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 *
23
50
from bzrlib.trace import mutter
51
import bzrlib.win32console
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):
111
return _mapper(_lstat(f).st_mode)
68
114
def kind_marker(kind):
69
115
if kind == 'file':
71
elif kind == 'directory':
117
elif kind == _directory_kind:
73
119
elif kind == 'symlink':
76
122
raise BzrError('invalid file kind %r' % kind)
124
lexists = getattr(os.path, 'lexists', None)
128
if hasattr(os, 'lstat'):
134
if e.errno == errno.ENOENT:
137
raise BzrError("lstat/stat of (%r): %r" % (f, e))
140
def fancy_rename(old, new, rename_func, unlink_func):
141
"""A fancy rename, when you don't have atomic rename.
143
:param old: The old path, to rename from
144
:param new: The new path, to rename to
145
:param rename_func: The potentially non-atomic rename function
146
:param unlink_func: A way to delete the target file if the full rename succeeds
149
# sftp rename doesn't allow overwriting, so play tricks:
151
base = os.path.basename(new)
152
dirname = os.path.dirname(new)
153
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
154
tmp_name = pathjoin(dirname, tmp_name)
156
# Rename the file out of the way, but keep track if it didn't exist
157
# We don't want to grab just any exception
158
# something like EACCES should prevent us from continuing
159
# The downside is that the rename_func has to throw an exception
160
# with an errno = ENOENT, or NoSuchFile
163
rename_func(new, tmp_name)
164
except (NoSuchFile,), e:
167
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
168
# function raises an IOError with errno == None when a rename fails.
169
# This then gets caught here.
170
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
173
if (not hasattr(e, 'errno')
174
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
181
# This may throw an exception, in which case success will
183
rename_func(old, new)
187
# If the file used to exist, rename it back into place
188
# otherwise just delete it from the tmp location
190
unlink_func(tmp_name)
192
rename_func(tmp_name, new)
195
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
196
# choke on a Unicode string containing a relative path if
197
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
199
_fs_enc = sys.getfilesystemencoding()
200
def _posix_abspath(path):
201
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
202
# jam 20060426 This is another possibility which mimics
203
# os.path.abspath, only uses unicode characters instead
204
# if not os.path.isabs(path):
205
# return os.path.join(os.getcwdu(), path)
209
def _posix_realpath(path):
210
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
213
def _win32_abspath(path):
214
return _nt_abspath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
217
def _win32_realpath(path):
218
return _nt_realpath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
221
def _win32_pathjoin(*args):
222
return _nt_join(*args).replace('\\', '/')
225
def _win32_normpath(path):
226
return _nt_normpath(path).replace('\\', '/')
230
return os.getcwdu().replace('\\', '/')
233
def _win32_mkdtemp(*args, **kwargs):
234
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
237
def _win32_rename(old, new):
238
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
241
# Default is to just use the python builtins, but these can be rebound on
242
# particular platforms.
243
abspath = _posix_abspath
244
realpath = _posix_realpath
245
pathjoin = os.path.join
246
normpath = os.path.normpath
248
mkdtemp = tempfile.mkdtemp
250
dirname = os.path.dirname
251
basename = os.path.basename
252
rmtree = shutil.rmtree
254
MIN_ABS_PATHLENGTH = 1
257
if sys.platform == 'win32':
258
abspath = _win32_abspath
259
realpath = _win32_realpath
260
pathjoin = _win32_pathjoin
261
normpath = _win32_normpath
262
getcwd = _win32_getcwd
263
mkdtemp = _win32_mkdtemp
264
rename = _win32_rename
266
MIN_ABS_PATHLENGTH = 3
268
def _win32_delete_readonly(function, path, excinfo):
269
"""Error handler for shutil.rmtree function [for win32]
270
Helps to remove files and dirs marked as read-only.
272
type_, value = excinfo[:2]
273
if function in (os.remove, os.rmdir) \
274
and type_ == OSError \
275
and value.errno == errno.EACCES:
276
bzrlib.osutils.make_writable(path)
281
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
282
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
283
return shutil.rmtree(path, ignore_errors, onerror)
286
def normalizepath(f):
287
if hasattr(os.path, 'realpath'):
291
[p,e] = os.path.split(f)
292
if e == "" or e == "." or e == "..":
295
return pathjoin(F(p), e)
80
298
def backup_file(fn):
223
454
'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
457
def compare_files(a, b):
330
458
"""Returns true if equal in contents"""
440
593
if (f == '..') or (f == None) or (f == ''):
441
594
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
598
@deprecated_function(zero_nine)
445
599
def appendpath(p1, p2):
449
return os.path.join(p1, p2)
603
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")
607
"""Split s into lines, but without removing the newline characters."""
608
lines = s.split('\n')
609
result = [line + '\n' for line in lines[:-1]]
611
result.append(lines[-1])
615
def hardlinks_good():
616
return sys.platform not in ('win32', 'cygwin', 'darwin')
619
def link_or_copy(src, dest):
620
"""Hardlink a file, or copy it if it can't be hardlinked."""
621
if not hardlinks_good():
626
except (OSError, IOError), e:
627
if e.errno != errno.EXDEV:
631
def delete_any(full_path):
632
"""Delete a file or directory."""
636
# We may be renaming a dangling inventory id
637
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
643
if hasattr(os, 'symlink'):
477
if os.name == "windows":
479
elif os.name == "posix":
649
def contains_whitespace(s):
650
"""True if there are any whitespace characters in s."""
651
for ch in string.whitespace:
658
def contains_linebreaks(s):
659
"""True if there is any vertical whitespace in s."""
667
def relpath(base, path):
668
"""Return path relative to base, or raise exception.
670
The path may be either an absolute path or a path relative to the
671
current working directory.
673
os.path.commonprefix (python2.4) has a bad bug that it works just
674
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
678
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
679
' exceed the platform minimum length (which is %d)' %
686
while len(head) >= len(base):
689
head, tail = os.path.split(head)
693
raise PathNotChild(rp, base)
701
def safe_unicode(unicode_or_utf8_string):
702
"""Coerce unicode_or_utf8_string into unicode.
704
If it is unicode, it is returned.
705
Otherwise it is decoded from utf-8. If a decoding error
706
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
707
as a BzrBadParameter exception.
709
if isinstance(unicode_or_utf8_string, unicode):
710
return unicode_or_utf8_string
712
return unicode_or_utf8_string.decode('utf8')
713
except UnicodeDecodeError:
714
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
717
_platform_normalizes_filenames = False
718
if sys.platform == 'darwin':
719
_platform_normalizes_filenames = True
722
def normalizes_filenames():
723
"""Return True if this platform normalizes unicode filenames.
725
Mac OSX does, Windows/Linux do not.
727
return _platform_normalizes_filenames
730
if _platform_normalizes_filenames:
731
def unicode_filename(path):
732
"""Make sure 'path' is a properly normalized filename.
734
On platforms where the system normalizes filenames (Mac OSX),
735
you can access a file by any path which will normalize
737
Internally, bzr only supports NFC/NFKC normalization, since
738
that is the standard for XML documents.
739
So we return an normalized path, and indicate this has been
742
:return: (path, is_normalized) Return a path which can
743
access the file, and whether or not this path is
746
return unicodedata.normalize('NFKC', path), True
748
def unicode_filename(path):
749
"""Make sure 'path' is a properly normalized filename.
751
On platforms where the system does not normalize filenames
752
(Windows, Linux), you have to access a file by its exact path.
753
Internally, bzr only supports NFC/NFKC normalization, since
754
that is the standard for XML documents.
755
So we return the original path, and indicate if this is
758
:return: (path, is_normalized) Return a path which can
759
access the file, and whether or not this path is
762
return path, unicodedata.normalize('NFKC', path) == path
765
def terminal_width():
766
"""Return estimated terminal width."""
767
if sys.platform == 'win32':
768
import bzrlib.win32console
769
return bzrlib.win32console.get_console_size()[0]
772
import struct, fcntl, termios
773
s = struct.pack('HHHH', 0, 0, 0, 0)
774
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
775
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)
780
width = int(os.environ['COLUMNS'])
788
def supports_executable():
789
return sys.platform != "win32"
792
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
795
def check_legal_path(path):
796
"""Check whether the supplied path is legal.
797
This is only required on Windows, so we don't test on other platforms
800
if sys.platform != "win32":
802
if _validWin32PathRE.match(path) is None:
803
raise IllegalPath(path)
807
"""Yield data about all the directories in a tree.
809
This yields all the data about the contents of a directory at a time.
810
After each directory has been yielded, if the caller has mutated the list
811
to exclude some directories, they are then not descended into.
813
The data yielded is of the form:
814
[(relpath, basename, kind, lstat, path_from_top), ...]
816
:return: an iterator over the dirs.
820
_directory = _directory_kind
822
pending = [("", "", _directory, None, top)]
825
currentdir = pending.pop()
826
# 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
829
relroot = currentdir[0] + '/'
832
for name in sorted(_listdir(top)):
833
abspath = top + '/' + name
834
statvalue = lstat(abspath)
835
dirblock.append ((relroot + name, name, file_kind_from_stat_mode(statvalue.st_mode), statvalue, abspath))
837
# push the user specified dirs from dirblock
838
for dir in reversed(dirblock):
839
if dir[2] == _directory:
added
removed
bzrlib/osutils.py
