Class: SL::LinkdingSearch
- Inherits:
-
Object
- Object
- SL::LinkdingSearch
- Defined in:
- lib/searchlink/searches/linkding.rb
Constant Summary collapse
- LINKDING_CACHE =
SL::Util.cache_file_for("linkding")
Class Method Summary collapse
- .get_json(call) ⇒ Object
- .get_linkding_bookmarks ⇒ Object
- .linkding_bookmarks ⇒ Object
- .linkding_cache ⇒ Object
- .save_linkding_cache(cache) ⇒ Object
-
.search(_, search_terms, link_text) ⇒ Object
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.
- .settings ⇒ Object
Class Method Details
.get_json(call) ⇒ Object
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
# File 'lib/searchlink/searches/linkding.rb', line 17 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") .unpack1("H*") .gsub(/(....)/, '\u\1') end bookmarks.gsub!(/[\u{1F600}-\u{1F6FF}]/, "") JSON.parse(bookmarks) end |
.get_linkding_bookmarks ⇒ Object
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 |
# File 'lib/searchlink/searches/linkding.rb', line 34 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 |
.linkding_bookmarks ⇒ Object
51 52 53 54 55 |
# File 'lib/searchlink/searches/linkding.rb', line 51 def linkding_bookmarks bookmarks = get_linkding_bookmarks updated = Time.now { "update_time" => updated, "bookmarks" => bookmarks } end |
.linkding_cache ⇒ Object
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/searchlink/searches/linkding.rb', line 71 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 |
.save_linkding_cache(cache) ⇒ Object
57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/searchlink/searches/linkding.rb', line 57 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 |
.search(_, search_terms, link_text) ⇒ Object
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
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/searchlink/searches/linkding.rb', line 122 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| = [bm["title"], bm["description"]].join(" ") full_text = [bm["title"], bm["description"], bm["tag_names"].join(" ")].join(" ") score = if .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 |
.settings ⇒ Object
8 9 10 11 12 13 14 15 |
# File 'lib/searchlink/searches/linkding.rb', line 8 def settings { trigger: "(ld|ding)", searches: [ [%w[ld ding], "Linkding Bookmark Search"] ] } end |