Extension:Replace Text

Cette extension est fournie avec MediaWiki 1.31 et supérieur. Ainsi vous n'avez pas besoin de la télécharger à nouveau. Néanmoins, vous devez encore suivre les autres instructions fournies.

Manuel des extensions MediaWiki

ReplaceText État de la version : stable
Implémentation	Page spéciale
Description	Fournit un formulaire permettant aux administrateurs de remplacer les chaînes sur l'ensemble du wiki, à la fois dans le contenu et le titre des pages
Auteur(s)	Yaron Koren <yaron57gmail.com> et Niklas Laxström
Dernière version	1.8
Politique de compatibilité	Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki	1.31+
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (Phabricator · GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code
Paramètres $wgReplaceTextResultsLimit
Droits ajoutés replacetext
Accroches utilisées AdminLinks SpecialMovepageAfterMove UserGetReservedNames
Utilisé par les wikis publics	1,812 (Ranked 200th)
Traduire l’extension Replace Text sur translatewiki.net si elle y est disponible
Problèmes	Tâches ouvertes · Signaler un bogue

Replace Text est une extension de MediaWiki qui fournit une page spéciale, ainsi qu'un script de ligne de commande, pour permettre aux administrateurs de faire une chaîne globale find-and-replace du côté serveur, sur le texte et les titres des pages de contenu du wiki.

L'opération de remplacement de texte est une opération différée et validée dans la file d'attente des travaux. Vous pouvez exécuter runJobs.php à partir du dossier maintenance pour effectuer le remplacement immédiatement et traiter la file d'attente des travaux.

Installation

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé ReplaceText dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ReplaceText
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'ReplaceText' );
  

• Par défaut, seuls les membres du groupe d'utilisateurs "sysop" ont accès à la fonctionnalité Remplacer le texte. Vous pouvez ajouter ou modifier l'ensemble d'utilisateurs autorisés en modifiant le tableau $wgGroupPermissions dans LocalSettings.php. Pour ajouter la permission aux utilisateurs de "bureaucrat" ou "bot" ajoutez par exemple ceci :

$wgGroupPermissions['bureaucrat']['replacetext'] = true;

•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Utilisation

Replace Text définit une page spéciale, à "Special:ReplaceText" (ou son équivalent dans une autre langue), qui gère la recherche globale et le remplacement; il définit également un script, replaceAll.php, qui fait la même chose à partir de la ligne de commande. Cette documentation couvrira d'abord la page spéciale, puis le script de ligne de commande.

La page Special:ReplaceText affiche initialement un formulaire pour qu'un administrateur remplisse les détails de la recherche et du remplacement : l'administrateur entre une chaîne de recherche et son remplacement, l'ensemble d'espaces de noms sur lequel effectuer la recherche, et choisit de remplacer le texte dans le contenu de la page, les titres de la page ou les deux. En option, l'administrateur peut également ajouter deux filtres supplémentaires : nom d'une catégorie à laquelle toutes les pages doivent appartenir et préfixe par lequel tous les noms de pages doivent commencer. Lorsque ce formulaire est soumis, une liste de toutes les pages contenant cette chaîne de recherche ou de toutes les pages dont les titres contiennent la chaîne de recherche, ou les deux, s'affiche. À côté de chaque nom de page figure une case à cocher pour chaque page, afin qu'ils puissent désélectionner les pages qu'ils ne souhaitent pas remplacer. L'utilisateur peut alors appuyer sur "Remplacer" pour effectuer le remplacement réel. Une fois qu'un remplacement de texte est fait, il n'est pas directement impossible ; bien que vous puissiez toujours exécuter un remplacement "inverse", en remplaçant la nouvelle chaîne par la chaîne d'origine. Pour cette raison, si la chaîne de remplacement est vide ou s'il s'agit d'une chaîne qui existe déjà dans le wiki, l'utilisateur reçoit un message d'avertissement.

Si la chaîne de recherche est contenue plusieurs fois sur une page, toutes ces instances sont remplacées. Les remplacements de chaque page s'affichent sous la forme d'une modification wiki (mineure), avec l'administrateur qui a effectué le remplacement de texte comme l'utilisateur qui a effectué l'édition et un résumé d'édition qui ressemble à « Remplacement de texte : chaîne à remplacer en nouvelle chaîne».

Le titre d'une page ne peut pas être déplacé vers un titre qui existe déjà dans le wiki, ou vers un titre à plusieurs lignes. Les pages qui ne peuvent pas être déplacées seront simplement listées sur la page de sélection comme étant non déplaçables, sans case à cocher près d'elle

La recherche est sensible à la casse. Voir ci-dessous pour savoir comment le rendre insensible à la casse.

Considérations

1. ReplaceText ne traite que 250 pages à la fois par défaut. Pour changer cela, vous pouvez affecter $wgReplaceTextResultsLimit à une valeur plus grande dans votre fichier LocalSettings.php. Cependant, vous pouvez être limité par le max_input_vars de PHP ; si l'extension signale un tel avertissement, vous devrez peut-être le changer.
2. Tous les remplacements sont placés dans la file d'attente des travaux. Ainsi, si vous devez traiter un grand nombre de pages, vous devrez exécuter Replace Text puis "runJobs.php" (potentiellement plusieurs fois).

Utiliser les expressions régulières

Si vous utilisez une base de données MySQL ou PostgreSQL, vous verrez une case à cocher "Utiliser des expressions régulières" dans le formulaire Special:ReplaceText. Cette case à cocher n'apparaît pas pour les bases de données SQLite, car SQLite n'a pas d'opérateur natif « REGEXP ».

Si vous cliquez sur cette case, vous pouvez utiliser lesexpressions régulières, ou regexps, dans les chaînes de recherche et de remplacement. The set of regular expressions allowed is basically a small subset of the PHP and MySQL/PostgreSQL regular-expression set. The special characters that one can use in the search string are "( ) . * + ? [ ] |", and within the replacement string one can use values like $1, $2 etc. (To use these as regular characters, you just need to escape them by adding a "\" beforehand - which you would also need to do with the "/" character.) This section will not give a tutorial on using regular expressions (the Wikipedia article is a good place to start for that, as is this page on MySQL regexps), but here is the basic example listed in the inline explanation:

Search string - a(.*)c

Replacement string - ac$1

This would look for pages containing the letter 'a', the letter 'c', and any text in between (signified by the ".*"). It would then put that middle text after the 'a' and 'c' - the "$1" in the replacement string refers to the first element of the search string contained within parentheses (in this case, there's only one).

For every page for which the replace is actually called, the replacement would happen for every occurrence of the search string, not just one - just as happens with regular, non-regular-expression search.

More complex regexps

Search string - hello([0-9]*)\.([0-9]*)

Replacement string - $1,$2

This would replace "hello222.555" with "222,555" and "hello2.55" with "2,55"

First the word "hello" is matched. In brackets follows an expression to search for any digits "0-9". The following asterisk finds multiple matches of the preceding element. The brackets and the asterisk get enclosed with parantheses, so we match the complete term and transfer it to $1. The "\." indicates that it's a true dot, and not a special character. The second expression within parentheses is matched and put into $2.

Replacements followed by numbers

The following will not work:

Search string - 123(.*)456

Replacement string - $1123456

That's because the search will think the number of the replacement is 1123456, not 1. Instead, you should have the following:

Replacement string - {$1}123456

In general, you can always enclose numbered values in curly brackets.

Case-insensitive search

To make your search case-insensitive, use regular expression and the case-insensitive modifier, (?i):

Search string - (?i)iphone

Replacement string - iPhone

The above will unify the casing of all mentions of iPhone/iphone/IPHONE to iPhone.

Encapsulating timestamps

If you have text that contains timestamps (such as from a video transcript) in the form hh:mm:ss where the hh and mm are not zero-padded and hh: may not even be present - such as:

0:03
Blah blah blah
11:21
Blah blah blah
2:31:54
Blah blah blah

and you would like to encapsulate the timestamps in, say, span tags. You could do something like:

• Original text: ((([01]?\d|2[0-3]):)?[0-5]?\d:[0-5]\d)
• Replacement Text: <span class="timespan">$0</span>

This would result in:

<span class="timespan">0:03</span>
Blah blah blah
<span class="timespan">11:21</span>
Blah blah blah
<span class="timespan">2:31:54</span>
Blah blah blah

(special thanks to: https://matrix.to/#/@alex.mashin:matrix.org)

Command-line script: replaceAll.php

Replace Text offers a script, replaceAll.php, in the extensions/ReplaceText/maintenance directory, which can be run from the command line, and which does all the same replacements that the page Special:ReplaceText does. The first two arguments for this script should be the search text and the replacement text; you can call this script simply like the following:

php replaceAll.php "Leningrad" "St. Petersburg"

If you use numbered values like $1 in the replacement string, you have to either escape them inside double quotes like "ac\$1" or use single quotes. Otherwise the shell will put blanks in their place as it thinks they are variables.

Other possible arguments/flags for this script are:

	Description	Default
--dry-run	only find the search texts, without doing any actual replacements
--regex	regular expressions should be used	false
--user	the user to attribute the replacements to	the user with ID 1
--yes	skip all prompts with an assumed "yes"
--summary	set a custom edit summary for the replacement edits
--rename	rename page titles instead of replacing contents
--bot-edit	mark all replacements as bot edits
--ns	set a comma-separated list of the namespaces to search
--nsall	search on all the namespaces; overrides any value set for "--ns"
--replacements	the name of a file holding a tab-separated list of replacements to make
--debug	display the replacements being made
--category	search only pages within this category
--prefix	search only pages whose names start with this string

Additionally, there are two flags that strictly print out helpful information unrelated to a specific text replacement:

	Description	Default
--show-file-format	show a description of the file format to use with --replacements
--listns	show a list of all namespaces on this wiki

(You can also see all of these options by calling "php replaceAll.php --help".)

Assigner des remplacements à un utilisateur

Par défaut tous les remplacements sont crédités dans la page historique, à l'utilisateur qui les a initiés. Néanmoins, il est possible que les remplacements soient crédités à un utilisateur prédéfini -- tel que le compte d'un robot -- en ajoutant un line telle que celle-ci dans LocalSettings.php, sous l'inclusion de Replace Text :

$wgReplaceTextUser = "MyReplaceTextBot";

Le nom spécifié d'utilisateur doit être celui d'un compte déjà existant sur le wiki. Il sera ajouté au tableau des noms d'utilisateurs de MediaWiki, qui peuvent ne pas être enregistrés, ni connectés à partir de lui.

Auteurs

Replace Text was mostly written by Yaron Koren, reachable at yaron57gmail.com. Important contributions were also made by Niklas Laxström, Ankit Garg (who contributed much of the regular expression code), Mark Hershberger (who wrote the command-line script), Brent Laabs, Cindy Cicalese, Nikhil Kumar, Umherirrender, James Forrester, Fomafix, Marijn van Wezel, Sahaj Khandelwal and others.

Historique des versions

Replace Text is currently at version 1.8. See the entire version history .

Captures d’écran

Vous trouverez ci-dessous les images du flux de travail de Replace Text. First, the initial page in which "George F. Will" and "George Will" are entered for the target string and replacement string, respectively, and replacing text in page titles is specified as well, on Discourse DB:

Note: the check "All" and "None" boxes only show up when using the Vector skin, or skins based off of it.

And here is what the page looks like after the user hits "Continue":

Hitting "Replace" would replace this value in all of the listed pages, as well as moving the page at the end to its new value.

Problèmes connus

• The replacement actions themselves are structured as MediaWiki "jobs", to ensure that the system is not overloaded if the user wants to do many at the same time. This means that a large set of replacements will not be done immediately, and may take minutes, hours or even longer to complete. Normally, jobs get activated every time a page is viewed on the wiki; to speed up the process (or slow it down), you can change the number of jobs run when a page is viewed; the default is 1. Thus a Replace Text request can stall soon after it starts if there is not enough front-end activity on the wiki to outrun the other sources of new batch jobs. For information on how to change the default, see the $wgJobRunRate page. To force the wiki to run all jobs immediately, go to the shell and execute the script runJobs.php ; there generally isn't a way to do this from the wiki's front end.
• For getting the jobs to run on a seldom-used wiki, for instance a working wiki for a small hobby project team, you can for instance force a refresh of the "All pages" special page. This can be done for instance by using the following shell script on Unix:

#!/bin/bash
# $0 is the script name, $1 id the first ARG, $2 is second...
ITERATIONS=$1
WAIT=$2

n=1
while [ $n -le $ITERATIONS ]
do
	echo "Iteration $n/$ITERATIONS"
	# Getting a special page that must be regenerated forces the wiki's queued jobs to be run, the resulting download is discarded
	wget -nv --output-document=/dev/null http://yourwiki.tld/index.php/Special:AllPages
	echo "  wget OK"
	sleep $WAIT
	echo "  wait OK"
	n=$(( n+1 ))
done

• If you are still having a problem with getting Replace Text's jobs to run, adding the following to LocalSettings.php may fix the problem:

$wgRunJobsAsync = false;

• In order for redirects not to be created on page moves (i.e. if the "Save the old titles as redirects to the new titles" checkbox is unchecked), you will have to give the relevant user the 'suppressredirect' permission. Assuming you've given the replacetext permission to a trusted-editor user group, you would need to add the following to LocalSettings.php:

$wgGroupPermissions['trusted-editor']['suppressredirect'] = true;

• If your revisions are compressed (that is, if $wgCompressRevisions is enabled in LocalSettings.php or the script compressOld.php has been executed with the option -t gzip) then ReplaceText will not work, because it makes use of SQL queries that can't search compressed text. (see the MassEditRegex extension as an alternative in this case.)
• If you have a large number of replacements, some of them may not get done; or you may see an error message that reads "You must select at least one namespace". In both cases, that's due to a limit on the number of form inputs that PHP accepts. This can be fixed in a number of ways:
  • If you have the Suhosin PHP extension installed on your server, that may be source of the problem. You can increase the value of the variables suhosin.post.max_vars and suhosin.request.max_vars; or simply try temporarily disabling Suhosin while you do the replacements.
  • The PHP setting max_input_vars (available since PHP 5.3.9) also affects the number of replacements you can do at any time - you can try setting this to a very large number, like 3000.

Traductions

Translation of Replace Text is done through translatewiki.net. The translation for this extension is on translatewiki. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

Voir aussi

• Extension:MassEditRegex - A similar extension using regular expressions to edit multiple pages at once