jenkins-bot has submitted this change and it was merged. Change subject: use all pagegenerators options for protect.py ...................................................................... use all pagegenerators options for protect.py - remove "nosubcat" option which was never implemented - include revision: 0b888f24b532d54ee93574632b34c162fbe77ba0 made by Merlijn van Deen: mysite was not defined. pywikibot.handleArgs is guaranteed to return a list (as opposed to a generator) after parsing all global arguments (such as -lang and -family). This means it's safe to call pywikibot.getSite immediately after handleArgs, but before handling local arguments. - pageName is extracted from command option handled by pagegenerators if availlable. Otherwise we ask for the message. - -images option is deprecated. -imageused from pagegenerators is used. We just append the right option command to the option list - docu replacement from pagegenerators Change-Id: I6e2b6b85670a28e24c50f6da9cb6b3db236f78b5 --- M scripts/protect.py 1 file changed, 76 insertions(+), 118 deletions(-) Approvals: Merlijn van Deen: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/protect.py b/scripts/protect.py index deaae24..7ed203f 100644 --- a/scripts/protect.py +++ b/scripts/protect.py @@ -3,21 +3,21 @@ This script can be used to protect and unprotect pages en masse. Of course, you will need an admin account on the relevant wiki. -Syntax: python protect.py OPTION... -Command line options: +These command line parameters can be used to specify which pages to work on: --page: Protect specified page --cat: Protect all pages in the given category. --nosubcats: Don't protect pages in the subcategories. --links: Protect all pages linked from a given page. --file: Protect all pages listed in a text file. --ref: Protect all pages referring from a given page. --images: Protect all images used on a given page. --always: Don't prompt to protect pages, just do it. --summary: Supply a custom edit summary. --unprotect: Actually unprotect pages instead of protecting +&params; + +Furthermore, the following command line parameters are supported: + +-always: Don't prompt to protect pages, just do it. + +-summary: Supply a custom edit summary. + +-unprotect: Actually unprotect pages instead of protecting + -edit:PROTECTION_LEVEL Set edit protection level to PROTECTION_LEVEL + -move:PROTECTION_LEVEL Set move protection level to PROTECTION_LEVEL ## Without support ## @@ -26,6 +26,8 @@ Values for PROTECTION_LEVEL are: sysop, autoconfirmed, none. If an operation parameter (edit, move or create) is not specified, default protection level is 'sysop' (or 'none' if -unprotect). + +Usage: python protect.py <OPTIONS> Examples: @@ -40,7 +42,7 @@ # Written by http://it.wikisource.org/wiki/Utente:Qualc1 # Created by modifying delete.py # -# (C) Pywikibot team, 2008-2013 +# (c) Pywikibot team, 2008-2014 # # Distributed under the terms of the MIT license. # @@ -51,11 +53,15 @@ from pywikibot import i18n from pywikibot import pagegenerators +# This is required for the text that is shown when you run this script +# with the parameter -help. +docuReplacements = { + '&params;': pagegenerators.parameterHelp, +} + class ProtectionRobot: - """ - This robot allows protection of pages en masse. - """ + """ This robot allows protection of pages en masse. """ def __init__(self, generator, summary, always=False, unprotect=False, edit='sysop', move='sysop', create='sysop'): @@ -75,20 +81,21 @@ self.move = move def run(self): + """ Starts the robot's action. + Loop through everything in the page generator and (un)protect it. + """ - Starts the robot's action. - """ - #Loop through everything in the page generator and (un)protect it. for page in self.generator: pywikibot.output(u'Processing page %s' % page.title()) page.protect(unprotect=self.unprotect, reason=self.summary, - prompt=self.prompt, edit=self.edit, - move=self.move) + prompt=self.prompt, edit=self.edit, move=self.move) -# Asks a valid protection level for "operation". -# Returns the protection level chosen by user. def choiceProtectionLevel(operation, default): + """ Asks a valid protection level for "operation". + Returns the protection level chosen by user. + + """ default = default[0] firstChar = map(lambda level: level[0], protectionLevels) choiceChar = pywikibot.inputChoice('Choice a protection level to %s:' @@ -100,74 +107,38 @@ return level -def main(): +def main(*args): global protectionLevels protectionLevels = ['sysop', 'autoconfirmed', 'none'] + # This factory is responsible for processing command line arguments + # that are also used by other scripts and that determine on which pages + # to work on. + genFactory = pagegenerators.GeneratorFactory() pageName = '' - summary = '' + summary = None always = False - doSinglePage = False - doCategory = False - protectSubcategories = True - doRef = False - doLinks = False - doImages = False - fileName = '' - gen = None + generator = None edit = '' move = '' defaultProtection = 'sysop' # read command line parameters - for arg in pywikibot.handleArgs(): + localargs = pywikibot.handleArgs() + mysite = pywikibot.getSite() + + for arg in pywikibot.handleArgs(*args): if arg == '-always': always = True - elif arg.startswith('-file'): - if len(arg) == len('-file'): - fileName = pywikibot.input( - u'Enter name of file to protect pages from:') - else: - fileName = arg[len('-file:'):] elif arg.startswith('-summary'): if len(arg) == len('-summary'): - summary = pywikibot.input( - u'Enter a reason for the protection:') + summary = pywikibot.input(u'Enter a reason for the protection:') else: summary = arg[len('-summary:'):] - elif arg.startswith('-cat'): - doCategory = True - if len(arg) == len('-cat'): - pageName = pywikibot.input( - u'Enter the category to protect from:') - else: - pageName = arg[len('-cat:'):] - elif arg.startswith('-nosubcats'): - protectSubcategories = False - elif arg.startswith('-links'): - doLinks = True - if len(arg) == len('-links'): - pageName = pywikibot.input(u'Enter the page to protect from:') - else: - pageName = arg[len('-links:'):] - elif arg.startswith('-ref'): - doRef = True - if len(arg) == len('-ref'): - pageName = pywikibot.input(u'Enter the page to protect from:') - else: - pageName = arg[len('-ref:'):] - elif arg.startswith('-page'): - doSinglePage = True - if len(arg) == len('-page'): - pageName = pywikibot.input(u'Enter the page to protect:') - else: - pageName = arg[len('-page:'):] elif arg.startswith('-images'): - doImages = True - if len(arg) == len('-images'): - pageName = pywikibot.input(u'Enter the page with the images to protect:') - else: - pageName = arg[len('-images:'):] + pywikibot.output('\n\03{lightred}-image option is deprecated. ' + 'Please use -imagelinks instead.\03{default}\n') + localargs.append('-imagelinks' + arg[7:]) elif arg.startswith('-unprotect'): defaultProtection = 'none' elif arg.startswith('-edit'): @@ -182,58 +153,45 @@ create = arg[len('-create:'):] if create not in protectionLevels: create = choiceProtectionLevel('create', defaultProtection) + else: + genFactory.handleArg(arg) + found = arg.find(':') + 1 + if found: + pageName = arg[found:] - mysite = pywikibot.getSite() + if not summary: + if pageName: + if arg.startswith('cat') or arg.startswith('subcats'): + summary = i18n.twtranslate(mysite, 'protect-category', + {'cat': pageName}) + elif arg.startswith('links'): + summary = i18n.twtranslate(mysite, 'protect-links', + {'page': pageName}) + elif arg.startswith('ref'): + summary = i18n.twtranslate(mysite, 'protect-ref', + {'page': pageName}) + elif arg.startswith('imageused'): + summary = i18n.twtranslate(mysite, 'protect-images', + {'page': pageName}) + elif arg.startswith('file'): + summary = i18n.twtranslate(mysite, 'protect-simple') - if doSinglePage: - if not summary: - summary = pywikibot.input(u'Enter a reason for the protection:') - page = pywikibot.Page(mysite, pageName) - gen = iter([page]) - elif doCategory: - if not summary: - summary = i18n.twtranslate(mysite, 'protect-category', - {'cat': pageName}) - ns = mysite.category_namespace() - categoryPage = pywikibot.Category(mysite, ns + ':' + pageName) - gen = pagegenerators.CategorizedPageGenerator( - categoryPage, recurse=protectSubcategories) - elif doLinks: - if not summary: - summary = i18n.twtranslate(mysite, 'protect-links', - {'page': pageName}) - linksPage = pywikibot.Page(mysite, pageName) - gen = pagegenerators.LinkedPageGenerator(linksPage) - elif doRef: - if not summary: - summary = i18n.twtranslate(mysite, 'protect-ref', - {'page': pageName}) - refPage = pywikibot.Page(mysite, pageName) - gen = pagegenerators.ReferringPageGenerator(refPage) - elif fileName: - if not summary: - summary = i18n.twtranslate(mysite, 'protect-simple') - gen = pagegenerators.TextfilePageGenerator(fileName) - elif doImages: - if not summary: - summary = i18n.twtranslate(mysite, 'protect-images', - {'page': pageName}) - gen = pagegenerators.ImagesPageGenerator(pywikibot.Page(mysite, - pageName)) - - if gen: - pywikibot.setAction(summary) - # We are just protecting pages, so we have no need of using a preloading - # page generator - # to actually get the text of those pages. + generator = genFactory.getCombinedGenerator() + # We are just protecting pages, so we have no need of using a preloading + # page generator to actually get the text of those pages. + if generator: + if summary is None: + summary = pywikibot.input(u'Enter a reason for the %sprotection:' + % ['', 'un'][protectionLevels == 'none']) if not edit: edit = defaultProtection if not move: move = defaultProtection - bot = ProtectionRobot(gen, summary, always, edit=edit, move=move) + bot = ProtectionRobot(generator, summary, always, edit=edit, move=move) bot.run() else: - pywikibot.showHelp(u'protect') + # Show help text from the top of this file + pywikibot.showHelp() if __name__ == "__main__": -- To view, visit https://gerrit.wikimedia.org/r/104198 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I6e2b6b85670a28e24c50f6da9cb6b3db236f78b5 Gerrit-PatchSet: 6 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: Ladsgroup &lt;ladsgroup(a)gmail.com&gt; Gerrit-Reviewer: Merlijn van Deen &lt;valhallasw(a)arctus.nl&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot <>