Initial

README.md

@@ -0,0 +1 @@
+Mailcow API through IRC

__init__.py

@@ -0,0 +1,71 @@
+###
+# Copyright (c) 2021, Georg Pfuetzenreuter
+# 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.
+
+###
+
+"""
+Mailcow: Mailcow API through IRC
+"""
+
+import sys
+import supybot
+from supybot import world
+
+# Use this for the version of this plugin.
+__version__ = "v1"
+
+# XXX Replace this with an appropriate author or supybot.Author instance.
+__author__ = supybot.authors.unknown
+
+# This is a dictionary mapping supybot.Author instances to lists of
+# contributions.
+__contributors__ = {}
+
+# This is a url where the most recent plugin package can be downloaded.
+__url__ = ''
+
+from . import config
+from . import plugin
+if sys.version_info >= (3, 4):
+    from importlib import reload
+else:
+    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:

config.py

@@ -0,0 +1,56 @@
+###
+# Copyright (c) 2021, Georg Pfuetzenreuter
+# 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 import conf, registry
+try:
+    from supybot.i18n import PluginInternationalization
+    _ = PluginInternationalization('Mailcow')
+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('Mailcow', True)
+
+
+Mailcow = conf.registerPlugin('Mailcow')
+# This is where your configuration variables (if any) should go.  For example:
+# conf.registerGlobalValue(Mailcow, 'someConfigVariableName',
+#     registry.Boolean(False, _("""Help for someConfigVariableName.""")))
+
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79:

local/__init__.py

@@ -0,0 +1 @@
+# Stub so local is a module, used for third-party modules

plugin.py

@@ -0,0 +1,193 @@
+###
+# Copyright (c) 2021, Georg Pfuetzenreuter
+# 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 requests
+import secrets
+import string
+from supybot import utils, plugins, ircutils, callbacks, ircdb
+from supybot.commands import *
+try:
+    from supybot.i18n import PluginInternationalization
+    _ = PluginInternationalization('Mailcow')
+except ImportError:
+    # Placeholder that allows to run the plugin on a bot
+    # without the i18n module
+    _ = lambda x: x
+
+server = 'https://zz0.email'
+api = '/api/v1'
+get = api + '/get'
+api_key = ""
+
+capability = ircdb.checkCapability(hostmask='cranberry!~u@cranberry.juice', capability='owner', ignoreDefaultAllow=True)
+
+class Mailcow(callbacks.Plugin):
+    """Mailcow API through IRC"""
+    pass
+    
+    def maildomain(self, irc, msg, args, variant, id):
+        """<variant> <id>
+        i.e. 'get liberta.casa' will print infos about the respective MX zone"""
+
+        if 'summary' in variant:
+            URL = server + get + '/domain/' + id
+            response = requests.get(
+            URL,
+            headers = {'accept': 'application/json', 'X-API-Key': api_key},
+            )
+            data = response.json()
+            domain = data['domain_name']
+            description = data['description']
+            bytes_total = data['bytes_total']
+            irc.reply(f"Domain: {domain} | Description: {description} | Bytes Total: {bytes_total} " + str(capability))
+
+        elif 'create' in variant:
+            URL = server + api + '/add/domain'
+            #domain = id['domain']
+            payload = {
+            "active": "1",
+            "aliases": "20",
+            "backupmx": "0",
+            "defquota": "1024",
+            "description": id,
+            "domain": id,
+            "mailboxes": "10",
+            "maxquota": "2048",
+            "quota": "5120",
+            "relay_all_recipients": "0",
+            "rl_frame": "s",
+            "rl_value": "10",
+            "restart_sogo": "10"
+            }
+            response = requests.post(
+            URL,
+            headers = {'accept': 'application/json', 'X-API-Key': api_key, 'Content-Type': 'application/json'},
+            json = payload,
+            )
+            data = response.json()
+            print(data)
+            status = data[0]['type']
+            #object = data[0]['domain']
+            #active = data[0]['active']
+            msg = data[0]['msg']
+            #max_aliases = data['aliases']
+            #max_mailboxes = data['mailboxes']
+            #default_quota = data['defquota']
+            #max_mailbox_quota = data['maxquota']
+            #max_domain_quota = data['quota']
+            irc.reply(f"CREATION: {status} | {msg} | NOTE: SOGo is NOT being restarted automatically.")# Issue 'sogo restart' to make the object visible through Groupware. | Summary of object properties: MaxAliases: {aliases} | MaxMailboxes: {mailboxes} | DefaultQuota: {default_quota} | MaxMailBoxQuota: {max_mailbox_quota} | MaxDomainQuota: {max_domain_quota}")
+
+        elif 'delete' in variant:
+            URL = server + api + '/delete/domain'
+            payload = [
+                id
+            ]
+            response = requests.post(
+            URL,
+            headers = {'accept': 'application/json', 'X-API-Key': api_key, 'Content-Type': 'application/json'},
+            json = payload,
+            )
+            data = response.json()
+            status = data[0]['type']
+            object = data[0]['msg']
+            irc.reply(f"DELETION: {status} - {msg} - Hey, where's that backup again?")
+
+        else:
+            irc.reply("Unknown option.")
+    maildomain = wrap(maildomain, ['anything', 'anything'])
+
+    def mailbox(self, irc, msg, args, variant, id):
+        """<variant> <id>
+        Modifies Mailboxes."""
+
+        if 'summary' in variant:
+            URL = server + get + '/mailbox/' + id
+            response = requests.get(
+            URL,
+            params={'q': 'requests'},
+            headers={'accept': 'application/json', 'X-API-Key': api_key},
+            )
+            data = response.json()
+            #return(print(data))
+            irc.reply('Username: ' + data['username'] + ' | Quota: ' + str(data['quota']) + ' | Messages: ' + str(data['messages']) + ' | Mail Active: ' + str(data['active']) + ' | XMPP Active: ' + str(data['domain_xmpp']))
+
+        elif 'create' in variant:
+            URL = server + api + '/add/mailbox/' + id
+            user = id.split('@')[0]
+            domain = id.split('@')[1]
+            random = secrets.token_urlsafe(64)
+            payload = {
+            "active": "1",
+            "domain": domain,
+            "local_part": user,
+            "name": user + '@' + domain,
+            "password": random,
+            "password2": random,
+            "quota": "512",
+            "force_pw_update": "1",
+            "tls_enforce_in": "1",
+            "tls_enforce_out": "1"
+            }
+            response = requests.post(
+            URL,
+            headers = {'accept': 'application/json', 'X-API-Key': api_key, 'Content-Type': 'application/json'},
+            json = payload,
+            )
+            data = response.json()
+            status = data[0]['type']
+            msg = data[0]['msg']
+
+            irc.reply(f"CREATION: {status} | {msg} | " + str(random) + server)
+
+        elif 'delete' in variant:
+            URL = server + api + '/delete/mailbox/' + id
+            payload = [
+                id
+            ]
+            response = requests.post(
+            URL,
+            headers = {'accept': 'application/json', 'X-API-Key': api_key, 'Content-Type': 'application/json'},
+            json = payload,
+            )
+            data = response.json()
+            status = data[0]['type']
+            object = data[0]['msg']
+
+            irc.reply(f"DELETION: {status} - {msg}")
+
+        else:
+            irc.reply('Unknown function.')
+
+    mailbox = wrap(mailbox, ['anything', 'anything'])
+
+Class = Mailcow
+
+
+# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:

test-conf/test.conf

@@ -0,0 +1,18 @@
+
+supybot.directories.data: /home/georg/limnoria/Mailcow/test-data
+supybot.directories.conf: /home/georg/limnoria/Mailcow/test-conf
+supybot.directories.log: /home/georg/limnoria/Mailcow/test-logs
+supybot.reply.whenNotCommand: True
+supybot.log.stdout: False
+supybot.log.stdout.level: ERROR
+supybot.log.level: DEBUG
+supybot.log.format: %(levelname)s %(message)s
+supybot.log.plugins.individualLogfiles: False
+supybot.protocols.irc.throttleTime: 0
+supybot.reply.whenAddressedBy.chars: @
+supybot.networks.test.server: should.not.need.this
+supybot.networks.testnet1.server: should.not.need.this
+supybot.networks.testnet2.server: should.not.need.this
+supybot.networks.testnet3.server: should.not.need.this
+supybot.nick: test
+supybot.databases.users.allowUnregistration: True

test-data/web/default.css.example

@@ -0,0 +1,55 @@
+body {
+    background-color: #F0F0F0;
+}
+
+/************************************
+ * Classes that plugins should use. *
+ ************************************/
+
+/* Error pages */
+body.error {
+    text-align: center;
+}
+body.error p {
+    background-color: #FFE0E0;
+    border: 1px #FFA0A0 solid;
+}
+
+/* Pages that only contain a list. */
+.purelisting {
+    text-align: center;
+}
+.purelisting ul {
+    margin: 0;
+    padding: 0;
+}
+.purelisting ul li {
+    margin: 0;
+    padding: 0;
+    list-style-type: none;
+}
+
+/* Pages that only contain a table. */
+.puretable {
+    text-align: center;
+}
+.puretable table
+{
+    width: 100%;
+    border-collapse: collapse;
+    text-align: center;
+}
+
+.puretable table th
+{
+    /*color: #039;*/
+    padding: 10px 8px;
+    border-bottom: 2px solid #6678b1;
+}
+
+.puretable table td
+{
+    padding: 9px 8px 0px 8px;
+    border-bottom: 1px solid #ccc;
+}
+

test-data/web/generic/error.html.example

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+ <head>
+  <meta charset="UTF-8" />
+  <title>%(title)s</title>
+  <link rel="stylesheet" href="/default.css" />
+ </head>
+ <body class="error">
+  <h1>Error</h1>
+  <p>%(error)s</p>
+ </body>
+</html>

test-data/web/index.html.example

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="UTF-8" />
+  <title>Supybot Web server index</title>
+  <link rel="stylesheet" type="text/css" href="/default.css" media="screen" />
+ </head>
+ <body class="purelisting">
+  <h1>Supybot web server index</h1>
+  <p>Here is a list of the plugins that have a Web interface:
+  </p>
+  %(list)s
+ </body>
+</html>

test-logs/messages.log

@@ -0,0 +1,33 @@
+ERROR Invalid user dictionary file, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/users.conf'
+ERROR Invalid channel database, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/channels.conf'
+ERROR Invalid network database, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/networks.conf'
+WARNING Couldn't open ignore database: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/ignores.conf'
+INFO Shutdown initiated.
+INFO Killing Driver objects.
+INFO Killing Irc objects.
+INFO Shutdown complete.
+ERROR Invalid user dictionary file, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/users.conf'
+ERROR Invalid channel database, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/channels.conf'
+ERROR Invalid network database, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/networks.conf'
+WARNING Couldn't open ignore database: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/ignores.conf'
+INFO Shutdown initiated.
+INFO Killing Driver objects.
+INFO Killing Irc objects.
+INFO Shutdown complete.
+ERROR Invalid user dictionary file, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/users.conf'
+ERROR Invalid channel database, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/channels.conf'
+ERROR Invalid network database, resetting to empty.
+ERROR Exact error: FileNotFoundError: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/networks.conf'
+WARNING Couldn't open ignore database: [Errno 2] No such file or directory: '/home/georg/limnoria/Mailcow/test-conf/ignores.conf'
+INFO Shutdown initiated.
+INFO Killing Driver objects.
+INFO Killing Irc objects.
+INFO Shutdown complete.

test.py

@@ -0,0 +1,40 @@
+###
+# Copyright (c) 2021, Georg Pfuetzenreuter
+# 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 MailcowTestCase(PluginTestCase):
+    plugins = ('Mailcow',)
+def testGet(self):
+    self.assertNotError('domain')
+
+
+# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: