/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Ian Clatworthy
  • Date: 2009-02-10 00:22:46 UTC
  • mto: (3992.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3993.
  • Revision ID: ian.clatworthy@canonical.com-20090210002246-bj56cq97fhdo951e
split tests as suggested by Jelmer's review

Show diffs side-by-side

added added

removed removed

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