diff --git a/LinkTitles_Maintenance.php b/LinkTitles_Maintenance.php index 96b6f93..b04273f 100755 --- a/LinkTitles_Maintenance.php +++ b/LinkTitles_Maintenance.php @@ -1,17 +1,17 @@ ('bovender') - * + * Copyright 2012-2016 Daniel Kraus @bovender + * * 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 * (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., 51 Franklin Street, Fifth Floor, Boston, @@ -29,7 +29,7 @@ if ( file_exists( $maintenanceScript ) ) { } else { - // Did not find the script where we expected it (maybe because we are a + // Did not find the script where we expected it (maybe because we are a // symlinked file -- __DIR resolves symbolic links). $maintenanceScript = __DIR__ . "/Maintenance.php"; if ( file_exists( $maintenanceScript ) ) { @@ -45,12 +45,12 @@ else }; require_once( __DIR__ . "/includes/LinkTitles_Extension.php" ); - + /// Core class of the maintanance script. -/// @note Note that the execution of maintenance scripts is prohibited for -/// an Apache web server due to a `.htaccess` file that declares `deny from +/// @note Note that the execution of maintenance scripts is prohibited for +/// an Apache web server due to a `.htaccess` file that declares `deny from /// all`. Other webservers may exhibit different behavior. Be aware that -/// anybody who is able to execute this script may place a high load on the +/// anybody who is able to execute this script may place a high load on the /// server. /// @ingroup batch class Cli extends \Maintenance { @@ -65,71 +65,84 @@ class Cli extends \Maintenance { true, // requires argument "s" ); - $this->addOption( + $this->addOption( "page", - "page to process", + "page name to process", false, // not required true, // requires argument "p" ); - $this->addOption( + $this->addOption( "log", "enables logging to console", false, // not required false, // requires no argument "l" ); - $this->addOption( + $this->addOption( "debug", "enables debug logging to console", false, // not required - false // requires no argument + false // requires no argument ); } /// Main function of the maintenance script. - /// Will iterate over all pages in the wiki (starting at a certain index, - /// if the `--start` option is given) and call LinkTitles::processPage() for + /// Will iterate over all pages in the wiki (starting at a certain index, + /// if the `--start` option is given) and call LinkTitles::processPage() for /// each page. public function execute() { - global $wgLinkTitlesNamespaces; - - $index = intval($this->getOption('start', 0)); - if ( $index < 0 ) { - $this->error('FATAL: Start index must be 0 or greater.', 1); - }; - - if ($this->hasOption('log')) - { - Extension::$ltConsoleOutput = true; - } - if ($this->hasOption('debug')) - { - Extension::$ltConsoleOutputDebug = true; - } - - $pagename = strval($this->getOption('page')); - if ($pagename != null) - { - - $curTitle = Title::newFromDBkey( $pagename ); - LinkTitles::processPage($curTitle,RequestContext::getMain() ); - $this->output("\nFinished parsing.\n"); - return; - } - // get our Namespaces - $namespacesClause = str_replace( '_', ' ','(' . implode( ', ',$wgLinkTitlesNamespaces ) . ')' ); - - // Connect to the database - $dbr = $this->getDB( DB_SLAVE ); + if ($this->hasOption('log')) + { + Extension::$ltConsoleOutput = true; + } + if ($this->hasOption('debug')) + { + Extension::$ltConsoleOutputDebug = true; + } + if ( $this->hasOption('page') ) { + if ( !$this->hasOption( 'start' ) ) { + $this->singlePage(); + } + else { + $this->error( 'FATAL: Must not use --start option with --page option.', 2 ); + } + } + else { + $startIndex = intval( $this->getOption( 'start', 0 ) ); + if ( $startIndex < 0 ) { + $this->error( 'FATAL: Start index must be 0 or greater.', 1 ); + }; + $this->allPages( $startIndex); + } + } + + private function singlePage() { + $pageName = strval( $this->getOption( 'page' ) ); + $this->output( "Processing single page: '$pageName'\n" ); + $title = \Title::newFromText( $pageName ); + $success = Extension::processPage( $title, \RequestContext::getMain() ); + if ( $success ) { + $this->output( "Finished.\n" ); + } + else { + $this->error( 'FATAL: There is no such page.', 3 ); + } + return $success; + } + + private function allPages( $index = 0 ) { + global $wgLinkTitlesNamespaces; // Retrieve page names from the database. - $res = $dbr->select( + $dbr = $this->getDB( DB_SLAVE ); + $namespacesClause = str_replace( '_', ' ','(' . implode( ', ', $wgLinkTitlesNamespaces ) . ')' ); + $res = $dbr->select( 'page', - array('page_title', 'page_namespace'), - array( - 'page_namespace IN ' . $namespacesClause, - ), + array( 'page_title', 'page_namespace' ), + array( + 'page_namespace IN ' . $namespacesClause, + ), __METHOD__, array( 'LIMIT' => 999999999, @@ -138,22 +151,19 @@ class Cli extends \Maintenance { ); $numPages = $res->numRows(); $context = \RequestContext::getMain(); - $this->output("Processing ${numPages} pages, starting at index ${index}...\n"); + $this->output( "Processing ${numPages} pages, starting at index ${index}...\n" ); - // Iterate through the pages; break if a time limit is exceeded. foreach ( $res as $row ) { - $index += 1; - $curTitle = \Title::makeTitleSafe( $row->page_namespace, $row->page_title); - $this->output( - sprintf("\rPage #%d (%02.0f%%) ", $index, $index / $numPages * 100) - ); - Extension::processPage($curTitle, $context); + $index += 1; // at this point, $index is only needed for reporting to user + $title = \Title::makeTitleSafe( $row->page_namespace, $row->page_title ); + $this->output( sprintf( "\rPage #%d (%02.0f%%) ", $index, $index / $numPages * 100 ) ); + Extension::processPage( $title, $context ); } - $this->output("\nFinished parsing.\n"); + $this->output( "\rFinished. \n" ); } } - + $maintClass = 'LinkTitles\Cli'; if( defined('RUN_MAINTENANCE_IF_MAIN') ) { require_once( RUN_MAINTENANCE_IF_MAIN ); diff --git a/NEWS b/NEWS index 8930b54..7f5a77a 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,13 @@ +Version 4.0.5 (2016-12-14) +------------------------------------------------------------------------ + +- Fix: Maintenance script would crash if invoked with the --page option. +- Fix: Remove leftover error log call. +- Improvement: Refactored maintenance script, improving user interaction. + +* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + + Version 4.0.4 (2016-11-30) ------------------------------------------------------------------------ diff --git a/extension.json b/extension.json index 907f8d8..adb9513 100644 --- a/extension.json +++ b/extension.json @@ -6,7 +6,7 @@ ], "type": "parserhook", "url": "https://www.mediawiki.org/wiki/Extension:LinkTitles", - "version": "4.0.4", + "version": "4.0.5", "license-name": "GPL-2.0+", "descriptionmsg": "linktitles-desc", "requires": { diff --git a/gh-pages b/gh-pages index 28e9c04..fe99cf4 160000 --- a/gh-pages +++ b/gh-pages @@ -1 +1 @@ -Subproject commit 28e9c0416e0793b797d09d567fc87a510074c911 +Subproject commit fe99cf4e039c3066c018fdf5973caee1cf4cef09 diff --git a/includes/LinkTitles_Extension.php b/includes/LinkTitles_Extension.php index 9883d91..60eaa44 100644 --- a/includes/LinkTitles_Extension.php +++ b/includes/LinkTitles_Extension.php @@ -124,7 +124,6 @@ class Extension { ( $wgLinkTitlesPreferShortTitles ) ? $sort_order = 'ASC' : $sort_order = 'DESC'; ( $wgLinkTitlesFirstOnly ) ? $limit = 1 : $limit = -1; $limitReached = false; - error_log($wgLinkTitlesFirstOnly); self::$currentTitle = $title; $newText = $text; @@ -248,26 +247,32 @@ class Extension { /// Automatically processes a single page, given a $title Title object. /// This function is called by the SpecialLinkTitles class and the /// LinkTitlesJob class. - /// @param string $title Page title. - /// @param RequestContext $context Current context. + /// @param Title $title Title object. + /// @param RequestContext $context Current request context. /// If in doubt, call MediaWiki's `RequestContext::getMain()` /// to obtain such an object. - /// @returns undefined - public static function processPage( $title, \RequestContext $context ) { - $titleObj = \Title::makeTitle(0, $title); - self::ltLog('Processing '. $titleObj->getPrefixedText()); - $page = \WikiPage::factory($titleObj); + /// @returns boolean True if the page exists, false if the page does not exist + public static function processPage( \Title $title, \RequestContext $context ) { + self::ltLog('Processing '. $title->getPrefixedText()); + $page = \WikiPage::factory($title); $content = $page->getContent(); - $text = $content->getContentHandler()->serializeContent($content); - $newText = self::parseContent($titleObj, $text); - if ( $text != $newText ) { - $content = $content->getContentHandler()->unserializeContent( $newText ); - $page->doQuickEditContent($content, - $context->getUser(), - "Links to existing pages added by LinkTitles bot.", // TODO: i18n - true // minor modification - ); - }; + if ( $content != null ) { + $text = $content->getContentHandler()->serializeContent($content); + $newText = self::parseContent($title, $text); + if ( $text != $newText ) { + $content = $content->getContentHandler()->unserializeContent( $newText ); + $page->doQuickEditContent( + $content, + $context->getUser(), + "Links to existing pages added by LinkTitles bot.", // TODO: i18n + true // minor modification + ); + }; + return true; + } + else { + return false; + } } /// Adds the two magic words defined by this extension to the list of