~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/info.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-09 20:23:07 UTC
  • mfrom: (4265.1.4 bbc-merge)
  • Revision ID: pqm@pqm.ubuntu.com-20090409202307-n0depb16qepoe21o
(jam) Change _fetch_uses_deltas = False for CHK repos until we can
        write a better fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005, 2006, 2007 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
5
5
# the Free Software Foundation; either version 2 of the License, or
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
__all__ = ['show_bzrdir_info']
18
18
 
 
19
import os
19
20
import time
20
 
 
 
21
import sys
21
22
 
22
23
from bzrlib import (
 
24
    bzrdir,
23
25
    diff,
 
26
    errors,
24
27
    osutils,
25
28
    urlutils,
26
29
    )
27
30
from bzrlib.errors import (NoWorkingTree, NotBranchError,
28
31
                           NoRepositoryPresent, NotLocalUrl)
29
32
from bzrlib.missing import find_unmerged
30
 
from bzrlib.symbol_versioning import (deprecated_function,
31
 
        zero_eight)
32
33
 
33
34
 
34
35
def plural(n, base='', pl=None):
40
41
        return 's'
41
42
 
42
43
 
43
 
def _repo_rel_url(repo_url, inner_url):
44
 
    """Return path with common prefix of repository path removed.
45
 
 
46
 
    If path is not part of the repository, the original path is returned.
47
 
    If path is equal to the repository, the current directory marker '.' is
48
 
    returned.
49
 
    Otherwise, a relative path is returned, with trailing '/' stripped.
50
 
    """
51
 
    inner_url = urlutils.normalize_url(inner_url)
52
 
    repo_url = urlutils.normalize_url(repo_url)
53
 
    if inner_url == repo_url:
54
 
        return '.'
55
 
    result = urlutils.relative_url(repo_url, inner_url)
56
 
    if result != inner_url:
57
 
        result = result.rstrip('/')
58
 
    return result
59
 
 
60
 
 
61
 
def _show_location_info(repository, branch=None, working=None):
62
 
    """Show known locations for working, branch and repository."""
 
44
class LocationList(object):
 
45
 
 
46
    def __init__(self, base_path):
 
47
        self.locs = []
 
48
        self.base_path = base_path
 
49
 
 
50
    def add_url(self, label, url):
 
51
        """Add a URL to the list, converting it to a path if possible"""
 
52
        if url is None:
 
53
            return
 
54
        try:
 
55
            path = urlutils.local_path_from_url(url)
 
56
        except errors.InvalidURL:
 
57
            self.locs.append((label, url))
 
58
        else:
 
59
            self.add_path(label, path)
 
60
 
 
61
    def add_path(self, label, path):
 
62
        """Add a path, converting it to a relative path if possible"""
 
63
        try:
 
64
            path = osutils.relpath(self.base_path, path)
 
65
        except errors.PathNotChild:
 
66
            pass
 
67
        else:
 
68
            if path == '':
 
69
                path = '.'
 
70
        if path != '/':
 
71
            path = path.rstrip('/')
 
72
        self.locs.append((label, path))
 
73
 
 
74
    def get_lines(self):
 
75
        max_len = max(len(l) for l, u in self.locs)
 
76
        return ["  %*s: %s\n" % (max_len, l, u) for l, u in self.locs ]
 
77
 
 
78
 
 
79
def gather_location_info(repository, branch=None, working=None):
 
80
    locs = {}
63
81
    repository_path = repository.bzrdir.root_transport.base
64
 
    print 'Location:'
65
 
    if working and branch:
 
82
    if branch is not None:
 
83
        branch_path = branch.bzrdir.root_transport.base
 
84
        master_path = branch.get_bound_location()
 
85
        if master_path is None:
 
86
            master_path = branch_path
 
87
    else:
 
88
        branch_path = None
 
89
        master_path = None
 
90
    if working:
66
91
        working_path = working.bzrdir.root_transport.base
67
 
        branch_path = branch.bzrdir.root_transport.base
68
92
        if working_path != branch_path:
69
 
            # lightweight checkout
70
 
            print ' light checkout root: %s' % working_path
 
93
            locs['light checkout root'] = working_path
 
94
        if master_path != branch_path:
71
95
            if repository.is_shared():
72
 
                # lightweight checkout of branch in shared repository
73
 
                print '   shared repository: %s' % repository_path
74
 
                print '   repository branch: %s' % (
75
 
                    _repo_rel_url(repository_path, branch_path))
 
96
                locs['repository checkout root'] = branch_path
76
97
            else:
77
 
                # lightweight checkout of standalone branch
78
 
                print '  checkout of branch: %s' % branch_path
 
98
                locs['checkout root'] = branch_path
 
99
        if working_path != master_path:
 
100
            locs['checkout of branch'] = master_path
79
101
        elif repository.is_shared():
80
 
            # branch with tree inside shared repository
81
 
            print '    shared repository: %s' % repository_path
82
 
            print '  repository checkout: %s' % (
83
 
                _repo_rel_url(repository_path, branch_path))
84
 
        elif branch.get_bound_location():
85
 
            # normal checkout
86
 
            print '       checkout root: %s' % working_path
87
 
            print '  checkout of branch: %s' % branch.get_bound_location()
88
 
        else:
 
102
            locs['repository branch'] = branch_path
 
103
        elif branch_path is not None:
89
104
            # standalone
90
 
            print '  branch root: %s' % working_path
91
 
    elif branch:
92
 
        branch_path = branch.bzrdir.root_transport.base
 
105
            locs['branch root'] = branch_path
 
106
    else:
 
107
        working_path = None
93
108
        if repository.is_shared():
94
 
            # branch is part of shared repository
95
 
            print '  shared repository: %s' % repository_path
96
 
            print '  repository branch: %s' % (
97
 
                _repo_rel_url(repository_path, branch_path))
 
109
            # lightweight checkout of branch in shared repository
 
110
            if branch_path is not None:
 
111
                locs['repository branch'] = branch_path
 
112
        elif branch_path is not None:
 
113
            # standalone
 
114
            locs['branch root'] = branch_path
 
115
            if master_path != branch_path:
 
116
                locs['bound to branch'] = master_path
98
117
        else:
99
 
            # standalone branch
100
 
            print '  branch root: %s' % branch_path
101
 
    else:
102
 
        # shared repository
103
 
        assert repository.is_shared()
104
 
        print '  shared repository: %s' % repository_path
105
 
 
106
 
 
107
 
def _show_related_info(branch):
 
118
            locs['repository'] = repository_path
 
119
    if repository.is_shared():
 
120
        # lightweight checkout of branch in shared repository
 
121
        locs['shared repository'] = repository_path
 
122
    order = ['light checkout root', 'repository checkout root',
 
123
             'checkout root', 'checkout of branch', 'shared repository',
 
124
             'repository', 'repository branch', 'branch root',
 
125
             'bound to branch']
 
126
    return [(n, locs[n]) for n in order if n in locs]
 
127
 
 
128
 
 
129
def _show_location_info(locs, outfile):
 
130
    """Show known locations for working, branch and repository."""
 
131
    outfile.write('Location:\n')
 
132
    path_list = LocationList(osutils.getcwd())
 
133
    for name, loc in locs:
 
134
        path_list.add_url(name, loc)
 
135
    outfile.writelines(path_list.get_lines())
 
136
 
 
137
 
 
138
def _gather_related_branches(branch):
 
139
    locs = LocationList(osutils.getcwd())
 
140
    locs.add_url('public branch', branch.get_public_branch())
 
141
    locs.add_url('push branch', branch.get_push_location())
 
142
    locs.add_url('parent branch', branch.get_parent())
 
143
    locs.add_url('submit branch', branch.get_submit_branch())
 
144
    try:
 
145
        locs.add_url('stacked on', branch.get_stacked_on_url())
 
146
    except (errors.UnstackableBranchFormat, errors.UnstackableRepositoryFormat,
 
147
        errors.NotStacked):
 
148
        pass
 
149
    return locs
 
150
 
 
151
 
 
152
def _show_related_info(branch, outfile):
108
153
    """Show parent and push location of branch."""
109
 
    if branch.get_parent() or branch.get_push_location():
110
 
        print
111
 
        print 'Related branches:'
112
 
        if branch.get_parent():
113
 
            if branch.get_push_location():
114
 
                print '      parent branch: %s' % branch.get_parent()
115
 
            else:
116
 
                print '  parent branch: %s' % branch.get_parent()
117
 
        if branch.get_push_location():
118
 
            print '  publish to branch: %s' % branch.get_push_location()
119
 
 
120
 
 
121
 
def _show_format_info(control=None, repository=None, branch=None, working=None):
 
154
    locs = _gather_related_branches(branch)
 
155
    if len(locs.locs) > 0:
 
156
        outfile.write('\n')
 
157
        outfile.write('Related branches:\n')
 
158
        outfile.writelines(locs.get_lines())
 
159
 
 
160
 
 
161
def _show_format_info(control=None, repository=None, branch=None,
 
162
                      working=None, outfile=None):
122
163
    """Show known formats for control, working, branch and repository."""
123
 
    print
124
 
    print 'Format:'
 
164
    outfile.write('\n')
 
165
    outfile.write('Format:\n')
125
166
    if control:
126
 
        print '       control: %s' % control._format.get_format_description()
 
167
        outfile.write('       control: %s\n' %
 
168
            control._format.get_format_description())
127
169
    if working:
128
 
        print '  working tree: %s' % working._format.get_format_description()
 
170
        outfile.write('  working tree: %s\n' %
 
171
            working._format.get_format_description())
129
172
    if branch:
130
 
        print '        branch: %s' % branch._format.get_format_description()
 
173
        outfile.write('        branch: %s\n' %
 
174
            branch._format.get_format_description())
131
175
    if repository:
132
 
        print '    repository: %s' % repository._format.get_format_description()
133
 
 
134
 
 
135
 
def _show_locking_info(repository, branch=None, working=None):
 
176
        outfile.write('    repository: %s\n' %
 
177
            repository._format.get_format_description())
 
178
 
 
179
 
 
180
def _show_locking_info(repository, branch=None, working=None, outfile=None):
136
181
    """Show locking status of working, branch and repository."""
137
182
    if (repository.get_physical_lock_status() or
138
183
        (branch and branch.get_physical_lock_status()) or
139
184
        (working and working.get_physical_lock_status())):
140
 
        print
141
 
        print 'Lock status:'
 
185
        outfile.write('\n')
 
186
        outfile.write('Lock status:\n')
142
187
        if working:
143
188
            if working.get_physical_lock_status():
144
189
                status = 'locked'
145
190
            else:
146
191
                status = 'unlocked'
147
 
            print '  working tree: %s' % status
 
192
            outfile.write('  working tree: %s\n' % status)
148
193
        if branch:
149
194
            if branch.get_physical_lock_status():
150
195
                status = 'locked'
151
196
            else:
152
197
                status = 'unlocked'
153
 
            print '        branch: %s' % status
 
198
            outfile.write('        branch: %s\n' % status)
154
199
        if repository:
155
200
            if repository.get_physical_lock_status():
156
201
                status = 'locked'
157
202
            else:
158
203
                status = 'unlocked'
159
 
            print '    repository: %s' % status
160
 
 
161
 
 
162
 
def _show_missing_revisions_branch(branch):
 
204
            outfile.write('    repository: %s\n' % status)
 
205
 
 
206
 
 
207
def _show_missing_revisions_branch(branch, outfile):
163
208
    """Show missing master revisions in branch."""
164
209
    # Try with inaccessible branch ?
165
210
    master = branch.get_master_branch()
166
211
    if master:
167
212
        local_extra, remote_extra = find_unmerged(branch, master)
168
213
        if remote_extra:
169
 
            print
170
 
            print 'Branch is out of date: missing %d revision%s.' % (
171
 
                len(remote_extra), plural(len(remote_extra)))
172
 
 
173
 
 
174
 
def _show_missing_revisions_working(working):
 
214
            outfile.write('\n')
 
215
            outfile.write(('Branch is out of date: missing %d '
 
216
                'revision%s.\n') % (len(remote_extra),
 
217
                plural(len(remote_extra))))
 
218
 
 
219
 
 
220
def _show_missing_revisions_working(working, outfile):
175
221
    """Show missing revisions in working tree."""
176
222
    branch = working.branch
177
223
    basis = working.basis_tree()
185
231
    if branch_revno and tree_last_id != branch_last_revision:
186
232
        tree_last_revno = branch.revision_id_to_revno(tree_last_id)
187
233
        missing_count = branch_revno - tree_last_revno
188
 
        print
189
 
        print 'Working tree is out of date: missing %d revision%s.' % (
190
 
            missing_count, plural(missing_count))
191
 
 
192
 
 
193
 
def _show_working_stats(working):
 
234
        outfile.write('\n')
 
235
        outfile.write(('Working tree is out of date: missing %d '
 
236
            'revision%s.\n') % (missing_count, plural(missing_count)))
 
237
 
 
238
 
 
239
def _show_working_stats(working, outfile):
194
240
    """Show statistics about a working tree."""
195
241
    basis = working.basis_tree()
196
242
    work_inv = working.inventory
197
243
    delta = working.changes_from(basis, want_unchanged=True)
198
244
 
199
 
    print
200
 
    print 'In the working tree:'
201
 
    print '  %8s unchanged' % len(delta.unchanged)
202
 
    print '  %8d modified' % len(delta.modified)
203
 
    print '  %8d added' % len(delta.added)
204
 
    print '  %8d removed' % len(delta.removed)
205
 
    print '  %8d renamed' % len(delta.renamed)
 
245
    outfile.write('\n')
 
246
    outfile.write('In the working tree:\n')
 
247
    outfile.write('  %8s unchanged\n' % len(delta.unchanged))
 
248
    outfile.write('  %8d modified\n' % len(delta.modified))
 
249
    outfile.write('  %8d added\n' % len(delta.added))
 
250
    outfile.write('  %8d removed\n' % len(delta.removed))
 
251
    outfile.write('  %8d renamed\n' % len(delta.renamed))
206
252
 
207
253
    ignore_cnt = unknown_cnt = 0
208
254
    for path in working.extras():
210
256
            ignore_cnt += 1
211
257
        else:
212
258
            unknown_cnt += 1
213
 
    print '  %8d unknown' % unknown_cnt
214
 
    print '  %8d ignored' % ignore_cnt
 
259
    outfile.write('  %8d unknown\n' % unknown_cnt)
 
260
    outfile.write('  %8d ignored\n' % ignore_cnt)
215
261
 
216
262
    dir_cnt = 0
217
263
    for file_id in work_inv:
218
 
        if (work_inv.get_file_kind(file_id) == 'directory' and 
 
264
        if (work_inv.get_file_kind(file_id) == 'directory' and
219
265
            not work_inv.is_root(file_id)):
220
266
            dir_cnt += 1
221
 
    print '  %8d versioned %s' \
222
 
          % (dir_cnt,
223
 
             plural(dir_cnt, 'subdirectory', 'subdirectories'))
224
 
 
225
 
 
226
 
def _show_branch_stats(branch, verbose):
 
267
    outfile.write('  %8d versioned %s\n' % (dir_cnt,
 
268
        plural(dir_cnt, 'subdirectory', 'subdirectories')))
 
269
 
 
270
 
 
271
def _show_branch_stats(branch, verbose, outfile):
227
272
    """Show statistics about a branch."""
228
273
    revno, head = branch.last_revision_info()
229
 
    print
230
 
    print 'Branch history:'
231
 
    print '  %8d revision%s' % (revno, plural(revno))
 
274
    outfile.write('\n')
 
275
    outfile.write('Branch history:\n')
 
276
    outfile.write('  %8d revision%s\n' % (revno, plural(revno)))
232
277
    stats = branch.repository.gather_stats(head, committers=verbose)
233
278
    if verbose:
234
279
        committers = stats['committers']
235
 
        print '  %8d committer%s' % (committers, plural(committers))
 
280
        outfile.write('  %8d committer%s\n' % (committers,
 
281
            plural(committers)))
236
282
    if revno:
237
283
        timestamp, timezone = stats['firstrev']
238
284
        age = int((time.time() - timestamp) / 3600 / 24)
239
 
        print '  %8d day%s old' % (age, plural(age))
240
 
        print '   first revision: %s' % osutils.format_date(timestamp,
241
 
            timezone)
 
285
        outfile.write('  %8d day%s old\n' % (age, plural(age)))
 
286
        outfile.write('   first revision: %s\n' %
 
287
            osutils.format_date(timestamp, timezone))
242
288
        timestamp, timezone = stats['latestrev']
243
 
        print '  latest revision: %s' % osutils.format_date(timestamp,
244
 
            timezone)
 
289
        outfile.write('  latest revision: %s\n' %
 
290
            osutils.format_date(timestamp, timezone))
245
291
    return stats
246
292
 
247
293
 
248
 
def _show_repository_info(repository):
 
294
def _show_repository_info(repository, outfile):
249
295
    """Show settings of a repository."""
250
296
    if repository.make_working_trees():
251
 
        print
252
 
        print 'Create working tree for new branches inside the repository.'
253
 
 
254
 
 
255
 
def _show_repository_stats(stats):
 
297
        outfile.write('\n')
 
298
        outfile.write('Create working tree for new branches inside '
 
299
            'the repository.\n')
 
300
 
 
301
 
 
302
def _show_repository_stats(stats, outfile):
256
303
    """Show statistics about a repository."""
257
304
    if 'revisions' in stats or 'size' in stats:
258
 
        print
259
 
        print 'Repository:'
 
305
        outfile.write('\n')
 
306
        outfile.write('Repository:\n')
260
307
    if 'revisions' in stats:
261
308
        revisions = stats['revisions']
262
 
        print '  %8d revision%s' % (revisions, plural(revisions))
 
309
        outfile.write('  %8d revision%s\n' % (revisions, plural(revisions)))
263
310
    if 'size' in stats:
264
 
        print '  %8d KiB' % (stats['size']/1024)
265
 
 
266
 
 
267
 
@deprecated_function(zero_eight)
268
 
def show_info(b):
269
 
    """Please see show_bzrdir_info."""
270
 
    return show_bzrdir_info(b.bzrdir)
271
 
 
272
 
 
273
 
def show_bzrdir_info(a_bzrdir, verbose=False):
 
311
        outfile.write('  %8d KiB\n' % (stats['size']/1024))
 
312
 
 
313
 
 
314
def show_bzrdir_info(a_bzrdir, verbose=False, outfile=None):
274
315
    """Output to stdout the 'info' for a_bzrdir."""
 
316
    if outfile is None:
 
317
        outfile = sys.stdout
275
318
    try:
276
 
        working = a_bzrdir.open_workingtree(
 
319
        tree = a_bzrdir.open_workingtree(
277
320
            recommend_upgrade=False)
278
 
        working.lock_read()
279
 
        try:
280
 
            show_tree_info(working, verbose)
281
 
        finally:
282
 
            working.unlock()
283
 
        return
284
321
    except (NoWorkingTree, NotLocalUrl):
285
 
        pass
286
 
 
287
 
    try:
288
 
        branch = a_bzrdir.open_branch()
289
 
        branch.lock_read()
290
 
        try:
291
 
            show_branch_info(branch, verbose)
292
 
        finally:
293
 
            branch.unlock()
294
 
        return
295
 
    except NotBranchError:
296
 
        pass
297
 
 
298
 
    try:
299
 
        repository = a_bzrdir.open_repository()
300
 
        repository.lock_read()
301
 
        try:
302
 
            show_repository_info(repository, verbose)
303
 
        finally:
304
 
            repository.unlock()
305
 
        return
306
 
    except NoRepositoryPresent:
307
 
        pass
308
 
 
309
 
    # Return silently, cmd_info already returned NotBranchError if no bzrdir
310
 
    # could be opened.
311
 
 
312
 
 
313
 
def show_tree_info(working, verbose):
314
 
    """Output to stdout the 'info' for working."""
315
 
    branch = working.branch
316
 
    repository = branch.repository
317
 
    control = working.bzrdir
318
 
 
319
 
    _show_location_info(repository, branch, working)
320
 
    _show_related_info(branch)
321
 
    _show_format_info(control, repository, branch, working)
322
 
    _show_locking_info(repository, branch, working)
323
 
    _show_missing_revisions_branch(branch)
324
 
    _show_missing_revisions_working(working)
325
 
    _show_working_stats(working)
326
 
    stats = _show_branch_stats(branch, verbose)
327
 
    _show_repository_stats(stats)
328
 
 
329
 
 
330
 
def show_branch_info(branch, verbose):
331
 
    """Output to stdout the 'info' for branch."""
332
 
    repository = branch.repository
333
 
    control = branch.bzrdir
334
 
 
335
 
    _show_location_info(repository, branch)
336
 
    _show_related_info(branch)
337
 
    _show_format_info(control, repository, branch)
338
 
    _show_locking_info(repository, branch)
339
 
    _show_missing_revisions_branch(branch)
340
 
    stats = _show_branch_stats(branch, verbose)
341
 
    _show_repository_stats(stats)
342
 
 
343
 
 
344
 
def show_repository_info(repository, verbose):
345
 
    """Output to stdout the 'info' for repository."""
346
 
    control = repository.bzrdir
347
 
 
348
 
    _show_location_info(repository)
349
 
    _show_format_info(control, repository)
350
 
    _show_locking_info(repository)
351
 
    _show_repository_info(repository)
352
 
    stats = repository.gather_stats()
353
 
    _show_repository_stats(stats)
 
322
        tree = None
 
323
        try:
 
324
            branch = a_bzrdir.open_branch()
 
325
        except NotBranchError:
 
326
            branch = None
 
327
            try:
 
328
                repository = a_bzrdir.open_repository()
 
329
            except NoRepositoryPresent:
 
330
                # Return silently; cmd_info already returned NotBranchError
 
331
                # if no bzrdir could be opened.
 
332
                return
 
333
            else:
 
334
                lockable = repository
 
335
        else:
 
336
            repository = branch.repository
 
337
            lockable = branch
 
338
    else:
 
339
        branch = tree.branch
 
340
        repository = branch.repository
 
341
        lockable = tree
 
342
 
 
343
    lockable.lock_read()
 
344
    try:
 
345
        show_component_info(a_bzrdir, repository, branch, tree, verbose,
 
346
                            outfile)
 
347
    finally:
 
348
        lockable.unlock()
 
349
 
 
350
 
 
351
def show_component_info(control, repository, branch=None, working=None,
 
352
    verbose=1, outfile=None):
 
353
    """Write info about all bzrdir components to stdout"""
 
354
    if outfile is None:
 
355
        outfile = sys.stdout
 
356
    if verbose is False:
 
357
        verbose = 1
 
358
    if verbose is True:
 
359
        verbose = 2
 
360
    layout = describe_layout(repository, branch, working)
 
361
    format = describe_format(control, repository, branch, working)
 
362
    outfile.write("%s (format: %s)\n" % (layout, format))
 
363
    _show_location_info(gather_location_info(repository, branch, working),
 
364
                        outfile)
 
365
    if branch is not None:
 
366
        _show_related_info(branch, outfile)
 
367
    if verbose == 0:
 
368
        return
 
369
    _show_format_info(control, repository, branch, working, outfile)
 
370
    _show_locking_info(repository, branch, working, outfile)
 
371
    if branch is not None:
 
372
        _show_missing_revisions_branch(branch, outfile)
 
373
    if working is not None:
 
374
        _show_missing_revisions_working(working, outfile)
 
375
        _show_working_stats(working, outfile)
 
376
    elif branch is not None:
 
377
        _show_missing_revisions_branch(branch, outfile)
 
378
    if branch is not None:
 
379
        show_committers = verbose >= 2
 
380
        stats = _show_branch_stats(branch, show_committers, outfile)
 
381
    else:
 
382
        stats = repository.gather_stats()
 
383
    if branch is None and working is None:
 
384
        _show_repository_info(repository, outfile)
 
385
    _show_repository_stats(stats, outfile)
 
386
 
 
387
 
 
388
def describe_layout(repository=None, branch=None, tree=None):
 
389
    """Convert a control directory layout into a user-understandable term
 
390
 
 
391
    Common outputs include "Standalone tree", "Repository branch" and
 
392
    "Checkout".  Uncommon outputs include "Unshared repository with trees"
 
393
    and "Empty control directory"
 
394
    """
 
395
    if repository is None:
 
396
        return 'Empty control directory'
 
397
    if branch is None and tree is None:
 
398
        if repository.is_shared():
 
399
            phrase = 'Shared repository'
 
400
        else:
 
401
            phrase = 'Unshared repository'
 
402
        if repository.make_working_trees():
 
403
            phrase += ' with trees'
 
404
        return phrase
 
405
    else:
 
406
        if repository.is_shared():
 
407
            independence = "Repository "
 
408
        else:
 
409
            independence = "Standalone "
 
410
        if tree is not None:
 
411
            phrase = "tree"
 
412
        else:
 
413
            phrase = "branch"
 
414
        if branch is None and tree is not None:
 
415
            phrase = "branchless tree"
 
416
        else:
 
417
            if (tree is not None and tree.bzrdir.root_transport.base !=
 
418
                branch.bzrdir.root_transport.base):
 
419
                independence = ''
 
420
                phrase = "Lightweight checkout"
 
421
            elif branch.get_bound_location() is not None:
 
422
                if independence == 'Standalone ':
 
423
                    independence = ''
 
424
                if tree is None:
 
425
                    phrase = "Bound branch"
 
426
                else:
 
427
                    phrase = "Checkout"
 
428
        if independence != "":
 
429
            phrase = phrase.lower()
 
430
        return "%s%s" % (independence, phrase)
 
431
 
 
432
 
 
433
def describe_format(control, repository, branch, tree):
 
434
    """Determine the format of an existing control directory
 
435
 
 
436
    Several candidates may be found.  If so, the names are returned as a
 
437
    single string, separated by ' or '.
 
438
 
 
439
    If no matching candidate is found, "unnamed" is returned.
 
440
    """
 
441
    candidates  = []
 
442
    if (branch is not None and tree is not None and
 
443
        branch.bzrdir.root_transport.base !=
 
444
        tree.bzrdir.root_transport.base):
 
445
        branch = None
 
446
        repository = None
 
447
    non_aliases = set(bzrdir.format_registry.keys())
 
448
    non_aliases.difference_update(bzrdir.format_registry.aliases())
 
449
    for key in non_aliases:
 
450
        format = bzrdir.format_registry.make_bzrdir(key)
 
451
        if isinstance(format, bzrdir.BzrDirMetaFormat1):
 
452
            if (tree and format.workingtree_format !=
 
453
                tree._format):
 
454
                continue
 
455
            if (branch and format.get_branch_format() !=
 
456
                branch._format):
 
457
                continue
 
458
            if (repository and format.repository_format !=
 
459
                repository._format):
 
460
                continue
 
461
        if format.__class__ is not control._format.__class__:
 
462
            continue
 
463
        candidates.append(key)
 
464
    if len(candidates) == 0:
 
465
        return 'unnamed'
 
466
    candidates.sort()
 
467
    new_candidates = [c for c in candidates if not
 
468
        bzrdir.format_registry.get_info(c).hidden]
 
469
    if len(new_candidates) > 0:
 
470
        # If there are any non-hidden formats that match, only return those to
 
471
        # avoid listing hidden formats except when only a hidden format will
 
472
        # do.
 
473
        candidates = new_candidates
 
474
    return ' or '.join(candidates)