opml.php 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  1. <?php
  2. class Opml extends Handler_Protected {
  3. function csrf_ignore($method) {
  4. $csrf_ignored = array("export", "import");
  5. return array_search($method, $csrf_ignored) !== false;
  6. }
  7. function export() {
  8. $output_name = $_REQUEST["filename"];
  9. if (!$output_name) $output_name = "TinyTinyRSS.opml";
  10. $show_settings = $_REQUEST["settings"];
  11. $owner_uid = $_SESSION["uid"];
  12. $rc = $this->opml_export($output_name, $owner_uid, false, ($show_settings == 1));
  13. return $rc;
  14. }
  15. function import() {
  16. $owner_uid = $_SESSION["uid"];
  17. header('Content-Type: text/html; charset=utf-8');
  18. print "<html>
  19. <head>
  20. ".stylesheet_tag("css/default.css")."
  21. <title>".__("OPML Utility")."</title>
  22. <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\"/>
  23. </head>
  24. <body class='claro ttrss_utility'>
  25. <div class=\"floatingLogo\"><img src=\"images/logo_small.png\"></div>
  26. <h1>".__('OPML Utility')."</h1><div class='content'>";
  27. add_feed_category("Imported feeds");
  28. $this->opml_notice(__("Importing OPML..."));
  29. $this->opml_import($owner_uid);
  30. print "<br><form method=\"GET\" action=\"prefs.php\">
  31. <input type=\"submit\" value=\"".__("Return to preferences")."\">
  32. </form>";
  33. print "</div></body></html>";
  34. }
  35. // Export
  36. private function opml_export_category($owner_uid, $cat_id, $hide_private_feeds=false) {
  37. $cat_id = (int) $cat_id;
  38. if ($hide_private_feeds)
  39. $hide_qpart = "(private IS false AND auth_login = '' AND auth_pass = '')";
  40. else
  41. $hide_qpart = "true";
  42. $out = "";
  43. if ($cat_id) {
  44. $sth = $this->pdo->prepare("SELECT title FROM ttrss_feed_categories WHERE id = ?
  45. AND owner_uid = ?");
  46. $sth->execute([$cat_id, $owner_uid]);
  47. $row = $sth->fetch();
  48. $cat_title = htmlspecialchars($row['title']);
  49. }
  50. if ($cat_title) $out .= "<outline text=\"$cat_title\">\n";
  51. $sth = $this->pdo->prepare("SELECT id,title
  52. FROM ttrss_feed_categories WHERE
  53. (parent_cat = :cat OR (:cat = 0 AND parent_cat IS NULL)) AND
  54. owner_uid = :uid ORDER BY order_id, title");
  55. $sth->execute([':cat' => $cat_id, ':uid' => $owner_uid]);
  56. while ($line = $sth->fetch()) {
  57. $out .= $this->opml_export_category($owner_uid, $line["id"], $hide_private_feeds);
  58. }
  59. $fsth = $this->pdo->prepare("select title, feed_url, site_url
  60. FROM ttrss_feeds WHERE
  61. (cat_id = :cat OR (:cat = 0 AND cat_id IS NULL)) AND owner_uid = :uid AND $hide_qpart
  62. ORDER BY order_id, title");
  63. $fsth->execute([':cat' => $cat_id, ':uid' => $owner_uid]);
  64. while ($fline = $fsth->fetch()) {
  65. $title = htmlspecialchars($fline["title"]);
  66. $url = htmlspecialchars($fline["feed_url"]);
  67. $site_url = htmlspecialchars($fline["site_url"]);
  68. if ($site_url) {
  69. $html_url_qpart = "htmlUrl=\"$site_url\"";
  70. } else {
  71. $html_url_qpart = "";
  72. }
  73. $out .= "<outline type=\"rss\" text=\"$title\" xmlUrl=\"$url\" $html_url_qpart/>\n";
  74. }
  75. if ($cat_title) $out .= "</outline>\n";
  76. return $out;
  77. }
  78. function opml_export($name, $owner_uid, $hide_private_feeds=false, $include_settings=true) {
  79. if (!$owner_uid) return;
  80. if (!isset($_REQUEST["debug"])) {
  81. header("Content-type: application/xml+opml");
  82. header("Content-Disposition: attachment; filename=" . $name );
  83. } else {
  84. header("Content-type: text/xml");
  85. }
  86. $out = "<?xml version=\"1.0\" encoding=\"utf-8\"?".">";
  87. $out .= "<opml version=\"1.0\">";
  88. $out .= "<head>
  89. <dateCreated>" . date("r", time()) . "</dateCreated>
  90. <title>Tiny Tiny RSS Feed Export</title>
  91. </head>";
  92. $out .= "<body>";
  93. $out .= $this->opml_export_category($owner_uid, 0, $hide_private_feeds);
  94. # export tt-rss settings
  95. if ($include_settings) {
  96. $out .= "<outline text=\"tt-rss-prefs\" schema-version=\"".SCHEMA_VERSION."\">";
  97. $sth = $this->pdo->prepare("SELECT pref_name, value FROM ttrss_user_prefs WHERE
  98. profile IS NULL AND owner_uid = ? ORDER BY pref_name");
  99. $sth->execute([$owner_uid]);
  100. while ($line = $sth->fetch()) {
  101. $name = $line["pref_name"];
  102. $value = htmlspecialchars($line["value"]);
  103. $out .= "<outline pref-name=\"$name\" value=\"$value\"/>";
  104. }
  105. $out .= "</outline>";
  106. $out .= "<outline text=\"tt-rss-labels\" schema-version=\"".SCHEMA_VERSION."\">";
  107. $sth = $this->pdo->prepare("SELECT * FROM ttrss_labels2 WHERE
  108. owner_uid = ?");
  109. $sth->execute([$owner_uid]);
  110. while ($line = $sth->fetch()) {
  111. $name = htmlspecialchars($line['caption']);
  112. $fg_color = htmlspecialchars($line['fg_color']);
  113. $bg_color = htmlspecialchars($line['bg_color']);
  114. $out .= "<outline label-name=\"$name\" label-fg-color=\"$fg_color\" label-bg-color=\"$bg_color\"/>";
  115. }
  116. $out .= "</outline>";
  117. $out .= "<outline text=\"tt-rss-filters\" schema-version=\"".SCHEMA_VERSION."\">";
  118. $sth = $this->pdo->prepare("SELECT * FROM ttrss_filters2
  119. WHERE owner_uid = ? ORDER BY id");
  120. $sth->execute([$owner_uid]);
  121. while ($line = $sth->fetch()) {
  122. $line["rules"] = array();
  123. $line["actions"] = array();
  124. $tmph = $this->pdo->prepare("SELECT * FROM ttrss_filters2_rules
  125. WHERE filter_id = ?");
  126. $tmph->execute([$line['id']]);
  127. while ($tmp_line = $tmph->fetch()) {
  128. unset($tmp_line["id"]);
  129. unset($tmp_line["filter_id"]);
  130. $cat_filter = $tmp_line["cat_filter"];
  131. if (!$tmp_line["match_on"]) {
  132. if ($cat_filter && $tmp_line["cat_id"] || $tmp_line["feed_id"]) {
  133. $tmp_line["feed"] = Feeds::getFeedTitle(
  134. $cat_filter ? $tmp_line["cat_id"] : $tmp_line["feed_id"],
  135. $cat_filter);
  136. } else {
  137. $tmp_line["feed"] = "";
  138. }
  139. } else {
  140. $match = [];
  141. foreach (json_decode($tmp_line["match_on"], true) as $feed_id) {
  142. if (strpos($feed_id, "CAT:") === 0) {
  143. $feed_id = (int)substr($feed_id, 4);
  144. if ($feed_id) {
  145. array_push($match, [Feeds::getCategoryTitle($feed_id), true, false]);
  146. } else {
  147. array_push($match, [0, true, true]);
  148. }
  149. } else {
  150. if ($feed_id) {
  151. array_push($match, [Feeds::getFeedTitle((int)$feed_id), false, false]);
  152. } else {
  153. array_push($match, [0, false, true]);
  154. }
  155. }
  156. }
  157. $tmp_line["match"] = $match;
  158. unset($tmp_line["match_on"]);
  159. }
  160. unset($tmp_line["feed_id"]);
  161. unset($tmp_line["cat_id"]);
  162. array_push($line["rules"], $tmp_line);
  163. }
  164. $tmph = $this->pdo->prepare("SELECT * FROM ttrss_filters2_actions
  165. WHERE filter_id = ?");
  166. $tmph->execute([$line['id']]);
  167. while ($tmp_line = $tmph->fetch()) {
  168. unset($tmp_line["id"]);
  169. unset($tmp_line["filter_id"]);
  170. array_push($line["actions"], $tmp_line);
  171. }
  172. unset($line["id"]);
  173. unset($line["owner_uid"]);
  174. $filter = json_encode($line);
  175. $out .= "<outline filter-type=\"2\"><![CDATA[$filter]]></outline>";
  176. }
  177. $out .= "</outline>";
  178. }
  179. $out .= "</body></opml>";
  180. // Format output.
  181. $doc = new DOMDocument();
  182. $doc->formatOutput = true;
  183. $doc->preserveWhiteSpace = false;
  184. $doc->loadXML($out);
  185. $xpath = new DOMXpath($doc);
  186. $outlines = $xpath->query("//outline[@title]");
  187. // cleanup empty categories
  188. foreach ($outlines as $node) {
  189. if ($node->getElementsByTagName('outline')->length == 0)
  190. $node->parentNode->removeChild($node);
  191. }
  192. $res = $doc->saveXML();
  193. /* // saveXML uses a two-space indent. Change to tabs.
  194. $res = preg_replace_callback('/^(?: )+/mu',
  195. create_function(
  196. '$matches',
  197. 'return str_repeat("\t", intval(strlen($matches[0])/2));'),
  198. $res); */
  199. print $res;
  200. }
  201. // Import
  202. private function opml_import_feed($node, $cat_id, $owner_uid) {
  203. $attrs = $node->attributes;
  204. $feed_title = mb_substr($attrs->getNamedItem('text')->nodeValue, 0, 250);
  205. if (!$feed_title) $feed_title = mb_substr($attrs->getNamedItem('title')->nodeValue, 0, 250);
  206. $feed_url = $attrs->getNamedItem('xmlUrl')->nodeValue;
  207. if (!$feed_url) $feed_url = $attrs->getNamedItem('xmlURL')->nodeValue;
  208. $site_url = mb_substr($attrs->getNamedItem('htmlUrl')->nodeValue, 0, 250);
  209. if ($feed_url) {
  210. $sth = $this->pdo->prepare("SELECT id FROM ttrss_feeds WHERE
  211. feed_url = ? AND owner_uid = ?");
  212. $sth->execute([$feed_url, $owner_uid]);
  213. if (!$feed_title) $feed_title = '[Unknown]';
  214. if (!$sth->fetch()) {
  215. #$this->opml_notice("[FEED] [$feed_title/$feed_url] dst_CAT=$cat_id");
  216. $this->opml_notice(T_sprintf("Adding feed: %s", $feed_title == '[Unknown]' ? $feed_url : $feed_title));
  217. if (!$cat_id) $cat_id = null;
  218. $sth = $this->pdo->prepare("INSERT INTO ttrss_feeds
  219. (title, feed_url, owner_uid, cat_id, site_url, order_id) VALUES
  220. (?, ?, ?, ?, ?, 0)");
  221. $sth->execute([$feed_title, $feed_url, $owner_uid, $cat_id, $site_url]);
  222. } else {
  223. $this->opml_notice(T_sprintf("Duplicate feed: %s", $feed_title == '[Unknown]' ? $feed_url : $feed_title));
  224. }
  225. }
  226. }
  227. private function opml_import_label($node, $owner_uid) {
  228. $attrs = $node->attributes;
  229. $label_name = $attrs->getNamedItem('label-name')->nodeValue;
  230. if ($label_name) {
  231. $fg_color = $attrs->getNamedItem('label-fg-color')->nodeValue;
  232. $bg_color = $attrs->getNamedItem('label-bg-color')->nodeValue;
  233. if (!Labels::find_id($label_name, $_SESSION['uid'])) {
  234. $this->opml_notice(T_sprintf("Adding label %s", htmlspecialchars($label_name)));
  235. Labels::create($label_name, $fg_color, $bg_color, $owner_uid);
  236. } else {
  237. $this->opml_notice(T_sprintf("Duplicate label: %s", htmlspecialchars($label_name)));
  238. }
  239. }
  240. }
  241. private function opml_import_preference($node) {
  242. $attrs = $node->attributes;
  243. $pref_name = $attrs->getNamedItem('pref-name')->nodeValue;
  244. if ($pref_name) {
  245. $pref_value = $attrs->getNamedItem('value')->nodeValue;
  246. $this->opml_notice(T_sprintf("Setting preference key %s to %s",
  247. $pref_name, $pref_value));
  248. set_pref($pref_name, $pref_value);
  249. }
  250. }
  251. private function opml_import_filter($node) {
  252. $attrs = $node->attributes;
  253. $filter_type = $attrs->getNamedItem('filter-type')->nodeValue;
  254. if ($filter_type == '2') {
  255. $filter = json_decode($node->nodeValue, true);
  256. if ($filter) {
  257. $match_any_rule = bool_to_sql_bool($filter["match_any_rule"]);
  258. $enabled = bool_to_sql_bool($filter["enabled"]);
  259. $inverse = bool_to_sql_bool($filter["inverse"]);
  260. $title = $filter["title"];
  261. //print "F: $title, $inverse, $enabled, $match_any_rule";
  262. $sth = $this->pdo->prepare("INSERT INTO ttrss_filters2 (match_any_rule,enabled,inverse,title,owner_uid)
  263. VALUES (?, ?, ?, ?, ?)");
  264. $sth->execute([$match_any_rule, $enabled, $inverse, $title, $_SESSION['uid']]);
  265. $sth = $this->pdo->prepare("SELECT MAX(id) AS id FROM ttrss_filters2 WHERE
  266. owner_uid = ?");
  267. $sth->execute([$_SESSION['uid']]);
  268. $row = $sth->fetch();
  269. $filter_id = $row['id'];
  270. if ($filter_id) {
  271. $this->opml_notice(T_sprintf("Adding filter..."));
  272. foreach ($filter["rules"] as $rule) {
  273. $feed_id = null;
  274. $cat_id = null;
  275. if ($rule["match"]) {
  276. $match_on = [];
  277. foreach ($rule["match"] as $match) {
  278. list ($name, $is_cat, $is_id) = $match;
  279. if ($is_id) {
  280. array_push($match_on, ($is_cat ? "CAT:" : "") . $name);
  281. } else {
  282. $match_id = false;
  283. if (!$is_cat) {
  284. $tsth = $this->pdo->prepare("SELECT id FROM ttrss_feeds
  285. WHERE title = ? AND owner_uid = ?");
  286. $tsth->execute([$name, $_SESSION['uid']]);
  287. if ($row = $tsth->fetch()) {
  288. $match_id = $row['id'];
  289. }
  290. } else {
  291. $tsth = $this->pdo->prepare("SELECT id FROM ttrss_feed_categories
  292. WHERE title = ? AND owner_uid = ?");
  293. $tsth->execute([$name, $_SESSION['uid']]);
  294. if ($row = $tsth->fetch()) {
  295. $match_id = $row['id'];
  296. }
  297. }
  298. if ($match_id) array_push($match_on, $match_id);
  299. }
  300. }
  301. $reg_exp = $rule["reg_exp"];
  302. $filter_type = (int)$rule["filter_type"];
  303. $inverse = bool_to_sql_bool($rule["inverse"]);
  304. $match_on = json_encode($match_on);
  305. $usth = $this->pdo->prepare("INSERT INTO ttrss_filters2_rules
  306. (feed_id,cat_id,match_on,filter_id,filter_type,reg_exp,cat_filter,inverse)
  307. VALUES
  308. (NULL, NULL, ?, ?, ?, ?, false, ?)");
  309. $usth->execute([$match_on, $filter_id, $filter_type, $reg_exp, $inverse]);
  310. } else {
  311. if (!$rule["cat_filter"]) {
  312. $tsth = $this->pdo->prepare("SELECT id FROM ttrss_feeds
  313. WHERE title = ? AND owner_uid = ?");
  314. $tsth->execute([$rule['feed'], $_SESSION['uid']]);
  315. if ($row = $tsth->fetch()) {
  316. $feed_id = $row['id'];
  317. }
  318. } else {
  319. $tsth = $this->pdo->prepare("SELECT id FROM ttrss_feed_categories
  320. WHERE title = ? AND owner_uid = ?");
  321. $tsth->execute([$rule['feed'], $_SESSION['uid']]);
  322. if ($row = $tsth->fetch()) {
  323. $feed_id = $row['id'];
  324. }
  325. }
  326. $cat_filter = bool_to_sql_bool($rule["cat_filter"]);
  327. $reg_exp = $rule["reg_exp"];
  328. $filter_type = (int)$rule["filter_type"];
  329. $inverse = bool_to_sql_bool($rule["inverse"]);
  330. $usth = $this->pdo->prepare("INSERT INTO ttrss_filters2_rules
  331. (feed_id,cat_id,filter_id,filter_type,reg_exp,cat_filter,inverse)
  332. VALUES
  333. (?, ?, ?, ?, ?, ?, ?)");
  334. $usth->execute([$feed_id, $cat_id, $filter_id, $filter_type, $reg_exp, $cat_filter, $inverse]);
  335. }
  336. }
  337. foreach ($filter["actions"] as $action) {
  338. $action_id = (int)$action["action_id"];
  339. $action_param = $action["action_param"];
  340. $usth = $this->pdo->prepare("INSERT INTO ttrss_filters2_actions
  341. (filter_id,action_id,action_param)
  342. VALUES
  343. (?, ?, ?)");
  344. $usth->execute([$filter_id, $action_id, $action_param]);
  345. }
  346. }
  347. }
  348. }
  349. }
  350. private function opml_import_category($doc, $root_node, $owner_uid, $parent_id) {
  351. $default_cat_id = (int) $this->get_feed_category('Imported feeds', false);
  352. if ($root_node) {
  353. $cat_title = mb_substr($root_node->attributes->getNamedItem('text')->nodeValue, 0, 250);
  354. if (!$cat_title)
  355. $cat_title = mb_substr($root_node->attributes->getNamedItem('title')->nodeValue, 0, 250);
  356. if (!in_array($cat_title, array("tt-rss-filters", "tt-rss-labels", "tt-rss-prefs"))) {
  357. $cat_id = $this->get_feed_category($cat_title, $parent_id);
  358. if ($cat_id === false) {
  359. add_feed_category($cat_title, $parent_id);
  360. $cat_id = $this->get_feed_category($cat_title, $parent_id);
  361. }
  362. } else {
  363. $cat_id = 0;
  364. }
  365. $outlines = $root_node->childNodes;
  366. } else {
  367. $xpath = new DOMXpath($doc);
  368. $outlines = $xpath->query("//opml/body/outline");
  369. $cat_id = 0;
  370. }
  371. #$this->opml_notice("[CAT] $cat_title id: $cat_id P_id: $parent_id");
  372. $this->opml_notice(T_sprintf("Processing category: %s", $cat_title ? $cat_title : __("Uncategorized")));
  373. foreach ($outlines as $node) {
  374. if ($node->hasAttributes() && strtolower($node->tagName) == "outline") {
  375. $attrs = $node->attributes;
  376. $node_cat_title = $attrs->getNamedItem('text')->nodeValue;
  377. if (!$node_cat_title)
  378. $node_cat_title = $attrs->getNamedItem('title')->nodeValue;
  379. $node_feed_url = $attrs->getNamedItem('xmlUrl')->nodeValue;
  380. if ($node_cat_title && !$node_feed_url) {
  381. $this->opml_import_category($doc, $node, $owner_uid, $cat_id);
  382. } else {
  383. if (!$cat_id) {
  384. $dst_cat_id = $default_cat_id;
  385. } else {
  386. $dst_cat_id = $cat_id;
  387. }
  388. switch ($cat_title) {
  389. case "tt-rss-prefs":
  390. $this->opml_import_preference($node);
  391. break;
  392. case "tt-rss-labels":
  393. $this->opml_import_label($node, $owner_uid);
  394. break;
  395. case "tt-rss-filters":
  396. $this->opml_import_filter($node);
  397. break;
  398. default:
  399. $this->opml_import_feed($node, $dst_cat_id, $owner_uid);
  400. }
  401. }
  402. }
  403. }
  404. }
  405. function opml_import($owner_uid) {
  406. if (!$owner_uid) return;
  407. $doc = false;
  408. if ($_FILES['opml_file']['error'] != 0) {
  409. print_error(T_sprintf("Upload failed with error code %d",
  410. $_FILES['opml_file']['error']));
  411. return;
  412. }
  413. if (is_uploaded_file($_FILES['opml_file']['tmp_name'])) {
  414. $tmp_file = tempnam(CACHE_DIR . '/upload', 'opml');
  415. $result = move_uploaded_file($_FILES['opml_file']['tmp_name'],
  416. $tmp_file);
  417. if (!$result) {
  418. print_error(__("Unable to move uploaded file."));
  419. return;
  420. }
  421. } else {
  422. print_error(__('Error: please upload OPML file.'));
  423. return;
  424. }
  425. if (is_file($tmp_file)) {
  426. $doc = new DOMDocument();
  427. libxml_disable_entity_loader(false);
  428. $doc->load($tmp_file);
  429. libxml_disable_entity_loader(true);
  430. unlink($tmp_file);
  431. } else if (!$doc) {
  432. print_error(__('Error: unable to find moved OPML file.'));
  433. return;
  434. }
  435. if ($doc) {
  436. $this->pdo->beginTransaction();
  437. $this->opml_import_category($doc, false, $owner_uid, false);
  438. $this->pdo->commit();
  439. } else {
  440. print_error(__('Error while parsing document.'));
  441. }
  442. }
  443. private function opml_notice($msg) {
  444. print "$msg<br/>";
  445. }
  446. static function opml_publish_url(){
  447. $url_path = get_self_url_prefix();
  448. $url_path .= "/opml.php?op=publish&key=" .
  449. get_feed_access_key('OPML:Publish', false, $_SESSION["uid"]);
  450. return $url_path;
  451. }
  452. function get_feed_category($feed_cat, $parent_cat_id = false) {
  453. $parent_cat_id = (int) $parent_cat_id;
  454. $sth = $this->pdo->prepare("SELECT id FROM ttrss_feed_categories
  455. WHERE title = :title
  456. AND (parent_cat = :parent OR (:parent = 0 AND parent_cat IS NULL))
  457. AND owner_uid = :uid");
  458. $sth->execute([':title' => $feed_cat, ':parent' => $parent_cat_id, ':uid' => $_SESSION['uid']]);
  459. if ($row = $sth->fetch()) {
  460. return $row['id'];
  461. } else {
  462. return false;
  463. }
  464. }
  465. }