feat!: move to new wallpaper api

README.md

@@ -1,8 +1,6 @@
 # <img src='./icon.png' width='50' height='50' style='vertical-align:bottom'/> Wallpaper Changer
 
-![](./logo.png)
-
-Pictures from selected subreddits
+Wallpapers from https://wallhaven.cc
 
 ![](./gui.png)
 ![](./gui2.png)

__init__.py

@@ -1,209 +1,40 @@
-import random
+from typing import Optional
 
+import requests
 from ovos_bus_client.message import Message
-from ovos_utils.parse import match_one
 from ovos_workshop.decorators import intent_handler, resting_screen_handler
 from ovos_workshop.intents import IntentBuilder
 from ovos_workshop.skills import OVOSSkill
-from wallpaper_changer import set_wallpaper, get_desktop_environment
-from wallpaper_changer.search import latest_reddit, latest_wpcraft, \
-    latest_unsplash
 
 
-class WallpapersSkill(OVOSSkill):
-
-    def initialize(self):
-        # skill settings defaults
-        if "auto_detect" not in self.settings:
-            self.settings["auto_detect"] = True
-        if "desktop_env" not in self.settings:
-            self.settings["desktop_env"] = get_desktop_environment()
-        if "rotate_wallpaper" not in self.settings:
-            self.settings["rotate_wallpaper"] = True
-        if "change_mins" not in self.settings:
-            self.settings["change_mins"] = 30
+def get_wallpapers(query: Optional[str] = None):
+    url = "https://wallhaven.cc/api/v1/search"
+    params = {"sorting": "random"}
+    if query:
+        params["q"] = query
+    data = requests.get(url, params=params).json()["data"]
+    return [w["path"] for w in data]
 
-        # imaage sources
-        if "unsplash" not in self.settings:
-            self.settings["unsplash"] = False
-        if "wpcraft" not in self.settings:
-            self.settings["wpcraft"] = True
 
-        subs = ['/r/EarthPorn', '/r/BotanicalPorn', '/r/WaterPorn',
-                '/r/SeaPorn',
-                '/r/SkyPorn', '/r/FirePorn', '/r/DesertPorn',
-                '/r/WinterPorn',
-                '/r/AutumnPorn', '/r/WeatherPorn', '/r/GeologyPorn',
-                '/r/SpacePorn',
-                '/r/BeachPorn', '/r/MushroomPorn', '/r/SpringPorn',
-                '/r/SummerPorn',
-                '/r/LavaPorn', '/r/LakePorn', '/r/CityPorn',
-                '/r/VillagePorn',
-                '/r/RuralPorn', '/r/ArchitecturePorn', '/r/HousePorn',
-                '/r/CabinPorn',
-                '/r/ChurchPorn', '/r/AbandonedPorn', '/r/CemeteryPorn',
-                '/r/InfrastructurePorn', '/r/MachinePorn', '/r/CarPorn',
-                '/r/F1Porn',
-                '/r/MotorcyclePorn', '/r/MilitaryPorn', '/r/GunPorn',
-                '/r/KnifePorn',
-                '/r/BoatPorn', '/r/RidesPorn', '/r/DestructionPorn',
-                '/r/ThingsCutInHalfPorn', '/r/StarshipPorn',
-                '/r/ToolPorn',
-                '/r/TechnologyPorn', '/r/BridgePorn', '/r/PolicePorn',
-                '/r/SteamPorn',
-                '/r/RetailPorn', '/r/SpaceFlightPorn', '/r/roadporn',
-                '/r/drydockporn',
-                '/r/AnimalPorn', '/r/HumanPorn', '/r/EarthlingPorn',
-                '/r/AdrenalinePorn', '/r/ClimbingPorn', '/r/SportsPorn',
-                '/r/AgriculturePorn', '/r/TeaPorn', '/r/BonsaiPorn',
-                '/r/FoodPorn',
-                '/r/CulinaryPorn', '/r/DessertPorn', '/r/DesignPorn',
-                '/r/RoomPorn',
-                '/r/AlbumArtPorn', '/r/MetalPorn', '/r/MoviePosterPorn',
-                '/r/TelevisionPosterPorn', '/r/ComicBookPorn',
-                '/r/StreetArtPorn',
-                '/r/AdPorn', '/r/ArtPorn', '/r/FractalPorn',
-                '/r/InstrumentPorn',
-                '/r/ExposurePorn', '/r/MacroPorn', '/r/MicroPorn',
-                '/r/GeekPorn',
-                '/r/MTGPorn', '/r/GamerPorn', '/r/PowerWashingPorn',
-                '/r/AerialPorn',
-                '/r/OrganizationPorn', '/r/FashionPorn', '/r/AVPorn',
-                '/r/ApocalypsePorn', '/r/InfraredPorn', '/r/ViewPorn',
-                '/r/HellscapePorn', '/r/sculptureporn', '/r/HistoryPorn',
-                '/r/UniformPorn', '/r/BookPorn', '/r/NewsPorn',
-                '/r/QuotesPorn',
-                '/r/FuturePorn', '/r/FossilPorn', '/r/MegalithPorn',
-                '/r/ArtefactPorn',
-                '/r/AmateurEarthPorn', '/r/AmateurPhotography',
-                '/r/ArtistOfTheDay',
-                '/r/BackgroundArt', '/r/Conservation', '/r/EarthPornVids',
-                '/r/EyeCandy', '/r/FWEPP', '/r/ImaginaryLandscapes',
-                '/r/ImaginaryWildlands', '/r/IncredibleIndia',
-                '/r/ITookAPicture',
-                '/r/JoshuaTree', '/r/NationalGeographic', '/r/Nature',
-                '/r/NatureGifs',
-                '/r/NaturePics', '/r/NotSafeForNature', '/r/NZPhotos',
-                '/r/remoteplaces', '/r/Schweiz', '/r/SpecArt',
-                '/r/wallpapers',
-                "/r/InterstellarArt"]
-        self.subs = [s.split("/")[-1].strip() for s in subs]
-        self.wpcats = [
-            '3d', 'abstract', 'animals', 'anime', "art", "black", "cars",
-            'city',
-            'dark', 'fantasy', 'flowers', 'food', 'holidays', 'love',
-            'macro',
-            'minimalism', 'motorcycles', 'music', 'nature', 'other',
-            'smilies',
-            'space', 'sport', 'hi-tech', 'textures', 'vector', 'words',
-            '60_favorites'
-        ]
-        for c in self.subs:
-            if c not in self.settings:
-                self.settings[c] = True
-        for c in self.wpcats:
-            if c not in self.settings:
-                self.settings[c] = True
+class WallpapersSkill(OVOSSkill):
 
+    def initialize(self):
         # state trackers
         self.pic_idx = 0
         self.picture_list = []
 
-        # events
-        self.log.info("Detected desktop env " + self.settings["desktop_env"])
-
         # gui slideshow buttons
         self.gui.register_handler(f'wallpaper.next', self.handle_next)
         self.gui.register_handler(f'wallpaper.prev', self.handle_prev)
 
         self.register_with_PHAL()
 
     # idle screen
-    def update_picture(self, query=None):
-        data = {}
-        if query is None:
-            cats = list(self.subs)
-            random.shuffle(cats)
-            for c in cats:
-                if data:
-                    break
-                idx = self.subs.index(c)
-                if self.settings[c] and random.choice([True, False]):
-                    wps = latest_reddit(self.subs[idx])
-                    if wps:
-                        random.shuffle(wps)
-                        self.picture_list = wps
-                        self.pic_idx = 0
-                        data = wps[0]
-                        data["url"] = "https://www.reddit.com/r/{s}/".format(s=c)
-            if self.settings["unsplash"] and \
-                    random.choice([True, False]) and not data:
-                self.picture_list = latest_unsplash(query, n=3)
-                data = self.picture_list[0]
-                data["url"] = "https://source.unsplash.com/1920x1080/?" + query
-                self.pic_idx = 0
-            elif self.settings["wpcraft"] and \
-                    random.choice([True, False]) and not data:
-                wps = latest_wpcraft()
-                random.shuffle(wps)
-                data = wps[0]
-                self.picture_list = wps
-                self.pic_idx = 0
-                data["url"] = "https://wallpaperscraft.com"
-        else:
-            # fuzzy match voc_files
-            best_sub = query
-            best_score = 0
-            for s in self.subs:
-                words = self.voc_list(s, self.lang)
-                sub, score = match_one(query, words)
-                if score > best_score:
-                    best_sub = sub
-                    best_score = score
-            if best_score > 0.85:
-                query = best_sub
-
-            # select subreddit
-            if query in self.subs:
-                wps = latest_reddit(query)
-                if wps:
-                    random.shuffle(wps)
-                    self.picture_list = wps
-                    self.pic_idx = 0
-                    data = wps[0]
-                    data["url"] = "https://www.reddit.com/r/{s}/".format(s=query)
-            elif query in self.wpcats:
-                wps = latest_wpcraft(query)
-                random.shuffle(wps)
-                data = wps[0]
-                self.picture_list = wps
-                self.pic_idx = 0
-                data["url"] = "https://wallpaperscraft.com/catalog/" + query
-            else:
-                # no matching subreddit, search in unsplash
-                self.picture_list = latest_unsplash(query, n=3)
-                data = self.picture_list[0]
-                data["url"] = "https://source.unsplash.com/1920x1080/?" + query
-                self.pic_idx = 0
-
-        if not data:
-            # default source of wallpapers
-            wps = latest_reddit("wallpapers")
-            random.shuffle(wps)
-            data = wps[0]
-            self.picture_list = wps
-            self.pic_idx = 0
-            data["url"] = "https://www.reddit.com/r/wallpapers/"
-
-        for k in data:
-            self.gui[k] = data[k]
+    def fetch_wallpapers(self, query=None) -> str:
+        self.picture_list = get_wallpapers(query)
+        self.pic_idx = 0
         self.set_context("PhotoUpdated")
-        return data["imgLink"], data.get("title", "")
-
-    @resting_screen_handler("Wallpapers")
-    def idle(self, message=None):
-        image, title = self.update_picture()
-        self.gui.show_image(image, fill='PreserveAspectFit')
+        return self.picture_list[self.pic_idx]
 
     # PHAL wallpaper manager integrations
     def register_with_PHAL(self):
@@ -212,98 +43,56 @@ def register_with_PHAL(self):
                                "provider_display_name": self.name}))
         self.bus.on(f"{self.skill_id}.get.wallpaper.collection", self.handle_wallpaper_scan)
         self.bus.on(f"{self.skill_id}.get.new.wallpaper", self.handle_wallpaper_get)
-        wallpapers = list(self.iter_wallpapers())
+        self.fetch_wallpapers()
         self.bus.emit(Message("ovos.wallpaper.manager.collect.collection.response",
                               {"provider_name": self.skill_id,
-                               "wallpaper_collection": wallpapers}))
+                               "wallpaper_collection": self.picture_list}))
 
     def handle_wallpaper_scan(self, message: Message):
-        wallpapers = list(self.iter_wallpapers())
+        self.fetch_wallpapers()
         self.bus.emit(message.reply("ovos.wallpaper.manager.collect.collection.response",
                                     {"provider_name": self.skill_id,
-                                     "wallpaper_collection": wallpapers}))
+                                     "wallpaper_collection": self.picture_list}))
 
     def handle_wallpaper_get(self, message: Message):
-        url, _ = self.update_picture()
+        url = self.fetch_wallpapers()
         self.bus.emit(message.reply("ovos.wallpaper.manager.set.wallpaper",
                                     {"provider_name": self.skill_id,
                                      "url": url}))
 
     # skill internals
-    def iter_wallpapers(self):
-        for c in self.subs:
-            if self.settings[c]:
-                wps = latest_reddit(c)
-                for u in wps:
-                    yield u["imgLink"]
-
     def change_wallpaper(self, image):
-        if self.settings["auto_detect"]:
-            success = set_wallpaper(image)
-        else:
-            # allow user override of wallpaper command
-            success = set_wallpaper(image, self.settings["desktop_env"])
-            if not success:
-                success = set_wallpaper(image)
-
         # update in homescreen skill / PHAL plugin
         self.bus.emit(Message("ovos.wallpaper.manager.set.wallpaper",
-                              {"provider_name": self.skill_id,
-                               "url": image}))
+                              {"provider_name": self.skill_id, "url": image}))
         self.bus.emit(Message("homescreen.wallpaper.set", {"url": image}))
-        return success
-
-    def display(self):
-        self.gui.clear()
-        data = self.picture_list[self.pic_idx]
-        for k in data:
-            self.gui[k] = data[k]
-        title = self.picture_list[self.pic_idx].get("title")
-        if title:
-            self.speak(title)
-        self.gui.show_page("slideshow", override_idle=True)
-        self.set_context("SlideShow")
 
     # intents
     @intent_handler("wallpaper.random.intent")
     def handle_random_wallpaper(self, message):
-        image, title = self.update_picture()
-        success = self.change_wallpaper(image)
-        if success:
-            self.speak_dialog("wallpaper.changed")
-        else:
-            self.speak_dialog("wallpaper fail")
-        self.gui.show_image(image, fill='PreserveAspectFit')
+        image = self.fetch_wallpapers()
+        self.change_wallpaper(image)
+        self.speak_dialog("wallpaper.changed")
 
     @intent_handler("picture.random.intent")
     def handle_random_picture(self, message=None):
-        self.update_picture()
-        title = self.picture_list[self.pic_idx].get("title")
-        if title:
-            self.speak(title)
-        self.display()
+        image = self.fetch_wallpapers()
+        self.gui.show_image(image)
 
     @intent_handler("wallpaper.about.intent")
     def handle_wallpaper_about(self, message):
         query = message.data["query"]
         self.speak_dialog("searching", {"query": query})
-        image, title = self.update_picture(query)
-        success = self.change_wallpaper(image)
-        if success:
-            self.speak_dialog("wallpaper.changed")
-        else:
-            self.speak_dialog("wallpaper fail")
-        self.gui.show_image(image, fill='PreserveAspectFit')
+        image = self.fetch_wallpapers(query)
+        self.change_wallpaper(image)
+        self.speak_dialog("wallpaper.changed")
 
     @intent_handler("picture.about.intent")
     def handle_picture_about(self, message=None):
         query = message.data["query"]
         self.speak_dialog("searching", {"query": query})
-        self.update_picture(query)
-        title = self.picture_list[self.pic_idx].get("title")
-        if title:
-            self.speak(title)
-        self.display()
+        image = self.fetch_wallpapers(query)
+        self.gui.show_image(image)
 
     @intent_handler(IntentBuilder("NextPictureIntent")
                     .require("next").optionally("picture")
@@ -315,7 +104,8 @@ def handle_next(self, message=None):
             self.pic_idx = total - 1
             self.speak_dialog("no.more.pictures")
         else:
-            self.display()
+            image = self.picture_list[self.pic_idx]
+            self.gui.show_image(image)
 
     @intent_handler(IntentBuilder("PrevPictureIntent")
                     .require("previous").optionally("picture")
@@ -326,18 +116,13 @@ def handle_prev(self, message=None):
             self.pic_idx = 0
             self.speak_dialog("no.more.pictures")
         else:
-            title = self.picture_list[self.pic_idx].get("title")
-            if title:
-                self.speak(title)
-            self.display()
+            image = self.picture_list[self.pic_idx]
+            self.gui.show_image(image)
 
     @intent_handler(IntentBuilder("MakeWallpaperIntent")
                     .require("set").require("wallpapers").optionally("picture")
                     .require("SlideShow"))
     def handle_set_wallpaper(self, message=None):
-        image = self.picture_list[self.pic_idx]["imgLink"]
-        success = self.change_wallpaper(image)
-        if success:
-            self.speak_dialog("wallpaper.changed")
-        else:
-            self.speak_dialog("wallpaper fail")
+        image = self.picture_list[self.pic_idx]
+        self.change_wallpaper(image)
+        self.speak_dialog("wallpaper.changed")