Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F6101130
replaceAll.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
13 KB
Referenced Files
None
Subscribers
None
replaceAll.php
View Options
<?php
/**
* Replace text in pages or page titles.
*
* Copyright © 2014 NicheWork, LLC
*
* 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, MA 02110-1301, USA.
* https://www.gnu.org/copyleft/gpl.html
*
* @file
* @category Maintenance
* @package ReplaceText
* @author Mark A. Hershberger <mah@nichework.com>
* @license GPL-2.0-or-later
* @link https://www.mediawiki.org/wiki/Extension:Replace_Text
*
*/
namespace
MediaWiki\Extension\ReplaceText
;
use
MediaWiki\Maintenance\Maintenance
;
use
MediaWiki\User\User
;
use
MWException
;
$IP
=
getenv
(
'MW_INSTALL_PATH'
)
?:
__DIR__
.
'/../../..'
;
if
(
!
is_readable
(
"$IP/maintenance/Maintenance.php"
)
)
{
die
(
"MW_INSTALL_PATH needs to be set to your MediaWiki installation.
\n
"
);
}
require_once
"$IP/maintenance/Maintenance.php"
;
/**
* Maintenance script that replaces text in pages
*
* @ingroup Maintenance
* @SuppressWarnings(StaticAccess)
* @SuppressWarnings(LongVariable)
*/
class
ReplaceAll
extends
Maintenance
{
/** @var User */
private
$user
;
/** @var string[] */
private
$target
;
/** @var string[] */
private
$replacement
;
/** @var int[] */
private
$namespaces
;
/** @var string */
private
$category
;
/** @var string */
private
$prefix
;
/** @var int */
private
$pageLimit
;
/** @var bool[] */
private
$useRegex
;
/** @var bool */
private
$defaultContinue
;
/** @var bool */
private
$botEdit
;
/** @var bool */
private
$rename
;
public
function
__construct
()
{
parent
::
__construct
();
$this
->
addDescription
(
'CLI utility to replace text wherever it is '
.
'found in the wiki.'
);
$this
->
addArg
(
'target'
,
'Target text to find.'
,
false
);
$this
->
addArg
(
'replace'
,
'Text to replace.'
,
false
);
$this
->
addOption
(
'dry-run'
,
'Only find the texts, don
\'
t replace.'
,
false
,
false
,
'n'
);
$this
->
addOption
(
'regex'
,
'This is a regex (false).'
,
false
,
false
,
'r'
);
$this
->
addOption
(
'user'
,
'The user to attribute this to (uid 1).'
,
false
,
true
,
'u'
);
$this
->
addOption
(
'yes'
,
'Skip all prompts with an assumed
\'
yes
\'
.'
,
false
,
false
,
'y'
);
$this
->
addOption
(
'summary'
,
'Alternate edit summary. (%r is where to '
.
' place the replacement text, %f the text to look for.)'
,
false
,
true
,
's'
);
$this
->
addOption
(
'nsall'
,
'Search all canonical namespaces (false). '
.
'If true, this option overrides the ns option.'
,
false
,
false
,
'a'
);
$this
->
addOption
(
'ns'
,
'Comma separated namespaces to search in '
.
'(Main) .'
,
false
,
true
);
$this
->
addOption
(
'category'
,
'Search only pages within this category.'
,
false
,
true
,
'c'
);
$this
->
addOption
(
'prefix'
,
'Search only pages whose names start with this string.'
,
false
,
true
,
'p'
);
$this
->
addOption
(
'pageLimit'
,
'Maximum number of pages to return from the search.'
,
false
,
true
,
'p'
);
$this
->
addOption
(
'replacements'
,
'File containing the list of '
.
'replacements to be made. Fields in the file are tab-separated. '
.
'See --show-file-format for more information.'
,
false
,
true
,
'f'
);
$this
->
addOption
(
'show-file-format'
,
'Show a description of the '
.
'file format to use with --replacements.'
,
false
,
false
);
$this
->
addOption
(
'bot-edit'
,
'Mark changes as bot edits.'
,
false
,
false
,
'b'
);
$this
->
addOption
(
'debug'
,
'Display replacements being made.'
,
false
,
false
);
$this
->
addOption
(
'listns'
,
'List out the namespaces on this wiki.'
,
false
,
false
);
$this
->
addOption
(
'rename'
,
'Rename page titles instead of replacing contents.'
,
false
,
false
);
$this
->
requireExtension
(
'Replace Text'
);
}
private
function
getUser
()
{
$userReplacing
=
$this
->
getOption
(
'user'
,
1
);
$userFactory
=
$this
->
getServiceContainer
()->
getUserFactory
();
$user
=
is_numeric
(
$userReplacing
)
?
$userFactory
->
newFromId
(
$userReplacing
)
:
$userFactory
->
newFromName
(
$userReplacing
);
if
(
!
$user
instanceof
User
)
{
$this
->
fatalError
(
"Couldn't translate '$userReplacing' to a user."
);
}
return
$user
;
}
private
function
getTarget
()
{
$ret
=
$this
->
getArg
(
0
);
if
(
$ret
===
null
)
{
$this
->
fatalError
(
'You have to specify a target.'
);
}
return
[
$ret
];
}
private
function
getReplacement
()
{
$ret
=
$this
->
getArg
(
1
);
if
(
$ret
===
null
)
{
$this
->
fatalError
(
'You have to specify replacement text.'
);
}
return
[
$ret
];
}
private
function
getReplacements
()
{
$file
=
$this
->
getOption
(
'replacements'
);
if
(
!
$file
)
{
return
false
;
}
if
(
!
is_readable
(
$file
)
)
{
throw
new
MWException
(
'File does not exist or is not readable: '
.
"$file
\n
"
);
}
$handle
=
fopen
(
$file
,
'r'
);
if
(
$handle
===
false
)
{
throw
new
MWException
(
"Trouble opening file: $file
\n
"
);
}
$this
->
defaultContinue
=
true
;
// phpcs:ignore Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
while
(
(
$line
=
fgets
(
$handle
)
)
!==
false
)
{
$field
=
explode
(
"
\t
"
,
substr
(
$line
,
0
,
-
1
)
);
if
(
!
isset
(
$field
[
1
]
)
)
{
continue
;
}
$this
->
target
[]
=
$field
[
0
];
$this
->
replacement
[]
=
$field
[
1
];
$this
->
useRegex
[]
=
isset
(
$field
[
2
]
);
}
return
true
;
}
private
function
shouldContinueByDefault
()
{
if
(
!
is_bool
(
$this
->
defaultContinue
)
)
{
$this
->
defaultContinue
=
$this
->
getOption
(
'yes'
)
?
true
:
false
;
}
return
$this
->
defaultContinue
;
}
private
function
getSummary
(
$target
,
$replacement
)
{
$msg
=
wfMessage
(
'replacetext_editsummary'
,
$target
,
$replacement
)->
plain
();
if
(
$this
->
getOption
(
'summary'
)
!==
null
)
{
$msg
=
str_replace
(
[
'%f'
,
'%r'
],
[
$target
,
$replacement
],
$this
->
getOption
(
'summary'
)
);
}
return
$msg
;
}
private
function
listNamespaces
()
{
$this
->
output
(
"Index
\t
Namespace
\n
"
);
$nsList
=
$this
->
getServiceContainer
()->
getNamespaceInfo
()->
getCanonicalNamespaces
();
ksort
(
$nsList
);
foreach
(
$nsList
as
$int
=>
$val
)
{
if
(
$val
==
''
)
{
$val
=
'(main)'
;
}
$this
->
output
(
" $int
\t
$val
\n
"
);
}
}
private
function
showFileFormat
()
{
$text
=
<<<EOF
The format of the replacements file is tab separated with three fields.
Any line that does not have a tab is ignored and can be considered a comment.
Fields are:
1. String to search for.
2. String to replace found text with.
3. (optional) The presence of this field indicates that the previous two
are considered a regular expression.
Example:
This is a comment
TARGET REPLACE
regex(p*) Count the Ps; \\1 true
EOF;
$this
->
output
(
$text
);
}
private
function
getNamespaces
()
{
$nsall
=
$this
->
getOption
(
'nsall'
);
$ns
=
$this
->
getOption
(
'ns'
);
if
(
!
$nsall
&&
!
$ns
)
{
$namespaces
=
[
NS_MAIN
];
}
else
{
$canonical
=
$this
->
getServiceContainer
()->
getNamespaceInfo
()->
getCanonicalNamespaces
();
$canonical
[
NS_MAIN
]
=
'_'
;
$namespaces
=
array_flip
(
$canonical
);
if
(
!
$nsall
)
{
$namespaces
=
array_map
(
static
function
(
$n
)
use
(
$canonical
,
$namespaces
)
{
if
(
is_numeric
(
$n
)
)
{
if
(
isset
(
$canonical
[
$n
]
)
)
{
return
intval
(
$n
);
}
}
else
{
if
(
isset
(
$namespaces
[
$n
]
)
)
{
return
$namespaces
[
$n
];
}
}
return
null
;
},
explode
(
','
,
$ns
)
);
$namespaces
=
array_filter
(
$namespaces
,
static
function
(
$val
)
{
return
$val
!==
null
;
}
);
}
}
return
$namespaces
;
}
private
function
getCategory
()
{
return
$this
->
getOption
(
'category'
);
}
private
function
getPrefix
()
{
return
$this
->
getOption
(
'prefix'
);
}
private
function
getPageLimit
()
{
return
$this
->
getOption
(
'pageLimit'
);
}
private
function
useRegex
()
{
return
[
$this
->
getOption
(
'regex'
)
];
}
private
function
getRename
()
{
return
$this
->
hasOption
(
'rename'
);
}
private
function
listTitles
(
$titles
,
$target
,
$replacement
,
$regex
,
$rename
)
{
$skippedTitles
=
[];
foreach
(
$titles
as
$prefixedText
=>
$title
)
{
if
(
$title
===
null
)
{
$skippedTitles
[]
=
$prefixedText
;
continue
;
}
if
(
$rename
)
{
$newTitle
=
Search
::
getReplacedTitle
(
$title
,
$target
,
$replacement
,
$regex
);
// Implicit conversion of objects to strings
$this
->
output
(
"$title
\t
->
\t
$newTitle
\n
"
);
}
else
{
$this
->
output
(
"$title
\n
"
);
}
}
if
(
$skippedTitles
)
{
$this
->
output
(
"
\n
Extension hook filtered out the following titles from being moved:
\n
"
);
foreach
(
$skippedTitles
as
$prefixedTitle
)
{
$this
->
output
(
"$prefixedTitle
\n
"
);
}
}
}
private
function
replaceTitles
(
$titles
,
$target
,
$replacement
,
$useRegex
,
$rename
)
{
foreach
(
$titles
as
$title
)
{
$params
=
[
'target_str'
=>
$target
,
'replacement_str'
=>
$replacement
,
'use_regex'
=>
$useRegex
,
'user_id'
=>
$this
->
user
->
getId
(),
'edit_summary'
=>
$this
->
getSummary
(
$target
,
$replacement
),
'botEdit'
=>
$this
->
botEdit
];
if
(
$rename
)
{
$params
[
'move_page'
]
=
true
;
$params
[
'create_redirect'
]
=
false
;
$params
[
'watch_page'
]
=
false
;
}
$this
->
output
(
"Replacing on $title... "
);
$services
=
$this
->
getServiceContainer
();
$job
=
new
Job
(
$title
,
$params
,
$services
->
getMovePageFactory
(),
$services
->
getPermissionManager
(),
$services
->
getUserFactory
(),
$services
->
getWatchlistManager
(),
$services
->
getWikiPageFactory
()
);
if
(
$job
->
run
()
!==
true
)
{
$this
->
error
(
"Trouble on the page '$title'."
);
}
$this
->
output
(
"done.
\n
"
);
}
}
private
function
getReply
(
$question
)
{
$reply
=
''
;
if
(
$this
->
shouldContinueByDefault
()
)
{
return
true
;
}
while
(
$reply
!==
'y'
&&
$reply
!==
'n'
)
{
$reply
=
$this
->
readconsole
(
"$question (Y/N) "
);
$reply
=
substr
(
strtolower
(
$reply
),
0
,
1
);
}
return
$reply
===
'y'
;
}
private
function
localSetup
()
{
if
(
$this
->
getOption
(
'listns'
)
)
{
$this
->
listNamespaces
();
return
false
;
}
if
(
$this
->
getOption
(
'show-file-format'
)
)
{
$this
->
showFileFormat
();
return
false
;
}
$this
->
user
=
$this
->
getUser
();
if
(
!
$this
->
getReplacements
()
)
{
$this
->
target
=
$this
->
getTarget
();
$this
->
replacement
=
$this
->
getReplacement
();
$this
->
useRegex
=
$this
->
useRegex
();
}
$this
->
namespaces
=
$this
->
getNamespaces
();
$this
->
category
=
$this
->
getCategory
();
$this
->
prefix
=
$this
->
getPrefix
();
$this
->
pageLimit
=
$this
->
getPageLimit
();
$this
->
rename
=
$this
->
getRename
();
return
true
;
}
/**
* @inheritDoc
*/
public
function
execute
()
{
$this
->
botEdit
=
false
;
if
(
!
$this
->
localSetup
()
)
{
return
;
}
if
(
$this
->
namespaces
===
[]
)
{
$this
->
fatalError
(
'No matching namespaces.'
);
}
$services
=
$this
->
getServiceContainer
();
$hookHelper
=
new
HookHelper
(
$services
->
getHookContainer
()
);
$search
=
new
Search
(
$services
->
getMainConfig
(),
$services
->
getDBLoadBalancerFactory
()
);
foreach
(
$this
->
target
as
$index
=>
$target
)
{
$replacement
=
$this
->
replacement
[
$index
];
$useRegex
=
$this
->
useRegex
[
$index
];
if
(
$this
->
getOption
(
'debug'
)
)
{
$this
->
output
(
"Replacing '$target' with '$replacement'"
);
if
(
$useRegex
)
{
$this
->
output
(
' as regular expression'
);
}
$this
->
output
(
".
\n
"
);
}
if
(
$this
->
rename
)
{
$res
=
$search
->
getMatchingTitles
(
$target
,
$this
->
namespaces
,
$this
->
category
,
$this
->
prefix
,
$this
->
pageLimit
,
$useRegex
);
$titlesToProcess
=
$hookHelper
->
filterPageTitlesForRename
(
$res
);
}
else
{
$res
=
$search
->
doSearchQuery
(
$target
,
$this
->
namespaces
,
$this
->
category
,
$this
->
prefix
,
$this
->
pageLimit
,
$useRegex
);
$titlesToProcess
=
$hookHelper
->
filterPageTitlesForEdit
(
$res
);
}
if
(
count
(
$titlesToProcess
)
===
0
)
{
$this
->
fatalError
(
'No targets found to replace.'
);
}
if
(
$this
->
getOption
(
'dry-run'
)
)
{
$this
->
listTitles
(
$titlesToProcess
,
$target
,
$replacement
,
$useRegex
,
$this
->
rename
);
continue
;
}
if
(
!
$this
->
shouldContinueByDefault
()
)
{
$this
->
listTitles
(
$titlesToProcess
,
$target
,
$replacement
,
$useRegex
,
$this
->
rename
);
if
(
!
$this
->
getReply
(
'Replace instances on these pages?'
)
)
{
return
;
}
}
$comment
=
''
;
if
(
$this
->
getOption
(
'user'
,
null
)
===
null
)
{
$comment
=
' (Use --user to override)'
;
}
if
(
$this
->
getOption
(
'bot-edit'
,
false
)
)
{
$this
->
botEdit
=
true
;
}
if
(
!
$this
->
getReply
(
"Attribute changes to the user '{$this->user->getName()}'?$comment"
)
)
{
return
;
}
$this
->
replaceTitles
(
$titlesToProcess
,
$target
,
$replacement
,
$useRegex
,
$this
->
rename
);
}
}
}
$maintClass
=
ReplaceAll
::
class
;
require_once
RUN_MAINTENANCE_IF_MAIN
;
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Oct 6 2026, 08:47 (6 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
68/eb/123141031e569d17675d79cba0c7
Default Alt Text
replaceAll.php (13 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment