~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/send.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-12 16:32:06 UTC
  • mfrom: (5031.2.2 checkouts-help)
  • Revision ID: pqm@pqm.ubuntu.com-20100212163206-uvs9ck67uqw2901y
(Matthew Fuller) Update docs for using 'switch' with a checkout

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2009, 2010 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
 
 
18
import time
 
19
 
 
20
from bzrlib import (
 
21
    bzrdir,
 
22
    errors,
 
23
    osutils,
 
24
    registry,
 
25
    trace,
 
26
    )
 
27
from bzrlib.branch import (
 
28
    Branch,
 
29
    )
 
30
from bzrlib.revision import (
 
31
    NULL_REVISION,
 
32
    )
 
33
 
 
34
 
 
35
format_registry = registry.Registry()
 
36
 
 
37
 
 
38
def send(submit_branch, revision, public_branch, remember, format,
 
39
         no_bundle, no_patch, output, from_, mail_to, message, body,
 
40
         to_file, strict=None):
 
41
    tree, branch = bzrdir.BzrDir.open_containing_tree_or_branch(from_)[:2]
 
42
    # we may need to write data into branch's repository to calculate
 
43
    # the data to send.
 
44
    branch.lock_write()
 
45
    try:
 
46
        if output is None:
 
47
            config = branch.get_config()
 
48
            if mail_to is None:
 
49
                mail_to = config.get_user_option('submit_to')
 
50
            mail_client = config.get_mail_client()
 
51
            if (not getattr(mail_client, 'supports_body', False)
 
52
                and body is not None):
 
53
                raise errors.BzrCommandError(
 
54
                    'Mail client "%s" does not support specifying body' %
 
55
                    mail_client.__class__.__name__)
 
56
        if remember and submit_branch is None:
 
57
            raise errors.BzrCommandError(
 
58
                '--remember requires a branch to be specified.')
 
59
        stored_submit_branch = branch.get_submit_branch()
 
60
        remembered_submit_branch = None
 
61
        if submit_branch is None:
 
62
            submit_branch = stored_submit_branch
 
63
            remembered_submit_branch = "submit"
 
64
        else:
 
65
            if stored_submit_branch is None or remember:
 
66
                branch.set_submit_branch(submit_branch)
 
67
        if submit_branch is None:
 
68
            submit_branch = branch.get_parent()
 
69
            remembered_submit_branch = "parent"
 
70
        if submit_branch is None:
 
71
            raise errors.BzrCommandError('No submit branch known or'
 
72
                                         ' specified')
 
73
        if remembered_submit_branch is not None:
 
74
            trace.note('Using saved %s location "%s" to determine what '
 
75
                       'changes to submit.', remembered_submit_branch,
 
76
                       submit_branch)
 
77
 
 
78
        if mail_to is None or format is None:
 
79
            # TODO: jam 20090716 we open the submit_branch here, but we *don't*
 
80
            #       pass it down into the format creation, so it will have to
 
81
            #       open it again
 
82
            submit_br = Branch.open(submit_branch)
 
83
            submit_config = submit_br.get_config()
 
84
            if mail_to is None:
 
85
                mail_to = submit_config.get_user_option("child_submit_to")
 
86
            if format is None:
 
87
                formatname = submit_br.get_child_submit_format()
 
88
                try:
 
89
                    format = format_registry.get(formatname)
 
90
                except KeyError:
 
91
                    raise errors.BzrCommandError("No such send format '%s'." % 
 
92
                                                 formatname)
 
93
 
 
94
        stored_public_branch = branch.get_public_branch()
 
95
        if public_branch is None:
 
96
            public_branch = stored_public_branch
 
97
        elif stored_public_branch is None or remember:
 
98
            branch.set_public_branch(public_branch)
 
99
        if no_bundle and public_branch is None:
 
100
            raise errors.BzrCommandError('No public branch specified or'
 
101
                                         ' known')
 
102
        base_revision_id = None
 
103
        revision_id = None
 
104
        if revision is not None:
 
105
            if len(revision) > 2:
 
106
                raise errors.BzrCommandError('bzr send takes '
 
107
                    'at most two one revision identifiers')
 
108
            revision_id = revision[-1].as_revision_id(branch)
 
109
            if len(revision) == 2:
 
110
                base_revision_id = revision[0].as_revision_id(branch)
 
111
        if revision_id is None:
 
112
            if strict is None:
 
113
                strict = branch.get_config(
 
114
                    ).get_user_option_as_bool('send_strict')
 
115
            if strict is None: strict = True # default value
 
116
            if strict and tree is not None:
 
117
                if (tree.has_changes()):
 
118
                    raise errors.UncommittedChanges(
 
119
                        tree, more='Use --no-strict to force the send.')
 
120
                if tree.last_revision() != tree.branch.last_revision():
 
121
                    # The tree has lost sync with its branch, there is little
 
122
                    # chance that the user is aware of it but he can still force
 
123
                    # the send with --no-strict
 
124
                    raise errors.OutOfDateTree(
 
125
                        tree, more='Use --no-strict to force the send.')
 
126
            revision_id = branch.last_revision()
 
127
        if revision_id == NULL_REVISION:
 
128
            raise errors.BzrCommandError('No revisions to submit.')
 
129
        if format is None:
 
130
            format = format_registry.get()
 
131
        directive = format(branch, revision_id, submit_branch,
 
132
            public_branch, no_patch, no_bundle, message, base_revision_id)
 
133
        if output is None:
 
134
            directive.compose_merge_request(mail_client, mail_to, body,
 
135
                                            branch, tree)
 
136
        else:
 
137
            if output == '-':
 
138
                outfile = to_file
 
139
            else:
 
140
                outfile = open(output, 'wb')
 
141
            try:
 
142
                outfile.writelines(directive.to_lines())
 
143
            finally:
 
144
                if outfile is not to_file:
 
145
                    outfile.close()
 
146
    finally:
 
147
        branch.unlock()
 
148
 
 
149
 
 
150
def _send_4(branch, revision_id, submit_branch, public_branch,
 
151
            no_patch, no_bundle, message, base_revision_id):
 
152
    from bzrlib import merge_directive
 
153
    return merge_directive.MergeDirective2.from_objects(
 
154
        branch.repository, revision_id, time.time(),
 
155
        osutils.local_time_offset(), submit_branch,
 
156
        public_branch=public_branch, include_patch=not no_patch,
 
157
        include_bundle=not no_bundle, message=message,
 
158
        base_revision_id=base_revision_id)
 
159
 
 
160
 
 
161
def _send_0_9(branch, revision_id, submit_branch, public_branch,
 
162
              no_patch, no_bundle, message, base_revision_id):
 
163
    if not no_bundle:
 
164
        if not no_patch:
 
165
            patch_type = 'bundle'
 
166
        else:
 
167
            raise errors.BzrCommandError('Format 0.9 does not'
 
168
                ' permit bundle with no patch')
 
169
    else:
 
170
        if not no_patch:
 
171
            patch_type = 'diff'
 
172
        else:
 
173
            patch_type = None
 
174
    from bzrlib import merge_directive
 
175
    return merge_directive.MergeDirective.from_objects(
 
176
        branch.repository, revision_id, time.time(),
 
177
        osutils.local_time_offset(), submit_branch,
 
178
        public_branch=public_branch, patch_type=patch_type,
 
179
        message=message)
 
180
 
 
181
 
 
182
format_registry.register('4', 
 
183
    _send_4, 'Bundle format 4, Merge Directive 2 (default)')
 
184
format_registry.register('0.9',
 
185
    _send_0_9, 'Bundle format 0.9, Merge Directive 1')
 
186
format_registry.default_key = '4'