searchlink 2.3.68 → 2.3.70

data/lib/searchlink/script_plugin.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# title: Script plugin
+# description: Load custom searches from non-ruby scripts
+module SL
+  # Script Search
+  class ScriptSearch
+    def initialize(config)
+      @filename = config['filename']
+      @path = config['path']
+
+      %w[trigger searches name script].each do |key|
+        raise PluginError.new(%(configuration missing key "#{key}"), plugin: @filename) unless config.key?(key)
+      end
+
+      @trigger = config['trigger']
+      @searches = config['searches']
+      @name = config['name']
+      @script = find_script(config['script'])
+
+      unless File.executable?(@script)
+        raise PluginError.new(%(script "#{File.basename(@script)}" not executable\nrun `chmod a+x #{@script.shorten_path}` to correct),
+                              plugin: @filename)
+      end
+
+      class << self
+        def settings
+          {
+            trigger: @trigger,
+            searches: @searches
+          }
+        end
+
+        def search(search_type, search_terms, link_text)
+          type = Shellwords.escape(search_type)
+          terms = Shellwords.escape(search_terms)
+          text = Shellwords.escape(link_text)
+
+          stdout = `#{[@script, type, terms, text].join(' ')} 2>&1`
+
+          unless $CHILD_STATUS.success?
+            raise PluginError.new(%("#{File.basename(@script)}" returned error #{$CHILD_STATUS.exitstatus}\n#{stdout}),
+                                  plugin: @filename)
+          end
+
+          begin
+            res = JSON.parse(stdout)
+          rescue JSON::ParserError
+            res = YAML.safe_load(stdout)
+          end
+
+          unless res.is_a?(Hash)
+            raise PluginError.new(%(invalid results from "#{File.basename(@script)}", must be YAML or JSON string),
+                                  plugin: @filename)
+          end
+
+          %w[url title link_text].each do |key|
+            unless res.key?(key)
+              raise PluginError.new(%("#{File.basename(@script)}" output missing key "#{key}"), plugin: @filename)
+            end
+          end
+
+          [res['url'], res['title'], res['link_text']]
+        end
+      end
+
+      SL::Searches.register @name, :search, self
+    end
+
+    def find_script(script)
+      return script if File.exist?(File.expand_path(script))
+
+      base = File.expand_path('~/.config/searchlink/plugins')
+      first = File.join(base, script)
+      return first if File.exist?(first)
+
+      base = File.expand_path('~/.config/searchlink')
+      second = File.join(base, script)
+      return second if File.exist?(second)
+
+      raise PluginError.new(%(Script plugin script "#{script}" not found), plugin: @filename)
+    end
+  end
+end

data/lib/searchlink/searches/duckduckgo.rb

@@ -36,7 +36,7 @@ module SL
       def search(search_type, search_terms, link_text)
         return zero_click(search_terms, link_text) if search_type =~ /^z$/
 
-        # return SL.ddg(search_terms, link_text) if search_type == 'g' && SL::GoogleSearch.test_for_key
+        # return SL.ddg(search_terms, link_text) if search_type == 'g' && SL::GoogleSearch.api_key?
 
         terms = "%5C#{search_terms.url_encode}"
         page = Curl::Html.new("https://duckduckgo.com/?q=#{terms}", compressed: true)
@@ -122,7 +122,7 @@ module SL
     # @param      timeout       [Integer] The timeout
     #
     def google(search_terms, link_text = nil, timeout: SL.config['timeout'], image: false)
-      if SL::GoogleSearch.test_for_key
+      if SL::GoogleSearch.api_key?
         s_class = 'google'
         s_type = image ? 'img' : 'gg'
       else
@@ -147,7 +147,7 @@ module SL
     # @return     [SL::Searches::Result] The search result
     #
     def ddg(search_terms, link_text = nil, timeout: SL.config['timeout'], google: true, image: false)
-      if google && SL::GoogleSearch.test_for_key
+      if google && SL::GoogleSearch.api_key?
         s_class = 'google'
         s_type = image ? 'img' : 'gg'
       else

data/lib/searchlink/searches/google.rb

@@ -16,7 +16,7 @@ module SL
         }
       end
 
-      def test_for_key
+      def api_key?
         return false unless SL.config.key?('google_api_key') && SL.config['google_api_key']
 
         key = SL.config['google_api_key']
@@ -30,7 +30,7 @@ module SL
       def search(search_type, search_terms, link_text)
         image = search_type =~ /img$/ ? true : false
 
-        unless test_for_key
+        unless api_key?
           SL.add_error('api key', 'Missing Google API Key')
           return false
         end

data/lib/searchlink/searches/helpers/chromium.rb

@@ -31,14 +31,25 @@ module SL
       ## @return     [Array] Single bookmark, [url, title, date]
       ##
       def search_brave_history(term)
-        # Google history
-        history_file = File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/Default/History')
-        if File.exist?(history_file)
-          SL.notify('Searching Brave History', term)
-          search_chromium_history(history_file, term)
-        else
-          false
+        base = File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/')
+        profiles = Dir.glob('**/History', base: base)
+        profiles.delete_if { |p| p =~ /^Snapshots/ }
+        profiles.map! { |f| File.join(base, f) }
+
+        res = false
+
+        profiles.each do |bookmarks|
+          next unless File.exist?(bookmarks)
+
+          profile = bookmarks.match(%r{Browser/([^/]+)/})[1]
+
+          SL.notify("Searching Brave History for profile #{profile}", term)
+          res = search_chromium_history(bookmarks, term)
+
+          break if res
         end
+
+        res
       end
 
       ## Search Edge history
@@ -48,14 +59,25 @@ module SL
       ## @return     [Array] Single bookmark, [url, title, date]
       ##
       def search_edge_history(term)
-        # Google history
-        history_file = File.expand_path('~/Library/Application Support/Microsoft Edge/Default/History')
-        if File.exist?(history_file)
-          SL.notify('Searching Edge History', term)
-          search_chromium_history(history_file, term)
-        else
-          false
+        base = File.expand_path('~/Library/Application Support/Microsoft Edge/')
+        profiles = Dir.glob('**/History', base: base)
+        profiles.delete_if { |p| p =~ /^Snapshots/ }
+        profiles.map! { |f| File.join(base, f) }
+
+        res = false
+
+        profiles.each do |bookmarks|
+          next unless File.exist?(bookmarks)
+
+          profile = bookmarks.match(%r{Edge/([^/]+)/})[1]
+
+          SL.notify("Searching Chrome History for profile #{profile}", term)
+          res = search_chromium_history(bookmarks, term)
+
+          break if res
         end
+
+        res
       end
 
       ## Search Chrome history
@@ -66,13 +88,27 @@ module SL
       ##
       def search_chrome_history(term)
         # Google history
-        history_file = File.expand_path('~/Library/Application Support/Google/Chrome/Default/History')
-        if File.exist?(history_file)
-          SL.notify('Searching Chrome History', term)
-          search_chromium_history(history_file, term)
-        else
-          false
+        base = File.expand_path('~/Library/Application Support/Google/Chrome/')
+        profiles = Dir.glob('**/History', base: base)
+        profiles.delete_if { |p| p =~ /^Snapshots/ }
+        profiles.map! { |f| File.join(base, f) }
+
+        # bookmarks_file = File.expand_path('~/Library/Application Support/Google/Chrome/Default/Bookmarks')
+
+        res = false
+
+        profiles.each do |bookmarks|
+          next unless File.exist?(bookmarks)
+
+          profile = bookmarks.match(%r{Chrome/([^/]+)/})[1]
+
+          SL.notify("Searching Chrome History for profile #{profile}", term)
+          res = search_chromium_history(bookmarks, term)
+
+          break if res
         end
+
+        res
       end
 
       ##
@@ -105,6 +141,7 @@ module SL
         terms.push("(url NOT LIKE '%search/?%'
                    AND url NOT LIKE '%?q=%'
                    AND url NOT LIKE '%?s=%'
+                   AND url NOT LIKE '%www.bing.com%'
                    AND url NOT LIKE '%duckduckgo.com/?t%')")
         if exact_match
           terms.push("(url LIKE '%#{term.strip.downcase}%' OR title LIKE '%#{term.strip.downcase}%')")
@@ -138,11 +175,11 @@ module SL
       ## @return     [Array] single bookmark [url, title, date]
       ##
       def search_arc_bookmarks(term)
-        bookmarks_file = File.expand_path('~/Library/Application Support/Arc/User Data/Default/Bookmarks')
+        bookmarks_file = File.expand_path('~/Library/Application Support/Arc/StorableSidebar.json')
 
         if File.exist?(bookmarks_file)
-          SL.notify('Searching Brave Bookmarks', term)
-          return search_chromium_bookmarks(bookmarks_file, term)
+          SL.notify('Searching Arc Bookmarks', term)
+          return search_arc_json(bookmarks_file, term)
         end
 
         false
@@ -156,14 +193,25 @@ module SL
       ## @return     [Array] single bookmark [url, title, date]
       ##
       def search_brave_bookmarks(term)
-        bookmarks_file = File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/Default/Bookmarks')
+        base = File.expand_path('~/Library/Application Support/BraveSoftware/Brave-Browser/')
+        profiles = Dir.glob('**/Bookmarks', base: base)
+        profiles.delete_if { |p| p =~ /^Snapshots/ }
+        profiles.map! { |f| File.join(base, f) }
 
-        if File.exist?(bookmarks_file)
-          SL.notify('Searching Brave Bookmarks', term)
-          return search_chromium_bookmarks(bookmarks_file, term)
+        res = false
+
+        profiles.each do |bookmarks|
+          next unless File.exist?(bookmarks)
+
+          profile = bookmarks.match(%r{Browser/([^/]+)/})[1]
+
+          SL.notify("Searching Brave Bookmarks for profile #{profile}", term)
+          res = search_chromium_bookmarks(bookmarks, term)
+
+          break if res
         end
 
-        false
+        res
       end
 
       ##
@@ -174,14 +222,24 @@ module SL
       ## @return     [Array] single bookmark [url, title, date]
       ##
       def search_edge_bookmarks(term)
-        bookmarks_file = File.expand_path('~/Library/Application Support/Microsoft Edge/Default/Bookmarks')
+        base = File.expand_path('~/Library/Application Support/Microsoft Edge')
+        profiles = Dir.glob('**/Bookmarks', base: base)
+        profiles.delete_if { |p| p =~ /^Snapshots/ }
+        profiles.map! { |f| File.join(base, f) }
 
-        if File.exist?(bookmarks_file)
-          SL.notify('Searching Edge Bookmarks', term)
-          return search_chromium_bookmarks(bookmarks_file, term)
+        res = false
+
+        profiles.each do |bookmarks|
+          next unless File.exist?(bookmarks)
+
+          profile = bookmarks.match(%r{Edge/([^/]+)/})[1]
+
+          SL.notify("Searching Edge Bookmarks for profile #{profile}", term)
+          res = search_chromium_bookmarks(bookmarks, term)
+          break if res
         end
 
-        false
+        res
       end
 
       ##
@@ -192,11 +250,102 @@ module SL
       ## @return     [Array] single bookmark [url, title, date]
       ##
       def search_chrome_bookmarks(term)
-        bookmarks_file = File.expand_path('~/Library/Application Support/Google/Chrome/Default/Bookmarks')
+        base = File.expand_path('~/Library/Application Support/Google/Chrome/')
+        profiles = Dir.glob('**/Bookmarks', base: base)
+        profiles.delete_if { |p| p =~ /^Snapshots/ }
+        profiles.map! { |f| File.join(base, f) }
 
-        if File.exist?(bookmarks_file)
-          SL.notify('Searching Chrome Bookmarks', term)
-          return search_chromium_bookmarks(bookmarks_file, term)
+        res = false
+
+        profiles.each do |bookmarks|
+          if File.exist?(bookmarks)
+            profile = bookmarks.match(%r{Chrome/([^/]+)/})[1]
+
+            SL.notify("Searching Chrome Bookmarks for profile #{profile}", term)
+            res = search_chromium_bookmarks(bookmarks, term)
+            break if res
+          end
+        end
+
+        res
+      end
+
+      ##
+      ## Search Arc/JSON bookmarks
+      ##
+      ## @param      bookmarks_file  [String] path to bookmarks file
+      ## @param      term            [String] the string to search for
+      ##
+      ## @return     [Array] single bookmark [url, title, date]
+      ##
+      def search_arc_json(bookmarks_file, term)
+        arc_bookmarks = JSON.parse(IO.read(bookmarks_file))
+
+        exact_match = false
+        match_phrases = []
+
+        # If search terms start with ''term, only search for exact string matches
+        if term =~ /^ *'/
+          exact_match = true
+          term.gsub!(/(^ *'+|'+ *$)/, '')
+        elsif term =~ /%22(.*?)%22/
+          match_phrases = term.scan(/%22(\S.*?\S)%22/)
+          term.gsub!(/%22(\S.*?\S)%22/, '')
+        end
+
+        if arc_bookmarks
+          bookmarks = []
+          arc_bookmarks['sidebarSyncState']['items'].each do |mark|
+            next if mark.is_a?(String)
+
+            next unless mark['value']['childrenIds'].empty?
+
+            next unless mark['value']['data']['tab']
+
+            url = {
+              url: mark['value']['data']['tab']['savedURL'],
+              saved_title: mark['value']['data']['tab']['savedTitle'],
+              title: mark['value']['title'],
+              created: mark['value']['createdAt'].to_datetime,
+              active: mark['value']['data']['tab']['timeLastActiveAt']&.to_datetime
+            }
+
+            score = score_mark(url, term)
+
+            if score > 7
+              url[:score] = score
+              bookmarks << url
+            end
+          end
+
+          unless bookmarks.empty?
+            if exact_match
+              bookmarks.delete_if do |bm|
+                !(bm[:url].matches_exact(term) ||
+                bm[:title].matches_exact(term) ||
+                bm[:saved_title].matches_exact(term))
+              end
+            end
+
+            if match_phrases
+              match_phrases.map! { |phrase| phrase[0] }
+              bookmarks.delete_if do |bm|
+                matched = true
+                match_phrases.each do |phrase|
+                  matched = false unless bm[:url].matches_exact(phrase) ||
+                                         bm[:title].matches_exact(phrase) ||
+                                         bm[:saved_title].matches_exact(phrase)
+                end
+                !matched
+              end
+            end
+
+            return false if bookmarks.empty?
+
+            lastest_bookmark = bookmarks.min_by { |u| u[:created] }
+
+            return [lastest_bookmark[:url], lastest_bookmark[:title], lastest_bookmark[:date]]
+          end
         end
 
         false
@@ -284,7 +433,7 @@ module SL
               urls << url
             end
           else
-            json.each { |_, v| urls = extract_chrome_bookmarks(v, urls, term) }
+            json.each_value { |v| urls = extract_chrome_bookmarks(v, urls, term) }
           end
         else
           return urls
@@ -301,19 +450,27 @@ module SL
       def score_mark(mark, terms)
         return 0 unless mark[:url]
 
-        score = if mark[:title]&.matches_exact(terms)
-                  12 + mark[:url].matches_score(terms, start_word: false)
-                elsif mark[:url].matches_exact(terms)
-                  11
-                elsif mark[:title] && mark[:title].matches_score(terms) > 5
-                  mark[:title].matches_score(terms)
-                elsif mark[:url].matches_score(terms, start_word: false)
-                  mark[:url].matches_score(terms, start_word: false)
-                else
-                  0
-                end
+        if mark[:title]&.matches_exact(terms)
+          12 + mark[:url].matches_score(terms, start_word: false)
+        elsif mark[:url].matches_exact(terms)
+          11
+        elsif (mark[:title] && mark[:title].matches_score(terms) > 5) ||
+              (mark[:saved_title] && mark[:saved_title].matches_score(terms) > 5)
+
+          if mark[:saved_title]
+            t = mark[:title]&.matches_score(terms)
+            s = mark[:saved_title].matches_score(terms)
+            return s if t.nil?
 
-        score
+            [t, s].max
+          else
+            mark[:title]&.matches_score(terms)
+          end
+        elsif mark[:url].matches_score(terms, start_word: false)
+          mark[:url].matches_score(terms, start_word: false)
+        else
+          0
+        end
       end
     end
   end

data/lib/searchlink/searches/helpers/safari.rb

@@ -28,6 +28,7 @@ module SL
           terms = []
           terms.push("(url NOT LIKE '%search/?%'
                      AND url NOT LIKE '%?q=%' AND url NOT LIKE '%?s=%'
+                     AND url NOT LIKE '%/search?%'
                      AND url NOT LIKE '%duckduckgo.com/?t%')")
           if exact_match
             terms.push("(url LIKE '%#{term.strip.downcase}%' OR title LIKE '%#{term.strip.downcase}%')")

data/lib/searchlink/searches.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module SL
+  # Searches and plugin registration
   module Searches
     class << self
       def plugins
@@ -25,7 +26,7 @@ module SL
 
       def description_for_search(search_type)
         description = "#{search_type} search"
-        plugins[:search].each do |_, plugin|
+        plugins[:search].each_value do |plugin|
           search = plugin[:searches].select { |s| s[0].is_a?(Array) ? s[0].include?(search_type) : s[0] == search_type }
           unless search.empty?
             description = search[0][1]
@@ -50,7 +51,11 @@ module SL
                '<tbody>']
 
         searches.each do |s|
-          out << "<tr><td><code>!#{s[0].is_a?(Array) ? "#{s[0][0]} (#{s[0][1..-1].join(',')})" : s[0]}</code></td><td>#{s[1]}</td></tr>"
+          out << "<tr>
+          <td>
+          <code>!#{s[0].is_a?(Array) ? "#{s[0][0]} (#{s[0][1..-1].join(',')})" : s[0]}
+          </code>
+          </td><td>#{s[1]}</td></tr>"
         end
         out.concat(['</tbody>', '</table>']).join("\n")
       end
@@ -62,7 +67,7 @@ module SL
       #
       def available_searches
         searches = []
-        plugins[:search].each { |_, plugin| searches.concat(plugin[:searches].delete_if { |s| s[1].nil? }) }
+        plugins[:search].each_value { |plugin| searches.concat(plugin[:searches].delete_if { |s| s[1].nil? }) }
         out = []
         searches.each do |s|
           out += "!#{s[0].is_a?(Array) ? "#{s[0][0]} (#{s[0][1..-1].join(',')})" : s[0]}#{s[0].spacer}#{s[1]}"
@@ -77,8 +82,8 @@ module SL
 
       def all_possible_searches
         searches = []
-        plugins[:search].each { |_, plugin| plugin[:searches].each { |s| searches.push(s[0]) } }
-        searches.concat(SL.config['custom_site_searches'].keys)
+        plugins[:search].each_value { |plugin| plugin[:searches].each { |s| searches.push(s[0]) } }
+        searches.concat(SL.config['custom_site_searches'].keys.sort)
       end
 
       def did_you_mean(term)
@@ -101,11 +106,11 @@ module SL
       end
 
       def register_plugin(title, type, klass)
-        raise StandardError, "Plugin #{title} has no settings method" unless klass.respond_to? :settings
+        raise PluginError.new("Plugin has no settings method", plugin: title)  unless klass.respond_to? :settings
 
         settings = klass.settings
 
-        raise StandardError, "Plugin #{title} has no search method" unless klass.respond_to? :search
+        raise PluginError.new("Plugin has no search method", plugin: title) unless klass.respond_to? :search
 
         plugins[type] ||= {}
         plugins[type][title] = {
@@ -123,6 +128,8 @@ module SL
           Dir.glob(File.join(plugins_folder, '**/*.rb')).sort.each do |plugin|
             require plugin
           end
+
+          load_custom_scripts(plugins_folder)
         end
 
         return unless File.directory?(new_plugins_folder)
@@ -130,6 +137,24 @@ module SL
         Dir.glob(File.join(new_plugins_folder, '**/*.rb')).sort.each do |plugin|
           require plugin
         end
+
+        load_custom_scripts(new_plugins_folder)
+      end
+
+      def load_custom_scripts(plugins_folder)
+        Dir.glob(File.join(plugins_folder, '**/*.{json,yml,yaml}')).each do |file|
+          ext = File.extname(file).sub(/^\./, '')
+          config = IO.read(file)
+          cfg = case ext
+                when /^y/i
+                  YAML.safe_load(config)
+                else
+                  JSON.parse(config)
+                end
+          cfg['filename'] = File.basename(file)
+          cfg['path'] = file.shorten_path
+          SL::ScriptSearch.new(cfg)
+        end
       end
 
       def do_search(search_type, search_terms, link_text, timeout: SL.config['timeout'])

data/lib/searchlink/semver.rb

@@ -5,14 +5,14 @@ module SL
   class SemVer
     attr_accessor :maj, :min, :patch, :pre
 
-    # Initialize a Semantic Version object
-    #
-    # @param      version_string  [String] a semantic version number
-    #
-    # @return     [SemVer] SemVer object
-    #
+    ## Initialize a Semantic Version object
+    ##
+    ## @param      version_string  [String] a semantic version number
+    ##
+    ## @return     [SemVer] SemVer object
+    ##
     def initialize(version_string)
-      raise "Invalid semantic version number: #{version_string}" unless version_string.valid_version?
+      raise VersionError.new("Invalid semantic version number: #{version_string}") unless version_string.valid_version?
 
       @maj, @min, @patch = version_string.split(/\./)
       @pre = nil

data/lib/searchlink/string.rb

@@ -488,5 +488,13 @@ module SL
     def code_indent
       split(/\n/).map { |l| "    #{l}" }.join("\n")
     end
+
+    ##
+    ## Shorten path by adding ~ for home directory
+    ##
+    def shorten_path
+      home_directory = ENV['HOME']
+      sub(home_directory, '~')
+    end
   end
 end

data/lib/searchlink/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module SL
-  VERSION = '2.3.68'
+  VERSION = '2.3.70'
 end
 
 # Main module

data/lib/searchlink.rb

@@ -13,10 +13,17 @@ require 'zlib'
 require 'time'
 require 'json'
 require 'erb'
+require 'english'
 
 # import
 require 'tokens' if File.exist?('lib/tokens.rb')
 
+# import
+require 'searchlink/exceptions'
+
+# import
+require 'searchlink/number'
+
 # import
 require 'searchlink/util'
 
@@ -62,4 +69,7 @@ require 'searchlink/output'
 # import
 require 'searchlink/which'
 
+# import
+require 'searchlink/script_plugin'
+
 module Secrets; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchlink
 version: !ruby/object:Gem::Version
-  version: 2.3.68
+  version: 2.3.70
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -235,10 +235,13 @@ files:
 - lib/searchlink/curl.rb
 - lib/searchlink/curl/html.rb
 - lib/searchlink/curl/json.rb
+- lib/searchlink/exceptions.rb
 - lib/searchlink/help.rb
+- lib/searchlink/number.rb
 - lib/searchlink/output.rb
 - lib/searchlink/parse.rb
 - lib/searchlink/plist.rb
+- lib/searchlink/script_plugin.rb
 - lib/searchlink/search.rb
 - lib/searchlink/searches.rb
 - lib/searchlink/searches/amazon.rb