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.symbol_versioning import *
42
from bzrlib.trace import mutter
43
import bzrlib.win32console
46
def make_readonly(filename):
47
"""Make a filename read-only."""
48
mod = os.stat(filename).st_mode
50
os.chmod(filename, mod)
53
def make_writable(filename):
54
mod = os.stat(filename).st_mode
56
os.chmod(filename, mod)
63
"""Return a quoted filename filename
65
This previously used backslash quoting, but that works poorly on
67
# TODO: I'm not really sure this is the best format either.x
70
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
72
if _QUOTE_RE.search(f):
79
mode = os.lstat(f)[ST_MODE]
98
def kind_marker(kind):
101
elif kind == 'directory':
103
elif kind == 'symlink':
106
raise BzrError('invalid file kind %r' % kind)
109
if hasattr(os.path, 'lexists'):
110
return os.path.lexists(f)
112
if hasattr(os, 'lstat'):
118
if e.errno == errno.ENOENT:
121
raise BzrError("lstat/stat of (%r): %r" % (f, e))
123
def fancy_rename(old, new, rename_func, unlink_func):
124
"""A fancy rename, when you don't have atomic rename.
126
:param old: The old path, to rename from
127
:param new: The new path, to rename to
128
:param rename_func: The potentially non-atomic rename function
129
:param unlink_func: A way to delete the target file if the full rename succeeds
132
# sftp rename doesn't allow overwriting, so play tricks:
134
base = os.path.basename(new)
135
dirname = os.path.dirname(new)
136
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
137
tmp_name = pathjoin(dirname, tmp_name)
139
# Rename the file out of the way, but keep track if it didn't exist
140
# We don't want to grab just any exception
141
# something like EACCES should prevent us from continuing
142
# The downside is that the rename_func has to throw an exception
143
# with an errno = ENOENT, or NoSuchFile
146
rename_func(new, tmp_name)
147
except (NoSuchFile,), e:
150
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
151
# function raises an IOError with errno == None when a rename fails.
152
# This then gets caught here.
153
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
156
if (not hasattr(e, 'errno')
157
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
164
# This may throw an exception, in which case success will
166
rename_func(old, new)
170
# If the file used to exist, rename it back into place
171
# otherwise just delete it from the tmp location
173
unlink_func(tmp_name)
175
rename_func(tmp_name, new)
177
# Default is to just use the python builtins, but these can be rebound on
178
# particular platforms.
179
abspath = os.path.abspath
180
realpath = os.path.realpath
181
pathjoin = os.path.join
182
normpath = os.path.normpath
184
mkdtemp = tempfile.mkdtemp
186
dirname = os.path.dirname
187
basename = os.path.basename
188
rmtree = shutil.rmtree
190
MIN_ABS_PATHLENGTH = 1
192
if os.name == "posix":
193
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
194
# choke on a Unicode string containing a relative path if
195
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
197
_fs_enc = sys.getfilesystemencoding()
199
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
202
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
204
if sys.platform == 'win32':
205
# We need to use the Unicode-aware os.path.abspath and
206
# os.path.realpath on Windows systems.
208
return os.path.abspath(path).replace('\\', '/')
211
return os.path.realpath(path).replace('\\', '/')
214
return os.path.join(*args).replace('\\', '/')
217
return os.path.normpath(path).replace('\\', '/')
220
return os.getcwdu().replace('\\', '/')
222
def mkdtemp(*args, **kwargs):
223
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
225
def rename(old, new):
226
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
228
MIN_ABS_PATHLENGTH = 3
230
def _win32_delete_readonly(function, path, excinfo):
231
"""Error handler for shutil.rmtree function [for win32]
232
Helps to remove files and dirs marked as read-only.
234
type_, value = excinfo[:2]
235
if function in (os.remove, os.rmdir) \
236
and type_ == OSError \
237
and value.errno == errno.EACCES:
238
bzrlib.osutils.make_writable(path)
243
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
244
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
245
return shutil.rmtree(path, ignore_errors, onerror)
248
def normalizepath(f):
249
if hasattr(os.path, 'realpath'):
253
[p,e] = os.path.split(f)
254
if e == "" or e == "." or e == "..":
257
return pathjoin(F(p), e)
261
"""Copy a file to a backup.
263
Backups are named in GNU-style, with a ~ suffix.
265
If the file is already a backup, it's not copied.
271
if has_symlinks() and os.path.islink(fn):
272
target = os.readlink(fn)
273
os.symlink(target, bfn)
281
outf = file(bfn, 'wb')
289
"""True if f is an accessible directory."""
291
return S_ISDIR(os.lstat(f)[ST_MODE])
297
"""True if f is a regular file."""
299
return S_ISREG(os.lstat(f)[ST_MODE])
304
"""True if f is a symlink."""
306
return S_ISLNK(os.lstat(f)[ST_MODE])
310
def is_inside(dir, fname):
311
"""True if fname is inside dir.
313
The parameters should typically be passed to osutils.normpath first, so
314
that . and .. and repeated slashes are eliminated, and the separators
315
are canonical for the platform.
317
The empty string as a dir name is taken as top-of-tree and matches
320
>>> is_inside('src', pathjoin('src', 'foo.c'))
322
>>> is_inside('src', 'srccontrol')
324
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
326
>>> is_inside('foo.c', 'foo.c')
328
>>> is_inside('foo.c', '')
330
>>> is_inside('', 'foo.c')
333
# XXX: Most callers of this can actually do something smarter by
334
# looking at the inventory
344
return fname.startswith(dir)
347
def is_inside_any(dir_list, fname):
348
"""True if fname is inside any of given dirs."""
349
for dirname in dir_list:
350
if is_inside(dirname, fname):
356
def pumpfile(fromfile, tofile):
357
"""Copy contents of one file to another."""
360
b = fromfile.read(BUFSIZE)
366
def file_iterator(input_file, readsize=32768):
368
b = input_file.read(readsize)
375
if hasattr(f, 'tell'):
388
def sha_strings(strings):
389
"""Return the sha-1 of concatenation of strings"""
391
map(s.update, strings)
401
def fingerprint_file(f):
406
return {'size': size,
407
'sha1': s.hexdigest()}
410
def compare_files(a, b):
411
"""Returns true if equal in contents"""
422
def local_time_offset(t=None):
423
"""Return offset of local zone from GMT, either at present or at time t."""
424
# python2.3 localtime() can't take None
428
if time.localtime(t).tm_isdst and time.daylight:
431
return -time.timezone
434
def format_date(t, offset=0, timezone='original', date_fmt=None,
436
## TODO: Perhaps a global option to use either universal or local time?
437
## Or perhaps just let people set $TZ?
438
assert isinstance(t, float)
440
if timezone == 'utc':
443
elif timezone == 'original':
446
tt = time.gmtime(t + offset)
447
elif timezone == 'local':
448
tt = time.localtime(t)
449
offset = local_time_offset(t)
451
raise BzrError("unsupported timezone format %r" % timezone,
452
['options are "utc", "original", "local"'])
454
date_fmt = "%a %Y-%m-%d %H:%M:%S"
456
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
459
return (time.strftime(date_fmt, tt) + offset_str)
462
def compact_date(when):
463
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
468
"""Return size of given open file."""
469
return os.fstat(f.fileno())[ST_SIZE]
472
# Define rand_bytes based on platform.
474
# Python 2.4 and later have os.urandom,
475
# but it doesn't work on some arches
477
rand_bytes = os.urandom
478
except (NotImplementedError, AttributeError):
479
# If python doesn't have os.urandom, or it doesn't work,
480
# then try to first pull random data from /dev/urandom
481
if os.path.exists("/dev/urandom"):
482
rand_bytes = file('/dev/urandom', 'rb').read
483
# Otherwise, use this hack as a last resort
485
# not well seeded, but better than nothing
490
s += chr(random.randint(0, 255))
495
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
497
"""Return a random string of num alphanumeric characters
499
The result only contains lowercase chars because it may be used on
500
case-insensitive filesystems.
503
for raw_byte in rand_bytes(num):
504
s += ALNUM[ord(raw_byte) % 36]
508
## TODO: We could later have path objects that remember their list
509
## decomposition (might be too tricksy though.)
512
"""Turn string into list of parts.
518
>>> splitpath('a/./b')
520
>>> splitpath('a/.b')
522
>>> splitpath('a/../b')
523
Traceback (most recent call last):
525
BzrError: sorry, '..' not allowed in path
527
assert isinstance(p, types.StringTypes)
529
# split on either delimiter because people might use either on
531
ps = re.split(r'[\\/]', p)
536
raise BzrError("sorry, %r not allowed in path" % f)
537
elif (f == '.') or (f == ''):
544
assert isinstance(p, list)
546
if (f == '..') or (f == None) or (f == ''):
547
raise BzrError("sorry, %r not allowed in path" % f)
551
@deprecated_function(zero_nine)
552
def appendpath(p1, p2):
556
return pathjoin(p1, p2)
560
"""Split s into lines, but without removing the newline characters."""
561
lines = s.split('\n')
562
result = [line + '\n' for line in lines[:-1]]
564
result.append(lines[-1])
568
def hardlinks_good():
569
return sys.platform not in ('win32', 'cygwin', 'darwin')
572
def link_or_copy(src, dest):
573
"""Hardlink a file, or copy it if it can't be hardlinked."""
574
if not hardlinks_good():
579
except (OSError, IOError), e:
580
if e.errno != errno.EXDEV:
584
def delete_any(full_path):
585
"""Delete a file or directory."""
589
# We may be renaming a dangling inventory id
590
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
596
if hasattr(os, 'symlink'):
602
def contains_whitespace(s):
603
"""True if there are any whitespace characters in s."""
604
for ch in string.whitespace:
611
def contains_linebreaks(s):
612
"""True if there is any vertical whitespace in s."""
620
def relpath(base, path):
621
"""Return path relative to base, or raise exception.
623
The path may be either an absolute path or a path relative to the
624
current working directory.
626
os.path.commonprefix (python2.4) has a bad bug that it works just
627
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
631
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
632
' exceed the platform minimum length (which is %d)' %
638
while len(head) >= len(base):
641
head, tail = os.path.split(head)
645
# XXX This should raise a NotChildPath exception, as its not tied
647
raise PathNotChild(rp, base)
655
def safe_unicode(unicode_or_utf8_string):
656
"""Coerce unicode_or_utf8_string into unicode.
658
If it is unicode, it is returned.
659
Otherwise it is decoded from utf-8. If a decoding error
660
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
661
as a BzrBadParameter exception.
663
if isinstance(unicode_or_utf8_string, unicode):
664
return unicode_or_utf8_string
666
return unicode_or_utf8_string.decode('utf8')
667
except UnicodeDecodeError:
668
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
671
def terminal_width():
672
"""Return estimated terminal width."""
673
if sys.platform == 'win32':
674
import bzrlib.win32console
675
return bzrlib.win32console.get_console_size()[0]
678
import struct, fcntl, termios
679
s = struct.pack('HHHH', 0, 0, 0, 0)
680
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
681
width = struct.unpack('HHHH', x)[1]
686
width = int(os.environ['COLUMNS'])
694
def supports_executable():
695
return sys.platform != "win32"
698
def strip_trailing_slash(path):
699
"""Strip trailing slash, except for root paths.
700
The definition of 'root path' is platform-dependent.
702
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
708
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
711
def check_legal_path(path):
712
"""Check whether the supplied path is legal.
713
This is only required on Windows, so we don't test on other platforms
716
if sys.platform != "win32":
718
if _validWin32PathRE.match(path) is None:
719
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
