### # Copyright (c) 2015, Moritz Lipp # 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 json from supybot.commands import wrap import supybot.ircdb as ircdb import supybot.ircmsgs as ircmsgs import supybot.callbacks as callbacks import supybot.log as log import supybot.httpserver as httpserver import supybot.world as world try: from supybot.i18n import PluginInternationalization from supybot.i18n import internationalizeDocstring _ = PluginInternationalization('Gitlab') except ImportError: # Placeholder that allows to run the plugin on a bot # without the i18n module def _(x): return x def internationalizeDocstring(x): return x class GitlabHandler(object): """Handle gitlab messages""" def __init__(self, plugin): self.plugin = plugin self.log = log.getPluginLogger('Gitlab') # HACK: instead of refactoring everything, I can just replace this with each handle_payload() call. self.irc = None def handle_payload(self, headers, payload, irc): if 'X-Gitlab-Event' not in headers: self.log.info('Invalid header: Missing X-Gitlab-Event entry') return self.irc = irc self.log.debug('GitLab: running on network %r', irc.network) event_type = headers['X-Gitlab-Event'] if event_type not in ['Push Hook', 'Tag Push Hook', 'Note Hook', 'Issue Hook', 'Merge Request Hook']: self.log.info('Unsupported X-Gitlab-Event type') return # Check if any channel has subscribed to this project for channel in irc.state.channels.keys(): projects = self.plugin._load_projects(channel) for slug, url in projects.items(): # Parse project url if event_type == 'Push Hook' or event_type == 'Tag Push Hook' or event_type == 'Note Hook': if url != payload['repository']['homepage']: continue elif event_type == 'Issue Hook': if url not in payload['object_attributes']['url']: continue elif event_type == 'Merge Request Hook': if url not in payload['object_attributes']['target']['http_url']: continue else: continue # Update payload payload['project'] = { 'name': slug, 'url': url } if event_type == 'Issue Hook': payload['project']['id'] = payload[ 'object_attributes']['project_id'] elif event_type == 'Merge Request Hook': payload['project']['id'] = payload[ 'object_attributes']['target_project_id'] else: payload['project']['id'] = payload['project_id'] # Handle types if event_type == 'Push Hook': self._push_hook(channel, payload) elif event_type == 'Tag Push Hook': self._tag_push_hook(channel, payload) elif event_type == 'Issue Hook': self._issue_hook(channel, payload) elif event_type == 'Note Hook': self._note_hook(channel, payload) elif event_type == 'Merge Request Hook': self._merge_request_hook(channel, payload) def _push_hook(self, channel, payload): # Send general message msg = self._build_message(channel, 'push', payload) self._send_message(channel, msg) # Send commits for commit in payload['commits']: commit['project'] = { 'id': payload['project_id'], 'name': payload['project']['name'], 'url': payload['project']['url'] } commit['short_message'] = commit['message'].splitlines()[0] commit['short_id'] = commit['id'][0:10] msg = self._build_message(channel, 'commit', commit) self._send_message(channel, msg) def _tag_push_hook(self, channel, payload): msg = self._build_message(channel, 'tag', payload) self._send_message(channel, msg) # Send commits for commit in payload['commits']: commit['project'] = { 'id': payload['project_id'], 'name': payload['project']['name'], 'url': payload['project']['url'] } commit['short_message'] = commit['message'].splitlines()[0] commit['short_id'] = commit['id'][0:10] msg = self._build_message(channel, 'commit', commit) self._send_message(channel, msg) def _note_hook(self, channel, payload): noteable_type = payload['object_attributes']['noteable_type'] if noteable_type not in ['Commit', 'MergeRequest', 'Issue', 'Snippet']: self.log.info("Unsupported note type '%s'" % noteable_type) return noteable_type = noteable_type.lower() if noteable_type == "mergerequest": noteable_type = "merge-request" payload['note'] = payload['object_attributes'] msg = self._build_message(channel, 'note-' + noteable_type, payload) self._send_message(channel, msg) def _issue_hook(self, channel, payload): action = payload['object_attributes']['action'] if action not in ['open', 'update', 'close', 'reopen']: self.log.info("Unsupported issue action '%s'" % action) return payload['issue'] = payload['object_attributes'] msg = self._build_message(channel, 'issue-' + action, payload) self._send_message(channel, msg) def _merge_request_hook(self, channel, payload): action = payload['object_attributes']['action'] if action not in ['open', 'update', 'close', 'reopen', 'merge']: self.log.info("Unsupported issue action '%s'" % action) return payload['merge_request'] = payload['object_attributes'] msg = self._build_message(channel, 'merge-request-' + action, payload) self._send_message(channel, msg) def _build_message(self, channel, format_string_identifier, args): format_string = str( self.plugin.registryValue( 'format.' + format_string_identifier, channel)) msg = format_string.format(**args) return msg def _send_message(self, channel, msg): if self.plugin.registryValue('use-notices', channel): announce_msg = ircmsgs.notice(channel, msg) else: announce_msg = ircmsgs.privmsg(channel, msg) self.irc.queueMsg(announce_msg) class GitlabWebHookService(httpserver.SupyHTTPServerCallback): """https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/web_hooks/web_hooks.md""" name = "GitlabWebHookService" defaultResponse = """This plugin handles only POST request, please don't use other requests.""" def __init__(self, plugin): self.log = log.getPluginLogger('Gitlab') self.gitlab = GitlabHandler(plugin) self.plugin = plugin def _send_error(self, handler, message): handler.send_response(403) handler.send_header('Content-type', 'text/plain') handler.end_headers() handler.wfile.write(message.encode('utf-8')) def _send_ok(self, handler): handler.send_response(200) handler.send_header('Content-type', 'text/plain') handler.end_headers() handler.wfile.write(bytes('OK', 'utf-8')) def doPost(self, handler, path, form): headers = dict(self.headers) network = None try: information = path.split('/')[1:] network = information[0] except IndexError: self._send_error(handler, _("""Error: You need to provide the network name in the URL.""")) return irc = world.getIrc(network) if irc is None: self._send_error(handler, (_('Error: Unknown network %r') % network)) return # Handle payload payload = None try: payload = json.JSONDecoder().decode(form.decode('utf-8')) except Exception as e: self.log.info(e) self._send_error(handler, _('Error: Invalid JSON data sent.')) return try: self.gitlab.handle_payload(headers, payload, irc) except Exception as e: self.log.info(e) self._send_error(handler, _('Error: Invalid data sent.')) return # Return OK self._send_ok(handler) class Gitlab(callbacks.Plugin): """Plugin for communication and notifications of a Gitlab project management tool instance""" threaded = True def __init__(self, irc): global instance # Store the super() information so that reloads don't fail self.__parent = super(Gitlab, self) self.__parent.__init__(irc) instance = self callback = GitlabWebHookService(self) httpserver.hook('gitlab', callback) def die(self): httpserver.unhook('gitlab') self.__parent.die() def _load_projects(self, channel): projects = self.registryValue('projects', channel) if projects is None: return {} else: return projects def _save_projects(self, projects, channel): self.setRegistryValue('projects', value=projects, channel=channel) def _check_capability(self, irc, msg): if ircdb.checkCapability(msg.prefix, 'admin'): return True else: irc.errorNoCapability('admin') return False class gitlab(callbacks.Commands): """Gitlab commands""" class project(callbacks.Commands): """Project commands""" @internationalizeDocstring def add(self, irc, msg, args, channel, project_slug, project_url): """[] Announces the changes of the project with the slug and the url to . """ if not instance._check_capability(irc, msg): return projects = instance._load_projects(channel) if project_slug in projects: irc.error( _('This project is already announced to this channel.')) return # Save new project mapping projects[project_slug] = project_url instance._save_projects(projects, channel) irc.replySuccess() add = wrap(add, ['channel', 'somethingWithoutSpaces', 'httpUrl']) @internationalizeDocstring def remove(self, irc, msg, args, channel, project_slug): """[] Stops announcing the changes of the project slug to . """ if not instance._check_capability(irc, msg): return projects = instance._load_projects(channel) if project_slug not in projects: irc.error( _('This project is not registered to this channel.')) return # Remove project mapping del projects[project_slug] instance._save_projects(projects, channel) irc.replySuccess() remove = wrap(remove, ['channel', 'somethingWithoutSpaces']) @internationalizeDocstring def list(self, irc, msg, args, channel): """[] Lists the registered projects in . """ if not instance._check_capability(irc, msg): return projects = instance._load_projects(channel) if projects is None or len(projects) == 0: irc.error(_('This channel has no registered projects.')) return for project_slug, project_url in projects.items(): irc.reply("%s: %s" % (project_slug, project_url)) list = wrap(list, ['channel']) Class = Gitlab # vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: