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
22
from bzrlib.errors import BzrError
35
from bzrlib.errors import (BzrError,
36
BzrBadParameterNotUnicode,
23
41
from bzrlib.trace import mutter
42
import bzrlib.win32console
26
45
def make_readonly(filename):
27
46
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
47
mod = os.stat(filename).st_mode
30
48
mod = mod & 0777555
31
49
os.chmod(filename, mod)
76
105
raise BzrError('invalid file kind %r' % kind)
108
if hasattr(os.path, 'lexists'):
109
return os.path.lexists(f)
111
if hasattr(os, 'lstat'):
117
if e.errno == errno.ENOENT:
120
raise BzrError("lstat/stat of (%r): %r" % (f, e))
122
def fancy_rename(old, new, rename_func, unlink_func):
123
"""A fancy rename, when you don't have atomic rename.
125
:param old: The old path, to rename from
126
:param new: The new path, to rename to
127
:param rename_func: The potentially non-atomic rename function
128
:param unlink_func: A way to delete the target file if the full rename succeeds
131
# sftp rename doesn't allow overwriting, so play tricks:
133
base = os.path.basename(new)
134
dirname = os.path.dirname(new)
135
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
136
tmp_name = pathjoin(dirname, tmp_name)
138
# Rename the file out of the way, but keep track if it didn't exist
139
# We don't want to grab just any exception
140
# something like EACCES should prevent us from continuing
141
# The downside is that the rename_func has to throw an exception
142
# with an errno = ENOENT, or NoSuchFile
145
rename_func(new, tmp_name)
146
except (NoSuchFile,), e:
149
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
150
# function raises an IOError with errno == None when a rename fails.
151
# This then gets caught here.
152
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
155
if (not hasattr(e, 'errno')
156
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
163
# This may throw an exception, in which case success will
165
rename_func(old, new)
169
# If the file used to exist, rename it back into place
170
# otherwise just delete it from the tmp location
172
unlink_func(tmp_name)
174
rename_func(tmp_name, new)
176
# Default is to just use the python builtins, but these can be rebound on
177
# particular platforms.
178
abspath = os.path.abspath
179
realpath = os.path.realpath
180
pathjoin = os.path.join
181
normpath = os.path.normpath
183
mkdtemp = tempfile.mkdtemp
185
dirname = os.path.dirname
186
basename = os.path.basename
187
rmtree = shutil.rmtree
189
MIN_ABS_PATHLENGTH = 1
191
if os.name == "posix":
192
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
193
# choke on a Unicode string containing a relative path if
194
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
196
_fs_enc = sys.getfilesystemencoding()
198
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
201
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
203
if sys.platform == 'win32':
204
# We need to use the Unicode-aware os.path.abspath and
205
# os.path.realpath on Windows systems.
207
return os.path.abspath(path).replace('\\', '/')
210
return os.path.realpath(path).replace('\\', '/')
213
return os.path.join(*args).replace('\\', '/')
216
return os.path.normpath(path).replace('\\', '/')
219
return os.getcwdu().replace('\\', '/')
221
def mkdtemp(*args, **kwargs):
222
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
224
def rename(old, new):
225
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
227
MIN_ABS_PATHLENGTH = 3
229
def _win32_delete_readonly(function, path, excinfo):
230
"""Error handler for shutil.rmtree function [for win32]
231
Helps to remove files and dirs marked as read-only.
233
type_, value = excinfo[:2]
234
if function in (os.remove, os.rmdir) \
235
and type_ == OSError \
236
and value.errno == errno.EACCES:
237
bzrlib.osutils.make_writable(path)
242
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
243
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
244
return shutil.rmtree(path, ignore_errors, onerror)
247
def normalizepath(f):
248
if hasattr(os.path, 'realpath'):
252
[p,e] = os.path.split(f)
253
if e == "" or e == "." or e == "..":
256
return pathjoin(F(p), e)
80
259
def backup_file(fn):
303
"""True if f is a symlink."""
305
return S_ISLNK(os.lstat(f)[ST_MODE])
135
309
def is_inside(dir, fname):
136
310
"""True if fname is inside dir.
138
The parameters should typically be passed to os.path.normpath first, so
312
The parameters should typically be passed to osutils.normpath first, so
139
313
that . and .. and repeated slashes are eliminated, and the separators
140
314
are canonical for the platform.
142
316
The empty string as a dir name is taken as top-of-tree and matches
145
>>> is_inside('src', 'src/foo.c')
319
>>> is_inside('src', pathjoin('src', 'foo.c'))
147
321
>>> is_inside('src', 'srccontrol')
149
>>> is_inside('src', 'src/a/a/a/foo.c')
323
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
151
325
>>> is_inside('foo.c', 'foo.c')
223
406
'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
409
def compare_files(a, b):
330
410
"""Returns true if equal in contents"""
384
468
return os.fstat(f.fileno())[ST_SIZE]
387
if hasattr(os, 'urandom'): # python 2.4 and later
471
# Define rand_bytes based on platform.
473
# Python 2.4 and later have os.urandom,
474
# but it doesn't work on some arches
388
476
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))
477
except (NotImplementedError, AttributeError):
478
# If python doesn't have os.urandom, or it doesn't work,
479
# then try to first pull random data from /dev/urandom
480
if os.path.exists("/dev/urandom"):
481
rand_bytes = file('/dev/urandom', 'rb').read
482
# Otherwise, use this hack as a last resort
484
# not well seeded, but better than nothing
489
s += chr(random.randint(0, 255))
494
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
496
"""Return a random string of num alphanumeric characters
498
The result only contains lowercase chars because it may be used on
499
case-insensitive filesystems.
502
for raw_byte in rand_bytes(num):
503
s += ALNUM[ord(raw_byte) % 36]
402
507
## TODO: We could later have path objects that remember their list
440
545
if (f == '..') or (f == None) or (f == ''):
441
546
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
445
550
def appendpath(p1, p2):
449
return os.path.join(p1, p2)
554
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")
558
"""Split s into lines, but without removing the newline characters."""
559
lines = s.split('\n')
560
result = [line + '\n' for line in lines[:-1]]
562
result.append(lines[-1])
566
def hardlinks_good():
567
return sys.platform not in ('win32', 'cygwin', 'darwin')
570
def link_or_copy(src, dest):
571
"""Hardlink a file, or copy it if it can't be hardlinked."""
572
if not hardlinks_good():
577
except (OSError, IOError), e:
578
if e.errno != errno.EXDEV:
582
def delete_any(full_path):
583
"""Delete a file or directory."""
587
# We may be renaming a dangling inventory id
588
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
594
if hasattr(os, 'symlink'):
477
if os.name == "windows":
479
elif os.name == "posix":
600
def contains_whitespace(s):
601
"""True if there are any whitespace characters in s."""
602
for ch in string.whitespace:
609
def contains_linebreaks(s):
610
"""True if there is any vertical whitespace in s."""
618
def relpath(base, path):
619
"""Return path relative to base, or raise exception.
621
The path may be either an absolute path or a path relative to the
622
current working directory.
624
os.path.commonprefix (python2.4) has a bad bug that it works just
625
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
629
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
630
' exceed the platform minimum length (which is %d)' %
636
while len(head) >= len(base):
639
head, tail = os.path.split(head)
643
# XXX This should raise a NotChildPath exception, as its not tied
645
raise PathNotChild(rp, base)
653
def safe_unicode(unicode_or_utf8_string):
654
"""Coerce unicode_or_utf8_string into unicode.
656
If it is unicode, it is returned.
657
Otherwise it is decoded from utf-8. If a decoding error
658
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
659
as a BzrBadParameter exception.
661
if isinstance(unicode_or_utf8_string, unicode):
662
return unicode_or_utf8_string
664
return unicode_or_utf8_string.decode('utf8')
665
except UnicodeDecodeError:
666
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
669
def terminal_width():
670
"""Return estimated terminal width."""
671
if sys.platform == 'win32':
672
import bzrlib.win32console
673
return bzrlib.win32console.get_console_size()[0]
676
import struct, fcntl, termios
677
s = struct.pack('HHHH', 0, 0, 0, 0)
678
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
679
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)
684
width = int(os.environ['COLUMNS'])
692
def supports_executable():
693
return sys.platform != "win32"
696
def strip_trailing_slash(path):
697
"""Strip trailing slash, except for root paths.
698
The definition of 'root path' is platform-dependent.
700
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
706
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
709
def check_legal_path(path):
710
"""Check whether the supplied path is legal.
711
This is only required on Windows, so we don't test on other platforms
714
if sys.platform != "win32":
716
if _validWin32PathRE.match(path) is None:
717
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
