1
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from cStringIO import StringIO
21
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
22
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
26
from bzrlib.lazy_import import lazy_import
27
lazy_import(globals(), """
29
from datetime import datetime
31
from ntpath import (abspath as _nt_abspath,
33
normpath as _nt_normpath,
34
realpath as _nt_realpath,
35
splitdrive as _nt_splitdrive,
44
from tempfile import (
57
from bzrlib import symbol_versioning
58
from bzrlib.symbol_versioning import (
62
from bzrlib.trace import mutter
65
# On win32, O_BINARY is used to indicate the file should
66
# be opened in binary mode, rather than text mode.
67
# On other platforms, O_BINARY doesn't exist, because
68
# they always open in binary mode, so it is okay to
69
# OR with 0 on those platforms
70
O_BINARY = getattr(os, 'O_BINARY', 0)
73
def make_readonly(filename):
74
"""Make a filename read-only."""
75
mod = os.stat(filename).st_mode
77
os.chmod(filename, mod)
80
def make_writable(filename):
81
mod = os.stat(filename).st_mode
83
os.chmod(filename, mod)
90
"""Return a quoted filename filename
92
This previously used backslash quoting, but that works poorly on
94
# TODO: I'm not really sure this is the best format either.x
97
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
99
if _QUOTE_RE.search(f):
105
_directory_kind = 'directory'
108
stat.S_IFDIR:_directory_kind,
109
stat.S_IFCHR:'chardev',
110
stat.S_IFBLK:'block',
113
stat.S_IFLNK:'symlink',
114
stat.S_IFSOCK:'socket',
118
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
119
"""Generate a file kind from a stat mode. This is used in walkdirs.
121
Its performance is critical: Do not mutate without careful benchmarking.
124
return _formats[stat_mode & 0170000]
129
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
131
return _mapper(_lstat(f).st_mode)
133
if getattr(e, 'errno', None) == errno.ENOENT:
134
raise errors.NoSuchFile(f)
139
"""Return the current umask"""
140
# Assume that people aren't messing with the umask while running
141
# XXX: This is not thread safe, but there is no way to get the
142
# umask without setting it
150
_directory_kind: "/",
152
'tree-reference': '+',
156
def kind_marker(kind):
158
return _kind_marker_map[kind]
160
raise errors.BzrError('invalid file kind %r' % kind)
163
lexists = getattr(os.path, 'lexists', None)
167
stat = getattr(os, 'lstat', os.stat)
171
if e.errno == errno.ENOENT:
174
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
177
def fancy_rename(old, new, rename_func, unlink_func):
178
"""A fancy rename, when you don't have atomic rename.
180
:param old: The old path, to rename from
181
:param new: The new path, to rename to
182
:param rename_func: The potentially non-atomic rename function
183
:param unlink_func: A way to delete the target file if the full rename succeeds
186
# sftp rename doesn't allow overwriting, so play tricks:
188
base = os.path.basename(new)
189
dirname = os.path.dirname(new)
190
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
191
tmp_name = pathjoin(dirname, tmp_name)
193
# Rename the file out of the way, but keep track if it didn't exist
194
# We don't want to grab just any exception
195
# something like EACCES should prevent us from continuing
196
# The downside is that the rename_func has to throw an exception
197
# with an errno = ENOENT, or NoSuchFile
200
rename_func(new, tmp_name)
201
except (errors.NoSuchFile,), e:
204
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
205
# function raises an IOError with errno is None when a rename fails.
206
# This then gets caught here.
207
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
210
if (getattr(e, 'errno', None) is None
211
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
218
# This may throw an exception, in which case success will
220
rename_func(old, new)
224
# If the file used to exist, rename it back into place
225
# otherwise just delete it from the tmp location
227
unlink_func(tmp_name)
229
rename_func(tmp_name, new)
232
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
233
# choke on a Unicode string containing a relative path if
234
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
236
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
237
def _posix_abspath(path):
238
# jam 20060426 rather than encoding to fsencoding
239
# copy posixpath.abspath, but use os.getcwdu instead
240
if not posixpath.isabs(path):
241
path = posixpath.join(getcwd(), path)
242
return posixpath.normpath(path)
245
def _posix_realpath(path):
246
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
249
def _win32_fixdrive(path):
250
"""Force drive letters to be consistent.
252
win32 is inconsistent whether it returns lower or upper case
253
and even if it was consistent the user might type the other
254
so we force it to uppercase
255
running python.exe under cmd.exe return capital C:\\
256
running win32 python inside a cygwin shell returns lowercase c:\\
258
drive, path = _nt_splitdrive(path)
259
return drive.upper() + path
262
def _win32_abspath(path):
263
# Real _nt_abspath doesn't have a problem with a unicode cwd
264
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
267
def _win98_abspath(path):
268
"""Return the absolute version of a path.
269
Windows 98 safe implementation (python reimplementation
270
of Win32 API function GetFullPathNameW)
275
# \\HOST\path => //HOST/path
276
# //HOST/path => //HOST/path
277
# path => C:/cwd/path
280
# check for absolute path
281
drive = _nt_splitdrive(path)[0]
282
if drive == '' and path[:2] not in('//','\\\\'):
284
# we cannot simply os.path.join cwd and path
285
# because os.path.join('C:','/path') produce '/path'
286
# and this is incorrect
287
if path[:1] in ('/','\\'):
288
cwd = _nt_splitdrive(cwd)[0]
290
path = cwd + '\\' + path
291
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
293
if win32utils.winver == 'Windows 98':
294
_win32_abspath = _win98_abspath
297
def _win32_realpath(path):
298
# Real _nt_realpath doesn't have a problem with a unicode cwd
299
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
302
def _win32_pathjoin(*args):
303
return _nt_join(*args).replace('\\', '/')
306
def _win32_normpath(path):
307
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
311
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
314
def _win32_mkdtemp(*args, **kwargs):
315
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
318
def _win32_rename(old, new):
319
"""We expect to be able to atomically replace 'new' with old.
321
On win32, if new exists, it must be moved out of the way first,
325
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
327
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
328
# If we try to rename a non-existant file onto cwd, we get
329
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
330
# if the old path doesn't exist, sometimes we get EACCES
331
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
337
return unicodedata.normalize('NFKC', os.getcwdu())
340
# Default is to just use the python builtins, but these can be rebound on
341
# particular platforms.
342
abspath = _posix_abspath
343
realpath = _posix_realpath
344
pathjoin = os.path.join
345
normpath = os.path.normpath
348
dirname = os.path.dirname
349
basename = os.path.basename
350
split = os.path.split
351
splitext = os.path.splitext
352
# These were already imported into local scope
353
# mkdtemp = tempfile.mkdtemp
354
# rmtree = shutil.rmtree
356
MIN_ABS_PATHLENGTH = 1
359
if sys.platform == 'win32':
360
abspath = _win32_abspath
361
realpath = _win32_realpath
362
pathjoin = _win32_pathjoin
363
normpath = _win32_normpath
364
getcwd = _win32_getcwd
365
mkdtemp = _win32_mkdtemp
366
rename = _win32_rename
368
MIN_ABS_PATHLENGTH = 3
370
def _win32_delete_readonly(function, path, excinfo):
371
"""Error handler for shutil.rmtree function [for win32]
372
Helps to remove files and dirs marked as read-only.
374
exception = excinfo[1]
375
if function in (os.remove, os.rmdir) \
376
and isinstance(exception, OSError) \
377
and exception.errno == errno.EACCES:
383
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
384
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
385
return shutil.rmtree(path, ignore_errors, onerror)
386
elif sys.platform == 'darwin':
390
def get_terminal_encoding():
391
"""Find the best encoding for printing to the screen.
393
This attempts to check both sys.stdout and sys.stdin to see
394
what encoding they are in, and if that fails it falls back to
395
bzrlib.user_encoding.
396
The problem is that on Windows, locale.getpreferredencoding()
397
is not the same encoding as that used by the console:
398
http://mail.python.org/pipermail/python-list/2003-May/162357.html
400
On my standard US Windows XP, the preferred encoding is
401
cp1252, but the console is cp437
403
output_encoding = getattr(sys.stdout, 'encoding', None)
404
if not output_encoding:
405
input_encoding = getattr(sys.stdin, 'encoding', None)
406
if not input_encoding:
407
output_encoding = bzrlib.user_encoding
408
mutter('encoding stdout as bzrlib.user_encoding %r', output_encoding)
410
output_encoding = input_encoding
411
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
413
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
414
if output_encoding == 'cp0':
415
# invalid encoding (cp0 means 'no codepage' on Windows)
416
output_encoding = bzrlib.user_encoding
417
mutter('cp0 is invalid encoding.'
418
' encoding stdout as bzrlib.user_encoding %r', output_encoding)
421
codecs.lookup(output_encoding)
423
sys.stderr.write('bzr: warning:'
424
' unknown terminal encoding %s.\n'
425
' Using encoding %s instead.\n'
426
% (output_encoding, bzrlib.user_encoding)
428
output_encoding = bzrlib.user_encoding
430
return output_encoding
433
def normalizepath(f):
434
if getattr(os.path, 'realpath', None) is not None:
438
[p,e] = os.path.split(f)
439
if e == "" or e == "." or e == "..":
442
return pathjoin(F(p), e)
446
"""Copy a file to a backup.
448
Backups are named in GNU-style, with a ~ suffix.
450
If the file is already a backup, it's not copied.
456
if has_symlinks() and os.path.islink(fn):
457
target = os.readlink(fn)
458
os.symlink(target, bfn)
466
outf = file(bfn, 'wb')
474
"""True if f is an accessible directory."""
476
return S_ISDIR(os.lstat(f)[ST_MODE])
482
"""True if f is a regular file."""
484
return S_ISREG(os.lstat(f)[ST_MODE])
489
"""True if f is a symlink."""
491
return S_ISLNK(os.lstat(f)[ST_MODE])
495
def is_inside(dir, fname):
496
"""True if fname is inside dir.
498
The parameters should typically be passed to osutils.normpath first, so
499
that . and .. and repeated slashes are eliminated, and the separators
500
are canonical for the platform.
502
The empty string as a dir name is taken as top-of-tree and matches
505
# XXX: Most callers of this can actually do something smarter by
506
# looking at the inventory
516
return fname.startswith(dir)
519
def is_inside_any(dir_list, fname):
520
"""True if fname is inside any of given dirs."""
521
for dirname in dir_list:
522
if is_inside(dirname, fname):
527
def is_inside_or_parent_of_any(dir_list, fname):
528
"""True if fname is a child or a parent of any of the given files."""
529
for dirname in dir_list:
530
if is_inside(dirname, fname) or is_inside(fname, dirname):
535
def pumpfile(fromfile, tofile):
536
"""Copy contents of one file to another."""
539
b = fromfile.read(BUFSIZE)
545
def file_iterator(input_file, readsize=32768):
547
b = input_file.read(readsize)
554
if getattr(f, 'tell', None) is not None:
567
def sha_strings(strings):
568
"""Return the sha-1 of concatenation of strings"""
570
map(s.update, strings)
580
def fingerprint_file(f):
585
return {'size': size,
586
'sha1': s.hexdigest()}
589
def compare_files(a, b):
590
"""Returns true if equal in contents"""
601
def local_time_offset(t=None):
602
"""Return offset of local zone from GMT, either at present or at time t."""
605
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
606
return offset.days * 86400 + offset.seconds
609
def format_date(t, offset=0, timezone='original', date_fmt=None,
611
## TODO: Perhaps a global option to use either universal or local time?
612
## Or perhaps just let people set $TZ?
613
assert isinstance(t, float)
615
if timezone == 'utc':
618
elif timezone == 'original':
621
tt = time.gmtime(t + offset)
622
elif timezone == 'local':
623
tt = time.localtime(t)
624
offset = local_time_offset(t)
626
raise errors.BzrError("unsupported timezone format %r" % timezone,
627
['options are "utc", "original", "local"'])
629
date_fmt = "%a %Y-%m-%d %H:%M:%S"
631
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
634
return (time.strftime(date_fmt, tt) + offset_str)
637
def compact_date(when):
638
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
641
def format_delta(delta):
642
"""Get a nice looking string for a time delta.
644
:param delta: The time difference in seconds, can be positive or negative.
645
positive indicates time in the past, negative indicates time in the
646
future. (usually time.time() - stored_time)
647
:return: String formatted to show approximate resolution
653
direction = 'in the future'
657
if seconds < 90: # print seconds up to 90 seconds
659
return '%d second %s' % (seconds, direction,)
661
return '%d seconds %s' % (seconds, direction)
663
minutes = int(seconds / 60)
664
seconds -= 60 * minutes
669
if minutes < 90: # print minutes, seconds up to 90 minutes
671
return '%d minute, %d second%s %s' % (
672
minutes, seconds, plural_seconds, direction)
674
return '%d minutes, %d second%s %s' % (
675
minutes, seconds, plural_seconds, direction)
677
hours = int(minutes / 60)
678
minutes -= 60 * hours
685
return '%d hour, %d minute%s %s' % (hours, minutes,
686
plural_minutes, direction)
687
return '%d hours, %d minute%s %s' % (hours, minutes,
688
plural_minutes, direction)
691
"""Return size of given open file."""
692
return os.fstat(f.fileno())[ST_SIZE]
695
# Define rand_bytes based on platform.
697
# Python 2.4 and later have os.urandom,
698
# but it doesn't work on some arches
700
rand_bytes = os.urandom
701
except (NotImplementedError, AttributeError):
702
# If python doesn't have os.urandom, or it doesn't work,
703
# then try to first pull random data from /dev/urandom
705
rand_bytes = file('/dev/urandom', 'rb').read
706
# Otherwise, use this hack as a last resort
707
except (IOError, OSError):
708
# not well seeded, but better than nothing
713
s += chr(random.randint(0, 255))
718
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
720
"""Return a random string of num alphanumeric characters
722
The result only contains lowercase chars because it may be used on
723
case-insensitive filesystems.
726
for raw_byte in rand_bytes(num):
727
s += ALNUM[ord(raw_byte) % 36]
731
## TODO: We could later have path objects that remember their list
732
## decomposition (might be too tricksy though.)
735
"""Turn string into list of parts."""
736
assert isinstance(p, basestring)
738
# split on either delimiter because people might use either on
740
ps = re.split(r'[\\/]', p)
745
raise errors.BzrError("sorry, %r not allowed in path" % f)
746
elif (f == '.') or (f == ''):
753
assert isinstance(p, (list, tuple))
755
if (f == '..') or (f is None) or (f == ''):
756
raise errors.BzrError("sorry, %r not allowed in path" % f)
760
@deprecated_function(zero_nine)
761
def appendpath(p1, p2):
765
return pathjoin(p1, p2)
769
"""Split s into lines, but without removing the newline characters."""
770
lines = s.split('\n')
771
result = [line + '\n' for line in lines[:-1]]
773
result.append(lines[-1])
777
def hardlinks_good():
778
return sys.platform not in ('win32', 'cygwin', 'darwin')
781
def link_or_copy(src, dest):
782
"""Hardlink a file, or copy it if it can't be hardlinked."""
783
if not hardlinks_good():
784
shutil.copyfile(src, dest)
788
except (OSError, IOError), e:
789
if e.errno != errno.EXDEV:
791
shutil.copyfile(src, dest)
793
def delete_any(full_path):
794
"""Delete a file or directory."""
798
# We may be renaming a dangling inventory id
799
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
805
if getattr(os, 'symlink', None) is not None:
811
def contains_whitespace(s):
812
"""True if there are any whitespace characters in s."""
813
# string.whitespace can include '\xa0' in certain locales, because it is
814
# considered "non-breaking-space" as part of ISO-8859-1. But it
815
# 1) Isn't a breaking whitespace
816
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
818
# 3) '\xa0' isn't unicode safe since it is >128.
820
# This should *not* be a unicode set of characters in case the source
821
# string is not a Unicode string. We can auto-up-cast the characters since
822
# they are ascii, but we don't want to auto-up-cast the string in case it
824
for ch in ' \t\n\r\v\f':
831
def contains_linebreaks(s):
832
"""True if there is any vertical whitespace in s."""
840
def relpath(base, path):
841
"""Return path relative to base, or raise exception.
843
The path may be either an absolute path or a path relative to the
844
current working directory.
846
os.path.commonprefix (python2.4) has a bad bug that it works just
847
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
851
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
852
' exceed the platform minimum length (which is %d)' %
859
while len(head) >= len(base):
862
head, tail = os.path.split(head)
866
raise errors.PathNotChild(rp, base)
874
def safe_unicode(unicode_or_utf8_string):
875
"""Coerce unicode_or_utf8_string into unicode.
877
If it is unicode, it is returned.
878
Otherwise it is decoded from utf-8. If a decoding error
879
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
880
as a BzrBadParameter exception.
882
if isinstance(unicode_or_utf8_string, unicode):
883
return unicode_or_utf8_string
885
return unicode_or_utf8_string.decode('utf8')
886
except UnicodeDecodeError:
887
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
890
def safe_utf8(unicode_or_utf8_string):
891
"""Coerce unicode_or_utf8_string to a utf8 string.
893
If it is a str, it is returned.
894
If it is Unicode, it is encoded into a utf-8 string.
896
if isinstance(unicode_or_utf8_string, str):
897
# TODO: jam 20070209 This is overkill, and probably has an impact on
898
# performance if we are dealing with lots of apis that want a
901
# Make sure it is a valid utf-8 string
902
unicode_or_utf8_string.decode('utf-8')
903
except UnicodeDecodeError:
904
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
905
return unicode_or_utf8_string
906
return unicode_or_utf8_string.encode('utf-8')
909
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
910
' Revision id generators should be creating utf8'
914
def safe_revision_id(unicode_or_utf8_string, warn=True):
915
"""Revision ids should now be utf8, but at one point they were unicode.
917
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
919
:param warn: Functions that are sanitizing user data can set warn=False
920
:return: None or a utf8 revision id.
922
if (unicode_or_utf8_string is None
923
or unicode_or_utf8_string.__class__ == str):
924
return unicode_or_utf8_string
926
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
928
return cache_utf8.encode(unicode_or_utf8_string)
931
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
932
' generators should be creating utf8 file ids.')
935
def safe_file_id(unicode_or_utf8_string, warn=True):
936
"""File ids should now be utf8, but at one point they were unicode.
938
This is the same as safe_utf8, except it uses the cached encode functions
939
to save a little bit of performance.
941
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
943
:param warn: Functions that are sanitizing user data can set warn=False
944
:return: None or a utf8 file id.
946
if (unicode_or_utf8_string is None
947
or unicode_or_utf8_string.__class__ == str):
948
return unicode_or_utf8_string
950
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
952
return cache_utf8.encode(unicode_or_utf8_string)
955
_platform_normalizes_filenames = False
956
if sys.platform == 'darwin':
957
_platform_normalizes_filenames = True
960
def normalizes_filenames():
961
"""Return True if this platform normalizes unicode filenames.
963
Mac OSX does, Windows/Linux do not.
965
return _platform_normalizes_filenames
968
def _accessible_normalized_filename(path):
969
"""Get the unicode normalized path, and if you can access the file.
971
On platforms where the system normalizes filenames (Mac OSX),
972
you can access a file by any path which will normalize correctly.
973
On platforms where the system does not normalize filenames
974
(Windows, Linux), you have to access a file by its exact path.
976
Internally, bzr only supports NFC/NFKC normalization, since that is
977
the standard for XML documents.
979
So return the normalized path, and a flag indicating if the file
980
can be accessed by that path.
983
return unicodedata.normalize('NFKC', unicode(path)), True
986
def _inaccessible_normalized_filename(path):
987
__doc__ = _accessible_normalized_filename.__doc__
989
normalized = unicodedata.normalize('NFKC', unicode(path))
990
return normalized, normalized == path
993
if _platform_normalizes_filenames:
994
normalized_filename = _accessible_normalized_filename
996
normalized_filename = _inaccessible_normalized_filename
999
def terminal_width():
1000
"""Return estimated terminal width."""
1001
if sys.platform == 'win32':
1002
return win32utils.get_console_size()[0]
1005
import struct, fcntl, termios
1006
s = struct.pack('HHHH', 0, 0, 0, 0)
1007
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1008
width = struct.unpack('HHHH', x)[1]
1013
width = int(os.environ['COLUMNS'])
1022
def supports_executable():
1023
return sys.platform != "win32"
1026
def supports_posix_readonly():
1027
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1029
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1030
directory controls creation/deletion, etc.
1032
And under win32, readonly means that the directory itself cannot be
1033
deleted. The contents of a readonly directory can be changed, unlike POSIX
1034
where files in readonly directories cannot be added, deleted or renamed.
1036
return sys.platform != "win32"
1039
def set_or_unset_env(env_variable, value):
1040
"""Modify the environment, setting or removing the env_variable.
1042
:param env_variable: The environment variable in question
1043
:param value: The value to set the environment to. If None, then
1044
the variable will be removed.
1045
:return: The original value of the environment variable.
1047
orig_val = os.environ.get(env_variable)
1049
if orig_val is not None:
1050
del os.environ[env_variable]
1052
if isinstance(value, unicode):
1053
value = value.encode(bzrlib.user_encoding)
1054
os.environ[env_variable] = value
1058
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1061
def check_legal_path(path):
1062
"""Check whether the supplied path is legal.
1063
This is only required on Windows, so we don't test on other platforms
1066
if sys.platform != "win32":
1068
if _validWin32PathRE.match(path) is None:
1069
raise errors.IllegalPath(path)
1072
def walkdirs(top, prefix=""):
1073
"""Yield data about all the directories in a tree.
1075
This yields all the data about the contents of a directory at a time.
1076
After each directory has been yielded, if the caller has mutated the list
1077
to exclude some directories, they are then not descended into.
1079
The data yielded is of the form:
1080
((directory-relpath, directory-path-from-top),
1081
[(directory-relpath, basename, kind, lstat, path-from-top), ...]),
1082
- directory-relpath is the relative path of the directory being returned
1083
with respect to top. prefix is prepended to this.
1084
- directory-path-from-root is the path including top for this directory.
1085
It is suitable for use with os functions.
1086
- relpath is the relative path within the subtree being walked.
1087
- basename is the basename of the path
1088
- kind is the kind of the file now. If unknown then the file is not
1089
present within the tree - but it may be recorded as versioned. See
1091
- lstat is the stat data *if* the file was statted.
1092
- planned, not implemented:
1093
path_from_tree_root is the path from the root of the tree.
1095
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1096
allows one to walk a subtree but get paths that are relative to a tree
1098
:return: an iterator over the dirs.
1100
#TODO there is a bit of a smell where the results of the directory-
1101
# summary in this, and the path from the root, may not agree
1102
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1103
# potentially confusing output. We should make this more robust - but
1104
# not at a speed cost. RBC 20060731
1106
_directory = _directory_kind
1107
_listdir = os.listdir
1108
_kind_from_mode = _formats.get
1109
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1111
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1112
relroot, _, _, _, top = pending.pop()
1114
relprefix = relroot + u'/'
1117
top_slash = top + u'/'
1120
append = dirblock.append
1121
for name in sorted(_listdir(top)):
1122
abspath = top_slash + name
1123
statvalue = _lstat(abspath)
1124
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1125
append((relprefix + name, name, kind, statvalue, abspath))
1126
yield (relroot, top), dirblock
1128
# push the user specified dirs from dirblock
1129
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1132
def _walkdirs_utf8(top, prefix=""):
1133
"""Yield data about all the directories in a tree.
1135
This yields the same information as walkdirs() only each entry is yielded
1136
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1137
are returned as exact byte-strings.
1139
:return: yields a tuple of (dir_info, [file_info])
1140
dir_info is (utf8_relpath, path-from-top)
1141
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1142
if top is an absolute path, path-from-top is also an absolute path.
1143
path-from-top might be unicode or utf8, but it is the correct path to
1144
pass to os functions to affect the file in question. (such as os.lstat)
1146
fs_encoding = sys.getfilesystemencoding()
1147
if (sys.platform == 'win32' or
1148
fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968')): # ascii
1149
return _walkdirs_unicode_to_utf8(top, prefix=prefix)
1151
return _walkdirs_fs_utf8(top, prefix=prefix)
1154
def _walkdirs_fs_utf8(top, prefix=""):
1155
"""See _walkdirs_utf8.
1157
This sub-function is called when we know the filesystem is already in utf8
1158
encoding. So we don't need to transcode filenames.
1161
_directory = _directory_kind
1162
_listdir = os.listdir
1163
_kind_from_mode = _formats.get
1165
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1166
# But we don't actually uses 1-3 in pending, so set them to None
1167
pending = [(safe_utf8(prefix), None, None, None, safe_utf8(top))]
1169
relroot, _, _, _, top = pending.pop()
1171
relprefix = relroot + '/'
1174
top_slash = top + '/'
1177
append = dirblock.append
1178
for name in sorted(_listdir(top)):
1179
abspath = top_slash + name
1180
statvalue = _lstat(abspath)
1181
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1182
append((relprefix + name, name, kind, statvalue, abspath))
1183
yield (relroot, top), dirblock
1185
# push the user specified dirs from dirblock
1186
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1189
def _walkdirs_unicode_to_utf8(top, prefix=""):
1190
"""See _walkdirs_utf8
1192
Because Win32 has a Unicode api, all of the 'path-from-top' entries will be
1194
This is currently the fallback code path when the filesystem encoding is
1195
not UTF-8. It may be better to implement an alternative so that we can
1196
safely handle paths that are not properly decodable in the current
1199
_utf8_encode = codecs.getencoder('utf8')
1201
_directory = _directory_kind
1202
_listdir = os.listdir
1203
_kind_from_mode = _formats.get
1205
pending = [(safe_utf8(prefix), None, None, None, safe_unicode(top))]
1207
relroot, _, _, _, top = pending.pop()
1209
relprefix = relroot + '/'
1212
top_slash = top + u'/'
1215
append = dirblock.append
1216
for name in sorted(_listdir(top)):
1217
name_utf8 = _utf8_encode(name)[0]
1218
abspath = top_slash + name
1219
statvalue = _lstat(abspath)
1220
kind = _kind_from_mode(statvalue.st_mode & 0170000, 'unknown')
1221
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1222
yield (relroot, top), dirblock
1224
# push the user specified dirs from dirblock
1225
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1228
def copy_tree(from_path, to_path, handlers={}):
1229
"""Copy all of the entries in from_path into to_path.
1231
:param from_path: The base directory to copy.
1232
:param to_path: The target directory. If it does not exist, it will
1234
:param handlers: A dictionary of functions, which takes a source and
1235
destinations for files, directories, etc.
1236
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1237
'file', 'directory', and 'symlink' should always exist.
1238
If they are missing, they will be replaced with 'os.mkdir()',
1239
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1241
# Now, just copy the existing cached tree to the new location
1242
# We use a cheap trick here.
1243
# Absolute paths are prefixed with the first parameter
1244
# relative paths are prefixed with the second.
1245
# So we can get both the source and target returned
1246
# without any extra work.
1248
def copy_dir(source, dest):
1251
def copy_link(source, dest):
1252
"""Copy the contents of a symlink"""
1253
link_to = os.readlink(source)
1254
os.symlink(link_to, dest)
1256
real_handlers = {'file':shutil.copy2,
1257
'symlink':copy_link,
1258
'directory':copy_dir,
1260
real_handlers.update(handlers)
1262
if not os.path.exists(to_path):
1263
real_handlers['directory'](from_path, to_path)
1265
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1266
for relpath, name, kind, st, abspath in entries:
1267
real_handlers[kind](abspath, relpath)
1270
def path_prefix_key(path):
1271
"""Generate a prefix-order path key for path.
1273
This can be used to sort paths in the same way that walkdirs does.
1275
return (dirname(path) , path)
1278
def compare_paths_prefix_order(path_a, path_b):
1279
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1280
key_a = path_prefix_key(path_a)
1281
key_b = path_prefix_key(path_b)
1282
return cmp(key_a, key_b)
1285
_cached_user_encoding = None
1288
def get_user_encoding(use_cache=True):
1289
"""Find out what the preferred user encoding is.
1291
This is generally the encoding that is used for command line parameters
1292
and file contents. This may be different from the terminal encoding
1293
or the filesystem encoding.
1295
:param use_cache: Enable cache for detected encoding.
1296
(This parameter is turned on by default,
1297
and required only for selftesting)
1299
:return: A string defining the preferred user encoding
1301
global _cached_user_encoding
1302
if _cached_user_encoding is not None and use_cache:
1303
return _cached_user_encoding
1305
if sys.platform == 'darwin':
1306
# work around egregious python 2.4 bug
1307
sys.platform = 'posix'
1311
sys.platform = 'darwin'
1316
user_encoding = locale.getpreferredencoding()
1317
except locale.Error, e:
1318
sys.stderr.write('bzr: warning: %s\n'
1319
' Could not determine what text encoding to use.\n'
1320
' This error usually means your Python interpreter\n'
1321
' doesn\'t support the locale set by $LANG (%s)\n'
1322
" Continuing with ascii encoding.\n"
1323
% (e, os.environ.get('LANG')))
1324
user_encoding = 'ascii'
1326
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1327
# treat that as ASCII, and not support printing unicode characters to the
1329
if user_encoding in (None, 'cp0'):
1330
user_encoding = 'ascii'
1334
codecs.lookup(user_encoding)
1336
sys.stderr.write('bzr: warning:'
1337
' unknown encoding %s.'
1338
' Continuing with ascii encoding.\n'
1341
user_encoding = 'ascii'
1344
_cached_user_encoding = user_encoding
1346
return user_encoding
1349
def recv_all(socket, bytes):
1350
"""Receive an exact number of bytes.
1352
Regular Socket.recv() may return less than the requested number of bytes,
1353
dependning on what's in the OS buffer. MSG_WAITALL is not available
1354
on all platforms, but this should work everywhere. This will return
1355
less than the requested amount if the remote end closes.
1357
This isn't optimized and is intended mostly for use in testing.
1360
while len(b) < bytes:
1361
new = socket.recv(bytes - len(b))
1367
def dereference_path(path):
1368
"""Determine the real path to a file.
1370
All parent elements are dereferenced. But the file itself is not
1372
:param path: The original path. May be absolute or relative.
1373
:return: the real path *to* the file
1375
parent, base = os.path.split(path)
1376
# The pathjoin for '.' is a workaround for Python bug #1213894.
1377
# (initial path components aren't dereferenced)
1378
return pathjoin(realpath(pathjoin('.', parent)), base)
added
removed
bzrlib/osutils.py
