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
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 bzrlib.errors import BzrError
34
from bzrlib.errors import BzrError, PathNotChild
23
35
from bzrlib.trace import mutter
26
38
def make_readonly(filename):
27
39
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
40
mod = os.stat(filename).st_mode
30
41
mod = mod & 0777555
31
42
os.chmod(filename, mod)
79
98
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os.path, 'lexists'):
102
return os.path.lexists(f)
104
if hasattr(os, 'lstat'):
110
if e.errno == errno.ENOENT:
113
raise BzrError("lstat/stat of (%r): %r" % (f, e))
115
if os.name == "posix":
116
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
117
# choke on a Unicode string containing a relative path if
118
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
120
_fs_enc = sys.getfilesystemencoding()
122
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
124
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
125
pathjoin = os.path.join
126
normpath = os.path.normpath
128
mkdtemp = tempfile.mkdtemp
130
# We need to use the Unicode-aware os.path.abspath and
131
# os.path.realpath on Windows systems.
133
return os.path.abspath(path).replace('\\', '/')
135
return os.path.realpath(path).replace('\\', '/')
137
return os.path.join(*args).replace('\\', '/')
139
return os.path.normpath(path).replace('\\', '/')
141
return os.getcwdu().replace('\\', '/')
142
def mkdtemp(*args, **kwargs):
143
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
144
# Because these shrink the path, we can use the original
145
# versions on any platform
146
dirname = os.path.dirname
147
basename = os.path.basename
149
def normalizepath(f):
150
if hasattr(os.path, 'realpath'):
154
[p,e] = os.path.split(f)
155
if e == "" or e == "." or e == "..":
158
return pathjoin(F(p), e)
83
161
def backup_file(fn):
211
"""True if f is a symlink."""
213
return S_ISLNK(os.lstat(f)[ST_MODE])
138
217
def is_inside(dir, fname):
139
218
"""True if fname is inside dir.
141
The parameters should typically be passed to os.path.normpath first, so
220
The parameters should typically be passed to osutils.normpath first, so
142
221
that . and .. and repeated slashes are eliminated, and the separators
143
222
are canonical for the platform.
145
224
The empty string as a dir name is taken as top-of-tree and matches
148
>>> is_inside('src', 'src/foo.c')
227
>>> is_inside('src', pathjoin('src', 'foo.c'))
150
229
>>> is_inside('src', 'srccontrol')
152
>>> is_inside('src', 'src/a/a/a/foo.c')
231
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
154
233
>>> is_inside('foo.c', 'foo.c')
226
306
'sha1': s.hexdigest()}
230
"""Return per-user configuration directory.
232
By default this is ~/.bzr.conf/
234
TODO: Global option --config-dir to override this.
236
return os.path.expanduser("~/.bzr.conf")
240
"""Calculate automatic user identification.
242
Returns (realname, email).
244
Only used when none is set in the environment or the id file.
246
This previously used the FQDN as the default domain, but that can
247
be very slow on machines where DNS is broken. So now we simply
252
# XXX: Any good way to get real user name on win32?
257
w = pwd.getpwuid(uid)
258
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
username = w.pw_name.decode(bzrlib.user_encoding)
260
comma = gecos.find(',')
264
realname = gecos[:comma]
270
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
272
return realname, (username + '@' + socket.gethostname())
275
def _get_user_id(branch):
276
"""Return the full user id from a file or environment variable.
278
e.g. "John Hacker <jhacker@foo.org>"
281
A branch to use for a per-branch configuration, or None.
283
The following are searched in order:
286
2. .bzr/email for this branch.
290
v = os.environ.get('BZREMAIL')
292
return v.decode(bzrlib.user_encoding)
296
return (branch.controlfile("email", "r")
298
.decode(bzrlib.user_encoding)
301
if e.errno != errno.ENOENT:
307
return (open(os.path.join(config_dir(), "email"))
309
.decode(bzrlib.user_encoding)
312
if e.errno != errno.ENOENT:
315
v = os.environ.get('EMAIL')
317
return v.decode(bzrlib.user_encoding)
322
def username(branch):
323
"""Return email-style username.
325
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
327
TODO: Check it's reasonably well-formed.
329
v = _get_user_id(branch)
333
name, email = _auto_user_id()
335
return '%s <%s>' % (name, email)
340
def user_email(branch):
341
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
344
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
349
return _auto_user_id()[1]
353
309
def compare_files(a, b):
354
310
"""Returns true if equal in contents"""
375
330
return -time.timezone
378
def format_date(t, offset=0, timezone='original'):
333
def format_date(t, offset=0, timezone='original', date_fmt=None,
379
335
## TODO: Perhaps a global option to use either universal or local time?
380
336
## Or perhaps just let people set $TZ?
381
337
assert isinstance(t, float)
394
350
raise BzrError("unsupported timezone format %r" % timezone,
395
351
['options are "utc", "original", "local"'])
397
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
398
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
353
date_fmt = "%a %Y-%m-%d %H:%M:%S"
355
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
358
return (time.strftime(date_fmt, tt) + offset_str)
401
361
def compact_date(when):
407
367
"""Return size of given open file."""
408
368
return os.fstat(f.fileno())[ST_SIZE]
411
if hasattr(os, 'urandom'): # python 2.4 and later
370
# Define rand_bytes based on platform.
372
# Python 2.4 and later have os.urandom,
373
# but it doesn't work on some arches
412
375
rand_bytes = os.urandom
413
elif sys.platform == 'linux2':
414
rand_bytes = file('/dev/urandom', 'rb').read
416
# not well seeded, but better than nothing
421
s += chr(random.randint(0, 255))
376
except (NotImplementedError, AttributeError):
377
# If python doesn't have os.urandom, or it doesn't work,
378
# then try to first pull random data from /dev/urandom
379
if os.path.exists("/dev/urandom"):
380
rand_bytes = file('/dev/urandom', 'rb').read
381
# Otherwise, use this hack as a last resort
383
# not well seeded, but better than nothing
388
s += chr(random.randint(0, 255))
426
392
## TODO: We could later have path objects that remember their list
427
393
## decomposition (might be too tricksy though.)
464
430
if (f == '..') or (f == None) or (f == ''):
465
431
raise BzrError("sorry, %r not allowed in path" % f)
466
return os.path.join(*p)
469
435
def appendpath(p1, p2):
473
return os.path.join(p1, p2)
439
return pathjoin(p1, p2)
476
def extern_command(cmd, ignore_errors = False):
477
mutter('external command: %s' % `cmd`)
479
if not ignore_errors:
480
raise BzrError('command failed')
483
def _read_config_value(name):
484
"""Read a config value from the file ~/.bzr.conf/<name>
485
Return None if the file does not exist"""
487
f = file(os.path.join(config_dir(), name), "r")
488
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
490
if e.errno == errno.ENOENT:
443
"""Split s into lines, but without removing the newline characters."""
444
return StringIO(s).readlines()
447
def hardlinks_good():
448
return sys.platform not in ('win32', 'cygwin', 'darwin')
451
def link_or_copy(src, dest):
452
"""Hardlink a file, or copy it if it can't be hardlinked."""
453
if not hardlinks_good():
458
except (OSError, IOError), e:
459
if e.errno != errno.EXDEV:
465
if hasattr(os, 'symlink'):
471
def contains_whitespace(s):
472
"""True if there are any whitespace characters in s."""
473
for ch in string.whitespace:
480
def contains_linebreaks(s):
481
"""True if there is any vertical whitespace in s."""
489
def relpath(base, path):
490
"""Return path relative to base, or raise exception.
492
The path may be either an absolute path or a path relative to the
493
current working directory.
495
os.path.commonprefix (python2.4) has a bad bug that it works just
496
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
497
avoids that problem."""
502
while len(head) >= len(base):
505
head, tail = os.path.split(head)
509
# XXX This should raise a NotChildPath exception, as its not tied
511
raise PathNotChild(rp, base)
520
def terminal_width():
521
"""Return estimated terminal width."""
523
# TODO: Do something smart on Windows?
525
# TODO: Is there anything that gets a better update when the window
526
# is resized while the program is running? We could use the Python termcap
529
return int(os.environ['COLUMNS'])
530
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
