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.
141
outf = file(bfn, 'wb')
155
"""True if f is an accessible directory."""
157
return S_ISDIR(os.lstat(f)[ST_MODE])
163
"""True if f is a regular file."""
165
return S_ISREG(os.lstat(f)[ST_MODE])
170
"""True if f is a symlink."""
172
return S_ISLNK(os.lstat(f)[ST_MODE])
176
def is_inside(dir, fname):
177
"""True if fname is inside dir.
179
The parameters should typically be passed to os.path.normpath first, so
180
that . and .. and repeated slashes are eliminated, and the separators
181
are canonical for the platform.
183
The empty string as a dir name is taken as top-of-tree and matches
186
>>> is_inside('src', os.path.join('src', 'foo.c'))
188
>>> is_inside('src', 'srccontrol')
190
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
192
>>> is_inside('foo.c', 'foo.c')
194
>>> is_inside('foo.c', '')
196
>>> is_inside('', 'foo.c')
199
# XXX: Most callers of this can actually do something smarter by
200
# looking at the inventory
207
if dir[-1] != os.sep:
210
return fname.startswith(dir)
213
def is_inside_any(dir_list, fname):
214
"""True if fname is inside any of given dirs."""
215
for dirname in dir_list:
216
if is_inside(dirname, fname):
222
def pumpfile(fromfile, tofile):
223
"""Copy contents of one file to another."""
224
tofile.write(fromfile.read())
228
if hasattr(f, 'tell'):
241
def sha_strings(strings):
242
"""Return the sha-1 of concatenation of strings"""
244
map(s.update, strings)
254
def fingerprint_file(f):
259
return {'size': size,
260
'sha1': s.hexdigest()}
263
def compare_files(a, b):
264
"""Returns true if equal in contents"""
275
def local_time_offset(t=None):
276
"""Return offset of local zone from GMT, either at present or at time t."""
277
# python2.3 localtime() can't take None
281
if time.localtime(t).tm_isdst and time.daylight:
284
return -time.timezone
287
def format_date(t, offset=0, timezone='original'):
288
## TODO: Perhaps a global option to use either universal or local time?
289
## Or perhaps just let people set $TZ?
290
assert isinstance(t, float)
292
if timezone == 'utc':
295
elif timezone == 'original':
298
tt = time.gmtime(t + offset)
299
elif timezone == 'local':
300
tt = time.localtime(t)
301
offset = local_time_offset(t)
303
raise BzrError("unsupported timezone format %r" % timezone,
304
['options are "utc", "original", "local"'])
306
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
307
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
310
def compact_date(when):
311
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
316
"""Return size of given open file."""
317
return os.fstat(f.fileno())[ST_SIZE]
319
# Define rand_bytes based on platform.
321
# Python 2.4 and later have os.urandom,
322
# but it doesn't work on some arches
324
rand_bytes = os.urandom
325
except (NotImplementedError, AttributeError):
326
# If python doesn't have os.urandom, or it doesn't work,
327
# then try to first pull random data from /dev/urandom
328
if os.path.exists("/dev/urandom"):
329
rand_bytes = file('/dev/urandom', 'rb').read
330
# Otherwise, use this hack as a last resort
332
# not well seeded, but better than nothing
337
s += chr(random.randint(0, 255))
341
## TODO: We could later have path objects that remember their list
342
## decomposition (might be too tricksy though.)
345
"""Turn string into list of parts.
351
>>> splitpath('a/./b')
353
>>> splitpath('a/.b')
355
>>> splitpath('a/../b')
356
Traceback (most recent call last):
358
BzrError: sorry, '..' not allowed in path
360
assert isinstance(p, types.StringTypes)
362
# split on either delimiter because people might use either on
364
ps = re.split(r'[\\/]', p)
369
raise BzrError("sorry, %r not allowed in path" % f)
370
elif (f == '.') or (f == ''):
377
assert isinstance(p, list)
379
if (f == '..') or (f == None) or (f == ''):
380
raise BzrError("sorry, %r not allowed in path" % f)
381
return os.path.join(*p)
384
def appendpath(p1, p2):
388
return os.path.join(p1, p2)
392
"""Split s into lines, but without removing the newline characters."""
393
return StringIO(s).readlines()
396
def hardlinks_good():
397
return sys.platform not in ('win32', 'cygwin', 'darwin')
400
def link_or_copy(src, dest):
401
"""Hardlink a file, or copy it if it can't be hardlinked."""
402
if not hardlinks_good():
407
except (OSError, IOError), e:
408
if e.errno != errno.EXDEV:
414
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
