← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/bundle/commands.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-05-04 12:10:51 UTC
  • mfrom: (5819.1.4 777007-developer-doc)
  • Revision ID: pqm@pqm.ubuntu.com-20110504121051-aovlsmqiivjmc4fc
(jelmer) Small fixes to developer documentation. (Jonathan Riddell)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/bundle/commands.py
1
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2005-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
17
This is an attempt to take the internal delta object, and represent
18
18
it as a single-file text-only changeset.
20
20
and for applying a changeset.
21
21
"""
22
22
 
23
 
import sys
 
23
from cStringIO import StringIO
24
24
 
25
25
from bzrlib.lazy_import import lazy_import
26
26
lazy_import(globals(), """
27
27
from bzrlib import (
28
28
    branch,
29
29
    errors,
 
30
    merge_directive,
 
31
    revision as _mod_revision,
30
32
    urlutils,
 
33
    transport,
31
34
    )
32
 
from bzrlib.revision import common_ancestor
33
35
""")
34
36
 
35
37
from bzrlib.commands import Command
36
 
from bzrlib.option import Option
37
 
from bzrlib.trace import note
38
 
 
39
 
 
40
 
class cmd_send_changeset(Command):
41
 
    """Send a bundled up changset via mail.
42
 
 
43
 
    If no revision has been specified, the last commited change will
44
 
    be sent.
45
 
 
46
 
    Subject of the mail can be specified by the --message option,
47
 
    otherwise information from the changeset log will be used.
48
 
 
49
 
    A editor will be spawned where the user may enter a description
50
 
    of the changeset.  The description can be read from a file with
51
 
    the --file FILE option.
52
 
    """
53
 
    takes_options = ['revision', 'message', 'file']
54
 
    takes_args = ['to?']
55
 
 
56
 
    def run(self, to=None, message=None, revision=None, file=None):
57
 
        from bzrlib.errors import BzrCommandError
58
 
        from send_changeset import send_changeset
59
 
        
60
 
        if isinstance(revision, (list, tuple)):
61
 
            if len(revision) > 1:
62
 
                raise BzrCommandError('We do not support rollup-changesets yet.')
63
 
            revision = revision[0]
64
 
 
65
 
        b = branch.Branch.open_containing('.')
66
 
 
67
 
        if not to:
68
 
            try:
69
 
                to = b.controlfile('x-send-address', 'rb').read().strip('\n')
70
 
            except:
71
 
                raise BzrCommandError('destination address is not known')
72
 
 
73
 
        if not isinstance(revision, (list, tuple)):
74
 
            revision = [revision]
75
 
 
76
 
        send_changeset(b, revision, to, message, file)
77
 
 
78
 
 
79
 
class cmd_bundle_revisions(Command):
80
 
    """Generate a revision bundle.
81
 
 
82
 
    This bundle contains all of the meta-information of a
83
 
    diff, rather than just containing the patch information.
84
 
 
85
 
    You can apply it to another tree using 'bzr merge'.
86
 
 
87
 
    bzr bundle-revisions
88
 
        - Generate a bundle relative to a remembered location
89
 
    bzr bundle-revisions BASE
90
 
        - Bundle to apply the current tree into BASE
91
 
    bzr bundle-revisions --revision A
92
 
        - Bundle to apply revision A to remembered location 
93
 
    bzr bundle-revisions --revision A..B
94
 
        - Bundle to transform A into B
95
 
    """
96
 
    takes_options = ['verbose', 'revision', 'remember',
97
 
                     Option("output", help="write bundle to specified file",
98
 
                            type=unicode)]
99
 
    takes_args = ['base?']
100
 
    aliases = ['bundle']
101
 
 
102
 
    def run(self, base=None, revision=None, output=None, remember=False):
103
 
        from bzrlib import user_encoding
104
 
        from bzrlib.bundle.serializer import write_bundle
105
 
 
106
 
        target_branch = branch.Branch.open_containing(u'.')[0]
107
 
 
108
 
        if base is None:
109
 
            base_specified = False
110
 
        else:
111
 
            base_specified = True
112
 
 
113
 
        if revision is None:
114
 
            target_revision = target_branch.last_revision()
115
 
        elif len(revision) < 3:
116
 
            target_revision = revision[-1].in_history(target_branch).rev_id
117
 
            if len(revision) == 2:
118
 
                if base_specified:
119
 
                    raise errors.BzrCommandError('Cannot specify base as well'
120
 
                                                 ' as two revision arguments.')
121
 
                base_revision = revision[0].in_history(target_branch).rev_id
122
 
        else:
123
 
            raise errors.BzrCommandError('--revision takes 1 or 2 parameters')
124
 
 
125
 
        if revision is None or len(revision) < 2:
126
 
            submit_branch = target_branch.get_submit_branch()
127
 
            if base is None:
128
 
                base = submit_branch
129
 
            if base is None:
130
 
                base = target_branch.get_parent()
131
 
            if base is None:
132
 
                raise errors.BzrCommandError("No base branch known or"
133
 
                                             " specified.")
134
 
            elif not base_specified:
135
 
                # FIXME:
136
 
                # note() doesn't pay attention to terminal_encoding() so
137
 
                # we must format with 'ascii' to be safe
138
 
                note('Using saved location: %s',
139
 
                     urlutils.unescape_for_display(base, 'ascii'))
140
 
            base_branch = branch.Branch.open(base)
141
 
 
142
 
            # We don't want to lock the same branch across
143
 
            # 2 different branches
144
 
            if target_branch.base == base_branch.base:
145
 
                base_branch = target_branch 
146
 
            if submit_branch is None or remember:
147
 
                if base_specified:
148
 
                    target_branch.set_submit_branch(base_branch.base)
149
 
                elif remember:
150
 
                    raise errors.BzrCommandError('--remember requires a branch'
151
 
                                                 ' to be specified.')
152
 
            target_branch.repository.fetch(base_branch.repository, 
153
 
                                           base_branch.last_revision())
154
 
            base_revision = common_ancestor(base_branch.last_revision(),
155
 
                                            target_revision,
156
 
                                            target_branch.repository)
157
 
 
158
 
 
159
 
        if output is not None:
160
 
            fileobj = file(output, 'wb')
161
 
        else:
162
 
            fileobj = sys.stdout
163
 
        target_branch.repository.lock_read()
164
 
        try:
165
 
            write_bundle(target_branch.repository, target_revision,
166
 
                         base_revision, fileobj)
167
 
        finally:
168
 
            target_branch.repository.unlock()
169
 
 
170
 
 
171
 
class cmd_verify_changeset(Command):
172
 
    """Read a written changeset, and make sure it is valid.
173
 
 
174
 
    """
175
 
    takes_args = ['filename?']
176
 
 
177
 
    def run(self, filename=None):
178
 
        from read_changeset import read_changeset
179
 
        #from bzrlib.xml import serializer_v4
180
 
 
181
 
        b, relpath = branch.Branch.open_containing('.')
182
 
 
183
 
        if filename is None or filename == '-':
184
 
            f = sys.stdin
185
 
        else:
186
 
            f = open(filename, 'U')
187
 
 
188
 
        cset_info, cset_tree = read_changeset(f, b)
189
 
        # print cset_info
190
 
        # print cset_tree
191
 
        #serializer_v4.write(cset_tree.inventory, sys.stdout)
 
38
 
 
39
 
 
40
class cmd_bundle_info(Command):
 
41
    __doc__ = """Output interesting stats about a bundle"""
 
42
 
 
43
    hidden = True
 
44
    takes_args = ['location']
 
45
    takes_options = ['verbose']
 
46
    encoding_type = 'exact'
 
47
 
 
48
    def run(self, location, verbose=False):
 
49
        from bzrlib.bundle.serializer import read_bundle
 
50
        from bzrlib.bundle import read_mergeable_from_url
 
51
        from bzrlib import osutils
 
52
        term_encoding = osutils.get_terminal_encoding()
 
53
        bundle_info = read_mergeable_from_url(location)
 
54
        if isinstance(bundle_info, merge_directive.BaseMergeDirective):
 
55
            bundle_file = StringIO(bundle_info.get_raw_bundle())
 
56
            bundle_info = read_bundle(bundle_file)
 
57
        else:
 
58
            if verbose:
 
59
                raise errors.BzrCommandError('--verbose requires a merge'
 
60
                    ' directive')
 
61
        reader_method = getattr(bundle_info, 'get_bundle_reader', None)
 
62
        if reader_method is None:
 
63
            raise errors.BzrCommandError('Bundle format not supported')
 
64
 
 
65
        by_kind = {}
 
66
        file_ids = set()
 
67
        for bytes, parents, repo_kind, revision_id, file_id\
 
68
            in reader_method().iter_records():
 
69
            by_kind.setdefault(repo_kind, []).append(
 
70
                (bytes, parents, repo_kind, revision_id, file_id))
 
71
            if file_id is not None:
 
72
                file_ids.add(file_id)
 
73
        self.outf.write('Records\n')
 
74
        for kind, records in sorted(by_kind.iteritems()):
 
75
            multiparent = sum(1 for b, m, k, r, f in records if
 
76
                              len(m.get('parents', [])) > 1)
 
77
            self.outf.write('%s: %d (%d multiparent)\n' % \
 
78
                (kind, len(records), multiparent))
 
79
        self.outf.write('unique files: %d\n' % len(file_ids))
 
80
        self.outf.write('\n')
 
81
        nicks = set()
 
82
        committers = set()
 
83
        for revision in bundle_info.real_revisions:
 
84
            if 'branch-nick' in revision.properties:
 
85
                nicks.add(revision.properties['branch-nick'])
 
86
            committers.add(revision.committer)
 
87
 
 
88
        self.outf.write('Revisions\n')
 
89
        self.outf.write(('nicks: %s\n'
 
90
            % ', '.join(sorted(nicks))).encode(term_encoding, 'replace'))
 
91
        self.outf.write(('committers: \n%s\n' %
 
92
        '\n'.join(sorted(committers)).encode(term_encoding, 'replace')))
 
93
        if verbose:
 
94
            self.outf.write('\n')
 
95
            bundle_file.seek(0)
 
96
            line = bundle_file.readline()
 
97
            line = bundle_file.readline()
 
98
            content = bundle_file.read().decode('bz2')
 
99
            self.outf.write("Decoded contents\n")
 
100
            self.outf.write(content)
 
101
            self.outf.write('\n')