#!/usr/bin/python
# -*- coding: utf-8 -*-
"""
This script can move pages.
These command line parameters can be used to specify which pages to work on:
¶ms;
Furthermore, the following command line parameters are supported:
-from and -to The page to move from and the page to move to.
-noredirect Leave no redirect behind.
-notalkpage Do not move this page's talk page (if it exists)
-prefix Move pages by adding a namespace prefix to the names of the
pages. (Will remove the old namespace prefix if any)
Argument can also be given as "-prefix:namespace:".
-always Don't prompt to make changes, just do them.
-skipredirects Skip redirect pages (Warning: increases server load)
-summary Prompt for a custom summary, bypassing the predefined message
texts. Argument can also be given as "-summary:XYZ".
-pairsfile Read pairs of file names from a file. The file must be in a
format [[frompage]] [[topage]] [[frompage]] [[topage]] ...
Argument can also be given as "-pairsfile:filename"
"""
#
# (C) Pywikibot team, 2006-2020
#
# Distributed under the terms of the MIT license.
#
import re
import pywikibot
from pywikibot import i18n, pagegenerators
from pywikibot.bot import MultipleSitesBot
from pywikibot.exceptions import ArgumentDeprecationWarning
from pywikibot.tools import issue_deprecation_warning
# This is required for the text that is shown when you run this script
# with the parameter -help.
docuReplacements = {'¶ms;': pagegenerators.parameterHelp} # noqa: N816
[docs]class MovePagesBot(MultipleSitesBot):
"""Page move bot."""
[docs] def __init__(self, generator, **kwargs) -> None:
"""Initializer."""
self.availableOptions.update({
'prefix': None,
'noredirect': False,
'movetalkpage': True,
'skipredirects': False,
'summary': None,
})
super().__init__(**kwargs)
self.generator = generator
self.appendAll = False
self.regexAll = False
self.noNamespace = False
[docs] def moveOne(self, page, newPageTitle) -> None:
"""Move on page to newPageTitle."""
try:
msg = self.getOption('summary')
if not msg:
msg = i18n.twtranslate(page.site, 'movepages-moving')
pywikibot.output('Moving page {0} to [[{1}]]'
.format(page.title(as_link=True), newPageTitle))
page.move(
newPageTitle, reason=msg,
movetalk=self.getOption('movetalkpage'),
noredirect=self.getOption('noredirect'))
except pywikibot.PageRelatedError as error:
pywikibot.output(error)
[docs] def treat(self, page) -> None:
"""Treat a single page."""
self.current_page = page
if self.getOption('skipredirects') and page.isRedirectPage():
pywikibot.output('Page {0} is a redirect; skipping.'
.format(page.title()))
return
pagetitle = page.title(with_ns=False)
namesp = page.site.namespace(page.namespace())
if self.appendAll:
newPageTitle = ('{0}{1}{2}'.format(self.pagestart, pagetitle,
self.pageend))
if not self.noNamespace and namesp:
newPageTitle = ('{0}:{1}'.format(namesp, newPageTitle))
elif self.regexAll:
newPageTitle = self.regex.sub(self.replacePattern, pagetitle)
if not self.noNamespace and namesp:
newPageTitle = ('{0}:{1}'.format(namesp, newPageTitle))
if self.getOption('prefix'):
newPageTitle = ('{0}{1}'.format(self.getOption('prefix'),
pagetitle))
if self.getOption('prefix') or self.appendAll or self.regexAll:
if self.user_confirm('Change the page title to "{0}"?'
.format(newPageTitle)):
self.moveOne(page, newPageTitle)
else:
choice = pywikibot.input_choice('What do you want to do?',
[('change page name', 'c'),
('append to page name', 'a'),
('use a regular expression', 'r'),
('next page', 'n')])
if choice == 'c':
newPageTitle = pywikibot.input('New page name:')
self.moveOne(page, newPageTitle)
elif choice == 'a':
self.pagestart = pywikibot.input('Append this to the start:')
self.pageend = pywikibot.input('Append this to the end:')
newPageTitle = ('{0}{1}{2}'.format(self.pagestart, pagetitle,
self.pageend))
if namesp:
if pywikibot.input_yn('Do you want to remove the '
'namespace prefix "{0}:"?'
.format(namesp),
automatic_quit=False):
self.noNamespace = True
else:
newPageTitle = ('{0}:{1}'.format(namesp, newPageTitle))
choice2 = pywikibot.input_choice(
'Change the page title to "{0}"?'
.format(newPageTitle),
[('yes', 'y'), ('no', 'n'), ('all', 'a')])
if choice2 == 'y':
self.moveOne(page, newPageTitle)
elif choice2 == 'a':
self.appendAll = True
self.moveOne(page, newPageTitle)
elif choice == 'r':
searchPattern = pywikibot.input('Enter the search pattern:')
self.replacePattern = pywikibot.input(
'Enter the replace pattern:')
self.regex = re.compile(searchPattern)
if page.title() == page.title(with_ns=False):
newPageTitle = self.regex.sub(self.replacePattern,
page.title())
else:
if pywikibot.input_yn('Do you want to remove the '
'namespace prefix "{0}:"?'
.format(namesp),
automatic_quit=False):
newPageTitle = self.regex.sub(
self.replacePattern, page.title(with_ns=False))
self.noNamespace = True
else:
newPageTitle = self.regex.sub(self.replacePattern,
page.title())
choice2 = pywikibot.input_choice(
'Change the page title to "{0}"?'
.format(newPageTitle),
[('yes', 'y'), ('no', 'n'), ('all', 'a')])
if choice2 == 'y':
self.moveOne(page, newPageTitle)
elif choice2 == 'a':
self.regexAll = True
self.moveOne(page, newPageTitle)
[docs]def main(*args) -> None:
"""
Process command line arguments and invoke bot.
If args is an empty list, sys.argv is used.
@param args: command line arguments
@type args: str
"""
oldName = None
options = {}
fromToPairs = []
# Process global args and prepare generator args parser
local_args = pywikibot.handle_args(args)
genFactory = pagegenerators.GeneratorFactory()
for arg in local_args:
if genFactory.handleArg(arg):
continue
if arg == '-pairs' or arg.startswith('-pairs:'):
issue_deprecation_warning(
'-pairs',
'-pairsfile',
2, ArgumentDeprecationWarning, since='20160304')
elif arg.startswith('-pairsfile'):
if len(arg) == len('-pairsfile'):
filename = pywikibot.input(
'Enter the name of the file containing pairs:')
else:
filename = arg[len('-pairsfile:'):]
oldName1 = None
for page in pagegenerators.TextfilePageGenerator(filename):
if oldName1:
fromToPairs.append([oldName1, page.title()])
oldName1 = None
else:
oldName1 = page.title()
if oldName1:
pywikibot.warning(
'file {0} contains odd number of links'.format(filename))
elif arg == '-noredirect':
options['noredirect'] = True
elif arg == '-notalkpage':
options['movetalkpage'] = False
elif arg == '-always':
options['always'] = True
elif arg == '-skipredirects':
options['skipredirects'] = True
elif arg.startswith('-from:'):
if oldName:
pywikibot.warning('-from:{0} without -to:'.format(oldName))
oldName = arg[len('-from:'):]
elif arg.startswith('-to:'):
if oldName:
fromToPairs.append([oldName, arg[len('-to:'):]])
oldName = None
else:
pywikibot.warning('{0} without -from'.format(arg))
elif arg.startswith('-prefix'):
if len(arg) == len('-prefix'):
options['prefix'] = pywikibot.input('Enter the prefix:')
else:
options['prefix'] = arg[8:]
elif arg.startswith('-summary'):
if len(arg) == len('-summary'):
options['summary'] = pywikibot.input('Enter the summary:')
else:
options['summary'] = arg[9:]
if oldName:
pywikibot.warning('-from:{0} without -to:'.format(oldName))
site = pywikibot.Site()
for pair in fromToPairs:
page = pywikibot.Page(site, pair[0])
bot = MovePagesBot(None, **options)
bot.moveOne(page, pair[1])
gen = genFactory.getCombinedGenerator(preload=True)
if gen:
bot = MovePagesBot(gen, **options)
bot.run()
elif not fromToPairs:
pywikibot.bot.suggest_help(missing_generator=True)
if __name__ == '__main__':
main()