mirror of
https://github.com/diocloid/LinkTitles.git
synced 2025-07-13 09:49:31 +02:00
Revise comments.
This commit is contained in:
Daniel Kraus
@ -1,21 +1,25 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright 2012-2017 Daniel Kraus <bovender@bovender.de> ('bovender')
|
||||
/**
|
||||
* Provides a special page for the LinkTitles extension.
|
||||
*
|
||||
* 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.
|
||||
* Copyright 2012-2017 Daniel Kraus <bovender@bovender.de> ('bovender')
|
||||
*
|
||||
* 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.
|
||||
* 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.
|
||||
*
|
||||
* 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,
|
||||
* MA 02110-1301, USA.
|
||||
* 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,
|
||||
* MA 02110-1301, USA.
|
||||
*
|
||||
* @author Daniel Kraus <bovender@bovender.de>
|
||||
*/
|
||||
namespace LinkTitles;
|
||||
/// @defgroup batch Batch processing
|
||||
@ -26,13 +30,17 @@ if ( !defined( 'MEDIAWIKI' ) ) {
|
||||
}
|
||||
/// @endcond
|
||||
|
||||
/// Provides a special page that can be used to batch-process all pages in
|
||||
/// the wiki. By default, this can only be performed by sysops.
|
||||
/// @ingroup batch
|
||||
/**
|
||||
* Provides a special page that can be used to batch-process all pages in
|
||||
* the wiki. By default, this can only be performed by sysops.
|
||||
* @ingroup batch
|
||||
*
|
||||
*/
|
||||
class Special extends \SpecialPage {
|
||||
|
||||
/// Constructor. Announces the special page title and required user right
|
||||
/// to the parent constructor.
|
||||
/**
|
||||
* Constructor. Announces the special page title and required user right to the parent constructor.
|
||||
*/
|
||||
function __construct() {
|
||||
// the second parameter in the following function call ensures that only
|
||||
// users who have the 'linktitles-batch' right get to see this page (by
|
||||
@ -44,9 +52,11 @@ class Special extends \SpecialPage {
|
||||
return 'pagetools';
|
||||
}
|
||||
|
||||
/// Entry function of the special page class. Will abort if the user does
|
||||
/// not have appropriate permissions ('linktitles-batch').
|
||||
/// @return undefined
|
||||
|
||||
/**
|
||||
* Entry function of the special page class. Will abort if the user does not have appropriate permissions ('linktitles-batch').
|
||||
* @param $par Additional parameters (required by interface; currently not used)
|
||||
*/
|
||||
function execute($par) {
|
||||
// Prevent non-authorized users from executing the batch processing.
|
||||
if ( !$this->userCanExecute( $this->getUser() ) ) {
|
||||
@ -76,18 +86,19 @@ class Special extends \SpecialPage {
|
||||
}
|
||||
}
|
||||
|
||||
/// Processes wiki articles, starting at the page indicated by
|
||||
/// $startTitle. If $wgLinkTitlesTimeLimit is reached before all pages are
|
||||
/// processed, returns the title of the next page that needs processing.
|
||||
/// @param WebRequest $request WebRequest object that is associated with the special
|
||||
/// page.
|
||||
/// @param OutputPage $output Output page for the special page.
|
||||
/**
|
||||
* Processes wiki articles, starting at the page indicated by
|
||||
* $startTitle. If $wgLinkTitlesTimeLimit is reached before all pages are
|
||||
* processed, returns the title of the next page that needs processing.
|
||||
* @param WebRequest $request WebRequest object that is associated with the special page.
|
||||
* @param OutputPage $output Output page for the special page.
|
||||
*/
|
||||
private function process( \WebRequest &$request, \OutputPage &$output) {
|
||||
global $wgLinkTitlesTimeLimit;
|
||||
global $wgLinkTitlesNamespaces;
|
||||
global $wgLinkTitlesNamespaces;
|
||||
|
||||
// get our Namespaces
|
||||
$namespacesClause = str_replace( '_', ' ','(' . implode( ', ',$wgLinkTitlesNamespaces ) . ')' );
|
||||
// get our Namespaces
|
||||
$namespacesClause = str_replace( '_', ' ','(' . implode( ', ',$wgLinkTitlesNamespaces ) . ')' );
|
||||
|
||||
// Start the stopwatch
|
||||
$startTime = microtime(true);
|
||||
@ -113,9 +124,7 @@ class Special extends \SpecialPage {
|
||||
$end = $this->countPages($dbr, $namespacesClause );
|
||||
};
|
||||
|
||||
array_key_exists('r', $postValues) ?
|
||||
$reloads = $postValues['r'] :
|
||||
$reloads = 0;
|
||||
array_key_exists('r', $postValues) ? $reloads = $postValues['r'] : $reloads = 0;
|
||||
|
||||
// Retrieve page names from the database.
|
||||
$res = $dbr->select(
|
||||
@ -126,7 +135,7 @@ class Special extends \SpecialPage {
|
||||
),
|
||||
__METHOD__,
|
||||
array(
|
||||
'LIMIT' => 999999999,
|
||||
'LIMIT' => 999999999,
|
||||
'OFFSET' => $start
|
||||
)
|
||||
);
|
||||
@ -149,7 +158,7 @@ class Special extends \SpecialPage {
|
||||
// If we have not reached the last page yet, produce code to reload
|
||||
// the extension's special page.
|
||||
if ( $start < $end )
|
||||
{
|
||||
{
|
||||
$reloads += 1;
|
||||
// Build a form with hidden values and output JavaScript code that
|
||||
// immediately submits the form in order to continue the process.
|
||||
@ -162,8 +171,10 @@ class Special extends \SpecialPage {
|
||||
}
|
||||
}
|
||||
|
||||
/// Adds WikiText to the output containing information about the extension
|
||||
/// and a form and button to start linking.
|
||||
/*
|
||||
* Adds WikiText to the output containing information about the extension
|
||||
* and a form and button to start linking.
|
||||
*/
|
||||
private function buildInfoPage( &$request, &$output ) {
|
||||
$url = $request->getRequestURL();
|
||||
|
||||
@ -192,12 +203,13 @@ EOF
|
||||
);
|
||||
}
|
||||
|
||||
/// Produces informative output in WikiText format to show while working.
|
||||
/// @param $output Output object.
|
||||
/// @param $curTitle Title of the currently processed page.
|
||||
/// @param $index Index of the currently processed page.
|
||||
/// @param $end Last index that will be processed (i.e., number of
|
||||
/// pages).
|
||||
/*
|
||||
* Produces informative output in WikiText format to show while working.
|
||||
* @param $output Output object.
|
||||
* @param $curTitle Title of the currently processed page.
|
||||
* @param $index Index of the currently processed page.
|
||||
* @param $end Last index that will be processed (i.e., number of pages).
|
||||
*/
|
||||
private function addProgressInfo( &$output, $curTitle, $index, $end ) {
|
||||
$progress = $index / $end * 100;
|
||||
$percent = sprintf("%01.1f", $progress);
|
||||
@ -232,14 +244,15 @@ EOF
|
||||
);
|
||||
}
|
||||
|
||||
/// Generates an HTML form and JavaScript to automatically submit the
|
||||
/// form.
|
||||
/// @param $url URL to reload with a POST request.
|
||||
/// @param $start Index of the next page that shall be processed.
|
||||
/// @param $end Index of the last page to be processed.
|
||||
/// @param $reloads Counter that holds the number of reloads so far.
|
||||
/// @returns String that holds the HTML for a form and a
|
||||
/// JavaScript command.
|
||||
/*
|
||||
* Generates an HTML form and JavaScript to automatically submit the
|
||||
* form.
|
||||
* @param $url URL to reload with a POST request.
|
||||
* @param $start Index of the next page that shall be processed.
|
||||
* @param $end Index of the last page to be processed.
|
||||
* @param $reloads Counter that holds the number of reloads so far.
|
||||
* @returns String that holds the HTML for a form and a JavaScript command.
|
||||
*/
|
||||
private function getReloaderForm( $url, $start, $end, $reloads ) {
|
||||
return
|
||||
<<<EOF
|
||||
@ -255,12 +268,14 @@ EOF
|
||||
;
|
||||
}
|
||||
|
||||
/// Adds statistics to the page when all processing is done.
|
||||
/// @param $output Output object
|
||||
/// @param $start Index of the first page that was processed.
|
||||
/// @param $end Index of the last processed page.
|
||||
/// @param $reloads Number of reloads of the page.
|
||||
/// @returns undefined
|
||||
/*
|
||||
* Adds statistics to the page when all processing is done.
|
||||
* @param $output Output object
|
||||
* @param $start Index of the first page that was processed.
|
||||
* @param $end Index of the last processed page.
|
||||
* @param $reloads Number of reloads of the page.
|
||||
* @returns undefined
|
||||
*/
|
||||
private function addCompletedInfo( &$output, $start, $end, $reloads ) {
|
||||
global $wgLinkTitlesTimeLimit;
|
||||
$pagesPerReload = sprintf('%0.1f', $end / $reloads);
|
||||
@ -281,9 +296,11 @@ EOF
|
||||
);
|
||||
}
|
||||
|
||||
/// Counts the number of pages in a read-access wiki database ($dbr).
|
||||
/// @param $dbr Read-only `Database` object.
|
||||
/// @returns Number of pages in the default namespace (0) of the wiki.
|
||||
/*
|
||||
* Counts the number of pages in a read-access wiki database ($dbr).
|
||||
* @param $dbr Read-only `Database` object.
|
||||
* @returns Number of pages in the default namespace (0) of the wiki.
|
||||
*/
|
||||
private function countPages(&$dbr, $namespacesClause) {
|
||||
$res = $dbr->select(
|
||||
'page',
|
||||
|
||||
Reference in New Issue
Block a user