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
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
28
from datetime import datetime
30
from ntpath import (abspath as _nt_abspath,
32
normpath as _nt_normpath,
33
realpath as _nt_realpath,
34
splitdrive as _nt_splitdrive,
42
from tempfile import (
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
56
if sys.version_info < (2, 5):
57
import md5 as _mod_md5
59
import sha as _mod_sha
69
from bzrlib import symbol_versioning
72
# On win32, O_BINARY is used to indicate the file should
73
# be opened in binary mode, rather than text mode.
74
# On other platforms, O_BINARY doesn't exist, because
75
# they always open in binary mode, so it is okay to
76
# OR with 0 on those platforms
77
O_BINARY = getattr(os, 'O_BINARY', 0)
80
def make_readonly(filename):
81
"""Make a filename read-only."""
82
mod = os.lstat(filename).st_mode
83
if not stat.S_ISLNK(mod):
85
os.chmod(filename, mod)
88
def make_writable(filename):
89
mod = os.lstat(filename).st_mode
90
if not stat.S_ISLNK(mod):
92
os.chmod(filename, mod)
95
def minimum_path_selection(paths):
96
"""Return the smallset subset of paths which are outside paths.
98
:param paths: A container (and hence not None) of paths.
99
:return: A set of paths sufficient to include everything in paths via
100
is_inside_any, drawn from the paths parameter.
105
other_paths = paths.difference([path])
106
if not is_inside_any(other_paths, path):
107
# this is a top level path, we must check it.
108
search_paths.add(path)
116
"""Return a quoted filename filename
118
This previously used backslash quoting, but that works poorly on
120
# TODO: I'm not really sure this is the best format either.x
122
if _QUOTE_RE is None:
123
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
125
if _QUOTE_RE.search(f):
131
_directory_kind = 'directory'
134
"""Return the current umask"""
135
# Assume that people aren't messing with the umask while running
136
# XXX: This is not thread safe, but there is no way to get the
137
# umask without setting it
145
_directory_kind: "/",
147
'tree-reference': '+',
151
def kind_marker(kind):
153
return _kind_marker_map[kind]
155
raise errors.BzrError('invalid file kind %r' % kind)
158
lexists = getattr(os.path, 'lexists', None)
162
stat = getattr(os, 'lstat', os.stat)
166
if e.errno == errno.ENOENT:
169
raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
172
def fancy_rename(old, new, rename_func, unlink_func):
173
"""A fancy rename, when you don't have atomic rename.
175
:param old: The old path, to rename from
176
:param new: The new path, to rename to
177
:param rename_func: The potentially non-atomic rename function
178
:param unlink_func: A way to delete the target file if the full rename succeeds
181
# sftp rename doesn't allow overwriting, so play tricks:
182
base = os.path.basename(new)
183
dirname = os.path.dirname(new)
184
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
185
tmp_name = pathjoin(dirname, tmp_name)
187
# Rename the file out of the way, but keep track if it didn't exist
188
# We don't want to grab just any exception
189
# something like EACCES should prevent us from continuing
190
# The downside is that the rename_func has to throw an exception
191
# with an errno = ENOENT, or NoSuchFile
194
rename_func(new, tmp_name)
195
except (errors.NoSuchFile,), e:
198
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
199
# function raises an IOError with errno is None when a rename fails.
200
# This then gets caught here.
201
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
204
if (getattr(e, 'errno', None) is None
205
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
213
# This may throw an exception, in which case success will
215
rename_func(old, new)
217
except (IOError, OSError), e:
218
# source and target may be aliases of each other (e.g. on a
219
# case-insensitive filesystem), so we may have accidentally renamed
220
# source by when we tried to rename target
221
if not (file_existed and e.errno in (None, errno.ENOENT)):
225
# If the file used to exist, rename it back into place
226
# otherwise just delete it from the tmp location
228
unlink_func(tmp_name)
230
rename_func(tmp_name, new)
233
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
234
# choke on a Unicode string containing a relative path if
235
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
237
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
238
def _posix_abspath(path):
239
# jam 20060426 rather than encoding to fsencoding
240
# copy posixpath.abspath, but use os.getcwdu instead
241
if not posixpath.isabs(path):
242
path = posixpath.join(getcwd(), path)
243
return posixpath.normpath(path)
246
def _posix_realpath(path):
247
return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
250
def _win32_fixdrive(path):
251
"""Force drive letters to be consistent.
253
win32 is inconsistent whether it returns lower or upper case
254
and even if it was consistent the user might type the other
255
so we force it to uppercase
256
running python.exe under cmd.exe return capital C:\\
257
running win32 python inside a cygwin shell returns lowercase c:\\
259
drive, path = _nt_splitdrive(path)
260
return drive.upper() + path
263
def _win32_abspath(path):
264
# Real _nt_abspath doesn't have a problem with a unicode cwd
265
return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
268
def _win98_abspath(path):
269
"""Return the absolute version of a path.
270
Windows 98 safe implementation (python reimplementation
271
of Win32 API function GetFullPathNameW)
276
# \\HOST\path => //HOST/path
277
# //HOST/path => //HOST/path
278
# path => C:/cwd/path
281
# check for absolute path
282
drive = _nt_splitdrive(path)[0]
283
if drive == '' and path[:2] not in('//','\\\\'):
285
# we cannot simply os.path.join cwd and path
286
# because os.path.join('C:','/path') produce '/path'
287
# and this is incorrect
288
if path[:1] in ('/','\\'):
289
cwd = _nt_splitdrive(cwd)[0]
291
path = cwd + '\\' + path
292
return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
295
def _win32_realpath(path):
296
# Real _nt_realpath doesn't have a problem with a unicode cwd
297
return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
300
def _win32_pathjoin(*args):
301
return _nt_join(*args).replace('\\', '/')
304
def _win32_normpath(path):
305
return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
309
return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
312
def _win32_mkdtemp(*args, **kwargs):
313
return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
316
def _win32_rename(old, new):
317
"""We expect to be able to atomically replace 'new' with old.
319
On win32, if new exists, it must be moved out of the way first,
323
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
325
if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
326
# If we try to rename a non-existant file onto cwd, we get
327
# EPERM or EACCES instead of ENOENT, this will raise ENOENT
328
# if the old path doesn't exist, sometimes we get EACCES
329
# On Linux, we seem to get EBUSY, on Mac we get EINVAL
335
return unicodedata.normalize('NFC', os.getcwdu())
338
# Default is to just use the python builtins, but these can be rebound on
339
# particular platforms.
340
abspath = _posix_abspath
341
realpath = _posix_realpath
342
pathjoin = os.path.join
343
normpath = os.path.normpath
346
dirname = os.path.dirname
347
basename = os.path.basename
348
split = os.path.split
349
splitext = os.path.splitext
350
# These were already imported into local scope
351
# mkdtemp = tempfile.mkdtemp
352
# rmtree = shutil.rmtree
354
MIN_ABS_PATHLENGTH = 1
357
if sys.platform == 'win32':
358
if win32utils.winver == 'Windows 98':
359
abspath = _win98_abspath
361
abspath = _win32_abspath
362
realpath = _win32_realpath
363
pathjoin = _win32_pathjoin
364
normpath = _win32_normpath
365
getcwd = _win32_getcwd
366
mkdtemp = _win32_mkdtemp
367
rename = _win32_rename
369
MIN_ABS_PATHLENGTH = 3
371
def _win32_delete_readonly(function, path, excinfo):
372
"""Error handler for shutil.rmtree function [for win32]
373
Helps to remove files and dirs marked as read-only.
375
exception = excinfo[1]
376
if function in (os.remove, os.rmdir) \
377
and isinstance(exception, OSError) \
378
and exception.errno == errno.EACCES:
384
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
385
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
386
return shutil.rmtree(path, ignore_errors, onerror)
387
elif sys.platform == 'darwin':
391
def get_terminal_encoding():
392
"""Find the best encoding for printing to the screen.
394
This attempts to check both sys.stdout and sys.stdin to see
395
what encoding they are in, and if that fails it falls back to
396
osutils.get_user_encoding().
397
The problem is that on Windows, locale.getpreferredencoding()
398
is not the same encoding as that used by the console:
399
http://mail.python.org/pipermail/python-list/2003-May/162357.html
401
On my standard US Windows XP, the preferred encoding is
402
cp1252, but the console is cp437
404
from bzrlib.trace import mutter
405
output_encoding = getattr(sys.stdout, 'encoding', None)
406
if not output_encoding:
407
input_encoding = getattr(sys.stdin, 'encoding', None)
408
if not input_encoding:
409
output_encoding = get_user_encoding()
410
mutter('encoding stdout as osutils.get_user_encoding() %r',
413
output_encoding = input_encoding
414
mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
416
mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
417
if output_encoding == 'cp0':
418
# invalid encoding (cp0 means 'no codepage' on Windows)
419
output_encoding = get_user_encoding()
420
mutter('cp0 is invalid encoding.'
421
' encoding stdout as osutils.get_user_encoding() %r',
425
codecs.lookup(output_encoding)
427
sys.stderr.write('bzr: warning:'
428
' unknown terminal encoding %s.\n'
429
' Using encoding %s instead.\n'
430
% (output_encoding, get_user_encoding())
432
output_encoding = get_user_encoding()
434
return output_encoding
437
def normalizepath(f):
438
if getattr(os.path, 'realpath', None) is not None:
442
[p,e] = os.path.split(f)
443
if e == "" or e == "." or e == "..":
446
return pathjoin(F(p), e)
450
"""True if f is an accessible directory."""
452
return S_ISDIR(os.lstat(f)[ST_MODE])
458
"""True if f is a regular file."""
460
return S_ISREG(os.lstat(f)[ST_MODE])
465
"""True if f is a symlink."""
467
return S_ISLNK(os.lstat(f)[ST_MODE])
471
def is_inside(dir, fname):
472
"""True if fname is inside dir.
474
The parameters should typically be passed to osutils.normpath first, so
475
that . and .. and repeated slashes are eliminated, and the separators
476
are canonical for the platform.
478
The empty string as a dir name is taken as top-of-tree and matches
481
# XXX: Most callers of this can actually do something smarter by
482
# looking at the inventory
492
return fname.startswith(dir)
495
def is_inside_any(dir_list, fname):
496
"""True if fname is inside any of given dirs."""
497
for dirname in dir_list:
498
if is_inside(dirname, fname):
503
def is_inside_or_parent_of_any(dir_list, fname):
504
"""True if fname is a child or a parent of any of the given files."""
505
for dirname in dir_list:
506
if is_inside(dirname, fname) or is_inside(fname, dirname):
511
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768):
512
"""Copy contents of one file to another.
514
The read_length can either be -1 to read to end-of-file (EOF) or
515
it can specify the maximum number of bytes to read.
517
The buff_size represents the maximum size for each read operation
518
performed on from_file.
520
:return: The number of bytes copied.
524
# read specified number of bytes
526
while read_length > 0:
527
num_bytes_to_read = min(read_length, buff_size)
529
block = from_file.read(num_bytes_to_read)
535
actual_bytes_read = len(block)
536
read_length -= actual_bytes_read
537
length += actual_bytes_read
541
block = from_file.read(buff_size)
550
def pump_string_file(bytes, file_handle, segment_size=None):
551
"""Write bytes to file_handle in many smaller writes.
553
:param bytes: The string to write.
554
:param file_handle: The file to write to.
556
# Write data in chunks rather than all at once, because very large
557
# writes fail on some platforms (e.g. Windows with SMB mounted
560
segment_size = 5242880 # 5MB
561
segments = range(len(bytes) / segment_size + 1)
562
write = file_handle.write
563
for segment_index in segments:
564
segment = buffer(bytes, segment_index * segment_size, segment_size)
568
def file_iterator(input_file, readsize=32768):
570
b = input_file.read(readsize)
577
"""Calculate the hexdigest of an open file.
579
The file cursor should be already at the start.
591
def sha_file_by_name(fname):
592
"""Calculate the SHA1 of a file by reading the full text"""
594
f = os.open(fname, os.O_RDONLY | O_BINARY)
597
b = os.read(f, 1<<16)
605
def sha_strings(strings, _factory=sha):
606
"""Return the sha-1 of concatenation of strings"""
608
map(s.update, strings)
612
def sha_string(f, _factory=sha):
613
return _factory(f).hexdigest()
616
def fingerprint_file(f):
618
return {'size': len(b),
619
'sha1': sha(b).hexdigest()}
622
def compare_files(a, b):
623
"""Returns true if equal in contents"""
634
def local_time_offset(t=None):
635
"""Return offset of local zone from GMT, either at present or at time t."""
638
offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
639
return offset.days * 86400 + offset.seconds
641
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
643
def format_date(t, offset=0, timezone='original', date_fmt=None,
645
"""Return a formatted date string.
647
:param t: Seconds since the epoch.
648
:param offset: Timezone offset in seconds east of utc.
649
:param timezone: How to display the time: 'utc', 'original' for the
650
timezone specified by offset, or 'local' for the process's current
652
:param date_fmt: strftime format.
653
:param show_offset: Whether to append the timezone.
655
(date_fmt, tt, offset_str) = \
656
_format_date(t, offset, timezone, date_fmt, show_offset)
657
date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
658
date_str = time.strftime(date_fmt, tt)
659
return date_str + offset_str
661
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
663
"""Return an unicode date string formatted according to the current locale.
665
:param t: Seconds since the epoch.
666
:param offset: Timezone offset in seconds east of utc.
667
:param timezone: How to display the time: 'utc', 'original' for the
668
timezone specified by offset, or 'local' for the process's current
670
:param date_fmt: strftime format.
671
:param show_offset: Whether to append the timezone.
673
(date_fmt, tt, offset_str) = \
674
_format_date(t, offset, timezone, date_fmt, show_offset)
675
date_str = time.strftime(date_fmt, tt)
676
if not isinstance(date_str, unicode):
677
date_str = date_str.decode(bzrlib.user_encoding, 'replace')
678
return date_str + offset_str
680
def _format_date(t, offset, timezone, date_fmt, show_offset):
681
if timezone == 'utc':
684
elif timezone == 'original':
687
tt = time.gmtime(t + offset)
688
elif timezone == 'local':
689
tt = time.localtime(t)
690
offset = local_time_offset(t)
692
raise errors.UnsupportedTimezoneFormat(timezone)
694
date_fmt = "%a %Y-%m-%d %H:%M:%S"
696
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
699
return (date_fmt, tt, offset_str)
702
def compact_date(when):
703
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
706
def format_delta(delta):
707
"""Get a nice looking string for a time delta.
709
:param delta: The time difference in seconds, can be positive or negative.
710
positive indicates time in the past, negative indicates time in the
711
future. (usually time.time() - stored_time)
712
:return: String formatted to show approximate resolution
718
direction = 'in the future'
722
if seconds < 90: # print seconds up to 90 seconds
724
return '%d second %s' % (seconds, direction,)
726
return '%d seconds %s' % (seconds, direction)
728
minutes = int(seconds / 60)
729
seconds -= 60 * minutes
734
if minutes < 90: # print minutes, seconds up to 90 minutes
736
return '%d minute, %d second%s %s' % (
737
minutes, seconds, plural_seconds, direction)
739
return '%d minutes, %d second%s %s' % (
740
minutes, seconds, plural_seconds, direction)
742
hours = int(minutes / 60)
743
minutes -= 60 * hours
750
return '%d hour, %d minute%s %s' % (hours, minutes,
751
plural_minutes, direction)
752
return '%d hours, %d minute%s %s' % (hours, minutes,
753
plural_minutes, direction)
756
"""Return size of given open file."""
757
return os.fstat(f.fileno())[ST_SIZE]
760
# Define rand_bytes based on platform.
762
# Python 2.4 and later have os.urandom,
763
# but it doesn't work on some arches
765
rand_bytes = os.urandom
766
except (NotImplementedError, AttributeError):
767
# If python doesn't have os.urandom, or it doesn't work,
768
# then try to first pull random data from /dev/urandom
770
rand_bytes = file('/dev/urandom', 'rb').read
771
# Otherwise, use this hack as a last resort
772
except (IOError, OSError):
773
# not well seeded, but better than nothing
778
s += chr(random.randint(0, 255))
783
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
785
"""Return a random string of num alphanumeric characters
787
The result only contains lowercase chars because it may be used on
788
case-insensitive filesystems.
791
for raw_byte in rand_bytes(num):
792
s += ALNUM[ord(raw_byte) % 36]
796
## TODO: We could later have path objects that remember their list
797
## decomposition (might be too tricksy though.)
800
"""Turn string into list of parts."""
801
# split on either delimiter because people might use either on
803
ps = re.split(r'[\\/]', p)
808
raise errors.BzrError("sorry, %r not allowed in path" % f)
809
elif (f == '.') or (f == ''):
817
if (f == '..') or (f is None) or (f == ''):
818
raise errors.BzrError("sorry, %r not allowed in path" % f)
823
"""Split s into lines, but without removing the newline characters."""
824
lines = s.split('\n')
825
result = [line + '\n' for line in lines[:-1]]
827
result.append(lines[-1])
831
def hardlinks_good():
832
return sys.platform not in ('win32', 'cygwin', 'darwin')
835
def link_or_copy(src, dest):
836
"""Hardlink a file, or copy it if it can't be hardlinked."""
837
if not hardlinks_good():
838
shutil.copyfile(src, dest)
842
except (OSError, IOError), e:
843
if e.errno != errno.EXDEV:
845
shutil.copyfile(src, dest)
848
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
849
# Forgiveness than Permission (EAFP) because:
850
# - root can damage a solaris file system by using unlink,
851
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
852
# EACCES, OSX: EPERM) when invoked on a directory.
853
def delete_any(path):
854
"""Delete a file or directory."""
855
if isdir(path): # Takes care of symlinks
862
if getattr(os, 'symlink', None) is not None:
869
if getattr(os, 'link', None) is not None:
875
def host_os_dereferences_symlinks():
876
return (has_symlinks()
877
and sys.platform not in ('cygwin', 'win32'))
880
def contains_whitespace(s):
881
"""True if there are any whitespace characters in s."""
882
# string.whitespace can include '\xa0' in certain locales, because it is
883
# considered "non-breaking-space" as part of ISO-8859-1. But it
884
# 1) Isn't a breaking whitespace
885
# 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
887
# 3) '\xa0' isn't unicode safe since it is >128.
889
# This should *not* be a unicode set of characters in case the source
890
# string is not a Unicode string. We can auto-up-cast the characters since
891
# they are ascii, but we don't want to auto-up-cast the string in case it
893
for ch in ' \t\n\r\v\f':
900
def contains_linebreaks(s):
901
"""True if there is any vertical whitespace in s."""
909
def relpath(base, path):
910
"""Return path relative to base, or raise exception.
912
The path may be either an absolute path or a path relative to the
913
current working directory.
915
os.path.commonprefix (python2.4) has a bad bug that it works just
916
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
920
if len(base) < MIN_ABS_PATHLENGTH:
921
# must have space for e.g. a drive letter
922
raise ValueError('%r is too short to calculate a relative path'
929
while len(head) >= len(base):
932
head, tail = os.path.split(head)
936
raise errors.PathNotChild(rp, base)
944
def safe_unicode(unicode_or_utf8_string):
945
"""Coerce unicode_or_utf8_string into unicode.
947
If it is unicode, it is returned.
948
Otherwise it is decoded from utf-8. If a decoding error
949
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
950
as a BzrBadParameter exception.
952
if isinstance(unicode_or_utf8_string, unicode):
953
return unicode_or_utf8_string
955
return unicode_or_utf8_string.decode('utf8')
956
except UnicodeDecodeError:
957
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
960
def safe_utf8(unicode_or_utf8_string):
961
"""Coerce unicode_or_utf8_string to a utf8 string.
963
If it is a str, it is returned.
964
If it is Unicode, it is encoded into a utf-8 string.
966
if isinstance(unicode_or_utf8_string, str):
967
# TODO: jam 20070209 This is overkill, and probably has an impact on
968
# performance if we are dealing with lots of apis that want a
971
# Make sure it is a valid utf-8 string
972
unicode_or_utf8_string.decode('utf-8')
973
except UnicodeDecodeError:
974
raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
975
return unicode_or_utf8_string
976
return unicode_or_utf8_string.encode('utf-8')
979
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
980
' Revision id generators should be creating utf8'
984
def safe_revision_id(unicode_or_utf8_string, warn=True):
985
"""Revision ids should now be utf8, but at one point they were unicode.
987
:param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
989
:param warn: Functions that are sanitizing user data can set warn=False
990
:return: None or a utf8 revision id.
992
if (unicode_or_utf8_string is None
993
or unicode_or_utf8_string.__class__ == str):
994
return unicode_or_utf8_string
996
symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
998
return cache_utf8.encode(unicode_or_utf8_string)
1001
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
1002
' generators should be creating utf8 file ids.')
1005
def safe_file_id(unicode_or_utf8_string, warn=True):
1006
"""File ids should now be utf8, but at one point they were unicode.
1008
This is the same as safe_utf8, except it uses the cached encode functions
1009
to save a little bit of performance.
1011
:param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
1013
:param warn: Functions that are sanitizing user data can set warn=False
1014
:return: None or a utf8 file id.
1016
if (unicode_or_utf8_string is None
1017
or unicode_or_utf8_string.__class__ == str):
1018
return unicode_or_utf8_string
1020
symbol_versioning.warn(_file_id_warning, DeprecationWarning,
1022
return cache_utf8.encode(unicode_or_utf8_string)
1025
_platform_normalizes_filenames = False
1026
if sys.platform == 'darwin':
1027
_platform_normalizes_filenames = True
1030
def normalizes_filenames():
1031
"""Return True if this platform normalizes unicode filenames.
1033
Mac OSX does, Windows/Linux do not.
1035
return _platform_normalizes_filenames
1038
def _accessible_normalized_filename(path):
1039
"""Get the unicode normalized path, and if you can access the file.
1041
On platforms where the system normalizes filenames (Mac OSX),
1042
you can access a file by any path which will normalize correctly.
1043
On platforms where the system does not normalize filenames
1044
(Windows, Linux), you have to access a file by its exact path.
1046
Internally, bzr only supports NFC normalization, since that is
1047
the standard for XML documents.
1049
So return the normalized path, and a flag indicating if the file
1050
can be accessed by that path.
1053
return unicodedata.normalize('NFC', unicode(path)), True
1056
def _inaccessible_normalized_filename(path):
1057
__doc__ = _accessible_normalized_filename.__doc__
1059
normalized = unicodedata.normalize('NFC', unicode(path))
1060
return normalized, normalized == path
1063
if _platform_normalizes_filenames:
1064
normalized_filename = _accessible_normalized_filename
1066
normalized_filename = _inaccessible_normalized_filename
1069
def terminal_width():
1070
"""Return estimated terminal width."""
1071
if sys.platform == 'win32':
1072
return win32utils.get_console_size()[0]
1075
import struct, fcntl, termios
1076
s = struct.pack('HHHH', 0, 0, 0, 0)
1077
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
1078
width = struct.unpack('HHHH', x)[1]
1083
width = int(os.environ['COLUMNS'])
1092
def supports_executable():
1093
return sys.platform != "win32"
1096
def supports_posix_readonly():
1097
"""Return True if 'readonly' has POSIX semantics, False otherwise.
1099
Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
1100
directory controls creation/deletion, etc.
1102
And under win32, readonly means that the directory itself cannot be
1103
deleted. The contents of a readonly directory can be changed, unlike POSIX
1104
where files in readonly directories cannot be added, deleted or renamed.
1106
return sys.platform != "win32"
1109
def set_or_unset_env(env_variable, value):
1110
"""Modify the environment, setting or removing the env_variable.
1112
:param env_variable: The environment variable in question
1113
:param value: The value to set the environment to. If None, then
1114
the variable will be removed.
1115
:return: The original value of the environment variable.
1117
orig_val = os.environ.get(env_variable)
1119
if orig_val is not None:
1120
del os.environ[env_variable]
1122
if isinstance(value, unicode):
1123
value = value.encode(get_user_encoding())
1124
os.environ[env_variable] = value
1128
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
1131
def check_legal_path(path):
1132
"""Check whether the supplied path is legal.
1133
This is only required on Windows, so we don't test on other platforms
1136
if sys.platform != "win32":
1138
if _validWin32PathRE.match(path) is None:
1139
raise errors.IllegalPath(path)
1142
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
1144
def _is_error_enotdir(e):
1145
"""Check if this exception represents ENOTDIR.
1147
Unfortunately, python is very inconsistent about the exception
1148
here. The cases are:
1149
1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
1150
2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
1151
which is the windows error code.
1152
3) Windows, Python2.5 uses errno == EINVAL and
1153
winerror == ERROR_DIRECTORY
1155
:param e: An Exception object (expected to be OSError with an errno
1156
attribute, but we should be able to cope with anything)
1157
:return: True if this represents an ENOTDIR error. False otherwise.
1159
en = getattr(e, 'errno', None)
1160
if (en == errno.ENOTDIR
1161
or (sys.platform == 'win32'
1162
and (en == _WIN32_ERROR_DIRECTORY
1163
or (en == errno.EINVAL
1164
and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
1170
def walkdirs(top, prefix=""):
1171
"""Yield data about all the directories in a tree.
1173
This yields all the data about the contents of a directory at a time.
1174
After each directory has been yielded, if the caller has mutated the list
1175
to exclude some directories, they are then not descended into.
1177
The data yielded is of the form:
1178
((directory-relpath, directory-path-from-top),
1179
[(relpath, basename, kind, lstat, path-from-top), ...]),
1180
- directory-relpath is the relative path of the directory being returned
1181
with respect to top. prefix is prepended to this.
1182
- directory-path-from-root is the path including top for this directory.
1183
It is suitable for use with os functions.
1184
- relpath is the relative path within the subtree being walked.
1185
- basename is the basename of the path
1186
- kind is the kind of the file now. If unknown then the file is not
1187
present within the tree - but it may be recorded as versioned. See
1189
- lstat is the stat data *if* the file was statted.
1190
- planned, not implemented:
1191
path_from_tree_root is the path from the root of the tree.
1193
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
1194
allows one to walk a subtree but get paths that are relative to a tree
1196
:return: an iterator over the dirs.
1198
#TODO there is a bit of a smell where the results of the directory-
1199
# summary in this, and the path from the root, may not agree
1200
# depending on top and prefix - i.e. ./foo and foo as a pair leads to
1201
# potentially confusing output. We should make this more robust - but
1202
# not at a speed cost. RBC 20060731
1204
_directory = _directory_kind
1205
_listdir = os.listdir
1206
_kind_from_mode = file_kind_from_stat_mode
1207
pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
1209
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1210
relroot, _, _, _, top = pending.pop()
1212
relprefix = relroot + u'/'
1215
top_slash = top + u'/'
1218
append = dirblock.append
1220
names = sorted(_listdir(top))
1222
if not _is_error_enotdir(e):
1226
abspath = top_slash + name
1227
statvalue = _lstat(abspath)
1228
kind = _kind_from_mode(statvalue.st_mode)
1229
append((relprefix + name, name, kind, statvalue, abspath))
1230
yield (relroot, top), dirblock
1232
# push the user specified dirs from dirblock
1233
pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
1236
class DirReader(object):
1237
"""An interface for reading directories."""
1239
def top_prefix_to_starting_dir(self, top, prefix=""):
1240
"""Converts top and prefix to a starting dir entry
1242
:param top: A utf8 path
1243
:param prefix: An optional utf8 path to prefix output relative paths
1245
:return: A tuple starting with prefix, and ending with the native
1248
raise NotImplementedError(self.top_prefix_to_starting_dir)
1250
def read_dir(self, prefix, top):
1251
"""Read a specific dir.
1253
:param prefix: A utf8 prefix to be preprended to the path basenames.
1254
:param top: A natively encoded path to read.
1255
:return: A list of the directories contents. Each item contains:
1256
(utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
1258
raise NotImplementedError(self.read_dir)
1261
_selected_dir_reader = None
1264
def _walkdirs_utf8(top, prefix=""):
1265
"""Yield data about all the directories in a tree.
1267
This yields the same information as walkdirs() only each entry is yielded
1268
in utf-8. On platforms which have a filesystem encoding of utf8 the paths
1269
are returned as exact byte-strings.
1271
:return: yields a tuple of (dir_info, [file_info])
1272
dir_info is (utf8_relpath, path-from-top)
1273
file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
1274
if top is an absolute path, path-from-top is also an absolute path.
1275
path-from-top might be unicode or utf8, but it is the correct path to
1276
pass to os functions to affect the file in question. (such as os.lstat)
1278
global _selected_dir_reader
1279
if _selected_dir_reader is None:
1280
fs_encoding = _fs_enc.upper()
1281
if sys.platform == "win32" and win32utils.winver == 'Windows NT':
1282
# Win98 doesn't have unicode apis like FindFirstFileW
1283
# TODO: We possibly could support Win98 by falling back to the
1284
# original FindFirstFile, and using TCHAR instead of WCHAR,
1285
# but that gets a bit tricky, and requires custom compiling
1288
from bzrlib._walkdirs_win32 import Win32ReadDir
1290
_selected_dir_reader = UnicodeDirReader()
1292
_selected_dir_reader = Win32ReadDir()
1293
elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
1294
# ANSI_X3.4-1968 is a form of ASCII
1295
_selected_dir_reader = UnicodeDirReader()
1298
from bzrlib._readdir_pyx import UTF8DirReader
1300
# No optimised code path
1301
_selected_dir_reader = UnicodeDirReader()
1303
_selected_dir_reader = UTF8DirReader()
1304
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
1305
# But we don't actually uses 1-3 in pending, so set them to None
1306
pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
1307
read_dir = _selected_dir_reader.read_dir
1308
_directory = _directory_kind
1310
relroot, _, _, _, top = pending[-1].pop()
1313
dirblock = sorted(read_dir(relroot, top))
1314
yield (relroot, top), dirblock
1315
# push the user specified dirs from dirblock
1316
next = [d for d in reversed(dirblock) if d[2] == _directory]
1318
pending.append(next)
1321
class UnicodeDirReader(DirReader):
1322
"""A dir reader for non-utf8 file systems, which transcodes."""
1324
__slots__ = ['_utf8_encode']
1327
self._utf8_encode = codecs.getencoder('utf8')
1329
def top_prefix_to_starting_dir(self, top, prefix=""):
1330
"""See DirReader.top_prefix_to_starting_dir."""
1331
return (safe_utf8(prefix), None, None, None, safe_unicode(top))
1333
def read_dir(self, prefix, top):
1334
"""Read a single directory from a non-utf8 file system.
1336
top, and the abspath element in the output are unicode, all other paths
1337
are utf8. Local disk IO is done via unicode calls to listdir etc.
1339
This is currently the fallback code path when the filesystem encoding is
1340
not UTF-8. It may be better to implement an alternative so that we can
1341
safely handle paths that are not properly decodable in the current
1344
See DirReader.read_dir for details.
1346
_utf8_encode = self._utf8_encode
1348
_listdir = os.listdir
1349
_kind_from_mode = file_kind_from_stat_mode
1352
relprefix = prefix + '/'
1355
top_slash = top + u'/'
1358
append = dirblock.append
1359
for name in sorted(_listdir(top)):
1361
name_utf8 = _utf8_encode(name)[0]
1362
except UnicodeDecodeError:
1363
raise errors.BadFilenameEncoding(
1364
_utf8_encode(relprefix)[0] + name, _fs_enc)
1365
abspath = top_slash + name
1366
statvalue = _lstat(abspath)
1367
kind = _kind_from_mode(statvalue.st_mode)
1368
append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
1372
def copy_tree(from_path, to_path, handlers={}):
1373
"""Copy all of the entries in from_path into to_path.
1375
:param from_path: The base directory to copy.
1376
:param to_path: The target directory. If it does not exist, it will
1378
:param handlers: A dictionary of functions, which takes a source and
1379
destinations for files, directories, etc.
1380
It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
1381
'file', 'directory', and 'symlink' should always exist.
1382
If they are missing, they will be replaced with 'os.mkdir()',
1383
'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
1385
# Now, just copy the existing cached tree to the new location
1386
# We use a cheap trick here.
1387
# Absolute paths are prefixed with the first parameter
1388
# relative paths are prefixed with the second.
1389
# So we can get both the source and target returned
1390
# without any extra work.
1392
def copy_dir(source, dest):
1395
def copy_link(source, dest):
1396
"""Copy the contents of a symlink"""
1397
link_to = os.readlink(source)
1398
os.symlink(link_to, dest)
1400
real_handlers = {'file':shutil.copy2,
1401
'symlink':copy_link,
1402
'directory':copy_dir,
1404
real_handlers.update(handlers)
1406
if not os.path.exists(to_path):
1407
real_handlers['directory'](from_path, to_path)
1409
for dir_info, entries in walkdirs(from_path, prefix=to_path):
1410
for relpath, name, kind, st, abspath in entries:
1411
real_handlers[kind](abspath, relpath)
1414
def path_prefix_key(path):
1415
"""Generate a prefix-order path key for path.
1417
This can be used to sort paths in the same way that walkdirs does.
1419
return (dirname(path) , path)
1422
def compare_paths_prefix_order(path_a, path_b):
1423
"""Compare path_a and path_b to generate the same order walkdirs uses."""
1424
key_a = path_prefix_key(path_a)
1425
key_b = path_prefix_key(path_b)
1426
return cmp(key_a, key_b)
1429
_cached_user_encoding = None
1432
def get_user_encoding(use_cache=True):
1433
"""Find out what the preferred user encoding is.
1435
This is generally the encoding that is used for command line parameters
1436
and file contents. This may be different from the terminal encoding
1437
or the filesystem encoding.
1439
:param use_cache: Enable cache for detected encoding.
1440
(This parameter is turned on by default,
1441
and required only for selftesting)
1443
:return: A string defining the preferred user encoding
1445
global _cached_user_encoding
1446
if _cached_user_encoding is not None and use_cache:
1447
return _cached_user_encoding
1449
if sys.platform == 'darwin':
1450
# python locale.getpreferredencoding() always return
1451
# 'mac-roman' on darwin. That's a lie.
1452
sys.platform = 'posix'
1454
if os.environ.get('LANG', None) is None:
1455
# If LANG is not set, we end up with 'ascii', which is bad
1456
# ('mac-roman' is more than ascii), so we set a default which
1457
# will give us UTF-8 (which appears to work in all cases on
1458
# OSX). Users are still free to override LANG of course, as
1459
# long as it give us something meaningful. This work-around
1460
# *may* not be needed with python 3k and/or OSX 10.5, but will
1461
# work with them too -- vila 20080908
1462
os.environ['LANG'] = 'en_US.UTF-8'
1465
sys.platform = 'darwin'
1470
user_encoding = locale.getpreferredencoding()
1471
except locale.Error, e:
1472
sys.stderr.write('bzr: warning: %s\n'
1473
' Could not determine what text encoding to use.\n'
1474
' This error usually means your Python interpreter\n'
1475
' doesn\'t support the locale set by $LANG (%s)\n'
1476
" Continuing with ascii encoding.\n"
1477
% (e, os.environ.get('LANG')))
1478
user_encoding = 'ascii'
1480
# Windows returns 'cp0' to indicate there is no code page. So we'll just
1481
# treat that as ASCII, and not support printing unicode characters to the
1484
# For python scripts run under vim, we get '', so also treat that as ASCII
1485
if user_encoding in (None, 'cp0', ''):
1486
user_encoding = 'ascii'
1490
codecs.lookup(user_encoding)
1492
sys.stderr.write('bzr: warning:'
1493
' unknown encoding %s.'
1494
' Continuing with ascii encoding.\n'
1497
user_encoding = 'ascii'
1500
_cached_user_encoding = user_encoding
1502
return user_encoding
1505
def get_host_name():
1506
"""Return the current unicode host name.
1508
This is meant to be used in place of socket.gethostname() because that
1509
behaves inconsistently on different platforms.
1511
if sys.platform == "win32":
1513
return win32utils.get_host_name()
1516
return socket.gethostname().decode(get_user_encoding())
1519
def recv_all(socket, bytes):
1520
"""Receive an exact number of bytes.
1522
Regular Socket.recv() may return less than the requested number of bytes,
1523
dependning on what's in the OS buffer. MSG_WAITALL is not available
1524
on all platforms, but this should work everywhere. This will return
1525
less than the requested amount if the remote end closes.
1527
This isn't optimized and is intended mostly for use in testing.
1530
while len(b) < bytes:
1531
new = socket.recv(bytes - len(b))
1538
def send_all(socket, bytes):
1539
"""Send all bytes on a socket.
1541
Regular socket.sendall() can give socket error 10053 on Windows. This
1542
implementation sends no more than 64k at a time, which avoids this problem.
1545
for pos in xrange(0, len(bytes), chunk_size):
1546
socket.sendall(bytes[pos:pos+chunk_size])
1549
def dereference_path(path):
1550
"""Determine the real path to a file.
1552
All parent elements are dereferenced. But the file itself is not
1554
:param path: The original path. May be absolute or relative.
1555
:return: the real path *to* the file
1557
parent, base = os.path.split(path)
1558
# The pathjoin for '.' is a workaround for Python bug #1213894.
1559
# (initial path components aren't dereferenced)
1560
return pathjoin(realpath(pathjoin('.', parent)), base)
1563
def supports_mapi():
1564
"""Return True if we can use MAPI to launch a mail client."""
1565
return sys.platform == "win32"
1568
def resource_string(package, resource_name):
1569
"""Load a resource from a package and return it as a string.
1571
Note: Only packages that start with bzrlib are currently supported.
1573
This is designed to be a lightweight implementation of resource
1574
loading in a way which is API compatible with the same API from
1576
http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
1577
If and when pkg_resources becomes a standard library, this routine
1580
# Check package name is within bzrlib
1581
if package == "bzrlib":
1582
resource_relpath = resource_name
1583
elif package.startswith("bzrlib."):
1584
package = package[len("bzrlib."):].replace('.', os.sep)
1585
resource_relpath = pathjoin(package, resource_name)
1587
raise errors.BzrError('resource package %s not in bzrlib' % package)
1589
# Map the resource to a file and read its contents
1590
base = dirname(bzrlib.__file__)
1591
if getattr(sys, 'frozen', None): # bzr.exe
1592
base = abspath(pathjoin(base, '..', '..'))
1593
filename = pathjoin(base, resource_relpath)
1594
return open(filename, 'rU').read()
1597
def file_kind_from_stat_mode_thunk(mode):
1598
global file_kind_from_stat_mode
1599
if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
1601
from bzrlib._readdir_pyx import UTF8DirReader
1602
file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
1604
from bzrlib._readdir_py import (
1605
_kind_from_mode as file_kind_from_stat_mode
1607
return file_kind_from_stat_mode(mode)
1608
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
1611
def file_kind(f, _lstat=os.lstat):
1613
return file_kind_from_stat_mode(_lstat(f).st_mode)
1615
if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
1616
raise errors.NoSuchFile(f)
1619
if sys.platform == "win32":
1622
return msvcrt.getch()
1627
fd = sys.stdin.fileno()
1628
settings = termios.tcgetattr(fd)
1631
ch = sys.stdin.read(1)
1633
termios.tcsetattr(fd, termios.TCSADRAIN, settings)
added
removed
bzrlib/osutils.py
