/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/merge_directive.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/merge_directive.py
1
 
# Copyright (C) 2007-2011 Canonical Ltd
 
1
# Copyright (C) 2007-2010 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
17
 
19
 
import base64
 
18
from StringIO import StringIO
20
19
import re
21
20
 
22
 
from . import lazy_import
23
 
lazy_import.lazy_import(globals(), """
24
 
from breezy import (
 
21
from bzrlib import (
25
22
    branch as _mod_branch,
26
 
    cleanup,
27
23
    diff,
28
 
    email_message,
 
24
    errors,
29
25
    gpg,
30
26
    hooks,
31
27
    registry,
32
28
    revision as _mod_revision,
33
29
    rio,
 
30
    testament,
34
31
    timestamp,
35
32
    trace,
36
33
    )
37
 
from breezy.bzr import (
38
 
    testament,
39
 
    )
40
 
from breezy.bzr.bundle import (
 
34
from bzrlib.bundle import (
41
35
    serializer as bundle_serializer,
42
36
    )
43
 
""")
44
 
from . import (
45
 
    errors,
46
 
    )
47
 
from .sixish import (
48
 
    BytesIO,
49
 
    )
 
37
from bzrlib.email_message import EmailMessage
50
38
 
51
39
 
52
40
class MergeRequestBodyParams(object):
68
56
    """Hooks for MergeDirective classes."""
69
57
 
70
58
    def __init__(self):
71
 
        hooks.Hooks.__init__(self, "breezy.merge_directive",
72
 
                             "BaseMergeDirective.hooks")
73
 
        self.add_hook(
74
 
            'merge_request_body',
 
59
        hooks.Hooks.__init__(self)
 
60
        self.create_hook(hooks.HookPoint('merge_request_body',
75
61
            "Called with a MergeRequestBodyParams when a body is needed for"
76
62
            " a merge request.  Callbacks must return a body.  If more"
77
63
            " than one callback is registered, the output of one callback is"
78
 
            " provided to the next.", (1, 15, 0))
 
64
            " provided to the next.", (1, 15, 0), False))
79
65
 
80
66
 
81
67
class BaseMergeDirective(object):
82
68
    """A request to perform a merge into a branch.
83
69
 
84
 
    This is the base class that all merge directive implementations
 
70
    This is the base class that all merge directive implementations 
85
71
    should derive from.
86
72
 
87
 
    :cvar multiple_output_files: Whether or not this merge directive
 
73
    :cvar multiple_output_files: Whether or not this merge directive 
88
74
        stores a set of revisions in more than one file
89
75
    """
90
76
 
93
79
    multiple_output_files = False
94
80
 
95
81
    def __init__(self, revision_id, testament_sha1, time, timezone,
96
 
                 target_branch, patch=None, source_branch=None,
97
 
                 message=None, bundle=None):
 
82
                 target_branch, patch=None, source_branch=None, message=None,
 
83
                 bundle=None):
98
84
        """Constructor.
99
85
 
100
86
        :param revision_id: The revision to merge
102
88
            merge.
103
89
        :param time: The current POSIX timestamp time
104
90
        :param timezone: The timezone offset
105
 
        :param target_branch: Location of branch to apply the merge to
 
91
        :param target_branch: The branch to apply the merge to
106
92
        :param patch: The text of a diff or bundle
107
93
        :param source_branch: A public location to merge the revision from
108
94
        :param message: The message to use when committing this merge
151
137
                stanza.add(key, self.__dict__[key])
152
138
        if base_revision:
153
139
            stanza.add('base_revision_id', self.base_revision_id)
154
 
        lines = [b'# ' + self._format_string + b'\n']
 
140
        lines = ['# ' + self._format_string + '\n']
155
141
        lines.extend(rio.to_patch_lines(stanza))
156
 
        lines.append(b'# \n')
 
142
        lines.append('# \n')
157
143
        return lines
158
144
 
159
145
    def write_to_directory(self, path):
165
151
 
166
152
    @classmethod
167
153
    def from_objects(klass, repository, revision_id, time, timezone,
168
 
                     target_branch, patch_type='bundle',
169
 
                     local_target_branch=None, public_branch=None, message=None):
 
154
                 target_branch, patch_type='bundle',
 
155
                 local_target_branch=None, public_branch=None, message=None):
170
156
        """Generate a merge directive from various objects
171
157
 
172
158
        :param repository: The repository containing the revision
176
162
        :param target_branch: The url of the branch to merge into
177
163
        :param patch_type: 'bundle', 'diff' or None, depending on the type of
178
164
            patch desired.
179
 
        :param local_target_branch: the submit branch, either itself or a local copy
180
 
        :param public_branch: location of a public branch containing
181
 
            the target revision.
 
165
        :param local_target_branch: a local copy of the target branch
 
166
        :param public_branch: location of a public branch containing the target
 
167
            revision.
182
168
        :param message: Message to use when committing the merge
183
169
        :return: The merge directive
184
170
 
192
178
        if revision_id == _mod_revision.NULL_REVISION:
193
179
            t_revision_id = None
194
180
        t = testament.StrictTestament3.from_revision(repository, t_revision_id)
195
 
        if local_target_branch is None:
196
 
            submit_branch = _mod_branch.Branch.open(target_branch)
197
 
        else:
198
 
            submit_branch = local_target_branch
 
181
        submit_branch = _mod_branch.Branch.open(target_branch)
199
182
        if submit_branch.get_public_branch() is not None:
200
183
            target_branch = submit_branch.get_public_branch()
201
184
        if patch_type is None:
209
192
                                                submit_revision_id)
210
193
            type_handler = {'bundle': klass._generate_bundle,
211
194
                            'diff': klass._generate_diff,
212
 
                            None: lambda x, y, z: None}
 
195
                            None: lambda x, y, z: None }
213
196
            patch = type_handler[patch_type](repository, revision_id,
214
197
                                             ancestor_id)
215
198
 
220
203
                                                   revision_id)
221
204
 
222
205
        return klass(revision_id, t.as_sha1(), time, timezone, target_branch,
223
 
                     patch, patch_type, public_branch, message)
 
206
            patch, patch_type, public_branch, message)
224
207
 
225
208
    def get_disk_name(self, branch):
226
209
        """Generate a suitable basename for storing this directive on disk
232
215
        if self.revision_id == revision_id:
233
216
            revno = [revno]
234
217
        else:
235
 
            try:
236
 
                revno = branch.revision_id_to_dotted_revno(self.revision_id)
237
 
            except errors.NoSuchRevision:
238
 
                revno = ['merge']
239
 
        nick = re.sub('(\\W+)', '-', branch.nick).strip('-')
 
218
            revno = branch.get_revision_id_to_revno_map().get(self.revision_id,
 
219
                ['merge'])
 
220
        nick = re.sub('(\W+)', '-', branch.nick).strip('-')
240
221
        return '%s-%s' % (nick, '.'.join(str(n) for n in revno))
241
222
 
242
223
    @staticmethod
243
224
    def _generate_diff(repository, revision_id, ancestor_id):
244
225
        tree_1 = repository.revision_tree(ancestor_id)
245
226
        tree_2 = repository.revision_tree(revision_id)
246
 
        s = BytesIO()
 
227
        s = StringIO()
247
228
        diff.show_diff_trees(tree_1, tree_2, s, old_label='', new_label='')
248
229
        return s.getvalue()
249
230
 
250
231
    @staticmethod
251
232
    def _generate_bundle(repository, revision_id, ancestor_id):
252
 
        s = BytesIO()
 
233
        s = StringIO()
253
234
        bundle_serializer.write_bundle(repository, revision_id,
254
235
                                       ancestor_id, s)
255
236
        return s.getvalue()
260
241
        :param branch: The source branch, to get the signing strategy
261
242
        :return: a string
262
243
        """
263
 
        my_gpg = gpg.GPGStrategy(branch.get_config_stack())
264
 
        return my_gpg.sign(b''.join(self.to_lines()), gpg.MODE_CLEAR)
 
244
        my_gpg = gpg.GPGStrategy(branch.get_config())
 
245
        return my_gpg.sign(''.join(self.to_lines()))
265
246
 
266
247
    def to_email(self, mail_to, branch, sign=False):
267
248
        """Serialize as an email message.
272
253
        :param sign: If True, gpg-sign the email
273
254
        :return: an email message
274
255
        """
275
 
        mail_from = branch.get_config_stack().get('email')
 
256
        mail_from = branch.get_config().username()
276
257
        if self.message is not None:
277
258
            subject = self.message
278
259
        else:
281
262
        if sign:
282
263
            body = self.to_signed(branch)
283
264
        else:
284
 
            body = b''.join(self.to_lines())
285
 
        message = email_message.EmailMessage(mail_from, mail_to, subject,
286
 
                                             body)
 
265
            body = ''.join(self.to_lines())
 
266
        message = EmailMessage(mail_from, mail_to, subject, body)
287
267
        return message
288
268
 
289
269
    def install_revisions(self, target_repo):
291
271
        if not target_repo.has_revision(self.revision_id):
292
272
            if self.patch_type == 'bundle':
293
273
                info = bundle_serializer.read_bundle(
294
 
                    BytesIO(self.get_raw_bundle()))
 
274
                    StringIO(self.get_raw_bundle()))
295
275
                # We don't use the bundle's target revision, because
296
276
                # MergeDirective.revision_id is authoritative.
297
277
                try:
309
289
                                           info.real_revisions)
310
290
                    for revision in info.real_revisions:
311
291
                        for parent_id in revision.parent_ids:
312
 
                            if (parent_id not in bundle_revisions
313
 
                                    and not target_repo.has_revision(parent_id)):
 
292
                            if (parent_id not in bundle_revisions and
 
293
                                not target_repo.has_revision(parent_id)):
314
294
                                missing_revisions.append(parent_id)
315
295
                    # reverse missing revisions to try to get heads first
316
296
                    unique_missing = []
355
335
        elif len(self.hooks['merge_request_body']) > 0:
356
336
            trace.warning('Cannot run merge_request_body hooks because mail'
357
337
                          ' client %s does not support message bodies.',
358
 
                          mail_client.__class__.__name__)
 
338
                        mail_client.__class__.__name__)
359
339
        mail_client.compose_merge_request(to, subject,
360
 
                                          b''.join(self.to_lines()),
 
340
                                          ''.join(self.to_lines()),
361
341
                                          basename, body)
362
342
 
363
343
 
377
357
    directly using the standard patch program.
378
358
    """
379
359
 
380
 
    _format_string = b'Bazaar merge directive format 1'
 
360
    _format_string = 'Bazaar merge directive format 1'
381
361
 
382
362
    def __init__(self, revision_id, testament_sha1, time, timezone,
383
363
                 target_branch, patch=None, patch_type=None,
389
369
            merge.
390
370
        :param time: The current POSIX timestamp time
391
371
        :param timezone: The timezone offset
392
 
        :param target_branch: Location of the branch to apply the merge to
 
372
        :param target_branch: The branch to apply the merge to
393
373
        :param patch: The text of a diff or bundle
394
374
        :param patch_type: None, "diff" or "bundle", depending on the contents
395
375
            of patch
397
377
        :param message: The message to use when committing this merge
398
378
        """
399
379
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
400
 
                                    timezone, target_branch, patch, source_branch, message)
 
380
            timezone, target_branch, patch, source_branch, message)
401
381
        if patch_type not in (None, 'diff', 'bundle'):
402
382
            raise ValueError(patch_type)
403
383
        if patch_type != 'bundle' and source_branch is None:
429
409
        :return: a MergeRequest
430
410
        """
431
411
        line_iter = iter(lines)
432
 
        firstline = b""
 
412
        firstline = ""
433
413
        for line in line_iter:
434
 
            if line.startswith(b'# Bazaar merge directive format '):
 
414
            if line.startswith('# Bazaar merge directive format '):
435
415
                return _format_registry.get(line[2:].rstrip())._from_lines(
436
416
                    line_iter)
437
417
            firstline = firstline or line.strip()
445
425
            patch = None
446
426
            patch_type = None
447
427
        else:
448
 
            patch = b''.join(patch_lines)
 
428
            patch = ''.join(patch_lines)
449
429
            try:
450
 
                bundle_serializer.read_bundle(BytesIO(patch))
 
430
                bundle_serializer.read_bundle(StringIO(patch))
451
431
            except (errors.NotABundle, errors.BundleNotSupported,
452
432
                    errors.BadBundle):
453
433
                patch_type = 'diff'
462
442
            except KeyError:
463
443
                pass
464
444
        kwargs['revision_id'] = kwargs['revision_id'].encode('utf-8')
465
 
        if 'testament_sha1' in kwargs:
466
 
            kwargs['testament_sha1'] = kwargs['testament_sha1'].encode('ascii')
467
445
        return MergeDirective(time=time, timezone=timezone,
468
446
                              patch_type=patch_type, patch=patch, **kwargs)
469
447
 
475
453
 
476
454
    @staticmethod
477
455
    def _generate_bundle(repository, revision_id, ancestor_id):
478
 
        s = BytesIO()
 
456
        s = StringIO()
479
457
        bundle_serializer.write_bundle(repository, revision_id,
480
458
                                       ancestor_id, s, '0.9')
481
459
        return s.getvalue()
490
468
 
491
469
class MergeDirective2(BaseMergeDirective):
492
470
 
493
 
    _format_string = b'Bazaar merge directive format 2 (Bazaar 0.90)'
 
471
    _format_string = 'Bazaar merge directive format 2 (Bazaar 0.90)'
494
472
 
495
473
    def __init__(self, revision_id, testament_sha1, time, timezone,
496
474
                 target_branch, patch=None, source_branch=None, message=None,
498
476
        if source_branch is None and bundle is None:
499
477
            raise errors.NoMergeSource()
500
478
        BaseMergeDirective.__init__(self, revision_id, testament_sha1, time,
501
 
                                    timezone, target_branch, patch, source_branch, message)
 
479
            timezone, target_branch, patch, source_branch, message)
502
480
        self.bundle = bundle
503
481
        self.base_revision_id = base_revision_id
504
482
 
520
498
        if self.bundle is None:
521
499
            return None
522
500
        else:
523
 
            return base64.b64decode(self.bundle)
 
501
            return self.bundle.decode('base-64')
524
502
 
525
503
    @classmethod
526
504
    def _from_lines(klass, line_iter):
528
506
        patch = None
529
507
        bundle = None
530
508
        try:
531
 
            start = next(line_iter)
 
509
            start = line_iter.next()
532
510
        except StopIteration:
533
511
            pass
534
512
        else:
535
 
            if start.startswith(b'# Begin patch'):
 
513
            if start.startswith('# Begin patch'):
536
514
                patch_lines = []
537
515
                for line in line_iter:
538
 
                    if line.startswith(b'# Begin bundle'):
 
516
                    if line.startswith('# Begin bundle'):
539
517
                        start = line
540
518
                        break
541
519
                    patch_lines.append(line)
542
520
                else:
543
521
                    start = None
544
 
                patch = b''.join(patch_lines)
 
522
                patch = ''.join(patch_lines)
545
523
            if start is not None:
546
 
                if start.startswith(b'# Begin bundle'):
547
 
                    bundle = b''.join(line_iter)
 
524
                if start.startswith('# Begin bundle'):
 
525
                    bundle = ''.join(line_iter)
548
526
                else:
549
527
                    raise errors.IllegalMergeDirectivePayload(start)
550
528
        time, timezone = timestamp.parse_patch_date(stanza.get('timestamp'))
558
536
        kwargs['revision_id'] = kwargs['revision_id'].encode('utf-8')
559
537
        kwargs['base_revision_id'] =\
560
538
            kwargs['base_revision_id'].encode('utf-8')
561
 
        if 'testament_sha1' in kwargs:
562
 
            kwargs['testament_sha1'] = kwargs['testament_sha1'].encode('ascii')
563
539
        return klass(time=time, timezone=timezone, patch=patch, bundle=bundle,
564
540
                     **kwargs)
565
541
 
566
542
    def to_lines(self):
567
543
        lines = self._to_lines(base_revision=True)
568
544
        if self.patch is not None:
569
 
            lines.append(b'# Begin patch\n')
 
545
            lines.append('# Begin patch\n')
570
546
            lines.extend(self.patch.splitlines(True))
571
547
        if self.bundle is not None:
572
 
            lines.append(b'# Begin bundle\n')
 
548
            lines.append('# Begin bundle\n')
573
549
            lines.extend(self.bundle.splitlines(True))
574
550
        return lines
575
551
 
576
552
    @classmethod
577
553
    def from_objects(klass, repository, revision_id, time, timezone,
578
 
                     target_branch, include_patch=True, include_bundle=True,
579
 
                     local_target_branch=None, public_branch=None, message=None,
580
 
                     base_revision_id=None):
 
554
                 target_branch, include_patch=True, include_bundle=True,
 
555
                 local_target_branch=None, public_branch=None, message=None,
 
556
                 base_revision_id=None):
581
557
        """Generate a merge directive from various objects
582
558
 
583
559
        :param repository: The repository containing the revision
587
563
        :param target_branch: The url of the branch to merge into
588
564
        :param include_patch: If true, include a preview patch
589
565
        :param include_bundle: If true, include a bundle
590
 
        :param local_target_branch: the target branch, either itself or a local copy
591
 
        :param public_branch: location of a public branch containing
592
 
            the target revision.
 
566
        :param local_target_branch: a local copy of the target branch
 
567
        :param public_branch: location of a public branch containing the target
 
568
            revision.
593
569
        :param message: Message to use when committing the merge
594
570
        :return: The merge directive
595
571
 
599
575
        If the message is not supplied, the message from revision_id will be
600
576
        used for the commit.
601
577
        """
602
 
        with cleanup.ExitStack() as exit_stack:
603
 
            exit_stack.enter_context(repository.lock_write())
 
578
        locked = []
 
579
        try:
 
580
            repository.lock_write()
 
581
            locked.append(repository)
604
582
            t_revision_id = revision_id
605
 
            if revision_id == b'null:':
 
583
            if revision_id == 'null:':
606
584
                t_revision_id = None
607
585
            t = testament.StrictTestament3.from_revision(repository,
608
 
                                                         t_revision_id)
609
 
            if local_target_branch is None:
610
 
                submit_branch = _mod_branch.Branch.open(target_branch)
611
 
            else:
612
 
                submit_branch = local_target_branch
613
 
            exit_stack.enter_context(submit_branch.lock_read())
 
586
                t_revision_id)
 
587
            submit_branch = _mod_branch.Branch.open(target_branch)
 
588
            submit_branch.lock_read()
 
589
            locked.append(submit_branch)
614
590
            if submit_branch.get_public_branch() is not None:
615
591
                target_branch = submit_branch.get_public_branch()
616
592
            submit_revision_id = submit_branch.last_revision()
629
605
                patch = None
630
606
 
631
607
            if include_bundle:
632
 
                bundle = base64.b64encode(klass._generate_bundle(repository, revision_id,
633
 
                                                                 ancestor_id))
 
608
                bundle = klass._generate_bundle(repository, revision_id,
 
609
                    ancestor_id).encode('base-64')
634
610
            else:
635
611
                bundle = None
636
612
 
637
613
            if public_branch is not None and not include_bundle:
638
614
                public_branch_obj = _mod_branch.Branch.open(public_branch)
639
 
                exit_stack.enter_context(public_branch_obj.lock_read())
 
615
                public_branch_obj.lock_read()
 
616
                locked.append(public_branch_obj)
640
617
                if not public_branch_obj.repository.has_revision(
641
 
                        revision_id):
 
618
                    revision_id):
642
619
                    raise errors.PublicBranchOutOfDate(public_branch,
643
620
                                                       revision_id)
644
621
            testament_sha1 = t.as_sha1()
 
622
        finally:
 
623
            for entry in reversed(locked):
 
624
                entry.unlock()
645
625
        return klass(revision_id, testament_sha1, time, timezone,
646
 
                     target_branch, patch, public_branch, message, bundle,
647
 
                     base_revision_id)
 
626
            target_branch, patch, public_branch, message, bundle,
 
627
            base_revision_id)
648
628
 
649
629
    def _verify_patch(self, repository):
650
630
        calculated_patch = self._generate_diff(repository, self.revision_id,
651
631
                                               self.base_revision_id)
652
632
        # Convert line-endings to UNIX
653
 
        stored_patch = re.sub(b'\r\n?', b'\n', self.patch)
654
 
        calculated_patch = re.sub(b'\r\n?', b'\n', calculated_patch)
 
633
        stored_patch = re.sub('\r\n?', '\n', self.patch)
 
634
        calculated_patch = re.sub('\r\n?', '\n', calculated_patch)
655
635
        # Strip trailing whitespace
656
 
        calculated_patch = re.sub(b' *\n', b'\n', calculated_patch)
657
 
        stored_patch = re.sub(b' *\n', b'\n', stored_patch)
 
636
        calculated_patch = re.sub(' *\n', '\n', calculated_patch)
 
637
        stored_patch = re.sub(' *\n', '\n', stored_patch)
658
638
        return (calculated_patch == stored_patch)
659
639
 
660
640
    def get_merge_request(self, repository):
690
670
# already merge directives in the wild that used 0.19. Registering with the old
691
671
# format string to retain compatibility with those merge directives.
692
672
_format_registry.register(MergeDirective2,
693
 
                          b'Bazaar merge directive format 2 (Bazaar 0.19)')
 
673
                          'Bazaar merge directive format 2 (Bazaar 0.19)')