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
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
34
from bzrlib.errors import BzrError, PathNotChild
35
from bzrlib.trace import mutter
38
def make_readonly(filename):
39
"""Make a filename read-only."""
40
mod = os.stat(filename).st_mode
42
os.chmod(filename, mod)
45
def make_writable(filename):
46
mod = os.stat(filename).st_mode
48
os.chmod(filename, mod)
55
"""Return a quoted filename filename
57
This previously used backslash quoting, but that works poorly on
59
# TODO: I'm not really sure this is the best format either.x
62
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
64
if _QUOTE_RE.search(f):
71
mode = os.lstat(f)[ST_MODE]
90
def kind_marker(kind):
93
elif kind == 'directory':
95
elif kind == 'symlink':
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)
162
"""Copy a file to a backup.
164
Backups are named in GNU-style, with a ~ suffix.
166
If the file is already a backup, it's not copied.
172
if has_symlinks() and os.path.islink(fn):
173
target = os.readlink(fn)
174
os.symlink(target, bfn)
182
outf = file(bfn, 'wb')
196
"""True if f is an accessible directory."""
198
return S_ISDIR(os.lstat(f)[ST_MODE])
204
"""True if f is a regular file."""
206
return S_ISREG(os.lstat(f)[ST_MODE])
211
"""True if f is a symlink."""
213
return S_ISLNK(os.lstat(f)[ST_MODE])
217
def is_inside(dir, fname):
218
"""True if fname is inside dir.
220
The parameters should typically be passed to osutils.normpath first, so
221
that . and .. and repeated slashes are eliminated, and the separators
222
are canonical for the platform.
224
The empty string as a dir name is taken as top-of-tree and matches
227
>>> is_inside('src', pathjoin('src', 'foo.c'))
229
>>> is_inside('src', 'srccontrol')
231
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
233
>>> is_inside('foo.c', 'foo.c')
235
>>> is_inside('foo.c', '')
237
>>> is_inside('', 'foo.c')
240
# XXX: Most callers of this can actually do something smarter by
241
# looking at the inventory
251
return fname.startswith(dir)
254
def is_inside_any(dir_list, fname):
255
"""True if fname is inside any of given dirs."""
256
for dirname in dir_list:
257
if is_inside(dirname, fname):
263
def pumpfile(fromfile, tofile):
264
"""Copy contents of one file to another."""
267
b = fromfile.read(BUFSIZE)
274
if hasattr(f, 'tell'):
287
def sha_strings(strings):
288
"""Return the sha-1 of concatenation of strings"""
290
map(s.update, strings)
300
def fingerprint_file(f):
305
return {'size': size,
306
'sha1': s.hexdigest()}
309
def compare_files(a, b):
310
"""Returns true if equal in contents"""
321
def local_time_offset(t=None):
322
"""Return offset of local zone from GMT, either at present or at time t."""
323
# python2.3 localtime() can't take None
327
if time.localtime(t).tm_isdst and time.daylight:
330
return -time.timezone
333
def format_date(t, offset=0, timezone='original', date_fmt=None,
335
## TODO: Perhaps a global option to use either universal or local time?
336
## Or perhaps just let people set $TZ?
337
assert isinstance(t, float)
339
if timezone == 'utc':
342
elif timezone == 'original':
345
tt = time.gmtime(t + offset)
346
elif timezone == 'local':
347
tt = time.localtime(t)
348
offset = local_time_offset(t)
350
raise BzrError("unsupported timezone format %r" % timezone,
351
['options are "utc", "original", "local"'])
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)
361
def compact_date(when):
362
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
367
"""Return size of given open file."""
368
return os.fstat(f.fileno())[ST_SIZE]
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
375
rand_bytes = os.urandom
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))
392
## TODO: We could later have path objects that remember their list
393
## decomposition (might be too tricksy though.)
396
"""Turn string into list of parts.
402
>>> splitpath('a/./b')
404
>>> splitpath('a/.b')
406
>>> splitpath('a/../b')
407
Traceback (most recent call last):
409
BzrError: sorry, '..' not allowed in path
411
assert isinstance(p, types.StringTypes)
413
# split on either delimiter because people might use either on
415
ps = re.split(r'[\\/]', p)
420
raise BzrError("sorry, %r not allowed in path" % f)
421
elif (f == '.') or (f == ''):
428
assert isinstance(p, list)
430
if (f == '..') or (f == None) or (f == ''):
431
raise BzrError("sorry, %r not allowed in path" % f)
435
def appendpath(p1, p2):
439
return pathjoin(p1, p2)
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)
519
def terminal_width():
520
"""Return estimated terminal width."""
522
# TODO: Do something smart on Windows?
524
# TODO: Is there anything that gets a better update when the window
525
# is resized while the program is running? We could use the Python termcap
528
return int(os.environ['COLUMNS'])
529
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
