1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
import os, types, re, time, errno, sys
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
26
def make_readonly(filename):
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
mod = os.stat(filename).st_mode
31
os.chmod(filename, mod)
34
def make_writable(filename):
35
mod = os.stat(filename).st_mode
37
os.chmod(filename, mod)
44
"""Return a quoted filename filename
46
This previously used backslash quoting, but that works poorly on
48
# TODO: I'm not really sure this is the best format either.x
51
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
53
if _QUOTE_RE.search(f):
60
mode = os.lstat(f)[ST_MODE]
68
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
71
def kind_marker(kind):
74
elif kind == 'directory':
76
elif kind == 'symlink':
79
raise BzrError('invalid file kind %r' % kind)
83
if hasattr(os, 'lstat'):
89
if e.errno == errno.ENOENT:
92
raise BzrError("lstat/stat of (%r): %r" % (f, e))
95
if hasattr(os.path, 'realpath'):
99
[p,e] = os.path.split(f)
100
if e == "" or e == "." or e == "..":
103
return os.path.join(F(p), e)
107
"""Copy a file to a backup.
109
Backups are named in GNU-style, with a ~ suffix.
111
If the file is already a backup, it's not copied.
124
outf = file(bfn, 'wb')
130
def rename(path_from, path_to):
131
"""Basically the same as os.rename() just special for win32"""
132
if sys.platform == 'win32':
136
if e.errno != e.ENOENT:
138
os.rename(path_from, path_to)
145
"""True if f is an accessible directory."""
147
return S_ISDIR(os.lstat(f)[ST_MODE])
154
"""True if f is a regular file."""
156
return S_ISREG(os.lstat(f)[ST_MODE])
161
"""True if f is a symlink."""
163
return S_ISLNK(os.lstat(f)[ST_MODE])
167
def is_inside(dir, fname):
168
"""True if fname is inside dir.
170
The parameters should typically be passed to os.path.normpath first, so
171
that . and .. and repeated slashes are eliminated, and the separators
172
are canonical for the platform.
174
The empty string as a dir name is taken as top-of-tree and matches
177
>>> is_inside('src', 'src/foo.c')
179
>>> is_inside('src', 'srccontrol')
181
>>> is_inside('src', 'src/a/a/a/foo.c')
183
>>> is_inside('foo.c', 'foo.c')
185
>>> is_inside('foo.c', '')
187
>>> is_inside('', 'foo.c')
190
# XXX: Most callers of this can actually do something smarter by
191
# looking at the inventory
198
if dir[-1] != os.sep:
201
return fname.startswith(dir)
204
def is_inside_any(dir_list, fname):
205
"""True if fname is inside any of given dirs."""
206
for dirname in dir_list:
207
if is_inside(dirname, fname):
213
def pumpfile(fromfile, tofile):
214
"""Copy contents of one file to another."""
215
tofile.write(fromfile.read())
219
"""Return a new UUID"""
221
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
223
return chomp(os.popen('uuidgen').readline())
228
if hasattr(f, 'tell'):
248
def fingerprint_file(f):
254
return {'size': size,
255
'sha1': s.hexdigest()}
259
"""Return per-user configuration directory.
261
By default this is ~/.bzr.conf/
263
TODO: Global option --config-dir to override this.
265
return os.path.expanduser("~/.bzr.conf")
269
"""Calculate automatic user identification.
271
Returns (realname, email).
273
Only used when none is set in the environment or the id file.
275
This previously used the FQDN as the default domain, but that can
276
be very slow on machines where DNS is broken. So now we simply
281
# XXX: Any good way to get real user name on win32?
286
w = pwd.getpwuid(uid)
287
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
288
username = w.pw_name.decode(bzrlib.user_encoding)
289
comma = gecos.find(',')
293
realname = gecos[:comma]
299
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
301
return realname, (username + '@' + socket.gethostname())
304
def _get_user_id(branch):
305
"""Return the full user id from a file or environment variable.
307
e.g. "John Hacker <jhacker@foo.org>"
310
A branch to use for a per-branch configuration, or None.
312
The following are searched in order:
315
2. .bzr/email for this branch.
319
v = os.environ.get('BZREMAIL')
321
return v.decode(bzrlib.user_encoding)
325
return (branch.controlfile("email", "r")
327
.decode(bzrlib.user_encoding)
330
if e.errno != errno.ENOENT:
336
return (open(os.path.join(config_dir(), "email"))
338
.decode(bzrlib.user_encoding)
341
if e.errno != errno.ENOENT:
344
v = os.environ.get('EMAIL')
346
return v.decode(bzrlib.user_encoding)
351
def username(branch):
352
"""Return email-style username.
354
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
356
TODO: Check it's reasonably well-formed.
358
v = _get_user_id(branch)
362
name, email = _auto_user_id()
364
return '%s <%s>' % (name, email)
369
def user_email(branch):
370
"""Return just the email component of a username."""
371
e = _get_user_id(branch)
373
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
375
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
378
return _auto_user_id()[1]
382
def compare_files(a, b):
383
"""Returns true if equal in contents"""
395
def local_time_offset(t=None):
396
"""Return offset of local zone from GMT, either at present or at time t."""
397
# python2.3 localtime() can't take None
401
if time.localtime(t).tm_isdst and time.daylight:
404
return -time.timezone
407
def format_date(t, offset=0, timezone='original'):
408
## TODO: Perhaps a global option to use either universal or local time?
409
## Or perhaps just let people set $TZ?
410
assert isinstance(t, float)
412
if timezone == 'utc':
415
elif timezone == 'original':
418
tt = time.gmtime(t + offset)
419
elif timezone == 'local':
420
tt = time.localtime(t)
421
offset = local_time_offset(t)
423
raise BzrError("unsupported timezone format %r" % timezone,
424
['options are "utc", "original", "local"'])
426
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
427
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
430
def compact_date(when):
431
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
436
"""Return size of given open file."""
437
return os.fstat(f.fileno())[ST_SIZE]
440
if hasattr(os, 'urandom'): # python 2.4 and later
441
rand_bytes = os.urandom
442
elif sys.platform == 'linux2':
443
rand_bytes = file('/dev/urandom', 'rb').read
445
# not well seeded, but better than nothing
450
s += chr(random.randint(0, 255))
455
## TODO: We could later have path objects that remember their list
456
## decomposition (might be too tricksy though.)
459
"""Turn string into list of parts.
465
>>> splitpath('a/./b')
467
>>> splitpath('a/.b')
469
>>> splitpath('a/../b')
470
Traceback (most recent call last):
472
BzrError: sorry, '..' not allowed in path
474
assert isinstance(p, types.StringTypes)
476
# split on either delimiter because people might use either on
478
ps = re.split(r'[\\/]', p)
483
raise BzrError("sorry, %r not allowed in path" % f)
484
elif (f == '.') or (f == ''):
491
assert isinstance(p, list)
493
if (f == '..') or (f == None) or (f == ''):
494
raise BzrError("sorry, %r not allowed in path" % f)
495
return os.path.join(*p)
498
def appendpath(p1, p2):
502
return os.path.join(p1, p2)
505
def extern_command(cmd, ignore_errors = False):
506
mutter('external command: %s' % `cmd`)
508
if not ignore_errors:
509
raise BzrError('command failed')
512
def _read_config_value(name):
513
"""Read a config value from the file ~/.bzr.conf/<name>
514
Return None if the file does not exist"""
516
f = file(os.path.join(config_dir(), name), "r")
517
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
519
if e.errno == errno.ENOENT:
added
removed
bzrlib/osutils.py
