plugins/import_export/init.php

   1 <?php
   2 class Import_Export extends Plugin implements IHandler {
   3         private $host;
   4
   5         function init($host) {
   6                 $this->host = $host;
   7
   8                 $host->add_hook($host::HOOK_PREFS_TAB, $this);
   9                 $host->add_command("xml-import", "import articles from XML", $this, ":", "FILE");
  10         }
  11
  12         function about() {
  13                 return array(1.0,
  14                         "Imports and exports user data using neutral XML format",
  15                         "fox");
  16         }
  17
  18         function xml_import($args) {
  19
  20                 $filename = $args['xml_import'];
  21
  22                 if (!is_file($filename)) {
  23                         print "error: input filename ($filename) doesn't exist.\n";
  24                         return;
  25                 }
  26
  27                 _debug("please enter your username:");
  28
  29                 $username = db_escape_string(trim(read_stdin()));
  30
  31                 _debug("importing $filename for user $username...\n");
  32
  33                 $result = db_query("SELECT id FROM ttrss_users WHERE login = '$username'");
  34
  35                 if (db_num_rows($result) == 0) {
  36                         print "error: could not find user $username.\n";
  37                         return;
  38                 }
  39
  40                 $owner_uid = db_fetch_result($result, 0, "id");
  41
  42                 $this->perform_data_import($filename, $owner_uid);
  43         }
  44
  45         function save() {
  46                 $example_value = db_escape_string($_POST["example_value"]);
  47
  48                 echo "Value set to $example_value (not really)";
  49         }
  50
  51         function get_prefs_js() {
  52                 return file_get_contents(dirname(__FILE__) . "/import_export.js");
  53         }
  54
  55         function hook_prefs_tab($args) {
  56                 if ($args != "prefFeeds") return;
  57
  58                 print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"".__('Import and export')."\">";
  59
  60                 print_notice(__("You can export and import your Starred and Archived articles for safekeeping or when migrating between tt-rss instances of same version."));
  61
  62                 print "<p>";
  63
  64                 print "<button dojoType=\"dijit.form.Button\" onclick=\"return exportData()\">".
  65                         __('Export my data')."</button> ";
  66
  67                 print "<hr>";
  68
  69                 print "<iframe id=\"data_upload_iframe\"
  70                         name=\"data_upload_iframe\" onload=\"dataImportComplete(this)\"
  71                         style=\"width: 400px; height: 100px; display: none;\"></iframe>";
  72
  73                 print "<form name=\"import_form\" style='display : block' target=\"data_upload_iframe\"
  74                         enctype=\"multipart/form-data\" method=\"POST\"
  75                         action=\"backend.php\">
  76                         <input id=\"export_file\" name=\"export_file\" type=\"file\">&nbsp;
  77                         <input type=\"hidden\" name=\"op\" value=\"pluginhandler\">
  78                         <input type=\"hidden\" name=\"plugin\" value=\"import_export\">
  79                         <input type=\"hidden\" name=\"method\" value=\"dataimport\">
  80                         <button dojoType=\"dijit.form.Button\" onclick=\"return importData();\" type=\"submit\">" .
  81                         __('Import') . "</button>";
  82
  83                 print "</form>";
  84
  85                 print "</p>";
  86
  87                 print "</div>"; # pane
  88         }
  89
  90         function csrf_ignore($method) {
  91                 return in_array($method, array("exportget"));
  92         }
  93
  94         function before($method) {
  95                 return $_SESSION["uid"] != false;
  96         }
  97
  98         function after() {
  99                 return true;
 100         }
 101
 102         function exportget() {
 103                 $exportname = CACHE_DIR . "/export/" .
 104                         sha1($_SESSION['uid'] . $_SESSION['login']) . ".xml";
 105
 106                 if (file_exists($exportname)) {
 107                         header("Content-type: text/xml");
 108
 109                         $timestamp_suffix = date("Y-m-d", filemtime($exportname));
 110
 111                         if (function_exists('gzencode')) {
 112                                 header("Content-Disposition: attachment; filename=TinyTinyRSS_exported_${timestamp_suffix}.xml.gz");
 113                                 echo gzencode(file_get_contents($exportname));
 114                         } else {
 115                                 header("Content-Disposition: attachment; filename=TinyTinyRSS_exported_${timestamp_suffix}.xml");
 116                                 echo file_get_contents($exportname);
 117                         }
 118                 } else {
 119                         echo "File not found.";
 120                 }
 121         }
 122
 123         function exportrun() {
 124                 $offset = (int) db_escape_string($_REQUEST['offset']);
 125                 $exported = 0;
 126                 $limit = 250;
 127
 128                 if ($offset < 10000 && is_writable(CACHE_DIR . "/export")) {
 129                         $result = db_query("SELECT
 130                                         ttrss_entries.guid,
 131                                         ttrss_entries.title,
 132                                         content,
 133                                         marked,
 134                                         published,
 135                                         score,
 136                                         note,
 137                                         link,
 138                                         tag_cache,
 139                                         label_cache,
 140                                         ttrss_feeds.title AS feed_title,
 141                                         ttrss_feeds.feed_url AS feed_url,
 142                                         ttrss_entries.updated
 143                                 FROM
 144                                         ttrss_user_entries LEFT JOIN ttrss_feeds ON (ttrss_feeds.id = feed_id),
 145                                         ttrss_entries
 146                                 WHERE
 147                                         (marked = true OR feed_id IS NULL) AND
 148                                         ref_id = ttrss_entries.id AND
 149                                         ttrss_user_entries.owner_uid = " . $_SESSION['uid'] . "
 150                                 ORDER BY ttrss_entries.id LIMIT $limit OFFSET $offset");
 151
 152                         $exportname = sha1($_SESSION['uid'] . $_SESSION['login']);
 153
 154                         if ($offset == 0) {
 155                                 $fp = fopen(CACHE_DIR . "/export/$exportname.xml", "w");
 156                                 fputs($fp, "<articles schema-version=\"".SCHEMA_VERSION."\">");
 157                         } else {
 158                                 $fp = fopen(CACHE_DIR . "/export/$exportname.xml", "a");
 159                         }
 160
 161                         if ($fp) {
 162
 163                                 while ($line = db_fetch_assoc($result)) {
 164                                         fputs($fp, "<article>");
 165
 166                                         foreach ($line as $k => $v) {
 167                                                 $v = str_replace("]]>", "]]]]><![CDATA[>", $v);
 168                                                 fputs($fp, "<$k><![CDATA[$v]]></$k>");
 169                                         }
 170
 171                                         fputs($fp, "</article>");
 172                                 }
 173
 174                                 $exported = db_num_rows($result);
 175
 176                                 if ($exported < $limit && $exported > 0) {
 177                                         fputs($fp, "</articles>");
 178                                 }
 179
 180                                 fclose($fp);
 181                         }
 182
 183                 }
 184
 185                 print json_encode(array("exported" => $exported));
 186         }
 187
 188         function perform_data_import($filename, $owner_uid) {
 189
 190                 $num_imported = 0;
 191                 $num_processed = 0;
 192                 $num_feeds_created = 0;
 193
 194                 libxml_disable_entity_loader(false);
 195
 196                 $doc = @DOMDocument::load($filename);
 197
 198                 if (!$doc) {
 199                         $contents = file_get_contents($filename);
 200
 201                         if ($contents) {
 202                                 $data = @gzuncompress($contents);
 203                         }
 204
 205                         if (!$data) {
 206                                 $data = @gzdecode($contents);
 207                         }
 208
 209                         if ($data)
 210                                 $doc = DOMDocument::loadXML($data);
 211                 }
 212
 213                 libxml_disable_entity_loader(true);
 214
 215                 if ($doc) {
 216
 217                         $xpath = new DOMXpath($doc);
 218
 219                         $container = $doc->firstChild;
 220
 221                         if ($container && $container->hasAttribute('schema-version')) {
 222                                 $schema_version = $container->getAttribute('schema-version');
 223
 224                                 if ($schema_version != SCHEMA_VERSION) {
 225                                         print "<p>" .__("Could not import: incorrect schema version.") . "</p>";
 226                                         return;
 227                                 }
 228
 229                         } else {
 230                                 print "<p>" . __("Could not import: unrecognized document format.") . "</p>";
 231                                 return;
 232                         }
 233
 234                         $articles = $xpath->query("//article");
 235
 236                         foreach ($articles as $article_node) {
 237                                 if ($article_node->childNodes) {
 238
 239                                         $ref_id = 0;
 240
 241                                         $article = array();
 242
 243                                         foreach ($article_node->childNodes as $child) {
 244                                                 if ($child->nodeName != 'label_cache')
 245                                                         $article[$child->nodeName] = db_escape_string($child->nodeValue);
 246                                                 else
 247                                                         $article[$child->nodeName] = $child->nodeValue;
 248                                         }
 249
 250                                         //print_r($article);
 251
 252                                         if ($article['guid']) {
 253
 254                                                 ++$num_processed;
 255
 256                                                 //db_query("BEGIN");
 257
 258                                                 //print 'GUID:' . $article['guid'] . "\n";
 259
 260                                                 $result = db_query("SELECT id FROM ttrss_entries
 261                                                         WHERE guid = '".$article['guid']."'");
 262
 263                                                 if (db_num_rows($result) == 0) {
 264
 265                                                         $result = db_query(
 266                                                                 "INSERT INTO ttrss_entries
 267                                                                         (title,
 268                                                                         guid,
 269                                                                         link,
 270                                                                         updated,
 271                                                                         content,
 272                                                                         content_hash,
 273                                                                         no_orig_date,
 274                                                                         date_updated,
 275                                                                         date_entered,
 276                                                                         comments,
 277                                                                         num_comments,
 278                                                                         author)
 279                                                                 VALUES
 280                                                                         ('".$article['title']."',
 281                                                                         '".$article['guid']."',
 282                                                                         '".$article['link']."',
 283                                                                         '".$article['updated']."',
 284                                                                         '".$article['content']."',
 285                                                                         '".sha1($article['content'])."',
 286                                                                         false,
 287                                                                         NOW(),
 288                                                                         NOW(),
 289                                                                         '',
 290                                                                         '0',
 291                                                                         '')");
 292
 293                                                         $result = db_query("SELECT id FROM ttrss_entries
 294                                                                 WHERE guid = '".$article['guid']."'");
 295
 296                                                         if (db_num_rows($result) != 0) {
 297                                                                 $ref_id = db_fetch_result($result, 0, "id");
 298                                                         }
 299
 300                                                 } else {
 301                                                         $ref_id = db_fetch_result($result, 0, "id");
 302                                                 }
 303
 304                                                 //print "Got ref ID: $ref_id\n";
 305
 306                                                 if ($ref_id) {
 307
 308                                                         $feed_url = $article['feed_url'];
 309                                                         $feed_title = $article['feed_title'];
 310
 311                                                         $feed = 'NULL';
 312
 313                                                         if ($feed_url && $feed_title) {
 314                                                                 $result = db_query("SELECT id FROM ttrss_feeds
 315                                                                         WHERE feed_url = '$feed_url' AND owner_uid = '$owner_uid'");
 316
 317                                                                 if (db_num_rows($result) != 0) {
 318                                                                         $feed = db_fetch_result($result, 0, "id");
 319                                                                 } else {
 320                                                                         // try autocreating feed in Uncategorized...
 321
 322                                                                         $result = db_query("INSERT INTO ttrss_feeds (owner_uid,
 323                                                                                 feed_url, title) VALUES ($owner_uid, '$feed_url', '$feed_title')");
 324
 325                                                                         $result = db_query("SELECT id FROM ttrss_feeds
 326                                                                                 WHERE feed_url = '$feed_url' AND owner_uid = '$owner_uid'");
 327
 328                                                                         if (db_num_rows($result) != 0) {
 329                                                                                 ++$num_feeds_created;
 330
 331                                                                                 $feed = db_fetch_result($result, 0, "id");
 332                                                                         }
 333                                                                 }
 334                                                         }
 335
 336                                                         if ($feed != 'NULL')
 337                                                                 $feed_qpart = "feed_id = $feed";
 338                                                         else
 339                                                                 $feed_qpart = "feed_id IS NULL";
 340
 341                                                         //print "$ref_id / $feed / " . $article['title'] . "\n";
 342
 343                                                         $result = db_query("SELECT int_id FROM ttrss_user_entries
 344                                                                 WHERE ref_id = '$ref_id' AND owner_uid = '$owner_uid' AND $feed_qpart");
 345
 346                                                         if (db_num_rows($result) == 0) {
 347
 348                                                                 $marked = bool_to_sql_bool(sql_bool_to_bool($article['marked']));
 349                                                                 $published = bool_to_sql_bool(sql_bool_to_bool($article['published']));
 350                                                                 $score = (int) $article['score'];
 351
 352                                                                 $tag_cache = $article['tag_cache'];
 353                                                                 $label_cache = db_escape_string($article['label_cache']);
 354                                                                 $note = $article['note'];
 355
 356                                                                 //print "Importing " . $article['title'] . "<br/>";
 357
 358                                                                 ++$num_imported;
 359
 360                                                                 $result = db_query(
 361                                                                         "INSERT INTO ttrss_user_entries
 362                                                                         (ref_id, owner_uid, feed_id, unread, last_read, marked,
 363                                                                                 published, score, tag_cache, label_cache, uuid, note)
 364                                                                         VALUES ($ref_id, $owner_uid, $feed, false,
 365                                                                                 NULL, $marked, $published, $score, '$tag_cache',
 366                                                                                         '$label_cache', '', '$note')");
 367
 368                                                                 $label_cache = json_decode($label_cache, true);
 369
 370                                                                 if (is_array($label_cache) && $label_cache["no-labels"] != 1) {
 371                                                                         foreach ($label_cache as $label) {
 372
 373                                                                                 label_create($label[1],
 374                                                                                         $label[2], $label[3], $owner_uid);
 375
 376                                                                                 label_add_article($ref_id, $label[1], $owner_uid);
 377
 378                                                                         }
 379                                                                 }
 380
 381                                                                 //db_query("COMMIT");
 382                                                         }
 383                                                 }
 384                                         }
 385                                 }
 386                         }
 387
 388                         print "<p>" .
 389                                 __("Finished: ").
 390                                 vsprintf(_ngettext("%d article processed, ", "%d articles processed, ", $num_processed), $num_processed).
 391                                 vsprintf(_ngettext("%d imported, ", "%d imported, ", $num_imported), $num_imported).
 392                                 vsprintf(_ngettext("%d feed created.", "%d feeds created.", $num_feeds_created), $num_feeds_created).
 393                                         "</p>";
 394
 395                 } else {
 396
 397                         print "<p>" . __("Could not load XML document.") . "</p>";
 398
 399                 }
 400         }
 401
 402         function exportData() {
 403
 404                 print "<p style='text-align : center' id='export_status_message'>You need to prepare exported data first by clicking the button below.</p>";
 405
 406                 print "<div align='center'>";
 407                 print "<button dojoType=\"dijit.form.Button\"
 408                         onclick=\"dijit.byId('dataExportDlg').prepare()\">".
 409                         __('Prepare data')."</button>";
 410
 411                 print "<button dojoType=\"dijit.form.Button\"
 412                         onclick=\"dijit.byId('dataExportDlg').hide()\">".
 413                         __('Close this window')."</button>";
 414
 415                 print "</div>";
 416
 417
 418         }
 419
 420         function dataImport() {
 421                 header("Content-Type: text/html"); # required for iframe
 422
 423                 print "<div style='text-align : center'>";
 424
 425                 if ($_FILES['export_file']['error'] != 0) {
 426                         print_error(T_sprintf("Upload failed with error code %d",
 427                                 $_FILES['export_file']['error']));
 428                         return;
 429                 }
 430
 431                 $tmp_file = false;
 432
 433                 if (is_uploaded_file($_FILES['export_file']['tmp_name'])) {
 434                         $tmp_file = tempnam(CACHE_DIR . '/upload', 'export');
 435
 436                         $result = move_uploaded_file($_FILES['export_file']['tmp_name'],
 437                                 $tmp_file);
 438
 439                         if (!$result) {
 440                                 print_error(__("Unable to move uploaded file."));
 441                                 return;
 442                         }
 443                 } else {
 444                         print_error(__('Error: please upload OPML file.'));
 445                         return;
 446                 }
 447
 448                 if (is_file($tmp_file)) {
 449                         $this->perform_data_import($tmp_file, $_SESSION['uid']);
 450                         unlink($tmp_file);
 451                 } else {
 452                         print_error(__('No file uploaded.'));
 453                         return;
 454                 }
 455
 456                 print "<button dojoType=\"dijit.form.Button\"
 457                         onclick=\"dijit.byId('dataImportDlg').hide()\">".
 458                         __('Close this window')."</button>";
 459
 460                 print "</div>";
 461
 462         }
 463
 464         function api_version() {
 465                 return 2;
 466         }
 467
 468 }
 469 ?>