« back to all changes in this revision
Viewing changes to bzrlib/branch.py
- browse files at revision 10
- compare with another revision
- download diff
- download tarball
- view history from revision 10
- Committer: mbp at sourcefrog
- Date: 2005-03-09 06:49:00 UTC
- Revision ID: mbp@sourcefrog.net-20050309064900-74935ffb7350b24b
import more files from baz
- files added:
- bzrlib/tests.py
- files removed:
- .bzrignore
- bzrlib/plugins
- bzrlib/selftest
- bzrlib/util
- bzrlib/util/effbot
- bzrlib/util/effbot/org
- bzrlib/util/elementtree
- bzrlib/util/urlgrabber
- contrib
- contrib/bash
- contrib/emacs
- contrib/zsh
- patches
- tools
- files renamed:
- bzrlib/commands.py => bzr.py
- files modified:
- README
added
removed
bzrlib/branch.py
1
# Copyright (C) 2005 Canonical Ltd
1
#! /usr/bin/env python
2
# -*- coding: UTF-8 -*-
2
3
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
17
17
18
18
import sys
19
import os
20
from cStringIO import StringIO
19
from sets import Set
20
21
import sys, os, os.path, random, time, sha, sets, types, re, shutil, tempfile
22
import traceback, socket, fnmatch, difflib, time
23
from binascii import hexlify
21
24
22
25
import bzrlib
23
from bzrlib.trace import mutter, note
24
from bzrlib.osutils import isdir, quotefn, compact_date, rand_bytes, \
25
splitpath, \
26
sha_file, appendpath, file_kind
27
28
from bzrlib.errors import (BzrError, InvalidRevisionNumber, InvalidRevisionId,
29
NoSuchRevision)
30
from bzrlib.textui import show_status
31
from bzrlib.revision import Revision
32
from bzrlib.delta import compare_trees
33
from bzrlib.tree import EmptyTree, RevisionTree
34
from bzrlib.inventory import Inventory
35
from bzrlib.weavestore import WeaveStore
36
from bzrlib.store import ImmutableStore
37
import bzrlib.xml5
38
import bzrlib.ui
39
40
41
INVENTORY_FILEID = '__inventory'
42
ANCESTRY_FILEID = '__ancestry'
43
44
45
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
46
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
26
from inventory import Inventory
27
from trace import mutter, note
28
from tree import Tree, EmptyTree, RevisionTree, WorkingTree
29
from inventory import InventoryEntry, Inventory
30
from osutils import isdir, quotefn, isfile, uuid, sha_file, username, chomp, \
31
format_date, compact_date, pumpfile, user_email, rand_bytes, splitpath, \
32
joinpath, sha_string, file_kind, local_time_offset
33
from store import ImmutableStore
34
from revision import Revision
35
from errors import bailout
36
from textui import show_status
37
from diff import diff_trees
38
39
BZR_BRANCH_FORMAT = "Bazaar-NG branch, format 0.0.4\n"
47
40
## TODO: Maybe include checks for common corruption of newlines, etc?
48
41
49
42
50
# TODO: Some operations like log might retrieve the same revisions
51
# repeatedly to calculate deltas. We could perhaps have a weakref
52
# cache in memory to make this faster. In general anything can be
53
# cached in memory between lock and unlock operations.
54
55
# TODO: please move the revision-string syntax stuff out of the branch
56
# object; it's clutter
57
58
59
def find_branch(f, **args):
60
if f and (f.startswith('http://') or f.startswith('https://')):
61
import remotebranch
62
return remotebranch.RemoteBranch(f, **args)
63
else:
64
return Branch(f, **args)
65
66
67
def find_cached_branch(f, cache_root, **args):
68
from remotebranch import RemoteBranch
69
br = find_branch(f, **args)
70
def cacheify(br, store_name):
71
from meta_store import CachedStore
72
cache_path = os.path.join(cache_root, store_name)
73
os.mkdir(cache_path)
74
new_store = CachedStore(getattr(br, store_name), cache_path)
75
setattr(br, store_name, new_store)
76
77
if isinstance(br, RemoteBranch):
78
cacheify(br, 'inventory_store')
79
cacheify(br, 'text_store')
80
cacheify(br, 'revision_store')
81
return br
82
83
84
def _relpath(base, path):
85
"""Return path relative to base, or raise exception.
86
87
The path may be either an absolute path or a path relative to the
88
current working directory.
89
90
Lifted out of Branch.relpath for ease of testing.
91
92
os.path.commonprefix (python2.4) has a bad bug that it works just
93
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
94
avoids that problem."""
95
rp = os.path.abspath(path)
96
97
s = []
98
head = rp
99
while len(head) >= len(base):
100
if head == base:
101
break
102
head, tail = os.path.split(head)
103
if tail:
104
s.insert(0, tail)
105
else:
106
from errors import NotBranchError
107
raise NotBranchError("path %r is not within branch %r" % (rp, base))
108
109
return os.sep.join(s)
110
111
112
def find_branch_root(f=None):
113
"""Find the branch root enclosing f, or pwd.
114
115
f may be a filename or a URL.
116
117
It is not necessary that f exists.
118
119
Basically we keep looking up until we find the control directory or
120
run into the root. If there isn't one, raises NotBranchError.
121
"""
122
if f == None:
123
f = os.getcwd()
124
elif hasattr(os.path, 'realpath'):
125
f = os.path.realpath(f)
126
else:
127
f = os.path.abspath(f)
128
if not os.path.exists(f):
129
raise BzrError('%r does not exist' % f)
130
131
132
orig_f = f
133
134
while True:
135
if os.path.exists(os.path.join(f, bzrlib.BZRDIR)):
136
return f
137
head, tail = os.path.split(f)
138
if head == f:
139
# reached the root, whatever that may be
140
raise bzrlib.errors.NotBranchError('%s is not in a branch' % orig_f)
141
f = head
142
143
144
145
# XXX: move into bzrlib.errors; subclass BzrError
146
class DivergedBranches(Exception):
147
def __init__(self, branch1, branch2):
148
self.branch1 = branch1
149
self.branch2 = branch2
150
Exception.__init__(self, "These branches have diverged.")
43
151
44
152
45
153
46
######################################################################
154
47
# branch objects
155
48
156
class Branch(object):
49
class Branch:
157
50
"""Branch holding a history of revisions.
158
51
159
base
160
Base directory of the branch.
161
162
_lock_mode
163
None, or 'r' or 'w'
164
165
_lock_count
166
If _lock_mode is true, a positive count of the number of times the
167
lock has been taken.
168
169
_lock
170
Lock object from bzrlib.lock.
52
:todo: Perhaps use different stores for different classes of object,
53
so that we can keep track of how much space each one uses,
54
or garbage-collect them.
55
56
:todo: Add a RemoteBranch subclass. For the basic case of read-only
57
HTTP access this should be very easy by,
58
just redirecting controlfile access into HTTP requests.
59
We would need a RemoteStore working similarly.
60
61
:todo: Keep the on-disk branch locked while the object exists.
62
63
:todo: mkdir() method.
171
64
"""
172
base = None
173
_lock_mode = None
174
_lock_count = None
175
_lock = None
176
_inventory_weave = None
177
178
# Map some sort of prefix into a namespace
179
# stuff like "revno:10", "revid:", etc.
180
# This should match a prefix with a function which accepts
181
REVISION_NAMESPACES = {}
182
183
def __init__(self, base, init=False, find_root=True):
65
def __init__(self, base, init=False):
184
66
"""Create new branch object at a particular location.
185
67
186
base -- Base directory for the branch.
187
188
init -- If True, create new control files in a previously
68
:param base: Base directory for the branch.
69
70
:param init: If True, create new control files in a previously
189
71
unversioned directory. If False, the branch must already
190
72
be versioned.
191
73
192
find_root -- If true and init is false, find the root of the
193
existing branch containing base.
194
195
74
In the test suite, creation of new trees is tested using the
196
75
`ScratchBranch` class.
197
76
"""
77
self.base = os.path.realpath(base)
198
78
if init:
199
self.base = os.path.realpath(base)
200
79
self._make_control()
201
elif find_root:
202
self.base = find_branch_root(base)
203
80
else:
204
self.base = os.path.realpath(base)
205
81
if not isdir(self.controlfilename('.')):
206
from errors import NotBranchError
207
raise NotBranchError("not a bzr branch: %s" % quotefn(base),
208
['use "bzr init" to initialize a new working tree',
209
'current bzr can only operate from top-of-tree'])
210
self._check_format()
82
bailout("not a bzr branch: %s" % quotefn(base),
83
['use "bzr init" to initialize a new working tree',
84
'current bzr can only operate from top-of-tree'])
85
self._check_format()
211
86
212
self.weave_store = WeaveStore(self.controlfilename('weaves'))
87
self.text_store = ImmutableStore(self.controlfilename('text-store'))
213
88
self.revision_store = ImmutableStore(self.controlfilename('revision-store'))
89
self.inventory_store = ImmutableStore(self.controlfilename('inventory-store'))
214
90
215
91
216
92
def __str__(self):
220
96
__repr__ = __str__
221
97
222
98
223
def __del__(self):
224
if self._lock_mode or self._lock:
225
from warnings import warn
226
warn("branch %r was not explicitly unlocked" % self)
227
self._lock.unlock()
228
229
230
def lock_write(self):
231
if self._lock_mode:
232
if self._lock_mode != 'w':
233
from errors import LockError
234
raise LockError("can't upgrade to a write lock from %r" %
235
self._lock_mode)
236
self._lock_count += 1
237
else:
238
from bzrlib.lock import WriteLock
239
240
self._lock = WriteLock(self.controlfilename('branch-lock'))
241
self._lock_mode = 'w'
242
self._lock_count = 1
243
244
245
def lock_read(self):
246
if self._lock_mode:
247
assert self._lock_mode in ('r', 'w'), \
248
"invalid lock mode %r" % self._lock_mode
249
self._lock_count += 1
250
else:
251
from bzrlib.lock import ReadLock
252
253
self._lock = ReadLock(self.controlfilename('branch-lock'))
254
self._lock_mode = 'r'
255
self._lock_count = 1
256
257
def unlock(self):
258
if not self._lock_mode:
259
from errors import LockError
260
raise LockError('branch %r is not locked' % (self))
261
262
if self._lock_count > 1:
263
self._lock_count -= 1
264
else:
265
self._lock.unlock()
266
self._lock = None
267
self._lock_mode = self._lock_count = None
268
269
def abspath(self, name):
270
"""Return absolute filename for something in the branch"""
99
def _rel(self, name):
100
"""Return filename relative to branch top"""
271
101
return os.path.join(self.base, name)
272
273
def relpath(self, path):
274
"""Return path relative to this branch of something inside it.
275
276
Raises an error if path is not in this branch."""
277
return _relpath(self.base, path)
102
278
103
279
104
def controlfilename(self, file_or_path):
280
105
"""Return location relative to branch."""
281
if isinstance(file_or_path, basestring):
106
if isinstance(file_or_path, types.StringTypes):
282
107
file_or_path = [file_or_path]
283
108
return os.path.join(self.base, bzrlib.BZRDIR, *file_or_path)
284
109
285
110
286
111
def controlfile(self, file_or_path, mode='r'):
287
"""Open a control file for this branch.
288
289
There are two classes of file in the control directory: text
290
and binary. binary files are untranslated byte streams. Text
291
control files are stored with Unix newlines and in UTF-8, even
292
if the platform or locale defaults are different.
293
294
Controlfiles should almost never be opened in write mode but
295
rather should be atomically copied and replaced using atomicfile.
296
"""
297
298
fn = self.controlfilename(file_or_path)
299
300
if mode == 'rb' or mode == 'wb':
301
return file(fn, mode)
302
elif mode == 'r' or mode == 'w':
303
# open in binary mode anyhow so there's no newline translation;
304
# codecs uses line buffering by default; don't want that.
305
import codecs
306
return codecs.open(fn, mode + 'b', 'utf-8',
307
buffering=60000)
308
else:
309
raise BzrError("invalid controlfile mode %r" % mode)
112
"""Open a control file for this branch"""
113
return file(self.controlfilename(file_or_path), mode)
114
310
115
311
116
def _make_control(self):
312
117
os.mkdir(self.controlfilename([]))
313
118
self.controlfile('README', 'w').write(
314
119
"This is a Bazaar-NG control directory.\n"
315
"Do not change any files in this directory.\n")
316
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT_5)
317
for d in ('text-store', 'revision-store',
318
'weaves'):
120
"Do not change any files in this directory.")
121
self.controlfile('branch-format', 'w').write(BZR_BRANCH_FORMAT)
122
for d in ('text-store', 'inventory-store', 'revision-store'):
319
123
os.mkdir(self.controlfilename(d))
320
124
for f in ('revision-history', 'merged-patches',
321
'pending-merged-patches', 'branch-name',
322
'branch-lock',
323
'pending-merges'):
125
'pending-merged-patches', 'branch-name'):
324
126
self.controlfile(f, 'w').write('')
325
127
mutter('created control directory in ' + self.base)
326
327
# if we want per-tree root ids then this is the place to set
328
# them; they're not needed for now and so ommitted for
329
# simplicity.
330
f = self.controlfile('inventory','w')
331
bzrlib.xml5.serializer_v5.write_inventory(Inventory(), f)
332
128
Inventory().write_xml(self.controlfile('inventory','w'))
333
129
334
130
335
131
def _check_format(self):
336
132
"""Check this branch format is supported.
337
133
338
The format level is stored, as an integer, in
339
self._branch_format for code that needs to check it later.
134
The current tool only supports the current unstable format.
340
135
341
136
In the future, we might need different in-memory Branch
342
137
classes to support downlevel branches. But not yet.
343
"""
344
fmt = self.controlfile('branch-format', 'r').read()
345
if fmt == BZR_BRANCH_FORMAT_5:
346
self._branch_format = 5
347
else:
348
raise BzrError('sorry, branch format "%s" not supported; '
349
'use a different bzr version, '
350
'or run "bzr upgrade", '
351
'or remove the .bzr directory and "bzr init" again'
352
% fmt.rstrip('\n\r'))
353
354
def get_root_id(self):
355
"""Return the id of this branches root"""
356
inv = self.read_working_inventory()
357
return inv.root.file_id
358
359
def set_root_id(self, file_id):
360
inv = self.read_working_inventory()
361
orig_root_id = inv.root.file_id
362
del inv._byid[inv.root.file_id]
363
inv.root.file_id = file_id
364
inv._byid[inv.root.file_id] = inv.root
365
for fid in inv:
366
entry = inv[fid]
367
if entry.parent_id in (None, orig_root_id):
368
entry.parent_id = inv.root.file_id
369
self._write_inventory(inv)
138
"""
139
# read in binary mode to detect newline wierdness.
140
fmt = self.controlfile('branch-format', 'rb').read()
141
if fmt != BZR_BRANCH_FORMAT:
142
bailout('sorry, branch format %r not supported' % fmt,
143
['use a different bzr version',
144
'or remove the .bzr directory and "bzr init" again'])
145
370
146
371
147
def read_working_inventory(self):
372
148
"""Read the working inventory."""
373
self.lock_read()
374
try:
375
# ElementTree does its own conversion from UTF-8, so open in
376
# binary.
377
f = self.controlfile('inventory', 'rb')
378
return bzrlib.xml5.serializer_v5.read_inventory(f)
379
finally:
380
self.unlock()
381
149
before = time.time()
150
inv = Inventory.read_xml(self.controlfile('inventory', 'r'))
151
mutter("loaded inventory of %d items in %f"
152
% (len(inv), time.time() - before))
153
return inv
154
382
155
383
156
def _write_inventory(self, inv):
384
157
"""Update the working inventory.
386
159
That is to say, the inventory describing changes underway, that
387
160
will be committed to the next revision.
388
161
"""
389
from bzrlib.atomicfile import AtomicFile
390
391
self.lock_write()
392
try:
393
f = AtomicFile(self.controlfilename('inventory'), 'wb')
394
try:
395
bzrlib.xml5.serializer_v5.write_inventory(inv, f)
396
f.commit()
397
finally:
398
f.close()
399
finally:
400
self.unlock()
401
402
mutter('wrote working inventory')
403
162
inv.write_xml(self.controlfile('inventory', 'w'))
163
mutter('wrote inventory to %s' % quotefn(self.controlfilename('inventory')))
164
404
165
405
166
inventory = property(read_working_inventory, _write_inventory, None,
406
167
"""Inventory for the working copy.""")
407
168
408
169
409
def add(self, files, ids=None):
170
def add(self, files, verbose=False):
410
171
"""Make files versioned.
411
172
412
Note that the command line normally calls smart_add instead,
413
which can automatically recurse.
414
415
173
This puts the files in the Added state, so that they will be
416
174
recorded by the next commit.
417
175
418
files
419
List of paths to add, relative to the base of the tree.
420
421
ids
422
If set, use these instead of automatically generated ids.
423
Must be the same length as the list of files, but may
424
contain None for ids that are to be autogenerated.
425
426
TODO: Perhaps have an option to add the ids even if the files do
427
not (yet) exist.
428
429
TODO: Perhaps yield the ids and paths as they're added.
176
:todo: Perhaps have an option to add the ids even if the files do
177
not (yet) exist.
178
179
:todo: Perhaps return the ids of the files? But then again it
180
is easy to retrieve them if they're needed.
181
182
:todo: Option to specify file id.
183
184
:todo: Adding a directory should optionally recurse down and
185
add all non-ignored children. Perhaps do that in a
186
higher-level method.
187
188
>>> b = ScratchBranch(files=['foo'])
189
>>> 'foo' in b.unknowns()
190
True
191
>>> b.show_status()
192
? foo
193
>>> b.add('foo')
194
>>> 'foo' in b.unknowns()
195
False
196
>>> bool(b.inventory.path2id('foo'))
197
True
198
>>> b.show_status()
199
A foo
200
201
>>> b.add('foo')
202
Traceback (most recent call last):
203
...
204
BzrError: ('foo is already versioned', [])
205
206
>>> b.add(['nothere'])
207
Traceback (most recent call last):
208
BzrError: ('cannot add: not a regular file or directory: nothere', [])
430
209
"""
210
431
211
# TODO: Re-adding a file that is removed in the working copy
432
212
# should probably put it back with the previous ID.
433
if isinstance(files, basestring):
434
assert(ids is None or isinstance(ids, basestring))
213
if isinstance(files, types.StringTypes):
435
214
files = [files]
436
if ids is not None:
437
ids = [ids]
438
439
if ids is None:
440
ids = [None] * len(files)
441
else:
442
assert(len(ids) == len(files))
443
444
self.lock_write()
445
try:
446
inv = self.read_working_inventory()
447
for f,file_id in zip(files, ids):
448
if is_control_file(f):
449
raise BzrError("cannot add control file %s" % quotefn(f))
450
451
fp = splitpath(f)
452
453
if len(fp) == 0:
454
raise BzrError("cannot add top-level %r" % f)
455
456
fullpath = os.path.normpath(self.abspath(f))
457
458
try:
459
kind = file_kind(fullpath)
460
except OSError:
461
# maybe something better?
462
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
463
464
if kind != 'file' and kind != 'directory':
465
raise BzrError('cannot add: not a regular file or directory: %s' % quotefn(f))
466
467
if file_id is None:
468
file_id = gen_file_id(f)
469
inv.add_path(f, kind=kind, file_id=file_id)
470
471
mutter("add file %s file_id:{%s} kind=%r" % (f, file_id, kind))
472
473
self._write_inventory(inv)
474
finally:
475
self.unlock()
476
477
478
def print_file(self, file, revno):
479
"""Print `file` to stdout."""
480
self.lock_read()
481
try:
482
tree = self.revision_tree(self.lookup_revision(revno))
483
# use inventory as it was in that revision
484
file_id = tree.inventory.path2id(file)
485
if not file_id:
486
raise BzrError("%r is not present in revision %s" % (file, revno))
487
tree.print_file(file_id)
488
finally:
489
self.unlock()
215
216
inv = self.read_working_inventory()
217
for f in files:
218
if is_control_file(f):
219
bailout("cannot add control file %s" % quotefn(f))
220
221
fp = splitpath(f)
222
223
if len(fp) == 0:
224
bailout("cannot add top-level %r" % f)
225
226
fullpath = os.path.normpath(self._rel(f))
227
228
if isfile(fullpath):
229
kind = 'file'
230
elif isdir(fullpath):
231
kind = 'directory'
232
else:
233
bailout('cannot add: not a regular file or directory: %s' % quotefn(f))
234
235
if len(fp) > 1:
236
parent_name = joinpath(fp[:-1])
237
mutter("lookup parent %r" % parent_name)
238
parent_id = inv.path2id(parent_name)
239
if parent_id == None:
240
bailout("cannot add: parent %r is not versioned"
241
% joinpath(fp[:-1]))
242
else:
243
parent_id = None
244
245
file_id = _gen_file_id(fp[-1])
246
inv.add(InventoryEntry(file_id, fp[-1], kind=kind, parent_id=parent_id))
247
if verbose:
248
show_status('A', kind, quotefn(f))
249
250
mutter("add file %s file_id:{%s} kind=%r parent_id={%s}"
251
% (f, file_id, kind, parent_id))
252
self._write_inventory(inv)
253
490
254
491
255
492
256
def remove(self, files, verbose=False):
494
258
495
259
This does not remove their text. This does not run on
496
260
497
TODO: Refuse to remove modified files unless --force is given?
498
499
TODO: Do something useful with directories.
500
501
TODO: Should this remove the text or not? Tough call; not
261
:todo: Refuse to remove modified files unless --force is given?
262
263
>>> b = ScratchBranch(files=['foo'])
264
>>> b.add('foo')
265
>>> b.inventory.has_filename('foo')
266
True
267
>>> b.remove('foo')
268
>>> b.working_tree().has_filename('foo')
269
True
270
>>> b.inventory.has_filename('foo')
271
False
272
273
>>> b = ScratchBranch(files=['foo'])
274
>>> b.add('foo')
275
>>> b.commit('one')
276
>>> b.remove('foo')
277
>>> b.commit('two')
278
>>> b.inventory.has_filename('foo')
279
False
280
>>> b.basis_tree().has_filename('foo')
281
False
282
>>> b.working_tree().has_filename('foo')
283
True
284
285
:todo: Do something useful with directories.
286
287
:todo: Should this remove the text or not? Tough call; not
502
288
removing may be useful and the user can just use use rm, and
503
289
is the opposite of add. Removing it is consistent with most
504
290
other tools. Maybe an option.
505
291
"""
506
292
## TODO: Normalize names
507
293
## TODO: Remove nested loops; better scalability
508
if isinstance(files, basestring):
294
295
if isinstance(files, types.StringTypes):
509
296
files = [files]
510
511
self.lock_write()
512
513
try:
514
tree = self.working_tree()
515
inv = tree.inventory
516
517
# do this before any modifications
518
for f in files:
519
fid = inv.path2id(f)
520
if not fid:
521
raise BzrError("cannot remove unversioned file %s" % quotefn(f))
522
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
523
if verbose:
524
# having remove it, it must be either ignored or unknown
525
if tree.is_ignored(f):
526
new_status = 'I'
527
else:
528
new_status = '?'
529
show_status(new_status, inv[fid].kind, quotefn(f))
530
del inv[fid]
531
532
self._write_inventory(inv)
533
finally:
534
self.unlock()
535
536
537
# FIXME: this doesn't need to be a branch method
538
def set_inventory(self, new_inventory_list):
539
from bzrlib.inventory import Inventory, InventoryEntry
540
inv = Inventory(self.get_root_id())
541
for path, file_id, parent, kind in new_inventory_list:
542
name = os.path.basename(path)
543
if name == "":
544
continue
545
inv.add(InventoryEntry(file_id, name, kind, parent))
297
298
inv = self.read_working_inventory()
299
300
# do this before any modifications
301
for f in files:
302
fid = inv.path2id(f)
303
if not fid:
304
bailout("cannot remove unversioned file %s" % quotefn(f))
305
mutter("remove inventory entry %s {%s}" % (quotefn(f), fid))
306
if verbose:
307
show_status('D', inv[fid].kind, quotefn(f))
308
del inv[fid]
309
546
310
self._write_inventory(inv)
547
311
548
312
565
329
return self.working_tree().unknowns()
566
330
567
331
568
def append_revision(self, *revision_ids):
569
from bzrlib.atomicfile import AtomicFile
570
571
for revision_id in revision_ids:
572
mutter("add {%s} to revision-history" % revision_id)
573
574
rev_history = self.revision_history()
575
rev_history.extend(revision_ids)
576
577
f = AtomicFile(self.controlfilename('revision-history'))
578
try:
579
for rev_id in rev_history:
580
print >>f, rev_id
581
f.commit()
582
finally:
583
f.close()
584
585
586
def get_revision_xml_file(self, revision_id):
587
"""Return XML file object for revision object."""
588
if not revision_id or not isinstance(revision_id, basestring):
589
raise InvalidRevisionId(revision_id)
590
591
self.lock_read()
592
try:
593
try:
594
return self.revision_store[revision_id]
595
except IndexError:
596
raise bzrlib.errors.NoSuchRevision(self, revision_id)
597
finally:
598
self.unlock()
599
600
601
#deprecated
602
get_revision_xml = get_revision_xml_file
332
def commit(self, message, timestamp=None, timezone=None,
333
committer=None,
334
verbose=False):
335
"""Commit working copy as a new revision.
336
337
The basic approach is to add all the file texts into the
338
store, then the inventory, then make a new revision pointing
339
to that inventory and store that.
340
341
This is not quite safe if the working copy changes during the
342
commit; for the moment that is simply not allowed. A better
343
approach is to make a temporary copy of the files before
344
computing their hashes, and then add those hashes in turn to
345
the inventory. This should mean at least that there are no
346
broken hash pointers. There is no way we can get a snapshot
347
of the whole directory at an instant. This would also have to
348
be robust against files disappearing, moving, etc. So the
349
whole thing is a bit hard.
350
351
:param timestamp: if not None, seconds-since-epoch for a
352
postdated/predated commit.
353
"""
354
355
## TODO: Show branch names
356
357
# TODO: Don't commit if there are no changes, unless forced?
358
359
# First walk over the working inventory; and both update that
360
# and also build a new revision inventory. The revision
361
# inventory needs to hold the text-id, sha1 and size of the
362
# actual file versions committed in the revision. (These are
363
# not present in the working inventory.) We also need to
364
# detect missing/deleted files, and remove them from the
365
# working inventory.
366
367
work_inv = self.read_working_inventory()
368
inv = Inventory()
369
basis = self.basis_tree()
370
basis_inv = basis.inventory
371
missing_ids = []
372
for path, entry in work_inv.iter_entries():
373
## TODO: Cope with files that have gone missing.
374
375
## TODO: Check that the file kind has not changed from the previous
376
## revision of this file (if any).
377
378
entry = entry.copy()
379
380
p = self._rel(path)
381
file_id = entry.file_id
382
mutter('commit prep file %s, id %r ' % (p, file_id))
383
384
if not os.path.exists(p):
385
mutter(" file is missing, removing from inventory")
386
if verbose:
387
show_status('D', entry.kind, quotefn(path))
388
missing_ids.append(file_id)
389
continue
390
391
# TODO: Handle files that have been deleted
392
393
# TODO: Maybe a special case for empty files? Seems a
394
# waste to store them many times.
395
396
inv.add(entry)
397
398
if basis_inv.has_id(file_id):
399
old_kind = basis_inv[file_id].kind
400
if old_kind != entry.kind:
401
bailout("entry %r changed kind from %r to %r"
402
% (file_id, old_kind, entry.kind))
403
404
if entry.kind == 'directory':
405
if not isdir(p):
406
bailout("%s is entered as directory but not a directory" % quotefn(p))
407
elif entry.kind == 'file':
408
if not isfile(p):
409
bailout("%s is entered as file but is not a file" % quotefn(p))
410
411
content = file(p, 'rb').read()
412
413
entry.text_sha1 = sha_string(content)
414
entry.text_size = len(content)
415
416
old_ie = basis_inv.has_id(file_id) and basis_inv[file_id]
417
if (old_ie
418
and (old_ie.text_size == entry.text_size)
419
and (old_ie.text_sha1 == entry.text_sha1)):
420
## assert content == basis.get_file(file_id).read()
421
entry.text_id = basis_inv[file_id].text_id
422
mutter(' unchanged from previous text_id {%s}' %
423
entry.text_id)
424
425
else:
426
entry.text_id = _gen_file_id(entry.name)
427
self.text_store.add(content, entry.text_id)
428
mutter(' stored with text_id {%s}' % entry.text_id)
429
if verbose:
430
if not old_ie:
431
state = 'A'
432
elif (old_ie.name == entry.name
433
and old_ie.parent_id == entry.parent_id):
434
state = 'R'
435
else:
436
state = 'M'
437
438
show_status(state, entry.kind, quotefn(path))
439
440
for file_id in missing_ids:
441
# have to do this later so we don't mess up the iterator.
442
# since parents may be removed before their children we
443
# have to test.
444
445
# FIXME: There's probably a better way to do this; perhaps
446
# the workingtree should know how to filter itself.
447
if work_inv.has_id(file_id):
448
del work_inv[file_id]
449
450
451
inv_id = rev_id = _gen_revision_id(time.time())
452
453
inv_tmp = tempfile.TemporaryFile()
454
inv.write_xml(inv_tmp)
455
inv_tmp.seek(0)
456
self.inventory_store.add(inv_tmp, inv_id)
457
mutter('new inventory_id is {%s}' % inv_id)
458
459
self._write_inventory(work_inv)
460
461
if timestamp == None:
462
timestamp = time.time()
463
464
if committer == None:
465
committer = username()
466
467
if timezone == None:
468
timezone = local_time_offset()
469
470
mutter("building commit log message")
471
rev = Revision(timestamp=timestamp,
472
timezone=timezone,
473
committer=committer,
474
precursor = self.last_patch(),
475
message = message,
476
inventory_id=inv_id,
477
revision_id=rev_id)
478
479
rev_tmp = tempfile.TemporaryFile()
480
rev.write_xml(rev_tmp)
481
rev_tmp.seek(0)
482
self.revision_store.add(rev_tmp, rev_id)
483
mutter("new revision_id is {%s}" % rev_id)
484
485
## XXX: Everything up to here can simply be orphaned if we abort
486
## the commit; it will leave junk files behind but that doesn't
487
## matter.
488
489
## TODO: Read back the just-generated changeset, and make sure it
490
## applies and recreates the right state.
491
492
## TODO: Also calculate and store the inventory SHA1
493
mutter("committing patch r%d" % (self.revno() + 1))
494
495
mutter("append to revision-history")
496
self.controlfile('revision-history', 'at').write(rev_id + '\n')
497
498
mutter("done!")
603
499
604
500
605
501
def get_revision(self, revision_id):
606
502
"""Return the Revision object for a named revision"""
607
xml_file = self.get_revision_xml_file(revision_id)
608
609
try:
610
r = bzrlib.xml5.serializer_v5.read_revision(xml_file)
611
except SyntaxError, e:
612
raise bzrlib.errors.BzrError('failed to unpack revision_xml',
613
[revision_id,
614
str(e)])
615
503
r = Revision.read_xml(self.revision_store[revision_id])
616
504
assert r.revision_id == revision_id
617
505
return r
618
506
619
507
620
def get_revision_delta(self, revno):
621
"""Return the delta for one revision.
622
623
The delta is relative to its mainline predecessor, or the
624
empty tree for revision 1.
625
"""
626
assert isinstance(revno, int)
627
rh = self.revision_history()
628
if not (1 <= revno <= len(rh)):
629
raise InvalidRevisionNumber(revno)
630
631
# revno is 1-based; list is 0-based
632
633
new_tree = self.revision_tree(rh[revno-1])
634
if revno == 1:
635
old_tree = EmptyTree()
636
else:
637
old_tree = self.revision_tree(rh[revno-2])
638
639
return compare_trees(old_tree, new_tree)
640
641
642
643
def get_revision_sha1(self, revision_id):
644
"""Hash the stored value of a revision, and return it."""
645
# In the future, revision entries will be signed. At that
646
# point, it is probably best *not* to include the signature
647
# in the revision hash. Because that lets you re-sign
648
# the revision, (add signatures/remove signatures) and still
649
# have all hash pointers stay consistent.
650
# But for now, just hash the contents.
651
return bzrlib.osutils.sha_file(self.get_revision_xml(revision_id))
652
653
654
def get_ancestry(self, revision_id):
655
"""Return a list of revision-ids integrated by a revision.
656
"""
657
w = self.weave_store.get_weave(ANCESTRY_FILEID)
658
# strip newlines
659
return [l[:-1] for l in w.get_iter(w.lookup(revision_id))]
660
661
662
def get_inventory_weave(self):
663
return self.weave_store.get_weave(INVENTORY_FILEID)
664
665
666
def get_inventory(self, revision_id):
667
"""Get Inventory object by hash."""
668
# FIXME: The text gets passed around a lot coming from the weave.
669
f = StringIO(self.get_inventory_xml(revision_id))
670
return bzrlib.xml5.serializer_v5.read_inventory(f)
671
672
673
def get_inventory_xml(self, revision_id):
674
"""Get inventory XML as a file object."""
675
try:
676
assert isinstance(revision_id, basestring), type(revision_id)
677
iw = self.get_inventory_weave()
678
return iw.get_text(iw.lookup(revision_id))
679
except IndexError:
680
raise bzrlib.errors.HistoryMissing(self, 'inventory', revision_id)
681
682
683
def get_inventory_sha1(self, revision_id):
684
"""Return the sha1 hash of the inventory entry
685
"""
686
return self.get_revision(revision_id).inventory_sha1
508
def get_inventory(self, inventory_id):
509
"""Get Inventory object by hash.
510
511
:todo: Perhaps for this and similar methods, take a revision
512
parameter which can be either an integer revno or a
513
string hash."""
514
i = Inventory.read_xml(self.inventory_store[inventory_id])
515
return i
687
516
688
517
689
518
def get_revision_inventory(self, revision_id):
690
519
"""Return inventory of a past revision."""
691
# bzr 0.0.6 and later imposes the constraint that the inventory_id
692
# must be the same as its revision, so this is trivial.
693
520
if revision_id == None:
694
return Inventory(self.get_root_id())
521
return Inventory()
695
522
else:
696
return self.get_inventory(revision_id)
523
return self.get_inventory(self.get_revision(revision_id).inventory_id)
697
524
698
525
699
526
def revision_history(self):
702
529
>>> ScratchBranch().revision_history()
703
530
[]
704
531
"""
705
self.lock_read()
706
try:
707
return [l.rstrip('\r\n') for l in
708
self.controlfile('revision-history', 'r').readlines()]
709
finally:
710
self.unlock()
711
712
713
def common_ancestor(self, other, self_revno=None, other_revno=None):
714
"""
715
>>> import commit
716
>>> sb = ScratchBranch(files=['foo', 'foo~'])
717
>>> sb.common_ancestor(sb) == (None, None)
718
True
719
>>> commit.commit(sb, "Committing first revision")
720
>>> sb.common_ancestor(sb)[0]
721
1
722
>>> clone = sb.clone()
723
>>> commit.commit(sb, "Committing second revision")
724
>>> sb.common_ancestor(sb)[0]
725
2
726
>>> sb.common_ancestor(clone)[0]
727
1
728
>>> commit.commit(clone, "Committing divergent second revision")
729
>>> sb.common_ancestor(clone)[0]
730
1
731
>>> sb.common_ancestor(clone) == clone.common_ancestor(sb)
732
True
733
>>> sb.common_ancestor(sb) != clone.common_ancestor(clone)
734
True
735
>>> clone2 = sb.clone()
736
>>> sb.common_ancestor(clone2)[0]
737
2
738
>>> sb.common_ancestor(clone2, self_revno=1)[0]
739
1
740
>>> sb.common_ancestor(clone2, other_revno=1)[0]
741
1
742
"""
743
my_history = self.revision_history()
744
other_history = other.revision_history()
745
if self_revno is None:
746
self_revno = len(my_history)
747
if other_revno is None:
748
other_revno = len(other_history)
749
indices = range(min((self_revno, other_revno)))
750
indices.reverse()
751
for r in indices:
752
if my_history[r] == other_history[r]:
753
return r+1, my_history[r]
754
return None, None
532
return [chomp(l) for l in self.controlfile('revision-history').readlines()]
755
533
756
534
757
535
def revno(self):
759
537
760
538
That is equivalent to the number of revisions committed to
761
539
this branch.
540
541
>>> b = ScratchBranch()
542
>>> b.revno()
543
0
544
>>> b.commit('no foo')
545
>>> b.revno()
546
1
762
547
"""
763
548
return len(self.revision_history())
764
549
765
550
766
551
def last_patch(self):
767
552
"""Return last patch hash, or None if no history.
553
554
>>> ScratchBranch().last_patch() == None
555
True
768
556
"""
769
557
ph = self.revision_history()
770
558
if ph:
771
559
return ph[-1]
772
else:
773
return None
774
775
776
def missing_revisions(self, other, stop_revision=None, diverged_ok=False):
777
"""
778
If self and other have not diverged, return a list of the revisions
779
present in other, but missing from self.
780
781
>>> from bzrlib.commit import commit
782
>>> bzrlib.trace.silent = True
783
>>> br1 = ScratchBranch()
784
>>> br2 = ScratchBranch()
785
>>> br1.missing_revisions(br2)
786
[]
787
>>> commit(br2, "lala!", rev_id="REVISION-ID-1")
788
>>> br1.missing_revisions(br2)
789
[u'REVISION-ID-1']
790
>>> br2.missing_revisions(br1)
791
[]
792
>>> commit(br1, "lala!", rev_id="REVISION-ID-1")
793
>>> br1.missing_revisions(br2)
794
[]
795
>>> commit(br2, "lala!", rev_id="REVISION-ID-2A")
796
>>> br1.missing_revisions(br2)
797
[u'REVISION-ID-2A']
798
>>> commit(br1, "lala!", rev_id="REVISION-ID-2B")
799
>>> br1.missing_revisions(br2)
800
Traceback (most recent call last):
801
DivergedBranches: These branches have diverged.
802
"""
803
self_history = self.revision_history()
804
self_len = len(self_history)
805
other_history = other.revision_history()
806
other_len = len(other_history)
807
common_index = min(self_len, other_len) -1
808
if common_index >= 0 and \
809
self_history[common_index] != other_history[common_index]:
810
raise DivergedBranches(self, other)
811
812
if stop_revision is None:
813
stop_revision = other_len
814
elif stop_revision > other_len:
815
raise bzrlib.errors.NoSuchRevision(self, stop_revision)
816
817
return other_history[self_len:stop_revision]
818
819
820
def update_revisions(self, other, stop_revision=None):
821
"""Pull in all new revisions from other branch.
822
"""
823
from bzrlib.fetch import greedy_fetch
824
825
pb = bzrlib.ui.ui_factory.progress_bar()
826
pb.update('comparing histories')
827
828
revision_ids = self.missing_revisions(other, stop_revision)
829
830
if len(revision_ids) > 0:
831
count = greedy_fetch(self, other, revision_ids[-1], pb)[0]
832
else:
833
count = 0
834
self.append_revision(*revision_ids)
835
## note("Added %d revisions." % count)
836
pb.clear()
837
838
839
def commit(self, *args, **kw):
840
from bzrlib.commit import Commit
841
Commit().commit(self, *args, **kw)
842
843
844
def lookup_revision(self, revision):
845
"""Return the revision identifier for a given revision information."""
846
revno, info = self._get_revision_info(revision)
847
return info
848
849
850
def revision_id_to_revno(self, revision_id):
851
"""Given a revision id, return its revno"""
852
history = self.revision_history()
853
try:
854
return history.index(revision_id) + 1
855
except ValueError:
856
raise bzrlib.errors.NoSuchRevision(self, revision_id)
857
858
859
def get_revision_info(self, revision):
860
"""Return (revno, revision id) for revision identifier.
861
862
revision can be an integer, in which case it is assumed to be revno (though
863
this will translate negative values into positive ones)
864
revision can also be a string, in which case it is parsed for something like
865
'date:' or 'revid:' etc.
866
"""
867
revno, rev_id = self._get_revision_info(revision)
868
if revno is None:
869
raise bzrlib.errors.NoSuchRevision(self, revision)
870
return revno, rev_id
871
872
def get_rev_id(self, revno, history=None):
873
"""Find the revision id of the specified revno."""
560
561
562
def lookup_revision(self, revno):
563
"""Return revision hash for revision number."""
874
564
if revno == 0:
875
565
return None
876
if history is None:
877
history = self.revision_history()
878
elif revno <= 0 or revno > len(history):
879
raise bzrlib.errors.NoSuchRevision(self, revno)
880
return history[revno - 1]
881
882
def _get_revision_info(self, revision):
883
"""Return (revno, revision id) for revision specifier.
884
885
revision can be an integer, in which case it is assumed to be revno
886
(though this will translate negative values into positive ones)
887
revision can also be a string, in which case it is parsed for something
888
like 'date:' or 'revid:' etc.
889
890
A revid is always returned. If it is None, the specifier referred to
891
the null revision. If the revid does not occur in the revision
892
history, revno will be None.
893
"""
894
895
if revision is None:
896
return 0, None
897
revno = None
898
try:# Convert to int if possible
899
revision = int(revision)
900
except ValueError:
901
pass
902
revs = self.revision_history()
903
if isinstance(revision, int):
904
if revision < 0:
905
revno = len(revs) + revision + 1
906
else:
907
revno = revision
908
rev_id = self.get_rev_id(revno, revs)
909
elif isinstance(revision, basestring):
910
for prefix, func in Branch.REVISION_NAMESPACES.iteritems():
911
if revision.startswith(prefix):
912
result = func(self, revs, revision)
913
if len(result) > 1:
914
revno, rev_id = result
915
else:
916
revno = result[0]
917
rev_id = self.get_rev_id(revno, revs)
918
break
919
else:
920
raise BzrError('No namespace registered for string: %r' %
921
revision)
922
else:
923
raise TypeError('Unhandled revision type %s' % revision)
924
925
if revno is None:
926
if rev_id is None:
927
raise bzrlib.errors.NoSuchRevision(self, revision)
928
return revno, rev_id
929
930
def _namespace_revno(self, revs, revision):
931
"""Lookup a revision by revision number"""
932
assert revision.startswith('revno:')
933
try:
934
return (int(revision[6:]),)
935
except ValueError:
936
return None
937
REVISION_NAMESPACES['revno:'] = _namespace_revno
938
939
def _namespace_revid(self, revs, revision):
940
assert revision.startswith('revid:')
941
rev_id = revision[len('revid:'):]
942
try:
943
return revs.index(rev_id) + 1, rev_id
944
except ValueError:
945
return None, rev_id
946
REVISION_NAMESPACES['revid:'] = _namespace_revid
947
948
def _namespace_last(self, revs, revision):
949
assert revision.startswith('last:')
950
try:
951
offset = int(revision[5:])
952
except ValueError:
953
return (None,)
954
else:
955
if offset <= 0:
956
raise BzrError('You must supply a positive value for --revision last:XXX')
957
return (len(revs) - offset + 1,)
958
REVISION_NAMESPACES['last:'] = _namespace_last
959
960
def _namespace_tag(self, revs, revision):
961
assert revision.startswith('tag:')
962
raise BzrError('tag: namespace registered, but not implemented.')
963
REVISION_NAMESPACES['tag:'] = _namespace_tag
964
965
def _namespace_date(self, revs, revision):
966
assert revision.startswith('date:')
967
import datetime
968
# Spec for date revisions:
969
# date:value
970
# value can be 'yesterday', 'today', 'tomorrow' or a YYYY-MM-DD string.
971
# it can also start with a '+/-/='. '+' says match the first
972
# entry after the given date. '-' is match the first entry before the date
973
# '=' is match the first entry after, but still on the given date.
974
#
975
# +2005-05-12 says find the first matching entry after May 12th, 2005 at 0:00
976
# -2005-05-12 says find the first matching entry before May 12th, 2005 at 0:00
977
# =2005-05-12 says find the first match after May 12th, 2005 at 0:00 but before
978
# May 13th, 2005 at 0:00
979
#
980
# So the proper way of saying 'give me all entries for today' is:
981
# -r {date:+today}:{date:-tomorrow}
982
# The default is '=' when not supplied
983
val = revision[5:]
984
match_style = '='
985
if val[:1] in ('+', '-', '='):
986
match_style = val[:1]
987
val = val[1:]
988
989
today = datetime.datetime.today().replace(hour=0,minute=0,second=0,microsecond=0)
990
if val.lower() == 'yesterday':
991
dt = today - datetime.timedelta(days=1)
992
elif val.lower() == 'today':
993
dt = today
994
elif val.lower() == 'tomorrow':
995
dt = today + datetime.timedelta(days=1)
996
else:
997
import re
998
# This should be done outside the function to avoid recompiling it.
999
_date_re = re.compile(
1000
r'(?P<date>(?P<year>\d\d\d\d)-(?P<month>\d\d)-(?P<day>\d\d))?'
1001
r'(,|T)?\s*'
1002
r'(?P<time>(?P<hour>\d\d):(?P<minute>\d\d)(:(?P<second>\d\d))?)?'
1003
)
1004
m = _date_re.match(val)
1005
if not m or (not m.group('date') and not m.group('time')):
1006
raise BzrError('Invalid revision date %r' % revision)
1007
1008
if m.group('date'):
1009
year, month, day = int(m.group('year')), int(m.group('month')), int(m.group('day'))
1010
else:
1011
year, month, day = today.year, today.month, today.day
1012
if m.group('time'):
1013
hour = int(m.group('hour'))
1014
minute = int(m.group('minute'))
1015
if m.group('second'):
1016
second = int(m.group('second'))
1017
else:
1018
second = 0
1019
else:
1020
hour, minute, second = 0,0,0
1021
1022
dt = datetime.datetime(year=year, month=month, day=day,
1023
hour=hour, minute=minute, second=second)
1024
first = dt
1025
last = None
1026
reversed = False
1027
if match_style == '-':
1028
reversed = True
1029
elif match_style == '=':
1030
last = dt + datetime.timedelta(days=1)
1031
1032
if reversed:
1033
for i in range(len(revs)-1, -1, -1):
1034
r = self.get_revision(revs[i])
1035
# TODO: Handle timezone.
1036
dt = datetime.datetime.fromtimestamp(r.timestamp)
1037
if first >= dt and (last is None or dt >= last):
1038
return (i+1,)
1039
else:
1040
for i in range(len(revs)):
1041
r = self.get_revision(revs[i])
1042
# TODO: Handle timezone.
1043
dt = datetime.datetime.fromtimestamp(r.timestamp)
1044
if first <= dt and (last is None or dt <= last):
1045
return (i+1,)
1046
REVISION_NAMESPACES['date:'] = _namespace_date
566
567
try:
568
# list is 0-based; revisions are 1-based
569
return self.revision_history()[revno-1]
570
except IndexError:
571
bailout("no such revision %s" % revno)
572
1047
573
1048
574
def revision_tree(self, revision_id):
1049
575
"""Return Tree for a revision on this branch.
1050
576
1051
577
`revision_id` may be None for the null revision, in which case
1052
578
an `EmptyTree` is returned."""
1053
# TODO: refactor this to use an existing revision object
1054
# so we don't need to read it in twice.
579
1055
580
if revision_id == None:
1056
581
return EmptyTree()
1057
582
else:
1058
583
inv = self.get_revision_inventory(revision_id)
1059
return RevisionTree(self.weave_store, inv, revision_id)
584
return RevisionTree(self.text_store, inv)
1060
585
1061
586
1062
587
def working_tree(self):
1063
588
"""Return a `Tree` for the working copy."""
1064
from workingtree import WorkingTree
1065
589
return WorkingTree(self.base, self.read_working_inventory())
1066
590
1067
591
1069
593
"""Return `Tree` object for last revision.
1070
594
1071
595
If there are no revisions yet, return an `EmptyTree`.
1072
"""
1073
return self.revision_tree(self.last_patch())
1074
1075
1076
def rename_one(self, from_rel, to_rel):
1077
"""Rename one file.
1078
1079
This can change the directory or the filename or both.
1080
"""
1081
self.lock_write()
1082
try:
1083
tree = self.working_tree()
1084
inv = tree.inventory
1085
if not tree.has_filename(from_rel):
1086
raise BzrError("can't rename: old working file %r does not exist" % from_rel)
1087
if tree.has_filename(to_rel):
1088
raise BzrError("can't rename: new working file %r already exists" % to_rel)
1089
1090
file_id = inv.path2id(from_rel)
1091
if file_id == None:
1092
raise BzrError("can't rename: old name %r is not versioned" % from_rel)
1093
1094
if inv.path2id(to_rel):
1095
raise BzrError("can't rename: new name %r is already versioned" % to_rel)
1096
1097
to_dir, to_tail = os.path.split(to_rel)
1098
to_dir_id = inv.path2id(to_dir)
1099
if to_dir_id == None and to_dir != '':
1100
raise BzrError("can't determine destination directory id for %r" % to_dir)
1101
1102
mutter("rename_one:")
1103
mutter(" file_id {%s}" % file_id)
1104
mutter(" from_rel %r" % from_rel)
1105
mutter(" to_rel %r" % to_rel)
1106
mutter(" to_dir %r" % to_dir)
1107
mutter(" to_dir_id {%s}" % to_dir_id)
1108
1109
inv.rename(file_id, to_dir_id, to_tail)
1110
1111
from_abs = self.abspath(from_rel)
1112
to_abs = self.abspath(to_rel)
1113
try:
1114
os.rename(from_abs, to_abs)
1115
except OSError, e:
1116
raise BzrError("failed to rename %r to %r: %s"
1117
% (from_abs, to_abs, e[1]),
1118
["rename rolled back"])
1119
1120
self._write_inventory(inv)
1121
finally:
1122
self.unlock()
1123
1124
1125
def move(self, from_paths, to_name):
1126
"""Rename files.
1127
1128
to_name must exist as a versioned directory.
1129
1130
If to_name exists and is a directory, the files are moved into
1131
it, keeping their old names. If it is a directory,
1132
1133
Note that to_name is only the last component of the new name;
1134
this doesn't change the directory.
1135
1136
This returns a list of (from_path, to_path) pairs for each
1137
entry that is moved.
1138
"""
1139
result = []
1140
self.lock_write()
1141
try:
1142
## TODO: Option to move IDs only
1143
assert not isinstance(from_paths, basestring)
1144
tree = self.working_tree()
1145
inv = tree.inventory
1146
to_abs = self.abspath(to_name)
1147
if not isdir(to_abs):
1148
raise BzrError("destination %r is not a directory" % to_abs)
1149
if not tree.has_filename(to_name):
1150
raise BzrError("destination %r not in working directory" % to_abs)
1151
to_dir_id = inv.path2id(to_name)
1152
if to_dir_id == None and to_name != '':
1153
raise BzrError("destination %r is not a versioned directory" % to_name)
1154
to_dir_ie = inv[to_dir_id]
1155
if to_dir_ie.kind not in ('directory', 'root_directory'):
1156
raise BzrError("destination %r is not a directory" % to_abs)
1157
1158
to_idpath = inv.get_idpath(to_dir_id)
1159
1160
for f in from_paths:
1161
if not tree.has_filename(f):
1162
raise BzrError("%r does not exist in working tree" % f)
1163
f_id = inv.path2id(f)
1164
if f_id == None:
1165
raise BzrError("%r is not versioned" % f)
1166
name_tail = splitpath(f)[-1]
1167
dest_path = appendpath(to_name, name_tail)
1168
if tree.has_filename(dest_path):
1169
raise BzrError("destination %r already exists" % dest_path)
1170
if f_id in to_idpath:
1171
raise BzrError("can't move %r to a subdirectory of itself" % f)
1172
1173
# OK, so there's a race here, it's possible that someone will
1174
# create a file in this interval and then the rename might be
1175
# left half-done. But we should have caught most problems.
1176
1177
for f in from_paths:
1178
name_tail = splitpath(f)[-1]
1179
dest_path = appendpath(to_name, name_tail)
1180
result.append((f, dest_path))
1181
inv.rename(inv.path2id(f), to_dir_id, name_tail)
1182
try:
1183
os.rename(self.abspath(f), self.abspath(dest_path))
1184
except OSError, e:
1185
raise BzrError("failed to rename %r to %r: %s" % (f, dest_path, e[1]),
1186
["rename rolled back"])
1187
1188
self._write_inventory(inv)
1189
finally:
1190
self.unlock()
1191
1192
return result
1193
1194
1195
def revert(self, filenames, old_tree=None, backups=True):
1196
"""Restore selected files to the versions from a previous tree.
1197
1198
backups
1199
If true (default) backups are made of files before
1200
they're renamed.
1201
"""
1202
from bzrlib.errors import NotVersionedError, BzrError
1203
from bzrlib.atomicfile import AtomicFile
1204
from bzrlib.osutils import backup_file
1205
1206
inv = self.read_working_inventory()
1207
if old_tree is None:
1208
old_tree = self.basis_tree()
1209
old_inv = old_tree.inventory
1210
1211
nids = []
1212
for fn in filenames:
1213
file_id = inv.path2id(fn)
1214
if not file_id:
1215
raise NotVersionedError("not a versioned file", fn)
1216
if not old_inv.has_id(file_id):
1217
raise BzrError("file not present in old tree", fn, file_id)
1218
nids.append((fn, file_id))
1219
1220
# TODO: Rename back if it was previously at a different location
1221
1222
# TODO: If given a directory, restore the entire contents from
1223
# the previous version.
1224
1225
# TODO: Make a backup to a temporary file.
1226
1227
# TODO: If the file previously didn't exist, delete it?
1228
for fn, file_id in nids:
1229
backup_file(fn)
1230
1231
f = AtomicFile(fn, 'wb')
1232
try:
1233
f.write(old_tree.get_file(file_id).read())
1234
f.commit()
1235
finally:
1236
f.close()
1237
1238
1239
def pending_merges(self):
1240
"""Return a list of pending merges.
1241
1242
These are revisions that have been merged into the working
1243
directory but not yet committed.
1244
"""
1245
cfn = self.controlfilename('pending-merges')
1246
if not os.path.exists(cfn):
1247
return []
1248
p = []
1249
for l in self.controlfile('pending-merges', 'r').readlines():
1250
p.append(l.rstrip('\n'))
1251
return p
1252
1253
1254
def add_pending_merge(self, revision_id):
1255
from bzrlib.revision import validate_revision_id
1256
1257
validate_revision_id(revision_id)
1258
1259
p = self.pending_merges()
1260
if revision_id in p:
1261
return
1262
p.append(revision_id)
1263
self.set_pending_merges(p)
1264
1265
1266
def set_pending_merges(self, rev_list):
1267
from bzrlib.atomicfile import AtomicFile
1268
self.lock_write()
1269
try:
1270
f = AtomicFile(self.controlfilename('pending-merges'))
1271
try:
1272
for l in rev_list:
1273
print >>f, l
1274
f.commit()
1275
finally:
1276
f.close()
1277
finally:
1278
self.unlock()
1279
1280
1281
def get_parent(self):
1282
"""Return the parent location of the branch.
1283
1284
This is the default location for push/pull/missing. The usual
1285
pattern is that the user can override it by specifying a
1286
location.
1287
"""
1288
import errno
1289
_locs = ['parent', 'pull', 'x-pull']
1290
for l in _locs:
1291
try:
1292
return self.controlfile(l, 'r').read().strip('\n')
1293
except IOError, e:
1294
if e.errno != errno.ENOENT:
1295
raise
1296
return None
1297
1298
1299
def set_parent(self, url):
1300
# TODO: Maybe delete old location files?
1301
from bzrlib.atomicfile import AtomicFile
1302
self.lock_write()
1303
try:
1304
f = AtomicFile(self.controlfilename('parent'))
1305
try:
1306
f.write(url + '\n')
1307
f.commit()
1308
finally:
1309
f.close()
1310
finally:
1311
self.unlock()
1312
1313
def check_revno(self, revno):
1314
"""\
1315
Check whether a revno corresponds to any revision.
1316
Zero (the NULL revision) is considered valid.
1317
"""
1318
if revno != 0:
1319
self.check_real_revno(revno)
1320
1321
def check_real_revno(self, revno):
1322
"""\
1323
Check whether a revno corresponds to a real revision.
1324
Zero (the NULL revision) is considered invalid
1325
"""
1326
if revno < 1 or revno > self.revno():
1327
raise InvalidRevisionNumber(revno)
1328
1329
596
597
>>> b = ScratchBranch(files=['foo'])
598
>>> b.basis_tree().has_filename('foo')
599
False
600
>>> b.working_tree().has_filename('foo')
601
True
602
>>> b.add('foo')
603
>>> b.commit('add foo')
604
>>> b.basis_tree().has_filename('foo')
605
True
606
"""
607
r = self.last_patch()
608
if r == None:
609
return EmptyTree()
610
else:
611
return RevisionTree(self.text_store, self.get_revision_inventory(r))
612
613
614
615
def write_log(self, utc=False):
616
"""Write out human-readable log of commits to this branch
617
618
:param utc: If true, show dates in universal time, not local time."""
619
## TODO: Option to choose either original, utc or local timezone
620
revno = 1
621
precursor = None
622
for p in self.revision_history():
623
print '-' * 40
624
print 'revno:', revno
625
## TODO: Show hash if --id is given.
626
##print 'revision-hash:', p
627
rev = self.get_revision(p)
628
print 'committer:', rev.committer
629
print 'timestamp: %s' % (format_date(rev.timestamp, rev.timezone or 0))
630
631
## opportunistic consistency check, same as check_patch_chaining
632
if rev.precursor != precursor:
633
bailout("mismatched precursor!")
634
635
print 'message:'
636
if not rev.message:
637
print ' (no message)'
638
else:
639
for l in rev.message.split('\n'):
640
print ' ' + l
641
642
revno += 1
643
precursor = p
644
645
646
647
def show_status(branch, show_all=False):
648
"""Display single-line status for non-ignored working files.
649
650
The list is show sorted in order by file name.
651
652
>>> b = ScratchBranch(files=['foo', 'foo~'])
653
>>> b.show_status()
654
? foo
655
>>> b.add('foo')
656
>>> b.show_status()
657
A foo
658
>>> b.commit("add foo")
659
>>> b.show_status()
660
661
:todo: Get state for single files.
662
663
:todo: Perhaps show a slash at the end of directory names.
664
665
"""
666
667
# We have to build everything into a list first so that it can
668
# sorted by name, incorporating all the different sources.
669
670
# FIXME: Rather than getting things in random order and then sorting,
671
# just step through in order.
672
673
# Interesting case: the old ID for a file has been removed,
674
# but a new file has been created under that name.
675
676
old = branch.basis_tree()
677
old_inv = old.inventory
678
new = branch.working_tree()
679
new_inv = new.inventory
680
681
for fs, fid, oldname, newname, kind in diff_trees(old, new):
682
if fs == 'R':
683
show_status(fs, kind,
684
oldname + ' => ' + newname)
685
elif fs == 'A' or fs == 'M':
686
show_status(fs, kind, newname)
687
elif fs == 'D':
688
show_status(fs, kind, oldname)
689
elif fs == '.':
690
if show_all:
691
show_status(fs, kind, newname)
692
elif fs == 'I':
693
if show_all:
694
show_status(fs, kind, newname)
695
elif fs == '?':
696
show_status(fs, kind, newname)
697
else:
698
bailout("wierd file state %r" % ((fs, fid),))
699
1330
700
1331
701
1332
702
class ScratchBranch(Branch):
1336
706
>>> isdir(b.base)
1337
707
True
1338
708
>>> bd = b.base
1339
>>> b.destroy()
709
>>> del b
1340
710
>>> isdir(bd)
1341
711
False
1342
712
"""
1343
def __init__(self, files=[], dirs=[], base=None):
713
def __init__(self, files = []):
1344
714
"""Make a test branch.
1345
715
1346
716
This creates a temporary directory and runs init-tree in it.
1347
717
1348
718
If any files are listed, they are created in the working copy.
1349
719
"""
1350
from tempfile import mkdtemp
1351
init = False
1352
if base is None:
1353
base = mkdtemp()
1354
init = True
1355
Branch.__init__(self, base, init=init)
1356
for d in dirs:
1357
os.mkdir(self.abspath(d))
1358
720
Branch.__init__(self, tempfile.mkdtemp(), init=True)
1359
721
for f in files:
1360
722
file(os.path.join(self.base, f), 'w').write('content of %s' % f)
1361
723
1362
724
1363
def clone(self):
1364
"""
1365
>>> orig = ScratchBranch(files=["file1", "file2"])
1366
>>> clone = orig.clone()
1367
>>> os.path.samefile(orig.base, clone.base)
1368
False
1369
>>> os.path.isfile(os.path.join(clone.base, "file1"))
1370
True
1371
"""
1372
from shutil import copytree
1373
from tempfile import mkdtemp
1374
base = mkdtemp()
1375
os.rmdir(base)
1376
copytree(self.base, base, symlinks=True)
1377
return ScratchBranch(base=base)
1378
1379
1380
1381
725
def __del__(self):
1382
self.destroy()
1383
1384
def destroy(self):
1385
726
"""Destroy the test branch, removing the scratch directory."""
1386
from shutil import rmtree
1387
try:
1388
if self.base:
1389
mutter("delete ScratchBranch %s" % self.base)
1390
rmtree(self.base)
1391
except OSError, e:
1392
# Work around for shutil.rmtree failing on Windows when
1393
# readonly files are encountered
1394
mutter("hit exception in destroying ScratchBranch: %s" % e)
1395
for root, dirs, files in os.walk(self.base, topdown=False):
1396
for name in files:
1397
os.chmod(os.path.join(root, name), 0700)
1398
rmtree(self.base)
1399
self.base = None
727
shutil.rmtree(self.base)
1400
728
1401
729
1402
730
1412
740
## mutter('check %r for control file' % ((head, tail), ))
1413
741
if tail == bzrlib.BZRDIR:
1414
742
return True
1415
if filename == head:
1416
break
1417
743
filename = head
1418
744
return False
1419
745
1420
746
1421
747
1422
def gen_file_id(name):
748
def _gen_revision_id(when):
749
"""Return new revision-id."""
750
s = '%s-%s-' % (user_email(), compact_date(when))
751
s += hexlify(rand_bytes(8))
752
return s
753
754
755
def _gen_file_id(name):
1423
756
"""Return new file id.
1424
757
1425
758
This should probably generate proper UUIDs, but for the moment we
1426
759
cope with just randomness because running uuidgen every time is
1427
760
slow."""
1428
import re
1429
from binascii import hexlify
1430
from time import time
1431
1432
# get last component
1433
idx = name.rfind('/')
1434
if idx != -1:
1435
name = name[idx+1 : ]
1436
idx = name.rfind('\\')
1437
if idx != -1:
1438
name = name[idx+1 : ]
1439
1440
# make it not a hidden file
1441
name = name.lstrip('.')
1442
1443
# remove any wierd characters; we don't escape them but rather
1444
# just pull them out
1445
name = re.sub(r'[^\w.]', '', name)
1446
761
assert '/' not in name
762
while name[0] == '.':
763
name = name[1:]
1447
764
s = hexlify(rand_bytes(8))
1448
return '-'.join((name, compact_date(time()), s))
1449
1450
1451
def gen_root_id():
1452
"""Return a new tree-root file id."""
1453
return gen_file_id('TREE_ROOT')
1454
1455
1456
def pull_loc(branch):
1457
# TODO: Should perhaps just make attribute be 'base' in
1458
# RemoteBranch and Branch?
1459
if hasattr(branch, "baseurl"):
1460
return branch.baseurl
1461
else:
1462
return branch.base
1463
1464
1465
def copy_branch(branch_from, to_location, revision=None):
1466
"""Copy branch_from into the existing directory to_location.
1467
1468
revision
1469
If not None, only revisions up to this point will be copied.
1470
The head of the new branch will be that revision.
1471
1472
to_location
1473
The name of a local directory that exists but is empty.
1474
"""
1475
from bzrlib.merge import merge
1476
from bzrlib.branch import Branch
1477
1478
assert isinstance(branch_from, Branch)
1479
assert isinstance(to_location, basestring)
1480
1481
br_to = Branch(to_location, init=True)
1482
br_to.set_root_id(branch_from.get_root_id())
1483
if revision is None:
1484
revno = branch_from.revno()
1485
else:
1486
revno, rev_id = branch_from.get_revision_info(revision)
1487
br_to.update_revisions(branch_from, stop_revision=revno)
1488
merge((to_location, -1), (to_location, 0), this_dir=to_location,
1489
check_clean=False, ignore_zero=True)
1490
1491
from_location = pull_loc(branch_from)
1492
br_to.set_parent(pull_loc(branch_from))
765
return '-'.join((name, compact_date(time.time()), s))
766
1493
767
Loggerhead is a web-based interface for Breezy
Version: 2.0.1