]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - maintenance/rebuildFileCache.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / maintenance / rebuildFileCache.php
index a1aecd80adad0e3932eb5bbf5cbf0bf614750abf..fe3944c8764dce534ba854c8aede865800e3b996 100644 (file)
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @file
  * @ingroup Maintenance
  */
 
-require_once( dirname( __FILE__ ) . '/Maintenance.php' );
+require_once __DIR__ . '/Maintenance.php';
 
+/**
+ * Maintenance script that builds file cache for content pages.
+ *
+ * @ingroup Maintenance
+ */
 class RebuildFileCache extends Maintenance {
+       private $enabled = true;
+
        public function __construct() {
                parent::__construct();
-               $this->mDescription = "Build file cache for content pages";
-               $this->addArg( 'start', 'Page_id to start from', true );
-               $this->addArg( 'overwrite', 'Refresh page cache', false );
+               $this->addDescription( 'Build file cache for content pages' );
+               $this->addOption( 'start', 'Page_id to start from', false, true );
+               $this->addOption( 'end', 'Page_id to end on', false, true );
+               $this->addOption( 'overwrite', 'Refresh page cache' );
                $this->setBatchSize( 100 );
        }
 
+       public function finalSetup() {
+               global $wgDebugToolbar, $wgUseFileCache;
+
+               $this->enabled = $wgUseFileCache;
+               // Script will handle capturing output and saving it itself
+               $wgUseFileCache = false;
+               // Debug toolbar makes content uncacheable so we disable it.
+               // Has to be done before Setup.php initialize MWDebug
+               $wgDebugToolbar = false;
+               //  Avoid DB writes (like enotif/counters)
+               MediaWiki\MediaWikiServices::getInstance()->getReadOnlyMode()
+                       ->setReason( 'Building cache' );
+
+               parent::finalSetup();
+       }
+
        public function execute() {
-               global $wgUseFileCache, $wgDisableCounters, $wgContentNamespaces, $wgRequestTime;
-               global $wgTitle, $wgArticle, $wgOut, $wgUser;
-               if ( !$wgUseFileCache ) {
+               global $wgRequestTime;
+
+               if ( !$this->enabled ) {
                        $this->error( "Nothing to do -- \$wgUseFileCache is disabled.", true );
                }
-               $wgDisableCounters = false;
-               $start = $this->getArg( 0, "0" );
+
+               $start = $this->getOption( 'start', "0" );
                if ( !ctype_digit( $start ) ) {
                        $this->error( "Invalid value for start parameter.", true );
                }
                $start = intval( $start );
-               $overwrite = $this->hasArg( 1 ) && $this->getArg( 1 ) === 'overwrite';
+
+               $end = $this->getOption( 'end', "0" );
+               if ( !ctype_digit( $end ) ) {
+                       $this->error( "Invalid value for end parameter.", true );
+               }
+               $end = intval( $end );
+
                $this->output( "Building content page file cache from page {$start}!\n" );
 
-               $dbr = wfGetDB( DB_SLAVE );
-               $start = $start > 0 ? $start : $dbr->selectField( 'page', 'MIN(page_id)', false, __FUNCTION__ );
-               $end = $dbr->selectField( 'page', 'MAX(page_id)', false, __FUNCTION__ );
+               $dbr = $this->getDB( DB_REPLICA );
+               $overwrite = $this->hasOption( 'overwrite' );
+               $start = ( $start > 0 )
+                       ? $start
+                       : $dbr->selectField( 'page', 'MIN(page_id)', false, __METHOD__ );
+               $end = ( $end > 0 )
+                       ? $end
+                       : $dbr->selectField( 'page', 'MAX(page_id)', false, __METHOD__ );
                if ( !$start ) {
                        $this->error( "Nothing to do.", true );
                }
 
                $_SERVER['HTTP_ACCEPT_ENCODING'] = 'bgzip'; // hack, no real client
-               OutputPage::setEncodings(); # Not really used yet
 
                # Do remaining chunk
                $end += $this->mBatchSize - 1;
                $blockStart = $start;
                $blockEnd = $start + $this->mBatchSize - 1;
 
-               $dbw = wfGetDB( DB_MASTER );
+               $dbw = $this->getDB( DB_MASTER );
                // Go through each page and save the output
                while ( $blockEnd <= $end ) {
                        // Get the pages
-                       $res = $dbr->select( 'page', array( 'page_namespace', 'page_title', 'page_id' ),
-                               array( 'page_namespace' => $wgContentNamespaces,
-                                       "page_id BETWEEN $blockStart AND $blockEnd" ),
-                               array( 'ORDER BY' => 'page_id ASC', 'USE INDEX' => 'PRIMARY' )
+                       $res = $dbr->select( 'page',
+                               [ 'page_namespace', 'page_title', 'page_id' ],
+                               [ 'page_namespace' => MWNamespace::getContentNamespaces(),
+                                       "page_id BETWEEN $blockStart AND $blockEnd" ],
+                               __METHOD__,
+                               [ 'ORDER BY' => 'page_id ASC', 'USE INDEX' => 'PRIMARY' ]
                        );
+
+                       $this->beginTransaction( $dbw, __METHOD__ ); // for any changes
                        foreach ( $res as $row ) {
                                $rebuilt = false;
-                               $wgRequestTime = wfTime(); # bug 22852
-                               $wgTitle = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
-                               if ( null == $wgTitle ) {
+
+                               $title = Title::makeTitleSafe( $row->page_namespace, $row->page_title );
+                               if ( null == $title ) {
                                        $this->output( "Page {$row->page_id} has bad title\n" );
                                        continue; // broken title?
                                }
-                               $wgOut->setTitle( $wgTitle ); // set display title
-                               $wgUser->getSkin( $wgTitle ); // set skin title
-                               $wgArticle = new Article( $wgTitle );
+
+                               $context = new RequestContext();
+                               $context->setTitle( $title );
+                               $article = Article::newFromTitle( $title, $context );
+                               $context->setWikiPage( $article->getPage() );
+
+                               // Some extensions like FlaggedRevs while error out if this is unset
+                               RequestContext::getMain()->setTitle( $title );
+
                                // If the article is cacheable, then load it
-                               if ( $wgArticle->isFileCacheable() ) {
-                                       $cache = new HTMLFileCache( $wgTitle );
-                                       if ( $cache->isFileCacheGood() ) {
+                               if ( $article->isFileCacheable( HTMLFileCache::MODE_REBUILD ) ) {
+                                       $viewCache = new HTMLFileCache( $title, 'view' );
+                                       $historyCache = new HTMLFileCache( $title, 'history' );
+                                       if ( $viewCache->isCacheGood() && $historyCache->isCacheGood() ) {
                                                if ( $overwrite ) {
                                                        $rebuilt = true;
                                                } else {
-                                                       $this->output( "Page {$row->page_id} already cached\n" );
+                                                       $this->output( "Page '$title' (id {$row->page_id}) already cached\n" );
                                                        continue; // done already!
                                                }
                                        }
-                                       ob_start( array( &$cache, 'saveToFileCache' ) ); // save on ob_end_clean()
-                                       $wgUseFileCache = false; // hack, we don't want $wgArticle fiddling with filecache
-                                       $wgArticle->view();
-                                       @$wgOut->output(); // header notices
-                                       $wgUseFileCache = true;
-                                       ob_end_clean(); // clear buffer
-                                       $wgOut = new OutputPage(); // empty out any output page garbage
-                                       if ( $rebuilt )
-                                               $this->output( "Re-cached page {$row->page_id}\n" );
-                                       else
-                                               $this->output( "Cached page {$row->page_id}\n" );
+
+                                       MediaWiki\suppressWarnings(); // header notices
+                                       // Cache ?action=view
+                                       $wgRequestTime = microtime( true ); # T24852
+                                       ob_start();
+                                       $article->view();
+                                       $context->getOutput()->output();
+                                       $context->getOutput()->clearHTML();
+                                       $viewHtml = ob_get_clean();
+                                       $viewCache->saveToFileCache( $viewHtml );
+                                       // Cache ?action=history
+                                       $wgRequestTime = microtime( true ); # T24852
+                                       ob_start();
+                                       Action::factory( 'history', $article, $context )->show();
+                                       $context->getOutput()->output();
+                                       $context->getOutput()->clearHTML();
+                                       $historyHtml = ob_get_clean();
+                                       $historyCache->saveToFileCache( $historyHtml );
+                                       MediaWiki\restoreWarnings();
+
+                                       if ( $rebuilt ) {
+                                               $this->output( "Re-cached page '$title' (id {$row->page_id})..." );
+                                       } else {
+                                               $this->output( "Cached page '$title' (id {$row->page_id})..." );
+                                       }
+                                       $this->output( "[view: " . strlen( $viewHtml ) . " bytes; " .
+                                               "history: " . strlen( $historyHtml ) . " bytes]\n" );
                                } else {
-                                       $this->output( "Page {$row->page_id} not cacheable\n" );
+                                       $this->output( "Page '$title' (id {$row->page_id}) not cacheable\n" );
                                }
-                               $dbw->commit(); // commit any changes
                        }
+                       $this->commitTransaction( $dbw, __METHOD__ ); // commit any changes (just for sanity)
+
                        $blockStart += $this->mBatchSize;
                        $blockEnd += $this->mBatchSize;
-                       wfWaitForSlaves( 5 );
                }
                $this->output( "Done!\n" );
-
-               // Remove these to be safe
-               if ( isset( $wgTitle ) )
-                       unset( $wgTitle );
-               if ( isset( $wgArticle ) )
-                       unset( $wgArticle );
        }
 }
 
 $maintClass = "RebuildFileCache";
-require_once( RUN_MAINTENANCE_IF_MAIN );
+require_once RUN_MAINTENANCE_IF_MAIN;