Style improvements
authorJeroen De Dauw <jeroendedauw@users.mediawiki.org>
Mon, 26 Jul 2010 17:31:38 +0000 (17:31 +0000)
committerJeroen De Dauw <jeroendedauw@users.mediawiki.org>
Mon, 26 Jul 2010 17:31:38 +0000 (17:31 +0000)
includes/specials/SpecialExport.php

index be9fecb..cec5c47 100644 (file)
@@ -46,7 +46,8 @@ class SpecialExport extends SpecialPage {
                $this->templates = $wgRequest->getCheck( 'templates' );
                $this->images = $wgRequest->getCheck( 'images' ); // Doesn't do anything yet
                $this->pageLinkDepth = $this->validateLinkDepth(
-                       $wgRequest->getIntOrNull( 'pagelink-depth' ) );
+                       $wgRequest->getIntOrNull( 'pagelink-depth' )
+               );
                $nsindex = '';
 
                if ( $wgRequest->getCheck( 'addcat' ) ) {
@@ -82,11 +83,13 @@ class SpecialExport extends SpecialPage {
                        $page = $wgRequest->getText( 'pages' );
                        $this->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(
@@ -95,6 +98,7 @@ class SpecialExport extends SpecialPage {
                                'limit' => $wgExportMaxHistory,
                        );
                        $historyCheck = $wgRequest->getCheck( 'history' );
+                       
                        if ( $this->curonly ) {
                                $history = WikiExporter::CURRENT;
                        } elseif ( !$historyCheck ) {
@@ -111,9 +115,10 @@ class SpecialExport extends SpecialPage {
 
                        if( $page != '' ) $this->doExport = true;
                } else {
-                       // Default to current-only for GET requests
+                       // Default to current-only for GET requests.
                        $page = $wgRequest->getText( 'pages', $par );
                        $historyCheck = $wgRequest->getCheck( 'history' );
+                       
                        if( $historyCheck ) {
                                $history = WikiExporter::FULL;
                        } else {
@@ -133,16 +138,20 @@ class SpecialExport extends SpecialPage {
 
                if ( $this->doExport ) {
                        $wgOut->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' ) ) {
                                // Provide a sane filename suggestion
                                $filename = urlencode( $wgSitename . '-' . wfTimestampNow() . '.xml' );
                                $wgRequest->response()->header( "Content-disposition: attachment;filename={$filename}" );
                        }
+                       
                        $this->doExport( $page, $history, $list_authors );
+                       
                        return;
                }
 
@@ -166,7 +175,9 @@ class SpecialExport extends SpecialPage {
                } else {
                        $wgOut->addHTML( wfMsgExt( 'exportnohistory', 'parse' ) );
                }
+               
                $form .= Xml::checkLabel( wfMsg( 'export-templates' ), 'templates', 'wpExportTemplates', false ) . '<br />';
+               
                if( $wgExportMaxLinkDepth || $this->userCanOverrideExportDepth() ) {
                        $form .= Xml::inputLabel( wfMsg( 'export-pagelinks' ), 'pagelink-depth', 'pagelink-depth', 20, 0 ) . '<br />';
                }
@@ -176,12 +187,12 @@ class SpecialExport extends SpecialPage {
 
                $form .= Xml::submitButton( wfMsg( 'export-submit' ), $wgUser->getSkin()->tooltipAndAccessKeyAttribs( 'export' ) );
                $form .= Xml::closeElement( 'form' );
+               
                $wgOut->addHTML( $form );
        }
 
        private function userCanOverrideExportDepth() {
                global $wgUser;
-
                return $wgUser->isAllowed( 'override-export-depth' );
        }
 
@@ -231,6 +242,7 @@ class SpecialExport extends SpecialPage {
                foreach( $pages as $k => $v ) {
                        $pages[$k] = str_replace( " ", "_", $v );
                }
+               
                $pages = array_unique( $pages );
 
                /* Ok, let's get to it... */
@@ -249,9 +261,11 @@ class SpecialExport extends SpecialPage {
                        set_time_limit(0);
                        wfRestoreWarnings();
                }
+               
                $exporter = new WikiExporter( $db, $history, $buffer );
                $exporter->list_authors = $list_authors;
                $exporter->openStream();
+               
                foreach( $pages as $page ) {
                        /*
                         if( $wgExportMaxHistory && !$this->curonly ) {
@@ -274,6 +288,7 @@ class SpecialExport extends SpecialPage {
                }
 
                $exporter->closeStream();
+               
                if( $lb ) {
                        $lb->closeAll();
                }
@@ -285,12 +300,16 @@ class SpecialExport extends SpecialPage {
                $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 ) ) {
                        $n = $row->page_title;
                        if ($row->page_namespace) {
@@ -300,6 +319,7 @@ class SpecialExport extends SpecialPage {
 
                        $pages[] = $n;
                }
+               
                $dbr->freeResult($res);
 
                return $pages;
@@ -309,21 +329,28 @@ class SpecialExport extends SpecialPage {
                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 ) ) {
                        $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);
+               
+               $dbr->freeResult( $res );
 
                return $pages;
        }
@@ -336,9 +363,10 @@ class SpecialExport extends SpecialPage {
         */
        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( 'tl_namespace AS namespace', 'tl_title AS title' ),
+                       array( 'page_id=tl_from' )
+               );
        }
 
        /**
@@ -346,14 +374,17 @@ class SpecialExport extends SpecialPage {
         */
        private function validateLinkDepth( $depth ) {
                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
@@ -364,55 +395,70 @@ class SpecialExport extends SpecialPage {
 
        /** Expand a list of pages to include pages linked to from that page. */
        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( 'pl_namespace AS namespace', 'pl_title AS 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( NS_FILE . ' AS namespace', 'il_to AS title' ),
+                       array( 'page_id=il_from' )
+               );
        }
 
        /**
         * Expand a list of pages to include items used in those pages.
-        * @private
         */
        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
                                ///        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;
        }
-}
-
+       
+}
\ No newline at end of file