]> git.wh0rd.org - tt-rss.git/blame - plugins/af_psql_trgm/init.php
trgm plugin: increase check distance to 3 days
[tt-rss.git] / plugins / af_psql_trgm / init.php
CommitLineData
117efb6f
AD
1<?php
2class Af_Psql_Trgm extends Plugin {
3
4 private $host;
117efb6f
AD
5
6 function about() {
7 return array(1.0,
8 "Marks similar articles as read (requires pg_trgm)",
9 "fox");
10 }
11
12 function save() {
13 $similarity = (float) db_escape_string($_POST["similarity"]);
14 $min_title_length = (int) db_escape_string($_POST["min_title_length"]);
f46fe839 15 $enable_globally = checkbox_to_sql_bool($_POST["enable_globally"]) == "true";
117efb6f
AD
16
17 if ($similarity < 0) $similarity = 0;
18 if ($similarity > 1) $similarity = 1;
19
20 if ($min_title_length < 0) $min_title_length = 0;
21
22 $similarity = sprintf("%.2f", $similarity);
23
24 $this->host->set($this, "similarity", $similarity);
25 $this->host->set($this, "min_title_length", $min_title_length);
f46fe839 26 $this->host->set($this, "enable_globally", $enable_globally);
117efb6f 27
f46fe839 28 echo T_sprintf("Data saved (%s, %d)", $similarity, $enable_globally);
117efb6f
AD
29 }
30
31 function init($host) {
32 $this->host = $host;
33
34 $host->add_hook($host::HOOK_ARTICLE_FILTER, $this);
35 $host->add_hook($host::HOOK_PREFS_TAB, $this);
36 $host->add_hook($host::HOOK_PREFS_EDIT_FEED, $this);
37 $host->add_hook($host::HOOK_PREFS_SAVE_FEED, $this);
f52879fe 38 $host->add_hook($host::HOOK_ARTICLE_BUTTON, $this);
117efb6f
AD
39
40 }
41
f52879fe 42 function get_js() {
167fb03f
AD
43 return file_get_contents(__DIR__ . "/init.js");
44 }
45
46 function showrelated() {
47 $id = (int) db_escape_string($_REQUEST['param']);
48 $owner_uid = $_SESSION["uid"];
49
50 $result = db_query("SELECT title FROM ttrss_entries, ttrss_user_entries
51 WHERE ref_id = id AND id = $id AND owner_uid = $owner_uid");
52
53 $title = db_fetch_result($result, 0, "title");
54
55 print "<h2>$title</h2>";
56
57 $title = db_escape_string($title);
f52879fe
AD
58 $result = db_query("SELECT ttrss_entries.id AS id,
59 feed_id,
60 ttrss_entries.title AS title,
61 updated, link,
62 ttrss_feeds.title AS feed_title,
63 SIMILARITY(ttrss_entries.title, '$title') AS sm
64 FROM
65 ttrss_entries, ttrss_user_entries LEFT JOIN ttrss_feeds ON (ttrss_feeds.id = feed_id)
66 WHERE
67 ttrss_entries.id = ref_id AND
68 ttrss_user_entries.owner_uid = $owner_uid AND
69 ttrss_entries.id != $id AND
d8069534 70 date_entered >= NOW() - INTERVAL '2 weeks'
f52879fe
AD
71 ORDER BY
72 sm DESC, date_entered DESC
73 LIMIT 10");
167fb03f
AD
74
75 print "<ul class=\"browseFeedList\" style=\"border-width : 1px\">";
76
77 while ($line = db_fetch_assoc($result)) {
78 print "<li>";
f52879fe
AD
79 print "<div class='insensitive small' style='margin-left : 20px; float : right'>" .
80 smart_date_time(strtotime($line["updated"]))
167fb03f 81 . "</div>";
f52879fe 82
4cbca7b2
AD
83 $sm = sprintf("%.2f", $line['sm']);
84 print "<img src='images/score_high.png' title='$sm'
f52879fe
AD
85 style='vertical-align : middle'>";
86
87 $article_link = htmlspecialchars($line["link"]);
88 print " <a target=\"_blank\" href=\"$article_link\">".
89 $line["title"]."</a>";
90
dcbe36b2 91 print " (<a href=\"#\" onclick=\"viewfeed({feed:".$line["feed_id"]."})\">".
f52879fe
AD
92 htmlspecialchars($line["feed_title"])."</a>)";
93
4cbca7b2
AD
94 print " <span class='insensitive'>($sm)</span>";
95
167fb03f
AD
96 print "</li>";
97 }
98
99 print "</ul>";
100
f52879fe
AD
101 print "<div style='text-align : center'>";
102 print "<button dojoType=\"dijit.form.Button\" onclick=\"dijit.byId('trgmRelatedDlg').hide()\">".__('Close this window')."</button>";
103 print "</div>";
167fb03f 104
f52879fe
AD
105
106 }
107
108 function hook_article_button($line) {
167fb03f
AD
109 return "<img src=\"plugins/af_psql_trgm/button.png\"
110 style=\"cursor : pointer\" style=\"cursor : pointer\"
111 onclick=\"showTrgmRelated(".$line["id"].")\"
112 class='tagsPic' title='".__('Show related articles')."'>";
f52879fe 113 }
167fb03f 114
117efb6f
AD
115 function hook_prefs_tab($args) {
116 if ($args != "prefFeeds") return;
117
118 print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"".__('Mark similar articles as read')."\">";
119
120 if (DB_TYPE != "pgsql") {
121 print_error("Database type not supported.");
122 }
123
124 $result = db_query("select 'similarity'::regproc");
125
126 if (db_num_rows($result) == 0) {
127 print_error("pg_trgm extension not found.");
128 }
129
130 $similarity = $this->host->get($this, "similarity");
131 $min_title_length = $this->host->get($this, "min_title_length");
f46fe839 132 $enable_globally = $this->host->get($this, "enable_globally");
117efb6f
AD
133
134 if (!$similarity) $similarity = '0.75';
135 if (!$min_title_length) $min_title_length = '32';
136
f46fe839
AD
137 $enable_globally_checked = $enable_globally ? "checked" : "";
138
117efb6f
AD
139 print "<form dojoType=\"dijit.form.Form\">";
140
141 print "<script type=\"dojo/method\" event=\"onSubmit\" args=\"evt\">
142 evt.preventDefault();
143 if (this.validate()) {
144 console.log(dojo.objectToQuery(this.getValues()));
145 new Ajax.Request('backend.php', {
146 parameters: dojo.objectToQuery(this.getValues()),
147 onComplete: function(transport) {
148 notify_info(transport.responseText);
149 }
150 });
151 //this.reset();
152 }
153 </script>";
154
155 print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"op\" value=\"pluginhandler\">";
156 print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"method\" value=\"save\">";
157 print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"plugin\" value=\"af_psql_trgm\">";
158
73dfda1d 159 print "<p>" . __("PostgreSQL trigram extension returns string similarity as a floating point number (0-1). Setting it too low might produce false positives, zero disables checking.") . "</p>";
117efb6f
AD
160 print_notice("Enable the plugin for specific feeds in the feed editor.");
161
162 print "<h3>" . __("Global settings") . "</h3>";
163
164 print "<table>";
165
166 print "<tr><td width=\"40%\">".__("Minimum similarity:")."</td>";
167 print "<td>
168 <input dojoType=\"dijit.form.ValidationTextBox\"
169 placeholder=\"0.75\"
170 required=\"1\" name=\"similarity\" value=\"$similarity\"></td></tr>";
171 print "<tr><td width=\"40%\">".__("Minimum title length:")."</td>";
172 print "<td>
173 <input dojoType=\"dijit.form.ValidationTextBox\"
174 placeholder=\"32\"
175 required=\"1\" name=\"min_title_length\" value=\"$min_title_length\"></td></tr>";
f46fe839
AD
176 print "<tr><td width=\"40%\">".__("Enable for all feeds:")."</td>";
177 print "<td>
178 <input dojoType=\"dijit.form.CheckBox\"
179 $enable_globally_checked name=\"enable_globally\"></td></tr>";
117efb6f 180
117efb6f
AD
181 print "</table>";
182
183 print "<p><button dojoType=\"dijit.form.Button\" type=\"submit\">".
184 __("Save")."</button>";
185
186 print "</form>";
187
9a121298
AD
188 $enabled_feeds = $this->host->get($this, "enabled_feeds");
189 if (!array($enabled_feeds)) $enabled_feeds = array();
190
53df80c4
AD
191 $enabled_feeds = $this->filter_unknown_feeds($enabled_feeds);
192 $this->host->set($this, "enabled_feeds", $enabled_feeds);
193
9a121298
AD
194 if (count($enabled_feeds) > 0) {
195 print "<h3>" . __("Currently enabled for (click to edit):") . "</h3>";
196
197 print "<ul class=\"browseFeedList\" style=\"border-width : 1px\">";
198 foreach ($enabled_feeds as $f) {
199 print "<li>" .
200 "<img src='images/pub_set.png'
201 style='vertical-align : middle'> <a href='#'
202 onclick='editFeed($f)'>".
203 getFeedTitle($f) . "</a></li>";
204 }
205 print "</ul>";
206 }
207
117efb6f
AD
208 print "</div>";
209 }
210
117efb6f
AD
211 function hook_prefs_edit_feed($feed_id) {
212 print "<div class=\"dlgSec\">".__("Similarity (pg_trgm)")."</div>";
213 print "<div class=\"dlgSecCont\">";
214
215 $enabled_feeds = $this->host->get($this, "enabled_feeds");
216 if (!array($enabled_feeds)) $enabled_feeds = array();
217
218 $key = array_search($feed_id, $enabled_feeds);
219 $checked = $key !== FALSE ? "checked" : "";
220
221 print "<hr/><input dojoType=\"dijit.form.CheckBox\" type=\"checkbox\" id=\"trgm_similarity_enabled\"
222 name=\"trgm_similarity_enabled\"
223 $checked>&nbsp;<label for=\"trgm_similarity_enabled\">".__('Mark similar articles as read')."</label>";
224
225 print "</div>";
226 }
227
228 function hook_prefs_save_feed($feed_id) {
229 $enabled_feeds = $this->host->get($this, "enabled_feeds");
230 if (!is_array($enabled_feeds)) $enabled_feeds = array();
231
232 $enable = checkbox_to_sql_bool($_POST["trgm_similarity_enabled"]) == 'true';
233 $key = array_search($feed_id, $enabled_feeds);
234
235 if ($enable) {
236 if ($key === FALSE) {
237 array_push($enabled_feeds, $feed_id);
238 }
239 } else {
240 if ($key !== FALSE) {
241 unset($enabled_feeds[$key]);
242 }
243 }
244
245 $this->host->set($this, "enabled_feeds", $enabled_feeds);
246 }
247
248 function hook_article_filter($article) {
249
250 if (DB_TYPE != "pgsql") return $article;
251
252 $result = db_query("select 'similarity'::regproc");
253 if (db_num_rows($result) == 0) return $article;
254
f46fe839
AD
255 $enable_globally = $this->host->get($this, "enable_globally");
256
257 if (!$enable_globally) {
258 $enabled_feeds = $this->host->get($this, "enabled_feeds");
259 $key = array_search($article["feed"]["id"], $enabled_feeds);
260 if ($key === FALSE) return $article;
261 }
117efb6f
AD
262
263 $similarity = (float) $this->host->get($this, "similarity");
264 if ($similarity < 0.01) return $article;
265
b1cefbc5 266 $min_title_length = (int) $this->host->get($this, "min_title_length");
117efb6f
AD
267 if (mb_strlen($article["title"]) < $min_title_length) return $article;
268
269 $owner_uid = $article["owner_uid"];
9264ec70 270 $entry_guid = $article["guid_hashed"];
117efb6f
AD
271 $title_escaped = db_escape_string($article["title"]);
272
4cbca7b2
AD
273 // trgm does not return similarity=1 for completely equal strings
274
275 $result = db_query("SELECT COUNT(id) AS nequal
276 FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id AND
d419aed5 277 date_entered >= NOW() - interval '3 days' AND
4cbca7b2 278 title = '$title_escaped' AND
9264ec70 279 guid != '$entry_guid' AND
4cbca7b2
AD
280 owner_uid = $owner_uid");
281
282 $nequal = db_fetch_result($result, 0, "nequal");
283 _debug("af_psql_trgm: num equals: $nequal");
284
285 if ($nequal != 0) {
286 $article["force_catchup"] = true;
287 return $article;
288 }
289
117efb6f
AD
290 $result = db_query("SELECT MAX(SIMILARITY(title, '$title_escaped')) AS ms
291 FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id AND
292 date_entered >= NOW() - interval '1 day' AND
9264ec70 293 guid != '$entry_guid' AND
117efb6f
AD
294 owner_uid = $owner_uid");
295
296 $similarity_result = db_fetch_result($result, 0, "ms");
297
4cbca7b2 298 _debug("af_psql_trgm: similarity result: $similarity_result");
117efb6f
AD
299
300 if ($similarity_result >= $similarity) {
301 $article["force_catchup"] = true;
302 }
303
304 return $article;
305
306 }
307
308 function api_version() {
309 return 2;
310 }
311
53df80c4
AD
312 private function filter_unknown_feeds($enabled_feeds) {
313 $tmp = array();
314
315 foreach ($enabled_feeds as $feed) {
316
317 $result = db_query("SELECT id FROM ttrss_feeds WHERE id = '$feed' AND owner_uid = " . $_SESSION["uid"]);
318
319 if (db_num_rows($result) != 0) {
320 array_push($tmp, $feed);
321 }
322 }
323
324 return $tmp;
325 }
326
117efb6f
AD
327}
328?>