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.config import config_dir, _get_user_id
34
from bzrlib.errors import BzrError
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)
102
if hasattr(os, 'lstat'):
108
if e.errno == errno.ENOENT:
111
raise BzrError("lstat/stat of (%r): %r" % (f, e))
113
def normalizepath(f):
114
if hasattr(os.path, 'realpath'):
118
[p,e] = os.path.split(f)
119
if e == "" or e == "." or e == "..":
122
return os.path.join(F(p), e)
126
"""Copy a file to a backup.
128
Backups are named in GNU-style, with a ~ suffix.
130
If the file is already a backup, it's not copied.
136
if has_symlinks() and os.path.islink(fn):
137
target = os.readlink(fn)
138
os.symlink(target, bfn)
146
outf = file(bfn, 'wb')
160
"""True if f is an accessible directory."""
162
return S_ISDIR(os.lstat(f)[ST_MODE])
168
"""True if f is a regular file."""
170
return S_ISREG(os.lstat(f)[ST_MODE])
175
"""True if f is a symlink."""
177
return S_ISLNK(os.lstat(f)[ST_MODE])
181
def is_inside(dir, fname):
182
"""True if fname is inside dir.
184
The parameters should typically be passed to os.path.normpath first, so
185
that . and .. and repeated slashes are eliminated, and the separators
186
are canonical for the platform.
188
The empty string as a dir name is taken as top-of-tree and matches
191
>>> is_inside('src', os.path.join('src', 'foo.c'))
193
>>> is_inside('src', 'srccontrol')
195
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
197
>>> is_inside('foo.c', 'foo.c')
199
>>> is_inside('foo.c', '')
201
>>> is_inside('', 'foo.c')
204
# XXX: Most callers of this can actually do something smarter by
205
# looking at the inventory
212
if dir[-1] != os.sep:
215
return fname.startswith(dir)
218
def is_inside_any(dir_list, fname):
219
"""True if fname is inside any of given dirs."""
220
for dirname in dir_list:
221
if is_inside(dirname, fname):
227
def pumpfile(fromfile, tofile):
228
"""Copy contents of one file to another."""
229
tofile.write(fromfile.read())
233
if hasattr(f, 'tell'):
246
def sha_strings(strings):
247
"""Return the sha-1 of concatenation of strings"""
249
map(s.update, strings)
259
def fingerprint_file(f):
264
return {'size': size,
265
'sha1': s.hexdigest()}
268
def compare_files(a, b):
269
"""Returns true if equal in contents"""
280
def local_time_offset(t=None):
281
"""Return offset of local zone from GMT, either at present or at time t."""
282
# python2.3 localtime() can't take None
286
if time.localtime(t).tm_isdst and time.daylight:
289
return -time.timezone
292
def format_date(t, offset=0, timezone='original'):
293
## TODO: Perhaps a global option to use either universal or local time?
294
## Or perhaps just let people set $TZ?
295
assert isinstance(t, float)
297
if timezone == 'utc':
300
elif timezone == 'original':
303
tt = time.gmtime(t + offset)
304
elif timezone == 'local':
305
tt = time.localtime(t)
306
offset = local_time_offset(t)
308
raise BzrError("unsupported timezone format %r" % timezone,
309
['options are "utc", "original", "local"'])
311
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
312
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
315
def compact_date(when):
316
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
321
"""Return size of given open file."""
322
return os.fstat(f.fileno())[ST_SIZE]
324
# Define rand_bytes based on platform.
326
# Python 2.4 and later have os.urandom,
327
# but it doesn't work on some arches
329
rand_bytes = os.urandom
330
except (NotImplementedError, AttributeError):
331
# If python doesn't have os.urandom, or it doesn't work,
332
# then try to first pull random data from /dev/urandom
333
if os.path.exists("/dev/urandom"):
334
rand_bytes = file('/dev/urandom', 'rb').read
335
# Otherwise, use this hack as a last resort
337
# not well seeded, but better than nothing
342
s += chr(random.randint(0, 255))
346
## TODO: We could later have path objects that remember their list
347
## decomposition (might be too tricksy though.)
350
"""Turn string into list of parts.
356
>>> splitpath('a/./b')
358
>>> splitpath('a/.b')
360
>>> splitpath('a/../b')
361
Traceback (most recent call last):
363
BzrError: sorry, '..' not allowed in path
365
assert isinstance(p, types.StringTypes)
367
# split on either delimiter because people might use either on
369
ps = re.split(r'[\\/]', p)
374
raise BzrError("sorry, %r not allowed in path" % f)
375
elif (f == '.') or (f == ''):
382
assert isinstance(p, list)
384
if (f == '..') or (f == None) or (f == ''):
385
raise BzrError("sorry, %r not allowed in path" % f)
386
return os.path.join(*p)
389
def appendpath(p1, p2):
393
return os.path.join(p1, p2)
397
"""Split s into lines, but without removing the newline characters."""
398
return StringIO(s).readlines()
401
def hardlinks_good():
402
return sys.platform not in ('win32', 'cygwin', 'darwin')
405
def link_or_copy(src, dest):
406
"""Hardlink a file, or copy it if it can't be hardlinked."""
407
if not hardlinks_good():
412
except (OSError, IOError), e:
413
if e.errno != errno.EXDEV:
419
if hasattr(os, 'symlink'):
425
def contains_whitespace(s):
426
"""True if there are any whitespace characters in s."""
427
for ch in string.whitespace:
434
def contains_linebreaks(s):
435
"""True if there is any vertical whitespace in s."""
added
removed
bzrlib/osutils.py
