'webhooks' -> 'git-webhooks'. move all 'webhooks' settings to 'git-webhooks'

2 files changed, 582 insertions, 0 deletions

diff --git a/modules/git_webhooks/__init__.py b/modules/git_webhooks/__init__.py
new file mode 100644
index 00000000..d861e5bb
--- /dev/null
+++ b/modules/git_webhooks/__init__.py
@@ -0,0 +1,196 @@
+import itertools, json, urllib.parse
+from src import ModuleManager, utils
+from . import colors, github
+
+FORM_ENCODED = "application/x-www-form-urlencoded"
+
+@utils.export("channelset", {"setting": "git-prevent-highlight",
+    "help": "Enable/disable preventing highlights",
+    "validate": utils.bool_or_none, "example": "on"})
+@utils.export("channelset", {"setting": "git-hide-organisation",
+    "help": "Hide/show organisation in repository names",
+    "validate": utils.bool_or_none, "example": "on"})
+@utils.export("channelset", {"setting": "git-hide-prefix",
+    "help": "Hide/show command-like prefix on git webhook outputs",
+    "validate": utils.bool_or_none, "example": "on"})
+class Module(ModuleManager.BaseModule):
+    def on_load(self):
+        self._github = github.GitHub()
+
+    @utils.hook("api.post.github")
+    def _api_github_webhook(self, event):
+        return self._webhook("github", "GitHub", self._github,
+            event["data"], event["headers"])
+
+    def _webhook(self, webhook_type, webhook_name, handler, payload_str,
+            headers):
+        payload = payload_str.decode("utf8")
+        if headers["Content-Type"] == FORM_ENCODED:
+            payload = urllib.parse.unquote(urllib.parse.parse_qs(payload)[
+                "payload"][0])
+        data = json.loads(payload)
+
+        full_name, repo_username, repo_name, organisation = handler.names(
+            data, headers)
+        branch = handler.branch(data, headers)
+        current_event, event_action = handler.event(data, headers)
+
+        hooks = self.bot.database.channel_settings.find_by_setting(
+            "git-webhooks")
+
+        targets = []
+        repo_hooked = False
+
+        for server_id, channel_name, hooked_repos in hooks:
+            found_hook = None
+            if full_name and full_name in hooked_repos:
+                found_hook = hooked_repos[full_name]
+            elif repo_username and repo_username in hooked_repos:
+                found_hook = hooked_repos[repo_username]
+            elif organisation and organisation in hooked_repos:
+                found_hook = hooked_repos[organisation]
+            else:
+                continue
+
+            repo_hooked = True
+            server = self.bot.get_server_by_id(server_id)
+            if server and channel_name in server.channels:
+                if (branch and
+                        found_hook["branches"] and
+                        not branch in found_hook["branches"]):
+                    continue
+
+                events = []
+                for hooked_event in found_hook["events"]:
+                    events.append(handler.event_categories(hooked_event))
+                events = list(itertools.chain(*events))
+
+                channel = server.channels.get(channel_name)
+                if (current_event in events or
+                        (event_action and event_action in events)):
+                    targets.append([server, channel])
+
+        if not targets:
+            if not repo_hooked:
+                return None
+            else:
+                return {"state": "success", "deliveries": 0}
+
+        outputs = handler.webhook(full_name, current_event, data, headers)
+
+        if outputs:
+            for server, channel in targets:
+                source = full_name or organisation
+                hide_org = channel.get_setting("git-hide-organisation", False)
+                if repo_name and hide_org:
+                    source = repo_name
+
+                for output in outputs:
+                    output = "(%s) %s" % (
+                        utils.irc.color(source, colors.COLOR_REPO), output)
+
+                    if channel.get_setting("git-prevent-highlight", False):
+                        output = self._prevent_highlight(server, channel,
+                            output)
+
+                    hide_prefix = channel.get_setting("git-hide-prefix", False)
+                    self.events.on("send.stdout").call(target=channel,
+                        module_name=webhook_name, server=server, message=output,
+                        hide_prefix=hide_prefix)
+
+        return {"state": "success", "deliveries": len(targets)}
+
+    def _prevent_highlight(self, server, channel, s):
+        for user in channel.users:
+            if len(user.nickname) == 1:
+                # if we don't ignore 1-letter nicknames, the below while loop
+                # will fire indefininitely.
+                continue
+
+            regex = re.compile(r"(.)\b(%s)(%s)" % (
+                re.escape(user.nickname[0]), re.escape(user.nickname[1:])),
+                re.I)
+            s = regex.sub("\\1\\2\u200c\\3", s)
+
+        return s
+
+    @utils.hook("received.command.webhook", min_args=1, channel_only=True)
+    def github_webhook(self, event):
+        """
+        :help: Add/remove/modify a git webhook
+        :require_mode: high
+        :require_access: git-webhook
+        :permission: gitoverride
+        :usage: list
+        :usage: add <hook>
+        :usage: remove <hook>
+        :usage: events <hook> [category [category ...]]
+        :usage: branches <hook> [branch [branch ...]]
+        """
+        all_hooks = event["target"].get_setting("git-webhooks", {})
+        hook_name = None
+        existing_hook = None
+        if len(event["args_split"]) > 1:
+            hook_name = event["args_split"][1]
+            for existing_hook_name in all_hooks.keys():
+                if existing_hook_name.lower() == hook_name.lower():
+                    existing_hook = existing_hook_name
+                    break
+
+        success_message = None
+
+        subcommand = event["args_split"][0].lower()
+        if subcommand == "list":
+            event["stdout"].write("Registered web hooks: %s" %
+                ", ".join(all_hooks.keys()))
+        elif subcommand == "add":
+            if existing_hook:
+                raise utils.EventError("There's already a hook for %s" %
+                    hook_name)
+
+            all_hooks[hook_name] = {
+                "events": DEFAULT_EVENT_CATEGORIES.copy(),
+                "branches": [],
+            }
+            success_message = "Added hook for %s" % hook_name
+
+        elif subcommand == "remove":
+            if not existing_hook:
+                raise utils.EventError("No hook found for %s" % hook_name)
+
+            del all_hooks[existing_hook]
+            success_message = "Removed hook for %s" % hook_name
+
+        elif subcommand == "events":
+            if not existing_hook:
+                raise utils.EventError("No hook found for %s" % hook_name)
+
+            if len(event["args_split"]) < 3:
+                event["stdout"].write("Events for hook %s: %s" %
+                    (hook_name, " ".join(all_hooks[existing_hook]["events"])))
+            else:
+                new_events = [e.lower() for e in event["args_split"][2:]]
+                all_hooks[existing_hook]["events"] = new_events
+                sucess_message = "Updated events for hook %s" % hook_name
+        elif subcommand == "branches":
+            if not existing_hook:
+                raise utils.EventError("No hook found for %s" % hook_name)
+
+            if len(event["args_split"]) < 3:
+                branches = ",".join(all_hooks[existing_hook]["branches"])
+                event["stdout"].write("Branches shown for hook %s: %s" %
+                    (hook_name, branches))
+            else:
+                all_hooks[existing_hook]["branches"] = event["args_split"][2:]
+                success_message = "Updated branches for hook %s" % hook_name
+        else:
+            event["stderr"].write("Unknown command '%s'" %
+                event["args_split"][0])
+
+        if not success_message == None:
+            if all_hooks:
+                event["target"].set_setting("git-webhooks", all_hooks)
+            else:
+                event["target"].del_setting("git-webhooks")
+
+            event["stdout"].write(success_message)
diff --git a/modules/git_webhooks/github.py b/modules/git_webhooks/github.py
new file mode 100644
index 00000000..3314049d
--- /dev/null
+++ b/modules/git_webhooks/github.py
@@ -0,0 +1,386 @@
+#--depends-on-github
+from src import ModuleManager, utils
+from . import colors
+
+COMMIT_URL = "https://github.com/%s/commit/%s"
+COMMIT_RANGE_URL = "https://github.com/%s/compare/%s...%s"
+CREATE_URL = "https://github.com/%s/tree/%s"
+
+DEFAULT_EVENT_CATEGORIES = [
+    "ping", "code", "pr", "issue", "repo"
+]
+EVENT_CATEGORIES = {
+    "ping": [
+        "ping" # new webhook received
+    ],
+    "code": [
+        "push", "commit_comment"
+    ],
+    "pr-minimal": [
+        "pull_request/opened", "pull_request/closed", "pull_request/reopened"
+    ],
+    "pr": [
+        "pull_request/opened", "pull_request/closed", "pull_request/reopened",
+        "pull_request/edited", "pull_request/assigned",
+        "pull_request/unassigned", "pull_request_review",
+        "pull_request_review_comment"
+    ],
+    "pr-all": [
+        "pull_request", "pull_request_review", "pull_request_review_comment"
+    ],
+    "pr-review-minimal": [
+        "pull_request_review/submitted", "pull_request_review/dismissed"
+    ],
+    "pr-review-comment-minimal": [
+        "pull_request_review_comment/created",
+        "pull_request_review_comment/deleted"
+    ],
+    "issue-minimal": [
+        "issues/opened", "issues/closed", "issues/reopened", "issues/deleted"
+    ],
+    "issue": [
+        "issues/opened", "issues/closed", "issues/reopened", "issues/deleted",
+        "issues/edited", "issues/assigned", "issues/unassigned", "issue_comment"
+    ],
+    "issue-all": [
+        "issues", "issue_comment"
+    ],
+    "issue-comment-minimal": [
+        "issue_comment/created", "issue_comment/deleted"
+    ],
+    "repo": [
+        "create", # a repository, branch or tag has been created
+        "delete", # same as above but deleted
+        "release",
+        "fork"
+    ],
+    "team": [
+        "membership"
+    ],
+    "star": [
+        # "watch" is a misleading name for this event so this add "star" as an
+        # alias for "watch"
+        "watch"
+    ]
+}
+
+COMMENT_ACTIONS = {
+    "created": "commented",
+    "edited":  "edited a comment",
+    "deleted": "deleted a comment"
+}
+
+CHECK_RUN_CONCLUSION = {
+    "success": "passed",
+    "failure": "failed",
+    "neutral": "finished",
+    "cancelled": "was cancelled",
+    "timed_out": "timed out",
+    "action_required": "requires action"
+}
+CHECK_RUN_FAILURES = ["failure", "cancelled", "timed_out", "action_required"]
+
+class GitHub(object):
+    def names(self, data, headers):
+        full_name = None
+        repo_username = None
+        repo_name = None
+        if "repository" in data:
+            full_name = data["repository"]["full_name"]
+            repo_username, repo_name = full_name.split("/", 1)
+
+        organisation = None
+        if "organization" in data:
+            organisation = data["organization"]["login"]
+        return full_name, repo_username, repo_name, organisation
+
+    def branch(self, data, headers):
+        if "ref" in data:
+            return data["ref"].rpartition("/")[2]
+        return None
+
+    def event(self, data, headers):
+        event = headers["X-GitHub-Event"]
+        event_action = None
+        if "action" in data:
+            event_action = "%s/%s" % (event, data["action"])
+        return event, event_action
+
+    def event_categories(self, event):
+        return EVENT_CATEGORIES.get(event, [event])
+
+    def webhook(self, full_name, event, data, headers):
+        if event == "push":
+            return self.push(full_name, data)
+        elif event == "commit_comment":
+            return self.commit_comment(full_name, data)
+        elif event == "pull_request":
+            return self.pull_request(full_name, data)
+        elif event == "pull_request_review":
+            return self.pull_request_review(full_name, data)
+        elif event == "pull_request_review_comment":
+            return self.pull_request_review_comment(full_name, data)
+        elif event == "issue_comment":
+            return self.issue_comment(full_name, data)
+        elif event == "issues":
+            return self.issues(full_name, data)
+        elif event == "create":
+            return self.create(full_name, data)
+        elif event == "delete":
+            return self.delete(full_name, data)
+        elif event == "release":
+            return self.release(full_name, data)
+        elif event == "check_run":
+            return self.check_run(data)
+        elif event == "fork":
+            return self.fork(full_name, data)
+        elif event == "ping":
+            return self.ping(data)
+        elif event == "membership":
+            return self.membership(organisation, data)
+        elif event == "watch":
+            return self.watch(data)
+    def _short_url(self, url):
+        try:
+            page = utils.http.request("https://git.io", method="POST",
+                post_data={"url": url})
+            return page.headers["Location"]
+        except utils.http.HTTPTimeoutException:
+            self.log.warn(
+                "HTTPTimeoutException while waiting for github short URL", [])
+            return url
+
+    def _iso8601(self, s):
+        return datetime.datetime.strptime(s, utils.ISO8601_PARSE)
+
+    def ping(self, data):
+        return ["Received new webhook"]
+
+    def _change_count(self, n, symbol, color):
+        return utils.irc.color("%s%d" % (symbol, n), color)+utils.irc.bold("")
+    def _added(self, n):
+        return self._change_count(n, "+", colors.COLOR_POSITIVE)
+    def _removed(self, n):
+        return self._change_count(n, "-", colors.COLOR_NEGATIVE)
+    def _modified(self, n):
+        return self._change_count(n, "~", utils.consts.PURPLE)
+
+    def _short_hash(self, hash):
+        return hash[:8]
+
+    def _flat_unique(self, commits, key):
+        return set(itertools.chain(*(commit[key] for commit in commits)))
+
+    def push(self, full_name, data):
+        outputs = []
+        branch = data["ref"].split("/", 2)[2]
+        branch = utils.irc.color(branch, colors.COLOR_BRANCH)
+        author = utils.irc.bold(data["pusher"]["name"])
+
+        forced = ""
+        if data["forced"]:
+            forced = "%s " % utils.irc.color("force", utils.consts.RED)
+
+        if len(data["commits"]) == 0 and data["forced"]:
+            outputs.append(
+                "%s %spushed to %s" % (author, forced, branch))
+        elif len(data["commits"]) <= 3:
+            for commit in data["commits"]:
+                hash = commit["id"]
+                hash_colored = utils.irc.color(self._short_hash(hash), colors.COLOR_ID)
+                message = commit["message"].split("\n")[0].strip()
+                url = self._short_url(COMMIT_URL % (full_name, hash))
+
+                outputs.append(
+                    "%s %spushed %s to %s: %s - %s"
+                    % (author, forced, hash_colored, branch, message, url))
+        else:
+            first_id = data["before"]
+            last_id = data["commits"][-1]["id"]
+            url = self._short_url(
+                COMMIT_RANGE_URL % (full_name, first_id, last_id))
+
+            outputs.append("%s %spushed %d commits to %s - %s"
+                % (author, forced, len(data["commits"]), branch, url))
+
+        return outputs
+
+    def commit_comment(self, full_name, data):
+        action = data["action"]
+        commit = self._short_hash(data["comment"]["commit_id"])
+        commenter = utils.irc.bold(data["comment"]["user"]["login"])
+        url = self._short_url(data["comment"]["html_url"])
+        return ["[commit/%s] %s %s a comment - %s" % (commit, commenter,
+            action, url)]
+
+    def pull_request(self, full_name, data):
+        number = utils.irc.color("#%s" % data["pull_request"]["number"],
+            colors.COLOR_ID)
+        action = data["action"]
+        action_desc = "%s %s" % (action, number)
+        branch = data["pull_request"]["base"]["ref"]
+        colored_branch = utils.irc.color(branch, colors.COLOR_BRANCH)
+
+        if action == "opened":
+            action_desc = "requested %s merge into %s" % (number,
+                colored_branch)
+        elif action == "closed":
+            if data["pull_request"]["merged"]:
+                action_desc = "%s %s into %s" % (
+                    utils.irc.color("merged", colors.COLOR_POSITIVE), number,
+                    colored_branch)
+            else:
+                action_desc = "%s %s" % (
+                    utils.irc.color("closed", colors.COLOR_NEGATIVE), number)
+        elif action == "ready_for_review":
+            action_desc = "marked %s ready for review" % number
+        elif action == "synchronize":
+            action_desc = "committed to %s" % number
+
+        pr_title = data["pull_request"]["title"]
+        author = utils.irc.bold(data["sender"]["login"])
+        url = self._short_url(data["pull_request"]["html_url"])
+        return ["[PR] %s %s: %s - %s" % (
+            author, action_desc, pr_title, url)]
+
+    def pull_request_review(self, full_name, data):
+        if not data["action"] == "submitted":
+            return []
+
+        if not "submitted_at" in data["review"]:
+            return []
+
+        state = data["review"]["state"]
+        if state == "commented":
+            return []
+
+        number = utils.irc.color("#%s" % data["pull_request"]["number"],
+            colors.COLOR_ID)
+        action = data["action"]
+        pr_title = data["pull_request"]["title"]
+        reviewer = utils.irc.bold(data["sender"]["login"])
+        url = self._short_url(data["review"]["html_url"])
+
+        state_desc = state
+        if state == "approved":
+            state_desc = "approved changes"
+        elif state == "changes_requested":
+            state_desc = "requested changes"
+        elif state == "dismissed":
+            state_desc = "dismissed a review"
+
+        return ["[PR] %s %s on %s: %s - %s" %
+            (reviewer, state_desc, number, pr_title, url)]
+
+    def pull_request_review_comment(self, full_name, data):
+        number = utils.irc.color("#%s" % data["pull_request"]["number"],
+            colors.COLOR_ID)
+        action = data["action"]
+        pr_title = data["pull_request"]["title"]
+        sender = utils.irc.bold(data["sender"]["login"])
+        url = self._short_url(data["comment"]["html_url"])
+        return ["[PR] %s %s on a review on %s: %s - %s" %
+            (sender, COMMENT_ACTIONS[action], number, pr_title, url)]
+
+    def issues(self, full_name, data):
+        number = utils.irc.color("#%s" % data["issue"]["number"], colors.COLOR_ID)
+        action = data["action"]
+        issue_title = data["issue"]["title"]
+        author = utils.irc.bold(data["sender"]["login"])
+        url = self._short_url(data["issue"]["html_url"])
+        return ["[issue] %s %s %s: %s - %s" %
+            (author, action, number, issue_title, url)]
+    def issue_comment(self, full_name, data):
+        if "changes" in data:
+            # don't show this event when nothing has actually changed
+            if data["changes"]["body"]["from"] == data["comment"]["body"]:
+                return
+
+        number = utils.irc.color("#%s" % data["issue"]["number"], colors.COLOR_ID)
+        action = data["action"]
+        issue_title = data["issue"]["title"]
+        type = "PR" if "pull_request" in data["issue"] else "issue"
+        commenter = utils.irc.bold(data["sender"]["login"])
+        url = self._short_url(data["comment"]["html_url"])
+        return ["[%s] %s %s on %s: %s - %s" %
+            (type, commenter, COMMENT_ACTIONS[action], number, issue_title,
+            url)]
+
+    def create(self, full_name, data):
+        ref = data["ref"]
+        ref_color = utils.irc.color(ref, colors.COLOR_BRANCH)
+        type = data["ref_type"]
+        sender = utils.irc.bold(data["sender"]["login"])
+        url = self._short_url(CREATE_URL % (full_name, ref))
+        return ["%s created a %s: %s - %s" % (sender, type, ref_color, url)]
+
+    def delete(self, full_name, data):
+        ref = data["ref"]
+        ref_color = utils.irc.color(ref, colors.COLOR_BRANCH)
+        type = data["ref_type"]
+        sender = utils.irc.bold(data["sender"]["login"])
+        return ["%s deleted a %s: %s" % (sender, type, ref_color)]
+
+    def release(self, full_name, data):
+        action = data["action"]
+        tag = data["release"]["tag_name"]
+        name = data["release"]["name"] or ""
+        if name:
+            name = ": %s" % name
+        author = utils.irc.bold(data["release"]["author"]["login"])
+        url = self._short_url(data["release"]["html_url"])
+        return ["%s %s a release%s - %s" % (author, action, name, url)]
+
+    def check_run(self, data):
+        name = data["check_run"]["name"]
+        commit = self._short_hash(data["check_run"]["head_sha"])
+        commit = utils.irc.color(commit, utils.consts.LIGHTBLUE)
+
+        url = ""
+        if data["check_run"]["details_url"]:
+            url = data["check_run"]["details_url"]
+            url = " - %s" % self.exports.get_one("shortlink")(url)
+
+        duration = ""
+        if data["check_run"]["completed_at"]:
+            started_at = self._iso8601(data["check_run"]["started_at"])
+            completed_at = self._iso8601(data["check_run"]["completed_at"])
+            if completed_at > started_at:
+                seconds = (completed_at-started_at).total_seconds()
+                duration = " in %s" % utils.to_pretty_time(seconds)
+
+        status = data["check_run"]["status"]
+        status_str = ""
+        if status == "queued":
+            status_str = utils.irc.bold("queued")
+        elif status == "in_progress":
+            status_str = utils.irc.bold("started")
+        elif status == "completed":
+            conclusion = data["check_run"]["conclusion"]
+            conclusion_color = colors.COLOR_POSITIVE
+            if conclusion in CHECK_RUN_FAILURES:
+                conclusion_color = colors.COLOR_NEGATIVE
+            if conclusion == "neutral":
+                conclusion_color = colors.COLOR_NEUTRAL
+
+            status_str = utils.irc.color(
+                CHECK_RUN_CONCLUSION[conclusion], conclusion_color)
+
+        return ["[build @%s] %s: %s%s%s" % (
+            commit, name, status_str, duration, url)]
+
+    def fork(self, full_name, data):
+        forker = utils.irc.bold(data["sender"]["login"])
+        fork_full_name = utils.irc.color(data["forkee"]["full_name"],
+            utils.consts.LIGHTBLUE)
+        url = self._short_url(data["forkee"]["html_url"])
+        return ["%s forked into %s - %s" %
+            (forker, fork_full_name, url)]
+
+    def membership(self, organisation, data):
+        return ["%s %s %s to team %s" %
+            (data["sender"]["login"], data["action"], data["member"]["login"],
+            data["team"]["name"])]
+
+    def watch(self, data):
+        return ["%s starred the repository" % data["sender"]["login"]]