add read-only mode and applied non-read-only status to commands that alter mappings

Author: bspkrs

BotBase.py

@@ -177,6 +177,7 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
             except socket.error, e:
                 if e.message.find('A socket operation was attempted to an unreachable network') != -1:
                     self.dccSocketv6 = None
+        self.readOnly = False
         self.cmdHandler = CmdHandler(self)
 
         self.registerCommand('dcc',  self.requestDCC, ['any'], 0, 0, "",            "Requests a DCC connection to the bot.")
@@ -200,6 +201,7 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
         self.registerCommand('sendraw',   self.sendRawCmd, ['admin'], 0, 999, "<irccmd>",    "Send a raw IRC cmd.")
         self.registerCommand('shutdown', self.killSelf, ['admin'], 0, 0, "", "Kills the bot.")
         self.registerCommand('restart', self.restart, ['admin'], 0, 0, '', 'Restarts the bot.')
+        self.registerCommand('readonly', self.setReadOnly, ['admin'], 1, 1, '[true|false]', 'Sets Read-Only Mode for commands that are able to set data.')
 
         self.registerCommand('help',      self.helpcmd,    ['any'],   0, 1, "[<command>|*]", "Lists available commands or help about a specific command.", allowpub=True)
 
@@ -268,6 +270,14 @@ def restart(self, bot, sender, dest, cmd, args):
         self.logger.info('Restarting...')
         self.isRestarting = True
 
+    def setReadOnly(self, bot, sender, dest, cmd, args):
+        self.readOnly = args[0].lower() == 'true'
+        if self.readOnly:
+            self.sendAllChanMessage('%s is now in read-only mode. Commands that change database data are currently disabled.' % self.nick)
+        else:
+            self.sendAllChanMessage('%s is no longer in read-only mode. All commands are now available again.' % self.nick)
+
+
     # User handling commands
     def useradd(self, bot, sender, dest, cmd, args):
         user  = args[0].lower()
@@ -697,8 +707,8 @@ def getTime(self, target):
         return self.usersInfo[target].ctcpData['TIME']
 
     #EVENT REGISTRATION METHODS (ONE PER RECOGNISE IRC COMMAND)
-    def registerCommand(self, command, callback, groups, minarg, maxarg, descargs = "", desccmd = "", showhelp = True, allowpub=False):
-        self.cmdHandler.registerCommand(command, callback, groups, minarg, maxarg, descargs, desccmd, showhelp, allowpub)
+    def registerCommand(self, command, callback, groups, minarg, maxarg, descargs = "", desccmd = "", showhelp = True, allowpub=False, readonly=True):
+        self.cmdHandler.registerCommand(command, callback, groups, minarg, maxarg, descargs, desccmd, showhelp, allowpub, readonly)
     def registerEventPing(self, callback):
         self.cmdHandler.registerEvent('Ping', callback)
     def registerEventKick(self, callback):

IRCHandler.py

@@ -248,12 +248,12 @@ def monitorEvents(self):
             self.monitor_thread = threading.Timer(self.next_event_check - time.time(), self.monitorEvents)
             self.monitor_thread.start()
 
-    def registerCommand(self, command, callback, groups, minarg, maxarg, descargs = None, desccmd=None, showhelp=True, allowpub=False):
+    def registerCommand(self, command, callback, groups, minarg, maxarg, descargs = None, desccmd=None, showhelp=True, allowpub=False, readonly=True):
         if not groups:
             groups = ['any']
 
         self.commands[command.lower()] = {'command':command.lower(), 'callback':callback, 'groups':groups, 'minarg':minarg, 'maxarg':maxarg,
-                                          'descargs':descargs, 'desccmd':desccmd, 'showhelp':showhelp, 'allowpub': allowpub}
+                                          'descargs':descargs, 'desccmd':desccmd, 'showhelp':showhelp, 'allowpub': allowpub, 'readonly': readonly}
         for group in groups:
             if not group in self.bot.groups:
                 #self.bot.groups[group]= set()
@@ -513,6 +513,10 @@ def onCOMMAND(self, sender, dest, command, cmd_char_cnt=0):
         if cmd_char_cnt <= 1 or not cmd['allowpub']:
             dest = sender.nick
 
+        if not cmd['readonly'] and self.bot.readOnly:
+            self.bot.sendOutput(dest, '%s is currently in read-only mode. Please try your command again later.' % self.bot.nick)
+            return
+
         if len(args) < cmd['minarg'] or len(args) > cmd['maxarg']:
             if cmd['descargs']:
                 self.bot.sendOutput(dest, "Wrong syntax : %s" % cmd['descargs'])

MCPBot.py

@@ -60,7 +60,7 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
         self.registerCommand('testcsv',  self.getTestCSVURL, ['any', 'mcp_team'], 0, 1, "", "Gets the URL for the running export of staged changes.", allowpub=True)
         self.registerCommand('exports',  self.getExportsURL, ['any'], 0, 0, '', 'Gets the URL where all mapping exports can be found.', allowpub=True)
         self.registerCommand('latest',   self.getLatestMappingVersion, ['any'], 0, 2, '[snapshot|stable] [<mcversion>]', 'Gets a list of the latest mapping versions.', allowpub=True)
-        self.registerCommand('commit',   self.commitMappings,['mcp_team'], 0, 1, '[<srg_name>|method|field|param]', 'Commits staged mapping changes. If SRG name is specified only that member will be committed. If method/field/param is specified only that member type will be committed. Give no arguments to commit all staged changes.')
+        self.registerCommand('commit',   self.commitMappings,['mcp_team'], 0, 1, '[<srg_name>|method|field|param]', 'Commits staged mapping changes. If SRG name is specified only that member will be committed. If method/field/param is specified only that member type will be committed. Give no arguments to commit all staged changes.', readonly=False)
         self.registerCommand('maventime',self.setMavenTime,['mcp_team'], 1, 1, '<HH:MM>', 'Changes the time that the Maven upload will occur using 24 hour clock format.')
 
         self.registerCommand('gc',       self.getClass,   ['any'], 1, 2, "<class> [<version>]",                     "Returns class information. Defaults to current version. Version can be for MCP or MC.", allowpub=True)
@@ -83,24 +83,24 @@ def __init__(self, configfile=None, nspass=None, backupcfg=False):
         self.registerCommand('uf',       self.listMembers,['any'], 1, 1, "<class>",                                 "Returns a list of unnamed fields for a given class. Use DCC if the list is long.", allowpub=True)
         self.registerCommand('um',       self.listMembers,['any'], 1, 1, "<class>",                                 "Returns a list of unnamed methods for a given class. Use DCC if the list is long.", allowpub=True)
         self.registerCommand('up',       self.listMembers,['any'], 1, 1, "<class>",                                 "Returns a list of unnamed method parameters for a given class. Use DCC if the list is long.", allowpub=True)
-        self.registerCommand('undo',     self.undoChange, ['any', 'undo_any', 'mcp_team'], 1, 1, "<srg name>",      "Undoes the last *STAGED* name change to a given method/field/param. By default you can only undo your own changes.")
-        self.registerCommand('redo',     self.undoChange, ['any', 'undo_any', 'mcp_team'], 1, 1, "<srg name>",      "Redoes the last *UNDONE* staged change to a given method/field/param. By default you can only redo your own changes.")
-
-        self.registerCommand('sf',  self.setMember,  ['any'],        2, 999, "<srg name> <new name> [<comment>]", "Sets the MCP name and comment for the SRG field specified. SRG index can also be used.", allowpub=True)
-        self.registerCommand('fsf', self.setMember,  ['maintainer', 'mcp_team'], 2, 999, "<srg name> <new name> [<comment>]", "Force sets the MCP name and comment for the SRG field specified. SRG index can also be used.", allowpub=True)
-        self.registerCommand('sm',  self.setMember,  ['any'],        2, 999, "<srg name> <new name> [<comment>]", "Sets the MCP name and comment for the SRG method specified. SRG index can also be used.", allowpub=True)
-        self.registerCommand('fsm', self.setMember,  ['maintainer', 'mcp_team'], 2, 999, "<srg name> <new name> [<comment>]", "Force sets the MCP name and comment for the SRG method specified. SRG index can also be used.", allowpub=True)
-        self.registerCommand('sp',  self.setMember,  ['any'],        2, 999, "<srg name> <new name> [<comment>]", "Sets the MCP name and comment for the SRG method parameter specified. SRG index can also be used.", allowpub=True)
-        self.registerCommand('fsp', self.setMember,  ['maintainer', 'mcp_team'], 2, 999, "<srg name> <new name> [<comment>]", "Force sets the MCP name and comment for the SRG method parameter specified. SRG index can also be used.", allowpub=True)
-
-        self.registerCommand('lock',    self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given field/method/parameter from being edited. Full SRG name must be used.")
-        self.registerCommand('lockf',   self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given field from being edited. SRG index can also be used.")
-        self.registerCommand('lockm',   self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given method from being edited. SRG index can also be used.")
-        self.registerCommand('lockp',   self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given method parameter from being edited. SRG index can also be used.")
-        self.registerCommand('unlock',  self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given field/method/parameter to allow editing. Full SRG name must be used.")
-        self.registerCommand('unlockf', self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given field to allow editing. SRG index can also be used.")
-        self.registerCommand('unlockm', self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given method to allow editing. SRG index can also be used.")
-        self.registerCommand('unlockp', self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given method parameter to allow editing. SRG index can also be used.")
+        self.registerCommand('undo',     self.undoChange, ['any', 'undo_any', 'mcp_team'], 1, 1, "<srg name>",      "Undoes the last *STAGED* name change to a given method/field/param. By default you can only undo your own changes.", readonly=False)
+        self.registerCommand('redo',     self.undoChange, ['any', 'undo_any', 'mcp_team'], 1, 1, "<srg name>",      "Redoes the last *UNDONE* staged change to a given method/field/param. By default you can only redo your own changes.", readonly=False)
+
+        self.registerCommand('sf',  self.setMember,  ['any'],        2, 999, "<srg name> <new name> [<comment>]", "Sets the MCP name and comment for the SRG field specified. SRG index can also be used.", allowpub=True, readonly=False)
+        self.registerCommand('fsf', self.setMember,  ['maintainer', 'mcp_team'], 2, 999, "<srg name> <new name> [<comment>]", "Force sets the MCP name and comment for the SRG field specified. SRG index can also be used.", allowpub=True, readonly=False)
+        self.registerCommand('sm',  self.setMember,  ['any'],        2, 999, "<srg name> <new name> [<comment>]", "Sets the MCP name and comment for the SRG method specified. SRG index can also be used.", allowpub=True, readonly=False)
+        self.registerCommand('fsm', self.setMember,  ['maintainer', 'mcp_team'], 2, 999, "<srg name> <new name> [<comment>]", "Force sets the MCP name and comment for the SRG method specified. SRG index can also be used.", allowpub=True, readonly=False)
+        self.registerCommand('sp',  self.setMember,  ['any'],        2, 999, "<srg name> <new name> [<comment>]", "Sets the MCP name and comment for the SRG method parameter specified. SRG index can also be used.", allowpub=True, readonly=False)
+        self.registerCommand('fsp', self.setMember,  ['maintainer', 'mcp_team'], 2, 999, "<srg name> <new name> [<comment>]", "Force sets the MCP name and comment for the SRG method parameter specified. SRG index can also be used.", allowpub=True, readonly=False)
+
+        self.registerCommand('lock',    self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given field/method/parameter from being edited. Full SRG name must be used.", readonly=False)
+        self.registerCommand('lockf',   self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given field from being edited. SRG index can also be used.", readonly=False)
+        self.registerCommand('lockm',   self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given method from being edited. SRG index can also be used.", readonly=False)
+        self.registerCommand('lockp',   self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Locks the given method parameter from being edited. SRG index can also be used.", readonly=False)
+        self.registerCommand('unlock',  self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given field/method/parameter to allow editing. Full SRG name must be used.", readonly=False)
+        self.registerCommand('unlockf', self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given field to allow editing. SRG index can also be used.", readonly=False)
+        self.registerCommand('unlockm', self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given method to allow editing. SRG index can also be used.", readonly=False)
+        self.registerCommand('unlockp', self.setLocked,  ['lock_control', 'mcp_team'], 1, 1, "<srg name>", "Unlocks the given method parameter to allow editing. SRG index can also be used.", readonly=False)
 
         # Legacy commands that only show a notice
         self.registerCommand('gcf',  self.legacyNotice, ['any'], 1, 1,   "", "", showhelp=False, allowpub=True)
@@ -524,10 +524,10 @@ def commitMappings(self, bot, sender, dest, cmd, args):
             member_type = None
             srg_name = None
 
+        self.setReadOnly(self, sender, dest, cmd, ['true'])
         val, status = self.db.doCommit(member_type, cmd['command'], sender, args, srg_name)
         if status:
             self.sendNotice(sender.nick, str(type(status)) + ' : ' + str(status))
-            return
         else:
             self.sendPrimChanMessage("===§B Mappings Commit §N===")
             self.sendPrimChanMessage(val[0][0])
@@ -542,6 +542,8 @@ def commitMappings(self, bot, sender, dest, cmd, args):
                                      export_path=os.path.normpath(os.path.join(self.base_export_path, self.stable_export_path)))
                 self.doMavenPush(isSnapshot=False, now=datetime.now())
 
+        self.setReadOnly(self, sender, dest, cmd, ['false'])
+
 
     # Send Results