ttrss/plugins/af_readability/init.php

363 lines
9.2 KiB
PHP
Raw Normal View History

2015-07-06 20:02:21 +00:00
<?php
2021-02-26 16:55:49 +00:00
require_once __DIR__ . "/vendor/autoload.php";
2021-02-26 16:55:49 +00:00
use \andreskrey\Readability\Readability;
use \andreskrey\Readability\Configuration;
2015-07-06 20:02:21 +00:00
class Af_Readability extends Plugin {
/** @var PluginHost $host */
2015-07-06 20:02:21 +00:00
private $host;
function about() {
return array(null,
2015-07-06 20:02:21 +00:00
"Try to inline article content using Readability",
"fox");
}
function flags() {
return array("needs_curl" => true);
}
/** @return void */
2015-07-06 20:02:21 +00:00
function save() {
$enable_share_anything = checkbox_to_sql_bool($_POST["enable_share_anything"] ?? "");
$this->host->set($this, "enable_share_anything", $enable_share_anything);
echo __("Data saved.");
2015-07-06 20:02:21 +00:00
}
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);
// Note: we have to install the hook even if disabled because init() is being run before plugin data has loaded
// so we can't check for our storage-set options here
$host->add_hook($host::HOOK_GET_FULL_TEXT, $this);
$host->add_filter_action($this, "action_inline", __("Inline content"));
$host->add_filter_action($this, "action_inline_append", __("Append content"));
2015-07-06 20:02:21 +00:00
}
function get_js() {
return file_get_contents(__DIR__ . "/init.js");
}
function hook_article_button($line) {
return "<i class='material-icons' onclick=\"Plugins.Af_Readability.embed(".$line["id"].")\"
style='cursor : pointer' title=\"".__('Toggle full article text')."\">description</i>";
}
2015-07-06 20:02:21 +00:00
function hook_prefs_tab($args) {
if ($args != "prefFeeds") return;
2021-02-17 09:36:02 +00:00
$enable_share_anything = sql_bool_to_bool($this->host->get($this, "enable_share_anything"));
2015-07-06 20:02:21 +00:00
2021-02-17 09:36:02 +00:00
?>
<div dojoType='dijit.layout.AccordionPane'
title="<i class='material-icons'>extension</i> <?= __('Readability settings (af_readability)') ?>">
2021-02-17 09:36:02 +00:00
<?= format_notice("Enable for specific feeds in the feed editor.") ?>
2021-02-17 09:36:02 +00:00
<form dojoType='dijit.form.Form'>
2019-02-22 09:48:02 +00:00
<?= \Controls\pluginhandler_tags($this, "save") ?>
<script type="dojo/method" event="onSubmit" args="evt">
2021-02-17 09:36:02 +00:00
evt.preventDefault();
if (this.validate()) {
Notify.progress('Saving data...', true);
xhr.post("backend.php", this.getValues(), (reply) => {
Notify.info(reply);
})
2021-02-17 09:36:02 +00:00
}
</script>
2021-02-17 09:36:02 +00:00
<fieldset>
<label class='checkbox'>
<?= \Controls\checkbox_tag("enable_share_anything", $enable_share_anything) ?>
<?= __("Provide full-text services to core code (bookmarklets) and other plugins") ?>
</label>
</fieldset>
<hr/>
<?= \Controls\submit_tag(__("Save")) ?>
</form>
<?php
/* cleanup */
$enabled_feeds = $this->filter_unknown_feeds(
$this->get_stored_array("enabled_feeds"));
$append_feeds = $this->filter_unknown_feeds(
$this->get_stored_array("append_feeds"));
$this->host->set($this, "enabled_feeds", $enabled_feeds);
$this->host->set($this, "append_feeds", $append_feeds);
?>
<?php if (count($enabled_feeds) > 0) { ?>
<hr/>
<h3><?= __("Currently enabled for (click to edit):") ?></h3>
<ul class='panel panel-scrollable list list-unstyled'>
<?php foreach ($enabled_feeds as $f) { ?>
<li>
<i class='material-icons'>rss_feed</i>
<a href='#' onclick="CommonDialogs.editFeed(<?= $f ?>)">
<?= Feeds::_get_title($f) . " " . (in_array($f, $append_feeds) ? __("(append)") : "") ?>
</a>
</li>
<?php } ?>
</ul>
<?php } ?>
</div>
<?php
2015-07-06 20:02:21 +00:00
}
function hook_prefs_edit_feed($feed_id) {
$enabled_feeds = $this->get_stored_array("enabled_feeds");
$append_feeds = $this->get_stored_array("append_feeds");
2021-02-17 10:55:58 +00:00
?>
2015-07-06 20:02:21 +00:00
2021-02-17 10:55:58 +00:00
<header><?= __("Readability") ?></header>
<section>
<fieldset>
<label class='checkbox'>
<?= \Controls\checkbox_tag("af_readability_enabled", in_array($feed_id, $enabled_feeds)) ?>
<?= __('Inline article content') ?>
</label>
</fieldset>
<fieldset>
<label class='checkbox'>
<?= \Controls\checkbox_tag("af_readability_append", in_array($feed_id, $append_feeds)) ?>
<?= __('Append to summary, instead of replacing it') ?>
</label>
</fieldset>
</section>
<?php
2015-07-06 20:02:21 +00:00
}
function hook_prefs_save_feed($feed_id) {
$enabled_feeds = $this->get_stored_array("enabled_feeds");
$append_feeds = $this->get_stored_array("append_feeds");
2015-07-06 20:02:21 +00:00
$enable = checkbox_to_sql_bool($_POST["af_readability_enabled"] ?? "");
$append = checkbox_to_sql_bool($_POST["af_readability_append"] ?? "");
$enable_key = array_search($feed_id, $enabled_feeds);
$append_key = array_search($feed_id, $append_feeds);
2015-07-06 20:02:21 +00:00
if ($enable) {
if ($enable_key === false) {
2015-07-06 20:02:21 +00:00
array_push($enabled_feeds, $feed_id);
}
} else {
if ($enable_key !== false) {
unset($enabled_feeds[$enable_key]);
}
}
if ($append) {
if ($append_key === false) {
array_push($append_feeds, $feed_id);
}
} else {
if ($append_key !== false) {
unset($append_feeds[$append_key]);
2015-07-06 20:02:21 +00:00
}
}
$this->host->set($this, "enabled_feeds", $enabled_feeds);
$this->host->set($this, "append_feeds", $append_feeds);
2015-07-06 20:02:21 +00:00
}
function hook_article_filter_action($article, $action) {
switch ($action) {
case "action_inline":
return $this->process_article($article, false);
case "action_append":
return $this->process_article($article, true);
}
return $article;
}
2015-07-06 20:02:21 +00:00
/**
* @param string $url
* @return string|false
*/
public function extract_content(string $url) {
$tmp = UrlHelper::fetch([
"url" => $url,
"http_accept" => "text/*",
"type" => "text/html"]);
2015-07-06 20:02:21 +00:00
if ($tmp && mb_strlen($tmp) < 1024 * 500) {
$tmpdoc = new DOMDocument("1.0", "UTF-8");
if (!@$tmpdoc->loadHTML($tmp))
return false;
// this is the worst hack yet :(
if (strtolower($tmpdoc->encoding) != 'utf-8') {
$tmp = preg_replace("/<meta.*?charset.*?\/?>/i", "", $tmp);
if (empty($tmpdoc->encoding)) {
$tmp = mb_convert_encoding($tmp, 'utf-8');
} else {
$tmp = mb_convert_encoding($tmp, 'utf-8', $tmpdoc->encoding);
}
}
try {
$r = new Readability(new Configuration());
if ($r->parse($tmp)) {
$tmpxpath = new DOMXPath($r->getDOMDOcument());
$entries = $tmpxpath->query('(//a[@href]|//img[@src])');
foreach ($entries as $entry) {
if ($entry->hasAttribute("href")) {
$entry->setAttribute("href",
UrlHelper::rewrite_relative(UrlHelper::$fetch_effective_url, $entry->getAttribute("href")));
}
if ($entry->hasAttribute("src")) {
if ($entry->hasAttribute("data-src")) {
$src = $entry->getAttribute("data-src");
} else {
$src = $entry->getAttribute("src");
}
$entry->setAttribute("src",
UrlHelper::rewrite_relative(UrlHelper::$fetch_effective_url, $src));
}
}
return $r->getContent();
}
} catch (Exception $e) {
return false;
2015-07-06 20:02:21 +00:00
}
}
return false;
}
/**
* @param array<string, mixed> $article
* @param bool $append_mode
* @return array<string,mixed>
* @throws PDOException
*/
function process_article(array $article, bool $append_mode) : array {
$extracted_content = $this->extract_content($article["link"]);
# let's see if there's anything of value in there
$content_test = trim(strip_tags(Sanitizer::sanitize($extracted_content)));
if ($content_test) {
if ($append_mode)
$article["content"] .= "<hr/>" . $extracted_content;
else
$article["content"] = $extracted_content;
}
2015-07-06 20:02:21 +00:00
return $article;
}
/**
* @param string $name
* @return array<int|string, mixed>
* @throws PDOException
* @deprecated
*/
private function get_stored_array(string $name) : array {
return $this->host->get_array($this, $name);
}
function hook_article_filter($article) {
$enabled_feeds = $this->get_stored_array("enabled_feeds");
$append_feeds = $this->get_stored_array("append_feeds");
$feed_id = $article["feed"]["id"];
if (!in_array($feed_id, $enabled_feeds))
return $article;
return $this->process_article($article, in_array($feed_id, $append_feeds));
2015-07-06 20:02:21 +00:00
}
function hook_get_full_text($link) {
$enable_share_anything = $this->host->get($this, "enable_share_anything");
if ($enable_share_anything) {
$extracted_content = $this->extract_content($link);
# let's see if there's anything of value in there
$content_test = trim(strip_tags(Sanitizer::sanitize($extracted_content)));
if ($content_test) {
return $extracted_content;
}
}
return false;
}
2015-07-06 20:02:21 +00:00
function api_version() {
return 2;
}
/**
* @param array<int> $enabled_feeds
* @return array<int>
* @throws PDOException
*/
private function filter_unknown_feeds(array $enabled_feeds) : array {
2015-07-06 20:02:21 +00:00
$tmp = array();
foreach ($enabled_feeds as $feed) {
2015-07-06 20:02:21 +00:00
2017-12-03 07:44:43 +00:00
$sth = $this->pdo->prepare("SELECT id FROM ttrss_feeds WHERE id = ? AND owner_uid = ?");
$sth->execute([$feed, $_SESSION['uid']]);
2015-07-06 20:02:21 +00:00
2017-12-03 07:44:43 +00:00
if ($row = $sth->fetch()) {
array_push($tmp, $feed);
2015-07-06 20:02:21 +00:00
}
}
return $tmp;
}
function embed() : void {
$article_id = (int) $_REQUEST["id"];
$sth = $this->pdo->prepare("SELECT link FROM ttrss_entries WHERE id = ?");
$sth->execute([$article_id]);
$ret = [];
if ($row = $sth->fetch()) {
$ret["content"] = Sanitizer::sanitize($this->extract_content($row["link"]));
}
print json_encode($ret);
}
2015-07-06 20:02:21 +00:00
}