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,
39
from bzrlib.trace import mutter
42
26
def make_readonly(filename):
43
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
44
29
mod = os.stat(filename).st_mode
45
30
mod = mod & 0777555
46
31
os.chmod(filename, mod)
102
76
raise BzrError('invalid file kind %r' % kind)
105
if hasattr(os.path, 'lexists'):
106
return os.path.lexists(f)
108
if hasattr(os, 'lstat'):
114
if e.errno == errno.ENOENT:
117
raise BzrError("lstat/stat of (%r): %r" % (f, e))
119
def fancy_rename(old, new, rename_func, unlink_func):
120
"""A fancy rename, when you don't have atomic rename.
122
:param old: The old path, to rename from
123
:param new: The new path, to rename to
124
:param rename_func: The potentially non-atomic rename function
125
:param unlink_func: A way to delete the target file if the full rename succeeds
128
# sftp rename doesn't allow overwriting, so play tricks:
130
base = os.path.basename(new)
131
dirname = os.path.dirname(new)
132
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
133
tmp_name = pathjoin(dirname, tmp_name)
135
# Rename the file out of the way, but keep track if it didn't exist
136
# We don't want to grab just any exception
137
# something like EACCES should prevent us from continuing
138
# The downside is that the rename_func has to throw an exception
139
# with an errno = ENOENT, or NoSuchFile
142
rename_func(new, tmp_name)
143
except (NoSuchFile,), e:
146
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
# function raises an IOError with errno == None when a rename fails.
148
# This then gets caught here.
149
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
152
if (not hasattr(e, 'errno')
153
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
160
# This may throw an exception, in which case success will
162
rename_func(old, new)
166
# If the file used to exist, rename it back into place
167
# otherwise just delete it from the tmp location
169
unlink_func(tmp_name)
171
rename_func(tmp_name, new)
173
# Default is to just use the python builtins
174
abspath = os.path.abspath
175
realpath = os.path.realpath
176
pathjoin = os.path.join
177
normpath = os.path.normpath
179
mkdtemp = tempfile.mkdtemp
181
dirname = os.path.dirname
182
basename = os.path.basename
184
if os.name == "posix":
185
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
# choke on a Unicode string containing a relative path if
187
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
189
_fs_enc = sys.getfilesystemencoding()
191
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
194
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
196
if sys.platform == 'win32':
197
# We need to use the Unicode-aware os.path.abspath and
198
# os.path.realpath on Windows systems.
200
return os.path.abspath(path).replace('\\', '/')
203
return os.path.realpath(path).replace('\\', '/')
206
return os.path.join(*args).replace('\\', '/')
209
return os.path.normpath(path).replace('\\', '/')
212
return os.getcwdu().replace('\\', '/')
214
def mkdtemp(*args, **kwargs):
215
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
217
def rename(old, new):
218
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
221
def normalizepath(f):
222
if hasattr(os.path, 'realpath'):
226
[p,e] = os.path.split(f)
227
if e == "" or e == "." or e == "..":
230
return pathjoin(F(p), e)
233
80
def backup_file(fn):
277
"""True if f is a symlink."""
279
return S_ISLNK(os.lstat(f)[ST_MODE])
283
135
def is_inside(dir, fname):
284
136
"""True if fname is inside dir.
286
The parameters should typically be passed to osutils.normpath first, so
138
The parameters should typically be passed to os.path.normpath first, so
287
139
that . and .. and repeated slashes are eliminated, and the separators
288
140
are canonical for the platform.
290
142
The empty string as a dir name is taken as top-of-tree and matches
293
>>> is_inside('src', pathjoin('src', 'foo.c'))
145
>>> is_inside('src', 'src/foo.c')
295
147
>>> is_inside('src', 'srccontrol')
297
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
149
>>> is_inside('src', 'src/a/a/a/foo.c')
299
151
>>> is_inside('foo.c', 'foo.c')
380
223
'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]
383
329
def compare_files(a, b):
384
330
"""Returns true if equal in contents"""
442
384
return os.fstat(f.fileno())[ST_SIZE]
445
# Define rand_bytes based on platform.
447
# Python 2.4 and later have os.urandom,
448
# but it doesn't work on some arches
387
if hasattr(os, 'urandom'): # python 2.4 and later
450
388
rand_bytes = os.urandom
451
except (NotImplementedError, AttributeError):
452
# If python doesn't have os.urandom, or it doesn't work,
453
# then try to first pull random data from /dev/urandom
454
if os.path.exists("/dev/urandom"):
455
rand_bytes = file('/dev/urandom', 'rb').read
456
# Otherwise, use this hack as a last resort
458
# not well seeded, but better than nothing
463
s += chr(random.randint(0, 255))
468
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
470
"""Return a random string of num alphanumeric characters
472
The result only contains lowercase chars because it may be used on
473
case-insensitive filesystems.
476
for raw_byte in rand_bytes(num):
477
s += ALNUM[ord(raw_byte) % 36]
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))
481
402
## TODO: We could later have path objects that remember their list
519
440
if (f == '..') or (f == None) or (f == ''):
520
441
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
524
445
def appendpath(p1, p2):
528
return pathjoin(p1, p2)
449
return os.path.join(p1, p2)
532
"""Split s into lines, but without removing the newline characters."""
533
return StringIO(s).readlines()
536
def hardlinks_good():
537
return sys.platform not in ('win32', 'cygwin', 'darwin')
540
def link_or_copy(src, dest):
541
"""Hardlink a file, or copy it if it can't be hardlinked."""
542
if not hardlinks_good():
547
except (OSError, IOError), e:
548
if e.errno != errno.EXDEV:
552
def delete_any(full_path):
553
"""Delete a file or directory."""
557
# We may be renaming a dangling inventory id
558
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
564
if hasattr(os, 'symlink'):
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")
570
def contains_whitespace(s):
571
"""True if there are any whitespace characters in s."""
572
for ch in string.whitespace:
579
def contains_linebreaks(s):
580
"""True if there is any vertical whitespace in s."""
588
def relpath(base, path):
589
"""Return path relative to base, or raise exception.
591
The path may be either an absolute path or a path relative to the
592
current working directory.
594
os.path.commonprefix (python2.4) has a bad bug that it works just
595
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
598
if sys.platform != "win32":
602
assert len(base) >= minlength, ('Length of base must be equal or exceed the'
603
' platform minimum length (which is %d)' % minlength)
608
while len(head) >= len(base):
477
if os.name == "windows":
479
elif os.name == "posix":
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))
611
head, tail = os.path.split(head)
615
# XXX This should raise a NotChildPath exception, as its not tied
617
raise PathNotChild(rp, base)
625
def safe_unicode(unicode_or_utf8_string):
626
"""Coerce unicode_or_utf8_string into unicode.
628
If it is unicode, it is returned.
629
Otherwise it is decoded from utf-8. If a decoding error
630
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
631
as a BzrBadParameter exception.
633
if isinstance(unicode_or_utf8_string, unicode):
634
return unicode_or_utf8_string
636
return unicode_or_utf8_string.decode('utf8')
637
except UnicodeDecodeError:
638
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
641
def terminal_width():
642
"""Return estimated terminal width."""
644
# TODO: Do something smart on Windows?
646
# TODO: Is there anything that gets a better update when the window
647
# is resized while the program is running? We could use the Python termcap
650
return int(os.environ['COLUMNS'])
651
except (IndexError, KeyError, ValueError):
654
def supports_executable():
655
return sys.platform != "win32"
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)
added
removed
bzrlib/osutils.py
