]>
git.wh0rd.org - tt-rss.git/blob - plugins/cache_starred_images/init.php
2 class Cache_Starred_Images
extends Plugin
implements IHandler
{
9 "Automatically cache Starred articles' images and HTML5 video files",
15 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
17 function csrf_ignore($method) {
22 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
24 function before($method) {
32 function init($host) {
35 $this->cache_dir
= CACHE_DIR
. "/starred-images/";
37 if (!is_dir($this->cache_dir
)) {
38 mkdir($this->cache_dir
);
41 if (is_dir($this->cache_dir
)) {
43 if (!is_writable($this->cache_dir
))
44 chmod($this->cache_dir
, 0777);
46 if (is_writable($this->cache_dir
)) {
47 $host->add_hook($host::HOOK_UPDATE_TASK
, $this);
48 $host->add_hook($host::HOOK_HOUSE_KEEPING
, $this);
49 $host->add_hook($host::HOOK_SANITIZE
, $this);
50 $host->add_handler("public", "cache_starred_images_getimage", $this);
53 user_error("Starred cache directory is not writable.", E_USER_WARNING
);
57 user_error("Unable to create starred cache directory.", E_USER_WARNING
);
61 function cache_starred_images_getimage() {
64 $hash = basename($_REQUEST["hash"]);
68 $filename = $this->cache_dir
. "/" . basename($hash);
69 $is_video = strpos($filename, ".mp4") !== FALSE;
71 if (file_exists($filename)) {
72 header("Content-Disposition: attachment; filename=\"$hash\"");
74 /* See if we can use X-Sendfile */
76 if (function_exists('apache_get_modules') &&
77 array_search('mod_xsendfile', apache_get_modules()))
81 header("X-Sendfile: $filename");
82 header("Content-type: application/octet-stream");
83 header('Content-Disposition: attachment; filename="' . basename($filename) . '"');
85 header("Content-type: " . ($is_video ?
"video/mp4" : "image/png"));
86 $stamp = gmdate("D, d M Y H:i:s", filemtime($filename)). " GMT";
87 header("Last-Modified: $stamp", true);
91 header($_SERVER["SERVER_PROTOCOL"]." 404 Not Found");
92 echo "File not found.";
98 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
100 function hook_house_keeping() {
101 $files = glob($this->cache_dir
. "/*.{png,mp4}", GLOB_BRACE
);
103 $last_article_id = 0;
106 foreach ($files as $file) {
107 list ($article_id, $hash) = explode("-", basename($file));
109 if ($article_id != $last_article_id) {
110 $last_article_id = $article_id;
111 $article_id = db_escape_string($article_id);
113 $result = db_query("SELECT id FROM ttrss_entries WHERE id = " . $article_id);
115 $article_exists = db_num_rows($result) > 0;
118 if (!$article_exists) {
125 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
127 function hook_sanitize($doc, $site_url, $allowed_elements, $disallowed_attributes, $article_id) {
128 $xpath = new DOMXpath($doc);
131 $entries = $xpath->query('(//img[@src])|(//video/source[@src])');
133 foreach ($entries as $entry) {
134 if ($entry->hasAttribute('src')) {
135 $src = rewrite_relative_url($site_url, $entry->getAttribute('src'));
137 $extension = $entry->tagName
== 'source' ?
'.mp4' : '.png';
138 $local_filename = $this->cache_dir
. $article_id . "-" . sha1($src) . $extension;
140 if (file_exists($local_filename)) {
141 $entry->setAttribute("src", get_self_url_prefix() .
142 "/public.php?op=cache_starred_images_getimage&method=image&hash=" .
143 $article_id . "-" . sha1($src) . $extension);
153 function hook_update_task() {
154 $result = db_query("SELECT content, ttrss_user_entries.owner_uid, link, site_url, ttrss_entries.id, plugin_data
155 FROM ttrss_entries, ttrss_user_entries LEFT JOIN ttrss_feeds ON
156 (ttrss_user_entries.feed_id = ttrss_feeds.id)
157 WHERE ref_id = ttrss_entries.id AND
159 (UPPER(content) LIKE '%<IMG%' OR UPPER(content) LIKE '%<VIDEO%') AND
161 plugin_data NOT LIKE '%starred_cache_images%'
162 ORDER BY ".sql_random_function()." LIMIT 100");
164 while ($line = db_fetch_assoc($result)) {
165 if ($line["site_url"]) {
166 $success = $this->cache_article_images($line["content"], $line["site_url"], $line["owner_uid"], $line["id"]);
169 $plugin_data = db_escape_string("starred_cache_images,${line['owner_uid']}:" . $line["plugin_data"]);
171 db_query("UPDATE ttrss_entries SET plugin_data = '$plugin_data' WHERE id = " . $line["id"]);
178 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
180 function cache_article_images($content, $site_url, $owner_uid, $article_id) {
181 libxml_use_internal_errors(true);
183 $charset_hack = '<head>
184 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
187 $doc = new DOMDocument();
188 $doc->loadHTML($charset_hack . $content);
189 $xpath = new DOMXPath($doc);
191 $entries = $xpath->query('(//img[@src])|(//video/source[@src])');
196 foreach ($entries as $entry) {
198 if ($entry->hasAttribute('src') && strpos($entry->getAttribute('src'), "data:") !== 0) {
201 $src = rewrite_relative_url($site_url, $entry->getAttribute('src'));
203 $extension = $entry->tagName
== 'source' ?
'.mp4' : '.png';
205 $local_filename = $this->cache_dir
. $article_id . "-" . sha1($src) . $extension;
207 //_debug("cache_images: downloading: $src to $local_filename");
209 if (!file_exists($local_filename)) {
210 $file_content = fetch_file_contents($src);
212 if ($file_content && strlen($file_content) > 0) {
213 file_put_contents($local_filename, $file_content);
222 return $success ||
!$has_images;
225 function api_version() {