Phpdoc comments and place holder. Part of the subpackage "maintenance", archives in subpackage "maintenanceArchive"

This commit is contained in:
Antoine Musso 2004-09-03 20:33:01 +00:00
parent d8afcb5ae8
commit 6bbcf091bf
46 changed files with 422 additions and 131 deletions

View file

@ -32,6 +32,8 @@
* The script then print a list of wgAllMessagesXX keys that aren't
* localised, a percentage of messages correctly localised and the
* number of messages to be translated.
* @package MediaWiki
* @subpackage Maintenance
*/
/** This script run from the commandline */

View file

@ -1,9 +1,16 @@
<?php
# Script to initialise the MediaWiki namespace
# This script is included from update.php and install.php. Do not run it
# by itself.
/**
* Script to initialise the MediaWiki namespace
*
* This script is included from update.php and install.php. Do not run it
* by itself.
*
* @deprecated
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
function initialiseMessages( $overwrite = false, $messageArray = false ) {
global $wgLang, $wgScript, $wgServer, $wgAllMessagesEn;
global $wgOut, $wgArticle, $wgUser;

View file

@ -1,5 +1,11 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
/** */
print "This script is obsolete!";
print "It is retained in the source here in case some of its
code might be useful for ad-hoc conversion tasks, but it is

View file

@ -1,5 +1,11 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
/** */
print "This script is obsolete!";
print "It is retained in the source here in case some of its
code might be useful for ad-hoc conversion tasks, but it is

View file

@ -1,5 +1,11 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
/** */
print "This script is obsolete!";
print "It is retained in the source here in case some of its
code might be useful for ad-hoc conversion tasks, but it is
@ -53,7 +59,13 @@ $usercache = array();
$titlecache = array();
$linkcache = array();
# Some oversimplified test types
/**
* Some oversimplified test types
*
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
class Title {
var $title, $namespace;
function fromData( $namespace, $title ) {

View file

@ -1,5 +1,11 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
/** */
function isTemplateInitialised() {
$fname = 'isTemplateInitialised';

View file

@ -1,4 +1,12 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
/** */
# Move "custom messages" from the MediaWiki namespace to the Template namespace
# Usage: php moveCustomMessages.php [<lang>] [phase]

View file

@ -1,7 +1,13 @@
<?php
/**
* Rebuild recent changes table
*
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
# Rebuild recent changes table.
/** */
function rebuildRecentChangesTable()
{
$sql = "DROP TABLE IF EXISTS recentchanges";

View file

@ -1,5 +1,11 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage MaintenanceArchive
*/
/** */
print "This script is obsolete!";
print "It is retained in the source here in case some of its
code might be useful for ad-hoc conversion tasks, but it is

View file

@ -1,5 +1,12 @@
<?php
# Script for re-attributing edits
/**
* Script for re-attributing edits
*
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
# Parameters

View file

@ -1,17 +1,20 @@
<?php
/**
* Check to see if all messages have been translated into
* the selected language. To run this script, you must have
* a working installation, and it checks the selected language
* of that installation.
*
* The enhanced version will check more arrays than just
* wgAllMessages
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Check to see if all messages have been translated into
# the selected language. To run this script, you must have
# a working installation, and it checks the selected language
# of that installation.
#
# The enhanced version will check more arrays than just
# wgAllMessages
function check($arrayname)
{
/** */
function check($arrayname) {
$arraynameprinted = 0;
global $count, $total, $wgLanguageCode;
@ -37,11 +40,6 @@ function check($arrayname)
}
}
if ( ! is_readable( "../LocalSettings.php" ) ) {
print "A copy of your installation's LocalSettings.php\n" .
"must exist in the source directory.\n";
@ -72,11 +70,6 @@ $wgCommandLineMode = true;
$count = $total = 0;
check("wgLanguageNames");
check("wgNamespaceNames");
check("wgDefaultUserOptions");
@ -93,4 +86,3 @@ check("wgDeveloperSpecialPages");
check("wgAllMessages");
print "{$count} messages of {$total} not translated.\n";

View file

@ -1,11 +1,15 @@
<?php
/**
* Check to see if all messages have been translated into
* the selected language. To run this script, you must have
* a working installation, and it checks the selected language
* of that installation.
*
* @package MediaWiki
* @subpackage Maintenance
*/
# Check to see if all messages have been translated into
# the selected language. To run this script, you must have
# a working installation, and it checks the selected language
# of that installation.
#
/** */
if ( ! is_readable( "../LocalSettings.php" ) ) {
print "A copy of your installation's LocalSettings.php\n" .
"must exist in the source directory.\n";
@ -45,4 +49,3 @@ foreach ( $wgAllMessagesEn as $code => $msg ) {
}
}
print "{$count} messages of {$total} not translated.\n";

View file

@ -1,5 +1,11 @@
<?php
/**
* @deprecated
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
die("This script is not being maintained.");
# Checks translation of all language files
@ -104,4 +110,3 @@ foreach ( $filenames as $filename ) {
print "\n" . str_repeat( "-", $width ) . "\n";
print "{$count} messages of {$total} not translated.\n";

View file

@ -1,8 +1,13 @@
<?php
/**
* Creating a new empty database; either this or the conversion
* script from the old format needs to be run, but not both.
*
* @package MediaWiki
* @subpackage Maintenance
*/
# Creating a new empty database; either this or the conversion
# script from the old format needs to be run, but not both.
/** */
$wgCommandLineMode = true;
require_once( "../LocalSettings.php" );

View file

@ -1,5 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
# Abort if called from a web server
if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
print "This script must be run from the command line\n";

View file

@ -1,5 +1,10 @@
<?php
/**
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
function compressOldPages( $start = 0 ) {
$fname = 'compressOldPages';

View file

@ -1,7 +1,12 @@
<?php
/**
* Compress the old table, old_flags=gzip
*
* @package MediaWiki
* @subpackage Maintenance
*/
# Compress the old table, old_flags=gzip
/** */
require_once( "commandLine.inc" );
require_once( "compressOld.inc" );

View file

@ -1,5 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
function convertLinks() {
print "Converting links table to ID-ID...\n";

View file

@ -1,7 +1,13 @@
<?php
# Convert from the old links schema (string->ID) to the new schema (ID->ID)
# The wiki should be put into read-only mode while this script executes
/**
* Convert from the old links schema (string->ID) to the new schema (ID->ID)
* The wiki should be put into read-only mode while this script executes
*
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
require_once( "convertLinks.inc" );

View file

@ -1,4 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
$wgMessageCache->disableTransform();
$messages = array();

View file

@ -1,4 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
do {
@ -13,4 +20,3 @@ do {
?>

View file

@ -17,16 +17,28 @@
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
# http://www.gnu.org/copyleft/gpl.html
# Attempt to import existing log pages into the log tables.
# Not yet complete.
/**
* Attempt to import existing log pages into the log tables.
*
* Not yet complete.
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( 'GlobalFunctions.php' );
require_once( 'Database.php' );
require_once( 'Article.php' );
require_once( 'LogPage.php' );
# Log importer
/**
* Log importer
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
class LogImporter {
var $dummy = false;
@ -129,4 +141,4 @@ function wfUnescapeWikiText( $text ) {
return $text;
}
?>
?>

View file

@ -1,5 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
require_once( "importLogs.inc" );
@ -18,4 +24,4 @@ foreach( LogPage::validTypes() as $type ) {
$importer->importText( $text );
}
?>
?>

View file

@ -21,6 +21,14 @@
# 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
# http://www.gnu.org/copyleft/gpl.html
/**
* @todo document
* @deprecated
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
die( "This import script is not currently maintained.
If you need it you'll have to modify it as necessary.\n");
@ -51,6 +59,11 @@ require_once( "rebuildlinks.inc" );
require_once( "rebuildrecentchanges.inc" );
require_once( "rebuildtextindex.inc" );
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
class Phase2Importer {
var $olddb, $titleCache;
@ -309,6 +322,11 @@ class Phase2Importer {
}
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
class TitleCache {
var $hash = array();
@ -349,4 +367,4 @@ $wgTitle = Title::newFromText( "Conversion script" );
$importer = new Phase2Importer( $olddb );
$importer->importAll();
?>
?>

View file

@ -1,20 +1,23 @@
<?php
/*
Import data from a UseModWiki into a PediaWiki wiki
2003-02-09 Brion VIBBER <brion@pobox.com>
Based loosely on Magnus's code from 2001-2002
/**
* Import data from a UseModWiki into a PediaWiki wiki
* 2003-02-09 Brion VIBBER <brion@pobox.com>
* Based loosely on Magnus's code from 2001-2002
*
* Updated limited version to get something working temporarily
* 2003-10-09
* Be sure to run the link & index rebuilding scripts!
*
* Some more munging for charsets etc
* 2003-11-28
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
Updated limited version to get something working temporarily
2003-10-09
Be sure to run the link & index rebuilding scripts!
Some more munging for charsets etc
2003-11-28
*/
/* Set these correctly! */
/** Set these correctly! */
$wgImportEncoding = "CP1252"; /* We convert all to UTF-8 */
$wgRootDirectory = "/home/usemod/wiki-ia/lib-http/db/wiki";

View file

@ -1,10 +1,16 @@
<?php
/**
* This is a drop-in replacement for commandLine.inc, for use only on
* the Wikimedia wikis.
* Call your command-line script with the language name and site name,
* e.g. php convertLinks.php aa wikipedia
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# This is a drop-in replacement for commandLine.inc, for use only on
# the Wikimedia wikis.
# Call your command-line script with the language name and site name,
# e.g. php convertLinks.php aa wikipedia
/** */
if ( isset( $_SERVER ) && array_key_exists( 'REQUEST_METHOD', $_SERVER ) ) {
print "This script must be run from the command line\n";
exit();

View file

@ -1,7 +1,13 @@
<?php
/**
* memcached diagnostic tool
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# memcached diagnostic tool
/** */
require_once( "commandLine.inc" );
$mcc = new memcached( array('persistant' => true) );

View file

@ -1,4 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
$wikiuser_pass = `wikiuser_pass`;
$wikiadmin_pass = `wikiadmin_pass`;
$wikisql_pass = `wikisql_pass`;
@ -67,5 +74,3 @@ EOS;
}
print "\n";
}

View file

@ -1,12 +1,24 @@
<?php
/**
* Rebuild interwiki table using the file on meta and the language list
* Wikimedia specific!
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Rebuild interwiki table using the file on meta and the language list
# Wikimedia specific!
/** */
$oldCwd = getcwd();
$optionsWithArgs = array( "o" );
include_once( "commandLine.inc" );
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
class Site {
var $suffix, $lateral, $url;

View file

@ -1,7 +1,13 @@
<?php
/**
* Rebuild interwiki table using the file on meta and the language list
* Wikimedia specific!
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Rebuild interwiki table using the file on meta and the language list
# Wikimedia specific!
/** */
$oldCwd = getcwd();
$optionsWithArgs = array( "o" );

View file

@ -1,4 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
include_once( "InitialiseMessages.inc" );

View file

@ -1,8 +1,13 @@
<?php
/**
* Rebuild link tracking tables from scratch. This takes several
* hours, depending on the database size and server configuration.
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Rebuild link tracking tables from scratch. This takes several
# hours, depending on the database size and server configuration.
/** */
require_once( "commandLine.inc" );
#require_once( "rebuildlinks.inc" );

View file

@ -1,10 +1,18 @@
<?php
/**
* Functions for rebuilding the link tracking tables; must
* be included within a script that also includes the Setup.
* See @see rebuildlinks.php, for example.
*
* @deprecated
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
die( "rebuildLinks.inc needs to be updated for the new schema\n" );
# Functions for rebuilding the link tracking tables; must
# be included within a script that also includes the Setup.
# See rebuildlinks.php, for example.
#
# Buffer this many rows before inserting them all in one sweep. More
@ -238,13 +246,18 @@ function rebuildLinkTables()
return intval($n/$t);
}
# InsertBuffer increases performance slightly by inserting many rows
# at once. The gain is small (<5%) when running against a local, idle
# database, but may be significant in other circumstances. It also
# limits the number of inserted rows uppwards, which should avoid
# problems with huge articles and certain mysql settings that limits
# the size of queries. It's also convenient.
/**
* InsertBuffer increases performance slightly by inserting many rows
* at once. The gain is small (<5%) when running against a local, idle
* database, but may be significant in other circumstances. It also
* limits the number of inserted rows uppwards, which should avoid
* problems with huge articles and certain mysql settings that limits
* the size of queries. It's also convenient.
*
* @deprecated
* @package MediaWiki
* @subpackage Maintenance
*/
class InsertBuffer {
/* private */ var $mBuf, $mSql, $mBufcount, $mMaxsize;
@ -276,10 +289,15 @@ class InsertBuffer {
}
# Select parts from a large table by using the "BETWEEN X AND Y"
# operator on the id column. Avoids buffering the whole thing in
# RAM. It's also convenient.
/**
* Select parts from a large table by using the "BETWEEN X AND Y"
* operator on the id column. Avoids buffering the whole thing in
* RAM. It's also convenient.
*
* @deprecated
* @package MediaWiki
* @subpackage Maintenance
*/
class SelectPulser {
/* private */ var $mSql, $mSetsize, $mPos, $mMax, $mSet;
@ -316,8 +334,13 @@ class SelectPulser {
}
}
# A simple MRU for general cacheing.
/**
* A simple MRU for general cacheing.
* @deprecated
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
class MRUCache {
/* private */ var $mMru, $mCache, $mSize, $mPurgefreq, $nexti;
/* private */ var $hits, $misses;

View file

@ -1,8 +1,13 @@
<?php
# Rebuild link tracking tables from scratch. This takes several
# hours, depending on the database size and server configuration.
/**
* Rebuild link tracking tables from scratch. This takes several
* hours, depending on the database size and server configuration.
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
require_once( "./rebuildlinks.inc" );

View file

@ -1,8 +1,13 @@
<?php
/**
* Rebuild recent changes table.
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Rebuild recent changes table.
#
/** */
function rebuildRecentChangesTablePass1()
{
$fname = 'rebuildRecentChangesTablePass1';

View file

@ -1,8 +1,14 @@
<?php
/**
* Rebuild link tracking tables from scratch. This takes several
* hours, depending on the database size and server configuration.
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Rebuild link tracking tables from scratch. This takes several
# hours, depending on the database size and server configuration.
/** */
require_once( "commandLine.inc" );
require_once( "./rebuildrecentchanges.inc" );
$wgTitle = Title::newFromText( "Rebuild recent changes script" );

View file

@ -1,11 +1,17 @@
<?php
/**
* Rebuild the fulltext search indexes. This may take a while
* depending on the database size and server configuration.
*
* Rebuilding is faster if you drop the index and recreate it,
* but that will prevent searches from working while it runs.
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
# Rebuild the fulltext search indexes. This may take a while
# depending on the database size and server configuration.
# Rebuilding is faster if you drop the index and recreate it,
# but that will prevent searches from working while it runs.
/** */
define( "RTI_CHUNK_SIZE", 500 );
function dropTextIndex( &$database )

View file

@ -1,7 +1,14 @@
<?php
# Rebuild search index table from scratch. This takes several
# hours, depending on the database size and server configuration.
/**
* Rebuild search index table from scratch. This takes several
* hours, depending on the database size and server configuration.
*
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
require_once( "rebuildtextindex.inc" );
$wgTitle = Title::newFromText( "Rebuild text index script" );

View file

@ -1,5 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
define( "REPORTING_INTERVAL", 50 );
define( "PAUSE_INTERVAL", 50 );

View file

@ -1,5 +1,11 @@
<?php
/**
* @todo document
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
require_once( "refreshLinks.inc" );

View file

@ -1,6 +1,11 @@
<?php
/**
* Remove spurious brokenlinks
* @package MediaWiki
* @subpackage Maintenance
*/
# Remove spurious brokenlinks
/** */
require_once( "commandLine.inc" );
require_once( "./rebuildrecentchanges.inc" );
$wgTitle = Title::newFromText( "Rebuild brokenlinks script" );

View file

@ -1,5 +1,10 @@
<?php
/**
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
require_once( "commandLine.inc" );
# print "DB name: $wgDBname\n";
# print "DB user: $wgDBuser\n";

View file

@ -1,7 +1,11 @@
<?php
/**
* This script was used to convert the live Wikimedia wikis from 1.2 to 1.3
* @package MediaWiki
* @subpackage Maintenance
*/
# This script was used to convert the live Wikimedia wikis from 1.2 to 1.3
/** */
$maintenance = "/home/wikipedia/common/php-new/maintenance";
require_once( "$maintenance/liveCmdLine.inc" );
require_once( "$maintenance/InitialiseMessages.inc" );

View file

@ -1,5 +1,10 @@
<?php
/**
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
function updateSearchIndex( $start, $end, $maxLockTime, $quiet ) {
global $wgQuiet;
global $wgDisableSearchUpdate;

View file

@ -1,14 +1,19 @@
<?php
/**
* Script for periodic off-peak updating of the search index
*
* Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
* Where START is the starting timestamp
* END is the ending timestamp
* POSFILE is a file to load timestamps from and save them to, searchUpdate.pos by default
* LOCKTIME is how long the searchindex and cur tables will be locked for
* -q means quiet
*
* @package MediaWiki
* @subpackage Maintenance
*/
# Script for periodic off-peak updating of the search index
# Usage: php updateSearchIndex.php [-s START] [-e END] [-p POSFILE] [-l LOCKTIME] [-q]
# Where START is the starting timestamp
# END is the ending timestamp
# POSFILE is a file to load timestamps from and save them to, searchUpdate.pos by default
# LOCKTIME is how long the searchindex and cur tables will be locked for
# -q means quiet
/** */
$optionsWithArgs = array( 's', 'e', 'p' );
require_once( 'commandLine.inc' );

View file

@ -1,5 +1,10 @@
<?php
/**
* @package MediaWiki
* @subpackage Maintenance
*/
/** */
function do_revision_updates() {
global $wgSoftwareRevision;
if ( $wgSoftwareRevision < 1001 ) {