From 771e1a51a90f86c1a81adbaf59274b5e8df013e9 Mon Sep 17 00:00:00 2001 From: James Lu Date: Sun, 16 Apr 2017 16:41:29 -0700 Subject: [PATCH] Add an experimental plugin to restart Limnoria from IRC Resolves ProgVal/Limnoria#1070. --- README.md | 3 ++ Restart/README.md | 9 +++++ Restart/__init__.py | 59 ++++++++++++++++++++++++++++++ Restart/config.py | 57 +++++++++++++++++++++++++++++ Restart/local/__init__.py | 1 + Restart/plugin.py | 75 +++++++++++++++++++++++++++++++++++++++ Restart/test.py | 38 ++++++++++++++++++++ 7 files changed, 242 insertions(+) create mode 100644 Restart/README.md create mode 100644 Restart/__init__.py create mode 100644 Restart/config.py create mode 100644 Restart/local/__init__.py create mode 100644 Restart/plugin.py create mode 100644 Restart/test.py diff --git a/README.md b/README.md index 0e0b2f0..82c372f 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,9 @@ Most of these plugins also have their own READMEs in their folders; you can usua - Looks up commonly used UDP and TCP port numbers from Wikipedia: https://en.wikipedia.org/wiki/List_of_TCP_and_UDP_port_numbers - **Requires:** [Beautiful Soup 4](http://www.crummy.com/software/BeautifulSoup/bs4/doc/) +##### Restart +- **EXPERIMENTAL**: provides a command to restart Limnoria from IRC. + ##### [RelayNext](RelayNext/README.md) - Next generation relayer plugin, designed with two-way relays in mind. diff --git a/Restart/README.md b/Restart/README.md new file mode 100644 index 0000000..3e11b00 --- /dev/null +++ b/Restart/README.md @@ -0,0 +1,9 @@ +**EXPERIMENTAL**: provides a command to restart Limnoria from IRC. + +Usage is simple: + +``` +16:36 <@GL> %restart +16:36 <-- Atlas (AtlasBot@bots.overdrivenetworks.com) has quit (Quit: Disconnecting...) +16:36 --> Atlas (AtlasBot@bots.overdrivenetworks.com) has joined #test +``` diff --git a/Restart/__init__.py b/Restart/__init__.py new file mode 100644 index 0000000..e220ad5 --- /dev/null +++ b/Restart/__init__.py @@ -0,0 +1,59 @@ +### +# Copyright (c) 2017, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +""" +Restart plugin: provides a command to restart Limnoria from IRC. +""" + +import supybot +import supybot.world as world + +__version__ = "" +__author__ = supybot.Author('James Lu', 'GLolol', 'james@overdrivenetworks.com') +__contributors__ = {} +__url__ = 'https://github.com/GLolol/SupyPlugins/' + +from . import config +from . import plugin +from imp import reload +# In case we're being reloaded. +reload(config) +reload(plugin) +# Add more reloads here if you add third-party modules and want them to be +# reloaded when this plugin is reloaded. Don't forget to import them as well! + +if world.testing: + from . import test + +Class = plugin.Class +configure = config.configure + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/Restart/config.py b/Restart/config.py new file mode 100644 index 0000000..5d1c5fb --- /dev/null +++ b/Restart/config.py @@ -0,0 +1,57 @@ +### +# Copyright (c) 2017, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +import supybot.conf as conf +import supybot.registry as registry +try: + from supybot.i18n import PluginInternationalization + _ = PluginInternationalization('Restart') +except: + # Placeholder that allows to run the plugin on a bot + # without the i18n module + _ = lambda x: x + + +def configure(advanced): + # This will be called by supybot to configure this module. advanced is + # a bool that specifies whether the user identified themself as an advanced + # user or not. You should effect your configuration by manipulating the + # registry as appropriate. + from supybot.questions import expect, anything, something, yn + conf.registerPlugin('Restart', True) + + +Restart = conf.registerPlugin('Restart') +# This is where your configuration variables (if any) should go. For example: +# conf.registerGlobalValue(Restart, 'someConfigVariableName', +# registry.Boolean(False, _("""Help for someConfigVariableName."""))) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/Restart/local/__init__.py b/Restart/local/__init__.py new file mode 100644 index 0000000..e86e97b --- /dev/null +++ b/Restart/local/__init__.py @@ -0,0 +1 @@ +# Stub so local is a module, used for third-party modules diff --git a/Restart/plugin.py b/Restart/plugin.py new file mode 100644 index 0000000..5f5b8b5 --- /dev/null +++ b/Restart/plugin.py @@ -0,0 +1,75 @@ +### +# Copyright (c) 2017, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +import supybot.utils as utils +from supybot.commands import * +import supybot.plugins as plugins +import supybot.ircutils as ircutils +import supybot.callbacks as callbacks +try: + from supybot.i18n import PluginInternationalization + _ = PluginInternationalization('Restart') +except ImportError: + # Placeholder that allows to run the plugin on a bot + # without the i18n module + _ = lambda x: x + +import atexit +import os +import sys +import time + +class Restart(callbacks.Plugin): + """Restart plugin: provides a command to restart Limnoria from IRC.""" + + @staticmethod + def restart_atexit_hook(): + # Replace the currently running Supybot process with another one with the same + # args. + os.execl(sys.executable, os.path.basename(sys.executable), *sys.argv) + + @wrap(['owner', additional('text')]) + def restart(self, irc, msg, args, text): + """[] + + Restarts the bot with the QUIT message . If is not given, + the default quit message (supybot.plugins.Owner.quitMsg) will be used. + If there is no default quitMsg set, your nick will be used. The standard + substitutions ($version, $nick, etc.) are all handled appropriately. + """ + atexit.register(self.restart_atexit_hook) + self.log.info('Restart: Attempting to restart Limnoria.') + # Reuse the 'quit' command of the Owner plugin. + irc.getCallback('Owner').quit(irc, msg, [text or '']) + +Class = Restart + + +# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: diff --git a/Restart/test.py b/Restart/test.py new file mode 100644 index 0000000..f7b716c --- /dev/null +++ b/Restart/test.py @@ -0,0 +1,38 @@ +### +# Copyright (c) 2017, James Lu +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +from supybot.test import * + + +class RestartTestCase(PluginTestCase): + plugins = ('Restart',) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: