<?php
/**
- * Copyright (C) 2003-2008 Brion Vibber <brion@pobox.com>
+ * Implements Special:Export
+ *
+ * Copyright © 2003-2008 Brion Vibber <brion@pobox.com>
*
* 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
*
* 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
+ *
+ * @file
+ * @ingroup SpecialPage
*/
/**
- * @file
+ * A special page that allows users to export pages in a XML file
+ *
* @ingroup SpecialPage
*/
-
class SpecialExport extends SpecialPage {
private $curonly, $doExport, $pageLinkDepth, $templates;
}
public function execute( $par ) {
- global $wgOut, $wgRequest, $wgSitename, $wgExportAllowListContributors;
+ global $wgSitename, $wgExportAllowListContributors, $wgExportFromNamespaces;
global $wgExportAllowHistory, $wgExportMaxHistory, $wgExportMaxLinkDepth;
- global $wgExportFromNamespaces, $wgUser;
+ global $wgExportAllowAll;
$this->setHeaders();
$this->outputHeader();
// Set some variables
$this->curonly = true;
$this->doExport = false;
- $this->templates = $wgRequest->getCheck( 'templates' );
- $this->images = $wgRequest->getCheck( 'images' ); // Doesn't do anything yet
+ $request = $this->getRequest();
+ $this->templates = $request->getCheck( 'templates' );
+ $this->images = $request->getCheck( 'images' ); // Doesn't do anything yet
$this->pageLinkDepth = $this->validateLinkDepth(
- $wgRequest->getIntOrNull( 'pagelink-depth' ) );
+ $request->getIntOrNull( 'pagelink-depth' )
+ );
$nsindex = '';
+ $exportall = false;
- if ( $wgRequest->getCheck( 'addcat' ) ) {
- $page = $wgRequest->getText( 'pages' );
- $catname = $wgRequest->getText( 'catname' );
+ if ( $request->getCheck( 'addcat' ) ) {
+ $page = $request->getText( 'pages' );
+ $catname = $request->getText( 'catname' );
if ( $catname !== '' && $catname !== null && $catname !== false ) {
$t = Title::makeTitleSafe( NS_MAIN, $catname );
if ( $t ) {
/**
- * @todo Fixme: this can lead to hitting memory limit for very large
+ * @todo 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 = $this->getPagesFromCategory( $t );
- if ( $catpages ) $page .= "\n" . implode( "\n", $catpages );
+ if ( $catpages ) {
+ $page .= "\n" . implode( "\n", $catpages );
+ }
}
}
}
- else if( $wgRequest->getCheck( 'addns' ) && $wgExportFromNamespaces ) {
- $page = $wgRequest->getText( 'pages' );
- $nsindex = $wgRequest->getText( 'nsindex', '' );
+ elseif( $request->getCheck( 'addns' ) && $wgExportFromNamespaces ) {
+ $page = $request->getText( 'pages' );
+ $nsindex = $request->getText( 'nsindex', '' );
if ( strval( $nsindex ) !== '' ) {
/**
* Same implementation as above, so same @todo
*/
$nspages = $this->getPagesFromNamespace( $nsindex );
- if ( $nspages ) $page .= "\n" . implode( "\n", $nspages );
+ if ( $nspages ) {
+ $page .= "\n" . implode( "\n", $nspages );
+ }
}
}
- else if( $wgRequest->wasPosted() && $par == '' ) {
- $page = $wgRequest->getText( 'pages' );
- $this->curonly = $wgRequest->getCheck( 'curonly' );
- $rawOffset = $wgRequest->getVal( 'offset' );
+ elseif( $request->getCheck( 'exportall' ) && $wgExportAllowAll ) {
+ $this->doExport = true;
+ $exportall = true;
+
+ /* Although $page and $history are not used later on, we
+ nevertheless set them to avoid that PHP notices about using
+ undefined variables foul up our XML output (see call to
+ doExport(...) further down) */
+ $page = '';
+ $history = '';
+ }
+ elseif( $request->wasPosted() && $par == '' ) {
+ $page = $request->getText( 'pages' );
+ $this->curonly = $request->getCheck( 'curonly' );
+ $rawOffset = $request->getVal( 'offset' );
+
if( $rawOffset ) {
$offset = wfTimestamp( TS_MW, $rawOffset );
} else {
$offset = null;
}
- $limit = $wgRequest->getInt( 'limit' );
- $dir = $wgRequest->getVal( 'dir' );
+
+ $limit = $request->getInt( 'limit' );
+ $dir = $request->getVal( 'dir' );
$history = array(
'dir' => 'asc',
'offset' => false,
'limit' => $wgExportMaxHistory,
);
- $historyCheck = $wgRequest->getCheck( 'history' );
+ $historyCheck = $request->getCheck( 'history' );
+
if ( $this->curonly ) {
$history = WikiExporter::CURRENT;
} elseif ( !$historyCheck ) {
}
}
- if( $page != '' ) $this->doExport = true;
+ if( $page != '' ) {
+ $this->doExport = true;
+ }
} else {
- // Default to current-only for GET requests
- $page = $wgRequest->getText( 'pages', $par );
- $historyCheck = $wgRequest->getCheck( 'history' );
+ // Default to current-only for GET requests.
+ $page = $request->getText( 'pages', $par );
+ $historyCheck = $request->getCheck( 'history' );
+
if( $historyCheck ) {
$history = WikiExporter::FULL;
} else {
$history = WikiExporter::CURRENT;
}
- if( $page != '' ) $this->doExport = true;
+ if( $page != '' ) {
+ $this->doExport = true;
+ }
}
if( !$wgExportAllowHistory ) {
$history = WikiExporter::CURRENT;
}
- $list_authors = $wgRequest->getCheck( 'listauthors' );
- if ( !$this->curonly || !$wgExportAllowListContributors ) $list_authors = false ;
+ $list_authors = $request->getCheck( 'listauthors' );
+ if ( !$this->curonly || !$wgExportAllowListContributors ) {
+ $list_authors = false ;
+ }
if ( $this->doExport ) {
- $wgOut->disable();
+ $this->getOutput()->disable();
+
// Cancel output buffering and gzipping if set
// This should provide safer streaming for pages with history
wfResetOutputBuffers();
- $wgRequest->response()->header( "Content-type: application/xml; charset=utf-8" );
- if( $wgRequest->getCheck( 'wpDownload' ) ) {
+ $request->response()->header( "Content-type: application/xml; charset=utf-8" );
+
+ if( $request->getCheck( 'wpDownload' ) ) {
// Provide a sane filename suggestion
$filename = urlencode( $wgSitename . '-' . wfTimestampNow() . '.xml' );
- $wgRequest->response()->header( "Content-disposition: attachment;filename={$filename}" );
+ $request->response()->header( "Content-disposition: attachment;filename={$filename}" );
}
- $this->doExport( $page, $history, $list_authors );
+
+ $this->doExport( $page, $history, $list_authors, $exportall );
+
return;
}
- $wgOut->addWikiMsg( 'exporttext' );
+ $out = $this->getOutput();
+ $out->addWikiMsg( 'exporttext' );
$form = Xml::openElement( 'form', array( 'method' => 'post',
'action' => $this->getTitle()->getLocalUrl( 'action=submit' ) ) );
- $form .= Xml::inputLabel( wfMsg( 'export-addcattext' ) , 'catname', 'catname', 40 ) . ' ';
- $form .= Xml::submitButton( wfMsg( 'export-addcat' ), array( 'name' => 'addcat' ) ) . '<br />';
+ $form .= Xml::inputLabel( $this->msg( 'export-addcattext' )->text(), 'catname', 'catname', 40 ) . ' ';
+ $form .= Xml::submitButton( $this->msg( 'export-addcat' )->text(), array( 'name' => 'addcat' ) ) . '<br />';
if ( $wgExportFromNamespaces ) {
- $form .= Xml::namespaceSelector( $nsindex, null, 'nsindex', wfMsg( 'export-addnstext' ) ) . ' ';
- $form .= Xml::submitButton( wfMsg( 'export-addns' ), array( 'name' => 'addns' ) ) . '<br />';
+ $form .= Html::namespaceSelector(
+ array(
+ 'selected' => $nsindex,
+ 'label' => $this->msg( 'export-addnstext' )->text()
+ ), array(
+ 'name' => 'nsindex',
+ 'id' => 'namespace',
+ 'class' => 'namespaceselector',
+ )
+ ) . ' ';
+ $form .= Xml::submitButton( $this->msg( 'export-addns' )->text(), array( 'name' => 'addns' ) ) . '<br />';
+ }
+
+ if ( $wgExportAllowAll ) {
+ $form .= Xml::checkLabel(
+ $this->msg( 'exportall' )->text(),
+ 'exportall',
+ 'exportall',
+ $request->wasPosted() ? $request->getCheck( 'exportall' ) : false
+ ) . '<br />';
}
$form .= Xml::element( 'textarea', array( 'name' => 'pages', 'cols' => 40, 'rows' => 10 ), $page, false );
$form .= '<br />';
if( $wgExportAllowHistory ) {
- $form .= Xml::checkLabel( wfMsg( 'exportcuronly' ), 'curonly', 'curonly', true ) . '<br />';
+ $form .= Xml::checkLabel(
+ $this->msg( 'exportcuronly' )->text(),
+ 'curonly',
+ 'curonly',
+ $request->wasPosted() ? $request->getCheck( 'curonly' ) : true
+ ) . '<br />';
} else {
- $wgOut->addHTML( wfMsgExt( 'exportnohistory', 'parse' ) );
+ $out->addWikiMsg( 'exportnohistory' );
}
- $form .= Xml::checkLabel( wfMsg( 'export-templates' ), 'templates', 'wpExportTemplates', false ) . '<br />';
+
+ $form .= Xml::checkLabel(
+ $this->msg( 'export-templates' )->text(),
+ 'templates',
+ 'wpExportTemplates',
+ $request->wasPosted() ? $request->getCheck( 'templates' ) : false
+ ) . '<br />';
+
if( $wgExportMaxLinkDepth || $this->userCanOverrideExportDepth() ) {
- $form .= Xml::inputLabel( wfMsg( 'export-pagelinks' ), 'pagelink-depth', 'pagelink-depth', 20, 0 ) . '<br />';
+ $form .= Xml::inputLabel( $this->msg( 'export-pagelinks' )->text(), 'pagelink-depth', 'pagelink-depth', 20, 0 ) . '<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 />';
+ //$form .= Xml::checkLabel( $this->msg( 'export-images' )->text(), 'images', 'wpExportImages', false ) . '<br />';
+ $form .= Xml::checkLabel(
+ $this->msg( 'export-download' )->text(),
+ 'wpDownload',
+ 'wpDownload',
+ $request->wasPosted() ? $request->getCheck( 'wpDownload' ) : true
+ ) . '<br />';
+
+ if ( $wgExportAllowListContributors ) {
+ $form .= Xml::checkLabel(
+ $this->msg( 'exportlistauthors' )->text(),
+ 'listauthors',
+ 'listauthors',
+ $request->wasPosted() ? $request->getCheck( 'listauthors' ) : false
+ ) . '<br />';
+ }
- $form .= Xml::submitButton( wfMsg( 'export-submit' ), $wgUser->getSkin()->tooltipAndAccessKeyAttribs( 'export' ) );
+ $form .= Xml::submitButton( $this->msg( 'export-submit' )->text(), Linker::tooltipAndAccesskeyAttribs( 'export' ) );
$form .= Xml::closeElement( 'form' );
- $wgOut->addHTML( $form );
+
+ $out->addHTML( $form );
}
+ /**
+ * @return bool
+ */
private function userCanOverrideExportDepth() {
- global $wgUser;
-
- return $wgUser->isAllowed( 'override-export-depth' );
+ return $this->getUser()->isAllowed( 'override-export-depth' );
}
/**
* @param $history Mixed: one of the WikiExporter history export constants
* @param $list_authors Boolean: Whether to add distinct author list (when
* not returning full history)
+ * @param $exportall Boolean: Whether to export everything
*/
- private function doExport( $page, $history, $list_authors ) {
- global $wgExportMaxHistory;
+ private function doExport( $page, $history, $list_authors, $exportall ) {
- $pageSet = array(); // Inverted index of all pages to look up
+ // If we are grabbing everything, enable full history and ignore the rest
+ if ( $exportall ) {
+ $history = WikiExporter::FULL;
+ } else {
- // Split up and normalize input
- foreach( explode( "\n", $page ) as $pageName ) {
- $pageName = trim( $pageName );
- $title = Title::newFromText( $pageName );
- if( $title && $title->getInterwiki() == '' && $title->getText() !== '' ) {
- // Only record each page once!
- $pageSet[$title->getPrefixedText()] = true;
+ $pageSet = array(); // Inverted index of all pages to look up
+
+ // Split up and normalize input
+ foreach( explode( "\n", $page ) as $pageName ) {
+ $pageName = trim( $pageName );
+ $title = Title::newFromText( $pageName );
+ if( $title && $title->getInterwiki() == '' && $title->getText() !== '' ) {
+ // Only record each page once!
+ $pageSet[$title->getPrefixedText()] = true;
+ }
}
- }
- // Set of original pages to pass on to further manipulation...
- $inputPages = array_keys( $pageSet );
+ // Set of original pages to pass on to further manipulation...
+ $inputPages = array_keys( $pageSet );
- // Look up any linked pages if asked...
- if( $this->templates ) {
- $pageSet = $this->getTemplates( $inputPages, $pageSet );
- }
+ // Look up any linked pages if asked...
+ if( $this->templates ) {
+ $pageSet = $this->getTemplates( $inputPages, $pageSet );
+ }
+ $linkDepth = $this->pageLinkDepth;
+ if( $linkDepth ) {
+ $pageSet = $this->getPageLinks( $inputPages, $pageSet, $linkDepth );
+ }
- if( $linkDepth = $this->pageLinkDepth ) {
- $pageSet = $this->getPageLinks( $inputPages, $pageSet, $linkDepth );
- }
+ /*
+ // Enable this when we can do something useful exporting/importing image information. :)
+ if( $this->images ) ) {
+ $pageSet = $this->getImages( $inputPages, $pageSet );
+ }
+ */
- /*
- // Enable this when we can do something useful exporting/importing image information. :)
- if( $this->images ) ) {
- $pageSet = $this->getImages( $inputPages, $pageSet );
- }
- */
+ $pages = array_keys( $pageSet );
- $pages = array_keys( $pageSet );
+ // Normalize titles to the same format and remove dupes, see bug 17374
+ foreach( $pages as $k => $v ) {
+ $pages[$k] = str_replace( " ", "_", $v );
+ }
- // Normalize titles to the same format and remove dupes, see bug 17374
- foreach( $pages as $k => $v ) {
- $pages[$k] = str_replace( " ", "_", $v );
+ $pages = array_unique( $pages );
}
- $pages = array_unique( $pages );
/* Ok, let's get to it... */
if( $history == WikiExporter::CURRENT ) {
set_time_limit(0);
wfRestoreWarnings();
}
+
$exporter = new WikiExporter( $db, $history, $buffer );
$exporter->list_authors = $list_authors;
$exporter->openStream();
- foreach( $pages as $page ) {
+
+ if ( $exportall ) {
+ $exporter->allPages();
+ } else {
+ foreach( $pages as $page ) {
/*
if( $wgExportMaxHistory && !$this->curonly ) {
$title = Title::newFromText( $page );
}
}*/
#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->userCanRead() ) continue; #TODO: perhaps output an <error> tag or something.
+ $title = Title::newFromText( $page );
+ if( is_null( $title ) ) {
+ continue; #TODO: perhaps output an <error> tag or something.
+ }
+ if( !$title->userCan( 'read', $this->getUser() ) ) {
+ continue; #TODO: perhaps output an <error> tag or something.
+ }
- $exporter->pageByTitle( $title );
+ $exporter->pageByTitle( $title );
+ }
}
$exporter->closeStream();
+
if( $lb ) {
$lb->closeAll();
}
}
+ /**
+ * @param $title Title
+ * @return array
+ */
private function getPagesFromCategory( $title ) {
global $wgContLang;
$name = $title->getDBkey();
$dbr = wfGetDB( DB_SLAVE );
- $res = $dbr->select( array('page', 'categorylinks' ),
- array( 'page_namespace', 'page_title' ),
- array('cl_from=page_id', 'cl_to' => $name ),
- __METHOD__, array('LIMIT' => '5000'));
+ $res = $dbr->select(
+ array( 'page', 'categorylinks' ),
+ array( 'page_namespace', 'page_title' ),
+ array( 'cl_from=page_id', 'cl_to' => $name ),
+ __METHOD__,
+ array( 'LIMIT' => '5000' )
+ );
$pages = array();
- while ( $row = $dbr->fetchObject( $res ) ) {
+
+ foreach ( $res as $row ) {
$n = $row->page_title;
if ($row->page_namespace) {
$ns = $wgContLang->getNsText( $row->page_namespace );
$pages[] = $n;
}
- $dbr->freeResult($res);
-
return $pages;
}
+ /**
+ * @param $nsindex int
+ * @return array
+ */
private function getPagesFromNamespace( $nsindex ) {
global $wgContLang;
$dbr = wfGetDB( DB_SLAVE );
- $res = $dbr->select( 'page', array('page_namespace', 'page_title'),
- array('page_namespace' => $nsindex),
- __METHOD__, array('LIMIT' => '5000') );
+ $res = $dbr->select(
+ 'page',
+ array( 'page_namespace', 'page_title' ),
+ array( 'page_namespace' => $nsindex ),
+ __METHOD__,
+ array( 'LIMIT' => '5000' )
+ );
$pages = array();
- while ( $row = $dbr->fetchObject( $res ) ) {
+
+ foreach ( $res as $row ) {
$n = $row->page_title;
- if ($row->page_namespace) {
+
+ if ( $row->page_namespace ) {
$ns = $wgContLang->getNsText( $row->page_namespace );
$n = $ns . ':' . $n;
}
$pages[] = $n;
}
- $dbr->freeResult($res);
-
return $pages;
}
*/
private function getTemplates( $inputPages, $pageSet ) {
return $this->getLinks( $inputPages, $pageSet,
- 'templatelinks',
- array( 'tl_namespace AS namespace', 'tl_title AS title' ),
- array( 'page_id=tl_from' ) );
+ 'templatelinks',
+ array( 'namespace' => 'tl_namespace', 'title' => 'tl_title' ),
+ array( 'page_id=tl_from' )
+ );
}
/**
* Validate link depth setting, if available.
+ * @param $depth int
+ * @return int
*/
private function validateLinkDepth( $depth ) {
- global $wgExportMaxLinkDepth, $wgExportMaxLinkDepthLimit;
+ global $wgExportMaxLinkDepth;
+
if( $depth < 0 ) {
return 0;
}
+
if ( !$this->userCanOverrideExportDepth() ) {
if( $depth > $wgExportMaxLinkDepth ) {
return $wgExportMaxLinkDepth;
}
}
+
/*
* There's a HARD CODED limit of 5 levels of recursion here to prevent a
* crazy-big export from being done by someone setting the depth
return intval( min( $depth, 5 ) );
}
- /** Expand a list of pages to include pages linked to from that page. */
+ /**
+ * Expand a list of pages to include pages linked to from that page.
+ * @param $inputPages array
+ * @param $pageSet array
+ * @param $depth int
+ * @return array
+ */
private function getPageLinks( $inputPages, $pageSet, $depth ) {
- for( $depth=$depth; $depth>0; --$depth ) {
- $pageSet = $this->getLinks( $inputPages, $pageSet, 'pagelinks',
- array( 'pl_namespace AS namespace', 'pl_title AS title' ),
- array( 'page_id=pl_from' ) );
+ for( ; $depth > 0; --$depth ) {
+ $pageSet = $this->getLinks(
+ $inputPages, $pageSet, 'pagelinks',
+ array( 'namespace' => 'pl_namespace', 'title' => 'pl_title' ),
+ array( 'page_id=pl_from' )
+ );
$inputPages = array_keys( $pageSet );
}
+
return $pageSet;
}
/**
* 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
*/
private function getImages( $inputPages, $pageSet ) {
- return $this->getLinks( $inputPages, $pageSet,
- 'imagelinks',
- array( NS_FILE . ' AS namespace', 'il_to AS title' ),
- array( 'page_id=il_from' ) );
+ return $this->getLinks(
+ $inputPages,
+ $pageSet,
+ 'imagelinks',
+ array( 'namespace' => NS_FILE, 'title' => 'il_to' ),
+ array( 'page_id=il_from' )
+ );
}
/**
* Expand a list of pages to include items used in those pages.
- * @private
+ * @return array
*/
private function getLinks( $inputPages, $pageSet, $table, $fields, $join ) {
$dbr = wfGetDB( DB_SLAVE );
+
foreach( $inputPages as $page ) {
$title = Title::newFromText( $page );
+
if( $title ) {
$pageSet[$title->getPrefixedText()] = true;
- /// @todo Fixme: May or may not be more efficient to batch these
+ /// @todo 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__ );
+ 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;
}
-}
+}