* (bug 12506) Allow URL parameter 'section' in Special:Mypage/Mytalk. Patch by Eneas.
[lhc/web/wiklou.git] / includes / SpecialExport.php
index fa4424f..2a0d13f 100644 (file)
 <?php
 # Copyright (C) 2003 Brion Vibber <brion@pobox.com>
 # http://www.mediawiki.org/
-# 
+#
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or 
+# the Free Software Foundation; either version 2 of the License, or
 # (at your option) any later version.
-# 
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 # GNU General Public License for more details.
-# 
+#
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, write to the Free Software Foundation, Inc.,
-# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 # http://www.gnu.org/copyleft/gpl.html
 /**
  *
- * @package MediaWiki
- * @subpackage SpecialPage
+ * @addtogroup SpecialPage
  */
 
-/** */
-require_once( 'Revision.php' );
+function wfExportGetPagesFromCategory( $title ) {
+       global $wgContLang;
+
+       $name = $title->getDBkey();
+
+       $dbr = wfGetDB( DB_SLAVE );
+
+       list( $page, $categorylinks ) = $dbr->tableNamesN( 'page', 'categorylinks' );
+       $sql = "SELECT page_namespace, page_title FROM $page " .
+               "JOIN $categorylinks ON cl_from = page_id " .
+               "WHERE cl_to = " . $dbr->addQuotes( $name );
+
+       $pages = array();
+       $res = $dbr->query( $sql, 'wfExportGetPagesFromCategory' );
+       while ( $row = $dbr->fetchObject( $res ) ) {
+               $n = $row->page_title;
+               if ($row->page_namespace) {
+                       $ns = $wgContLang->getNsText( $row->page_namespace );
+                       $n = $ns . ':' . $n;
+               }
+
+               $pages[] = $n;
+       }
+       $dbr->freeResult($res);
+
+       return $pages;
+}
+
+/**
+ * Expand a list of pages to include templates used in those pages.
+ * @param $inputPages array, list of titles to look up
+ * @param $pageSet array, associative array indexed by titles for output
+ * @return array associative array index by titles
+ */
+function wfExportGetTemplates( $inputPages, $pageSet ) {
+       return wfExportGetLinks( $inputPages, $pageSet,
+               'templatelinks', 
+               array( 'tl_namespace AS namespace', 'tl_title AS title' ),
+               array( 'page_id=tl_from' ) );
+}
+
+/**
+ * Expand a list of pages to include images used in those pages.
+ * @param $inputPages array, list of titles to look up
+ * @param $pageSet array, associative array indexed by titles for output
+ * @return array associative array index by titles
+ */
+function wfExportGetImages( $inputPages, $pageSet ) {
+       return wfExportGetLinks( $inputPages, $pageSet,
+               'imagelinks',
+               array( NS_IMAGE . ' AS namespace', 'il_to AS title' ),
+               array( 'page_id=il_from' ) );
+}
+
+/**
+ * Expand a list of pages to include items used in those pages.
+ * @private
+ */
+function wfExportGetLinks( $inputPages, $pageSet, $table, $fields, $join ) {
+       $dbr = wfGetDB( DB_SLAVE );
+       foreach( $inputPages as $page ) {
+               $title = Title::newFromText( $page );
+               $pageSet[$title->getPrefixedText()] = true;
+               if( $title ) {
+                       /// @fixme May or may not be more efficient to batch these
+                       ///        by namespace when given multiple input pages.
+                       $result = $dbr->select(
+                               array( 'page', $table ),
+                               $fields,
+                               array_merge( $join,
+                                       array(
+                                               'page_namespace' => $title->getNamespace(),
+                                               'page_title' => $title->getDbKey() ) ),
+                               __METHOD__ );
+                       foreach( $result as $row ) {
+                               $template = Title::makeTitle( $row->namespace, $row->title );
+                               $pageSet[$template->getPrefixedText()] = true;
+                       }
+               }
+       }
+       return $pageSet;
+}
 
 /**
  *
  */
 function wfSpecialExport( $page = '' ) {
-       global $wgOut, $wgLang, $wgRequest;
-       
-       if( $wgRequest->getVal( 'action' ) == 'submit') {
+       global $wgOut, $wgRequest, $wgSitename, $wgExportAllowListContributors;
+       global $wgExportAllowHistory, $wgExportMaxHistory;
+
+       $curonly = true;
+       $doexport = false;
+
+       if ( $wgRequest->getCheck( 'addcat' ) ) {
+               $page = $wgRequest->getText( 'pages' );
+               $catname = $wgRequest->getText( 'catname' );
+               
+               if ( $catname !== '' && $catname !== NULL && $catname !== false ) {
+                       $t = Title::makeTitleSafe( NS_CATEGORY, $catname );
+                       if ( $t ) {
+                               /**
+                                * @fixme This can lead to hitting memory limit for very large
+                                * categories. Ideally we would do the lookup synchronously
+                                * during the export in a single query.
+                                */
+                               $catpages = wfExportGetPagesFromCategory( $t );
+                               if ( $catpages ) $page .= "\n" . implode( "\n", $catpages );
+                       }
+               }
+       }
+       else if( $wgRequest->wasPosted() && $page == '' ) {
                $page = $wgRequest->getText( 'pages' );
                $curonly = $wgRequest->getCheck( 'curonly' );
+               $rawOffset = $wgRequest->getVal( 'offset' );
+               if( $rawOffset ) {
+                       $offset = wfTimestamp( TS_MW, $rawOffset );
+               } else {
+                       $offset = null;
+               }
+               $limit = $wgRequest->getInt( 'limit' );
+               $dir = $wgRequest->getVal( 'dir' );
+               $history = array(
+                       'dir' => 'asc',
+                       'offset' => false,
+                       'limit' => $wgExportMaxHistory,
+               );
+               $historyCheck = $wgRequest->getCheck( 'history' );
+               if ( $curonly ) {
+                       $history = WikiExporter::CURRENT;
+               } elseif ( !$historyCheck ) {
+                       if ( $limit > 0 && $limit < $wgExportMaxHistory ) {
+                               $history['limit'] = $limit;
+                       }
+                       if ( !is_null( $offset ) ) {
+                               $history['offset'] = $offset;
+                       }
+                       if ( strtolower( $dir ) == 'desc' ) {
+                               $history['dir'] = 'desc';
+                       }
+               }
+               
+               if( $page != '' ) $doexport = true;
        } else {
-               # Pre-check the 'current version only' box in the UI
-               $curonly = true;
-       }
-       
-       if( $page != '' ) {
-               $wgOut->disable();
-               header( "Content-type: application/xml; charset=utf-8" );
-               $pages = explode( "\n", $page );
-               $xml = pages2xml( $pages, $curonly );
-               echo $xml;
-               return;
+               // Default to current-only for GET requests
+               $page = $wgRequest->getText( 'pages', $page );
+               $historyCheck = $wgRequest->getCheck( 'history' );
+               if( $historyCheck ) {
+                       $history = WikiExporter::FULL;
+               } else {
+                       $history = WikiExporter::CURRENT;
+               }
+               
+               if( $page != '' ) $doexport = true;
        }
-       
-       $wgOut->addWikiText( wfMsg( "exporttext" ) );
-       $titleObj = Title::makeTitle( NS_SPECIAL, "Export" );
-       $action = $titleObj->escapeLocalURL( 'action=submit' );
-       $wgOut->addHTML( "
-<form method='post' action=\"$action\">
-<input type='hidden' name='action' value='submit' />
-<textarea name='pages' cols='40' rows='10'></textarea><br />
-<label><input type='checkbox' name='curonly' value='true' checked='checked' />
-" . wfMsg( "exportcuronly" ) . "</label><br />
-<input type='submit' />
-</form>
-" );
-}
 
-function pages2xml( $pages, $curonly = false ) {
-       $fname = 'pages2xml';
-       wfProfileIn( $fname );
-       
-       global $wgContLanguageCode, $wgInputEncoding, $wgContLang;
-       $xml = '<?xml version="1.0" encoding="UTF-8" ?>' . "\n" .
-               '<mediawiki version="0.1" xml:lang="' . $wgContLanguageCode . '">' . "\n";
-       foreach( $pages as $page ) {
-               $xml .= page2xml( $page, $curonly );
+       if( !$wgExportAllowHistory ) {
+               // Override
+               $history = WikiExporter::CURRENT;
        }
-       $xml .= "</mediawiki>\n";
-       if($wgInputEncoding != "utf-8")
-               $xml = $wgContLang->iconv( $wgInputEncoding, "utf-8", $xml );
        
-       wfProfileOut( $fname );
-       return $xml;
-}
-
-function page2xml( $page, $curonly, $full = false ) {
-       global $wgLang;
-       $fname = 'page2xml';
-       wfProfileIn( $fname );
+       $list_authors = $wgRequest->getCheck( 'listauthors' );
+       if ( !$curonly || !$wgExportAllowListContributors ) $list_authors = false ;
        
-       $title = Title::NewFromText( $page );
-       if( !$title ) {
-               wfProfileOut( $fname );
-               return "";
-       }
-
-       $dbr =& wfGetDB( DB_SLAVE );
-       $s = $dbr->selectRow( 'page',
-               array( 'page_id', 'page_restrictions' ),
-               array( 'page_namespace' => $title->getNamespace(),
-                          'page_title'     => $title->getDbkey() ) );
-       if( $s ) {
-               $tl = xmlsafe( $title->getPrefixedText() );
-               $xml = "  <page>\n";
-               $xml .= "    <title>$tl</title>\n";
+       if ( $doexport ) {
+               $wgOut->disable();
                
-               if( $full ) {
-                       $xml .= "    <id>$s->page_id</id>\n";
+               // Cancel output buffering and gzipping if set
+               // This should provide safer streaming for pages with history
+               wfResetOutputBuffers();
+               header( "Content-type: application/xml; charset=utf-8" );
+               if( $wgRequest->getCheck( 'wpDownload' ) ) {
+                       // Provide a sane filename suggestion
+                       $filename = urlencode( $wgSitename . '-' . wfTimestampNow() . '.xml' );
+                       $wgRequest->response()->header( "Content-disposition: attachment;filename={$filename}" );
                }
-               if( $s->page_restrictions ) {
-                       $xml .= "    <restrictions>" . xmlsafe( $s->page_restrictions ) . "</restrictions>\n";
+               
+               /* Split up the input and look up linked pages */
+               $inputPages = array_filter( explode( "\n", $page ) );
+               $pageSet = array_flip( $inputPages );
+
+               if( $wgRequest->getCheck( 'templates' ) ) {
+                       $pageSet = wfExportGetTemplates( $inputPages, $pageSet );
                }
 
-               if( $curonly ) {
-                       $res = Revision::fetchRevision( $title );
-               } else {
-                       $res = Revision::fetchAllRevisions( $title );
+               /*
+               // Enable this when we can do something useful exporting/importing image information. :)
+               if( $wgRequest->getCheck( 'images' ) ) {
+                       $pageSet = wfExportGetImages( $inputPages, $pageSet );
                }
-               if( $res ) {
-                       while( $s = $res->fetchObject() ) {
-                               $rev = new Revision( $s );
-                               $xml .= revision2xml( $rev, $full, false );
-                       }
-                       $res->free();
+               */
+               
+               $pages = array_keys( $pageSet );
+               
+               /* Ok, let's get to it... */
+
+               $db = wfGetDB( DB_SLAVE );
+               $exporter = new WikiExporter( $db, $history );
+               $exporter->list_authors = $list_authors ;
+               $exporter->openStream();
+               
+               foreach( $pages as $page ) {
+                       /*
+                       if( $wgExportMaxHistory && !$curonly ) {
+                               $title = Title::newFromText( $page );
+                               if( $title ) {
+                                       $count = Revision::countByTitle( $db, $title );
+                                       if( $count > $wgExportMaxHistory ) {
+                                               wfDebug( __FUNCTION__ .
+                                                       ": Skipped $page, $count revisions too big\n" );
+                                               continue;
+                                       }
+                               }
+                       }*/
+
+                       #Bug 8824: Only export pages the user can read
+                       $title = Title::newFromText( $page );
+                       if( is_null( $title ) ) continue; #TODO: perhaps output an <error> tag or something.
+                       if( !$title->userCan( 'read' ) ) continue; #TODO: perhaps output an <error> tag or something.
+
+                       $exporter->pageByTitle( $title );
                }
                
-               $xml .= "  </page>\n";
-               wfProfileOut( $fname );
-               return $xml;
-       } else {
-               wfProfileOut( $fname );
-               return "";
+               $exporter->closeStream();
+               return;
        }
-}
 
-/**
- * @return string
- * @param Revision $rev
- * @param bool $full
- * @access private
- */
-function revision2xml( $rev, $full ) {
-       $fname = 'revision2xml';
-       wfProfileIn( $fname );
+       $self = SpecialPage::getTitleFor( 'Export' );
+       $wgOut->addHtml( wfMsgExt( 'exporttext', 'parse' ) );
        
-       $xml = "    <revision>\n";
-       if( $full )
-               $xml .= "    <id>" . $rev->getId() . "</id>\n";
+       $form = Xml::openElement( 'form', array( 'method' => 'post',
+               'action' => $self->getLocalUrl( 'action=submit' ) ) );
        
-       $ts = wfTimestamp2ISO8601( $rev->getTimestamp() );
-       $xml .= "      <timestamp>$ts</timestamp>\n";
+       $form .= Xml::inputLabel( wfMsg( 'export-addcattext' )  , 'catname', 'catname', 40 ) . '&nbsp;';
+       $form .= Xml::submitButton( wfMsg( 'export-addcat' ), array( 'name' => 'addcat' ) ) . '<br />';
        
-       if( $rev->getUser() ) {
-               $u = "<username>" . xmlsafe( $rev->getUserText() ) . "</username>";
-               if( $full )
-                       $u .= "<id>" . $rev->getUser() . "</id>";
-       } else {
-               $u = "<ip>" . xmlsafe( $rev->getUserText() ) . "</ip>";
-       }
-       $xml .= "      <contributor>$u</contributor>\n";
+       $form .= Xml::openElement( 'textarea', array( 'name' => 'pages', 'cols' => 40, 'rows' => 10 ) );
+       $form .= htmlspecialchars( $page );
+       $form .= Xml::closeElement( 'textarea' );
+       $form .= '<br />';
        
-       if( $rev->isMinor() ) {
-               $xml .= "      <minor/>\n";
-       }
-       if($rev->getComment() != "") {
-               $c = xmlsafe( $rev->getComment() );
-               $xml .= "      <comment>$c</comment>\n";
+       if( $wgExportAllowHistory ) {
+               $form .= Xml::checkLabel( wfMsg( 'exportcuronly' ), 'curonly', 'curonly', true ) . '<br />';
+       } else {
+               $wgOut->addHtml( wfMsgExt( 'exportnohistory', 'parse' ) );
        }
-
-       $t = xmlsafe( $rev->getText() );
-
-       $xml .= "      <text>$t</text>\n";
-       $xml .= "    </revision>\n";
-       wfProfileOut( $fname );
-       return $xml;
-}
-
-function wfTimestamp2ISO8601( $ts ) {
-       #2003-08-05T18:30:02Z
-       return preg_replace( '/^(....)(..)(..)(..)(..)(..)$/', '$1-$2-$3T$4:$5:$6Z', $ts );
-}
-
-function xmlsafe( $string ) {
-       $fname = 'xmlsafe';
-       wfProfileIn( $fname );
+       $form .= Xml::checkLabel( wfMsg( 'export-templates' ), 'templates', 'wpExportTemplates', false ) . '<br />';
+       // Enable this when we can do something useful exporting/importing image information. :)
+       //$form .= Xml::checkLabel( wfMsg( 'export-images' ), 'images', 'wpExportImages', false ) . '<br />';
+       $form .= Xml::checkLabel( wfMsg( 'export-download' ), 'wpDownload', 'wpDownload', true ) . '<br />';
        
-       /**
-        * The page may contain old data which has not been properly normalized.
-        * Invalid UTF-8 sequences or forbidden control characters will make our
-        * XML output invalid, so be sure to strip them out.
-        */
-       $string = UtfNormal::cleanUp( $string );
-       
-       $string = htmlspecialchars( $string );
-       wfProfileOut( $fname );
-       return $string;
-}
-?>
+       $form .= Xml::submitButton( wfMsg( 'export-submit' ) );
+       $form .= Xml::closeElement( 'form' );
+       $wgOut->addHtml( $form );
+}
\ No newline at end of file