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
33
from bzrlib.errors import BzrError, PathNotChild
34
from bzrlib.trace import mutter
37
def make_readonly(filename):
38
"""Make a filename read-only."""
39
mod = os.stat(filename).st_mode
41
os.chmod(filename, mod)
44
def make_writable(filename):
45
mod = os.stat(filename).st_mode
47
os.chmod(filename, mod)
54
"""Return a quoted filename filename
56
This previously used backslash quoting, but that works poorly on
58
# TODO: I'm not really sure this is the best format either.x
61
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
63
if _QUOTE_RE.search(f):
70
mode = os.lstat(f)[ST_MODE]
89
def kind_marker(kind):
92
elif kind == 'directory':
94
elif kind == 'symlink':
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
140
"""Copy a file to a backup.
142
Backups are named in GNU-style, with a ~ suffix.
144
If the file is already a backup, it's not copied.
150
if has_symlinks() and os.path.islink(fn):
151
target = os.readlink(fn)
152
os.symlink(target, bfn)
160
outf = file(bfn, 'wb')
174
"""True if f is an accessible directory."""
176
return S_ISDIR(os.lstat(f)[ST_MODE])
182
"""True if f is a regular file."""
184
return S_ISREG(os.lstat(f)[ST_MODE])
189
"""True if f is a symlink."""
191
return S_ISLNK(os.lstat(f)[ST_MODE])
195
def is_inside(dir, fname):
196
"""True if fname is inside dir.
198
The parameters should typically be passed to os.path.normpath first, so
199
that . and .. and repeated slashes are eliminated, and the separators
200
are canonical for the platform.
202
The empty string as a dir name is taken as top-of-tree and matches
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
207
>>> is_inside('src', 'srccontrol')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
211
>>> is_inside('foo.c', 'foo.c')
213
>>> is_inside('foo.c', '')
215
>>> is_inside('', 'foo.c')
218
# XXX: Most callers of this can actually do something smarter by
219
# looking at the inventory
226
if dir[-1] != os.sep:
229
return fname.startswith(dir)
232
def is_inside_any(dir_list, fname):
233
"""True if fname is inside any of given dirs."""
234
for dirname in dir_list:
235
if is_inside(dirname, fname):
241
def pumpfile(fromfile, tofile):
242
"""Copy contents of one file to another."""
245
b = fromfile.read(BUFSIZE)
252
if hasattr(f, 'tell'):
265
def sha_strings(strings):
266
"""Return the sha-1 of concatenation of strings"""
268
map(s.update, strings)
278
def fingerprint_file(f):
283
return {'size': size,
284
'sha1': s.hexdigest()}
287
def compare_files(a, b):
288
"""Returns true if equal in contents"""
299
def local_time_offset(t=None):
300
"""Return offset of local zone from GMT, either at present or at time t."""
301
# python2.3 localtime() can't take None
305
if time.localtime(t).tm_isdst and time.daylight:
308
return -time.timezone
311
def format_date(t, offset=0, timezone='original', date_fmt=None,
313
## TODO: Perhaps a global option to use either universal or local time?
314
## Or perhaps just let people set $TZ?
315
assert isinstance(t, float)
317
if timezone == 'utc':
320
elif timezone == 'original':
323
tt = time.gmtime(t + offset)
324
elif timezone == 'local':
325
tt = time.localtime(t)
326
offset = local_time_offset(t)
328
raise BzrError("unsupported timezone format %r" % timezone,
329
['options are "utc", "original", "local"'])
331
date_fmt = "%a %Y-%m-%d %H:%M:%S"
333
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
336
return (time.strftime(date_fmt, tt) + offset_str)
339
def compact_date(when):
340
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
345
"""Return size of given open file."""
346
return os.fstat(f.fileno())[ST_SIZE]
348
# Define rand_bytes based on platform.
350
# Python 2.4 and later have os.urandom,
351
# but it doesn't work on some arches
353
rand_bytes = os.urandom
354
except (NotImplementedError, AttributeError):
355
# If python doesn't have os.urandom, or it doesn't work,
356
# then try to first pull random data from /dev/urandom
357
if os.path.exists("/dev/urandom"):
358
rand_bytes = file('/dev/urandom', 'rb').read
359
# Otherwise, use this hack as a last resort
361
# not well seeded, but better than nothing
366
s += chr(random.randint(0, 255))
370
## TODO: We could later have path objects that remember their list
371
## decomposition (might be too tricksy though.)
374
"""Turn string into list of parts.
380
>>> splitpath('a/./b')
382
>>> splitpath('a/.b')
384
>>> splitpath('a/../b')
385
Traceback (most recent call last):
387
BzrError: sorry, '..' not allowed in path
389
assert isinstance(p, types.StringTypes)
391
# split on either delimiter because people might use either on
393
ps = re.split(r'[\\/]', p)
398
raise BzrError("sorry, %r not allowed in path" % f)
399
elif (f == '.') or (f == ''):
406
assert isinstance(p, list)
408
if (f == '..') or (f == None) or (f == ''):
409
raise BzrError("sorry, %r not allowed in path" % f)
410
return os.path.join(*p)
413
def appendpath(p1, p2):
417
return os.path.join(p1, p2)
421
"""Split s into lines, but without removing the newline characters."""
422
return StringIO(s).readlines()
425
def hardlinks_good():
426
return sys.platform not in ('win32', 'cygwin', 'darwin')
429
def link_or_copy(src, dest):
430
"""Hardlink a file, or copy it if it can't be hardlinked."""
431
if not hardlinks_good():
436
except (OSError, IOError), e:
437
if e.errno != errno.EXDEV:
443
if hasattr(os, 'symlink'):
449
def contains_whitespace(s):
450
"""True if there are any whitespace characters in s."""
451
for ch in string.whitespace:
458
def contains_linebreaks(s):
459
"""True if there is any vertical whitespace in s."""
467
def relpath(base, path):
468
"""Return path relative to base, or raise exception.
470
The path may be either an absolute path or a path relative to the
471
current working directory.
473
os.path.commonprefix (python2.4) has a bad bug that it works just
474
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
475
avoids that problem."""
480
while len(head) >= len(base):
483
head, tail = os.path.split(head)
487
# XXX This should raise a NotChildPath exception, as its not tied
489
raise PathNotChild(rp, base)
491
return os.sep.join(s)
495
def terminal_width():
496
"""Return estimated terminal width."""
498
# TODO: Do something smart on Windows?
500
# TODO: Is there anything that gets a better update when the window
501
# is resized while the program is running? We could use the Python termcap
504
return int(os.environ['COLUMNS'])
505
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
