]>
git.wh0rd.org - tt-rss.git/blob - plugins/import_export/init.php
2 class Import_Export
extends Plugin
implements IHandler
{
8 $this -> link
= $host -> get_link ();
11 $host -> add_hook ( $host :: HOOK_PREFS_TAB
, $this );
12 $host -> add_command ( "xml-import" , "USER FILE: import articles from XML" , $this );
17 "Imports and exports user data using neutral XML format" ,
21 function xml_import ( $args ) {
24 $username = $args [ count ( $args ) - 2 ];
25 $filename = $args [ count ( $args ) - 1 ];
28 print "error: please specify username. \n " ;
32 if (! is_file ( $filename )) {
33 print "error: input filename ( $filename ) doesn't exist. \n " ;
37 _debug ( "importing $filename for user $username ... \n " );
39 $result = db_query ( $this -> link
, "SELECT id FROM ttrss_users WHERE login = ' $username '" );
41 if ( db_num_rows ( $result ) == 0 ) {
42 print "error: could not find user $username . \n " ;
46 $owner_uid = db_fetch_result ( $result , 0 , "id" );
48 $this -> perform_data_import ( $this -> link
, $filename , $owner_uid );
52 $example_value = db_escape_string ( $this -> link
, $_POST [ "example_value" ]);
54 echo "Value set to $example_value (not really)" ;
57 function get_prefs_js () {
58 return file_get_contents ( dirname ( __FILE__
) . "/import_export.js" );
61 function hook_prefs_tab ( $args ) {
62 if ( $args != "prefFeeds" ) return ;
64 print "<div dojoType= \" dijit.layout.AccordionPane \" title= \" " . __ ( 'Import and export' ). " \" >" ;
66 print "<h3>" . __ ( "Article archive" ) . "</h3>" ;
68 print "<p>" . __ ( "You can export and import your Starred and Archived articles for safekeeping or when migrating between tt-rss instances." ) . "</p>" ;
70 print "<button dojoType= \" dijit.form.Button \" onclick= \" return exportData() \" >" .
71 __ ( 'Export my data' ). "</button> " ;
75 print "<iframe id= \" data_upload_iframe \"
76 name= \" data_upload_iframe \" onload= \" dataImportComplete(this) \"
77 style= \" width: 400px; height: 100px; display: none; \" ></iframe>" ;
79 print "<form name= \" import_form \" style='display : block' target= \" data_upload_iframe \"
80 enctype= \" multipart/form-data \" method= \" POST \"
81 action= \" backend.php \" >
82 <input id= \" export_file \" name= \" export_file \" type= \" file \" >
83 <input type= \" hidden \" name= \" op \" value= \" pluginhandler \" >
84 <input type= \" hidden \" name= \" plugin \" value= \" import_export \" >
85 <input type= \" hidden \" name= \" method \" value= \" dataimport \" >
86 <button dojoType= \" dijit.form.Button \" onclick= \" return importData(); \" type= \" submit \" >" .
87 __ ( 'Import' ) . "</button>" ;
90 print "</div>" ; # pane
93 function csrf_ignore ( $method ) {
94 return in_array ( $method , array ( "exportget" ));
97 function before ( $method ) {
98 return $_SESSION [ "uid" ] != false ;
105 function exportget () {
106 $exportname = CACHE_DIR
. "/export/" .
107 sha1 ( $_SESSION [ 'uid' ] . $_SESSION [ 'login' ]) . ".xml" ;
109 if ( file_exists ( $exportname )) {
110 header ( "Content-type: text/xml" );
112 if ( function_exists ( 'gzencode' )) {
113 header ( "Content-Disposition: attachment; filename=TinyTinyRSS_exported.xml.gz" );
114 echo gzencode ( file_get_contents ( $exportname ));
116 header ( "Content-Disposition: attachment; filename=TinyTinyRSS_exported.xml" );
117 echo file_get_contents ( $exportname );
120 echo "File not found." ;
124 function exportrun () {
125 $offset = ( int ) db_escape_string ( $this -> link
, $_REQUEST [ 'offset' ]);
129 if ( $offset < 10000 && is_writable ( CACHE_DIR
. "/export" )) {
130 $result = db_query ( $this -> link
, "SELECT
141 ttrss_feeds.title AS feed_title,
142 ttrss_feeds.feed_url AS feed_url,
143 ttrss_entries.updated
145 ttrss_user_entries LEFT JOIN ttrss_feeds ON (ttrss_feeds.id = feed_id),
148 (marked = true OR feed_id IS NULL) AND
149 ref_id = ttrss_entries.id AND
150 ttrss_user_entries.owner_uid = " . $_SESSION [ 'uid' ] . "
151 ORDER BY ttrss_entries.id LIMIT $limit OFFSET $offset " );
153 $exportname = sha1 ( $_SESSION [ 'uid' ] . $_SESSION [ 'login' ]);
156 $fp = fopen ( CACHE_DIR
. "/export/ $exportname .xml" , "w" );
157 fputs ( $fp , "<articles schema-version= \" " . SCHEMA_VERSION
. " \" >" );
159 $fp = fopen ( CACHE_DIR
. "/export/ $exportname .xml" , "a" );
164 while ( $line = db_fetch_assoc ( $result )) {
165 fputs ( $fp , "<article>" );
167 foreach ( $line as $k => $v ) {
168 fputs ( $fp , "< $k ><![CDATA[ $v ]]></ $k >" );
171 fputs ( $fp , "</article>" );
174 $exported = db_num_rows ( $result );
176 if ( $exported < $limit && $exported > 0 ) {
177 fputs ( $fp , "</articles>" );
185 print json_encode ( array ( "exported" => $exported ));
188 function perform_data_import ( $link , $filename , $owner_uid ) {
192 $num_feeds_created = 0 ;
194 $doc = @DOMDocument
:: load ( $filename );
197 $contents = file_get_contents ( $filename );
200 $data = @gzuncompress
( $contents );
204 $data = @gzdecode
( $contents );
208 $doc = DOMDocument
:: loadXML ( $data );
213 $xpath = new DOMXpath ( $doc );
215 $container = $doc -> firstChild
;
217 if ( $container && $container -> hasAttribute ( 'schema-version' )) {
218 $schema_version = $container -> getAttribute ( 'schema-version' );
220 if ( $schema_version != SCHEMA_VERSION
) {
221 print "<p>" . __ ( "Could not import: incorrect schema version." ) . "</p>" ;
226 print "<p>" . __ ( "Could not import: unrecognized document format." ) . "</p>" ;
230 $articles = $xpath -> query ( "//article" );
232 foreach ( $articles as $article_node ) {
233 if ( $article_node -> childNodes
) {
239 foreach ( $article_node -> childNodes
as $child ) {
240 if ( $child -> nodeName
!= 'label_cache' )
241 $article [ $child -> nodeName
] = db_escape_string ( $this -> link
, $child -> nodeValue
);
243 $article [ $child -> nodeName
] = $child -> nodeValue
;
248 if ( $article [ 'guid' ]) {
252 //db_query($link, "BEGIN");
254 //print 'GUID:' . $article['guid'] . "\n";
256 $result = db_query ( $link , "SELECT id FROM ttrss_entries
257 WHERE guid = '" . $article [ 'guid' ]. "'" );
259 if ( db_num_rows ( $result ) == 0 ) {
261 $result = db_query ( $link ,
262 "INSERT INTO ttrss_entries
276 ('" . $article [ 'title' ]. "',
277 '" . $article [ 'guid' ]. "',
278 '" . $article [ 'link' ]. "',
279 '" . $article [ 'updated' ]. "',
280 '" . $article [ 'content' ]. "',
281 '" . sha1 ( $article [ 'content' ]). "',
289 $result = db_query ( $link , "SELECT id FROM ttrss_entries
290 WHERE guid = '" . $article [ 'guid' ]. "'" );
292 if ( db_num_rows ( $result ) != 0 ) {
293 $ref_id = db_fetch_result ( $result , 0 , "id" );
297 $ref_id = db_fetch_result ( $result , 0 , "id" );
300 //print "Got ref ID: $ref_id\n";
304 $feed_url = $article [ 'feed_url' ];
305 $feed_title = $article [ 'feed_title' ];
309 if ( $feed_url && $feed_title ) {
310 $result = db_query ( $link , "SELECT id FROM ttrss_feeds
311 WHERE feed_url = ' $feed_url ' AND owner_uid = ' $owner_uid '" );
313 if ( db_num_rows ( $result ) != 0 ) {
314 $feed = db_fetch_result ( $result , 0 , "id" );
316 // try autocreating feed in Uncategorized...
318 $result = db_query ( $link , "INSERT INTO ttrss_feeds (owner_uid,
319 feed_url, title) VALUES ( $owner_uid , ' $feed_url ', ' $feed_title ')" );
321 $result = db_query ( $link , "SELECT id FROM ttrss_feeds
322 WHERE feed_url = ' $feed_url ' AND owner_uid = ' $owner_uid '" );
324 if ( db_num_rows ( $result ) != 0 ) {
325 ++
$num_feeds_created ;
327 $feed = db_fetch_result ( $result , 0 , "id" );
333 $feed_qpart = "feed_id = $feed " ;
335 $feed_qpart = "feed_id IS NULL" ;
337 //print "$ref_id / $feed / " . $article['title'] . "\n";
339 $result = db_query ( $link , "SELECT int_id FROM ttrss_user_entries
340 WHERE ref_id = ' $ref_id ' AND owner_uid = ' $owner_uid ' AND $feed_qpart " );
342 if ( db_num_rows ( $result ) == 0 ) {
344 $marked = bool_to_sql_bool ( sql_bool_to_bool ( $article [ 'marked' ]));
345 $published = bool_to_sql_bool ( sql_bool_to_bool ( $article [ 'published' ]));
346 $score = ( int ) $article [ 'score' ];
348 $tag_cache = $article [ 'tag_cache' ];
349 $label_cache = db_escape_string ( $this -> link
, $article [ 'label_cache' ]);
350 $note = $article [ 'note' ];
352 //print "Importing " . $article['title'] . "<br/>";
356 $result = db_query ( $link ,
357 "INSERT INTO ttrss_user_entries
358 (ref_id, owner_uid, feed_id, unread, last_read, marked,
359 published, score, tag_cache, label_cache, uuid, note)
360 VALUES ( $ref_id , $owner_uid , $feed , false,
361 NULL, $marked , $published , $score , ' $tag_cache ',
362 ' $label_cache ', '', ' $note ')" );
364 $label_cache = json_decode ( $label_cache , true );
366 if ( is_array ( $label_cache ) && $label_cache [ "no-labels" ] != 1 ) {
367 foreach ( $label_cache as $label ) {
369 label_create ( $link , $label [ 1 ],
370 $label [ 2 ], $label [ 3 ], $owner_uid );
372 label_add_article ( $link , $ref_id , $label [ 1 ], $owner_uid );
377 //db_query($link, "COMMIT");
385 vsprintf ( __ ( "Finished: " )).
386 vsprintf ( ngettext ( " %d article processed, " , " %d articles processed, " , $num_processed ), $num_processed ).
387 vsprintf ( ngettext ( " %d imported, " , " %d imported, " , $num_imported ), $num_imported ).
388 vsprintf ( ngettext ( " %d feed created." , " %d feeds created." , $num_feeds_created ), $num_feeds_created ).
393 print "<p>" . __ ( "Could not load XML document." ) . "</p>" ;
398 function exportData () {
400 print "<p style='text-align : center' id='export_status_message'>You need to prepare exported data first by clicking the button below.</p>" ;
402 print "<div align='center'>" ;
403 print "<button dojoType= \" dijit.form.Button \"
404 onclick= \" dijit.byId('dataExportDlg').prepare() \" >" .
405 __ ( 'Prepare data' ). "</button>" ;
407 print "<button dojoType= \" dijit.form.Button \"
408 onclick= \" dijit.byId('dataExportDlg').hide() \" >" .
409 __ ( 'Close this window' ). "</button>" ;
416 function dataImport () {
417 header ( "Content-Type: text/html" ); # required for iframe
419 print "<div style='text-align : center'>" ;
421 if ( is_file ( $_FILES [ 'export_file' ][ 'tmp_name' ])) {
423 $this -> perform_data_import ( $this -> link
, $_FILES [ 'export_file' ][ 'tmp_name' ], $_SESSION [ 'uid' ]);
426 print "<p>" . T_sprintf ( "Could not upload file. You might need to adjust upload_max_filesize in PHP.ini (current value = %s )" , ini_get ( "upload_max_filesize" )) . " or use CLI import tool.</p>" ;
430 print "<button dojoType= \" dijit.form.Button \"
431 onclick= \" dijit.byId('dataImportDlg').hide() \" >" .
432 __ ( 'Close this window' ). "</button>" ;