[tt-rss.git] / plugins / af_psql_trgm / init.php

<?php
class Af_Psql_Trgm extends Plugin {

	private $host;

	function about() {
		return array(1.0,
			"Marks similar articles as read (requires pg_trgm)",
			"fox");
	}

	function save() {
		$similarity = (float) db_escape_string($_POST["similarity"]);
		$min_title_length = (int) db_escape_string($_POST["min_title_length"]);

		if ($similarity < 0) $similarity = 0;
		if ($similarity > 1) $similarity = 1;

		if ($min_title_length < 0) $min_title_length = 0;

		$similarity = sprintf("%.2f", $similarity);

		$this->host->set($this, "similarity", $similarity);
		$this->host->set($this, "min_title_length", $min_title_length);

		echo T_sprintf("Data saved (%s)", $similarity);
	}

	function init($host) {
		$this->host = $host;

		$host->add_hook($host::HOOK_ARTICLE_FILTER, $this);
		$host->add_hook($host::HOOK_PREFS_TAB, $this);
		$host->add_hook($host::HOOK_PREFS_EDIT_FEED, $this);
		$host->add_hook($host::HOOK_PREFS_SAVE_FEED, $this);
		$host->add_hook($host::HOOK_ARTICLE_BUTTON, $this);

	}

	function get_js() {
		return file_get_contents(__DIR__ . "/init.js");
	}

	function showrelated() {
		$id = (int) db_escape_string($_REQUEST['param']);
		$owner_uid = $_SESSION["uid"];

		$result = db_query("SELECT title FROM ttrss_entries, ttrss_user_entries
			WHERE ref_id = id AND id = $id AND owner_uid = $owner_uid");

		$title = db_fetch_result($result, 0, "title");

		print "<h2>$title</h2>";

		$title = db_escape_string($title);
		$result = db_query("SELECT ttrss_entries.id AS id,
				feed_id,
				ttrss_entries.title AS title,
				updated, link,
				ttrss_feeds.title AS feed_title,
				SIMILARITY(ttrss_entries.title, '$title') AS sm
			FROM
				ttrss_entries, ttrss_user_entries LEFT JOIN ttrss_feeds ON (ttrss_feeds.id = feed_id)
			WHERE
				ttrss_entries.id = ref_id AND
				ttrss_user_entries.owner_uid = $owner_uid AND
				ttrss_entries.id != $id AND
				date_entered >= NOW() - INTERVAL '1 week'
			ORDER BY
				sm DESC, date_entered DESC
			LIMIT 10");

		print "<ul class=\"browseFeedList\" style=\"border-width : 1px\">";

		while ($line = db_fetch_assoc($result)) {
			print "<li>";
			print "<div class='insensitive small' style='margin-left : 20px; float : right'>" .
				smart_date_time(strtotime($line["updated"]))
				. "</div>";

			print "<img src='images/score_high.png' title='".sprintf("%.2f", $line['sm'])."'
				style='vertical-align : middle'>";

			$article_link = htmlspecialchars($line["link"]);
			print " <a target=\"_blank\" href=\"$article_link\">".
				$line["title"]."</a>";

			print " (<a href=\"#\" onclick=\"viewfeed(".$line["feed_id"].")\">".
				htmlspecialchars($line["feed_title"])."</a>)";

			print "</li>";
		}

		print "</ul>";

		print "<div style='text-align : center'>";
		print "<button dojoType=\"dijit.form.Button\" onclick=\"dijit.byId('trgmRelatedDlg').hide()\">".__('Close this window')."</button>";
		print "</div>";


	}

	function hook_article_button($line) {
		return "<img src=\"plugins/af_psql_trgm/button.png\"
			style=\"cursor : pointer\" style=\"cursor : pointer\"
			onclick=\"showTrgmRelated(".$line["id"].")\"
			class='tagsPic' title='".__('Show related articles')."'>";
	}

	function hook_prefs_tab($args) {
		if ($args != "prefFeeds") return;

		print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"".__('Mark similar articles as read')."\">";

		if (DB_TYPE != "pgsql") {
			print_error("Database type not supported.");
		}

		$result = db_query("select 'similarity'::regproc");

		if (db_num_rows($result) == 0) {
			print_error("pg_trgm extension not found.");
		}

		$similarity = $this->host->get($this, "similarity");
		$min_title_length = $this->host->get($this, "min_title_length");

		if (!$similarity) $similarity = '0.75';
		if (!$min_title_length) $min_title_length = '32';

		print "<form dojoType=\"dijit.form.Form\">";

		print "<script type=\"dojo/method\" event=\"onSubmit\" args=\"evt\">
			evt.preventDefault();
			if (this.validate()) {
				console.log(dojo.objectToQuery(this.getValues()));
				new Ajax.Request('backend.php', {
					parameters: dojo.objectToQuery(this.getValues()),
					onComplete: function(transport) {
						notify_info(transport.responseText);
					}
				});
				//this.reset();
			}
			</script>";

		print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"op\" value=\"pluginhandler\">";
		print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"method\" value=\"save\">";
		print "<input dojoType=\"dijit.form.TextBox\" style=\"display : none\" name=\"plugin\" value=\"af_psql_trgm\">";

		print_notice("PostgreSQL trigram extension returns string similarity as a floating point number (0-1). Setting it too low might produce false positives, zero disables checking.");

		print "<br/>";
		print_notice("Enable the plugin for specific feeds in the feed editor.");

		print "<h3>" . __("Global settings") . "</h3>";

		print "<table>";

		print "<tr><td width=\"40%\">".__("Minimum similarity:")."</td>";
		print "<td>
			<input dojoType=\"dijit.form.ValidationTextBox\"
			placeholder=\"0.75\"
			required=\"1\" name=\"similarity\" value=\"$similarity\"></td></tr>";
		print "<tr><td width=\"40%\">".__("Minimum title length:")."</td>";
		print "<td>
			<input dojoType=\"dijit.form.ValidationTextBox\"
			placeholder=\"32\"
			required=\"1\" name=\"min_title_length\" value=\"$min_title_length\"></td></tr>";

		print "</table>";

		print "<p><button dojoType=\"dijit.form.Button\" type=\"submit\">".
			__("Save")."</button>";

		print "</form>";

		$enabled_feeds = $this->host->get($this, "enabled_feeds");
		if (!array($enabled_feeds)) $enabled_feeds = array();

		if (count($enabled_feeds) > 0) {
			print "<h3>" . __("Currently enabled for (click to edit):") . "</h3>";

			print "<ul class=\"browseFeedList\" style=\"border-width : 1px\">";
			foreach ($enabled_feeds as $f) {
				print "<li>" .
					"<img src='images/pub_set.png'
						style='vertical-align : middle'> <a href='#'
						onclick='editFeed($f)'>".
					getFeedTitle($f) . "</a></li>";
			}
			print "</ul>";
		}

		print "</div>";
	}

	function hook_prefs_edit_feed($feed_id) {
		print "<div class=\"dlgSec\">".__("Similarity (pg_trgm)")."</div>";
		print "<div class=\"dlgSecCont\">";

		$enabled_feeds = $this->host->get($this, "enabled_feeds");
		if (!array($enabled_feeds)) $enabled_feeds = array();

		$key = array_search($feed_id, $enabled_feeds);
		$checked = $key !== FALSE ? "checked" : "";

		print "<hr/><input dojoType=\"dijit.form.CheckBox\" type=\"checkbox\" id=\"trgm_similarity_enabled\"
			name=\"trgm_similarity_enabled\"
			$checked>&nbsp;<label for=\"trgm_similarity_enabled\">".__('Mark similar articles as read')."</label>";

		print "</div>";
	}

	function hook_prefs_save_feed($feed_id) {
		$enabled_feeds = $this->host->get($this, "enabled_feeds");
		if (!is_array($enabled_feeds)) $enabled_feeds = array();

		$enable = checkbox_to_sql_bool($_POST["trgm_similarity_enabled"]) == 'true';
		$key = array_search($feed_id, $enabled_feeds);

		if ($enable) {
			if ($key === FALSE) {
				array_push($enabled_feeds, $feed_id);
			}
		} else {
			if ($key !== FALSE) {
				unset($enabled_feeds[$key]);
			}
		}

		$this->host->set($this, "enabled_feeds", $enabled_feeds);
	}

	function hook_article_filter($article) {

		if (DB_TYPE != "pgsql") return $article;

		$result = db_query("select 'similarity'::regproc");
		if (db_num_rows($result) == 0) return $article;

		$enabled_feeds = $this->host->get($this, "enabled_feeds");
		$key = array_search($article["feed"]["id"], $enabled_feeds);
		if ($key === FALSE) return $article;

		$similarity = (float) $this->host->get($this, "similarity");
		if ($similarity < 0.01) return $article;

		$min_title_length = (int) $this->host->get($this, "min_length");
		if (mb_strlen($article["title"]) < $min_title_length) return $article;

		$owner_uid = $article["owner_uid"];
		$feed_id = $article["feed"]["id"];

		$title_escaped = db_escape_string($article["title"]);

		$result = db_query("SELECT MAX(SIMILARITY(title, '$title_escaped')) AS ms
		  FROM ttrss_entries, ttrss_user_entries WHERE ref_id = id AND
		  date_entered >= NOW() - interval '1 day' AND
		  owner_uid = $owner_uid");

		$similarity_result = db_fetch_result($result, 0, "ms");

		//_debug("similarity result: $similarity_result");

		if ($similarity_result >= $similarity) {
			$article["force_catchup"] = true;
		}

		return $article;

	}

	function api_version() {
		return 2;
	}

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