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, sys
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
21
from cStringIO import StringIO
23
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
25
from bzrlib.errors import BzrError
33
from bzrlib.errors import BzrError, NotBranchError
26
34
from bzrlib.trace import mutter
29
37
def make_readonly(filename):
30
38
"""Make a filename read-only."""
31
# TODO: probably needs to be fixed for windows
32
39
mod = os.stat(filename).st_mode
33
40
mod = mod & 0777555
34
41
os.chmod(filename, mod)
82
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)
123
if os.name == "posix":
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
125
# choke on a Unicode string containing a relative path if
126
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
128
_fs_enc = sys.getfilesystemencoding()
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
134
# We need to use the Unicode-aware os.path.abspath and
135
# os.path.realpath on Windows systems.
136
abspath = os.path.abspath
137
realpath = os.path.realpath
86
139
def backup_file(fn):
87
140
"""Copy a file to a backup.
147
202
The empty string as a dir name is taken as top-of-tree and matches
150
>>> is_inside('src', 'src/foo.c')
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
152
207
>>> is_inside('src', 'srccontrol')
154
>>> is_inside('src', 'src/a/a/a/foo.c')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
156
211
>>> is_inside('foo.c', 'foo.c')
233
279
'sha1': s.hexdigest()}
237
"""Return per-user configuration directory.
239
By default this is ~/.bzr.conf/
241
TODO: Global option --config-dir to override this.
243
return os.path.expanduser("~/.bzr.conf")
247
"""Calculate automatic user identification.
249
Returns (realname, email).
251
Only used when none is set in the environment or the id file.
253
This previously used the FQDN as the default domain, but that can
254
be very slow on machines where DNS is broken. So now we simply
259
# XXX: Any good way to get real user name on win32?
264
w = pwd.getpwuid(uid)
265
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
266
username = w.pw_name.decode(bzrlib.user_encoding)
267
comma = gecos.find(',')
271
realname = gecos[:comma]
277
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
279
return realname, (username + '@' + socket.gethostname())
282
def _get_user_id(branch):
283
"""Return the full user id from a file or environment variable.
285
e.g. "John Hacker <jhacker@foo.org>"
288
A branch to use for a per-branch configuration, or None.
290
The following are searched in order:
293
2. .bzr/email for this branch.
297
v = os.environ.get('BZREMAIL')
299
return v.decode(bzrlib.user_encoding)
303
return (branch.controlfile("email", "r")
305
.decode(bzrlib.user_encoding)
308
if e.errno != errno.ENOENT:
314
return (open(os.path.join(config_dir(), "email"))
316
.decode(bzrlib.user_encoding)
319
if e.errno != errno.ENOENT:
322
v = os.environ.get('EMAIL')
324
return v.decode(bzrlib.user_encoding)
329
def username(branch):
330
"""Return email-style username.
332
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
334
TODO: Check it's reasonably well-formed.
336
v = _get_user_id(branch)
340
name, email = _auto_user_id()
342
return '%s <%s>' % (name, email)
347
def user_email(branch):
348
"""Return just the email component of a username."""
349
e = _get_user_id(branch)
351
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
353
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
356
return _auto_user_id()[1]
360
282
def compare_files(a, b):
361
283
"""Returns true if equal in contents"""
382
303
return -time.timezone
385
def format_date(t, offset=0, timezone='original'):
306
def format_date(t, offset=0, timezone='original', date_fmt=None,
386
308
## TODO: Perhaps a global option to use either universal or local time?
387
309
## Or perhaps just let people set $TZ?
388
310
assert isinstance(t, float)
401
323
raise BzrError("unsupported timezone format %r" % timezone,
402
324
['options are "utc", "original", "local"'])
404
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
405
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
326
date_fmt = "%a %Y-%m-%d %H:%M:%S"
328
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
331
return (time.strftime(date_fmt, tt) + offset_str)
408
334
def compact_date(when):
414
340
"""Return size of given open file."""
415
341
return os.fstat(f.fileno())[ST_SIZE]
418
if hasattr(os, 'urandom'): # python 2.4 and later
343
# Define rand_bytes based on platform.
345
# Python 2.4 and later have os.urandom,
346
# but it doesn't work on some arches
419
348
rand_bytes = os.urandom
420
elif sys.platform == 'linux2':
421
rand_bytes = file('/dev/urandom', 'rb').read
423
# not well seeded, but better than nothing
428
s += chr(random.randint(0, 255))
349
except (NotImplementedError, AttributeError):
350
# If python doesn't have os.urandom, or it doesn't work,
351
# then try to first pull random data from /dev/urandom
352
if os.path.exists("/dev/urandom"):
353
rand_bytes = file('/dev/urandom', 'rb').read
354
# Otherwise, use this hack as a last resort
356
# not well seeded, but better than nothing
361
s += chr(random.randint(0, 255))
433
365
## TODO: We could later have path objects that remember their list
434
366
## decomposition (might be too tricksy though.)
480
412
return os.path.join(p1, p2)
483
def extern_command(cmd, ignore_errors = False):
484
mutter('external command: %s' % `cmd`)
486
if not ignore_errors:
487
raise BzrError('command failed')
490
def _read_config_value(name):
491
"""Read a config value from the file ~/.bzr.conf/<name>
492
Return None if the file does not exist"""
494
f = file(os.path.join(config_dir(), name), "r")
495
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
497
if e.errno == errno.ENOENT:
503
415
def split_lines(s):
504
416
"""Split s into lines, but without removing the newline characters."""
505
417
return StringIO(s).readlines()
420
def hardlinks_good():
421
return sys.platform not in ('win32', 'cygwin', 'darwin')
424
def link_or_copy(src, dest):
425
"""Hardlink a file, or copy it if it can't be hardlinked."""
426
if not hardlinks_good():
431
except (OSError, IOError), e:
432
if e.errno != errno.EXDEV:
438
if hasattr(os, 'symlink'):
444
def contains_whitespace(s):
445
"""True if there are any whitespace characters in s."""
446
for ch in string.whitespace:
453
def contains_linebreaks(s):
454
"""True if there is any vertical whitespace in s."""
462
def relpath(base, path):
463
"""Return path relative to base, or raise exception.
465
The path may be either an absolute path or a path relative to the
466
current working directory.
468
os.path.commonprefix (python2.4) has a bad bug that it works just
469
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
470
avoids that problem."""
475
while len(head) >= len(base):
478
head, tail = os.path.split(head)
482
# XXX This should raise a NotChildPath exception, as its not tied
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
added
removed
bzrlib/osutils.py
