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,
40
from bzrlib.trace import mutter
43
def make_readonly(filename):
44
"""Make a filename read-only."""
45
mod = os.stat(filename).st_mode
47
os.chmod(filename, mod)
50
def make_writable(filename):
51
mod = os.stat(filename).st_mode
53
os.chmod(filename, mod)
60
"""Return a quoted filename filename
62
This previously used backslash quoting, but that works poorly on
64
# TODO: I'm not really sure this is the best format either.x
67
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
69
if _QUOTE_RE.search(f):
76
mode = os.lstat(f)[ST_MODE]
95
def kind_marker(kind):
98
elif kind == 'directory':
100
elif kind == 'symlink':
103
raise BzrError('invalid file kind %r' % kind)
106
if hasattr(os.path, 'lexists'):
107
return os.path.lexists(f)
109
if hasattr(os, 'lstat'):
115
if e.errno == errno.ENOENT:
118
raise BzrError("lstat/stat of (%r): %r" % (f, e))
120
def fancy_rename(old, new, rename_func, unlink_func):
121
"""A fancy rename, when you don't have atomic rename.
123
:param old: The old path, to rename from
124
:param new: The new path, to rename to
125
:param rename_func: The potentially non-atomic rename function
126
:param unlink_func: A way to delete the target file if the full rename succeeds
129
# sftp rename doesn't allow overwriting, so play tricks:
131
base = os.path.basename(new)
132
dirname = os.path.dirname(new)
133
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
134
tmp_name = pathjoin(dirname, tmp_name)
136
# Rename the file out of the way, but keep track if it didn't exist
137
# We don't want to grab just any exception
138
# something like EACCES should prevent us from continuing
139
# The downside is that the rename_func has to throw an exception
140
# with an errno = ENOENT, or NoSuchFile
143
rename_func(new, tmp_name)
144
except (NoSuchFile,), e:
147
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
148
# function raises an IOError with errno == None when a rename fails.
149
# This then gets caught here.
150
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
153
if (not hasattr(e, 'errno')
154
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
161
# This may throw an exception, in which case success will
163
rename_func(old, new)
167
# If the file used to exist, rename it back into place
168
# otherwise just delete it from the tmp location
170
unlink_func(tmp_name)
172
rename_func(tmp_name, new)
174
# Default is to just use the python builtins
175
abspath = os.path.abspath
176
realpath = os.path.realpath
177
pathjoin = os.path.join
178
normpath = os.path.normpath
180
mkdtemp = tempfile.mkdtemp
182
dirname = os.path.dirname
183
basename = os.path.basename
185
MIN_ABS_PATHLENGTH = 1
187
if os.name == "posix":
188
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
189
# choke on a Unicode string containing a relative path if
190
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
192
_fs_enc = sys.getfilesystemencoding()
194
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
197
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
199
if sys.platform == 'win32':
200
# We need to use the Unicode-aware os.path.abspath and
201
# os.path.realpath on Windows systems.
203
return os.path.abspath(path).replace('\\', '/')
206
return os.path.realpath(path).replace('\\', '/')
209
return os.path.join(*args).replace('\\', '/')
212
return os.path.normpath(path).replace('\\', '/')
215
return os.getcwdu().replace('\\', '/')
217
def mkdtemp(*args, **kwargs):
218
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
220
def rename(old, new):
221
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
223
MIN_ABS_PATHLENGTH = 3
225
def normalizepath(f):
226
if hasattr(os.path, 'realpath'):
230
[p,e] = os.path.split(f)
231
if e == "" or e == "." or e == "..":
234
return pathjoin(F(p), e)
238
"""Copy a file to a backup.
240
Backups are named in GNU-style, with a ~ suffix.
242
If the file is already a backup, it's not copied.
248
if has_symlinks() and os.path.islink(fn):
249
target = os.readlink(fn)
250
os.symlink(target, bfn)
258
outf = file(bfn, 'wb')
266
"""True if f is an accessible directory."""
268
return S_ISDIR(os.lstat(f)[ST_MODE])
274
"""True if f is a regular file."""
276
return S_ISREG(os.lstat(f)[ST_MODE])
281
"""True if f is a symlink."""
283
return S_ISLNK(os.lstat(f)[ST_MODE])
287
def is_inside(dir, fname):
288
"""True if fname is inside dir.
290
The parameters should typically be passed to osutils.normpath first, so
291
that . and .. and repeated slashes are eliminated, and the separators
292
are canonical for the platform.
294
The empty string as a dir name is taken as top-of-tree and matches
297
>>> is_inside('src', pathjoin('src', 'foo.c'))
299
>>> is_inside('src', 'srccontrol')
301
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
303
>>> is_inside('foo.c', 'foo.c')
305
>>> is_inside('foo.c', '')
307
>>> is_inside('', 'foo.c')
310
# XXX: Most callers of this can actually do something smarter by
311
# looking at the inventory
321
return fname.startswith(dir)
324
def is_inside_any(dir_list, fname):
325
"""True if fname is inside any of given dirs."""
326
for dirname in dir_list:
327
if is_inside(dirname, fname):
333
def pumpfile(fromfile, tofile):
334
"""Copy contents of one file to another."""
337
b = fromfile.read(BUFSIZE)
343
def file_iterator(input_file, readsize=32768):
345
b = input_file.read(readsize)
352
if hasattr(f, 'tell'):
365
def sha_strings(strings):
366
"""Return the sha-1 of concatenation of strings"""
368
map(s.update, strings)
378
def fingerprint_file(f):
383
return {'size': size,
384
'sha1': s.hexdigest()}
387
def compare_files(a, b):
388
"""Returns true if equal in contents"""
399
def local_time_offset(t=None):
400
"""Return offset of local zone from GMT, either at present or at time t."""
401
# python2.3 localtime() can't take None
405
if time.localtime(t).tm_isdst and time.daylight:
408
return -time.timezone
411
def format_date(t, offset=0, timezone='original', date_fmt=None,
413
## TODO: Perhaps a global option to use either universal or local time?
414
## Or perhaps just let people set $TZ?
415
assert isinstance(t, float)
417
if timezone == 'utc':
420
elif timezone == 'original':
423
tt = time.gmtime(t + offset)
424
elif timezone == 'local':
425
tt = time.localtime(t)
426
offset = local_time_offset(t)
428
raise BzrError("unsupported timezone format %r" % timezone,
429
['options are "utc", "original", "local"'])
431
date_fmt = "%a %Y-%m-%d %H:%M:%S"
433
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
436
return (time.strftime(date_fmt, tt) + offset_str)
439
def compact_date(when):
440
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
445
"""Return size of given open file."""
446
return os.fstat(f.fileno())[ST_SIZE]
449
# Define rand_bytes based on platform.
451
# Python 2.4 and later have os.urandom,
452
# but it doesn't work on some arches
454
rand_bytes = os.urandom
455
except (NotImplementedError, AttributeError):
456
# If python doesn't have os.urandom, or it doesn't work,
457
# then try to first pull random data from /dev/urandom
458
if os.path.exists("/dev/urandom"):
459
rand_bytes = file('/dev/urandom', 'rb').read
460
# Otherwise, use this hack as a last resort
462
# not well seeded, but better than nothing
467
s += chr(random.randint(0, 255))
472
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
474
"""Return a random string of num alphanumeric characters
476
The result only contains lowercase chars because it may be used on
477
case-insensitive filesystems.
480
for raw_byte in rand_bytes(num):
481
s += ALNUM[ord(raw_byte) % 36]
485
## TODO: We could later have path objects that remember their list
486
## decomposition (might be too tricksy though.)
489
"""Turn string into list of parts.
495
>>> splitpath('a/./b')
497
>>> splitpath('a/.b')
499
>>> splitpath('a/../b')
500
Traceback (most recent call last):
502
BzrError: sorry, '..' not allowed in path
504
assert isinstance(p, types.StringTypes)
506
# split on either delimiter because people might use either on
508
ps = re.split(r'[\\/]', p)
513
raise BzrError("sorry, %r not allowed in path" % f)
514
elif (f == '.') or (f == ''):
521
assert isinstance(p, list)
523
if (f == '..') or (f == None) or (f == ''):
524
raise BzrError("sorry, %r not allowed in path" % f)
528
def appendpath(p1, p2):
532
return pathjoin(p1, p2)
536
"""Split s into lines, but without removing the newline characters."""
537
lines = s.split('\n')
538
result = [line + '\n' for line in lines[:-1]]
540
result.append(lines[-1])
544
def hardlinks_good():
545
return sys.platform not in ('win32', 'cygwin', 'darwin')
548
def link_or_copy(src, dest):
549
"""Hardlink a file, or copy it if it can't be hardlinked."""
550
if not hardlinks_good():
555
except (OSError, IOError), e:
556
if e.errno != errno.EXDEV:
560
def delete_any(full_path):
561
"""Delete a file or directory."""
565
# We may be renaming a dangling inventory id
566
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
572
if hasattr(os, 'symlink'):
578
def contains_whitespace(s):
579
"""True if there are any whitespace characters in s."""
580
for ch in string.whitespace:
587
def contains_linebreaks(s):
588
"""True if there is any vertical whitespace in s."""
596
def relpath(base, path):
597
"""Return path relative to base, or raise exception.
599
The path may be either an absolute path or a path relative to the
600
current working directory.
602
os.path.commonprefix (python2.4) has a bad bug that it works just
603
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
607
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
608
' exceed the platform minimum length (which is %d)' %
614
while len(head) >= len(base):
617
head, tail = os.path.split(head)
621
# XXX This should raise a NotChildPath exception, as its not tied
623
raise PathNotChild(rp, base)
631
def safe_unicode(unicode_or_utf8_string):
632
"""Coerce unicode_or_utf8_string into unicode.
634
If it is unicode, it is returned.
635
Otherwise it is decoded from utf-8. If a decoding error
636
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
637
as a BzrBadParameter exception.
639
if isinstance(unicode_or_utf8_string, unicode):
640
return unicode_or_utf8_string
642
return unicode_or_utf8_string.decode('utf8')
643
except UnicodeDecodeError:
644
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
647
def terminal_width():
648
"""Return estimated terminal width."""
650
# TODO: Do something smart on Windows?
652
# TODO: Is there anything that gets a better update when the window
653
# is resized while the program is running? We could use the Python termcap
656
return int(os.environ['COLUMNS'])
657
except (IndexError, KeyError, ValueError):
660
def supports_executable():
661
return sys.platform != "win32"
664
def strip_trailing_slash(path):
665
"""Strip trailing slash, except for root paths.
666
The definition of 'root path' is platform-dependent.
668
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
674
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
677
def check_legal_path(path):
678
"""Check whether the supplied path is legal.
679
This is only required on Windows, so we don't test on other platforms
682
if sys.platform != "win32":
684
if _validWin32PathRE.match(path) is None:
685
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
