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, PathNotChild, NoSuchFile
35
from bzrlib.trace import mutter
38
26
def make_readonly(filename):
39
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
40
29
mod = os.stat(filename).st_mode
41
30
mod = mod & 0777555
42
31
os.chmod(filename, mod)
98
79
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os.path, 'lexists'):
102
return os.path.lexists(f)
104
if hasattr(os, 'lstat'):
110
if e.errno == errno.ENOENT:
113
raise BzrError("lstat/stat of (%r): %r" % (f, e))
115
def fancy_rename(old, new, rename_func, unlink_func):
116
"""A fancy rename, when you don't have atomic rename.
118
:param old: The old path, to rename from
119
:param new: The new path, to rename to
120
:param rename_func: The potentially non-atomic rename function
121
:param unlink_func: A way to delete the target file if the full rename succeeds
124
# sftp rename doesn't allow overwriting, so play tricks:
126
base = os.path.basename(new)
127
dirname = os.path.dirname(new)
128
tmp_name = u'tmp.%s.%.9f.%d.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
129
tmp_name = pathjoin(dirname, tmp_name)
131
# Rename the file out of the way, but keep track if it didn't exist
132
# We don't want to grab just any exception
133
# something like EACCES should prevent us from continuing
134
# The downside is that the rename_func has to throw an exception
135
# with an errno = ENOENT, or NoSuchFile
138
rename_func(new, tmp_name)
139
except (NoSuchFile,), e:
142
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
143
# function raises an IOError with errno == None when a rename fails.
144
# This then gets caught here.
145
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
148
if (not hasattr(e, 'errno')
149
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
156
# This may throw an exception, in which case success will
158
rename_func(old, new)
162
# If the file used to exist, rename it back into place
163
# otherwise just delete it from the tmp location
165
unlink_func(tmp_name)
167
rename_func(tmp_name, new)
169
# Default is to just use the python builtins
170
abspath = os.path.abspath
171
realpath = os.path.realpath
172
pathjoin = os.path.join
173
normpath = os.path.normpath
175
mkdtemp = tempfile.mkdtemp
177
dirname = os.path.dirname
178
basename = os.path.basename
180
if os.name == "posix":
181
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
182
# choke on a Unicode string containing a relative path if
183
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
185
_fs_enc = sys.getfilesystemencoding()
187
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
190
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
192
if sys.platform == 'win32':
193
# We need to use the Unicode-aware os.path.abspath and
194
# os.path.realpath on Windows systems.
196
return os.path.abspath(path).replace('\\', '/')
199
return os.path.realpath(path).replace('\\', '/')
202
return os.path.join(*args).replace('\\', '/')
205
return os.path.normpath(path).replace('\\', '/')
208
return os.getcwdu().replace('\\', '/')
210
def mkdtemp(*args, **kwargs):
211
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
213
def rename(old, new):
214
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
217
def normalizepath(f):
218
if hasattr(os.path, 'realpath'):
222
[p,e] = os.path.split(f)
223
if e == "" or e == "." or e == "..":
226
return pathjoin(F(p), e)
229
83
def backup_file(fn):
273
"""True if f is a symlink."""
275
return S_ISLNK(os.lstat(f)[ST_MODE])
279
138
def is_inside(dir, fname):
280
139
"""True if fname is inside dir.
282
The parameters should typically be passed to osutils.normpath first, so
141
The parameters should typically be passed to os.path.normpath first, so
283
142
that . and .. and repeated slashes are eliminated, and the separators
284
143
are canonical for the platform.
286
145
The empty string as a dir name is taken as top-of-tree and matches
289
>>> is_inside('src', pathjoin('src', 'foo.c'))
148
>>> is_inside('src', 'src/foo.c')
291
150
>>> is_inside('src', 'srccontrol')
293
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
152
>>> is_inside('src', 'src/a/a/a/foo.c')
295
154
>>> is_inside('foo.c', 'foo.c')
376
226
'sha1': s.hexdigest()}
230
"""Return per-user configuration directory.
232
By default this is ~/.bzr.conf/
234
TODO: Global option --config-dir to override this.
236
return os.path.expanduser("~/.bzr.conf")
240
"""Calculate automatic user identification.
242
Returns (realname, email).
244
Only used when none is set in the environment or the id file.
246
This previously used the FQDN as the default domain, but that can
247
be very slow on machines where DNS is broken. So now we simply
252
# XXX: Any good way to get real user name on win32?
257
w = pwd.getpwuid(uid)
258
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
259
username = w.pw_name.decode(bzrlib.user_encoding)
260
comma = gecos.find(',')
264
realname = gecos[:comma]
270
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
272
return realname, (username + '@' + socket.gethostname())
275
def _get_user_id(branch):
276
"""Return the full user id from a file or environment variable.
278
e.g. "John Hacker <jhacker@foo.org>"
281
A branch to use for a per-branch configuration, or None.
283
The following are searched in order:
286
2. .bzr/email for this branch.
290
v = os.environ.get('BZREMAIL')
292
return v.decode(bzrlib.user_encoding)
296
return (branch.controlfile("email", "r")
298
.decode(bzrlib.user_encoding)
301
if e.errno != errno.ENOENT:
307
return (open(os.path.join(config_dir(), "email"))
309
.decode(bzrlib.user_encoding)
312
if e.errno != errno.ENOENT:
315
v = os.environ.get('EMAIL')
317
return v.decode(bzrlib.user_encoding)
322
def username(branch):
323
"""Return email-style username.
325
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
327
TODO: Check it's reasonably well-formed.
329
v = _get_user_id(branch)
333
name, email = _auto_user_id()
335
return '%s <%s>' % (name, email)
340
def user_email(branch):
341
"""Return just the email component of a username."""
342
e = _get_user_id(branch)
344
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
346
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
349
return _auto_user_id()[1]
379
353
def compare_files(a, b):
380
354
"""Returns true if equal in contents"""
437
407
"""Return size of given open file."""
438
408
return os.fstat(f.fileno())[ST_SIZE]
440
# Define rand_bytes based on platform.
442
# Python 2.4 and later have os.urandom,
443
# but it doesn't work on some arches
411
if hasattr(os, 'urandom'): # python 2.4 and later
445
412
rand_bytes = os.urandom
446
except (NotImplementedError, AttributeError):
447
# If python doesn't have os.urandom, or it doesn't work,
448
# then try to first pull random data from /dev/urandom
449
if os.path.exists("/dev/urandom"):
450
rand_bytes = file('/dev/urandom', 'rb').read
451
# Otherwise, use this hack as a last resort
453
# not well seeded, but better than nothing
458
s += chr(random.randint(0, 255))
413
elif sys.platform == 'linux2':
414
rand_bytes = file('/dev/urandom', 'rb').read
416
# not well seeded, but better than nothing
421
s += chr(random.randint(0, 255))
462
426
## TODO: We could later have path objects that remember their list
463
427
## decomposition (might be too tricksy though.)
500
464
if (f == '..') or (f == None) or (f == ''):
501
465
raise BzrError("sorry, %r not allowed in path" % f)
466
return os.path.join(*p)
505
469
def appendpath(p1, p2):
509
return pathjoin(p1, p2)
473
return os.path.join(p1, p2)
513
"""Split s into lines, but without removing the newline characters."""
514
return StringIO(s).readlines()
517
def hardlinks_good():
518
return sys.platform not in ('win32', 'cygwin', 'darwin')
521
def link_or_copy(src, dest):
522
"""Hardlink a file, or copy it if it can't be hardlinked."""
523
if not hardlinks_good():
476
def extern_command(cmd, ignore_errors = False):
477
mutter('external command: %s' % `cmd`)
479
if not ignore_errors:
480
raise BzrError('command failed')
483
def _read_config_value(name):
484
"""Read a config value from the file ~/.bzr.conf/<name>
485
Return None if the file does not exist"""
528
except (OSError, IOError), e:
529
if e.errno != errno.EXDEV:
535
if hasattr(os, 'symlink'):
487
f = file(os.path.join(config_dir(), name), "r")
488
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
490
if e.errno == errno.ENOENT:
496
"""Return a sequence of possible editor binaries for the current platform"""
497
e = _read_config_value("editor")
541
def contains_whitespace(s):
542
"""True if there are any whitespace characters in s."""
543
for ch in string.whitespace:
550
def contains_linebreaks(s):
551
"""True if there is any vertical whitespace in s."""
559
def relpath(base, path):
560
"""Return path relative to base, or raise exception.
562
The path may be either an absolute path or a path relative to the
563
current working directory.
565
os.path.commonprefix (python2.4) has a bad bug that it works just
566
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
567
avoids that problem."""
572
while len(head) >= len(base):
501
if os.name == "windows":
503
elif os.name == "posix":
505
yield os.environ["EDITOR"]
510
def _run_editor(filename):
511
"""Try to execute an editor to edit the commit message. Returns True on success,
513
for e in _get_editor():
514
x = os.spawnvp(os.P_WAIT, e, (e, filename))
575
head, tail = os.path.split(head)
579
# XXX This should raise a NotChildPath exception, as its not tied
581
raise PathNotChild(rp, base)
589
def terminal_width():
590
"""Return estimated terminal width."""
592
# TODO: Do something smart on Windows?
594
# TODO: Is there anything that gets a better update when the window
595
# is resized while the program is running? We could use the Python termcap
521
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
525
def get_text_message(infotext, ignoreline = "default"):
528
if ignoreline == "default":
529
ignoreline = "-- This line and the following will be ignored --"
598
return int(os.environ['COLUMNS'])
599
except (IndexError, KeyError, ValueError):
532
tmp_fileno, msgfilename = tempfile.mkstemp()
533
msgfile = os.close(tmp_fileno)
534
if infotext is not None and infotext != "":
536
msgfile = file(msgfilename, "w")
537
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
542
if not _run_editor(msgfilename):
547
lastline, nlines = 0, 0
548
for line in file(msgfilename, "r"):
549
stripped_line = line.strip()
550
# strip empty line before the log message starts
552
if stripped_line != "":
556
# check for the ignore line only if there
557
# is additional information at the end
558
if hasinfo and stripped_line == ignoreline:
561
# keep track of the last line that had some content
562
if stripped_line != "":
568
# delete empty lines at the end
570
# add a newline at the end, if needed
571
if not msg[-1].endswith("\n"):
572
return "%s%s" % ("".join(msg), "\n")
576
# delete the msg file in any case
577
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
