~bzr-pqm/bzr/bzr.dev

2318.2.3 by Kent Gibson
merged bzr.dev
1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
1185.13.2 by Robert Collins
Merge Aarons conflict plugin for 0.1rc1
2
#
362 by Martin Pool
- Import stat-cache code
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.
1185.13.2 by Robert Collins
Merge Aarons conflict plugin for 0.1rc1
7
#
362 by Martin Pool
- Import stat-cache code
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.
1185.13.2 by Robert Collins
Merge Aarons conflict plugin for 0.1rc1
12
#
362 by Martin Pool
- Import stat-cache code
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
362 by Martin Pool
- Import stat-cache code
16
1185.13.2 by Robert Collins
Merge Aarons conflict plugin for 0.1rc1
17
import sys
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
18
1551.10.7 by Aaron Bentley
Use new-style output for status
19
from bzrlib import (
20
    delta as _mod_delta,
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
21
    log,
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
22
    osutils,
1551.10.7 by Aaron Bentley
Use new-style output for status
23
    tree,
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
24
    tsort,
25
    revision as _mod_revision,
1551.10.7 by Aaron Bentley
Use new-style output for status
26
    )
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
27
import bzrlib.errors as errors
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
28
from bzrlib.osutils import is_inside_any
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
29
from bzrlib.symbol_versioning import (deprecated_function,
30
        )
3224.5.19 by Andrew Bennetts
Move _raise_if_nonexistent into the only module that uses it, bzrlib.status.
31
from bzrlib.trace import mutter, warning
362 by Martin Pool
- Import stat-cache code
32
1185.33.70 by Martin Pool
Refactor status display code.
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
465 by Martin Pool
- Move show_status() out of Branch into a new function in
36
1773.1.2 by Robert Collins
Remove --all option from status.
37
def show_tree_status(wt, show_unchanged=None,
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
38
                     specific_files=None,
39
                     show_ids=False,
40
                     to_file=None,
41
                     show_pending=True,
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
42
                     revision=None,
2318.2.1 by Kent Gibson
Apply status versioned patch
43
                     short=False,
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
44
                     verbose=False,
2318.2.1 by Kent Gibson
Apply status versioned patch
45
                     versioned=False):
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
46
    """Display summary of changes.
47
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
48
    By default this compares the working tree to a previous revision.
49
    If the revision argument is given, summarizes changes between the
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
50
    working tree and another, or between two revisions.
51
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
52
    The result is written out as Unicode and to_file should be able
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
53
    to encode that.
54
1662.1.9 by Martin Pool
Give a clear error for bzr status of an unversioned, nonexistent file. (Malone #3619)
55
    If showing the status of a working tree, extra information is included
56
    about unknown files, conflicts, and pending merges.
57
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
58
    :param show_unchanged: Deprecated parameter. If set, includes unchanged
1773.1.2 by Robert Collins
Remove --all option from status.
59
        files.
60
    :param specific_files: If set, a list of filenames whose status should be
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
61
        shown.  It is an error to give a filename that is not in the working
1662.1.9 by Martin Pool
Give a clear error for bzr status of an unversioned, nonexistent file. (Malone #3619)
62
        tree, or in the working inventory or in the basis inventory.
1773.1.2 by Robert Collins
Remove --all option from status.
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.
3394.2.2 by Ian Clatworthy
show_tree_status docstring and deprecation cleanups
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.
2318.2.1 by Kent Gibson
Apply status versioned patch
70
    :param short: If True, gives short SVN-style status lines.
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
71
    :param verbose: If True, show all merged revisions, not just
72
        the merge tips
2318.2.1 by Kent Gibson
Apply status versioned patch
73
    :param versioned: If True, only shows versioned files.
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
74
    """
1773.1.2 by Robert Collins
Remove --all option from status.
75
    if show_unchanged is not None:
3394.2.2 by Ian Clatworthy
show_tree_status docstring and deprecation cleanups
76
        warn("show_tree_status with show_unchanged has been deprecated "
1773.1.2 by Robert Collins
Remove --all option from status.
77
             "since bzrlib 0.9", DeprecationWarning, stacklevel=2)
78
79
    if to_file is None:
915 by Martin Pool
- add simple test case for bzr status
80
        to_file = sys.stdout
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
81
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
82
    wt.lock_read()
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
83
    try:
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
84
        new_is_working_tree = True
85
        if revision is None:
2091.4.1 by wang
Pushing to a remote branch does not currently update the remote working
86
            if wt.last_revision() != wt.branch.last_revision():
87
                warning("working tree is out of date, run 'bzr update'")
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
88
            new = wt
1534.4.35 by Robert Collins
Give branch its own basis tree and last_revision methods; deprecated branch.working_tree()
89
            old = new.basis_tree()
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
90
        elif len(revision) > 0:
91
            try:
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
92
                old = revision[0].as_tree(wt.branch)
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
93
            except errors.NoSuchRevision, e:
94
                raise errors.BzrCommandError(str(e))
1540.2.6 by Robey Pointer
make 'log' and 'status' treat '-r N..' as implicitly '-r N..-1'
95
            if (len(revision) > 1) and (revision[1].spec is not None):
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
96
                try:
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
97
                    new = revision[1].as_tree(wt.branch)
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
98
                    new_is_working_tree = False
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
99
                except errors.NoSuchRevision, e:
100
                    raise errors.BzrCommandError(str(e))
1185.1.35 by Robert Collins
Heikki Paajanen's status -r patch
101
            else:
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
102
                new = wt
2255.2.80 by Robert Collins
In status, read lock the old and new trees being used to let data caching occur.
103
        old.lock_read()
104
        new.lock_read()
105
        try:
3930.2.2 by Karl Fogel
* bzrlib/status.py
106
            specific_files, nonexistents \
3930.2.4 by Karl Fogel
* bzrlib/status.py
107
                = _filter_nonexistent(specific_files, old, new)
2318.2.3 by Kent Gibson
merged bzr.dev
108
            want_unversioned = not versioned
2168.1.3 by John Arbash Meinel
The logic for when to display 'C' for conflicts was inverted.
109
            if short:
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
110
                changes = new.iter_changes(old, show_unchanged, specific_files,
2318.2.3 by Kent Gibson
merged bzr.dev
111
                    require_versioned=False, want_unversioned=want_unversioned)
1551.10.25 by Aaron Bentley
Make ChangeReporter private
112
                reporter = _mod_delta._ChangeReporter(output_file=to_file,
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
113
                    unversioned_filter=new.is_ignored)
2255.2.83 by John Arbash Meinel
[merge] bzr.dev 2294
114
                _mod_delta.report_changes(changes, reporter)
2147.2.1 by Keir Mierle
Add a --short flag to status to get svn-style status
115
            else:
2255.2.83 by John Arbash Meinel
[merge] bzr.dev 2294
116
                delta = new.changes_from(old, want_unchanged=show_unchanged,
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
117
                                      specific_files=specific_files,
2318.2.3 by Kent Gibson
merged bzr.dev
118
                                      want_unversioned=want_unversioned)
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
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])]
2255.2.83 by John Arbash Meinel
[merge] bzr.dev 2294
123
                delta.show(to_file,
124
                           show_ids=show_ids,
125
                           show_unchanged=show_unchanged,
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
126
                           short_status=False)
1551.15.58 by Aaron Bentley
Status honours selected paths for conflicts (#127606)
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:
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
134
                to_file.write("conflicts:\n")
1551.15.58 by Aaron Bentley
Status honours selected paths for conflicts (#127606)
135
            for conflict in conflicts:
2255.2.80 by Robert Collins
In status, read lock the old and new trees being used to let data caching occur.
136
                if short:
2255.2.83 by John Arbash Meinel
[merge] bzr.dev 2294
137
                    prefix = 'C  '
2255.2.80 by Robert Collins
In status, read lock the old and new trees being used to let data caching occur.
138
                else:
139
                    prefix = ' '
2911.6.1 by Blake Winton
Change 'print >> f,'s to 'f.write('s.
140
                to_file.write("%s %s\n" % (prefix, conflict))
3930.2.2 by Karl Fogel
* bzrlib/status.py
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:
3992.1.1 by Ian Clatworthy
Handle non-existent files in status (Karl Fogel, #306394)
149
                # We could calculate prefix outside the loop but, given
150
                # how rarely this ought to happen, it's OK and arguably
151
                # slightly faster to do it here (ala conflicts above)
3930.2.2 by Karl Fogel
* bzrlib/status.py
152
                if short:
153
                    prefix = 'X  '
154
                else:
155
                    prefix = ' '
156
                to_file.write("%s %s\n" % (prefix, nonexistent))
3636.1.1 by Robert Collins
Stop passing specific_file lists to show_tree_status when the specific
157
            if (new_is_working_tree and show_pending):
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
158
                show_pending_merges(new, to_file, short, verbose=verbose)
4593.3.1 by Martin Pool
Avoid raising exceptions from inside finally blocks (see bug 403523)
159
            if nonexistents:
160
                raise errors.PathsDoNotExist(nonexistents)
2255.2.80 by Robert Collins
In status, read lock the old and new trees being used to let data caching occur.
161
        finally:
162
            old.unlock()
163
            new.unlock()
580 by Martin Pool
- Use explicit lock methods on a branch, rather than doing it
164
    finally:
1551.2.9 by Aaron Bentley
Fix status to work with checkouts
165
        wt.unlock()
1185.33.70 by Martin Pool
Refactor status display code.
166
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
167
168
def _get_sorted_revisions(tip_revision, revision_ids, parent_map):
169
    """Get an iterator which will return the revisions in merge sorted order.
170
171
    This will build up a list of all nodes, such that only nodes in the list
172
    are referenced. It then uses MergeSorter to return them in 'merge-sorted'
173
    order.
174
175
    :param revision_ids: A set of revision_ids
176
    :param parent_map: The parent information for each node. Revisions which
177
        are considered ghosts should not be present in the map.
3377.3.43 by John Arbash Meinel
Ian's review feedback
178
    :return: iterator from MergeSorter.iter_topo_order()
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
179
    """
3377.3.40 by John Arbash Meinel
a little bit more cleanup, change how ghosts are handled
180
    # MergeSorter requires that all nodes be present in the graph, so get rid
181
    # of any references pointing outside of this graph.
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
182
    parent_graph = {}
183
    for revision_id in revision_ids:
184
        if revision_id not in parent_map: # ghost
185
            parent_graph[revision_id] = []
186
        else:
187
            # Only include parents which are in this sub-graph
188
            parent_graph[revision_id] = [p for p in parent_map[revision_id]
189
                                            if p in revision_ids]
190
    sorter = tsort.MergeSorter(parent_graph, tip_revision)
191
    return sorter.iter_topo_order()
192
193
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
194
def show_pending_merges(new, to_file, short=False, verbose=False):
1185.33.70 by Martin Pool
Refactor status display code.
195
    """Write out a display of pending merges in a working tree."""
3377.3.43 by John Arbash Meinel
Ian's review feedback
196
    parents = new.get_parent_ids()
197
    if len(parents) < 2:
198
        return
199
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
200
    term_width = osutils.terminal_width()
201
    if term_width is not None:
202
        # we need one extra space for terminals that wrap on last char
203
        term_width = term_width - 1
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
204
    if short:
3377.3.42 by John Arbash Meinel
Get the tests to actually work, and get the code to go along with.
205
        first_prefix = 'P   '
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
206
        sub_prefix = 'P.   '
207
    else:
208
        first_prefix = '  '
209
        sub_prefix = '    '
3377.3.38 by John Arbash Meinel
Pull out terminal width from the inner loop of show_pending_merges
210
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
211
    def show_log_message(rev, prefix):
212
        if term_width is None:
213
            width = term_width
214
        else:
215
            width = term_width - len(prefix)
216
        log_message = log_formatter.log_string(None, rev, width, prefix=prefix)
217
        to_file.write(log_message + '\n')
218
1908.6.9 by Robert Collins
Fix status to not use pending_merges.
219
    pending = parents[1:]
1185.33.70 by Martin Pool
Refactor status display code.
220
    branch = new.branch
1908.6.9 by Robert Collins
Fix status to not use pending_merges.
221
    last_revision = parents[0]
2147.2.2 by Keir Mierle
Fix spacing error and add tests for status --short command flag.
222
    if not short:
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
223
        if verbose:
224
            to_file.write('pending merges:\n')
225
        else:
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
226
            to_file.write('pending merge tips:'
227
                          ' (use -v to see all merge revisions)\n')
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
228
    graph = branch.repository.get_graph()
3377.3.31 by John Arbash Meinel
change the status code to use find_unique_ancestors()
229
    other_revisions = [last_revision]
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
230
    log_formatter = log.LineLogFormatter(to_file)
1908.6.9 by Robert Collins
Fix status to not use pending_merges.
231
    for merge in pending:
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
232
        try:
233
            rev = branch.repository.get_revisions([merge])[0]
234
        except errors.NoSuchRevision:
235
            # If we are missing a revision, just print out the revision id
3377.3.40 by John Arbash Meinel
a little bit more cleanup, change how ghosts are handled
236
            to_file.write(first_prefix + '(ghost) ' + merge + '\n')
3377.3.39 by John Arbash Meinel
More tweaks for show_pending_merges
237
            other_revisions.append(merge)
238
            continue
239
240
        # Log the merge, as it gets a slightly different formatting
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
241
        show_log_message(rev, first_prefix)
3936.2.1 by Ian Clatworthy
verbose flag for status - code & tests
242
        if not verbose:
243
            continue
244
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
245
        # Find all of the revisions in the merge source, which are not in the
246
        # last committed revision.
3377.3.31 by John Arbash Meinel
change the status code to use find_unique_ancestors()
247
        merge_extra = graph.find_unique_ancestors(merge, other_revisions)
248
        other_revisions.append(merge)
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
249
        merge_extra.discard(_mod_revision.NULL_REVISION)
3377.3.38 by John Arbash Meinel
Pull out terminal width from the inner loop of show_pending_merges
250
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
251
        # Get a handle to all of the revisions we will need
1185.33.70 by Martin Pool
Refactor status display code.
252
        try:
3074.3.1 by John Arbash Meinel
Fix bug #172657, use Graph.find_difference() rather than ancestry set operations.
253
            revisions = dict((rev.revision_id, rev) for rev in
254
                             branch.repository.get_revisions(merge_extra))
255
        except errors.NoSuchRevision:
3377.3.40 by John Arbash Meinel
a little bit more cleanup, change how ghosts are handled
256
            # One of the sub nodes is a ghost, check each one
257
            revisions = {}
258
            for revision_id in merge_extra:
259
                try:
3377.3.42 by John Arbash Meinel
Get the tests to actually work, and get the code to go along with.
260
                    rev = branch.repository.get_revisions([revision_id])[0]
3377.3.40 by John Arbash Meinel
a little bit more cleanup, change how ghosts are handled
261
                except errors.NoSuchRevision:
262
                    revisions[revision_id] = None
263
                else:
264
                    revisions[revision_id] = rev
265
266
        # Display the revisions brought in by this merge.
267
        rev_id_iterator = _get_sorted_revisions(merge, merge_extra,
268
                            branch.repository.get_parent_map(merge_extra))
269
        # Skip the first node
270
        num, first, depth, eom = rev_id_iterator.next()
271
        if first != merge:
272
            raise AssertionError('Somehow we misunderstood how'
273
                ' iter_topo_order works %s != %s' % (first, merge))
274
        for num, sub_merge, depth, eom in rev_id_iterator:
275
            rev = revisions[sub_merge]
276
            if rev is None:
277
                to_file.write(sub_prefix + '(ghost) ' + sub_merge + '\n')
278
                continue
4747.3.6 by Vincent Ladeuil
terminal_width can now returns None.
279
            show_log_message(revisions[sub_merge], sub_prefix)
3224.5.19 by Andrew Bennetts
Move _raise_if_nonexistent into the only module that uses it, bzrlib.status.
280
281
3930.2.4 by Karl Fogel
* bzrlib/status.py
282
def _filter_nonexistent(orig_paths, old_tree, new_tree):
3930.2.15 by Karl Fogel
Part of bug #306394: Ensure sorted order for nonexistent file output.
283
    """Convert orig_paths to two sorted lists and return them.
3930.2.2 by Karl Fogel
* bzrlib/status.py
284
285
    The first is orig_paths paths minus the items in the second list,
286
    and the second list is paths that are not in either inventory or
287
    tree (they don't qualify if they exist in the tree's inventory, or
288
    if they exist in the tree but are not versioned.)
289
290
    If either of the two lists is empty, return it as an empty list.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
291
3224.5.19 by Andrew Bennetts
Move _raise_if_nonexistent into the only module that uses it, bzrlib.status.
292
    This can be used by operations such as bzr status that can accept
293
    unknown or ignored files.
294
    """
3930.2.2 by Karl Fogel
* bzrlib/status.py
295
    mutter("check paths: %r", orig_paths)
296
    if not orig_paths:
297
        return orig_paths, []
298
    s = old_tree.filter_unversioned_files(orig_paths)
3224.5.19 by Andrew Bennetts
Move _raise_if_nonexistent into the only module that uses it, bzrlib.status.
299
    s = new_tree.filter_unversioned_files(s)
3930.2.2 by Karl Fogel
* bzrlib/status.py
300
    nonexistent = [path for path in s if not new_tree.has_filename(path)]
301
    remaining   = [path for path in orig_paths if not path in nonexistent]
3930.2.15 by Karl Fogel
Part of bug #306394: Ensure sorted order for nonexistent file output.
302
    # Sorting the 'remaining' list doesn't have much effect in
303
    # practice, since the various status output sections will sort
304
    # their groups individually.  But for consistency of this
305
    # function's API, it's better to sort both than just 'nonexistent'.
306
    return sorted(remaining), sorted(nonexistent)