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
35
from bzrlib.errors import (BzrError,
36
BzrBadParameterNotUnicode,
41
from bzrlib.trace import mutter
42
import bzrlib.win32console
45
def make_readonly(filename):
46
"""Make a filename read-only."""
47
mod = os.stat(filename).st_mode
49
os.chmod(filename, mod)
52
def make_writable(filename):
53
mod = os.stat(filename).st_mode
55
os.chmod(filename, mod)
62
"""Return a quoted filename filename
64
This previously used backslash quoting, but that works poorly on
66
# TODO: I'm not really sure this is the best format either.x
69
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
71
if _QUOTE_RE.search(f):
78
mode = os.lstat(f)[ST_MODE]
97
def kind_marker(kind):
100
elif kind == 'directory':
102
elif kind == 'symlink':
105
raise BzrError('invalid file kind %r' % kind)
108
if hasattr(os.path, 'lexists'):
109
return os.path.lexists(f)
111
if hasattr(os, 'lstat'):
117
if e.errno == errno.ENOENT:
120
raise BzrError("lstat/stat of (%r): %r" % (f, e))
122
def fancy_rename(old, new, rename_func, unlink_func):
123
"""A fancy rename, when you don't have atomic rename.
125
:param old: The old path, to rename from
126
:param new: The new path, to rename to
127
:param rename_func: The potentially non-atomic rename function
128
:param unlink_func: A way to delete the target file if the full rename succeeds
131
# sftp rename doesn't allow overwriting, so play tricks:
133
base = os.path.basename(new)
134
dirname = os.path.dirname(new)
135
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
136
tmp_name = pathjoin(dirname, tmp_name)
138
# Rename the file out of the way, but keep track if it didn't exist
139
# We don't want to grab just any exception
140
# something like EACCES should prevent us from continuing
141
# The downside is that the rename_func has to throw an exception
142
# with an errno = ENOENT, or NoSuchFile
145
rename_func(new, tmp_name)
146
except (NoSuchFile,), e:
149
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
150
# function raises an IOError with errno == None when a rename fails.
151
# This then gets caught here.
152
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
155
if (not hasattr(e, 'errno')
156
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
163
# This may throw an exception, in which case success will
165
rename_func(old, new)
169
# If the file used to exist, rename it back into place
170
# otherwise just delete it from the tmp location
172
unlink_func(tmp_name)
174
rename_func(tmp_name, new)
176
# Default is to just use the python builtins, but these can be rebound on
177
# particular platforms.
178
abspath = os.path.abspath
179
realpath = os.path.realpath
180
pathjoin = os.path.join
181
normpath = os.path.normpath
183
mkdtemp = tempfile.mkdtemp
185
dirname = os.path.dirname
186
basename = os.path.basename
187
rmtree = shutil.rmtree
189
MIN_ABS_PATHLENGTH = 1
191
if os.name == "posix":
192
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
193
# choke on a Unicode string containing a relative path if
194
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
196
_fs_enc = sys.getfilesystemencoding()
198
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
201
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
203
if sys.platform == 'win32':
204
# We need to use the Unicode-aware os.path.abspath and
205
# os.path.realpath on Windows systems.
207
return os.path.abspath(path).replace('\\', '/')
210
return os.path.realpath(path).replace('\\', '/')
213
return os.path.join(*args).replace('\\', '/')
216
return os.path.normpath(path).replace('\\', '/')
219
return os.getcwdu().replace('\\', '/')
221
def mkdtemp(*args, **kwargs):
222
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
224
def rename(old, new):
225
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
227
MIN_ABS_PATHLENGTH = 3
229
def _win32_delete_readonly(function, path, excinfo):
230
"""Error handler for shutil.rmtree function [for win32]
231
Helps to remove files and dirs marked as read-only.
233
type_, value = excinfo[:2]
234
if function in (os.remove, os.rmdir) \
235
and type_ == OSError \
236
and value.errno == errno.EACCES:
237
bzrlib.osutils.make_writable(path)
242
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
243
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
244
return shutil.rmtree(path, ignore_errors, onerror)
247
def normalizepath(f):
248
if hasattr(os.path, 'realpath'):
252
[p,e] = os.path.split(f)
253
if e == "" or e == "." or e == "..":
256
return pathjoin(F(p), e)
260
"""Copy a file to a backup.
262
Backups are named in GNU-style, with a ~ suffix.
264
If the file is already a backup, it's not copied.
270
if has_symlinks() and os.path.islink(fn):
271
target = os.readlink(fn)
272
os.symlink(target, bfn)
280
outf = file(bfn, 'wb')
288
"""True if f is an accessible directory."""
290
return S_ISDIR(os.lstat(f)[ST_MODE])
296
"""True if f is a regular file."""
298
return S_ISREG(os.lstat(f)[ST_MODE])
303
"""True if f is a symlink."""
305
return S_ISLNK(os.lstat(f)[ST_MODE])
309
def is_inside(dir, fname):
310
"""True if fname is inside dir.
312
The parameters should typically be passed to osutils.normpath first, so
313
that . and .. and repeated slashes are eliminated, and the separators
314
are canonical for the platform.
316
The empty string as a dir name is taken as top-of-tree and matches
319
>>> is_inside('src', pathjoin('src', 'foo.c'))
321
>>> is_inside('src', 'srccontrol')
323
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
325
>>> is_inside('foo.c', 'foo.c')
327
>>> is_inside('foo.c', '')
329
>>> is_inside('', 'foo.c')
332
# XXX: Most callers of this can actually do something smarter by
333
# looking at the inventory
343
return fname.startswith(dir)
346
def is_inside_any(dir_list, fname):
347
"""True if fname is inside any of given dirs."""
348
for dirname in dir_list:
349
if is_inside(dirname, fname):
355
def pumpfile(fromfile, tofile):
356
"""Copy contents of one file to another."""
359
b = fromfile.read(BUFSIZE)
365
def file_iterator(input_file, readsize=32768):
367
b = input_file.read(readsize)
374
if hasattr(f, 'tell'):
387
def sha_strings(strings):
388
"""Return the sha-1 of concatenation of strings"""
390
map(s.update, strings)
400
def fingerprint_file(f):
405
return {'size': size,
406
'sha1': s.hexdigest()}
409
def compare_files(a, b):
410
"""Returns true if equal in contents"""
421
def local_time_offset(t=None):
422
"""Return offset of local zone from GMT, either at present or at time t."""
423
# python2.3 localtime() can't take None
427
if time.localtime(t).tm_isdst and time.daylight:
430
return -time.timezone
433
def format_date(t, offset=0, timezone='original', date_fmt=None,
435
## TODO: Perhaps a global option to use either universal or local time?
436
## Or perhaps just let people set $TZ?
437
assert isinstance(t, float)
439
if timezone == 'utc':
442
elif timezone == 'original':
445
tt = time.gmtime(t + offset)
446
elif timezone == 'local':
447
tt = time.localtime(t)
448
offset = local_time_offset(t)
450
raise BzrError("unsupported timezone format %r" % timezone,
451
['options are "utc", "original", "local"'])
453
date_fmt = "%a %Y-%m-%d %H:%M:%S"
455
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
458
return (time.strftime(date_fmt, tt) + offset_str)
461
def compact_date(when):
462
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
467
"""Return size of given open file."""
468
return os.fstat(f.fileno())[ST_SIZE]
471
# Define rand_bytes based on platform.
473
# Python 2.4 and later have os.urandom,
474
# but it doesn't work on some arches
476
rand_bytes = os.urandom
477
except (NotImplementedError, AttributeError):
478
# If python doesn't have os.urandom, or it doesn't work,
479
# then try to first pull random data from /dev/urandom
480
if os.path.exists("/dev/urandom"):
481
rand_bytes = file('/dev/urandom', 'rb').read
482
# Otherwise, use this hack as a last resort
484
# not well seeded, but better than nothing
489
s += chr(random.randint(0, 255))
494
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
496
"""Return a random string of num alphanumeric characters
498
The result only contains lowercase chars because it may be used on
499
case-insensitive filesystems.
502
for raw_byte in rand_bytes(num):
503
s += ALNUM[ord(raw_byte) % 36]
507
## TODO: We could later have path objects that remember their list
508
## decomposition (might be too tricksy though.)
511
"""Turn string into list of parts.
517
>>> splitpath('a/./b')
519
>>> splitpath('a/.b')
521
>>> splitpath('a/../b')
522
Traceback (most recent call last):
524
BzrError: sorry, '..' not allowed in path
526
assert isinstance(p, types.StringTypes)
528
# split on either delimiter because people might use either on
530
ps = re.split(r'[\\/]', p)
535
raise BzrError("sorry, %r not allowed in path" % f)
536
elif (f == '.') or (f == ''):
543
assert isinstance(p, list)
545
if (f == '..') or (f == None) or (f == ''):
546
raise BzrError("sorry, %r not allowed in path" % f)
550
def appendpath(p1, p2):
554
return pathjoin(p1, p2)
558
"""Split s into lines, but without removing the newline characters."""
559
lines = s.split('\n')
560
result = [line + '\n' for line in lines[:-1]]
562
result.append(lines[-1])
566
def hardlinks_good():
567
return sys.platform not in ('win32', 'cygwin', 'darwin')
570
def link_or_copy(src, dest):
571
"""Hardlink a file, or copy it if it can't be hardlinked."""
572
if not hardlinks_good():
577
except (OSError, IOError), e:
578
if e.errno != errno.EXDEV:
582
def delete_any(full_path):
583
"""Delete a file or directory."""
587
# We may be renaming a dangling inventory id
588
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
594
if hasattr(os, 'symlink'):
600
def contains_whitespace(s):
601
"""True if there are any whitespace characters in s."""
602
for ch in string.whitespace:
609
def contains_linebreaks(s):
610
"""True if there is any vertical whitespace in s."""
618
def relpath(base, path):
619
"""Return path relative to base, or raise exception.
621
The path may be either an absolute path or a path relative to the
622
current working directory.
624
os.path.commonprefix (python2.4) has a bad bug that it works just
625
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
629
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
630
' exceed the platform minimum length (which is %d)' %
636
while len(head) >= len(base):
639
head, tail = os.path.split(head)
643
# XXX This should raise a NotChildPath exception, as its not tied
645
raise PathNotChild(rp, base)
653
def safe_unicode(unicode_or_utf8_string):
654
"""Coerce unicode_or_utf8_string into unicode.
656
If it is unicode, it is returned.
657
Otherwise it is decoded from utf-8. If a decoding error
658
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
659
as a BzrBadParameter exception.
661
if isinstance(unicode_or_utf8_string, unicode):
662
return unicode_or_utf8_string
664
return unicode_or_utf8_string.decode('utf8')
665
except UnicodeDecodeError:
666
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
669
def terminal_width():
670
"""Return estimated terminal width."""
671
if sys.platform == 'win32':
672
import bzrlib.win32console
673
return bzrlib.win32console.get_console_size()[0]
676
import struct, fcntl, termios
677
s = struct.pack('HHHH', 0, 0, 0, 0)
678
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
679
width = struct.unpack('HHHH', x)[1]
684
width = int(os.environ['COLUMNS'])
692
def supports_executable():
693
return sys.platform != "win32"
696
def strip_trailing_slash(path):
697
"""Strip trailing slash, except for root paths.
698
The definition of 'root path' is platform-dependent.
700
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
706
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
709
def check_legal_path(path):
710
"""Check whether the supplied path is legal.
711
This is only required on Windows, so we don't test on other platforms
714
if sys.platform != "win32":
716
if _validWin32PathRE.match(path) is None:
717
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
