~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/status.py

  • Committer: Aaron Bentley
  • Date: 2008-10-16 21:37:21 UTC
  • mfrom: (0.12.63 shelf-manager)
  • mto: This revision was merged to the branch mainline in revision 3823.
  • Revision ID: aaron@aaronbentley.com-20081016213721-4evccj16q9mb05uf
Merge with shelf-manager

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
                     versioned=False):
 
45
    """Display summary of changes.
 
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
    If showing the status of a working tree, extra information is included
 
55
    about unknown files, conflicts, and pending merges.
 
56
 
 
57
    :param show_unchanged: Deprecated parameter. If set, includes unchanged 
 
58
        files.
 
59
    :param specific_files: If set, a list of filenames whose status should be
 
60
        shown.  It is an error to give a filename that is not in the working 
 
61
        tree, or in the working inventory or in the basis inventory.
 
62
    :param show_ids: If set, includes each file's id.
 
63
    :param to_file: If set, write to this file (default stdout.)
 
64
    :param show_pending: If set, write pending merges.
 
65
    :param revision: If None, compare latest revision with working tree
 
66
        If not None, it must be a RevisionSpec list.
 
67
        If one revision, compare with working tree.
 
68
        If two revisions, show status between first and second.
 
69
    :param short: If True, gives short SVN-style status lines.
 
70
    :param versioned: If True, only shows versioned files.
 
71
    """
 
72
    if show_unchanged is not None:
 
73
        warn("show_tree_status with show_unchanged has been deprecated "
 
74
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
 
75
 
 
76
    if to_file is None:
 
77
        to_file = sys.stdout
 
78
    
 
79
    wt.lock_read()
 
80
    try:
 
81
        new_is_working_tree = True
 
82
        if revision is None:
 
83
            if wt.last_revision() != wt.branch.last_revision():
 
84
                warning("working tree is out of date, run 'bzr update'")
 
85
            new = wt
 
86
            old = new.basis_tree()
 
87
        elif len(revision) > 0:
 
88
            try:
 
89
                old = revision[0].as_tree(wt.branch)
 
90
            except errors.NoSuchRevision, e:
 
91
                raise errors.BzrCommandError(str(e))
 
92
            if (len(revision) > 1) and (revision[1].spec is not None):
 
93
                try:
 
94
                    new = revision[1].as_tree(wt.branch)
 
95
                    new_is_working_tree = False
 
96
                except errors.NoSuchRevision, e:
 
97
                    raise errors.BzrCommandError(str(e))
 
98
            else:
 
99
                new = wt
 
100
        old.lock_read()
 
101
        new.lock_read()
 
102
        try:
 
103
            _raise_if_nonexistent(specific_files, old, new)
 
104
            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)
 
123
            # show the new conflicts only for now. XXX: get them from the
 
124
            # delta.
 
125
            conflicts = new.conflicts()
 
126
            if specific_files is not None:
 
127
                conflicts = conflicts.select_conflicts(new, specific_files,
 
128
                    ignore_misses=True, recurse=True)[1]
 
129
            if len(conflicts) > 0 and not short:
 
130
                to_file.write("conflicts:\n")
 
131
            for conflict in conflicts:
 
132
                if short:
 
133
                    prefix = 'C  '
 
134
                else:
 
135
                    prefix = ' '
 
136
                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)
 
139
        finally:
 
140
            old.unlock()
 
141
            new.unlock()
 
142
    finally:
 
143
        wt.unlock()
 
144
 
 
145
 
 
146
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
 
147
    """Get an iterator which will return the revisions in merge sorted order.
 
148
 
 
149
    This will build up a list of all nodes, such that only nodes in the list
 
150
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
 
151
    order.
 
152
 
 
153
    :param revision_ids: A set of revision_ids
 
154
    :param parent_map: The parent information for each node. Revisions which
 
155
        are considered ghosts should not be present in the map.
 
156
    :return: iterator from MergeSorter.iter_topo_order()
 
157
    """
 
158
    # MergeSorter requires that all nodes be present in the graph, so get rid
 
159
    # of any references pointing outside of this graph.
 
160
    parent_graph = {}
 
161
    for revision_id in revision_ids:
 
162
        if revision_id not in parent_map: # ghost
 
163
            parent_graph[revision_id] = []
 
164
        else:
 
165
            # Only include parents which are in this sub-graph
 
166
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
 
167
                                            if p in revision_ids]
 
168
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
 
169
    return sorter.iter_topo_order()
 
170
 
 
171
 
 
172
def show_pending_merges(new, to_file, short=False):
 
173
    """Write out a display of pending merges in a working tree."""
 
174
    parents = new.get_parent_ids()
 
175
    if len(parents) < 2:
 
176
        return
 
177
 
 
178
    # we need one extra space for terminals that wrap on last char
 
179
    term_width = osutils.terminal_width() - 1
 
180
    if short:
 
181
        first_prefix = 'P   '
 
182
        sub_prefix = 'P.   '
 
183
    else:
 
184
        first_prefix = '  '
 
185
        sub_prefix = '    '
 
186
 
 
187
    pending = parents[1:]
 
188
    branch = new.branch
 
189
    last_revision = parents[0]
 
190
    if not short:
 
191
        to_file.write('pending merges:\n')
 
192
    graph = branch.repository.get_graph()
 
193
    other_revisions = [last_revision]
 
194
    log_formatter = log.LineLogFormatter(to_file)
 
195
    for merge in pending:
 
196
        try:
 
197
            rev = branch.repository.get_revisions([merge])[0]
 
198
        except errors.NoSuchRevision:
 
199
            # If we are missing a revision, just print out the revision id
 
200
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
 
201
            other_revisions.append(merge)
 
202
            continue
 
203
 
 
204
        # Log the merge, as it gets a slightly different formatting
 
205
        log_message = log_formatter.log_string(None, rev,
 
206
                        term_width - len(first_prefix))
 
207
        to_file.write(first_prefix + log_message + '\n')
 
208
        # Find all of the revisions in the merge source, which are not in the
 
209
        # last committed revision.
 
210
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
 
211
        other_revisions.append(merge)
 
212
        merge_extra.discard(_mod_revision.NULL_REVISION)
 
213
 
 
214
        # Get a handle to all of the revisions we will need
 
215
        try:
 
216
            revisions = dict((rev.revision_id, rev) for rev in
 
217
                             branch.repository.get_revisions(merge_extra))
 
218
        except errors.NoSuchRevision:
 
219
            # One of the sub nodes is a ghost, check each one
 
220
            revisions = {}
 
221
            for revision_id in merge_extra:
 
222
                try:
 
223
                    rev = branch.repository.get_revisions([revision_id])[0]
 
224
                except errors.NoSuchRevision:
 
225
                    revisions[revision_id] = None
 
226
                else:
 
227
                    revisions[revision_id] = rev
 
228
 
 
229
        # Display the revisions brought in by this merge.
 
230
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
 
231
                            branch.repository.get_parent_map(merge_extra))
 
232
        # Skip the first node
 
233
        num, first, depth, eom = rev_id_iterator.next()
 
234
        if first != merge:
 
235
            raise AssertionError('Somehow we misunderstood how'
 
236
                ' iter_topo_order works %s != %s' % (first, merge))
 
237
        for num, sub_merge, depth, eom in rev_id_iterator:
 
238
            rev = revisions[sub_merge]
 
239
            if rev is None:
 
240
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
 
241
                continue
 
242
            log_message = log_formatter.log_string(None,
 
243
                            revisions[sub_merge],
 
244
                            term_width - len(sub_prefix))
 
245
            to_file.write(sub_prefix + log_message + '\n')
 
246
 
 
247
 
 
248
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
249
    """Complain if paths are not in either inventory or tree.
 
250
 
 
251
    It's OK with the files exist in either tree's inventory, or 
 
252
    if they exist in the tree but are not versioned.
 
253
    
 
254
    This can be used by operations such as bzr status that can accept
 
255
    unknown or ignored files.
 
256
    """
 
257
    mutter("check paths: %r", paths)
 
258
    if not paths:
 
259
        return
 
260
    s = old_tree.filter_unversioned_files(paths)
 
261
    s = new_tree.filter_unversioned_files(s)
 
262
    s = [path for path in s if not new_tree.has_filename(path)]
 
263
    if s:
 
264
        raise errors.PathsDoNotExist(sorted(s))
 
265
 
 
266