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
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
19
import os, types, re, time, errno, sys
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
34
from bzrlib.errors import (BzrError,
35
BzrBadParameterNotUnicode,
40
from bzrlib.trace import mutter
43
26
def make_readonly(filename):
44
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
45
29
mod = os.stat(filename).st_mode
46
30
mod = mod & 0777555
47
31
os.chmod(filename, mod)
103
73
raise BzrError('invalid file kind %r' % kind)
106
if hasattr(os.path, 'lexists'):
107
return os.path.lexists(f)
109
if hasattr(os, 'lstat'):
115
if e.errno == errno.ENOENT:
118
raise BzrError("lstat/stat of (%r): %r" % (f, e))
120
def fancy_rename(old, new, rename_func, unlink_func):
121
"""A fancy rename, when you don't have atomic rename.
123
:param old: The old path, to rename from
124
:param new: The new path, to rename to
125
:param rename_func: The potentially non-atomic rename function
126
:param unlink_func: A way to delete the target file if the full rename succeeds
129
# sftp rename doesn't allow overwriting, so play tricks:
131
base = os.path.basename(new)
132
dirname = os.path.dirname(new)
133
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
134
tmp_name = pathjoin(dirname, tmp_name)
136
# Rename the file out of the way, but keep track if it didn't exist
137
# We don't want to grab just any exception
138
# something like EACCES should prevent us from continuing
139
# The downside is that the rename_func has to throw an exception
140
# with an errno = ENOENT, or NoSuchFile
143
rename_func(new, tmp_name)
144
except (NoSuchFile,), e:
147
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
148
# function raises an IOError with errno == None when a rename fails.
149
# This then gets caught here.
150
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
153
if (not hasattr(e, 'errno')
154
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
161
# This may throw an exception, in which case success will
163
rename_func(old, new)
167
# If the file used to exist, rename it back into place
168
# otherwise just delete it from the tmp location
170
unlink_func(tmp_name)
172
rename_func(tmp_name, new)
174
# Default is to just use the python builtins
175
abspath = os.path.abspath
176
realpath = os.path.realpath
177
pathjoin = os.path.join
178
normpath = os.path.normpath
180
mkdtemp = tempfile.mkdtemp
182
dirname = os.path.dirname
183
basename = os.path.basename
185
MIN_ABS_PATHLENGTH = 1
187
if os.name == "posix":
188
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
189
# choke on a Unicode string containing a relative path if
190
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
192
_fs_enc = sys.getfilesystemencoding()
194
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
197
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
199
if sys.platform == 'win32':
200
# We need to use the Unicode-aware os.path.abspath and
201
# os.path.realpath on Windows systems.
203
return os.path.abspath(path).replace('\\', '/')
206
return os.path.realpath(path).replace('\\', '/')
209
return os.path.join(*args).replace('\\', '/')
212
return os.path.normpath(path).replace('\\', '/')
215
return os.getcwdu().replace('\\', '/')
217
def mkdtemp(*args, **kwargs):
218
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
220
def rename(old, new):
221
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
223
MIN_ABS_PATHLENGTH = 3
225
def normalizepath(f):
226
if hasattr(os.path, 'realpath'):
230
[p,e] = os.path.split(f)
231
if e == "" or e == "." or e == "..":
234
return pathjoin(F(p), e)
237
77
def backup_file(fn):
281
"""True if f is a symlink."""
283
return S_ISLNK(os.lstat(f)[ST_MODE])
287
121
def is_inside(dir, fname):
288
122
"""True if fname is inside dir.
290
The parameters should typically be passed to osutils.normpath first, so
291
that . and .. and repeated slashes are eliminated, and the separators
292
are canonical for the platform.
294
The empty string as a dir name is taken as top-of-tree and matches
297
>>> is_inside('src', pathjoin('src', 'foo.c'))
299
>>> is_inside('src', 'srccontrol')
301
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
303
>>> is_inside('foo.c', 'foo.c')
305
>>> is_inside('foo.c', '')
307
>>> is_inside('', 'foo.c')
310
# XXX: Most callers of this can actually do something smarter by
311
# looking at the inventory
321
return fname.startswith(dir)
124
return os.path.commonprefix([dir, fname]) == dir
324
127
def is_inside_any(dir_list, fname):
325
128
"""True if fname is inside any of given dirs."""
129
# quick scan for perfect match
130
if fname in dir_list:
326
133
for dirname in dir_list:
327
134
if is_inside(dirname, fname):
384
182
'sha1': s.hexdigest()}
186
"""Return per-user configuration directory.
188
By default this is ~/.bzr.conf/
190
TODO: Global option --config-dir to override this.
192
return os.path.expanduser("~/.bzr.conf")
196
"""Calculate automatic user identification.
198
Returns (realname, email).
200
Only used when none is set in the environment or the id file.
202
This previously used the FQDN as the default domain, but that can
203
be very slow on machines where DNS is broken. So now we simply
208
# XXX: Any good way to get real user name on win32?
213
w = pwd.getpwuid(uid)
214
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
215
username = w.pw_name.decode(bzrlib.user_encoding)
216
comma = gecos.find(',')
220
realname = gecos[:comma]
226
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
228
return realname, (username + '@' + socket.gethostname())
232
"""Return the full user id from a file or environment variable.
234
TODO: Allow taking this from a file in the branch directory too
235
for per-branch ids."""
236
v = os.environ.get('BZREMAIL')
238
return v.decode(bzrlib.user_encoding)
241
return (open(os.path.join(config_dir(), "email"))
243
.decode(bzrlib.user_encoding)
246
if e.errno != errno.ENOENT:
249
v = os.environ.get('EMAIL')
251
return v.decode(bzrlib.user_encoding)
257
"""Return email-style username.
259
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
261
TODO: Check it's reasonably well-formed.
267
name, email = _auto_user_id()
269
return '%s <%s>' % (name, email)
274
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
276
"""Return just the email component of a username."""
279
m = _EMAIL_RE.search(e)
281
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
284
return _auto_user_id()[1]
387
288
def compare_files(a, b):
388
289
"""Returns true if equal in contents"""
446
343
return os.fstat(f.fileno())[ST_SIZE]
449
# Define rand_bytes based on platform.
451
# Python 2.4 and later have os.urandom,
452
# but it doesn't work on some arches
346
if hasattr(os, 'urandom'): # python 2.4 and later
454
347
rand_bytes = os.urandom
455
except (NotImplementedError, AttributeError):
456
# If python doesn't have os.urandom, or it doesn't work,
457
# then try to first pull random data from /dev/urandom
458
if os.path.exists("/dev/urandom"):
459
rand_bytes = file('/dev/urandom', 'rb').read
460
# Otherwise, use this hack as a last resort
462
# not well seeded, but better than nothing
467
s += chr(random.randint(0, 255))
472
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
474
"""Return a random string of num alphanumeric characters
476
The result only contains lowercase chars because it may be used on
477
case-insensitive filesystems.
480
for raw_byte in rand_bytes(num):
481
s += ALNUM[ord(raw_byte) % 36]
348
elif sys.platform == 'linux2':
349
rand_bytes = file('/dev/urandom', 'rb').read
351
# not well seeded, but better than nothing
356
s += chr(random.randint(0, 255))
485
361
## TODO: We could later have path objects that remember their list
523
399
if (f == '..') or (f == None) or (f == ''):
524
400
raise BzrError("sorry, %r not allowed in path" % f)
401
return os.path.join(*p)
528
404
def appendpath(p1, p2):
532
return pathjoin(p1, p2)
408
return os.path.join(p1, p2)
536
"""Split s into lines, but without removing the newline characters."""
537
lines = s.split('\n')
538
result = [line + '\n' for line in lines[:-1]]
540
result.append(lines[-1])
544
def hardlinks_good():
545
return sys.platform not in ('win32', 'cygwin', 'darwin')
548
def link_or_copy(src, dest):
549
"""Hardlink a file, or copy it if it can't be hardlinked."""
550
if not hardlinks_good():
555
except (OSError, IOError), e:
556
if e.errno != errno.EXDEV:
560
def delete_any(full_path):
561
"""Delete a file or directory."""
565
# We may be renaming a dangling inventory id
566
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
572
if hasattr(os, 'symlink'):
411
def extern_command(cmd, ignore_errors = False):
412
mutter('external command: %s' % `cmd`)
414
if not ignore_errors:
415
raise BzrError('command failed')
418
def _read_config_value(name):
419
"""Read a config value from the file ~/.bzr.conf/<name>
420
Return None if the file does not exist"""
422
f = file(os.path.join(config_dir(), name), "r")
423
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
425
if e.errno == errno.ENOENT:
431
"""Return a sequence of possible editor binaries for the current platform"""
432
e = _read_config_value("editor")
578
def contains_whitespace(s):
579
"""True if there are any whitespace characters in s."""
580
for ch in string.whitespace:
587
def contains_linebreaks(s):
588
"""True if there is any vertical whitespace in s."""
596
def relpath(base, path):
597
"""Return path relative to base, or raise exception.
599
The path may be either an absolute path or a path relative to the
600
current working directory.
602
os.path.commonprefix (python2.4) has a bad bug that it works just
603
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
607
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
608
' exceed the platform minimum length (which is %d)' %
614
while len(head) >= len(base):
436
if os.name == "windows":
438
elif os.name == "posix":
440
yield os.environ["EDITOR"]
445
def _run_editor(filename):
446
"""Try to execute an editor to edit the commit message. Returns True on success,
448
for e in _get_editor():
449
x = os.spawnvp(os.P_WAIT, e, (e, filename))
617
head, tail = os.path.split(head)
621
# XXX This should raise a NotChildPath exception, as its not tied
623
raise PathNotChild(rp, base)
631
def safe_unicode(unicode_or_utf8_string):
632
"""Coerce unicode_or_utf8_string into unicode.
634
If it is unicode, it is returned.
635
Otherwise it is decoded from utf-8. If a decoding error
636
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
637
as a BzrBadParameter exception.
639
if isinstance(unicode_or_utf8_string, unicode):
640
return unicode_or_utf8_string
642
return unicode_or_utf8_string.decode('utf8')
643
except UnicodeDecodeError:
644
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
647
def terminal_width():
648
"""Return estimated terminal width."""
650
# TODO: Do something smart on Windows?
652
# TODO: Is there anything that gets a better update when the window
653
# is resized while the program is running? We could use the Python termcap
656
return int(os.environ['COLUMNS'])
657
except (IndexError, KeyError, ValueError):
660
def supports_executable():
661
return sys.platform != "win32"
664
def strip_trailing_slash(path):
665
"""Strip trailing slash, except for root paths.
666
The definition of 'root path' is platform-dependent.
668
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
674
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
677
def check_legal_path(path):
678
"""Check whether the supplied path is legal.
679
This is only required on Windows, so we don't test on other platforms
682
if sys.platform != "win32":
684
if _validWin32PathRE.match(path) is None:
685
raise IllegalPath(path)
456
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
460
def get_text_message(infotext, ignoreline = "default"):
463
if ignoreline == "default":
464
ignoreline = "-- This line and the following will be ignored --"
467
tmp_fileno, msgfilename = tempfile.mkstemp()
468
msgfile = os.close(tmp_fileno)
469
if infotext is not None and infotext != "":
471
msgfile = file(msgfilename, "w")
472
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
477
if not _run_editor(msgfilename):
482
lastline, nlines = 0, 0
483
for line in file(msgfilename, "r"):
484
stripped_line = line.strip()
485
# strip empty line before the log message starts
487
if stripped_line != "":
491
# check for the ignore line only if there
492
# is additional information at the end
493
if hasinfo and stripped_line == ignoreline:
496
# keep track of the last line that had some content
497
if stripped_line != "":
503
# delete empty lines at the end
505
# add a newline at the end, if needed
506
if not msg[-1].endswith("\n"):
507
return "%s%s" % ("".join(msg), "\n")
511
# delete the msg file in any case
512
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
