searchlink 2.3.70 → 2.3.72

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94434b4c63f4188ca00e93ad4c2be7765b61a2fdbccd3b7e706482bf1e09b618
-  data.tar.gz: 4af48f283d1a693bed323cdbbb91121ee5b4616225d4ecef46f80302016227ff
+  metadata.gz: d6e6eec4235b7ab5dd818a599ccd7ece852d6328233d2a81b8738447a581e046
+  data.tar.gz: 2e11a49af2da708369bde197c02b247875c41d6591fedbbb8e2b80a339819332
 SHA512:
-  metadata.gz: 3fa2094dbbf341680baefae73f98aba890ace10c6f6d44198b7902c28810b9e3cc8121199b9ba26a1da0243dcf779c3f018ebaaa6f1e794456d72106fafe5ad6
-  data.tar.gz: 7a39a40fbc8e8466c3652e236eee03091b027dd83aebd481b31dcb3acaa3a53124d362887d4cbe33bc22699fadd4e7adfe40f4f40db48cb8f69754584d84ae70
+  metadata.gz: a7c755596c600f2ce59a02a7b4e4199efa726613ae085cb0cd1f9998fec0fae7d384597f57d5b1c5258ba45d9d2abfb7cd148d533ec35406d01fcb186385b77c
+  data.tar.gz: 461e781699e0f1f04eaf46d28215b0fecf1447da6784025505c2d4c1f700ca768a513ea07c2660cd8cd983d8704d63230689637f061d4f4ec4defbdb1c655ecc

data/lib/searchlink/parse.rb

@@ -424,6 +424,14 @@ module SL
                   @url, title, @link_text = do_search(search_type, search_terms, @link_text, @search_count)
                 end
 
+                if (@link_text == '' || @link_text == '%') && @url
+                  if title
+                    @link_text = title
+                  else
+                    add_title(@url)
+                  end
+                end
+
                 if @url
                   title = SL::URL.title(@url) if SL.titleize && title == ''
 

data/lib/searchlink/script_plugin.rb

@@ -68,7 +68,7 @@ module SL
     end
 
     def find_script(script)
-      return script if File.exist?(File.expand_path(script))
+      return File.expand_path(script) if File.exist?(File.expand_path(script))
 
       base = File.expand_path('~/.config/searchlink/plugins')
       first = File.join(base, script)

data/lib/searchlink/searches/duckduckgo.rb

@@ -133,17 +133,15 @@ module SL
       SL::Util.search_with_timeout(search, timeout)
     end
 
-    # Performs a DuckDuckGo search with the given search
-    # terms and link text. If link text is not provided, the
-    # first result will be returned. The search will timeout
-    # after the given number of seconds.
+    # Performs a DuckDuckGo search with the given search terms and link text. If
+    # link text is not provided, the first result will be returned. The search
+    # will timeout after the given number of seconds.
     #
-    # @param      search_terms  [String] The search terms to
-    #                           use
-    # @param      link_text     [String] The text of the
-    #                           link to search for
-    # @param      timeout       [Integer] The timeout for
-    #                           the search in seconds
+    # @param      search_terms  [String] The search terms to use
+    # @param      link_text     [String] The text of the link to search for
+    # @param      timeout       [Integer] The timeout for the search in seconds
+    # @param      google        [Boolean] Use Google if API key installed
+    # @param      image         [Boolean] Image search
     # @return     [SL::Searches::Result] The search result
     #
     def ddg(search_terms, link_text = nil, timeout: SL.config['timeout'], google: true, image: false)
@@ -159,6 +157,17 @@ module SL
       SL::Util.search_with_timeout(search, timeout)
     end
 
+    ##
+    ## Perform a site-specific search
+    ##
+    ## @param      site          [String] The site to search
+    ## @param      search_terms  [String] The search terms
+    ## @param      link_text     [String] The link text
+    ##
+    def site_search(site, search_terms, link_text)
+      ddg("site:#{site} #{search_terms}", link_text)
+    end
+
     def first_image(url)
       images = Curl::Html.new(url).images
       images.filter { |img| img[:type] == 'img' }.first[:src]

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

@@ -29,7 +29,7 @@ module SL
           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%')")
+                     AND url NOT LIKE '%duckduckgo.com%')")
           if exact_match
             terms.push("(url LIKE '%#{term.strip.downcase}%' OR title LIKE '%#{term.strip.downcase}%')")
           else

data/lib/searchlink/searches/linkding.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module SL
+  class LinkdingSearch
+    LINKDING_CACHE = SL::Util.cache_file_for("linkding")
+
+    class << self
+      def settings
+        {
+          trigger: "(ld|ding)",
+          searches: [
+            [["ld", "ding"], "Linkding Bookmark Search"],
+          ],
+        }
+      end
+
+      def get_json(call)
+        curl = TTY::Which.which("curl")
+        bookmarks = `#{curl} -SsL -H "Authorization: Token #{SL.config["linkding_api_key"]}" "#{SL.config["linkding_server"]}#{call}"`
+
+        bookmarks = bookmarks.force_encoding("utf-8")
+        bookmarks.gsub!(/[^[:ascii:]]/) do |non_ascii|
+          non_ascii.force_encoding("utf-8")
+            .encode("utf-16be")
+            .unpack("H*")[0]
+            .gsub(/(....)/, '\u\1')
+        end
+
+        bookmarks.gsub!(/[\u{1F600}-\u{1F6FF}]/, "")
+
+        JSON.parse(bookmarks)
+      end
+
+      def get_linkding_bookmarks
+        curl = TTY::Which.which("curl")
+        call = "/api/bookmarks/?limit=8000&format=json"
+
+        json = get_json(call)
+        bookmarks = json["results"]
+        offset = 0
+
+        while json["next"]
+          offset += 8000
+          json = get_json(call + "&offset=#{offset}")
+          bookmarks.concat(json["results"])
+        end
+
+        bookmarks
+      end
+
+      def linkding_bookmarks
+        bookmarks = get_linkding_bookmarks
+        updated = Time.now
+        { "update_time" => updated, "bookmarks" => bookmarks }
+      end
+
+      def save_linkding_cache(cache)
+        cachefile = LINKDING_CACHE
+
+        # file = File.new(cachefile,'w')
+        # file = Zlib::GzipWriter.new(File.new(cachefile,'w'))
+        begin
+          File.open(cachefile, "wb") { |f| f.write(Marshal.dump(cache)) }
+        rescue IOError
+          SL.add_error("Linkding cache error", "Failed to write stash to disk")
+          return false
+        end
+        true
+      end
+
+      def linkding_cache
+        refresh_cache = false
+        cachefile = LINKDING_CACHE
+
+        if File.exist?(cachefile)
+          begin
+            # file = IO.read(cachefile) # Zlib::GzipReader.open(cachefile)
+            # cache = Marshal.load file
+            cache = Marshal.load(File.binread(cachefile))
+            # file.close
+          rescue IOError # Zlib::GzipFile::Error
+            SL.add_error("Error loading linkding cache", "IOError reading #{cachefile}")
+            cache = linkding_bookmarks
+            save_linkding_cache(cache)
+          rescue StandardError
+            SL.add_error("Error loading linkding cache", "StandardError reading #{cachefile}")
+            cache = linkding_bookmarks
+            save_linkding_cache(cache)
+          end
+          curl = TTY::Which.which("curl")
+          updated = get_json("/api/bookmarks/?limit=1&format=json")["results"][0]
+          last_bookmark = Time.parse(updated["date_modified"])
+          if cache&.key?("update_time")
+            last_update = cache["update_time"]
+            refresh_cache = true if last_update < last_bookmark
+          else
+            refresh_cache = true
+          end
+        else
+          refresh_cache = true
+        end
+
+        if refresh_cache
+          cache = linkding_bookmarks
+          save_linkding_cache(cache)
+        end
+
+        cache
+      end
+
+      # Search pinboard bookmarks
+      # Begin query with '' to force exact matching (including description text)
+      # Regular matching searches for each word of query and scores the bookmarks
+      # exact matches in title get highest score
+      # exact matches in description get second highest score
+      # other bookmarks are scored based on the number of words that match
+      #
+      # After sorting by score, bookmarks will be sorted by date and the most recent
+      # will be returned
+      #
+      # Exact matching is case and punctuation insensitive
+      def search(_, search_terms, link_text)
+        unless SL.config["linkding_server"]
+          SL.add_error("Missing Linkding server",
+                       "add it to your configuration (linkding_server: https://YOUR_SERVER)")
+          return false
+        end
+
+        unless SL.config["linkding_api_key"]
+          SL.add_error("Missing Linkding API token",
+                       "Find your api key at https://your_server/settings/integrations and add it
+                        to your configuration (linkding_api_key: YOURKEY)")
+          return false
+        end
+
+        exact_match = false
+        match_phrases = []
+
+        # If search terms start with ''term, only search for exact string matches
+        case search_terms
+        when /^ *'/
+          exact_match = true
+          search_terms.gsub!(/(^ *'+|'+ *$)/, "")
+        when /%22(.*?)%22/
+          match_phrases = search_terms.scan(/%22(\S.*?\S)%22/)
+          search_terms.gsub!(/%22(\S.*?\S)%22/, "")
+        end
+
+        cache = linkding_cache
+        # cache = linkding_bookmarks
+        bookmarks = cache["bookmarks"]
+
+        if exact_match
+          bookmarks.each do |bm|
+            text = [bm["title"], bm["description"], bm["tag_names"].join(" ")].join(" ")
+
+            return [bm["url"], bm["title"]] if text.matches_exact(search_terms)
+          end
+
+          return false
+        end
+
+        unless match_phrases.empty?
+          bookmarks.delete_if do |bm|
+            matched = tru
+            full_text = [bm["title"], bm["description"], bm["tag_names"].join(" ")].join(" ")
+            match_phrases.each do |phrase|
+              matched = false unless full_text.matches_exact(phrase)
+            end
+            !matched
+          end
+        end
+
+        matches = []
+        bookmarks.each do |bm|
+          title_tags = [bm["title"], bm["description"]].join(" ")
+          full_text = [bm["title"], bm["description"], bm["tag_names"].join(" ")].join(" ")
+
+          score = if title_tags.matches_exact(search_terms)
+              14.0
+            elsif full_text.matches_exact(search_terms)
+              13.0
+            elsif full_text.matches_any(search_terms)
+              full_text.matches_score(search_terms)
+            else
+              0
+            end
+
+          return [bm["url"], bm["title"]] if score == 14
+
+          next unless score.positive?
+
+          matches.push({
+                         score: score,
+                         href: bm["url"],
+                         title: bm["title"],
+                         date: bm["date_added"],
+                       })
+        end
+
+        return false if matches.empty?
+
+        top = matches.max_by { |bm| [bm[:score], bm[:date]] }
+
+        return false unless top
+
+        [top[:href], top[:title], link_text]
+      end
+    end
+
+    SL::Searches.register "linkding", :search, self
+  end
+end

data/lib/searchlink/searches.rb

@@ -9,7 +9,7 @@ module SL
       end
 
       def load_searches
-        Dir.glob(File.join(File.dirname(__FILE__), 'searches', '*.rb')).sort.each { |f| require f }
+        Dir.glob(File.join(File.dirname(__FILE__), "searches", "*.rb")).sort.each { |f| require f }
       end
 
       #
@@ -43,21 +43,21 @@ module SL
       #
       def available_searches_html
         searches = plugins[:search]
-                   .flat_map { |_, plugin| plugin[:searches] }
-                   .reject { |s| s[1].nil? }
-                   .sort_by { |s| s[0].is_a?(Array) ? s[0][0] : s[0] }
+          .flat_map { |_, plugin| plugin[:searches] }
+          .reject { |s| s[1].nil? }
+          .sort_by { |s| s[0].is_a?(Array) ? s[0][0] : s[0] }
         out = ['<table id="searches">',
-               '<thead><td>Shortcut</td><td>Search Type</td></thead>',
-               '<tbody>']
+               "<thead><td>Shortcut</td><td>Search Type</td></thead>",
+               "<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>!#{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")
+        out.concat(["</tbody>", "</table>"]).join("\n")
       end
 
       #
@@ -69,26 +69,33 @@ module SL
         searches = []
         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]}"
+          shortcut = if s[0].is_a?(Array)
+              "#{s[0][0]} (#{s[0][1..-1].join(",")})"
+            else
+              s[0]
+            end
+
+          out << "!#{shortcut}#{shortcut.spacer}#{s[1]}"
         end
         out.join("\n")
       end
 
       def best_search_match(term)
         searches = all_possible_searches.dup
-        searches.flatten.select { |s| s.matches_score(term, separator: '', start_word: false) > 8 }
+        searches.flatten.select { |s| s.matches_score(term, separator: "", start_word: false) > 8 }
       end
 
       def all_possible_searches
         searches = []
         plugins[:search].each_value { |plugin| plugin[:searches].each { |s| searches.push(s[0]) } }
-        searches.concat(SL.config['custom_site_searches'].keys.sort)
+        searches.concat(SL.config["custom_site_searches"].keys.sort)
       end
 
       def did_you_mean(term)
         matches = best_search_match(term)
-        matches.empty? ? '' : ", did you mean #{matches.map { |m| "!#{m}" }.join(', ')}?"
+        matches.empty? ? "" : ", did you mean #{matches.map { |m| "!#{m}" }.join(", ")}?"
       end
 
       def valid_searches
@@ -99,14 +106,14 @@ module SL
 
       def valid_search?(term)
         valid = false
-        valid = true if term =~ /^(#{valid_searches.join('|')})$/
-        valid = true if SL.config['custom_site_searches'].keys.include? term
+        valid = true if term =~ /^(#{valid_searches.join("|")})$/
+        valid = true if SL.config["custom_site_searches"].keys.include? term
         # SL.notify("Invalid search#{did_you_mean(term)}", term) unless valid
         valid
       end
 
       def register_plugin(title, type, klass)
-        raise PluginError.new("Plugin has no settings method", plugin: title)  unless klass.respond_to? :settings
+        raise PluginError.new("Plugin has no settings method", plugin: title) unless klass.respond_to? :settings
 
         settings = klass.settings
 
@@ -116,16 +123,16 @@ module SL
         plugins[type][title] = {
           trigger: settings.fetch(:trigger, title).normalize_trigger,
           searches: settings[:searches],
-          class: klass
+          class: klass,
         }
       end
 
       def load_custom
-        plugins_folder = File.expand_path('~/.local/searchlink/plugins')
-        new_plugins_folder = File.expand_path('~/.config/searchlink/plugins')
+        plugins_folder = File.expand_path("~/.local/searchlink/plugins")
+        new_plugins_folder = File.expand_path("~/.config/searchlink/plugins")
 
         if File.directory?(plugins_folder) && !File.directory?(new_plugins_folder)
-          Dir.glob(File.join(plugins_folder, '**/*.rb')).sort.each do |plugin|
+          Dir.glob(File.join(plugins_folder, "**/*.rb")).sort.each do |plugin|
             require plugin
           end
 
@@ -134,7 +141,7 @@ module SL
 
         return unless File.directory?(new_plugins_folder)
 
-        Dir.glob(File.join(new_plugins_folder, '**/*.rb')).sort.each do |plugin|
+        Dir.glob(File.join(new_plugins_folder, "**/*.rb")).sort.each do |plugin|
           require plugin
         end
 
@@ -142,24 +149,25 @@ module SL
       end
 
       def load_custom_scripts(plugins_folder)
-        Dir.glob(File.join(plugins_folder, '**/*.{json,yml,yaml}')).each do |file|
-          ext = File.extname(file).sub(/^\./, '')
+        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
+            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'])
+      def do_search(search_type, search_terms, link_text, timeout: SL.config["timeout"])
         plugins[:search].each do |_title, plugin|
-          trigger = plugin[:trigger].gsub(/(^\^|\$$)/, '')
+          trigger = plugin[:trigger].gsub(/(^\^|\$$)/, "")
           if search_type =~ /^#{trigger}$/
             search = proc { plugin[:class].search(search_type, search_terms, link_text) }
             return SL::Util.search_with_timeout(search, timeout)
@@ -171,64 +179,67 @@ module SL
 end
 
 # import
-require_relative 'searches/applemusic'
+require_relative "searches/applemusic"
 
 # import
-require_relative 'searches/itunes'
+require_relative "searches/itunes"
 
 # import
-require_relative 'searches/amazon'
+require_relative "searches/amazon"
 
 # import
-require_relative 'searches/bitly'
+require_relative "searches/bitly"
 
 # import
-require_relative 'searches/definition'
+require_relative "searches/definition"
 
 # import
-require_relative 'searches/duckduckgo'
+require_relative "searches/duckduckgo"
 
 # import
-require_relative 'searches/github'
+require_relative "searches/github"
 
 # import
-require_relative 'searches/google'
+require_relative "searches/google"
 
 # import
-require_relative 'searches/history'
+require_relative "searches/history"
 
 # import
-require_relative 'searches/hook'
+require_relative "searches/hook"
 
 # import
-require_relative 'searches/lastfm'
+require_relative "searches/lastfm"
 
 # import
-require_relative 'searches/pinboard'
+require_relative "searches/pinboard"
 
 # import
-require_relative 'searches/social'
+require_relative "searches/social"
 
 # import
-require_relative 'searches/software'
+require_relative "searches/software"
 
 # import
-require_relative 'searches/spelling'
+require_relative "searches/spelling"
 
 # import
-require_relative 'searches/spotlight'
+require_relative "searches/spotlight"
 
 # import
-require_relative 'searches/tmdb'
+require_relative "searches/tmdb"
 
 # import
-require_relative 'searches/twitter'
+require_relative "searches/twitter"
 
 # import
-require_relative 'searches/wikipedia'
+require_relative "searches/wikipedia"
 
 # import
-require_relative 'searches/youtube'
+require_relative "searches/youtube"
 
 # import
-require_relative 'searches/stackoverflow'
+require_relative "searches/stackoverflow"
+
+#import
+require_relative "searches/linkding"

data/lib/searchlink/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: searchlink
 version: !ruby/object:Gem::Version
-  version: 2.3.70
+  version: 2.3.72
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-10 00:00:00.000000000 Z
+date: 2024-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -220,6 +220,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.1
 description: macOS System Service for inline web searches
 email:
 - me@brettterpstra.com
@@ -258,6 +272,7 @@ files:
 - lib/searchlink/searches/hook.rb
 - lib/searchlink/searches/itunes.rb
 - lib/searchlink/searches/lastfm.rb
+- lib/searchlink/searches/linkding.rb
 - lib/searchlink/searches/lyrics.rb
 - lib/searchlink/searches/pinboard.rb
 - lib/searchlink/searches/social.rb
@@ -295,7 +310,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Create Markdown links from web searches without leaving your editor.