classes/opml.php

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