1
# Copyright (C) 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
18
from email import Message
19
from StringIO import StringIO
22
branch as _mod_branch,
26
revision as _mod_revision,
31
from bzrlib.bundle import serializer as bundle_serializer
34
class MergeDirective(object):
36
"""A request to perform a merge into a branch.
38
Designed to be serialized and mailed. It provides all the information
39
needed to perform a merge automatically, by providing at minimum a revision
40
bundle or the location of a branch.
42
The serialization format is robust against certain common forms of
43
deterioration caused by mailing.
45
The format is also designed to be patch-compatible. If the directive
46
includes a diff or revision bundle, it should be possible to apply it
47
directly using the standard patch program.
50
_format_string = 'Bazaar merge directive format 1'
52
def __init__(self, revision_id, testament_sha1, time, timezone,
53
target_branch, patch=None, patch_type=None,
54
source_branch=None, message=None):
57
:param revision_id: The revision to merge
58
:param testament_sha1: The sha1 of the testament of the revision to
60
:param time: The current POSIX timestamp time
61
:param timezone: The timezone offset
62
:param target_branch: The branch to apply the merge to
63
:param patch: The text of a diff or bundle
64
:param patch_type: None, "diff" or "bundle", depending on the contents
66
:param source_branch: A public location to merge the revision from
67
:param message: The message to use when committing this merge
69
assert patch_type in (None, 'diff', 'bundle')
70
if patch_type != 'bundle' and source_branch is None:
71
raise errors.NoMergeSource()
72
if patch_type is not None and patch is None:
73
raise errors.PatchMissing(patch_type)
74
self.revision_id = revision_id
75
self.testament_sha1 = testament_sha1
77
self.timezone = timezone
78
self.target_branch = target_branch
80
self.patch_type = patch_type
81
self.source_branch = source_branch
82
self.message = message
85
def from_lines(klass, lines):
86
"""Deserialize a MergeRequest from an iterable of lines
88
:param lines: An iterable of lines
89
:return: a MergeRequest
91
assert lines[0].startswith('# ' + klass._format_string + '\n')
92
line_iter = iter(lines[1:])
93
stanza = rio.read_patch_stanza(line_iter)
94
patch_lines = list(line_iter)
95
if len(patch_lines) == 0:
98
patch = ''.join(patch_lines)
100
bundle_serializer.read_bundle(StringIO(patch))
101
except errors.NotABundle:
104
patch_type = 'bundle'
105
time, timezone = timestamp.parse_patch_date(stanza.get('timestamp'))
107
for key in ('revision_id', 'testament_sha1', 'target_branch',
108
'source_branch', 'message'):
110
kwargs[key] = stanza.get(key)
113
return MergeDirective(time=time, timezone=timezone,
114
patch_type=patch_type, patch=patch, **kwargs)
117
"""Serialize as a list of lines
119
:return: a list of lines
121
time_str = timestamp.format_patch_date(self.time, self.timezone)
122
stanza = rio.Stanza(revision_id=self.revision_id, timestamp=time_str,
123
target_branch=self.target_branch,
124
testament_sha1=self.testament_sha1)
125
for key in ('source_branch', 'message'):
126
if self.__dict__[key] is not None:
127
stanza.add(key, self.__dict__[key])
128
lines = ['# ' + self._format_string + '\n']
129
lines.extend(rio.to_patch_lines(stanza))
131
if self.patch is not None:
132
lines.extend(self.patch.splitlines(True))
135
def to_signed(self, branch):
136
"""Serialize as a signed string.
138
:param branch: The source branch, to get the signing strategy
141
my_gpg = gpg.GPGStrategy(branch.get_config())
142
return my_gpg.sign(''.join(self.to_lines()))
144
def to_email(self, mail_to, branch, sign=False):
145
"""Serialize as an email message.
147
:param mail_to: The address to mail the message to
148
:param branch: The source branch, to get the signing strategy and
150
:param sign: If True, gpg-sign the email
151
:return: an email message
153
mail_from = branch.get_config().username()
154
message = Message.Message()
155
message['To'] = mail_to
156
message['From'] = mail_from
157
if self.message is not None:
158
message['Subject'] = self.message
160
revision = branch.repository.get_revision(self.revision_id)
161
message['Subject'] = revision.message
163
body = self.to_signed(branch)
165
body = ''.join(self.to_lines())
166
message.set_payload(body)
170
def from_objects(klass, repository, revision_id, time, timezone,
171
target_branch, patch_type='bundle',
172
local_target_branch=None, public_branch=None, message=None):
173
"""Generate a merge directive from various objects
175
:param repository: The repository containing the revision
176
:param revision_id: The revision to merge
177
:param time: The POSIX timestamp of the date the request was issued.
178
:param timezone: The timezone of the request
179
:param target_branch: The url of the branch to merge into
180
:param patch_type: 'bundle', 'diff' or None, depending on the type of
182
:param local_target_branch: a local copy of the target branch
183
:param public_branch: location of a public branch containing the target
185
:param message: Message to use when committing the merge
186
:return: The merge directive
188
The public branch is always used if supplied. If the patch_type is
189
not 'bundle', the public branch must be supplied, and will be verified.
191
If the message is not supplied, the message from revision_id will be
194
t = testament.StrictTestament3.from_revision(repository, revision_id)
195
if patch_type is None:
198
submit_branch = _mod_branch.Branch.open(target_branch)
199
submit_revision_id = submit_branch.last_revision()
200
repository.fetch(submit_branch.repository, submit_revision_id)
201
ancestor_id = _mod_revision.common_ancestor(revision_id,
204
type_handler = {'bundle': klass._generate_bundle,
205
'diff': klass._generate_diff,
206
None: lambda x, y, z: None }
207
patch = type_handler[patch_type](repository, revision_id,
209
if patch_type == 'bundle':
211
bundle_serializer.write_bundle(repository, revision_id,
214
elif patch_type == 'diff':
215
patch = klass._generate_diff(repository, revision_id,
218
if public_branch is not None and patch_type != 'bundle':
219
public_branch_obj = _mod_branch.Branch.open(public_branch)
220
if not public_branch_obj.repository.has_revision(revision_id):
221
raise errors.PublicBranchOutOfDate(public_branch,
224
return MergeDirective(revision_id, t.as_sha1(), time, timezone,
225
target_branch, patch, patch_type, public_branch,
229
def _generate_diff(repository, revision_id, ancestor_id):
230
tree_1 = repository.revision_tree(ancestor_id)
231
tree_2 = repository.revision_tree(revision_id)
233
diff.show_diff_trees(tree_1, tree_2, s, old_label='', new_label='')
237
def _generate_bundle(repository, revision_id, ancestor_id):
239
bundle_serializer.write_bundle(repository, revision_id,
added
removed
bzrlib/merge_directive.py
