diocloid/LinkTitles
1
0
Fork 0
mirror of https://github.com/diocloid/LinkTitles.git synced 2025-07-13 17:59:29 +02:00
Code Issues Packages Projects Releases Wiki Activity

Revise comments.

Browse Source
This commit is contained in:
Daniel Kraus
2017-08-26 21:14:59 +02:00
parent 6c75eec1bb
commit 0a519bbc18
1 changed files with 100 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

103
includes/LinkTitles_Special.php
View File

@ -1,5 +1,7 @@
<?php <?php
/* /**
* Provides a special page for the LinkTitles extension.
*
* Copyright 2012-2017 Daniel Kraus <bovender@bovender.de> ('bovender') * Copyright 2012-2017 Daniel Kraus <bovender@bovender.de> ('bovender')
* *
* This program is free software; you can redistribute it and/or modify * This program is free software; you can redistribute it and/or modify
@ -16,6 +18,8 @@
* along with this program; if not, write to the Free Software * along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA. * MA 02110-1301, USA.
*
* @author Daniel Kraus <bovender@bovender.de>
*/ */
namespace LinkTitles; namespace LinkTitles;
/// @defgroup batch Batch processing /// @defgroup batch Batch processing
@ -26,13 +30,17 @@ if ( !defined( 'MEDIAWIKI' ) ) {
} }
/// @endcond /// @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. * Provides a special page that can be used to batch-process all pages in
/// @ingroup batch * the wiki. By default, this can only be performed by sysops.
* @ingroup batch
*
*/
class Special extends \SpecialPage { 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() { function __construct() {
// the second parameter in the following function call ensures that only // the second parameter in the following function call ensures that only
// users who have the 'linktitles-batch' right get to see this page (by // users who have the 'linktitles-batch' right get to see this page (by
@ -44,9 +52,11 @@ class Special extends \SpecialPage {
return 'pagetools'; 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) { function execute($par) {
// Prevent non-authorized users from executing the batch processing. // Prevent non-authorized users from executing the batch processing.
if ( !$this->userCanExecute( $this->getUser() ) ) { if ( !$this->userCanExecute( $this->getUser() ) ) {
@ -76,12 +86,13 @@ class Special extends \SpecialPage {
} }
} }
/// Processes wiki articles, starting at the page indicated by /**
/// $startTitle. If $wgLinkTitlesTimeLimit is reached before all pages are * Processes wiki articles, starting at the page indicated by
/// processed, returns the title of the next page that needs processing. * $startTitle. If $wgLinkTitlesTimeLimit is reached before all pages are
/// @param WebRequest $request WebRequest object that is associated with the special * processed, returns the title of the next page that needs processing.
/// page. * @param WebRequest $request WebRequest object that is associated with the special page.
/// @param OutputPage $output Output page for the special page. * @param OutputPage $output Output page for the special page.
*/
private function process( \WebRequest &$request, \OutputPage &$output) { private function process( \WebRequest &$request, \OutputPage &$output) {
global $wgLinkTitlesTimeLimit; global $wgLinkTitlesTimeLimit;
global $wgLinkTitlesNamespaces; global $wgLinkTitlesNamespaces;
@ -113,9 +124,7 @@ class Special extends \SpecialPage {
$end = $this->countPages($dbr, $namespacesClause ); $end = $this->countPages($dbr, $namespacesClause );
}; };
array_key_exists('r', $postValues) ? array_key_exists('r', $postValues) ? $reloads = $postValues['r'] : $reloads = 0;
$reloads = $postValues['r'] :
$reloads = 0;
// Retrieve page names from the database. // Retrieve page names from the database.
$res = $dbr->select( $res = $dbr->select(
@ -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 ) { private function buildInfoPage( &$request, &$output ) {
$url = $request->getRequestURL(); $url = $request->getRequestURL();
@ -192,12 +203,13 @@ EOF
); );
} }
/// Produces informative output in WikiText format to show while working. /*
/// @param $output Output object. * Produces informative output in WikiText format to show while working.
/// @param $curTitle Title of the currently processed page. * @param $output Output object.
/// @param $index Index of the currently processed page. * @param $curTitle Title of the currently processed page.
/// @param $end Last index that will be processed (i.e., number of * @param $index Index of the currently processed page.
/// pages). * @param $end Last index that will be processed (i.e., number of pages).
*/
private function addProgressInfo( &$output, $curTitle, $index, $end ) { private function addProgressInfo( &$output, $curTitle, $index, $end ) {
$progress = $index / $end * 100; $progress = $index / $end * 100;
$percent = sprintf("%01.1f", $progress); $percent = sprintf("%01.1f", $progress);
@ -232,14 +244,15 @@ EOF
); );
} }
/// Generates an HTML form and JavaScript to automatically submit the /*
/// form. * Generates an HTML form and JavaScript to automatically submit the
/// @param $url URL to reload with a POST request. * form.
/// @param $start Index of the next page that shall be processed. * @param $url URL to reload with a POST request.
/// @param $end Index of the last page to be processed. * @param $start Index of the next page that shall be processed.
/// @param $reloads Counter that holds the number of reloads so far. * @param $end Index of the last page to be processed.
/// @returns String that holds the HTML for a form and a * @param $reloads Counter that holds the number of reloads so far.
/// JavaScript command. * @returns String that holds the HTML for a form and a JavaScript command.
*/
private function getReloaderForm( $url, $start, $end, $reloads ) { private function getReloaderForm( $url, $start, $end, $reloads ) {
return return
<<<EOF <<<EOF
@ -255,12 +268,14 @@ EOF
; ;
} }
/// Adds statistics to the page when all processing is done. /*
/// @param $output Output object * Adds statistics to the page when all processing is done.
/// @param $start Index of the first page that was processed. * @param $output Output object
/// @param $end Index of the last processed page. * @param $start Index of the first page that was processed.
/// @param $reloads Number of reloads of the page. * @param $end Index of the last processed page.
/// @returns undefined * @param $reloads Number of reloads of the page.
* @returns undefined
*/
private function addCompletedInfo( &$output, $start, $end, $reloads ) { private function addCompletedInfo( &$output, $start, $end, $reloads ) {
global $wgLinkTitlesTimeLimit; global $wgLinkTitlesTimeLimit;
$pagesPerReload = sprintf('%0.1f', $end / $reloads); $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. * Counts the number of pages in a read-access wiki database ($dbr).
/// @returns Number of pages in the default namespace (0) of the wiki. * @param $dbr Read-only `Database` object.
* @returns Number of pages in the default namespace (0) of the wiki.
*/
private function countPages(&$dbr, $namespacesClause) { private function countPages(&$dbr, $namespacesClause) {
$res = $dbr->select( $res = $dbr->select(
'page', 'page',