1
1
# Bazaar-NG -- distributed version control
3
3
# Copyright (C) 2005 by Canonical Ltd
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
13
# GNU General Public License for more details.
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
import os, types, re, time, errno, sys
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
19
from cStringIO import StringIO
22
from os import listdir
26
from shutil import copyfile
28
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
29
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
36
from ntpath import (abspath as _nt_abspath,
38
normpath as _nt_normpath,
39
realpath as _nt_realpath,
22
from bzrlib.errors import BzrError
43
from bzrlib.errors import (BzrError,
44
BzrBadParameterNotUnicode,
49
from bzrlib.symbol_versioning import (deprecated_function,
23
51
from bzrlib.trace import mutter
26
54
def make_readonly(filename):
27
55
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
56
mod = os.stat(filename).st_mode
30
57
mod = mod & 0777555
31
58
os.chmod(filename, mod)
47
73
This previously used backslash quoting, but that works poorly on
49
75
# TODO: I'm not really sure this is the best format either.x
78
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
50
80
if _QUOTE_RE.search(f):
51
81
return '"' + f + '"'
57
mode = os.lstat(f)[ST_MODE]
65
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
86
_directory_kind = 'directory'
89
stat.S_IFDIR:_directory_kind,
90
stat.S_IFCHR:'chardev',
94
stat.S_IFLNK:'symlink',
95
stat.S_IFSOCK:'socket',
99
def file_kind_from_stat_mode(stat_mode, _formats=_formats, _unknown='unknown'):
100
"""Generate a file kind from a stat mode. This is used in walkdirs.
102
Its performance is critical: Do not mutate without careful benchmarking.
105
return _formats[stat_mode & 0170000]
110
def file_kind(f, _lstat=os.lstat, _mapper=file_kind_from_stat_mode):
112
return _mapper(_lstat(f).st_mode)
114
if getattr(e, 'errno', None) == errno.ENOENT:
115
raise bzrlib.errors.NoSuchFile(f)
68
119
def kind_marker(kind):
69
120
if kind == 'file':
71
elif kind == 'directory':
122
elif kind == _directory_kind:
73
124
elif kind == 'symlink':
76
127
raise BzrError('invalid file kind %r' % kind)
129
lexists = getattr(os.path, 'lexists', None)
133
if hasattr(os, 'lstat'):
139
if e.errno == errno.ENOENT:
142
raise BzrError("lstat/stat of (%r): %r" % (f, e))
145
def fancy_rename(old, new, rename_func, unlink_func):
146
"""A fancy rename, when you don't have atomic rename.
148
:param old: The old path, to rename from
149
:param new: The new path, to rename to
150
:param rename_func: The potentially non-atomic rename function
151
:param unlink_func: A way to delete the target file if the full rename succeeds
154
# sftp rename doesn't allow overwriting, so play tricks:
156
base = os.path.basename(new)
157
dirname = os.path.dirname(new)
158
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
159
tmp_name = pathjoin(dirname, tmp_name)
161
# Rename the file out of the way, but keep track if it didn't exist
162
# We don't want to grab just any exception
163
# something like EACCES should prevent us from continuing
164
# The downside is that the rename_func has to throw an exception
165
# with an errno = ENOENT, or NoSuchFile
168
rename_func(new, tmp_name)
169
except (NoSuchFile,), e:
172
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
173
# function raises an IOError with errno == None when a rename fails.
174
# This then gets caught here.
175
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
178
if (not hasattr(e, 'errno')
179
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
186
# This may throw an exception, in which case success will
188
rename_func(old, new)
192
# If the file used to exist, rename it back into place
193
# otherwise just delete it from the tmp location
195
unlink_func(tmp_name)
197
rename_func(tmp_name, new)
200
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
201
# choke on a Unicode string containing a relative path if
202
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
204
_fs_enc = sys.getfilesystemencoding()
205
def _posix_abspath(path):
206
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
207
# jam 20060426 This is another possibility which mimics
208
# os.path.abspath, only uses unicode characters instead
209
# if not os.path.isabs(path):
210
# return os.path.join(os.getcwdu(), path)
214
def _posix_realpath(path):
215
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
218
def _win32_abspath(path):
219
return _nt_abspath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
222
def _win32_realpath(path):
223
return _nt_realpath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
226
def _win32_pathjoin(*args):
227
return _nt_join(*args).replace('\\', '/')
230
def _win32_normpath(path):
231
return _nt_normpath(path).replace('\\', '/')
235
return os.getcwdu().replace('\\', '/')
238
def _win32_mkdtemp(*args, **kwargs):
239
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
242
def _win32_rename(old, new):
243
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
246
# Default is to just use the python builtins, but these can be rebound on
247
# particular platforms.
248
abspath = _posix_abspath
249
realpath = _posix_realpath
250
pathjoin = os.path.join
251
normpath = os.path.normpath
253
mkdtemp = tempfile.mkdtemp
255
dirname = os.path.dirname
256
basename = os.path.basename
257
rmtree = shutil.rmtree
259
MIN_ABS_PATHLENGTH = 1
262
if sys.platform == 'win32':
263
abspath = _win32_abspath
264
realpath = _win32_realpath
265
pathjoin = _win32_pathjoin
266
normpath = _win32_normpath
267
getcwd = _win32_getcwd
268
mkdtemp = _win32_mkdtemp
269
rename = _win32_rename
271
MIN_ABS_PATHLENGTH = 3
273
def _win32_delete_readonly(function, path, excinfo):
274
"""Error handler for shutil.rmtree function [for win32]
275
Helps to remove files and dirs marked as read-only.
277
type_, value = excinfo[:2]
278
if function in (os.remove, os.rmdir) \
279
and type_ == OSError \
280
and value.errno == errno.EACCES:
281
bzrlib.osutils.make_writable(path)
286
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
287
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
288
return shutil.rmtree(path, ignore_errors, onerror)
291
def normalizepath(f):
292
if hasattr(os.path, 'realpath'):
296
[p,e] = os.path.split(f)
297
if e == "" or e == "." or e == "..":
300
return pathjoin(F(p), e)
80
303
def backup_file(fn):
223
459
'sha1': s.hexdigest()}
227
"""Return per-user configuration directory.
229
By default this is ~/.bzr.conf/
231
TODO: Global option --config-dir to override this.
233
return os.path.expanduser("~/.bzr.conf")
237
"""Calculate automatic user identification.
239
Returns (realname, email).
241
Only used when none is set in the environment or the id file.
243
This previously used the FQDN as the default domain, but that can
244
be very slow on machines where DNS is broken. So now we simply
249
# XXX: Any good way to get real user name on win32?
254
w = pwd.getpwuid(uid)
255
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
256
username = w.pw_name.decode(bzrlib.user_encoding)
257
comma = gecos.find(',')
261
realname = gecos[:comma]
267
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
269
return realname, (username + '@' + socket.gethostname())
273
"""Return the full user id from a file or environment variable.
275
TODO: Allow taking this from a file in the branch directory too
276
for per-branch ids."""
277
v = os.environ.get('BZREMAIL')
279
return v.decode(bzrlib.user_encoding)
282
return (open(os.path.join(config_dir(), "email"))
284
.decode(bzrlib.user_encoding)
287
if e.errno != errno.ENOENT:
290
v = os.environ.get('EMAIL')
292
return v.decode(bzrlib.user_encoding)
298
"""Return email-style username.
300
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
302
TODO: Check it's reasonably well-formed.
308
name, email = _auto_user_id()
310
return '%s <%s>' % (name, email)
315
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
317
"""Return just the email component of a username."""
320
m = _EMAIL_RE.search(e)
322
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
325
return _auto_user_id()[1]
329
462
def compare_files(a, b):
330
463
"""Returns true if equal in contents"""
440
598
if (f == '..') or (f == None) or (f == ''):
441
599
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
603
@deprecated_function(zero_nine)
445
604
def appendpath(p1, p2):
449
return os.path.join(p1, p2)
608
return pathjoin(p1, p2)
452
def extern_command(cmd, ignore_errors = False):
453
mutter('external command: %s' % `cmd`)
455
if not ignore_errors:
456
raise BzrError('command failed')
459
def _read_config_value(name):
460
"""Read a config value from the file ~/.bzr.conf/<name>
461
Return None if the file does not exist"""
463
f = file(os.path.join(config_dir(), name), "r")
464
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
466
if e.errno == errno.ENOENT:
472
"""Return a sequence of possible editor binaries for the current platform"""
473
e = _read_config_value("editor")
612
"""Split s into lines, but without removing the newline characters."""
613
lines = s.split('\n')
614
result = [line + '\n' for line in lines[:-1]]
616
result.append(lines[-1])
620
def hardlinks_good():
621
return sys.platform not in ('win32', 'cygwin', 'darwin')
624
def link_or_copy(src, dest):
625
"""Hardlink a file, or copy it if it can't be hardlinked."""
626
if not hardlinks_good():
631
except (OSError, IOError), e:
632
if e.errno != errno.EXDEV:
636
def delete_any(full_path):
637
"""Delete a file or directory."""
641
# We may be renaming a dangling inventory id
642
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
648
if hasattr(os, 'symlink'):
477
if os.name == "windows":
479
elif os.name == "posix":
654
def contains_whitespace(s):
655
"""True if there are any whitespace characters in s."""
656
for ch in string.whitespace:
663
def contains_linebreaks(s):
664
"""True if there is any vertical whitespace in s."""
672
def relpath(base, path):
673
"""Return path relative to base, or raise exception.
675
The path may be either an absolute path or a path relative to the
676
current working directory.
678
os.path.commonprefix (python2.4) has a bad bug that it works just
679
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
683
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
684
' exceed the platform minimum length (which is %d)' %
691
while len(head) >= len(base):
694
head, tail = os.path.split(head)
698
raise PathNotChild(rp, base)
706
def safe_unicode(unicode_or_utf8_string):
707
"""Coerce unicode_or_utf8_string into unicode.
709
If it is unicode, it is returned.
710
Otherwise it is decoded from utf-8. If a decoding error
711
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
712
as a BzrBadParameter exception.
714
if isinstance(unicode_or_utf8_string, unicode):
715
return unicode_or_utf8_string
717
return unicode_or_utf8_string.decode('utf8')
718
except UnicodeDecodeError:
719
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
722
_platform_normalizes_filenames = False
723
if sys.platform == 'darwin':
724
_platform_normalizes_filenames = True
727
def normalizes_filenames():
728
"""Return True if this platform normalizes unicode filenames.
730
Mac OSX does, Windows/Linux do not.
732
return _platform_normalizes_filenames
735
if _platform_normalizes_filenames:
736
def unicode_filename(path):
737
"""Make sure 'path' is a properly normalized filename.
739
On platforms where the system normalizes filenames (Mac OSX),
740
you can access a file by any path which will normalize
742
Internally, bzr only supports NFC/NFKC normalization, since
743
that is the standard for XML documents.
744
So we return an normalized path, and indicate this has been
747
:return: (path, is_normalized) Return a path which can
748
access the file, and whether or not this path is
751
return unicodedata.normalize('NFKC', path), True
753
def unicode_filename(path):
754
"""Make sure 'path' is a properly normalized filename.
756
On platforms where the system does not normalize filenames
757
(Windows, Linux), you have to access a file by its exact path.
758
Internally, bzr only supports NFC/NFKC normalization, since
759
that is the standard for XML documents.
760
So we return the original path, and indicate if this is
763
:return: (path, is_normalized) Return a path which can
764
access the file, and whether or not this path is
767
return path, unicodedata.normalize('NFKC', path) == path
770
def terminal_width():
771
"""Return estimated terminal width."""
772
if sys.platform == 'win32':
773
import bzrlib.win32console
774
return bzrlib.win32console.get_console_size()[0]
777
import struct, fcntl, termios
778
s = struct.pack('HHHH', 0, 0, 0, 0)
779
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
780
width = struct.unpack('HHHH', x)[1]
481
yield os.environ["EDITOR"]
486
def _run_editor(filename):
487
"""Try to execute an editor to edit the commit message. Returns True on success,
489
for e in _get_editor():
490
x = os.spawnvp(os.P_WAIT, e, (e, filename))
497
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
501
def get_text_message(infotext, ignoreline = "default"):
504
if ignoreline == "default":
505
ignoreline = "-- This line and the following will be ignored --"
508
tmp_fileno, msgfilename = tempfile.mkstemp()
509
msgfile = os.close(tmp_fileno)
510
if infotext is not None and infotext != "":
512
msgfile = file(msgfilename, "w")
513
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
518
if not _run_editor(msgfilename):
523
lastline, nlines = 0, 0
524
for line in file(msgfilename, "r"):
525
stripped_line = line.strip()
526
# strip empty line before the log message starts
528
if stripped_line != "":
532
# check for the ignore line only if there
533
# is additional information at the end
534
if hasinfo and stripped_line == ignoreline:
537
# keep track of the last line that had some content
538
if stripped_line != "":
544
# delete empty lines at the end
546
# add a newline at the end, if needed
547
if not msg[-1].endswith("\n"):
548
return "%s%s" % ("".join(msg), "\n")
552
# delete the msg file in any case
553
try: os.unlink(msgfilename)
785
width = int(os.environ['COLUMNS'])
793
def supports_executable():
794
return sys.platform != "win32"
797
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
800
def check_legal_path(path):
801
"""Check whether the supplied path is legal.
802
This is only required on Windows, so we don't test on other platforms
805
if sys.platform != "win32":
807
if _validWin32PathRE.match(path) is None:
808
raise IllegalPath(path)
811
def walkdirs(top, prefix=""):
812
"""Yield data about all the directories in a tree.
814
This yields all the data about the contents of a directory at a time.
815
After each directory has been yielded, if the caller has mutated the list
816
to exclude some directories, they are then not descended into.
818
The data yielded is of the form:
819
[(relpath, basename, kind, lstat, path_from_top), ...]
821
:param prefix: Prefix the relpaths that are yielded with 'prefix'. This
822
allows one to walk a subtree but get paths that are relative to a tree
824
:return: an iterator over the dirs.
828
_directory = _directory_kind
830
pending = [(prefix, "", _directory, None, top)]
833
currentdir = pending.pop()
834
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
837
relroot = currentdir[0] + '/'
840
for name in sorted(_listdir(top)):
841
abspath = top + '/' + name
842
statvalue = lstat(abspath)
843
dirblock.append ((relroot + name, name, file_kind_from_stat_mode(statvalue.st_mode), statvalue, abspath))
845
# push the user specified dirs from dirblock
846
for dir in reversed(dirblock):
847
if dir[2] == _directory:
added
removed
bzrlib/osutils.py
