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
32
from bzrlib.config import config_dir, _get_user_id
33
from bzrlib.errors import BzrError
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)
125
"""Copy a file to a backup.
127
Backups are named in GNU-style, with a ~ suffix.
129
If the file is already a backup, it's not copied.
135
if has_symlinks() and os.path.islink(fn):
136
target = os.readlink(fn)
137
os.symlink(target, bfn)
145
outf = file(bfn, 'wb')
159
"""True if f is an accessible directory."""
161
return S_ISDIR(os.lstat(f)[ST_MODE])
167
"""True if f is a regular file."""
169
return S_ISREG(os.lstat(f)[ST_MODE])
174
"""True if f is a symlink."""
176
return S_ISLNK(os.lstat(f)[ST_MODE])
180
def is_inside(dir, fname):
181
"""True if fname is inside dir.
183
The parameters should typically be passed to os.path.normpath first, so
184
that . and .. and repeated slashes are eliminated, and the separators
185
are canonical for the platform.
187
The empty string as a dir name is taken as top-of-tree and matches
190
>>> is_inside('src', os.path.join('src', 'foo.c'))
192
>>> is_inside('src', 'srccontrol')
194
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
196
>>> is_inside('foo.c', 'foo.c')
198
>>> is_inside('foo.c', '')
200
>>> is_inside('', 'foo.c')
203
# XXX: Most callers of this can actually do something smarter by
204
# looking at the inventory
211
if dir[-1] != os.sep:
214
return fname.startswith(dir)
217
def is_inside_any(dir_list, fname):
218
"""True if fname is inside any of given dirs."""
219
for dirname in dir_list:
220
if is_inside(dirname, fname):
226
def pumpfile(fromfile, tofile):
227
"""Copy contents of one file to another."""
228
tofile.write(fromfile.read())
232
if hasattr(f, 'tell'):
245
def sha_strings(strings):
246
"""Return the sha-1 of concatenation of strings"""
248
map(s.update, strings)
258
def fingerprint_file(f):
263
return {'size': size,
264
'sha1': s.hexdigest()}
267
def compare_files(a, b):
268
"""Returns true if equal in contents"""
279
def local_time_offset(t=None):
280
"""Return offset of local zone from GMT, either at present or at time t."""
281
# python2.3 localtime() can't take None
285
if time.localtime(t).tm_isdst and time.daylight:
288
return -time.timezone
291
def format_date(t, offset=0, timezone='original'):
292
## TODO: Perhaps a global option to use either universal or local time?
293
## Or perhaps just let people set $TZ?
294
assert isinstance(t, float)
296
if timezone == 'utc':
299
elif timezone == 'original':
302
tt = time.gmtime(t + offset)
303
elif timezone == 'local':
304
tt = time.localtime(t)
305
offset = local_time_offset(t)
307
raise BzrError("unsupported timezone format %r" % timezone,
308
['options are "utc", "original", "local"'])
310
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
311
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
314
def compact_date(when):
315
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
320
"""Return size of given open file."""
321
return os.fstat(f.fileno())[ST_SIZE]
323
# Define rand_bytes based on platform.
325
# Python 2.4 and later have os.urandom,
326
# but it doesn't work on some arches
328
rand_bytes = os.urandom
329
except (NotImplementedError, AttributeError):
330
# If python doesn't have os.urandom, or it doesn't work,
331
# then try to first pull random data from /dev/urandom
332
if os.path.exists("/dev/urandom"):
333
rand_bytes = file('/dev/urandom', 'rb').read
334
# Otherwise, use this hack as a last resort
336
# not well seeded, but better than nothing
341
s += chr(random.randint(0, 255))
345
## TODO: We could later have path objects that remember their list
346
## decomposition (might be too tricksy though.)
349
"""Turn string into list of parts.
355
>>> splitpath('a/./b')
357
>>> splitpath('a/.b')
359
>>> splitpath('a/../b')
360
Traceback (most recent call last):
362
BzrError: sorry, '..' not allowed in path
364
assert isinstance(p, types.StringTypes)
366
# split on either delimiter because people might use either on
368
ps = re.split(r'[\\/]', p)
373
raise BzrError("sorry, %r not allowed in path" % f)
374
elif (f == '.') or (f == ''):
381
assert isinstance(p, list)
383
if (f == '..') or (f == None) or (f == ''):
384
raise BzrError("sorry, %r not allowed in path" % f)
385
return os.path.join(*p)
388
def appendpath(p1, p2):
392
return os.path.join(p1, p2)
396
"""Split s into lines, but without removing the newline characters."""
397
return StringIO(s).readlines()
400
def hardlinks_good():
401
return sys.platform not in ('win32', 'cygwin', 'darwin')
404
def link_or_copy(src, dest):
405
"""Hardlink a file, or copy it if it can't be hardlinked."""
406
if not hardlinks_good():
411
except (OSError, IOError), e:
412
if e.errno != errno.EXDEV:
418
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
