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
33
from bzrlib.errors import BzrError, NotBranchError
34
from bzrlib.trace import mutter
37
26
def make_readonly(filename):
38
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
39
29
mod = os.stat(filename).st_mode
40
30
mod = mod & 0777555
41
31
os.chmod(filename, mod)
97
73
raise BzrError('invalid file kind %r' % kind)
101
if hasattr(os, 'lstat'):
107
if e.errno == errno.ENOENT:
110
raise BzrError("lstat/stat of (%r): %r" % (f, e))
112
def normalizepath(f):
113
if hasattr(os.path, 'realpath'):
117
[p,e] = os.path.split(f)
118
if e == "" or e == "." or e == "..":
121
return os.path.join(F(p), e)
123
if os.name == "posix":
124
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
125
# choke on a Unicode string containing a relative path if
126
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
128
_fs_enc = sys.getfilesystemencoding()
130
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
132
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
134
# We need to use the Unicode-aware os.path.abspath and
135
# os.path.realpath on Windows systems.
136
abspath = os.path.abspath
137
realpath = os.path.realpath
139
77
def backup_file(fn):
140
78
"""Copy a file to a backup.
189
"""True if f is a symlink."""
191
return S_ISLNK(os.lstat(f)[ST_MODE])
195
121
def is_inside(dir, fname):
196
122
"""True if fname is inside dir.
198
The parameters should typically be passed to os.path.normpath first, so
199
that . and .. and repeated slashes are eliminated, and the separators
200
are canonical for the platform.
202
The empty string as a dir name is taken as top-of-tree and matches
205
>>> is_inside('src', os.path.join('src', 'foo.c'))
207
>>> is_inside('src', 'srccontrol')
209
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
211
>>> is_inside('foo.c', 'foo.c')
213
>>> is_inside('foo.c', '')
215
>>> is_inside('', 'foo.c')
218
# XXX: Most callers of this can actually do something smarter by
219
# looking at the inventory
226
if dir[-1] != os.sep:
229
return fname.startswith(dir)
124
return os.path.commonprefix([dir, fname]) == dir
232
127
def is_inside_any(dir_list, fname):
233
128
"""True if fname is inside any of given dirs."""
129
# quick scan for perfect match
130
if fname in dir_list:
234
133
for dirname in dir_list:
235
134
if is_inside(dirname, fname):
279
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]
282
288
def compare_files(a, b):
283
289
"""Returns true if equal in contents"""
320
326
tt = time.localtime(t)
321
327
offset = local_time_offset(t)
323
raise BzrError("unsupported timezone format %r" % timezone,
324
['options are "utc", "original", "local"'])
326
date_fmt = "%a %Y-%m-%d %H:%M:%S"
328
offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
331
return (time.strftime(date_fmt, tt) + offset_str)
329
raise BzrError("unsupported timezone format %r",
330
['options are "utc", "original", "local"'])
332
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
333
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
334
336
def compact_date(when):
340
342
"""Return size of given open file."""
341
343
return os.fstat(f.fileno())[ST_SIZE]
343
# Define rand_bytes based on platform.
345
# Python 2.4 and later have os.urandom,
346
# but it doesn't work on some arches
346
if hasattr(os, 'urandom'): # python 2.4 and later
348
347
rand_bytes = os.urandom
349
except (NotImplementedError, AttributeError):
350
# If python doesn't have os.urandom, or it doesn't work,
351
# then try to first pull random data from /dev/urandom
352
if os.path.exists("/dev/urandom"):
353
rand_bytes = file('/dev/urandom', 'rb').read
354
# Otherwise, use this hack as a last resort
356
# not well seeded, but better than nothing
361
s += chr(random.randint(0, 255))
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))
365
361
## TODO: We could later have path objects that remember their list
366
362
## decomposition (might be too tricksy though.)
412
408
return os.path.join(p1, p2)
416
"""Split s into lines, but without removing the newline characters."""
417
return StringIO(s).readlines()
420
def hardlinks_good():
421
return sys.platform not in ('win32', 'cygwin', 'darwin')
424
def link_or_copy(src, dest):
425
"""Hardlink a file, or copy it if it can't be hardlinked."""
426
if not hardlinks_good():
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"""
431
except (OSError, IOError), e:
432
if e.errno != errno.EXDEV:
438
if hasattr(os, 'symlink'):
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")
444
def contains_whitespace(s):
445
"""True if there are any whitespace characters in s."""
446
for ch in string.whitespace:
453
def contains_linebreaks(s):
454
"""True if there is any vertical whitespace in s."""
462
def relpath(base, path):
463
"""Return path relative to base, or raise exception.
465
The path may be either an absolute path or a path relative to the
466
current working directory.
468
os.path.commonprefix (python2.4) has a bad bug that it works just
469
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
470
avoids that problem."""
475
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))
478
head, tail = os.path.split(head)
482
# XXX This should raise a NotChildPath exception, as its not tied
484
raise NotBranchError("path %r is not within branch %r" % (rp, base))
486
return os.sep.join(s)
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
