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
33
from bzrlib.errors import BzrError, NotBranchError
23
34
from bzrlib.trace import mutter
26
37
def make_readonly(filename):
27
38
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
39
mod = os.stat(filename).st_mode
30
40
mod = mod & 0777555
31
41
os.chmod(filename, mod)
142
187
The empty string as a dir name is taken as top-of-tree and matches
145
>>> is_inside('src', 'src/foo.c')
190
>>> is_inside('src', os.path.join('src', 'foo.c'))
147
192
>>> is_inside('src', 'srccontrol')
149
>>> is_inside('src', 'src/a/a/a/foo.c')
194
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
151
196
>>> is_inside('foo.c', 'foo.c')
223
264
'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]
329
267
def compare_files(a, b):
330
268
"""Returns true if equal in contents"""
383
325
"""Return size of given open file."""
384
326
return os.fstat(f.fileno())[ST_SIZE]
387
if hasattr(os, 'urandom'): # python 2.4 and later
328
# Define rand_bytes based on platform.
330
# Python 2.4 and later have os.urandom,
331
# but it doesn't work on some arches
388
333
rand_bytes = os.urandom
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))
334
except (NotImplementedError, AttributeError):
335
# If python doesn't have os.urandom, or it doesn't work,
336
# then try to first pull random data from /dev/urandom
337
if os.path.exists("/dev/urandom"):
338
rand_bytes = file('/dev/urandom', 'rb').read
339
# Otherwise, use this hack as a last resort
341
# not well seeded, but better than nothing
346
s += chr(random.randint(0, 255))
402
350
## TODO: We could later have path objects that remember their list
403
351
## decomposition (might be too tricksy though.)
449
397
return os.path.join(p1, p2)
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"""
401
"""Split s into lines, but without removing the newline characters."""
402
return StringIO(s).readlines()
405
def hardlinks_good():
406
return sys.platform not in ('win32', 'cygwin', 'darwin')
409
def link_or_copy(src, dest):
410
"""Hardlink a file, or copy it if it can't be hardlinked."""
411
if not hardlinks_good():
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")
416
except (OSError, IOError), e:
417
if e.errno != errno.EXDEV:
423
if hasattr(os, 'symlink'):
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))
429
def contains_whitespace(s):
430
"""True if there are any whitespace characters in s."""
431
for ch in string.whitespace:
438
def contains_linebreaks(s):
439
"""True if there is any vertical whitespace in s."""
447
def relpath(base, path):
448
"""Return path relative to base, or raise exception.
450
The path may be either an absolute path or a path relative to the
451
current working directory.
453
os.path.commonprefix (python2.4) has a bad bug that it works just
454
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
455
avoids that problem."""
456
rp = os.path.abspath(path)
460
while len(head) >= len(base):
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)
463
head, tail = os.path.split(head)
467
# XXX This should raise a NotChildPath exception, as its not tied
469
raise NotBranchError("path %r is not within branch %r" % (rp, base))
471
return os.sep.join(s)
added
removed
bzrlib/osutils.py
