Mercurial > hg
view hgext/hgcia.py @ 27738:a0e783d26e81
exchange: make clone bundles non-experimental and enabled by default
The clone bundles feature was introduced in Mercurial 3.6 behind an
experimental and disabled by default flag. The feature has been enabled
on hg.mozilla.org for a few months and has served many terabytes of
clones. Users have been encouraged to use the feature and reception
has been very positive (mainly due to faster clones as a result of
connecting to a CDN). I have heard no feedback about changing the
feature other than inquiries about when it will be enabled by default.
So, I think the feature is ready to be enabled by default.
This patch renames experimental.clonebundles to ui.clonebundles,
documents the option, and enables it by default. References to the
experimental state of clone bundles have been removed. The remaining
config option docs in clonebundles.py have been removed because they
are redudant with `hg help config`.
There are some oddities with behavior of clone bundles. Because clones
with clone bundles are effectively 2 `hg pull` operations, there may be
2 transactions. This could result in hooks running twice. If the
subsequent pull is aborted, it could result in partial rollback and an
incomplete clone. This behavior is a bit wonky and should probably
be documented. If this patch is accepted, I'll send a follow-up to
document it. I don't think this behavior should prevent the feature
being enabled by default. Reworking the clone mechanism to support
interrupted or multi-part clones feels like a major new feature and
something that when implemented can change the hook and rollback
semantics of clone bundles. Besides, partial clone is better than
full rollback and hooks running on initial clone are likely rare, so I
think the impact is minimal.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Fri, 08 Jan 2016 10:58:04 -0800 |
parents | 56b2bcea2529 |
children |
line wrap: on
line source
# Copyright (C) 2007-8 Brendan Cully <brendan@kublai.com> # # This software may be used and distributed according to the terms of the # GNU General Public License version 2 or any later version. """hooks for integrating with the CIA.vc notification service This is meant to be run as a changegroup or incoming hook. To configure it, set the following options in your hgrc:: [cia] # your registered CIA user name user = foo # the name of the project in CIA project = foo # the module (subproject) (optional) #module = foo # Append a diffstat to the log message (optional) #diffstat = False # Template to use for log messages (optional) #template = {desc}\\n{baseurl}{webroot}/rev/{node}-- {diffstat} # Style to use (optional) #style = foo # The URL of the CIA notification service (optional) # You can use mailto: URLs to send by email, e.g. # mailto:cia@cia.vc # Make sure to set email.from if you do this. #url = http://cia.vc/ # print message instead of sending it (optional) #test = False # number of slashes to strip for url paths #strip = 0 [hooks] # one of these: changegroup.cia = python:hgcia.hook #incoming.cia = python:hgcia.hook [web] # If you want hyperlinks (optional) baseurl = http://server/path/to/repo """ from mercurial.i18n import _ from mercurial.node import bin, short from mercurial import cmdutil, patch, util, mail, error import email.Parser import socket, xmlrpclib from xml.sax import saxutils # Note for extension authors: ONLY specify testedwith = 'internal' for # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should # be specifying the version(s) of Mercurial they are tested with, or # leave the attribute unspecified. testedwith = 'internal' socket_timeout = 30 # seconds if util.safehasattr(socket, 'setdefaulttimeout'): # set a timeout for the socket so you don't have to wait so looooong # when cia.vc is having problems. requires python >= 2.3: socket.setdefaulttimeout(socket_timeout) HGCIA_VERSION = '0.1' HGCIA_URL = 'http://hg.kublai.com/mercurial/hgcia' class ciamsg(object): """ A CIA message """ def __init__(self, cia, ctx): self.cia = cia self.ctx = ctx self.url = self.cia.url if self.url: self.url += self.cia.root def fileelem(self, path, uri, action): if uri: uri = ' uri=%s' % saxutils.quoteattr(uri) return '<file%s action=%s>%s</file>' % ( uri, saxutils.quoteattr(action), saxutils.escape(path)) def fileelems(self): n = self.ctx.node() f = self.cia.repo.status(self.ctx.p1().node(), n) url = self.url or '' if url and url[-1] == '/': url = url[:-1] elems = [] for path in f.modified: uri = '%s/diff/%s/%s' % (url, short(n), path) elems.append(self.fileelem(path, url and uri, 'modify')) for path in f.added: # TODO: copy/rename ? uri = '%s/file/%s/%s' % (url, short(n), path) elems.append(self.fileelem(path, url and uri, 'add')) for path in f.removed: elems.append(self.fileelem(path, '', 'remove')) return '\n'.join(elems) def sourceelem(self, project, module=None, branch=None): msg = ['<source>', '<project>%s</project>' % saxutils.escape(project)] if module: msg.append('<module>%s</module>' % saxutils.escape(module)) if branch: msg.append('<branch>%s</branch>' % saxutils.escape(branch)) msg.append('</source>') return '\n'.join(msg) def diffstat(self): class patchbuf(object): def __init__(self): self.lines = [] # diffstat is stupid self.name = 'cia' def write(self, data): self.lines += data.splitlines(True) def close(self): pass n = self.ctx.node() pbuf = patchbuf() cmdutil.export(self.cia.repo, [n], fp=pbuf) return patch.diffstat(pbuf.lines) or '' def logmsg(self): if self.cia.diffstat: diffstat = self.diffstat() else: diffstat = '' self.cia.ui.pushbuffer() self.cia.templater.show(self.ctx, changes=self.ctx.changeset(), baseurl=self.cia.ui.config('web', 'baseurl'), url=self.url, diffstat=diffstat, webroot=self.cia.root) return self.cia.ui.popbuffer() def xml(self): n = short(self.ctx.node()) src = self.sourceelem(self.cia.project, module=self.cia.module, branch=self.ctx.branch()) # unix timestamp dt = self.ctx.date() timestamp = dt[0] author = saxutils.escape(self.ctx.user()) rev = '%d:%s' % (self.ctx.rev(), n) log = saxutils.escape(self.logmsg()) url = self.url if url and url[-1] == '/': url = url[:-1] url = url and '<url>%s/rev/%s</url>' % (saxutils.escape(url), n) or '' msg = """ <message> <generator> <name>Mercurial (hgcia)</name> <version>%s</version> <url>%s</url> <user>%s</user> </generator> %s <body> <commit> <author>%s</author> <version>%s</version> <log>%s</log> %s <files>%s</files> </commit> </body> <timestamp>%d</timestamp> </message> """ % \ (HGCIA_VERSION, saxutils.escape(HGCIA_URL), saxutils.escape(self.cia.user), src, author, rev, log, url, self.fileelems(), timestamp) return msg class hgcia(object): """ CIA notification class """ deftemplate = '{desc}' dstemplate = '{desc}\n-- \n{diffstat}' def __init__(self, ui, repo): self.ui = ui self.repo = repo self.ciaurl = self.ui.config('cia', 'url', 'http://cia.vc') self.user = self.ui.config('cia', 'user') self.project = self.ui.config('cia', 'project') self.module = self.ui.config('cia', 'module') self.diffstat = self.ui.configbool('cia', 'diffstat') self.emailfrom = self.ui.config('email', 'from') self.dryrun = self.ui.configbool('cia', 'test') self.url = self.ui.config('web', 'baseurl') # Default to -1 for backward compatibility self.stripcount = int(self.ui.config('cia', 'strip', -1)) self.root = self.strip(self.repo.root) style = self.ui.config('cia', 'style') template = self.ui.config('cia', 'template') if not template: if self.diffstat: template = self.dstemplate else: template = self.deftemplate t = cmdutil.changeset_templater(self.ui, self.repo, False, None, template, style, False) self.templater = t def strip(self, path): '''strip leading slashes from local path, turn into web-safe path.''' path = util.pconvert(path) count = self.stripcount if count < 0: return '' while count > 0: c = path.find('/') if c == -1: break path = path[c + 1:] count -= 1 return path def sendrpc(self, msg): srv = xmlrpclib.Server(self.ciaurl) res = srv.hub.deliver(msg) if res is not True and res != 'queued.': raise error.Abort(_('%s returned an error: %s') % (self.ciaurl, res)) def sendemail(self, address, data): p = email.Parser.Parser() msg = p.parsestr(data) msg['Date'] = util.datestr(format="%a, %d %b %Y %H:%M:%S %1%2") msg['To'] = address msg['From'] = self.emailfrom msg['Subject'] = 'DeliverXML' msg['Content-type'] = 'text/xml' msgtext = msg.as_string() self.ui.status(_('hgcia: sending update to %s\n') % address) mail.sendmail(self.ui, util.email(self.emailfrom), [address], msgtext) def hook(ui, repo, hooktype, node=None, url=None, **kwargs): """ send CIA notification """ def sendmsg(cia, ctx): msg = ciamsg(cia, ctx).xml() if cia.dryrun: ui.write(msg) elif cia.ciaurl.startswith('mailto:'): if not cia.emailfrom: raise error.Abort(_('email.from must be defined when ' 'sending by email')) cia.sendemail(cia.ciaurl[7:], msg) else: cia.sendrpc(msg) n = bin(node) cia = hgcia(ui, repo) if not cia.user: ui.debug('cia: no user specified') return if not cia.project: ui.debug('cia: no project specified') return if hooktype == 'changegroup': start = repo.changelog.rev(n) end = len(repo.changelog) for rev in xrange(start, end): n = repo.changelog.node(rev) ctx = repo.changectx(n) sendmsg(cia, ctx) else: ctx = repo.changectx(n) sendmsg(cia, ctx)