]>
git.wh0rd.org - tt-rss.git/blob - plugins/af_psql_trgm/init.php
2 class Af_Psql_Trgm
extends Plugin
{
8 "Marks similar articles as read (requires pg_trgm)" ,
13 $similarity = ( float ) db_escape_string ( $_POST [ "similarity" ]);
14 $min_title_length = ( int ) db_escape_string ( $_POST [ "min_title_length" ]);
15 $enable_globally = checkbox_to_sql_bool ( $_POST [ "enable_globally" ]) == "true" ;
17 if ( $similarity < 0 ) $similarity = 0 ;
18 if ( $similarity > 1 ) $similarity = 1 ;
20 if ( $min_title_length < 0 ) $min_title_length = 0 ;
22 $similarity = sprintf ( "%.2f" , $similarity );
24 $this -> host
-> set ( $this , "similarity" , $similarity );
25 $this -> host
-> set ( $this , "min_title_length" , $min_title_length );
26 $this -> host
-> set ( $this , "enable_globally" , $enable_globally );
28 echo T_sprintf ( "Data saved ( %s , %d )" , $similarity , $enable_globally );
31 function init ( $host ) {
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 );
38 $host -> add_hook ( $host :: HOOK_ARTICLE_BUTTON
, $this );
43 return file_get_contents ( __DIR__
. "/init.js" );
46 function showrelated () {
47 $id = ( int ) db_escape_string ( $_REQUEST [ 'param' ]);
48 $owner_uid = $_SESSION [ "uid" ];
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 " );
53 $title = db_fetch_result ( $result , 0 , "title" );
55 print "<h2> $title </h2>" ;
57 $title = db_escape_string ( $title );
58 $result = db_query ( "SELECT ttrss_entries.id AS id,
60 ttrss_entries.title AS title,
62 ttrss_feeds.title AS feed_title,
63 SIMILARITY(ttrss_entries.title, ' $title ') AS sm
65 ttrss_entries, ttrss_user_entries LEFT JOIN ttrss_feeds ON (ttrss_feeds.id = feed_id)
67 ttrss_entries.id = ref_id AND
68 ttrss_user_entries.owner_uid = $owner_uid AND
69 ttrss_entries.id != $id AND
70 date_entered >= NOW() - INTERVAL '2 weeks'
72 sm DESC, date_entered DESC
75 print "<ul class= \" browseFeedList \" style= \" border-width : 1px \" >" ;
77 while ( $line = db_fetch_assoc ( $result )) {
79 print "<div class='insensitive small' style='margin-left : 20px; float : right'>" .
80 smart_date_time ( strtotime ( $line [ "updated" ]))
83 $sm = sprintf ( "%.2f" , $line [ 'sm' ]);
84 print "<img src='images/score_high.png' title=' $sm '
85 style='vertical-align : middle'>" ;
87 $article_link = htmlspecialchars ( $line [ "link" ]);
88 print " <a target= \" _blank \" href= \" $article_link\" >" .
89 $line [ "title" ]. "</a>" ;
91 print " (<a href= \" # \" onclick= \" viewfeed({feed:" . $line [ "feed_id" ]. "}) \" >" .
92 htmlspecialchars ( $line [ "feed_title" ]). "</a>)" ;
94 print " <span class='insensitive'>( $sm )</span>" ;
101 print "<div style='text-align : center'>" ;
102 print "<button dojoType= \" dijit.form.Button \" onclick= \" dijit.byId('trgmRelatedDlg').hide() \" >" . __ ( 'Close this window' ). "</button>" ;
108 function hook_article_button ( $line ) {
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' ). "'>" ;
115 function hook_prefs_tab ( $args ) {
116 if ( $args != "prefFeeds" ) return ;
118 print "<div dojoType= \" dijit.layout.AccordionPane \" title= \" " . __ ( 'Mark similar articles as read' ). " \" >" ;
120 if ( DB_TYPE
!= "pgsql" ) {
121 print_error ( "Database type not supported." );
124 $result = db_query ( "select 'similarity'::regproc" );
126 if ( db_num_rows ( $result ) == 0 ) {
127 print_error ( "pg_trgm extension not found." );
130 $similarity = $this -> host
-> get ( $this , "similarity" );
131 $min_title_length = $this -> host
-> get ( $this , "min_title_length" );
132 $enable_globally = $this -> host
-> get ( $this , "enable_globally" );
134 if (! $similarity ) $similarity = '0.75' ;
135 if (! $min_title_length ) $min_title_length = '32' ;
137 $enable_globally_checked = $enable_globally ?
"checked" : "" ;
139 print "<form dojoType= \" dijit.form.Form \" >" ;
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);
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 \" >" ;
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>" ;
160 print_notice ( "Enable the plugin for specific feeds in the feed editor." );
162 print "<h3>" . __ ( "Global settings" ) . "</h3>" ;
166 print "<tr><td width= \" 40% \" >" . __ ( "Minimum similarity:" ). "</td>" ;
168 <input dojoType= \" dijit.form.ValidationTextBox \"
170 required= \" 1 \" name= \" similarity \" value= \" $similarity\" ></td></tr>" ;
171 print "<tr><td width= \" 40% \" >" . __ ( "Minimum title length:" ). "</td>" ;
173 <input dojoType= \" dijit.form.ValidationTextBox \"
175 required= \" 1 \" name= \" min_title_length \" value= \" $min_title_length\" ></td></tr>" ;
176 print "<tr><td width= \" 40% \" >" . __ ( "Enable for all feeds:" ). "</td>" ;
178 <input dojoType= \" dijit.form.CheckBox \"
179 $enable_globally_checked name= \" enable_globally \" ></td></tr>" ;
183 print "<p><button dojoType= \" dijit.form.Button \" type= \" submit \" >" .
184 __ ( "Save" ). "</button>" ;
188 $enabled_feeds = $this -> host
-> get ( $this , "enabled_feeds" );
189 if (! array ( $enabled_feeds )) $enabled_feeds = array ();
191 $enabled_feeds = $this -> filter_unknown_feeds ( $enabled_feeds );
192 $this -> host
-> set ( $this , "enabled_feeds" , $enabled_feeds );
194 if ( count ( $enabled_feeds ) > 0 ) {
195 print "<h3>" . __ ( "Currently enabled for (click to edit):" ) . "</h3>" ;
197 print "<ul class= \" browseFeedList \" style= \" border-width : 1px \" >" ;
198 foreach ( $enabled_feeds as $f ) {
200 "<img src='images/pub_set.png'
201 style='vertical-align : middle'> <a href='#'
202 onclick='editFeed( $f )'>" .
203 getFeedTitle ( $f ) . "</a></li>" ;
211 function hook_prefs_edit_feed ( $feed_id ) {
212 print "<div class= \" dlgSec \" >" . __ ( "Similarity (pg_trgm)" ). "</div>" ;
213 print "<div class= \" dlgSecCont \" >" ;
215 $enabled_feeds = $this -> host
-> get ( $this , "enabled_feeds" );
216 if (! array ( $enabled_feeds )) $enabled_feeds = array ();
218 $key = array_search ( $feed_id , $enabled_feeds );
219 $checked = $key !== FALSE ?
"checked" : "" ;
221 print "<hr/><input dojoType= \" dijit.form.CheckBox \" type= \" checkbox \" id= \" trgm_similarity_enabled \"
222 name= \" trgm_similarity_enabled \"
223 $checked > <label for= \" trgm_similarity_enabled \" >" . __ ( 'Mark similar articles as read' ). "</label>" ;
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 ();
232 $enable = checkbox_to_sql_bool ( $_POST [ "trgm_similarity_enabled" ]) == 'true' ;
233 $key = array_search ( $feed_id , $enabled_feeds );
236 if ( $key === FALSE ) {
237 array_push ( $enabled_feeds , $feed_id );
240 if ( $key !== FALSE ) {
241 unset ( $enabled_feeds [ $key ]);
245 $this -> host
-> set ( $this , "enabled_feeds" , $enabled_feeds );
248 function hook_article_filter ( $article ) {
250 if ( DB_TYPE
!= "pgsql" ) return $article ;
252 $result = db_query ( "select 'similarity'::regproc" );
253 if ( db_num_rows ( $result ) == 0 ) return $article ;
255 $enable_globally = $this -> host
-> get ( $this , "enable_globally" );
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 ;
263 $similarity = ( float ) $this -> host
-> get ( $this , "similarity" );
264 if ( $similarity < 0.01 ) return $article ;
266 $min_title_length = ( int ) $this -> host
-> get ( $this , "min_title_length" );
267 if ( mb_strlen ( $article [ "title" ]) < $min_title_length ) return $article ;
269 $owner_uid = $article [ "owner_uid" ];
270 $entry_guid = $article [ "guid_hashed" ];
271 $title_escaped = db_escape_string ( $article [ "title" ]);
273 // trgm does not return similarity=1 for completely equal strings
275 $result = db_query ( "SELECT COUNT(id) AS nequal
276 FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id AND
277 date_entered >= NOW() - interval '3 days' AND
278 title = ' $title_escaped ' AND
279 guid != ' $entry_guid ' AND
280 owner_uid = $owner_uid " );
282 $nequal = db_fetch_result ( $result , 0 , "nequal" );
283 _debug ( "af_psql_trgm: num equals: $nequal " );
286 $article [ "force_catchup" ] = true ;
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
293 guid != ' $entry_guid ' AND
294 owner_uid = $owner_uid " );
296 $similarity_result = db_fetch_result ( $result , 0 , "ms" );
298 _debug ( "af_psql_trgm: similarity result: $similarity_result " );
300 if ( $similarity_result >= $similarity ) {
301 $article [ "force_catchup" ] = true ;
308 function api_version () {
312 private function filter_unknown_feeds ( $enabled_feeds ) {
315 foreach ( $enabled_feeds as $feed ) {
317 $result = db_query ( "SELECT id FROM ttrss_feeds WHERE id = ' $feed ' AND owner_uid = " . $_SESSION [ "uid" ]);
319 if ( db_num_rows ( $result ) != 0 ) {
320 array_push ( $tmp , $feed );