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
34
from bzrlib.errors import (BzrError,
35
BzrBadParameterNotUnicode,
39
from bzrlib.trace import mutter
42
def make_readonly(filename):
43
"""Make a filename read-only."""
44
mod = os.stat(filename).st_mode
46
os.chmod(filename, mod)
49
def make_writable(filename):
50
mod = os.stat(filename).st_mode
52
os.chmod(filename, mod)
59
"""Return a quoted filename filename
61
This previously used backslash quoting, but that works poorly on
63
# TODO: I'm not really sure this is the best format either.x
66
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
68
if _QUOTE_RE.search(f):
75
mode = os.lstat(f)[ST_MODE]
94
def kind_marker(kind):
97
elif kind == 'directory':
99
elif kind == 'symlink':
102
raise BzrError('invalid file kind %r' % kind)
105
if hasattr(os.path, 'lexists'):
106
return os.path.lexists(f)
108
if hasattr(os, 'lstat'):
114
if e.errno == errno.ENOENT:
117
raise BzrError("lstat/stat of (%r): %r" % (f, e))
119
def fancy_rename(old, new, rename_func, unlink_func):
120
"""A fancy rename, when you don't have atomic rename.
122
:param old: The old path, to rename from
123
:param new: The new path, to rename to
124
:param rename_func: The potentially non-atomic rename function
125
:param unlink_func: A way to delete the target file if the full rename succeeds
128
# sftp rename doesn't allow overwriting, so play tricks:
130
base = os.path.basename(new)
131
dirname = os.path.dirname(new)
132
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
133
tmp_name = pathjoin(dirname, tmp_name)
135
# Rename the file out of the way, but keep track if it didn't exist
136
# We don't want to grab just any exception
137
# something like EACCES should prevent us from continuing
138
# The downside is that the rename_func has to throw an exception
139
# with an errno = ENOENT, or NoSuchFile
142
rename_func(new, tmp_name)
143
except (NoSuchFile,), e:
146
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
# function raises an IOError with errno == None when a rename fails.
148
# This then gets caught here.
149
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
152
if (not hasattr(e, 'errno')
153
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
160
# This may throw an exception, in which case success will
162
rename_func(old, new)
166
# If the file used to exist, rename it back into place
167
# otherwise just delete it from the tmp location
169
unlink_func(tmp_name)
171
rename_func(tmp_name, new)
173
# Default is to just use the python builtins
174
abspath = os.path.abspath
175
realpath = os.path.realpath
176
pathjoin = os.path.join
177
normpath = os.path.normpath
179
mkdtemp = tempfile.mkdtemp
181
dirname = os.path.dirname
182
basename = os.path.basename
184
MIN_ABS_PATHLENGTH = 1
186
if os.name == "posix":
187
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
188
# choke on a Unicode string containing a relative path if
189
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
191
_fs_enc = sys.getfilesystemencoding()
193
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
196
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
198
if sys.platform == 'win32':
199
# We need to use the Unicode-aware os.path.abspath and
200
# os.path.realpath on Windows systems.
202
return os.path.abspath(path).replace('\\', '/')
205
return os.path.realpath(path).replace('\\', '/')
208
return os.path.join(*args).replace('\\', '/')
211
return os.path.normpath(path).replace('\\', '/')
214
return os.getcwdu().replace('\\', '/')
216
def mkdtemp(*args, **kwargs):
217
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
219
def rename(old, new):
220
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
222
MIN_ABS_PATHLENGTH = 3
224
def normalizepath(f):
225
if hasattr(os.path, 'realpath'):
229
[p,e] = os.path.split(f)
230
if e == "" or e == "." or e == "..":
233
return pathjoin(F(p), e)
237
"""Copy a file to a backup.
239
Backups are named in GNU-style, with a ~ suffix.
241
If the file is already a backup, it's not copied.
247
if has_symlinks() and os.path.islink(fn):
248
target = os.readlink(fn)
249
os.symlink(target, bfn)
257
outf = file(bfn, 'wb')
265
"""True if f is an accessible directory."""
267
return S_ISDIR(os.lstat(f)[ST_MODE])
273
"""True if f is a regular file."""
275
return S_ISREG(os.lstat(f)[ST_MODE])
280
"""True if f is a symlink."""
282
return S_ISLNK(os.lstat(f)[ST_MODE])
286
def is_inside(dir, fname):
287
"""True if fname is inside dir.
289
The parameters should typically be passed to osutils.normpath first, so
290
that . and .. and repeated slashes are eliminated, and the separators
291
are canonical for the platform.
293
The empty string as a dir name is taken as top-of-tree and matches
296
>>> is_inside('src', pathjoin('src', 'foo.c'))
298
>>> is_inside('src', 'srccontrol')
300
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
302
>>> is_inside('foo.c', 'foo.c')
304
>>> is_inside('foo.c', '')
306
>>> is_inside('', 'foo.c')
309
# XXX: Most callers of this can actually do something smarter by
310
# looking at the inventory
320
return fname.startswith(dir)
323
def is_inside_any(dir_list, fname):
324
"""True if fname is inside any of given dirs."""
325
for dirname in dir_list:
326
if is_inside(dirname, fname):
332
def pumpfile(fromfile, tofile):
333
"""Copy contents of one file to another."""
336
b = fromfile.read(BUFSIZE)
342
def file_iterator(input_file, readsize=32768):
344
b = input_file.read(readsize)
351
if hasattr(f, 'tell'):
364
def sha_strings(strings):
365
"""Return the sha-1 of concatenation of strings"""
367
map(s.update, strings)
377
def fingerprint_file(f):
382
return {'size': size,
383
'sha1': s.hexdigest()}
386
def compare_files(a, b):
387
"""Returns true if equal in contents"""
398
def local_time_offset(t=None):
399
"""Return offset of local zone from GMT, either at present or at time t."""
400
# python2.3 localtime() can't take None
404
if time.localtime(t).tm_isdst and time.daylight:
407
return -time.timezone
410
def format_date(t, offset=0, timezone='original', date_fmt=None,
412
## TODO: Perhaps a global option to use either universal or local time?
413
## Or perhaps just let people set $TZ?
414
assert isinstance(t, float)
416
if timezone == 'utc':
419
elif timezone == 'original':
422
tt = time.gmtime(t + offset)
423
elif timezone == 'local':
424
tt = time.localtime(t)
425
offset = local_time_offset(t)
427
raise BzrError("unsupported timezone format %r" % timezone,
428
['options are "utc", "original", "local"'])
430
date_fmt = "%a %Y-%m-%d %H:%M:%S"
432
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
435
return (time.strftime(date_fmt, tt) + offset_str)
438
def compact_date(when):
439
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
444
"""Return size of given open file."""
445
return os.fstat(f.fileno())[ST_SIZE]
448
# Define rand_bytes based on platform.
450
# Python 2.4 and later have os.urandom,
451
# but it doesn't work on some arches
453
rand_bytes = os.urandom
454
except (NotImplementedError, AttributeError):
455
# If python doesn't have os.urandom, or it doesn't work,
456
# then try to first pull random data from /dev/urandom
457
if os.path.exists("/dev/urandom"):
458
rand_bytes = file('/dev/urandom', 'rb').read
459
# Otherwise, use this hack as a last resort
461
# not well seeded, but better than nothing
466
s += chr(random.randint(0, 255))
471
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
473
"""Return a random string of num alphanumeric characters
475
The result only contains lowercase chars because it may be used on
476
case-insensitive filesystems.
479
for raw_byte in rand_bytes(num):
480
s += ALNUM[ord(raw_byte) % 36]
484
## TODO: We could later have path objects that remember their list
485
## decomposition (might be too tricksy though.)
488
"""Turn string into list of parts.
494
>>> splitpath('a/./b')
496
>>> splitpath('a/.b')
498
>>> splitpath('a/../b')
499
Traceback (most recent call last):
501
BzrError: sorry, '..' not allowed in path
503
assert isinstance(p, types.StringTypes)
505
# split on either delimiter because people might use either on
507
ps = re.split(r'[\\/]', p)
512
raise BzrError("sorry, %r not allowed in path" % f)
513
elif (f == '.') or (f == ''):
520
assert isinstance(p, list)
522
if (f == '..') or (f == None) or (f == ''):
523
raise BzrError("sorry, %r not allowed in path" % f)
527
def appendpath(p1, p2):
531
return pathjoin(p1, p2)
535
"""Split s into lines, but without removing the newline characters."""
536
lines = s.split('\n')
537
result = [line + '\n' for line in lines[:-1]]
539
result.append(lines[-1])
543
def hardlinks_good():
544
return sys.platform not in ('win32', 'cygwin', 'darwin')
547
def link_or_copy(src, dest):
548
"""Hardlink a file, or copy it if it can't be hardlinked."""
549
if not hardlinks_good():
554
except (OSError, IOError), e:
555
if e.errno != errno.EXDEV:
559
def delete_any(full_path):
560
"""Delete a file or directory."""
564
# We may be renaming a dangling inventory id
565
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
571
if hasattr(os, 'symlink'):
577
def contains_whitespace(s):
578
"""True if there are any whitespace characters in s."""
579
for ch in string.whitespace:
586
def contains_linebreaks(s):
587
"""True if there is any vertical whitespace in s."""
595
def relpath(base, path):
596
"""Return path relative to base, or raise exception.
598
The path may be either an absolute path or a path relative to the
599
current working directory.
601
os.path.commonprefix (python2.4) has a bad bug that it works just
602
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
606
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
607
' exceed the platform minimum length (which is %d)' %
613
while len(head) >= len(base):
616
head, tail = os.path.split(head)
620
# XXX This should raise a NotChildPath exception, as its not tied
622
raise PathNotChild(rp, base)
630
def safe_unicode(unicode_or_utf8_string):
631
"""Coerce unicode_or_utf8_string into unicode.
633
If it is unicode, it is returned.
634
Otherwise it is decoded from utf-8. If a decoding error
635
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
636
as a BzrBadParameter exception.
638
if isinstance(unicode_or_utf8_string, unicode):
639
return unicode_or_utf8_string
641
return unicode_or_utf8_string.decode('utf8')
642
except UnicodeDecodeError:
643
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
646
def terminal_width():
647
"""Return estimated terminal width."""
649
# TODO: Do something smart on Windows?
651
# TODO: Is there anything that gets a better update when the window
652
# is resized while the program is running? We could use the Python termcap
655
return int(os.environ['COLUMNS'])
656
except (IndexError, KeyError, ValueError):
659
def supports_executable():
660
return sys.platform != "win32"
663
def strip_trailing_slash(path):
664
"""Strip trailing slash, except for root paths.
665
The definition of 'root path' is platform-dependent.
667
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
added
removed
bzrlib/osutils.py
