1
# Copyright (C) 2007 Canonical Ltd
1
# Copyright (C) 2007-2010 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
from StringIO import StringIO
35
37
from bzrlib.email_message import EmailMessage
38
class _BaseMergeDirective(object):
40
class MergeRequestBodyParams(object):
41
"""Parameter object for the merge_request_body hook."""
43
def __init__(self, body, orig_body, directive, to, basename, subject,
46
self.orig_body = orig_body
47
self.directive = directive
51
self.basename = basename
52
self.subject = subject
55
class MergeDirectiveHooks(hooks.Hooks):
56
"""Hooks for MergeDirective classes."""
59
hooks.Hooks.__init__(self)
60
self.create_hook(hooks.HookPoint('merge_request_body',
61
"Called with a MergeRequestBodyParams when a body is needed for"
62
" a merge request. Callbacks must return a body. If more"
63
" than one callback is registered, the output of one callback is"
64
" provided to the next.", (1, 15, 0), False))
67
class BaseMergeDirective(object):
68
"""A request to perform a merge into a branch.
70
This is the base class that all merge directive implementations
73
:cvar multiple_output_files: Whether or not this merge directive
74
stores a set of revisions in more than one file
77
hooks = MergeDirectiveHooks()
79
multiple_output_files = False
40
81
def __init__(self, revision_id, testament_sha1, time, timezone,
41
82
target_branch, patch=None, source_branch=None, message=None,
61
102
self.source_branch = source_branch
62
103
self.message = message
106
"""Serialize as a list of lines
108
:return: a list of lines
110
raise NotImplementedError(self.to_lines)
113
"""Serialize as a set of files.
115
:return: List of tuples with filename and contents as lines
117
raise NotImplementedError(self.to_files)
119
def get_raw_bundle(self):
120
"""Return the bundle for this merge directive.
122
:return: bundle text or None if there is no bundle
64
126
def _to_lines(self, base_revision=False):
65
127
"""Serialize as a list of lines
80
142
lines.append('# \n')
145
def write_to_directory(self, path):
146
"""Write this merge directive to a series of files in a directory.
148
:param path: Filesystem path to write to
150
raise NotImplementedError(self.write_to_directory)
84
153
def from_objects(klass, repository, revision_id, time, timezone,
85
154
target_branch, patch_type='bundle',
149
218
revno = branch.get_revision_id_to_revno_map().get(self.revision_id,
151
return '%s-%s' % (branch.nick, '.'.join(str(n) for n in revno))
220
nick = re.sub('(\W+)', '-', branch.nick).strip('-')
221
return '%s-%s' % (nick, '.'.join(str(n) for n in revno))
154
224
def _generate_diff(repository, revision_id, ancestor_id):
209
279
except errors.RevisionNotPresent:
210
280
# At least one dependency isn't present. Try installing
211
281
# missing revisions from the submit branch
212
submit_branch = _mod_branch.Branch.open(self.target_branch)
284
_mod_branch.Branch.open(self.target_branch)
285
except errors.NotBranchError:
286
raise errors.TargetNotBranch(self.target_branch)
213
287
missing_revisions = []
214
288
bundle_revisions = set(r.revision_id for r in
215
289
info.real_revisions)
235
309
target_repo.fetch(source_branch.repository, self.revision_id)
236
310
return self.revision_id
239
class MergeDirective(_BaseMergeDirective):
312
def compose_merge_request(self, mail_client, to, body, branch, tree=None):
313
"""Compose a request to merge this directive.
315
:param mail_client: The mail client to use for composing this request.
316
:param to: The address to compose the request to.
317
:param branch: The Branch that was used to produce this directive.
318
:param tree: The Tree (if any) for the Branch used to produce this
321
basename = self.get_disk_name(branch)
323
if self.message is not None:
324
subject += self.message
326
revision = branch.repository.get_revision(self.revision_id)
327
subject += revision.get_summary()
328
if getattr(mail_client, 'supports_body', False):
330
for hook in self.hooks['merge_request_body']:
331
params = MergeRequestBodyParams(body, orig_body, self,
332
to, basename, subject, branch,
335
elif len(self.hooks['merge_request_body']) > 0:
336
trace.warning('Cannot run merge_request_body hooks because mail'
337
' client %s does not support message bodies.',
338
mail_client.__class__.__name__)
339
mail_client.compose_merge_request(to, subject,
340
''.join(self.to_lines()),
344
class MergeDirective(BaseMergeDirective):
241
346
"""A request to perform a merge into a branch.
271
376
:param source_branch: A public location to merge the revision from
272
377
:param message: The message to use when committing this merge
274
_BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
379
BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
275
380
timezone, target_branch, patch, source_branch, message)
276
assert patch_type in (None, 'diff', 'bundle'), patch_type
381
if patch_type not in (None, 'diff', 'bundle'):
382
raise ValueError(patch_type)
277
383
if patch_type != 'bundle' and source_branch is None:
278
384
raise errors.NoMergeSource()
279
385
if patch_type is not None and patch is None:
303
409
:return: a MergeRequest
305
411
line_iter = iter(lines)
306
413
for line in line_iter:
307
414
if line.startswith('# Bazaar merge directive format '):
311
raise errors.NotAMergeDirective(lines[0])
313
raise errors.NotAMergeDirective('')
314
return _format_registry.get(line[2:].rstrip())._from_lines(line_iter)
415
return _format_registry.get(line[2:].rstrip())._from_lines(
417
firstline = firstline or line.strip()
418
raise errors.NotAMergeDirective(firstline)
317
421
def _from_lines(klass, line_iter):
362
466
return None, self.revision_id, 'inapplicable'
365
class MergeDirective2(_BaseMergeDirective):
469
class MergeDirective2(BaseMergeDirective):
367
471
_format_string = 'Bazaar merge directive format 2 (Bazaar 0.90)'
371
475
bundle=None, base_revision_id=None):
372
476
if source_branch is None and bundle is None:
373
477
raise errors.NoMergeSource()
374
_BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
478
BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
375
479
timezone, target_branch, patch, source_branch, message)
376
480
self.bundle = bundle
377
481
self.base_revision_id = base_revision_id
515
619
raise errors.PublicBranchOutOfDate(public_branch,
621
testament_sha1 = t.as_sha1()
518
623
for entry in reversed(locked):
520
return klass(revision_id, t.as_sha1(), time, timezone, target_branch,
521
patch, public_branch, message, bundle, base_revision_id)
625
return klass(revision_id, testament_sha1, time, timezone,
626
target_branch, patch, public_branch, message, bundle,
523
629
def _verify_patch(self, repository):
524
630
calculated_patch = self._generate_diff(repository, self.revision_id,
560
666
_format_registry = MergeDirectiveFormatRegistry()
561
667
_format_registry.register(MergeDirective)
562
668
_format_registry.register(MergeDirective2)
669
# 0.19 never existed. It got renamed to 0.90. But by that point, there were
670
# already merge directives in the wild that used 0.19. Registering with the old
671
# format string to retain compatibility with those merge directives.
563
672
_format_registry.register(MergeDirective2,
564
673
'Bazaar merge directive format 2 (Bazaar 0.19)')
added
removed
bzrlib/merge_directive.py
