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 shutil import copyfile
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
from cStringIO import StringIO
35
from ntpath import (abspath as _nt_abspath,
37
normpath as _nt_normpath,
38
realpath as _nt_realpath,
22
from bzrlib.errors import BzrError
42
from bzrlib.errors import (BzrError,
43
BzrBadParameterNotUnicode,
48
from bzrlib.symbol_versioning import *
23
49
from bzrlib.trace import mutter
50
import bzrlib.win32console
26
53
def make_readonly(filename):
27
54
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
55
mod = os.stat(filename).st_mode
30
56
mod = mod & 0777555
31
57
os.chmod(filename, mod)
76
109
raise BzrError('invalid file kind %r' % kind)
111
lexists = getattr(os.path, 'lexists', None)
115
if hasattr(os, 'lstat'):
121
if e.errno == errno.ENOENT:
124
raise BzrError("lstat/stat of (%r): %r" % (f, e))
127
def fancy_rename(old, new, rename_func, unlink_func):
128
"""A fancy rename, when you don't have atomic rename.
130
:param old: The old path, to rename from
131
:param new: The new path, to rename to
132
:param rename_func: The potentially non-atomic rename function
133
:param unlink_func: A way to delete the target file if the full rename succeeds
136
# sftp rename doesn't allow overwriting, so play tricks:
138
base = os.path.basename(new)
139
dirname = os.path.dirname(new)
140
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
141
tmp_name = pathjoin(dirname, tmp_name)
143
# Rename the file out of the way, but keep track if it didn't exist
144
# We don't want to grab just any exception
145
# something like EACCES should prevent us from continuing
146
# The downside is that the rename_func has to throw an exception
147
# with an errno = ENOENT, or NoSuchFile
150
rename_func(new, tmp_name)
151
except (NoSuchFile,), e:
154
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
155
# function raises an IOError with errno == None when a rename fails.
156
# This then gets caught here.
157
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
160
if (not hasattr(e, 'errno')
161
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
168
# This may throw an exception, in which case success will
170
rename_func(old, new)
174
# If the file used to exist, rename it back into place
175
# otherwise just delete it from the tmp location
177
unlink_func(tmp_name)
179
rename_func(tmp_name, new)
182
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
183
# choke on a Unicode string containing a relative path if
184
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
186
_fs_enc = sys.getfilesystemencoding()
187
def _posix_abspath(path):
188
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
189
# jam 20060426 This is another possibility which mimics
190
# os.path.abspath, only uses unicode characters instead
191
# if not os.path.isabs(path):
192
# return os.path.join(os.getcwdu(), path)
196
def _posix_realpath(path):
197
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
200
def _win32_abspath(path):
201
return _nt_abspath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
204
def _win32_realpath(path):
205
return _nt_realpath(path.encode(_fs_enc)).decode(_fs_enc).replace('\\', '/')
208
def _win32_pathjoin(*args):
209
return _nt_join(*args).replace('\\', '/')
212
def _win32_normpath(path):
213
return _nt_normpath(path).replace('\\', '/')
217
return os.getcwdu().replace('\\', '/')
220
def _win32_mkdtemp(*args, **kwargs):
221
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
224
def _win32_rename(old, new):
225
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
228
# Default is to just use the python builtins, but these can be rebound on
229
# particular platforms.
230
abspath = _posix_abspath
231
realpath = _posix_realpath
232
pathjoin = os.path.join
233
normpath = os.path.normpath
235
mkdtemp = tempfile.mkdtemp
237
dirname = os.path.dirname
238
basename = os.path.basename
239
rmtree = shutil.rmtree
241
MIN_ABS_PATHLENGTH = 1
244
if sys.platform == 'win32':
245
abspath = _win32_abspath
246
realpath = _win32_realpath
247
pathjoin = _win32_pathjoin
248
normpath = _win32_normpath
249
getcwd = _win32_getcwd
250
mkdtemp = _win32_mkdtemp
251
rename = _win32_rename
253
MIN_ABS_PATHLENGTH = 3
255
def _win32_delete_readonly(function, path, excinfo):
256
"""Error handler for shutil.rmtree function [for win32]
257
Helps to remove files and dirs marked as read-only.
259
type_, value = excinfo[:2]
260
if function in (os.remove, os.rmdir) \
261
and type_ == OSError \
262
and value.errno == errno.EACCES:
263
bzrlib.osutils.make_writable(path)
268
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
269
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
270
return shutil.rmtree(path, ignore_errors, onerror)
273
def normalizepath(f):
274
if hasattr(os.path, 'realpath'):
278
[p,e] = os.path.split(f)
279
if e == "" or e == "." or e == "..":
282
return pathjoin(F(p), e)
80
285
def backup_file(fn):
223
441
'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
444
def compare_files(a, b):
330
445
"""Returns true if equal in contents"""
384
503
return os.fstat(f.fileno())[ST_SIZE]
387
if hasattr(os, 'urandom'): # python 2.4 and later
506
# Define rand_bytes based on platform.
508
# Python 2.4 and later have os.urandom,
509
# but it doesn't work on some arches
388
511
rand_bytes = os.urandom
389
elif sys.platform == 'linux2':
390
rand_bytes = file('/dev/urandom', 'rb').read
392
# not well seeded, but better than nothing
397
s += chr(random.randint(0, 255))
512
except (NotImplementedError, AttributeError):
513
# If python doesn't have os.urandom, or it doesn't work,
514
# then try to first pull random data from /dev/urandom
515
if os.path.exists("/dev/urandom"):
516
rand_bytes = file('/dev/urandom', 'rb').read
517
# Otherwise, use this hack as a last resort
519
# not well seeded, but better than nothing
524
s += chr(random.randint(0, 255))
529
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
531
"""Return a random string of num alphanumeric characters
533
The result only contains lowercase chars because it may be used on
534
case-insensitive filesystems.
537
for raw_byte in rand_bytes(num):
538
s += ALNUM[ord(raw_byte) % 36]
402
542
## TODO: We could later have path objects that remember their list
440
580
if (f == '..') or (f == None) or (f == ''):
441
581
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
585
@deprecated_function(zero_nine)
445
586
def appendpath(p1, p2):
449
return os.path.join(p1, p2)
590
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")
594
"""Split s into lines, but without removing the newline characters."""
595
lines = s.split('\n')
596
result = [line + '\n' for line in lines[:-1]]
598
result.append(lines[-1])
602
def hardlinks_good():
603
return sys.platform not in ('win32', 'cygwin', 'darwin')
606
def link_or_copy(src, dest):
607
"""Hardlink a file, or copy it if it can't be hardlinked."""
608
if not hardlinks_good():
613
except (OSError, IOError), e:
614
if e.errno != errno.EXDEV:
618
def delete_any(full_path):
619
"""Delete a file or directory."""
623
# We may be renaming a dangling inventory id
624
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
630
if hasattr(os, 'symlink'):
477
if os.name == "windows":
479
elif os.name == "posix":
636
def contains_whitespace(s):
637
"""True if there are any whitespace characters in s."""
638
for ch in string.whitespace:
645
def contains_linebreaks(s):
646
"""True if there is any vertical whitespace in s."""
654
def relpath(base, path):
655
"""Return path relative to base, or raise exception.
657
The path may be either an absolute path or a path relative to the
658
current working directory.
660
os.path.commonprefix (python2.4) has a bad bug that it works just
661
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
665
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
666
' exceed the platform minimum length (which is %d)' %
673
while len(head) >= len(base):
676
head, tail = os.path.split(head)
680
raise PathNotChild(rp, base)
688
def safe_unicode(unicode_or_utf8_string):
689
"""Coerce unicode_or_utf8_string into unicode.
691
If it is unicode, it is returned.
692
Otherwise it is decoded from utf-8. If a decoding error
693
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
694
as a BzrBadParameter exception.
696
if isinstance(unicode_or_utf8_string, unicode):
697
return unicode_or_utf8_string
699
return unicode_or_utf8_string.decode('utf8')
700
except UnicodeDecodeError:
701
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
704
_platform_normalizes_filenames = False
705
if sys.platform == 'darwin':
706
_platform_normalizes_filenames = True
709
def normalizes_filenames():
710
"""Return True if this platform normalizes unicode filenames.
712
Mac OSX does, Windows/Linux do not.
714
return _platform_normalizes_filenames
717
if _platform_normalizes_filenames:
718
def unicode_filename(path):
719
"""Make sure 'path' is a properly normalized filename.
721
On platforms where the system normalizes filenames (Mac OSX),
722
you can access a file by any path which will normalize
724
Internally, bzr only supports NFC/NFKC normalization, since
725
that is the standard for XML documents.
726
So we return an normalized path, and indicate this has been
729
:return: (path, is_normalized) Return a path which can
730
access the file, and whether or not this path is
733
return unicodedata.normalize('NFKC', path), True
735
def unicode_filename(path):
736
"""Make sure 'path' is a properly normalized filename.
738
On platforms where the system does not normalize filenames
739
(Windows, Linux), you have to access a file by its exact path.
740
Internally, bzr only supports NFC/NFKC normalization, since
741
that is the standard for XML documents.
742
So we return the original path, and indicate if this is
745
:return: (path, is_normalized) Return a path which can
746
access the file, and whether or not this path is
749
return path, unicodedata.normalize('NFKC', path) == path
752
def terminal_width():
753
"""Return estimated terminal width."""
754
if sys.platform == 'win32':
755
import bzrlib.win32console
756
return bzrlib.win32console.get_console_size()[0]
759
import struct, fcntl, termios
760
s = struct.pack('HHHH', 0, 0, 0, 0)
761
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
762
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)
767
width = int(os.environ['COLUMNS'])
775
def supports_executable():
776
return sys.platform != "win32"
779
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
782
def check_legal_path(path):
783
"""Check whether the supplied path is legal.
784
This is only required on Windows, so we don't test on other platforms
787
if sys.platform != "win32":
789
if _validWin32PathRE.match(path) is None:
790
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
