← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/merge_directive.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge_directive.py
1
 
# Copyright (C) 2007 Canonical Ltd
 
1
# Copyright (C) 2007-2011 Canonical Ltd
2
2
#
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
12
12
#
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
16
16
 
 
17
from __future__ import absolute_import
17
18
 
18
19
from StringIO import StringIO
19
20
import re
20
21
 
 
22
from bzrlib import lazy_import
 
23
lazy_import.lazy_import(globals(), """
21
24
from bzrlib import (
22
25
    branch as _mod_branch,
23
26
    diff,
 
27
    email_message,
24
28
    errors,
25
29
    gpg,
 
30
    hooks,
26
31
    registry,
27
32
    revision as _mod_revision,
28
33
    rio,
29
34
    testament,
30
35
    timestamp,
 
36
    trace,
31
37
    )
32
38
from bzrlib.bundle import (
33
39
    serializer as bundle_serializer,
34
40
    )
35
 
from bzrlib.email_message import EmailMessage
36
 
 
37
 
 
38
 
class _BaseMergeDirective(object):
 
41
""")
 
42
 
 
43
 
 
44
class MergeRequestBodyParams(object):
 
45
    """Parameter object for the merge_request_body hook."""
 
46
 
 
47
    def __init__(self, body, orig_body, directive, to, basename, subject,
 
48
                 branch, tree=None):
 
49
        self.body = body
 
50
        self.orig_body = orig_body
 
51
        self.directive = directive
 
52
        self.branch = branch
 
53
        self.tree = tree
 
54
        self.to = to
 
55
        self.basename = basename
 
56
        self.subject = subject
 
57
 
 
58
 
 
59
class MergeDirectiveHooks(hooks.Hooks):
 
60
    """Hooks for MergeDirective classes."""
 
61
 
 
62
    def __init__(self):
 
63
        hooks.Hooks.__init__(self, "bzrlib.merge_directive", "BaseMergeDirective.hooks")
 
64
        self.add_hook('merge_request_body',
 
65
            "Called with a MergeRequestBodyParams when a body is needed for"
 
66
            " a merge request.  Callbacks must return a body.  If more"
 
67
            " than one callback is registered, the output of one callback is"
 
68
            " provided to the next.", (1, 15, 0))
 
69
 
 
70
 
 
71
class BaseMergeDirective(object):
 
72
    """A request to perform a merge into a branch.
 
73
 
 
74
    This is the base class that all merge directive implementations 
 
75
    should derive from.
 
76
 
 
77
    :cvar multiple_output_files: Whether or not this merge directive 
 
78
        stores a set of revisions in more than one file
 
79
    """
 
80
 
 
81
    hooks = MergeDirectiveHooks()
 
82
 
 
83
    multiple_output_files = False
39
84
 
40
85
    def __init__(self, revision_id, testament_sha1, time, timezone,
41
 
                 target_branch, patch=None, source_branch=None, message=None,
42
 
                 bundle=None):
 
86
                 target_branch, patch=None, source_branch=None,
 
87
                 message=None, bundle=None):
43
88
        """Constructor.
44
89
 
45
90
        :param revision_id: The revision to merge
47
92
            merge.
48
93
        :param time: The current POSIX timestamp time
49
94
        :param timezone: The timezone offset
50
 
        :param target_branch: The branch to apply the merge to
 
95
        :param target_branch: Location of branch to apply the merge to
51
96
        :param patch: The text of a diff or bundle
52
97
        :param source_branch: A public location to merge the revision from
53
98
        :param message: The message to use when committing this merge
61
106
        self.source_branch = source_branch
62
107
        self.message = message
63
108
 
 
109
    def to_lines(self):
 
110
        """Serialize as a list of lines
 
111
 
 
112
        :return: a list of lines
 
113
        """
 
114
        raise NotImplementedError(self.to_lines)
 
115
 
 
116
    def to_files(self):
 
117
        """Serialize as a set of files.
 
118
 
 
119
        :return: List of tuples with filename and contents as lines
 
120
        """
 
121
        raise NotImplementedError(self.to_files)
 
122
 
 
123
    def get_raw_bundle(self):
 
124
        """Return the bundle for this merge directive.
 
125
 
 
126
        :return: bundle text or None if there is no bundle
 
127
        """
 
128
        return None
 
129
 
64
130
    def _to_lines(self, base_revision=False):
65
131
        """Serialize as a list of lines
66
132
 
80
146
        lines.append('# \n')
81
147
        return lines
82
148
 
 
149
    def write_to_directory(self, path):
 
150
        """Write this merge directive to a series of files in a directory.
 
151
 
 
152
        :param path: Filesystem path to write to
 
153
        """
 
154
        raise NotImplementedError(self.write_to_directory)
 
155
 
83
156
    @classmethod
84
157
    def from_objects(klass, repository, revision_id, time, timezone,
85
158
                 target_branch, patch_type='bundle',
93
166
        :param target_branch: The url of the branch to merge into
94
167
        :param patch_type: 'bundle', 'diff' or None, depending on the type of
95
168
            patch desired.
96
 
        :param local_target_branch: a local copy of the target branch
97
 
        :param public_branch: location of a public branch containing the target
98
 
            revision.
 
169
        :param local_target_branch: the submit branch, either itself or a local copy
 
170
        :param public_branch: location of a public branch containing
 
171
            the target revision.
99
172
        :param message: Message to use when committing the merge
100
173
        :return: The merge directive
101
174
 
109
182
        if revision_id == _mod_revision.NULL_REVISION:
110
183
            t_revision_id = None
111
184
        t = testament.StrictTestament3.from_revision(repository, t_revision_id)
112
 
        submit_branch = _mod_branch.Branch.open(target_branch)
 
185
        if local_target_branch is None:
 
186
            submit_branch = _mod_branch.Branch.open(target_branch)
 
187
        else:
 
188
            submit_branch = local_target_branch
113
189
        if submit_branch.get_public_branch() is not None:
114
190
            target_branch = submit_branch.get_public_branch()
115
191
        if patch_type is None:
136
212
        return klass(revision_id, t.as_sha1(), time, timezone, target_branch,
137
213
            patch, patch_type, public_branch, message)
138
214
 
 
215
    def get_disk_name(self, branch):
 
216
        """Generate a suitable basename for storing this directive on disk
 
217
 
 
218
        :param branch: The Branch this merge directive was generated fro
 
219
        :return: A string
 
220
        """
 
221
        revno, revision_id = branch.last_revision_info()
 
222
        if self.revision_id == revision_id:
 
223
            revno = [revno]
 
224
        else:
 
225
            revno = branch.get_revision_id_to_revno_map().get(self.revision_id,
 
226
                ['merge'])
 
227
        nick = re.sub('(\W+)', '-', branch.nick).strip('-')
 
228
        return '%s-%s' % (nick, '.'.join(str(n) for n in revno))
 
229
 
139
230
    @staticmethod
140
231
    def _generate_diff(repository, revision_id, ancestor_id):
141
232
        tree_1 = repository.revision_tree(ancestor_id)
157
248
        :param branch: The source branch, to get the signing strategy
158
249
        :return: a string
159
250
        """
160
 
        my_gpg = gpg.GPGStrategy(branch.get_config())
 
251
        my_gpg = gpg.GPGStrategy(branch.get_config_stack())
161
252
        return my_gpg.sign(''.join(self.to_lines()))
162
253
 
163
254
    def to_email(self, mail_to, branch, sign=False):
169
260
        :param sign: If True, gpg-sign the email
170
261
        :return: an email message
171
262
        """
172
 
        mail_from = branch.get_config().username()
 
263
        mail_from = branch.get_config_stack().get('email')
173
264
        if self.message is not None:
174
265
            subject = self.message
175
266
        else:
179
270
            body = self.to_signed(branch)
180
271
        else:
181
272
            body = ''.join(self.to_lines())
182
 
        message = EmailMessage(mail_from, mail_to, subject, body)
 
273
        message = email_message.EmailMessage(mail_from, mail_to, subject,
 
274
            body)
183
275
        return message
184
276
 
185
277
    def install_revisions(self, target_repo):
195
287
                except errors.RevisionNotPresent:
196
288
                    # At least one dependency isn't present.  Try installing
197
289
                    # missing revisions from the submit branch
198
 
                    submit_branch = _mod_branch.Branch.open(self.target_branch)
 
290
                    try:
 
291
                        submit_branch = \
 
292
                            _mod_branch.Branch.open(self.target_branch)
 
293
                    except errors.NotBranchError:
 
294
                        raise errors.TargetNotBranch(self.target_branch)
199
295
                    missing_revisions = []
200
296
                    bundle_revisions = set(r.revision_id for r in
201
297
                                           info.real_revisions)
221
317
                target_repo.fetch(source_branch.repository, self.revision_id)
222
318
        return self.revision_id
223
319
 
224
 
 
225
 
class MergeDirective(_BaseMergeDirective):
 
320
    def compose_merge_request(self, mail_client, to, body, branch, tree=None):
 
321
        """Compose a request to merge this directive.
 
322
 
 
323
        :param mail_client: The mail client to use for composing this request.
 
324
        :param to: The address to compose the request to.
 
325
        :param branch: The Branch that was used to produce this directive.
 
326
        :param tree: The Tree (if any) for the Branch used to produce this
 
327
            directive.
 
328
        """
 
329
        basename = self.get_disk_name(branch)
 
330
        subject = '[MERGE] '
 
331
        if self.message is not None:
 
332
            subject += self.message
 
333
        else:
 
334
            revision = branch.repository.get_revision(self.revision_id)
 
335
            subject += revision.get_summary()
 
336
        if getattr(mail_client, 'supports_body', False):
 
337
            orig_body = body
 
338
            for hook in self.hooks['merge_request_body']:
 
339
                params = MergeRequestBodyParams(body, orig_body, self,
 
340
                                                to, basename, subject, branch,
 
341
                                                tree)
 
342
                body = hook(params)
 
343
        elif len(self.hooks['merge_request_body']) > 0:
 
344
            trace.warning('Cannot run merge_request_body hooks because mail'
 
345
                          ' client %s does not support message bodies.',
 
346
                        mail_client.__class__.__name__)
 
347
        mail_client.compose_merge_request(to, subject,
 
348
                                          ''.join(self.to_lines()),
 
349
                                          basename, body)
 
350
 
 
351
 
 
352
class MergeDirective(BaseMergeDirective):
226
353
 
227
354
    """A request to perform a merge into a branch.
228
355
 
250
377
            merge.
251
378
        :param time: The current POSIX timestamp time
252
379
        :param timezone: The timezone offset
253
 
        :param target_branch: The branch to apply the merge to
 
380
        :param target_branch: Location of the branch to apply the merge to
254
381
        :param patch: The text of a diff or bundle
255
382
        :param patch_type: None, "diff" or "bundle", depending on the contents
256
383
            of patch
257
384
        :param source_branch: A public location to merge the revision from
258
385
        :param message: The message to use when committing this merge
259
386
        """
260
 
        _BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
 
387
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
261
388
            timezone, target_branch, patch, source_branch, message)
262
 
        assert patch_type in (None, 'diff', 'bundle'), patch_type
 
389
        if patch_type not in (None, 'diff', 'bundle'):
 
390
            raise ValueError(patch_type)
263
391
        if patch_type != 'bundle' and source_branch is None:
264
392
            raise errors.NoMergeSource()
265
393
        if patch_type is not None and patch is None:
289
417
        :return: a MergeRequest
290
418
        """
291
419
        line_iter = iter(lines)
 
420
        firstline = ""
292
421
        for line in line_iter:
293
422
            if line.startswith('# Bazaar merge directive format '):
294
 
                break
295
 
        else:
296
 
            if len(lines) > 0:
297
 
                raise errors.NotAMergeDirective(lines[0])
298
 
            else:
299
 
                raise errors.NotAMergeDirective('')
300
 
        return _format_registry.get(line[2:].rstrip())._from_lines(line_iter)
 
423
                return _format_registry.get(line[2:].rstrip())._from_lines(
 
424
                    line_iter)
 
425
            firstline = firstline or line.strip()
 
426
        raise errors.NotAMergeDirective(firstline)
301
427
 
302
428
    @classmethod
303
429
    def _from_lines(klass, line_iter):
348
474
        return None, self.revision_id, 'inapplicable'
349
475
 
350
476
 
351
 
class MergeDirective2(_BaseMergeDirective):
 
477
class MergeDirective2(BaseMergeDirective):
352
478
 
353
479
    _format_string = 'Bazaar merge directive format 2 (Bazaar 0.90)'
354
480
 
357
483
                 bundle=None, base_revision_id=None):
358
484
        if source_branch is None and bundle is None:
359
485
            raise errors.NoMergeSource()
360
 
        _BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
 
486
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
361
487
            timezone, target_branch, patch, source_branch, message)
362
488
        self.bundle = bundle
363
489
        self.base_revision_id = base_revision_id
445
571
        :param target_branch: The url of the branch to merge into
446
572
        :param include_patch: If true, include a preview patch
447
573
        :param include_bundle: If true, include a bundle
448
 
        :param local_target_branch: a local copy of the target branch
449
 
        :param public_branch: location of a public branch containing the target
450
 
            revision.
 
574
        :param local_target_branch: the target branch, either itself or a local copy
 
575
        :param public_branch: location of a public branch containing
 
576
            the target revision.
451
577
        :param message: Message to use when committing the merge
452
578
        :return: The merge directive
453
579
 
466
592
                t_revision_id = None
467
593
            t = testament.StrictTestament3.from_revision(repository,
468
594
                t_revision_id)
469
 
            submit_branch = _mod_branch.Branch.open(target_branch)
 
595
            if local_target_branch is None:
 
596
                submit_branch = _mod_branch.Branch.open(target_branch)
 
597
            else:
 
598
                submit_branch = local_target_branch
470
599
            submit_branch.lock_read()
471
600
            locked.append(submit_branch)
472
601
            if submit_branch.get_public_branch() is not None:
500
629
                    revision_id):
501
630
                    raise errors.PublicBranchOutOfDate(public_branch,
502
631
                                                       revision_id)
 
632
            testament_sha1 = t.as_sha1()
503
633
        finally:
504
634
            for entry in reversed(locked):
505
635
                entry.unlock()
506
 
        return klass(revision_id, t.as_sha1(), time, timezone, target_branch,
507
 
            patch, public_branch, message, bundle, base_revision_id)
 
636
        return klass(revision_id, testament_sha1, time, timezone,
 
637
            target_branch, patch, public_branch, message, bundle,
 
638
            base_revision_id)
508
639
 
509
640
    def _verify_patch(self, repository):
510
641
        calculated_patch = self._generate_diff(repository, self.revision_id,
546
677
_format_registry = MergeDirectiveFormatRegistry()
547
678
_format_registry.register(MergeDirective)
548
679
_format_registry.register(MergeDirective2)
 
680
# 0.19 never existed.  It got renamed to 0.90.  But by that point, there were
 
681
# already merge directives in the wild that used 0.19. Registering with the old
 
682
# format string to retain compatibility with those merge directives.
549
683
_format_registry.register(MergeDirective2,
550
684
                          'Bazaar merge directive format 2 (Bazaar 0.19)')