~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Jelmer Vernooij
  • Date: 2010-08-02 11:20:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5389.
  • Revision ID: jelmer@samba.org-20100802112039-j96qqgswdytb4are
Rename per_bzrdir => per_controldir.

Show diffs side-by-side

added added

removed removed

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