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.errors import BzrError
33
from bzrlib.trace import mutter
26
36
def make_readonly(filename):
27
37
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
38
mod = os.stat(filename).st_mode
30
39
mod = mod & 0777555
31
40
os.chmod(filename, mod)
37
46
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)
53
"""Return a quoted filename filename
55
This previously used backslash quoting, but that works poorly on
57
# TODO: I'm not really sure this is the best format either.x
60
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
62
if _QUOTE_RE.search(f):
56
74
elif S_ISLNK(mode):
59
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
88
def kind_marker(kind):
91
elif kind == 'directory':
93
elif kind == 'symlink':
96
raise BzrError('invalid file kind %r' % kind)
100
if hasattr(os, 'lstat'):
106
if e.errno == errno.ENOENT:
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
111
def normalizepath(f):
112
if hasattr(os.path, 'realpath'):
116
[p,e] = os.path.split(f)
117
if e == "" or e == "." or e == "..":
120
return os.path.join(F(p), e)
124
"""Copy a file to a backup.
126
Backups are named in GNU-style, with a ~ suffix.
128
If the file is already a backup, it's not copied.
140
outf = file(bfn, 'wb')
169
"""True if f is a symlink."""
171
return S_ISLNK(os.lstat(f)[ST_MODE])
175
def is_inside(dir, fname):
176
"""True if fname is inside dir.
178
The parameters should typically be passed to os.path.normpath first, so
179
that . and .. and repeated slashes are eliminated, and the separators
180
are canonical for the platform.
182
The empty string as a dir name is taken as top-of-tree and matches
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
187
>>> is_inside('src', 'srccontrol')
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
191
>>> is_inside('foo.c', 'foo.c')
193
>>> is_inside('foo.c', '')
195
>>> is_inside('', 'foo.c')
198
# XXX: Most callers of this can actually do something smarter by
199
# looking at the inventory
206
if dir[-1] != os.sep:
209
return fname.startswith(dir)
212
def is_inside_any(dir_list, fname):
213
"""True if fname is inside any of given dirs."""
214
for dirname in dir_list:
215
if is_inside(dirname, fname):
80
221
def pumpfile(fromfile, tofile):
81
222
"""Copy contents of one file to another."""
82
223
tofile.write(fromfile.read())
86
"""Return a new UUID"""
88
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
90
return chomp(os.popen('uuidgen').readline())
95
227
if hasattr(f, 'tell'):
96
228
assert f.tell() == 0
168
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
172
309
"""Return the full user id from a file or environment variable.
174
TODO: Allow taking this from a file in the branch directory too
175
for per-branch ids."""
311
e.g. "John Hacker <jhacker@foo.org>"
314
A branch to use for a per-branch configuration, or None.
316
The following are searched in order:
319
2. .bzr/email for this branch.
176
323
v = os.environ.get('BZREMAIL')
178
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
181
340
return (open(os.path.join(config_dir(), "email"))
214
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
373
def user_email(branch):
216
374
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
219
m = _EMAIL_RE.search(e)
377
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
221
bailout("%r doesn't seem to contain a reasonable email address" % e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
222
381
return m.group(0)
224
383
return _auto_user_id()[1]
228
386
def compare_files(a, b):
266
423
tt = time.localtime(t)
267
424
offset = local_time_offset(t)
269
bailout("unsupported timezone format %r",
270
['options are "utc", "original", "local"'])
426
raise BzrError("unsupported timezone format %r" % timezone,
427
['options are "utc", "original", "local"'])
272
429
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
273
430
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
282
439
"""Return size of given open file."""
283
440
return os.fstat(f.fileno())[ST_SIZE]
286
if hasattr(os, 'urandom'): # python 2.4 and later
442
# Define rand_bytes based on platform.
444
# Python 2.4 and later have os.urandom,
445
# but it doesn't work on some arches
287
447
rand_bytes = os.urandom
289
# FIXME: No good on non-Linux
290
_rand_file = file('/dev/urandom', 'rb')
291
rand_bytes = _rand_file.read
448
except (NotImplementedError, AttributeError):
449
# If python doesn't have os.urandom, or it doesn't work,
450
# then try to first pull random data from /dev/urandom
451
if os.path.exists("/dev/urandom"):
452
rand_bytes = file('/dev/urandom', 'rb').read
453
# Otherwise, use this hack as a last resort
455
# not well seeded, but better than nothing
460
s += chr(random.randint(0, 255))
294
464
## TODO: We could later have path objects that remember their list
295
465
## decomposition (might be too tricksy though.)
308
478
>>> splitpath('a/../b')
309
479
Traceback (most recent call last):
311
BzrError: ("sorry, '..' not allowed in path", [])
481
BzrError: sorry, '..' not allowed in path
313
483
assert isinstance(p, types.StringTypes)
330
500
assert isinstance(p, list)
332
502
if (f == '..') or (f == None) or (f == ''):
333
bailout("sorry, %r not allowed in path" % f)
503
raise BzrError("sorry, %r not allowed in path" % f)
334
504
return os.path.join(*p)
341
511
return os.path.join(p1, p2)
344
def extern_command(cmd, ignore_errors = False):
345
mutter('external command: %s' % `cmd`)
347
if not ignore_errors:
348
bailout('command failed')
514
def _read_config_value(name):
515
"""Read a config value from the file ~/.bzr.conf/<name>
516
Return None if the file does not exist"""
518
f = file(os.path.join(config_dir(), name), "r")
519
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
521
if e.errno == errno.ENOENT:
527
"""Split s into lines, but without removing the newline characters."""
528
return StringIO(s).readlines()
531
def hardlinks_good():
532
return sys.platform not in ('win32', 'cygwin', 'darwin')
535
def link_or_copy(src, dest):
536
"""Hardlink a file, or copy it if it can't be hardlinked."""
537
if not hardlinks_good():
542
except (OSError, IOError), e:
543
if e.errno != errno.EXDEV:
added
removed
bzrlib/osutils.py
