]>
git.wh0rd.org - tt-rss.git/blob - plugins/import_export/init.php
2 class Import_Export
extends Plugin
implements IHandler
{
8 $host->add_hook($host::HOOK_PREFS_TAB
, $this);
9 $host->add_command("xml-import", "import articles from XML", $this, ":", "FILE");
14 "Imports and exports user data using neutral XML format",
18 function xml_import($args) {
20 $filename = $args['xml_import'];
22 if (!is_file($filename)) {
23 print "error: input filename ($filename) doesn't exist.\n";
27 _debug("please enter your username:");
29 $username = db_escape_string( trim(read_stdin()));
31 _debug("importing $filename for user $username...\n");
33 $result = db_query( "SELECT id FROM ttrss_users WHERE login = '$username'");
35 if (db_num_rows($result) == 0) {
36 print "error: could not find user $username.\n";
40 $owner_uid = db_fetch_result($result, 0, "id");
42 $this->perform_data_import( $filename, $owner_uid);
46 $example_value = db_escape_string( $_POST["example_value"]);
48 echo "Value set to $example_value (not really)";
51 function get_prefs_js() {
52 return file_get_contents(dirname(__FILE__
) . "/import_export.js");
55 function hook_prefs_tab($args) {
56 if ($args != "prefFeeds") return;
58 print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"".__('Import and export')."\">";
60 print "<h3>" . __("Article archive") . "</h3>";
62 print "<p>" . __("You can export and import your Starred and Archived articles for safekeeping or when migrating between tt-rss instances.") . "</p>";
64 print "<button dojoType=\"dijit.form.Button\" onclick=\"return exportData()\">".
65 __('Export my data')."</button> ";
69 print "<iframe id=\"data_upload_iframe\"
70 name=\"data_upload_iframe\" onload=\"dataImportComplete(this)\"
71 style=\"width: 400px; height: 100px; display: none;\"></iframe>";
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\">
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>";
85 print "</div>"; # pane
88 function csrf_ignore($method) {
89 return in_array($method, array("exportget"));
92 function before($method) {
93 return $_SESSION["uid"] != false;
100 function exportget() {
101 $exportname = CACHE_DIR
. "/export/" .
102 sha1($_SESSION['uid'] . $_SESSION['login']) . ".xml";
104 if (file_exists($exportname)) {
105 header("Content-type: text/xml");
107 if (function_exists('gzencode')) {
108 header("Content-Disposition: attachment; filename=TinyTinyRSS_exported.xml.gz");
109 echo gzencode(file_get_contents($exportname));
111 header("Content-Disposition: attachment; filename=TinyTinyRSS_exported.xml");
112 echo file_get_contents($exportname);
115 echo "File not found.";
119 function exportrun() {
120 $offset = (int) db_escape_string( $_REQUEST['offset']);
124 if ($offset < 10000 && is_writable(CACHE_DIR
. "/export")) {
125 $result = db_query( "SELECT
136 ttrss_feeds.title AS feed_title,
137 ttrss_feeds.feed_url AS feed_url,
138 ttrss_entries.updated
140 ttrss_user_entries LEFT JOIN ttrss_feeds ON (ttrss_feeds.id = feed_id),
143 (marked = true OR feed_id IS NULL) AND
144 ref_id = ttrss_entries.id AND
145 ttrss_user_entries.owner_uid = " . $_SESSION['uid'] . "
146 ORDER BY ttrss_entries.id LIMIT $limit OFFSET $offset");
148 $exportname = sha1($_SESSION['uid'] . $_SESSION['login']);
151 $fp = fopen(CACHE_DIR
. "/export/$exportname.xml", "w");
152 fputs($fp, "<articles schema-version=\"".SCHEMA_VERSION
."\">");
154 $fp = fopen(CACHE_DIR
. "/export/$exportname.xml", "a");
159 while ($line = db_fetch_assoc($result)) {
160 fputs($fp, "<article>");
162 foreach ($line as $k => $v) {
163 $v = str_replace("]]>", "]]]]><![CDATA[>", $v);
164 fputs($fp, "<$k><![CDATA[$v]]></$k>");
167 fputs($fp, "</article>");
170 $exported = db_num_rows($result);
172 if ($exported < $limit && $exported > 0) {
173 fputs($fp, "</articles>");
181 print json_encode(array("exported" => $exported));
184 function perform_data_import( $filename, $owner_uid) {
188 $num_feeds_created = 0;
190 $doc = @DOMDocument
::load($filename);
193 $contents = file_get_contents($filename);
196 $data = @gzuncompress
($contents);
200 $data = @gzdecode
($contents);
204 $doc = DOMDocument
::loadXML($data);
209 $xpath = new DOMXpath($doc);
211 $container = $doc->firstChild
;
213 if ($container && $container->hasAttribute('schema-version')) {
214 $schema_version = $container->getAttribute('schema-version');
216 if ($schema_version != SCHEMA_VERSION
) {
217 print "<p>" .__("Could not import: incorrect schema version.") . "</p>";
222 print "<p>" . __("Could not import: unrecognized document format.") . "</p>";
226 $articles = $xpath->query("//article");
228 foreach ($articles as $article_node) {
229 if ($article_node->childNodes
) {
235 foreach ($article_node->childNodes
as $child) {
236 if ($child->nodeName
!= 'label_cache')
237 $article[$child->nodeName
] = db_escape_string( $child->nodeValue
);
239 $article[$child->nodeName
] = $child->nodeValue
;
244 if ($article['guid']) {
248 //db_query( "BEGIN");
250 //print 'GUID:' . $article['guid'] . "\n";
252 $result = db_query( "SELECT id FROM ttrss_entries
253 WHERE guid = '".$article['guid']."'");
255 if (db_num_rows($result) == 0) {
258 "INSERT INTO ttrss_entries
272 ('".$article['title']."',
273 '".$article['guid']."',
274 '".$article['link']."',
275 '".$article['updated']."',
276 '".$article['content']."',
277 '".sha1($article['content'])."',
285 $result = db_query( "SELECT id FROM ttrss_entries
286 WHERE guid = '".$article['guid']."'");
288 if (db_num_rows($result) != 0) {
289 $ref_id = db_fetch_result($result, 0, "id");
293 $ref_id = db_fetch_result($result, 0, "id");
296 //print "Got ref ID: $ref_id\n";
300 $feed_url = $article['feed_url'];
301 $feed_title = $article['feed_title'];
305 if ($feed_url && $feed_title) {
306 $result = db_query( "SELECT id FROM ttrss_feeds
307 WHERE feed_url = '$feed_url' AND owner_uid = '$owner_uid'");
309 if (db_num_rows($result) != 0) {
310 $feed = db_fetch_result($result, 0, "id");
312 // try autocreating feed in Uncategorized...
314 $result = db_query( "INSERT INTO ttrss_feeds (owner_uid,
315 feed_url, title) VALUES ($owner_uid, '$feed_url', '$feed_title')");
317 $result = db_query( "SELECT id FROM ttrss_feeds
318 WHERE feed_url = '$feed_url' AND owner_uid = '$owner_uid'");
320 if (db_num_rows($result) != 0) {
321 ++
$num_feeds_created;
323 $feed = db_fetch_result($result, 0, "id");
329 $feed_qpart = "feed_id = $feed";
331 $feed_qpart = "feed_id IS NULL";
333 //print "$ref_id / $feed / " . $article['title'] . "\n";
335 $result = db_query( "SELECT int_id FROM ttrss_user_entries
336 WHERE ref_id = '$ref_id' AND owner_uid = '$owner_uid' AND $feed_qpart");
338 if (db_num_rows($result) == 0) {
340 $marked = bool_to_sql_bool(sql_bool_to_bool($article['marked']));
341 $published = bool_to_sql_bool(sql_bool_to_bool($article['published']));
342 $score = (int) $article['score'];
344 $tag_cache = $article['tag_cache'];
345 $label_cache = db_escape_string( $article['label_cache']);
346 $note = $article['note'];
348 //print "Importing " . $article['title'] . "<br/>";
353 "INSERT INTO ttrss_user_entries
354 (ref_id, owner_uid, feed_id, unread, last_read, marked,
355 published, score, tag_cache, label_cache, uuid, note)
356 VALUES ($ref_id, $owner_uid, $feed, false,
357 NULL, $marked, $published, $score, '$tag_cache',
358 '$label_cache', '', '$note')");
360 $label_cache = json_decode($label_cache, true);
362 if (is_array($label_cache) && $label_cache["no-labels"] != 1) {
363 foreach ($label_cache as $label) {
365 label_create( $label[1],
366 $label[2], $label[3], $owner_uid);
368 label_add_article( $ref_id, $label[1], $owner_uid);
373 //db_query( "COMMIT");
382 vsprintf(ngettext("%d article processed, ", "%d articles processed, ", $num_processed), $num_processed).
383 vsprintf(ngettext("%d imported, ", "%d imported, ", $num_imported), $num_imported).
384 vsprintf(ngettext("%d feed created.", "%d feeds created.", $num_feeds_created), $num_feeds_created).
389 print "<p>" . __("Could not load XML document.") . "</p>";
394 function exportData() {
396 print "<p style='text-align : center' id='export_status_message'>You need to prepare exported data first by clicking the button below.</p>";
398 print "<div align='center'>";
399 print "<button dojoType=\"dijit.form.Button\"
400 onclick=\"dijit.byId('dataExportDlg').prepare()\">".
401 __('Prepare data')."</button>";
403 print "<button dojoType=\"dijit.form.Button\"
404 onclick=\"dijit.byId('dataExportDlg').hide()\">".
405 __('Close this window')."</button>";
412 function dataImport() {
413 header("Content-Type: text/html"); # required for iframe
415 print "<div style='text-align : center'>";
417 if ($_FILES['export_file']['error'] != 0) {
418 print_error(T_sprintf("Upload failed with error code %d",
419 $_FILES['export_file']['error']));
425 if (is_uploaded_file($_FILES['export_file']['tmp_name'])) {
426 $tmp_file = tempnam(CACHE_DIR
. '/upload', 'export');
428 $result = move_uploaded_file($_FILES['export_file']['tmp_name'],
432 print_error(__("Unable to move uploaded file."));
436 print_error(__('Error: please upload OPML file.'));
440 if (is_file($tmp_file)) {
441 $this->perform_data_import( $tmp_file, $_SESSION['uid']);
444 print_error(__('No file uploaded.'));
448 print "<button dojoType=\"dijit.form.Button\"
449 onclick=\"dijit.byId('dataImportDlg').hide()\">".
450 __('Close this window')."</button>";