WebSuggest: offer default suggestion

WebSuggest/websuggest.ini

@@ -37,6 +37,12 @@
 # * Default: yes
 #enable_predefined_items = yes
 
+# Time that the plugin will wait before sending the request.
+# * Time in seconds (can be used with float type)
+# * The minimum value is 0.25
+# * Default: 0.25
+#waiting_time = 0.25
+
 
 [predefined_item/Amazon]
 provider = amazon

WebSuggest/websuggest.py

@@ -238,13 +238,15 @@ class WebSuggest(kp.Plugin):
 
     DEFAULT_ENABLE_PREDEFINED_PROVIDERS = True
     DEFAULT_ENABLE_PREDEFINED_ITEMS = True
+    DEFAULT_WAITING_TIME = 0.25
     DEFAULT_ACTION = ACTION_BROWSE
 
     actions_names = []
     default_icon = None
     icons = {}
     providers = {}
     profiles = {}
+    waiting_time = DEFAULT_WAITING_TIME
 
     def __init__(self):
         super().__init__()
@@ -307,11 +309,18 @@ def on_suggest(self, user_input, items_chain):
             self.warn('Item definition not found in current config: "{}"'.format(profile_name))
             return
 
+        default_item = current_item.clone()
+        default_item.set_args(user_input)
+        if not user_input:
+            default_item.set_short_desc("Open the search engine home page")
+
+        suggestions = [default_item]
+
         # avoid doing unnecessary network requests in case user is still typing
-        if len(user_input) < 2 or self.should_terminate(0.25):
+        if len(user_input) < 2 or self.should_terminate(self.waiting_time):
+            self.set_suggestions(suggestions)
             return
 
-        suggestions = []
         provider_suggestions = []
 
         try:
@@ -332,19 +341,33 @@ def on_suggest(self, user_input, items_chain):
             #item.set_data_bag(user_input)
             suggestions.append(item)
 
-        if suggestions:
-            self.set_suggestions(suggestions, kp.Match.ANY, kp.Sort.NONE)
+        if not provider_suggestions:  # change default item
+            suggestions[0].set_short_desc("No suggestions found (default action: {})".format(
+                                profile['default_action']))
+
+        self.set_suggestions(suggestions, kp.Match.ANY, kp.Sort.NONE)
 
     def on_execute(self, item, action):
         target_props = kpu.kwargs_decode(item.target())
         profile_name = target_props['profile']
+        args = item.raw_args()
 
         try:
             profile = self.profiles[profile_name]
         except KeyError:
             self.warn('Item definition not found in current config: "{}"'.format(profile_name))
             return
 
+        if not args:  # open the search engine home page
+            base = profile['provider'].browse_base
+            try:
+                parts = urllib.parse.urlsplit(base)
+                url = '{}://{}'.format(parts.scheme, parts.netloc)
+            except ValueError:
+                url = base
+            kpu.web_browser_command(url=url, execute=True)
+            return
+
         # choose action
         action_name = action.name() if action else None
         if not action_name:
@@ -360,24 +383,20 @@ def on_execute(self, item, action):
         # browse or copy url
         if action_name in (self.ACTION_BROWSE, self.ACTION_BROWSE_PRIVATE,
                            self.ACTION_COPY_URL):
-            url = profile['provider'].build_browse_url(item.raw_args())
+            url = profile['provider'].build_browse_url(args)
 
             # copy url
             if action_name == self.ACTION_COPY_URL:
                 kpu.set_clipboard(url)
 
             # launch browser
             else:
-                if action_name == self.ACTION_BROWSE_PRIVATE:
-                    private_mode = True
-                else:
-                    private_mode = None
-                kpu.web_browser_command(private_mode=private_mode, url=url,
-                                        execute=True)
+                private_mode = True if action_name == self.ACTION_BROWSE_PRIVATE else None
+                kpu.web_browser_command(private_mode=private_mode, url=url, execute=True)
 
         # default action: copy result (ACTION_COPY_RESULT)
         else:
-            kpu.set_clipboard(item.raw_args())
+            kpu.set_clipboard(args)
 
     def on_events(self, flags):
         if flags & (kp.Events.APPCONFIG | kp.Events.PACKCONFIG |
@@ -405,6 +424,9 @@ def _read_config(self):
         enable_predefined_items = settings.get_bool(
             "enable_predefined_items", self.CONFIG_SECTION_MAIN,
             fallback=self.DEFAULT_ENABLE_PREDEFINED_ITEMS)
+        self.waiting_time = settings.get_float(
+            "waiting_time", self.CONFIG_SECTION_MAIN,
+            fallback=self.DEFAULT_WAITING_TIME, min=0.25)
 
         # [predefined_provider/*] and [provider/*] sections
         for section in settings.sections():