Merge lp:~keegan-csmith/ibid/hg-505320 into lp:~ibid-core/ibid/old-trunk-1.6

[Keegan Carruthers-Smith]

Mercurial plugin

[Max Rabkin (max-rabkin)]

@match(r'^(?:hgrepos|hgrepositories)$') is not very human-friendly, and it should use simple matches (as should the other regex).

def get_cache_directory(plugin_name = None)

PEP 8 doesn't have spaces around "=" here.

I haven't looked at the code itself yet.

review: Needs Fixing

[lp:~keegan-csmith/ibid/hg-505320]

1009. By Keegan Carruthers-Smith on 2011-02-21

PEP 8 related changes.

1010. By Keegan Carruthers-Smith on 2011-02-21

Simplified match regex for commit and made how the revno is displayed consistent with how the HG UI does it.

[Keegan Carruthers-Smith (keegan-csmith)]

> @match(r'^(?:hgrepos|hgrepositories)$') is not very human-friendly, and it
> should use simple matches (as should the other regex).
r1010. Not changing hgrepos|hgrepositories since that is the same syntax used by the bzr and svn plugin.

> def get_cache_directory(plugin_name = None)
>
> PEP 8 doesn't have spaces around "=" here.
r1009

[lp:~keegan-csmith/ibid/hg-505320]

1011. By Keegan Carruthers-Smith on 2011-02-21

Made repo list command for hg, bzr and svn optionally contain a space.

[Max Rabkin (max-rabkin)]

Is it possible to make a "repositories" command that lists all svn, bzr and hg repos?

Have you tested this?

Do svn and bzr cooperate with "# Don't respond because this repo might be matched by bzr/svn/etc"?

Is it possible to refactor some of the common code between the three?

[Keegan Carruthers-Smith (keegan-csmith)]

> Is it possible to make a "repositories" command that lists all svn, bzr and hg
> repos?
I am going to re-evaulate anyvc, and then we can have a generic vc plugin which would do that. At the moment I suppose we could do it (assuming a certian ibid feature exists). But let me relook at anyvc first.

> Have you tested this?
Yup, works for me :)

> Do svn and bzr cooperate with "# Don't respond because this repo might be
> matched by bzr/svn/etc"?
Yes

> Is it possible to refactor some of the common code between the three?
Yes, but as above a more ideal solution would be using anyvc. See bug #505891

[Keegan Carruthers-Smith (keegan-csmith)]

I just realised this might act a bit funny when a remote repo deletes some revisions. I'll test it out

[Keegan Carruthers-Smith (keegan-csmith)]

Ok so when deleting changesets the user does not get informed about it, nor does ibid forget the hashes of the deleted changesets. Basically the only time ibid will announce anything, is when it sees a changeset with a hash it does not recognize. This only applies to remote repos.

[Stefano Rivera (stefanor)]

OK, so what's the plan re multiple repository plugins?

[Keegan Carruthers-Smith (keegan-csmith)]

> OK, so what's the plan re multiple repository plugins?
A wishlist ticket?

Unmerged revisions

1011. By Keegan Carruthers-Smith on 2011-02-21

Made repo list command for hg, bzr and svn optionally contain a space.

1010. By Keegan Carruthers-Smith on 2011-02-21

Simplified match regex for commit and made how the revno is displayed consistent with how the HG UI does it.

1009. By Keegan Carruthers-Smith on 2011-02-21

PEP 8 related changes.

1008. By Keegan Carruthers-Smith on 2011-02-20

hg plugin now pulls remote repos quietly.

1007. By Keegan Carruthers-Smith on 2011-02-20

Added call to Processor.setup(self) in both Mercurial and Bazaar plugins.

1006. By Keegan Carruthers-Smith on 2011-02-20

hg plugin now supports remote repos. Also updated to work against current ibid trunk.

1005. By Keegan Carruthers-Smith on 2010-01-13

Mercurial polling now works with local repositories.

1004. By Keegan Carruthers-Smith on 2010-01-09

Added a largely untested mercurial plugin.

=== modified file 'ibid/plugins/bzr.py'
--- ibid/plugins/bzr.py	2010-03-27 15:50:58 +0000
+++ ibid/plugins/bzr.py	2011-02-21 16:10:37 +0000
@@ -75,6 +75,7 @@
         RPC.__init__(self)
 
     def setup(self):
+        Processor.setup(self)
         self.branches = {}
         must_monitor = False
         for name, repository in self.repositories.items():
@@ -89,7 +90,7 @@
         if must_monitor:
             self.seen_revisions = {}
 
-    @match(r'^(?:repos|repositories)$')
+    @match(r'bzr\s*repos(?:itories)')
     def handle_repositories(self, event):
         repositories = self.branches.keys()
         if repositories:

=== added file 'ibid/plugins/hg.py'
--- ibid/plugins/hg.py	1970-01-01 00:00:00 +0000
+++ ibid/plugins/hg.py	2011-02-21 16:10:37 +0000
@@ -0,0 +1,155 @@
+# Copyright (c) 2011, Keegan Carruthers-Smith
+# Released under terms of the MIT/X/Expat Licence. See COPYING for details.
+
+from datetime import datetime
+
+import logging
+import os
+import os.path
+
+from mercurial import hg, ui, commands
+
+from ibid.config import DictOption, IntOption
+from ibid.plugins import Processor, match, RPC, periodic
+from ibid.utils import ago, format_date, human_join, get_cache_directory
+
+features = {'hg': {
+        'description': u'Retrieves commit logs from a Mercurial repository.',
+        'categories': ('development',),
+}}
+
+class Mercurial(Processor, RPC):
+    usage = u"""(last commit|commit <revno>) [to <repo>]
+    (hgrepos|hgrepositories)"""
+    features = ('hg',)
+    autoload = False
+
+    repositories = DictOption('repositories',
+                              'Dict of repositories names and URLs',
+                              {})
+    interval = IntOption('interval',
+                         'Interval inbetween checks for new revisions',
+                         300)
+    max_commits_to_announce = IntOption('max_commits_to_announce',
+                                        'Maximum number of commits to announce'
+                                        ' when polling for new commits.',
+                                        5)
+
+
+    def __init__(self, name):
+        self.log = logging.getLogger('plugins.hg')
+        Processor.__init__(self, name)
+        RPC.__init__(self)
+
+    def setup(self):
+        Processor.setup(self)
+        must_monitor = any(repo.get('poll', 'False').lower() in ('yes', 'true')
+                           for repo in self.repositories.values())
+        self.check.im_func.disabled = not must_monitor
+        if must_monitor:
+            self.latest_rev = {}
+
+    @match(r'hg\s*repos(?:itories)')
+    def handle_repositories(self, event):
+        if self.repositories:
+            repos = human_join(sorted(self.repositories.keys()))
+            event.addresponse(u'I know about: %s', repos)
+        else:
+            event.addresponse(u"I don't know about any repositories")
+
+    def get_repo(self, ui, name, url, pull):
+        if url[0] in (os.sep, os.altsep):
+            return hg.repository(ui, url)
+
+        ui.quiet = True
+
+        plugin_dir = get_cache_directory('hg')
+        repo_dir   = os.path.abspath(os.path.join(plugin_dir, name))
+
+        if not os.path.exists(repo_dir):
+            self.log.info('Creating a clone of %s at %s', url, repo_dir)
+            remote_repo = hg.repository(ui, url)
+            commands.clone(ui, remote_repo, repo_dir.encode('utf-8'),
+                           noupdate=True)
+
+        repo = hg.repository(ui, repo_dir)
+        repo.ui.quiet = True
+
+        if pull:
+            self.log.debug('Pulling from %s to %s', url, repo_dir)
+            commands.pull(ui, repo, url, force=True)
+
+        return repo
+
+    def commit(self, event, revno, repository):
+        if repository not in self.repositories:
+            # Don't respond because this repo might be matched by bzr/svn/etc
+            return
+
+        repo = self.get_repo(ui.ui(), repository,
+                             self.repositories[repository]['url'], True)
+        if revno is None:
+            revno = len(repo) - 1
+            if revno == -1:
+                event.addresponse(u'There have been no commits')
+                return
+
+        ctx = repo[revno]
+        timestamp = datetime.utcfromtimestamp(ctx.date()[0])
+        commit = u'Commit %d:%s by %s to %s on %s at %s: %s (%s)\n' % (
+            ctx.rev(),
+            ctx.hex()[:12], # HG only shows the first 12 chars of the hex str
+            ctx.user(),
+            repository,
+            format_date(timestamp, 'date'),
+            format_date(timestamp, 'time'),
+            ctx.description().replace('\n', ' '),
+            '; '.join(ctx.files()))
+
+        event.addresponse(commit, conflate=False)
+
+    @match(r'last commit to {chunk}')
+    def commit_repo(self, event, repository):
+        self.commit(event, None, repository)
+
+    @match(r'commit {chunk} to {chunk}')
+    def commit_rev(self, event, revno, repository):
+        self.commit(event, revno, repository)
+
+    @periodic(config_key='interval')
+    def check(self, event):
+        for name, repository in self.repositories.iteritems():
+            if repository.get('poll', 'False').lower() not in ('yes', 'true'):
+                continue
+
+            repo = self.get_repo(ui.ui(), name, repository['url'], True)
+
+            rev_end = len(repo) - 1
+            if rev_end == -1:
+                return
+            rev_start = self.latest_rev.get(name, rev_end) + 1
+            self.latest_rev[name] = rev_end
+
+            for rev in range(rev_start, rev_end+1)[-self.max_commits_to_announce:]:
+                ctx = repo[rev]
+                date = datetime.fromtimestamp(ctx.date()[0])
+                commit = u'Commit %d:%s by %s to %s %s ago: %s\n' % (
+                    ctx.rev(),
+                    ctx.hex()[:12],
+                    ctx.user(),
+                    name,
+                    ago(datetime.now() - date, 2),
+                    ctx.description().replace('\n', ' '))
+                event.addresponse(commit,
+                                  source=repository['source'],
+                                  target=repository['channel'],
+                                  address=False)
+
+            ncommits = rev_end - rev_start + 1
+            if self.max_commits_to_announce < ncommits:
+                event.addresponse('and %d more commits' % ncommits,
+                                  source=repository['source'],
+                                  target=repository['channel'],
+                                  address=False)
+
+# vi: set et sta sw=4 ts=4:

=== modified file 'ibid/plugins/svn.py'
--- ibid/plugins/svn.py	2010-03-27 15:50:58 +0000
+++ ibid/plugins/svn.py	2011-02-21 16:10:37 +0000
@@ -418,7 +418,7 @@
             else:
                 self.branches[reponame] = CommandLineBranch(reponame, repository['url'], username = repository['username'], password = repository['password'], svn_command=self.svn_command, svn_timeout=self.svn_timeout, multiline=self.multiline)
 
-    @match(r'^svn ?(?:repos|repositories)$')
+    @match(r'svn\s*repos(?:itories)')
     @authorise()
     def handle_repositories(self, event):
         repositories = self.branches.keys()

=== modified file 'ibid/utils/__init__.py'
--- ibid/utils/__init__.py	2011-01-22 23:04:00 +0000
+++ ibid/utils/__init__.py	2011-02-21 16:10:37 +0000
@@ -57,6 +57,22 @@
     text = re.sub("&(\w+);", replace, text)
     return text
 
+def get_cache_directory(plugin_name=None):
+    cachedir = ibid.config.plugins.get('cachedir', None)
+    if not cachedir:
+        cachedir = os.path.join(ibid.options['base'], 'cache')
+    elif cachedir[0] == "~":
+        cachedir = os.path.expanduser(cachedir)
+    cachedir = os.path.abspath(cachedir)
+
+    if plugin_name is not None:
+        cachedir = os.path.join(cachedir, plugin_name)
+
+    if not os.path.isdir(cachedir):
+        os.makedirs(cachedir)
+
+    return cachedir
+
 downloads_in_progress = defaultdict(Lock)
 def cacheable_download(url, cachefile, headers={}, timeout=60):
     """Download url to cachefile if it's modified since cachefile.
@@ -75,17 +91,7 @@
     # We do allow absolute paths, for people who know what they are doing,
     # but the common use case should be pluginname/cachefile.
     if cachefile[0] not in (os.sep, os.altsep):
-        cachedir = ibid.config.plugins.get('cachedir', None)
-        if not cachedir:
-            cachedir = os.path.join(ibid.options['base'], 'cache')
-        elif cachedir[0] == "~":
-            cachedir = os.path.expanduser(cachedir)
-        cachedir = os.path.abspath(cachedir)
-
-        plugindir = os.path.join(cachedir, os.path.dirname(cachefile))
-        if not os.path.isdir(plugindir):
-            os.makedirs(plugindir)
-
+        plugindir = get_cache_directory(os.path.dirname(cachefile))
         cachefile = os.path.join(cachedir, cachefile)
 
     exists = os.path.isfile(cachefile)

=== modified file 'setup.py'
--- setup.py	2011-02-20 20:31:01 +0000
+++ setup.py	2011-02-21 16:10:37 +0000
@@ -48,6 +48,7 @@
         'imdb': ['imdbpy'],
         'memory': ['objgraph'],
         'asciiart': ['python-aalib'],
+        'hg': ['mercurial'],
     },
     dependency_links=[
         'http://ibid.omnia.za.net/eggs/',