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.errors import BzrError
33
from bzrlib.trace import mutter
36
def make_readonly(filename):
37
"""Make a filename read-only."""
38
mod = os.stat(filename).st_mode
40
os.chmod(filename, mod)
43
def make_writable(filename):
44
mod = os.stat(filename).st_mode
46
os.chmod(filename, mod)
53
"""Return a quoted filename filename
55
This previously used backslash quoting, but that works poorly on
57
# TODO: I'm not really sure this is the best format either.x
60
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
62
if _QUOTE_RE.search(f):
69
mode = os.lstat(f)[ST_MODE]
88
def kind_marker(kind):
91
elif kind == 'directory':
93
elif kind == 'symlink':
96
raise BzrError('invalid file kind %r' % kind)
100
if hasattr(os, 'lstat'):
106
if e.errno == errno.ENOENT:
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
111
def normalizepath(f):
112
if hasattr(os.path, 'realpath'):
116
[p,e] = os.path.split(f)
117
if e == "" or e == "." or e == "..":
120
return os.path.join(F(p), e)
124
"""Copy a file to a backup.
126
Backups are named in GNU-style, with a ~ suffix.
128
If the file is already a backup, it's not copied.
134
if has_symlinks() and os.path.islink(fn):
135
target = os.readlink(fn)
136
os.symlink(target, bfn)
144
outf = file(bfn, 'wb')
158
"""True if f is an accessible directory."""
160
return S_ISDIR(os.lstat(f)[ST_MODE])
166
"""True if f is a regular file."""
168
return S_ISREG(os.lstat(f)[ST_MODE])
173
"""True if f is a symlink."""
175
return S_ISLNK(os.lstat(f)[ST_MODE])
179
def is_inside(dir, fname):
180
"""True if fname is inside dir.
182
The parameters should typically be passed to os.path.normpath first, so
183
that . and .. and repeated slashes are eliminated, and the separators
184
are canonical for the platform.
186
The empty string as a dir name is taken as top-of-tree and matches
189
>>> is_inside('src', os.path.join('src', 'foo.c'))
191
>>> is_inside('src', 'srccontrol')
193
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
195
>>> is_inside('foo.c', 'foo.c')
197
>>> is_inside('foo.c', '')
199
>>> is_inside('', 'foo.c')
202
# XXX: Most callers of this can actually do something smarter by
203
# looking at the inventory
210
if dir[-1] != os.sep:
213
return fname.startswith(dir)
216
def is_inside_any(dir_list, fname):
217
"""True if fname is inside any of given dirs."""
218
for dirname in dir_list:
219
if is_inside(dirname, fname):
225
def pumpfile(fromfile, tofile):
226
"""Copy contents of one file to another."""
227
tofile.write(fromfile.read())
231
if hasattr(f, 'tell'):
244
def sha_strings(strings):
245
"""Return the sha-1 of concatenation of strings"""
247
map(s.update, strings)
257
def fingerprint_file(f):
262
return {'size': size,
263
'sha1': s.hexdigest()}
266
def compare_files(a, b):
267
"""Returns true if equal in contents"""
278
def local_time_offset(t=None):
279
"""Return offset of local zone from GMT, either at present or at time t."""
280
# python2.3 localtime() can't take None
284
if time.localtime(t).tm_isdst and time.daylight:
287
return -time.timezone
290
def format_date(t, offset=0, timezone='original'):
291
## TODO: Perhaps a global option to use either universal or local time?
292
## Or perhaps just let people set $TZ?
293
assert isinstance(t, float)
295
if timezone == 'utc':
298
elif timezone == 'original':
301
tt = time.gmtime(t + offset)
302
elif timezone == 'local':
303
tt = time.localtime(t)
304
offset = local_time_offset(t)
306
raise BzrError("unsupported timezone format %r" % timezone,
307
['options are "utc", "original", "local"'])
309
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
310
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
313
def compact_date(when):
314
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
319
"""Return size of given open file."""
320
return os.fstat(f.fileno())[ST_SIZE]
322
# Define rand_bytes based on platform.
324
# Python 2.4 and later have os.urandom,
325
# but it doesn't work on some arches
327
rand_bytes = os.urandom
328
except (NotImplementedError, AttributeError):
329
# If python doesn't have os.urandom, or it doesn't work,
330
# then try to first pull random data from /dev/urandom
331
if os.path.exists("/dev/urandom"):
332
rand_bytes = file('/dev/urandom', 'rb').read
333
# Otherwise, use this hack as a last resort
335
# not well seeded, but better than nothing
340
s += chr(random.randint(0, 255))
344
## TODO: We could later have path objects that remember their list
345
## decomposition (might be too tricksy though.)
348
"""Turn string into list of parts.
354
>>> splitpath('a/./b')
356
>>> splitpath('a/.b')
358
>>> splitpath('a/../b')
359
Traceback (most recent call last):
361
BzrError: sorry, '..' not allowed in path
363
assert isinstance(p, types.StringTypes)
365
# split on either delimiter because people might use either on
367
ps = re.split(r'[\\/]', p)
372
raise BzrError("sorry, %r not allowed in path" % f)
373
elif (f == '.') or (f == ''):
380
assert isinstance(p, list)
382
if (f == '..') or (f == None) or (f == ''):
383
raise BzrError("sorry, %r not allowed in path" % f)
384
return os.path.join(*p)
387
def appendpath(p1, p2):
391
return os.path.join(p1, p2)
395
"""Split s into lines, but without removing the newline characters."""
396
return StringIO(s).readlines()
399
def hardlinks_good():
400
return sys.platform not in ('win32', 'cygwin', 'darwin')
403
def link_or_copy(src, dest):
404
"""Hardlink a file, or copy it if it can't be hardlinked."""
405
if not hardlinks_good():
410
except (OSError, IOError), e:
411
if e.errno != errno.EXDEV:
417
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
