ben
/
earwigbot-plugins
mirror of https://github.com/earwig/earwigbot-plugins
1
1
Fork 0
Code Releases 1 Activity
Additional IRC commands and bot tasks for EarwigBot https://en.wikipedia.org/wiki/User:EarwigBot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
5 Commits
1 Branch
751 KiB
 
 
Tree: a529788b6c
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a529788b6c'
${ noResults }
earwigbot-plugins/commands/git_command.py

241 lines
9.4 KiB
Raw Blame History 

  1. # -*- coding: utf-8  -*-

  2. #

  3. # Copyright (C) 2009-2012 Ben Kurtovic <ben.kurtovic@verizon.net>

  4. #

  5. # Permission is hereby granted, free of charge, to any person obtaining a copy

  6. # of this software and associated documentation files (the "Software"), to deal

  7. # in the Software without restriction, including without limitation the rights

  8. # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  9. # copies of the Software, and to permit persons to whom the Software is

  10. # furnished to do so, subject to the following conditions:

  11. #

  12. # The above copyright notice and this permission notice shall be included in

  13. # all copies or substantial portions of the Software.

  14. #

  15. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  16. # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  17. # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  18. # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  19. # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  20. # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

  21. # SOFTWARE.

  22. 

  23. import time

  24. 

  25. import git

  26. 

  27. from earwigbot.commands import Command

  28. 

  29. class Git(Command):

  30.     """Commands to interface with configurable git repositories; use '!git' for

  31.     a sub-command list."""

  32.     name = "git"

  33. 

  34.     def setup(self):

  35.         try:

  36.             self.repos = self.config.commands[self.name]["repos"]

  37.         except KeyError:

  38.             self.repos = None

  39. 

  40.     def process(self, data):

  41.         self.data = data

  42.         if not self.config.irc["permissions"].is_owner(data):

  43.             msg = "You must be a bot owner to use this command."

  44.             self.reply(data, msg)

  45.             return

  46.         if not data.args or data.args[0] == "help":

  47.             self.do_help()

  48.             return

  49.         if not self.repos:

  50.             self.reply(data, "No repos are specified in the config file.")

  51.             return

  52. 

  53.         command = data.args[0]

  54.         try:

  55.             repo_name = data.args[1]

  56.         except IndexError:

  57.             repos = self.get_repos()

  58.             msg = "Which repo do you want to work with (options are {0})?"

  59.             self.reply(data, msg.format(repos))

  60.             return

  61.         if repo_name not in self.repos:

  62.             repos = self.get_repos()

  63.             msg = "Repository must be one of the following: {0}."

  64.             self.reply(data, msg.format(repos))

  65.             return

  66.         self.repo = git.Repo(self.repos[repo_name])

  67. 

  68.         if command == "branch":

  69.             self.do_branch()

  70.         elif command == "branches":

  71.             self.do_branches()

  72.         elif command == "checkout":

  73.             self.do_checkout()

  74.         elif command == "delete":

  75.             self.do_delete()

  76.         elif command == "pull":

  77.             self.do_pull()

  78.         elif command == "status":

  79.             self.do_status()

  80.         else:  # They asked us to do something we don't know

  81.             msg = "Unknown argument: \x0303{0}\x0F.".format(data.args[0])

  82.             self.reply(data, msg)

  83. 

  84.     def get_repos(self):

  85.         data = self.repos.iteritems()

  86.         repos = ["\x0302{0}\x0F ({1})".format(k, v) for k, v in data]

  87.         return ", ".join(repos)

  88. 

  89.     def get_remote(self):

  90.         try:

  91.             remote_name = self.data.args[2]

  92.         except IndexError:

  93.             remote_name = "origin"

  94.         try:

  95.             return getattr(self.repo.remotes, remote_name)

  96.         except AttributeError:

  97.             msg = "Unknown remote: \x0302{0}\x0F.".format(remote_name)

  98.             self.reply(self.data, msg)

  99. 

  100.     def get_time_since(self, date):

  101.         diff = time.mktime(time.gmtime()) - date

  102.         if diff < 60:

  103.             return "{0} seconds".format(int(diff))

  104.         if diff < 60 * 60:

  105.             return "{0} minutes".format(int(diff / 60))

  106.         if diff < 60 * 60 * 24:

  107.             return "{0} hours".format(int(diff / 60 / 60))

  108.         return "{0} days".format(int(diff / 60 / 60 / 24))

  109. 

  110.     def do_help(self):

  111.         """Display all commands."""

  112.         help = {

  113.             "branch": "get current branch",

  114.             "branches": "get all branches",

  115.             "checkout": "switch branches",

  116.             "delete": "delete an old branch",

  117.             "pull": "update everything from the remote server",

  118.             "status": "check if we are up-to-date",

  119.         }

  120.         subcommands = ""

  121.         for key in sorted(help.keys()):

  122.             subcommands += "\x0303{0}\x0F ({1}), ".format(key, help[key])

  123.         subcommands = subcommands[:-2]  # Trim last comma and space

  124.         msg = "Sub-commands are: {0}; repos are: {1}. Syntax: !git \x0303subcommand\x0F \x0302repo\x0F."

  125.         self.reply(self.data, msg.format(subcommands, self.get_repos()))

  126. 

  127.     def do_branch(self):

  128.         """Get our current branch."""

  129.         branch = self.repo.active_branch.name

  130.         msg = "Currently on branch \x0302{0}\x0F.".format(branch)

  131.         self.reply(self.data, msg)

  132. 

  133.     def do_branches(self):

  134.         """Get a list of branches."""

  135.         branches = [branch.name for branch in self.repo.branches]

  136.         msg = "Branches: \x0302{0}\x0F.".format(", ".join(branches))

  137.         self.reply(self.data, msg)

  138. 

  139.     def do_checkout(self):

  140.         """Switch branches."""

  141.         try:

  142.             target = self.data.args[2]

  143.         except IndexError:  # No branch name provided

  144.             self.reply(self.data, "Wwitch to which branch?")

  145.             return

  146. 

  147.         current_branch = self.repo.active_branch.name

  148.         if target == current_branch:

  149.             msg = "Already on \x0302{0}\x0F!".format(target)

  150.             self.reply(self.data, msg)

  151.             return

  152. 

  153.         try:

  154.             ref = getattr(self.repo.branches, target)

  155.         except AttributeError:

  156.             msg = "Branch \x0302{0}\x0F doesn't exist!".format(target)

  157.             self.reply(self.data, msg)

  158.         else:

  159.             ref.checkout()

  160.             ms = "Switched from branch \x0302{0}\x0F to \x0302{1}\x0F."

  161.             msg = ms.format(current_branch, target)

  162.             self.reply(self.data, msg)

  163.             log = "{0} checked out branch {1} of {2}"

  164.             logmsg = log.format(self.data.nick, target, self.repo.working_dir)

  165.             self.logger.info(logmsg)

  166. 

  167.     def do_delete(self):

  168.         """Delete a branch, while making sure that we are not already on it."""

  169.         try:

  170.             target = self.data.args[2]

  171.         except IndexError:  # No branch name provided

  172.             self.reply(self.data, "Delete which branch?")

  173.             return

  174. 

  175.         current_branch = self.repo.active_branch.name

  176.         if current_branch == target:

  177.             msg = "You're currently on this branch; please checkout to a different branch before deleting."

  178.             self.reply(self.data, msg)

  179.             return

  180. 

  181.         try:

  182.             ref = getattr(self.repo.branches, target)

  183.         except AttributeError:

  184.             msg = "Branch \x0302{0}\x0F doesn't exist!".format(target)

  185.             self.reply(self.data, msg)

  186.         else:

  187.             self.repo.git.branch("-d", ref)

  188.             msg = "Branch \x0302{0}\x0F has been deleted locally."

  189.             self.reply(self.data, msg.format(target))

  190.             log = "{0} deleted branch {1} of {2}"

  191.             logmsg = log.format(self.data.nick, target, self.repo.working_dir)

  192.             self.logger.info(logmsg)

  193. 

  194.     def do_pull(self):

  195.         """Pull from our remote repository."""

  196.         branch = self.repo.active_branch.name

  197.         msg = "Pulling from remote (currently on \x0302{0}\x0F)..."

  198.         self.reply(self.data, msg.format(branch))

  199. 

  200.         remote = self.get_remote()

  201.         if not remote:

  202.             return

  203.         result = remote.pull()

  204.         updated = [info for info in result if info.flags != info.HEAD_UPTODATE]

  205. 

  206.         if updated:

  207.             branches = ", ".join([info.ref.remote_head for info in updated])

  208.             msg = "Done; updates to \x0302{0}\x0F (from {1})."

  209.             self.reply(self.data, msg.format(branches, remote.url))

  210.             log = "{0} pulled {1} of {2} (updates to {3})"

  211.             self.logger.info(log.format(self.data.nick, remote.name,

  212.                                         self.repo.working_dir, branches))

  213.         else:

  214.             self.reply(self.data, "Done; no new changes.")

  215.             log = "{0} pulled {1} of {2} (no updates)"

  216.             self.logger.info(log.format(self.data.nick, remote.name,

  217.                                         self.repo.working_dir))

  218. 

  219.     def do_status(self):

  220.         """Check if we have anything to pull."""

  221.         remote = self.get_remote()

  222.         if not remote:

  223.             return

  224.         since = self.get_time_since(self.repo.head.object.committed_date)

  225.         result = remote.fetch(dry_run=True)

  226.         updated = [info for info in result if info.flags != info.HEAD_UPTODATE]

  227. 

  228.         if updated:

  229.             branches = ", ".join([info.ref.remote_head for info in updated])

  230.             msg = "Last local commit was \x02{0}\x0F ago; updates to \x0302{1}\x0F."

  231.             self.reply(self.data, msg.format(since, branches))

  232.             log = "{0} got status of {1} of {2} (updates to {3})"

  233.             self.logger.info(log.format(self.data.nick, remote.name,

  234.                                         self.repo.working_dir, branches))

  235.         else:

  236.             msg = "Last commit was \x02{0}\x0F ago. Local copy is up-to-date with remote."

  237.             self.reply(self.data, msg.format(since))

  238.             log = "{0} pulled {1} of {2} (no updates)"

  239.             self.logger.info(log.format(self.data.nick, remote.name,

  240.                                         self.repo.working_dir))