← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge_directive.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-05-12 00:15:25 UTC
  • mfrom: (4098.5.19 send-hookage)
  • Revision ID: pqm@pqm.ubuntu.com-20090512001525-dnk0gpt8n0h8rbvb
(abentley) add new merge_request_body hook

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge_directive.py
23
23
    diff,
24
24
    errors,
25
25
    gpg,
 
26
    hooks,
26
27
    registry,
27
28
    revision as _mod_revision,
28
29
    rio,
29
30
    testament,
30
31
    timestamp,
 
32
    trace,
31
33
    )
32
34
from bzrlib.bundle import (
33
35
    serializer as bundle_serializer,
35
37
from bzrlib.email_message import EmailMessage
36
38
 
37
39
 
 
40
class MergeRequestBodyParams(object):
 
41
    """Parameter object for the merge_request_body hook."""
 
42
 
 
43
    def __init__(self, body, orig_body, directive, to, basename, subject,
 
44
                 branch, tree=None):
 
45
        self.body = body
 
46
        self.orig_body = orig_body
 
47
        self.directive = directive
 
48
        self.branch = branch
 
49
        self.tree = tree
 
50
        self.to = to
 
51
        self.basename = basename
 
52
        self.subject = subject
 
53
 
 
54
 
 
55
class MergeDirectiveHooks(hooks.Hooks):
 
56
    """Hooks for MergeDirective classes."""
 
57
 
 
58
    def __init__(self):
 
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))
 
65
 
 
66
 
38
67
class _BaseMergeDirective(object):
39
68
 
 
69
    hooks = MergeDirectiveHooks()
 
70
 
40
71
    def __init__(self, revision_id, testament_sha1, time, timezone,
41
72
                 target_branch, patch=None, source_branch=None, message=None,
42
73
                 bundle=None):
240
271
                target_repo.fetch(source_branch.repository, self.revision_id)
241
272
        return self.revision_id
242
273
 
 
274
    def compose_merge_request(self, mail_client, to, body, branch, tree=None):
 
275
        """Compose a request to merge this directive.
 
276
 
 
277
        :param mail_client: The mail client to use for composing this request.
 
278
        :param to: The address to compose the request to.
 
279
        :param branch: The Branch that was used to produce this directive.
 
280
        :param tree: The Tree (if any) for the Branch used to produce this
 
281
            directive.
 
282
        """
 
283
        basename = self.get_disk_name(branch)
 
284
        subject = '[MERGE] '
 
285
        if self.message is not None:
 
286
            subject += self.message
 
287
        else:
 
288
            revision = branch.repository.get_revision(self.revision_id)
 
289
            subject += revision.get_summary()
 
290
        if getattr(mail_client, 'supports_body', False):
 
291
            orig_body = body
 
292
            for hook in self.hooks['merge_request_body']:
 
293
                params = MergeRequestBodyParams(body, orig_body, self,
 
294
                                                to, basename, subject, branch,
 
295
                                                tree)
 
296
                body = hook(params)
 
297
        elif len(self.hooks['merge_request_body']) > 0:
 
298
            trace.warning('Cannot run merge_request_body hooks because mail'
 
299
                          ' client %s does not support message bodies.',
 
300
                        mail_client.__class__.__name__)
 
301
        mail_client.compose_merge_request(to, subject,
 
302
                                          ''.join(self.to_lines()),
 
303
                                          basename, body)
 
304
 
243
305
 
244
306
class MergeDirective(_BaseMergeDirective):
245
307