← Back to branch summary

~abentley/bzrtools/bzrtools.dev

« back to all changes in this revision

Viewing changes to bzrtools.py

  • Committer: Aaron Bentley
  • Date: 2006-03-01 16:04:07 UTC
  • mto: (147.4.30 trunk)
  • mto: This revision was merged to the branch mainline in revision 324.
  • Revision ID: abentley@panoramicfeedback.com-20060301160407-c8db0a2c02699dd2
Stopped using deprecated PyBaz functionality

Show diffs side-by-side

added added

removed removed

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