1
1
# Bazaar-NG -- distributed version control
3
3
# Copyright (C) 2005 by Canonical Ltd
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
13
# GNU General Public License for more details.
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
import os, types, re, time, errno
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
19
from shutil import copyfile
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
from cStringIO import StringIO
22
from errors import bailout, BzrError
23
from trace import mutter
32
from bzrlib.config import config_dir
33
from bzrlib.errors import BzrError
34
from bzrlib.trace import mutter
26
37
def make_readonly(filename):
27
38
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
39
mod = os.stat(filename).st_mode
30
40
mod = mod & 0777555
31
41
os.chmod(filename, mod)
37
47
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
42
"""Return shell-quoted filename"""
43
## We could be a bit more terse by using double-quotes etc
44
f = _QUOTE_RE.sub(r'\\\1', f)
54
"""Return a quoted filename filename
56
This previously used backslash quoting, but that works poorly on
58
# TODO: I'm not really sure this is the best format either.x
61
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
63
if _QUOTE_RE.search(f):
56
75
elif S_ISLNK(mode):
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
89
def kind_marker(kind):
92
elif kind == 'directory':
94
elif kind == 'symlink':
97
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os, 'lstat'):
107
if e.errno == errno.ENOENT:
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
112
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
117
[p,e] = os.path.split(f)
118
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
125
"""Copy a file to a backup.
127
Backups are named in GNU-style, with a ~ suffix.
129
If the file is already a backup, it's not copied.
141
outf = file(bfn, 'wb')
170
"""True if f is a symlink."""
172
return S_ISLNK(os.lstat(f)[ST_MODE])
176
def is_inside(dir, fname):
177
"""True if fname is inside dir.
179
The parameters should typically be passed to os.path.normpath first, so
180
that . and .. and repeated slashes are eliminated, and the separators
181
are canonical for the platform.
183
The empty string as a dir name is taken as top-of-tree and matches
186
>>> is_inside('src', os.path.join('src', 'foo.c'))
188
>>> is_inside('src', 'srccontrol')
190
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
192
>>> is_inside('foo.c', 'foo.c')
194
>>> is_inside('foo.c', '')
196
>>> is_inside('', 'foo.c')
199
# XXX: Most callers of this can actually do something smarter by
200
# looking at the inventory
207
if dir[-1] != os.sep:
210
return fname.startswith(dir)
213
def is_inside_any(dir_list, fname):
214
"""True if fname is inside any of given dirs."""
215
for dirname in dir_list:
216
if is_inside(dirname, fname):
80
222
def pumpfile(fromfile, tofile):
81
223
"""Copy contents of one file to another."""
82
224
tofile.write(fromfile.read())
86
"""Return a new UUID"""
88
## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
89
## Linux, but we need something portable for other systems;
90
## preferably an implementation in Python.
92
return chomp(file('/proc/sys/kernel/random/uuid').readline())
94
return chomp(os.popen('uuidgen').readline())
98
if s and (s[-1] == '\n'):
106
## TODO: Maybe read in chunks to handle big files
107
228
if hasattr(f, 'tell'):
108
229
assert f.tell() == 0
241
def sha_strings(strings):
242
"""Return the sha-1 of concatenation of strings"""
244
map(s.update, strings)
111
245
return s.hexdigest()
114
248
def sha_string(f):
118
251
return s.hexdigest()
122
254
def fingerprint_file(f):
129
260
'sha1': s.hexdigest()}
133
"""Return per-user configuration directory.
135
By default this is ~/.bzr.conf/
137
TODO: Global option --config-dir to override this.
139
return os.path.expanduser("~/.bzr.conf")
142
263
def _auto_user_id():
143
264
"""Calculate automatic user identification.
175
296
return realname, (username + '@' + socket.gethostname())
299
def _get_user_id(branch):
179
300
"""Return the full user id from a file or environment variable.
181
TODO: Allow taking this from a file in the branch directory too
182
for per-branch ids."""
302
e.g. "John Hacker <jhacker@foo.org>"
305
A branch to use for a per-branch configuration, or None.
307
The following are searched in order:
310
2. .bzr/email for this branch.
183
314
v = os.environ.get('BZREMAIL')
185
316
return v.decode(bzrlib.user_encoding)
320
return (branch.controlfile("email", "r")
322
.decode(bzrlib.user_encoding)
325
if e.errno != errno.ENOENT:
188
331
return (open(os.path.join(config_dir(), "email"))
221
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
364
def user_email(branch):
223
365
"""Return just the email component of a username."""
366
e = _get_user_id(branch)
226
m = _EMAIL_RE.search(e)
368
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
228
bailout("%r doesn't seem to contain a reasonable email address" % e)
370
raise BzrError("%r doesn't seem to contain "
371
"a reasonable email address" % e)
229
372
return m.group(0)
231
374
return _auto_user_id()[1]
235
377
def compare_files(a, b):
236
378
"""Returns true if equal in contents"""
237
# TODO: don't read the whole thing in one go.
240
381
ai = a.read(BUFSIZE)
274
414
tt = time.localtime(t)
275
415
offset = local_time_offset(t)
277
bailout("unsupported timezone format %r",
278
['options are "utc", "original", "local"'])
417
raise BzrError("unsupported timezone format %r" % timezone,
418
['options are "utc", "original", "local"'])
280
420
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
281
421
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
290
430
"""Return size of given open file."""
291
431
return os.fstat(f.fileno())[ST_SIZE]
294
if hasattr(os, 'urandom'): # python 2.4 and later
433
# Define rand_bytes based on platform.
435
# Python 2.4 and later have os.urandom,
436
# but it doesn't work on some arches
295
438
rand_bytes = os.urandom
297
# FIXME: No good on non-Linux
298
_rand_file = file('/dev/urandom', 'rb')
299
rand_bytes = _rand_file.read
439
except (NotImplementedError, AttributeError):
440
# If python doesn't have os.urandom, or it doesn't work,
441
# then try to first pull random data from /dev/urandom
442
if os.path.exists("/dev/urandom"):
443
rand_bytes = file('/dev/urandom', 'rb').read
444
# Otherwise, use this hack as a last resort
446
# not well seeded, but better than nothing
451
s += chr(random.randint(0, 255))
302
455
## TODO: We could later have path objects that remember their list
303
456
## decomposition (might be too tricksy though.)
316
469
>>> splitpath('a/../b')
317
470
Traceback (most recent call last):
319
BzrError: ("sorry, '..' not allowed in path", [])
472
BzrError: sorry, '..' not allowed in path
321
474
assert isinstance(p, types.StringTypes)
338
491
assert isinstance(p, list)
340
493
if (f == '..') or (f == None) or (f == ''):
341
bailout("sorry, %r not allowed in path" % f)
494
raise BzrError("sorry, %r not allowed in path" % f)
342
495
return os.path.join(*p)
349
502
return os.path.join(p1, p2)
352
def extern_command(cmd, ignore_errors = False):
353
mutter('external command: %s' % `cmd`)
355
if not ignore_errors:
356
bailout('command failed')
505
def _read_config_value(name):
506
"""Read a config value from the file ~/.bzr.conf/<name>
507
Return None if the file does not exist"""
509
f = file(os.path.join(config_dir(), name), "r")
510
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
512
if e.errno == errno.ENOENT:
518
"""Split s into lines, but without removing the newline characters."""
519
return StringIO(s).readlines()
522
def hardlinks_good():
523
return sys.platform not in ('win32', 'cygwin', 'darwin')
526
def link_or_copy(src, dest):
527
"""Hardlink a file, or copy it if it can't be hardlinked."""
528
if not hardlinks_good():
533
except (OSError, IOError), e:
534
if e.errno != errno.EXDEV:
540
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
