← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to bzrtools.py

  • Committer: Aaron Bentley
  • Date: 2008-11-05 00:11:09 UTC
  • mto: This revision was merged to the branch mainline in revision 678.
  • Revision ID: aaron@aaronbentley.com-20081105001109-yt2dp0h5h3ssb7xt
Restore runtime ignore for .shelf

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrtools.py
1
 
# Copyright (C) 2005 Aaron Bentley
2
 
# <aaron.bentley@utoronto.ca>
 
1
# Copyright (C) 2005, 2006, 2007 Aaron Bentley <aaron@aaronbentley.com>
 
2
# Copyright (C) 2007 John Arbash Meinel
3
3
#
4
4
#    This program is free software; you can redistribute it and/or modify
5
5
#    it under the terms of the GNU General Public License as published by
24
24
import sys
25
25
 
26
26
import bzrlib
 
27
from bzrlib import revision as _mod_revision, trace, urlutils
27
28
import bzrlib.errors
28
 
from bzrlib.errors import BzrCommandError
29
 
from bzrlib.bzrdir import BzrDir
 
29
from bzrlib.errors import (
 
30
    BzrCommandError,
 
31
    BzrError,
 
32
    ConnectionError,
 
33
    NotBranchError,
 
34
    NoSuchFile,
 
35
    NoWorkingTree,
 
36
    PermissionDenied,
 
37
    UnsupportedFormatError,
 
38
    TransportError,
 
39
    )
 
40
from bzrlib.bzrdir import BzrDir, BzrDirFormat
 
41
from bzrlib.transport import get_transport
30
42
 
31
43
def temp_tree():
32
44
    dirname = tempfile.mkdtemp("temp-branch")
38
50
def is_clean(cur_tree):
39
51
    """
40
52
    Return true if no files are modifed or unknown
41
 
    >>> import bzrlib.add
42
 
    >>> tree = temp_tree()
43
 
    >>> is_clean(tree)
44
 
    (True, [])
45
 
    >>> fooname = os.path.join(tree.basedir, "foo")
46
 
    >>> file(fooname, "wb").write("bar")
47
 
    >>> is_clean(tree)
48
 
    (True, [u'foo'])
49
 
    >>> bzrlib.add.smart_add_tree(tree, [tree.basedir])
50
 
    ([u'foo'], {})
51
 
    >>> is_clean(tree)
52
 
    (False, [])
53
 
    >>> tree.commit("added file")
54
 
    >>> is_clean(tree)
55
 
    (True, [])
56
 
    >>> rm_tree(tree)
57
53
    """
58
 
    from bzrlib.diff import compare_trees
59
54
    old_tree = cur_tree.basis_tree()
60
55
    new_tree = cur_tree
61
56
    non_source = []
62
 
    for path, file_class, kind, file_id, entry in new_tree.list_files():
63
 
        if file_class in ('?', 'I'):
64
 
            non_source.append(path)
65
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False)
 
57
    new_tree.lock_read()
 
58
    try:
 
59
        for path, file_class, kind, file_id, entry in new_tree.list_files():
 
60
            if file_class in ('?', 'I'):
 
61
                non_source.append(path)
 
62
        delta = new_tree.changes_from(old_tree, want_unchanged=False)
 
63
    finally:
 
64
        new_tree.unlock()
66
65
    return not delta.has_changed(), non_source
67
66
 
68
67
def set_push_data(tree, location):
69
 
    push_file = file (tree.branch.control_files.controlfilename("x-push-data"), "wb")
70
 
    push_file.write("%s\n" % location)
 
68
    tree.branch._transport.put_bytes("x-push-data", "%s\n" % location)
71
69
 
72
70
def get_push_data(tree):
73
71
    """
76
74
    True
77
75
    >>> set_push_data(tree, 'http://somewhere')
78
76
    >>> get_push_data(tree)
79
 
    'http://somewhere'
 
77
    u'http://somewhere'
80
78
    >>> rm_tree(tree)
81
79
    """
82
 
    filename = tree.branch.control_files.controlfilename("x-push-data")
83
 
    if not os.path.exists(filename):
 
80
    try:
 
81
        location = tree.branch._transport.get('x-push-data').read()
 
82
    except NoSuchFile:
84
83
        return None
85
 
    push_file = file (filename, "rb")
86
 
    (location,) = [f.rstrip('\n') for f in push_file]
87
 
    return location
 
84
    location = location.decode('utf-8')
 
85
    return location.rstrip('\n')
88
86
 
89
87
"""
90
88
>>> shell_escape('hello')
112
110
    def __init__(self, rsync_name):
113
111
        Exception.__init__(self, "%s not found." % rsync_name)
114
112
 
115
 
def rsync(source, target, ssh=False, excludes=(), silent=False, 
 
113
 
 
114
def rsync(source, target, ssh=False, excludes=(), silent=False,
116
115
          rsync_name="rsync"):
117
 
    """
118
 
    >>> new_dir = tempfile.mkdtemp()
119
 
    >>> old_dir = os.getcwd()
120
 
    >>> os.chdir(new_dir)
121
 
    >>> rsync("a", "b", silent=True)
122
 
    Traceback (most recent call last):
123
 
    RsyncNoFile: No such file...
124
 
    >>> rsync(new_dir + "/a", new_dir + "/b", excludes=("*.py",), silent=True)
125
 
    Traceback (most recent call last):
126
 
    RsyncNoFile: No such file...
127
 
    >>> rsync(new_dir + "/a", new_dir + "/b", excludes=("*.py",), silent=True, rsync_name="rsyncc")
128
 
    Traceback (most recent call last):
129
 
    NoRsync: rsyncc not found.
130
 
    >>> os.chdir(old_dir)
131
 
    >>> os.rmdir(new_dir)
132
 
    """
133
116
    cmd = [rsync_name, "-av", "--delete"]
134
117
    if ssh:
135
118
        cmd.extend(('-e', 'ssh'))
147
130
    except OSError, e:
148
131
        if e.errno == errno.ENOENT:
149
132
            raise NoRsync(rsync_name)
150
 
            
 
133
 
151
134
    proc.stdin.write('\n'.join(excludes)+'\n')
152
135
    proc.stdin.close()
153
136
    if silent:
189
172
        raise RsyncUnknownStatus(proc.returncode)
190
173
    return [l.split(' ')[-1].rstrip('\n') for l in result.splitlines(True)]
191
174
 
192
 
exclusions = ('.bzr/x-push-data', '.bzr/branch/x-push/data', '.bzr/parent', 
 
175
exclusions = ('.bzr/x-push-data', '.bzr/branch/x-push/data', '.bzr/parent',
193
176
              '.bzr/branch/parent', '.bzr/x-pull-data', '.bzr/x-pull',
194
177
              '.bzr/pull', '.bzr/stat-cache', '.bzr/x-rsync-data',
195
178
              '.bzr/basis-inventory', '.bzr/inventory.backup.weave')
199
182
    return [l.rstrip('\r\n') for l in
200
183
            codecs.open(fname, 'rb', 'utf-8').readlines()]
201
184
 
 
185
 
 
186
def read_revision_info(path):
 
187
    """Parse a last_revision file to determine revision_info"""
 
188
    line = open(path, 'rb').readlines()[0].strip('\n')
 
189
    revno, revision_id = line.split(' ', 1)
 
190
    revno = int(revno)
 
191
    return revno, revision_id
 
192
 
 
193
 
202
194
class RsyncNoFile(Exception):
203
195
    def __init__(self, path):
204
196
        Exception.__init__(self, "No such file %s" % path)
207
199
    def __init__(self):
208
200
        Exception.__init__(self, "Error in rsync protocol data stream.")
209
201
 
210
 
def get_revision_history(location):
 
202
 
 
203
class NotStandalone(BzrError):
 
204
 
 
205
    _fmt = '%(location)s is not a standalone tree.'
 
206
    _internal = False
 
207
 
 
208
    def __init__(self, location):
 
209
        BzrError.__init__(self, location=location)
 
210
 
 
211
 
 
212
def get_revision_history(location, _rsync):
211
213
    tempdir = tempfile.mkdtemp('push')
 
214
    my_rsync = _rsync
 
215
    if my_rsync is None:
 
216
        my_rsync = rsync
212
217
    try:
213
218
        history_fname = os.path.join(tempdir, 'revision-history')
214
219
        try:
215
 
            cmd = rsync(location+'.bzr/revision-history', history_fname,
 
220
            cmd = my_rsync(location+'.bzr/revision-history', history_fname,
216
221
                        silent=True)
217
222
        except RsyncNoFile:
218
223
            cmd = rsync(location+'.bzr/branch/revision-history', history_fname,
222
227
        shutil.rmtree(tempdir)
223
228
    return history
224
229
 
225
 
def history_subset(location, branch):
226
 
    remote_history = get_revision_history(location)
 
230
 
 
231
def get_revision_info(location, _rsync):
 
232
    """Get the revsision_info for an rsync-able branch"""
 
233
    tempdir = tempfile.mkdtemp('push')
 
234
    my_rsync = _rsync
 
235
    if my_rsync is None:
 
236
        my_rsync = rsync
 
237
    try:
 
238
        info_fname = os.path.join(tempdir, 'last-revision')
 
239
        cmd = rsync(location+'.bzr/branch/last-revision', info_fname,
 
240
                    silent=True)
 
241
        return read_revision_info(info_fname)
 
242
    finally:
 
243
        shutil.rmtree(tempdir)
 
244
 
 
245
 
 
246
def history_subset(location, branch, _rsync=None):
227
247
    local_history = branch.revision_history()
228
 
    if len(remote_history) > len(local_history):
229
 
        return False
230
 
    for local, remote in zip(remote_history, local_history):
231
 
        if local != remote:
232
 
            return False 
233
 
    return True
 
248
    try:
 
249
        remote_history = get_revision_history(location, _rsync)
 
250
    except RsyncNoFile:
 
251
        revno, revision_id = get_revision_info(location, _rsync)
 
252
        if revision_id == _mod_revision.NULL_REVISION:
 
253
            return True
 
254
        return bool(revision_id.decode('utf-8') in local_history)
 
255
    else:
 
256
        if len(remote_history) > len(local_history):
 
257
            return False
 
258
        for local, remote in zip(remote_history, local_history):
 
259
            if local != remote:
 
260
                return False
 
261
        return True
 
262
 
234
263
 
235
264
def empty_or_absent(location):
236
265
    try:
239
268
    except RsyncNoFile:
240
269
        return True
241
270
 
242
 
def push(tree, location=None, overwrite=False, working_tree=True):
243
 
    push_location = get_push_data(tree)
244
 
    if location is not None:
245
 
        if not location.endswith('/'):
246
 
            location += '/'
247
 
        push_location = location
248
 
    
249
 
    if push_location is None:
250
 
        if tree.branch.get_push_location() is None:
251
 
            raise BzrCommandError("No push location known or specified.")
252
 
        else:
253
 
            raise bzrlib.errors.MustUseDecorated
254
 
 
255
 
    if push_location.find('://') != -1:
256
 
        raise bzrlib.errors.MustUseDecorated
257
 
 
258
 
    if push_location.find(':') == -1:
259
 
        raise bzrlib.errors.MustUseDecorated
260
 
 
261
 
    if working_tree:
262
 
        clean, non_source = is_clean(tree)
263
 
        if not clean:
264
 
            print """Error: This tree has uncommitted changes or unknown (?) files.
265
 
    Use "bzr status" to list them."""
266
 
            sys.exit(1)
267
 
        final_exclusions = non_source[:]
268
 
    else:
269
 
        wt = tree
270
 
        final_exclusions = []
271
 
        for path, status, kind, file_id, entry in wt.list_files():
272
 
            final_exclusions.append(path)
273
 
 
274
 
    final_exclusions.extend(exclusions)
275
 
    if not overwrite:
276
 
        try:
277
 
            if not history_subset(push_location, tree.branch):
278
 
                raise bzrlib.errors.BzrCommandError("Local branch is not a"
279
 
                                                    " newer version of remote"
280
 
                                                    " branch.")
281
 
        except RsyncNoFile:
282
 
            if not empty_or_absent(push_location):
283
 
                raise bzrlib.errors.BzrCommandError("Remote location is not a"
284
 
                                                    " bzr branch (or empty"
285
 
                                                    " directory)")
286
 
        except RsyncStreamIO:
287
 
            raise bzrlib.errors.BzrCommandError("Rsync could not use the"
288
 
                " specified location.  Please ensure that"
289
 
                ' "%s" is of the form "machine:/path".' % push_location)
290
 
    print "Pushing to %s" % push_location
291
 
    rsync(tree.basedir+'/', push_location, ssh=True, 
292
 
          excludes=final_exclusions)
293
 
 
294
 
    set_push_data(tree, push_location)
 
271
def rspush(tree, location=None, overwrite=False, working_tree=True,
 
272
    _rsync=None):
 
273
    tree.lock_write()
 
274
    try:
 
275
        my_rsync = _rsync
 
276
        if my_rsync is None:
 
277
            my_rsync = rsync
 
278
        if (tree.bzrdir.root_transport.base !=
 
279
            tree.branch.bzrdir.root_transport.base):
 
280
            raise NotStandalone(tree.bzrdir.root_transport.base)
 
281
        if (tree.branch.get_bound_location() is not None):
 
282
            raise NotStandalone(tree.bzrdir.root_transport.base)
 
283
        if (tree.branch.repository.is_shared()):
 
284
            raise NotStandalone(tree.bzrdir.root_transport.base)
 
285
        push_location = get_push_data(tree)
 
286
        if location is not None:
 
287
            if not location.endswith('/'):
 
288
                location += '/'
 
289
            push_location = location
 
290
 
 
291
        if push_location is None:
 
292
            raise BzrCommandError("No rspush location known or specified.")
 
293
 
 
294
        if (push_location.find('::') != -1):
 
295
            usessh=False
 
296
        else:
 
297
            usessh=True
 
298
 
 
299
        if (push_location.find('://') != -1 or
 
300
            push_location.find(':') == -1):
 
301
            raise BzrCommandError("Invalid rsync path %r." % push_location)
 
302
 
 
303
        if working_tree:
 
304
            clean, non_source = is_clean(tree)
 
305
            if not clean:
 
306
                raise bzrlib.errors.BzrCommandError(
 
307
                    'This tree has uncommitted changes or unknown'
 
308
                    ' (?) files.  Use "bzr status" to list them.')
 
309
                sys.exit(1)
 
310
            final_exclusions = non_source[:]
 
311
        else:
 
312
            wt = tree
 
313
            final_exclusions = []
 
314
            for path, status, kind, file_id, entry in wt.list_files():
 
315
                final_exclusions.append(path)
 
316
 
 
317
        final_exclusions.extend(exclusions)
 
318
        if not overwrite:
 
319
            try:
 
320
                if not history_subset(push_location, tree.branch,
 
321
                                      _rsync=my_rsync):
 
322
                    raise bzrlib.errors.BzrCommandError(
 
323
                        "Local branch is not a newer version of remote"
 
324
                        " branch.")
 
325
            except RsyncNoFile:
 
326
                if not empty_or_absent(push_location):
 
327
                    raise bzrlib.errors.BzrCommandError(
 
328
                        "Remote location is not a bzr branch (or empty"
 
329
                        " directory)")
 
330
            except RsyncStreamIO:
 
331
                raise bzrlib.errors.BzrCommandError("Rsync could not use the"
 
332
                    " specified location.  Please ensure that"
 
333
                    ' "%s" is of the form "machine:/path".' % push_location)
 
334
        trace.note("Pushing to %s", push_location)
 
335
        my_rsync(tree.basedir+'/', push_location, ssh=usessh,
 
336
                 excludes=final_exclusions)
 
337
 
 
338
        set_push_data(tree, push_location)
 
339
    finally:
 
340
        tree.unlock()
295
341
 
296
342
 
297
343
def short_committer(committer):
301
347
    return new_committer
302
348
 
303
349
 
 
350
def apache_ls(t):
 
351
    """Screen-scrape Apache listings"""
 
352
    apache_dir = '<img border="0" src="/icons/folder.gif" alt="[dir]">'\
 
353
        ' <a href="'
 
354
    t = t.clone()
 
355
    t._remote_path = lambda x: t.base
 
356
    try:
 
357
        lines = t.get('')
 
358
    except bzrlib.errors.NoSuchFile:
 
359
        return
 
360
    expr = re.compile('<a[^>]*href="([^>]*)\/"[^>]*>', flags=re.I)
 
361
    for line in lines:
 
362
        match = expr.search(line)
 
363
        if match is None:
 
364
            continue
 
365
        url = match.group(1)
 
366
        if url.startswith('http://') or url.startswith('/') or '../' in url:
 
367
            continue
 
368
        if '?' in url:
 
369
            continue
 
370
        yield url.rstrip('/')
 
371
 
 
372
 
 
373
def list_branches(t):
 
374
    def is_inside(branch):
 
375
        return bool(branch.base.startswith(t.base))
 
376
 
 
377
    if t.base.startswith('http://'):
 
378
        def evaluate(bzrdir):
 
379
            try:
 
380
                branch = bzrdir.open_branch()
 
381
                if is_inside(branch):
 
382
                    return True, branch
 
383
                else:
 
384
                    return True, None
 
385
            except NotBranchError:
 
386
                return True, None
 
387
        return [b for b in BzrDir.find_bzrdirs(t, list_current=apache_ls,
 
388
                evaluate=evaluate) if b is not None]
 
389
    elif not t.listable():
 
390
        raise BzrCommandError("Can't list this type of location.")
 
391
    return [b for b in BzrDir.find_branches(t) if is_inside(b)]
 
392
 
 
393
 
 
394
def evaluate_branch_tree(bzrdir):
 
395
    try:
 
396
        tree, branch = bzrdir._get_tree_branch()
 
397
    except NotBranchError:
 
398
        return True, None
 
399
    else:
 
400
        return True, (branch, tree)
 
401
 
 
402
 
 
403
def iter_branch_tree(t, lister=None):
 
404
    return (x for x in BzrDir.find_bzrdirs(t, evaluate=evaluate_branch_tree,
 
405
            list_current=lister) if x is not None)
 
406
 
 
407
 
 
408
def open_from_url(location):
 
409
    location = urlutils.normalize_url(location)
 
410
    dirname, basename = urlutils.split(location)
 
411
    return get_transport(dirname).get(basename)
 
412
 
 
413
 
304
414
def run_tests():
305
415
    import doctest
306
416
    result = doctest.testmod()