1
# Bazaar-NG -- distributed version control
3
# Copyright (C) 2005 by Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
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
22
from bzrlib.errors import BzrError
23
from bzrlib.trace import mutter
26
def make_readonly(filename):
27
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
mod = os.stat(filename).st_mode
31
os.chmod(filename, mod)
34
def make_writable(filename):
35
mod = os.stat(filename).st_mode
37
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
42
_SLASH_RE = re.compile(r'[\\/]+')
45
"""Return a quoted filename filename
47
This previously used backslash quoting, but that works poorly on
49
# TODO: I'm not really sure this is the best format either.x
50
if _QUOTE_RE.search(f):
57
mode = os.lstat(f)[ST_MODE]
65
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
68
def kind_marker(kind):
71
elif kind == 'directory':
73
elif kind == 'symlink':
76
raise BzrError('invalid file kind %r' % kind)
81
"""Copy a file to a backup.
83
Backups are named in GNU-style, with a ~ suffix.
85
If the file is already a backup, it's not copied.
98
outf = file(bfn, 'wb')
104
def rename(path_from, path_to):
105
"""Basically the same as os.rename() just special for win32"""
106
if sys.platform == 'win32':
110
if e.errno != e.ENOENT:
112
os.rename(path_from, path_to)
119
"""True if f is an accessible directory."""
121
return S_ISDIR(os.lstat(f)[ST_MODE])
128
"""True if f is a regular file."""
130
return S_ISREG(os.lstat(f)[ST_MODE])
135
def is_inside(dir, fname):
136
"""True if fname is inside dir.
138
The parameters should typically be passed to os.path.normpath first, so
139
that . and .. and repeated slashes are eliminated, and the separators
140
are canonical for the platform.
142
>>> is_inside('src', 'src/foo.c')
144
>>> is_inside('src', 'srccontrol')
146
>>> is_inside('src', 'src/a/a/a/foo.c')
148
>>> is_inside('foo.c', 'foo.c')
151
# XXX: Most callers of this can actually do something smarter by
152
# looking at the inventory
154
dir = dir.split(os.sep)
156
fname = fname.split(os.sep)
158
return (len(fname) >= pl) and (dir == fname[:pl])
161
def is_inside_any(dir_list, fname):
162
"""True if fname is inside any of given dirs."""
163
# quick scan for perfect match
164
if fname in dir_list:
167
for dirname in dir_list:
168
if is_inside(dirname, fname):
174
def pumpfile(fromfile, tofile):
175
"""Copy contents of one file to another."""
176
tofile.write(fromfile.read())
180
"""Return a new UUID"""
182
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
184
return chomp(os.popen('uuidgen').readline())
189
if hasattr(f, 'tell'):
209
def fingerprint_file(f):
215
return {'size': size,
216
'sha1': s.hexdigest()}
220
"""Return per-user configuration directory.
222
By default this is ~/.bzr.conf/
224
TODO: Global option --config-dir to override this.
226
return os.path.expanduser("~/.bzr.conf")
230
"""Calculate automatic user identification.
232
Returns (realname, email).
234
Only used when none is set in the environment or the id file.
236
This previously used the FQDN as the default domain, but that can
237
be very slow on machines where DNS is broken. So now we simply
242
# XXX: Any good way to get real user name on win32?
247
w = pwd.getpwuid(uid)
248
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
249
username = w.pw_name.decode(bzrlib.user_encoding)
250
comma = gecos.find(',')
254
realname = gecos[:comma]
260
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
262
return realname, (username + '@' + socket.gethostname())
266
"""Return the full user id from a file or environment variable.
268
TODO: Allow taking this from a file in the branch directory too
269
for per-branch ids."""
270
v = os.environ.get('BZREMAIL')
272
return v.decode(bzrlib.user_encoding)
275
return (open(os.path.join(config_dir(), "email"))
277
.decode(bzrlib.user_encoding)
280
if e.errno != errno.ENOENT:
283
v = os.environ.get('EMAIL')
285
return v.decode(bzrlib.user_encoding)
291
"""Return email-style username.
293
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
295
TODO: Check it's reasonably well-formed.
301
name, email = _auto_user_id()
303
return '%s <%s>' % (name, email)
308
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
310
"""Return just the email component of a username."""
313
m = _EMAIL_RE.search(e)
315
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
318
return _auto_user_id()[1]
322
def compare_files(a, b):
323
"""Returns true if equal in contents"""
335
def local_time_offset(t=None):
336
"""Return offset of local zone from GMT, either at present or at time t."""
337
# python2.3 localtime() can't take None
341
if time.localtime(t).tm_isdst and time.daylight:
344
return -time.timezone
347
def format_date(t, offset=0, timezone='original'):
348
## TODO: Perhaps a global option to use either universal or local time?
349
## Or perhaps just let people set $TZ?
350
assert isinstance(t, float)
352
if timezone == 'utc':
355
elif timezone == 'original':
358
tt = time.gmtime(t + offset)
359
elif timezone == 'local':
360
tt = time.localtime(t)
361
offset = local_time_offset(t)
363
raise BzrError("unsupported timezone format %r",
364
['options are "utc", "original", "local"'])
366
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
367
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
370
def compact_date(when):
371
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
376
"""Return size of given open file."""
377
return os.fstat(f.fileno())[ST_SIZE]
380
if hasattr(os, 'urandom'): # python 2.4 and later
381
rand_bytes = os.urandom
382
elif sys.platform == 'linux2':
383
rand_bytes = file('/dev/urandom', 'rb').read
385
# not well seeded, but better than nothing
390
s += chr(random.randint(0, 255))
395
## TODO: We could later have path objects that remember their list
396
## decomposition (might be too tricksy though.)
399
"""Turn string into list of parts.
405
>>> splitpath('a/./b')
407
>>> splitpath('a/.b')
409
>>> splitpath('a/../b')
410
Traceback (most recent call last):
412
BzrError: sorry, '..' not allowed in path
414
assert isinstance(p, types.StringTypes)
416
# split on either delimiter because people might use either on
418
ps = re.split(r'[\\/]', p)
423
raise BzrError("sorry, %r not allowed in path" % f)
424
elif (f == '.') or (f == ''):
431
assert isinstance(p, list)
433
if (f == '..') or (f == None) or (f == ''):
434
raise BzrError("sorry, %r not allowed in path" % f)
435
return os.path.join(*p)
438
def appendpath(p1, p2):
442
return os.path.join(p1, p2)
445
def extern_command(cmd, ignore_errors = False):
446
mutter('external command: %s' % `cmd`)
448
if not ignore_errors:
449
raise BzrError('command failed')
452
def _read_config_value(name):
453
"""Read a config value from the file ~/.bzr.conf/<name>
454
Return None if the file does not exist"""
456
f = file(os.path.join(config_dir(), name), "r")
457
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
459
if e.errno == errno.ENOENT:
465
"""Return a sequence of possible editor binaries for the current platform"""
466
e = _read_config_value("editor")
470
if os.name == "windows":
472
elif os.name == "posix":
474
yield os.environ["EDITOR"]
479
def _run_editor(filename):
480
"""Try to execute an editor to edit the commit message. Returns True on success,
482
for e in _get_editor():
483
x = os.spawnvp(os.P_WAIT, e, (e, filename))
490
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
494
def get_text_message(infotext, ignoreline = "default"):
497
if ignoreline == "default":
498
ignoreline = "-- This line and the following will be ignored --"
501
tmp_fileno, msgfilename = tempfile.mkstemp()
502
msgfile = os.close(tmp_fileno)
503
if infotext is not None and infotext != "":
505
msgfile = file(msgfilename, "w")
506
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
511
if not _run_editor(msgfilename):
516
lastline, nlines = 0, 0
517
for line in file(msgfilename, "r"):
518
stripped_line = line.strip()
519
# strip empty line before the log message starts
521
if stripped_line != "":
525
# check for the ignore line only if there
526
# is additional information at the end
527
if hasinfo and stripped_line == ignoreline:
530
# keep track of the last line that had some content
531
if stripped_line != "":
537
# delete empty lines at the end
539
# add a newline at the end, if needed
540
if not msg[-1].endswith("\n"):
541
return "%s%s" % ("".join(msg), "\n")
545
# delete the msg file in any case
546
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
