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
34
from bzrlib.errors import (BzrError,
35
BzrBadParameterNotUnicode,
23
39
from bzrlib.trace import mutter
26
42
def make_readonly(filename):
27
43
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
44
mod = os.stat(filename).st_mode
30
45
mod = mod & 0777555
31
46
os.chmod(filename, mod)
73
102
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.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
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)
77
233
def backup_file(fn):
277
"""True if f is a symlink."""
279
return S_ISLNK(os.lstat(f)[ST_MODE])
132
283
def is_inside(dir, fname):
133
284
"""True if fname is inside dir.
286
The parameters should typically be passed to osutils.normpath first, so
287
that . and .. and repeated slashes are eliminated, and the separators
288
are canonical for the platform.
290
The empty string as a dir name is taken as top-of-tree and matches
293
>>> is_inside('src', pathjoin('src', 'foo.c'))
295
>>> is_inside('src', 'srccontrol')
297
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
299
>>> is_inside('foo.c', 'foo.c')
301
>>> is_inside('foo.c', '')
303
>>> is_inside('', 'foo.c')
135
return os.path.commonprefix([dir, fname]) == dir
306
# XXX: Most callers of this can actually do something smarter by
307
# looking at the inventory
317
return fname.startswith(dir)
138
320
def is_inside_any(dir_list, fname):
139
321
"""True if fname is inside any of given dirs."""
140
# quick scan for perfect match
141
if fname in dir_list:
144
322
for dirname in dir_list:
145
323
if is_inside(dirname, fname):
193
380
'sha1': s.hexdigest()}
197
"""Return per-user configuration directory.
199
By default this is ~/.bzr.conf/
201
TODO: Global option --config-dir to override this.
203
return os.path.expanduser("~/.bzr.conf")
207
"""Calculate automatic user identification.
209
Returns (realname, email).
211
Only used when none is set in the environment or the id file.
213
This previously used the FQDN as the default domain, but that can
214
be very slow on machines where DNS is broken. So now we simply
219
# XXX: Any good way to get real user name on win32?
224
w = pwd.getpwuid(uid)
225
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
226
username = w.pw_name.decode(bzrlib.user_encoding)
227
comma = gecos.find(',')
231
realname = gecos[:comma]
237
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
239
return realname, (username + '@' + socket.gethostname())
243
"""Return the full user id from a file or environment variable.
245
TODO: Allow taking this from a file in the branch directory too
246
for per-branch ids."""
247
v = os.environ.get('BZREMAIL')
249
return v.decode(bzrlib.user_encoding)
252
return (open(os.path.join(config_dir(), "email"))
254
.decode(bzrlib.user_encoding)
257
if e.errno != errno.ENOENT:
260
v = os.environ.get('EMAIL')
262
return v.decode(bzrlib.user_encoding)
268
"""Return email-style username.
270
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
272
TODO: Check it's reasonably well-formed.
278
name, email = _auto_user_id()
280
return '%s <%s>' % (name, email)
285
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
287
"""Return just the email component of a username."""
290
m = _EMAIL_RE.search(e)
292
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
295
return _auto_user_id()[1]
299
383
def compare_files(a, b):
300
384
"""Returns true if equal in contents"""
353
441
"""Return size of given open file."""
354
442
return os.fstat(f.fileno())[ST_SIZE]
357
if hasattr(os, 'urandom'): # python 2.4 and later
444
# Define rand_bytes based on platform.
446
# Python 2.4 and later have os.urandom,
447
# but it doesn't work on some arches
358
449
rand_bytes = os.urandom
359
elif sys.platform == 'linux2':
360
rand_bytes = file('/dev/urandom', 'rb').read
362
# not well seeded, but better than nothing
367
s += chr(random.randint(0, 255))
450
except (NotImplementedError, AttributeError):
451
# If python doesn't have os.urandom, or it doesn't work,
452
# then try to first pull random data from /dev/urandom
453
if os.path.exists("/dev/urandom"):
454
rand_bytes = file('/dev/urandom', 'rb').read
455
# Otherwise, use this hack as a last resort
457
# not well seeded, but better than nothing
462
s += chr(random.randint(0, 255))
372
466
## TODO: We could later have path objects that remember their list
373
467
## decomposition (might be too tricksy though.)
410
504
if (f == '..') or (f == None) or (f == ''):
411
505
raise BzrError("sorry, %r not allowed in path" % f)
412
return os.path.join(*p)
415
509
def appendpath(p1, p2):
419
return os.path.join(p1, p2)
513
return pathjoin(p1, p2)
422
def extern_command(cmd, ignore_errors = False):
423
mutter('external command: %s' % `cmd`)
425
if not ignore_errors:
426
raise BzrError('command failed')
429
def _read_config_value(name):
430
"""Read a config value from the file ~/.bzr.conf/<name>
431
Return None if the file does not exist"""
517
"""Split s into lines, but without removing the newline characters."""
518
return StringIO(s).readlines()
521
def hardlinks_good():
522
return sys.platform not in ('win32', 'cygwin', 'darwin')
525
def link_or_copy(src, dest):
526
"""Hardlink a file, or copy it if it can't be hardlinked."""
527
if not hardlinks_good():
433
f = file(os.path.join(config_dir(), name), "r")
434
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
436
if e.errno == errno.ENOENT:
442
"""Return a sequence of possible editor binaries for the current platform"""
443
e = _read_config_value("editor")
532
except (OSError, IOError), e:
533
if e.errno != errno.EXDEV:
539
if hasattr(os, 'symlink'):
447
if os.name == "windows":
449
elif os.name == "posix":
451
yield os.environ["EDITOR"]
456
def _run_editor(filename):
457
"""Try to execute an editor to edit the commit message. Returns True on success,
459
for e in _get_editor():
460
x = os.spawnvp(os.P_WAIT, e, (e, filename))
545
def contains_whitespace(s):
546
"""True if there are any whitespace characters in s."""
547
for ch in string.whitespace:
554
def contains_linebreaks(s):
555
"""True if there is any vertical whitespace in s."""
563
def relpath(base, path):
564
"""Return path relative to base, or raise exception.
566
The path may be either an absolute path or a path relative to the
567
current working directory.
569
os.path.commonprefix (python2.4) has a bad bug that it works just
570
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
571
avoids that problem."""
576
while len(head) >= len(base):
467
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
471
def get_text_message(infotext, ignoreline = "default"):
474
if ignoreline == "default":
475
ignoreline = "-- This line and the following will be ignored --"
478
tmp_fileno, msgfilename = tempfile.mkstemp()
479
msgfile = os.close(tmp_fileno)
480
if infotext is not None and infotext != "":
482
msgfile = file(msgfilename, "w")
483
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
488
if not _run_editor(msgfilename):
493
lastline, nlines = 0, 0
494
for line in file(msgfilename, "r"):
495
stripped_line = line.strip()
496
# strip empty line before the log message starts
498
if stripped_line != "":
502
# check for the ignore line only if there
503
# is additional information at the end
504
if hasinfo and stripped_line == ignoreline:
507
# keep track of the last line that had some content
508
if stripped_line != "":
514
# delete empty lines at the end
516
# add a newline at the end, if needed
517
if not msg[-1].endswith("\n"):
518
return "%s%s" % ("".join(msg), "\n")
522
# delete the msg file in any case
523
try: os.unlink(msgfilename)
579
head, tail = os.path.split(head)
583
# XXX This should raise a NotChildPath exception, as its not tied
585
raise PathNotChild(rp, base)
593
def safe_unicode(unicode_or_utf8_string):
594
"""Coerce unicode_or_utf8_string into unicode.
596
If it is unicode, it is returned.
597
Otherwise it is decoded from utf-8. If a decoding error
598
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
599
as a BzrBadParameter exception.
601
if isinstance(unicode_or_utf8_string, unicode):
602
return unicode_or_utf8_string
604
return unicode_or_utf8_string.decode('utf8')
605
except UnicodeDecodeError:
606
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
609
def terminal_width():
610
"""Return estimated terminal width."""
612
# TODO: Do something smart on Windows?
614
# TODO: Is there anything that gets a better update when the window
615
# is resized while the program is running? We could use the Python termcap
618
return int(os.environ['COLUMNS'])
619
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
