~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-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
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
import sys
18
18
 
19
19
from bzrlib import (
20
20
    delta as _mod_delta,
 
21
    log,
 
22
    osutils,
21
23
    tree,
 
24
    tsort,
 
25
    revision as _mod_revision,
22
26
    )
23
 
from bzrlib.diff import _raise_if_nonexistent
24
27
import bzrlib.errors as errors
25
 
from bzrlib.log import line_log
26
28
from bzrlib.osutils import is_inside_any
27
29
from bzrlib.symbol_versioning import (deprecated_function,
28
30
        )
29
 
from bzrlib.trace import warning
 
31
from bzrlib.trace import mutter, warning
30
32
 
31
33
# TODO: when showing single-line logs, truncate to the width of the terminal
32
34
# if known, but only if really going to the terminal (not into a file)
33
35
 
34
36
 
 
37
def report_changes(to_file, old, new, specific_files, 
 
38
                   show_short_reporter, show_long_callback, 
 
39
                   short=False, want_unchanged=False, 
 
40
                   want_unversioned=False, show_ids=False):
 
41
    """Display summary of changes.
 
42
 
 
43
    This compares two trees with regards to a list of files, and delegates 
 
44
    the display to underlying elements.
 
45
 
 
46
    For short output, it creates an iterator on all changes, and lets a given
 
47
    reporter display these changes.
 
48
 
 
49
    For stantard output, it creates a delta of the changes, and forwards it
 
50
    to a callback
 
51
 
 
52
    :param to_file: If set, write to this file (default stdout.)
 
53
    :param old: Start tree for the comparison
 
54
    :param end: End tree for the comparison
 
55
    :param specific_files: If set, a list of filenames whose status should be
 
56
        shown.  It is an error to give a filename that is not in the working
 
57
        tree, or in the working inventory or in the basis inventory.
 
58
    :param show_short_reporter: Reporter in charge of display for short output
 
59
    :param show_long_callback: Callback in charge of display for normal output
 
60
    :param short: If True, gives short SVN-style status lines.
 
61
    :param want_unchanged: Deprecated parameter. If set, includes unchanged
 
62
        files.
 
63
    :param show_ids: If set, includes each file's id.
 
64
    :param want_unversioned: If False, only shows versioned files.
 
65
    """
 
66
 
 
67
    if short:
 
68
        changes = new.iter_changes(old, want_unchanged, specific_files,
 
69
            require_versioned=False, want_unversioned=want_unversioned)
 
70
        _mod_delta.report_changes(changes, show_short_reporter)
 
71
        
 
72
    else:
 
73
        delta = new.changes_from(old, want_unchanged=want_unchanged,
 
74
                              specific_files=specific_files,
 
75
                              want_unversioned=want_unversioned)
 
76
        # filter out unknown files. We may want a tree method for
 
77
        # this
 
78
        delta.unversioned = [unversioned for unversioned in
 
79
            delta.unversioned if not new.is_ignored(unversioned[0])]
 
80
        show_long_callback(to_file, delta, 
 
81
                           show_ids=show_ids,
 
82
                           show_unchanged=want_unchanged)
 
83
 
 
84
 
35
85
def show_tree_status(wt, show_unchanged=None,
36
86
                     specific_files=None,
37
87
                     show_ids=False,
39
89
                     show_pending=True,
40
90
                     revision=None,
41
91
                     short=False,
42
 
                     versioned=False):
 
92
                     verbose=False,
 
93
                     versioned=False,
 
94
                     show_long_callback=_mod_delta.report_delta):
43
95
    """Display summary of changes.
44
96
 
45
 
    By default this compares the working tree to a previous revision. 
46
 
    If the revision argument is given, summarizes changes between the 
 
97
    By default this compares the working tree to a previous revision.
 
98
    If the revision argument is given, summarizes changes between the
47
99
    working tree and another, or between two revisions.
48
100
 
49
 
    The result is written out as Unicode and to_file should be able 
 
101
    The result is written out as Unicode and to_file should be able
50
102
    to encode that.
51
103
 
52
104
    If showing the status of a working tree, extra information is included
53
105
    about unknown files, conflicts, and pending merges.
54
106
 
55
 
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
107
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
56
108
        files.
57
109
    :param specific_files: If set, a list of filenames whose status should be
58
 
        shown.  It is an error to give a filename that is not in the working 
 
110
        shown.  It is an error to give a filename that is not in the working
59
111
        tree, or in the working inventory or in the basis inventory.
60
112
    :param show_ids: If set, includes each file's id.
61
113
    :param to_file: If set, write to this file (default stdout.)
62
114
    :param show_pending: If set, write pending merges.
63
 
    :param revision: If None the compare latest revision with working tree
64
 
        If not None it must be a RevisionSpec list.
65
 
        If one revision show compared it with working tree.
66
 
        If two revisions show status between first and second.
 
115
    :param revision: If None, compare latest revision with working tree
 
116
        If not None, it must be a RevisionSpec list.
 
117
        If one revision, compare with working tree.
 
118
        If two revisions, show status between first and second.
67
119
    :param short: If True, gives short SVN-style status lines.
 
120
    :param verbose: If True, show all merged revisions, not just
 
121
        the merge tips
68
122
    :param versioned: If True, only shows versioned files.
 
123
    :param show_long_callback: A callback: message = show_long_callback(to_file, delta, 
 
124
        show_ids, show_unchanged, indent, filter), only used with the long output
69
125
    """
70
126
    if show_unchanged is not None:
71
 
        warn("show_status_trees with show_unchanged has been deprecated "
 
127
        warn("show_tree_status with show_unchanged has been deprecated "
72
128
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
73
129
 
74
130
    if to_file is None:
75
131
        to_file = sys.stdout
76
 
    
 
132
 
77
133
    wt.lock_read()
78
134
    try:
79
135
        new_is_working_tree = True
84
140
            old = new.basis_tree()
85
141
        elif len(revision) > 0:
86
142
            try:
87
 
                rev_id = revision[0].in_history(wt.branch).rev_id
88
 
                old = wt.branch.repository.revision_tree(rev_id)
 
143
                old = revision[0].as_tree(wt.branch)
89
144
            except errors.NoSuchRevision, e:
90
145
                raise errors.BzrCommandError(str(e))
91
146
            if (len(revision) > 1) and (revision[1].spec is not None):
92
147
                try:
93
 
                    rev_id = revision[1].in_history(wt.branch).rev_id
94
 
                    new = wt.branch.repository.revision_tree(rev_id)
 
148
                    new = revision[1].as_tree(wt.branch)
95
149
                    new_is_working_tree = False
96
150
                except errors.NoSuchRevision, e:
97
151
                    raise errors.BzrCommandError(str(e))
100
154
        old.lock_read()
101
155
        new.lock_read()
102
156
        try:
103
 
            _raise_if_nonexistent(specific_files, old, new)
 
157
            specific_files, nonexistents \
 
158
                = _filter_nonexistent(specific_files, old, new)
104
159
            want_unversioned = not versioned
105
 
            if short:
106
 
                changes = new._iter_changes(old, show_unchanged, specific_files,
107
 
                    require_versioned=False, want_unversioned=want_unversioned)
108
 
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
109
 
                    unversioned_filter=new.is_ignored)
110
 
                _mod_delta.report_changes(changes, reporter)
111
 
            else:
112
 
                delta = new.changes_from(old, want_unchanged=show_unchanged,
113
 
                                      specific_files=specific_files,
114
 
                                      want_unversioned=want_unversioned)
115
 
                # filter out unknown files. We may want a tree method for
116
 
                # this
117
 
                delta.unversioned = [unversioned for unversioned in
118
 
                    delta.unversioned if not new.is_ignored(unversioned[0])]
119
 
                delta.show(to_file,
120
 
                           show_ids=show_ids,
121
 
                           show_unchanged=show_unchanged,
122
 
                           short_status=False)
 
160
 
 
161
            # Reporter used for short outputs
 
162
            reporter = _mod_delta._ChangeReporter(output_file=to_file,
 
163
                unversioned_filter=new.is_ignored)
 
164
            report_changes(to_file, old, new, specific_files, 
 
165
                           reporter, show_long_callback, 
 
166
                           short=short, want_unchanged=show_unchanged, 
 
167
                           want_unversioned=want_unversioned, show_ids=show_ids)
 
168
 
123
169
            # show the new conflicts only for now. XXX: get them from the
124
170
            # delta.
125
171
            conflicts = new.conflicts()
134
180
                else:
135
181
                    prefix = ' '
136
182
                to_file.write("%s %s\n" % (prefix, conflict))
137
 
            if new_is_working_tree and show_pending:
138
 
                show_pending_merges(new, to_file, short)
 
183
            # Show files that were requested but don't exist (and are
 
184
            # not versioned).  We don't involve delta in this; these
 
185
            # paths are really the province of just the status
 
186
            # command, since they have more to do with how it was
 
187
            # invoked than with the tree it's operating on.
 
188
            if nonexistents and not short:
 
189
                to_file.write("nonexistent:\n")
 
190
            for nonexistent in nonexistents:
 
191
                # We could calculate prefix outside the loop but, given
 
192
                # how rarely this ought to happen, it's OK and arguably
 
193
                # slightly faster to do it here (ala conflicts above)
 
194
                if short:
 
195
                    prefix = 'X  '
 
196
                else:
 
197
                    prefix = ' '
 
198
                to_file.write("%s %s\n" % (prefix, nonexistent))
 
199
            if (new_is_working_tree and show_pending):
 
200
                show_pending_merges(new, to_file, short, verbose=verbose)
 
201
            if nonexistents:
 
202
                raise errors.PathsDoNotExist(nonexistents)
139
203
        finally:
140
204
            old.unlock()
141
205
            new.unlock()
142
206
    finally:
143
207
        wt.unlock()
144
208
 
145
 
def show_pending_merges(new, to_file, short=False):
 
209
 
 
210
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
211
    """Get an iterator which will return the revisions in merge sorted order.
 
212
 
 
213
    This will build up a list of all nodes, such that only nodes in the list
 
214
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
215
    order.
 
216
 
 
217
    :param revision_ids: A set of revision_ids
 
218
    :param parent_map: The parent information for each node. Revisions which
 
219
        are considered ghosts should not be present in the map.
 
220
    :return: iterator from MergeSorter.iter_topo_order()
 
221
    """
 
222
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
223
    # of any references pointing outside of this graph.
 
224
    parent_graph = {}
 
225
    for revision_id in revision_ids:
 
226
        if revision_id not in parent_map: # ghost
 
227
            parent_graph[revision_id] = []
 
228
        else:
 
229
            # Only include parents which are in this sub-graph
 
230
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
231
                                            if p in revision_ids]
 
232
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
233
    return sorter.iter_topo_order()
 
234
 
 
235
 
 
236
def show_pending_merges(new, to_file, short=False, verbose=False):
146
237
    """Write out a display of pending merges in a working tree."""
147
238
    parents = new.get_parent_ids()
148
239
    if len(parents) < 2:
149
240
        return
 
241
 
 
242
    term_width = osutils.terminal_width()
 
243
    if term_width is not None:
 
244
        # we need one extra space for terminals that wrap on last char
 
245
        term_width = term_width - 1
 
246
    if short:
 
247
        first_prefix = 'P   '
 
248
        sub_prefix = 'P.   '
 
249
    else:
 
250
        first_prefix = '  '
 
251
        sub_prefix = '    '
 
252
 
 
253
    def show_log_message(rev, prefix):
 
254
        if term_width is None:
 
255
            width = term_width
 
256
        else:
 
257
            width = term_width - len(prefix)
 
258
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
 
259
        to_file.write(log_message + '\n')
 
260
 
150
261
    pending = parents[1:]
151
262
    branch = new.branch
152
263
    last_revision = parents[0]
153
264
    if not short:
154
 
        to_file.write('pending merges:\n')
155
 
    if last_revision is not None:
156
 
        try:
157
 
            ignore = set(branch.repository.get_ancestry(last_revision,
158
 
                                                        topo_sorted=False))
159
 
        except errors.NoSuchRevision:
160
 
            # the last revision is a ghost : assume everything is new 
161
 
            # except for it
162
 
            ignore = set([None, last_revision])
163
 
    else:
164
 
        ignore = set([None])
165
 
    # TODO: this could be improved using merge_sorted - we'd get the same 
166
 
    # output rather than one level of indent.
 
265
        if verbose:
 
266
            to_file.write('pending merges:\n')
 
267
        else:
 
268
            to_file.write('pending merge tips:'
 
269
                          ' (use -v to see all merge revisions)\n')
 
270
    graph = branch.repository.get_graph()
 
271
    other_revisions = [last_revision]
 
272
    log_formatter = log.LineLogFormatter(to_file)
167
273
    for merge in pending:
168
 
        ignore.add(merge)
169
 
        try:
170
 
            from bzrlib.osutils import terminal_width
171
 
            width = terminal_width()
172
 
            m_revision = branch.repository.get_revision(merge)
173
 
            if short:
174
 
                prefix = 'P  '
175
 
            else:
176
 
                prefix = ' '
177
 
            to_file.write(prefix + ' ' + line_log(m_revision, width - 4))
178
 
            to_file.write('\n')
179
 
            inner_merges = branch.repository.get_ancestry(merge)
180
 
            assert inner_merges[0] is None
181
 
            inner_merges.pop(0)
182
 
            inner_merges.reverse()
183
 
            for mmerge in inner_merges:
184
 
                if mmerge in ignore:
185
 
                    continue
186
 
                mm_revision = branch.repository.get_revision(mmerge)
187
 
                if short:
188
 
                    prefix = 'P.  '
 
274
        try:
 
275
            rev = branch.repository.get_revisions([merge])[0]
 
276
        except errors.NoSuchRevision:
 
277
            # If we are missing a revision, just print out the revision id
 
278
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
279
            other_revisions.append(merge)
 
280
            continue
 
281
 
 
282
        # Log the merge, as it gets a slightly different formatting
 
283
        show_log_message(rev, first_prefix)
 
284
        if not verbose:
 
285
            continue
 
286
 
 
287
        # Find all of the revisions in the merge source, which are not in the
 
288
        # last committed revision.
 
289
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
290
        other_revisions.append(merge)
 
291
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
292
 
 
293
        # Get a handle to all of the revisions we will need
 
294
        try:
 
295
            revisions = dict((rev.revision_id, rev) for rev in
 
296
                             branch.repository.get_revisions(merge_extra))
 
297
        except errors.NoSuchRevision:
 
298
            # One of the sub nodes is a ghost, check each one
 
299
            revisions = {}
 
300
            for revision_id in merge_extra:
 
301
                try:
 
302
                    rev = branch.repository.get_revisions([revision_id])[0]
 
303
                except errors.NoSuchRevision:
 
304
                    revisions[revision_id] = None
189
305
                else:
190
 
                    prefix = '   '
191
 
                to_file.write(prefix + ' ' + line_log(mm_revision, width - 5))
192
 
                to_file.write('\n')
193
 
                ignore.add(mmerge)
194
 
        except errors.NoSuchRevision:
195
 
            if short:
196
 
                prefix = 'P  '
197
 
            else:
198
 
                prefix = ' '
199
 
            to_file.write(prefix + ' ' + merge)
200
 
            to_file.write('\n')
 
306
                    revisions[revision_id] = rev
 
307
 
 
308
        # Display the revisions brought in by this merge.
 
309
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
310
                            branch.repository.get_parent_map(merge_extra))
 
311
        # Skip the first node
 
312
        num, first, depth, eom = rev_id_iterator.next()
 
313
        if first != merge:
 
314
            raise AssertionError('Somehow we misunderstood how'
 
315
                ' iter_topo_order works %s != %s' % (first, merge))
 
316
        for num, sub_merge, depth, eom in rev_id_iterator:
 
317
            rev = revisions[sub_merge]
 
318
            if rev is None:
 
319
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
320
                continue
 
321
            show_log_message(revisions[sub_merge], sub_prefix)
 
322
 
 
323
 
 
324
def _filter_nonexistent(orig_paths, old_tree, new_tree):
 
325
    """Convert orig_paths to two sorted lists and return them.
 
326
 
 
327
    The first is orig_paths paths minus the items in the second list,
 
328
    and the second list is paths that are not in either inventory or
 
329
    tree (they don't qualify if they exist in the tree's inventory, or
 
330
    if they exist in the tree but are not versioned.)
 
331
 
 
332
    If either of the two lists is empty, return it as an empty list.
 
333
 
 
334
    This can be used by operations such as bzr status that can accept
 
335
    unknown or ignored files.
 
336
    """
 
337
    mutter("check paths: %r", orig_paths)
 
338
    if not orig_paths:
 
339
        return orig_paths, []
 
340
    s = old_tree.filter_unversioned_files(orig_paths)
 
341
    s = new_tree.filter_unversioned_files(s)
 
342
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
 
343
    remaining   = [path for path in orig_paths if not path in nonexistent]
 
344
    # Sorting the 'remaining' list doesn't have much effect in
 
345
    # practice, since the various status output sections will sort
 
346
    # their groups individually.  But for consistency of this
 
347
    # function's API, it's better to sort both than just 'nonexistent'.
 
348
    return sorted(remaining), sorted(nonexistent)