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
The empty string as a dir name is taken as top-of-tree and matches
145
>>> is_inside('src', 'src/foo.c')
147
>>> is_inside('src', 'srccontrol')
149
>>> is_inside('src', 'src/a/a/a/foo.c')
151
>>> is_inside('foo.c', 'foo.c')
153
>>> is_inside('foo.c', '')
155
>>> is_inside('', 'foo.c')
158
# XXX: Most callers of this can actually do something smarter by
159
# looking at the inventory
166
if dir[-1] != os.sep:
169
return fname.startswith(dir)
172
def is_inside_any(dir_list, fname):
173
"""True if fname is inside any of given dirs."""
174
for dirname in dir_list:
175
if is_inside(dirname, fname):
181
def pumpfile(fromfile, tofile):
182
"""Copy contents of one file to another."""
183
tofile.write(fromfile.read())
187
"""Return a new UUID"""
189
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
191
return chomp(os.popen('uuidgen').readline())
196
if hasattr(f, 'tell'):
216
def fingerprint_file(f):
222
return {'size': size,
223
'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())
272
def _get_user_id(branch):
273
"""Return the full user id from a file or environment variable.
275
e.g. "John Hacker <jhacker@foo.org>"
278
A branch to use for a per-branch configuration, or None.
280
The following are searched in order:
283
2. .bzr/email for this branch.
287
v = os.environ.get('BZREMAIL')
289
return v.decode(bzrlib.user_encoding)
293
return (branch.controlfile("email", "r")
295
.decode(bzrlib.user_encoding)
298
if e.errno != errno.ENOENT:
304
return (open(os.path.join(config_dir(), "email"))
306
.decode(bzrlib.user_encoding)
309
if e.errno != errno.ENOENT:
312
v = os.environ.get('EMAIL')
314
return v.decode(bzrlib.user_encoding)
319
def username(branch):
320
"""Return email-style username.
322
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
324
TODO: Check it's reasonably well-formed.
326
v = _get_user_id(branch)
330
name, email = _auto_user_id()
332
return '%s <%s>' % (name, email)
337
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
338
def user_email(branch):
339
"""Return just the email component of a username."""
340
e = _get_user_id(branch)
342
m = _EMAIL_RE.search(e)
344
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
347
return _auto_user_id()[1]
351
def compare_files(a, b):
352
"""Returns true if equal in contents"""
364
def local_time_offset(t=None):
365
"""Return offset of local zone from GMT, either at present or at time t."""
366
# python2.3 localtime() can't take None
370
if time.localtime(t).tm_isdst and time.daylight:
373
return -time.timezone
376
def format_date(t, offset=0, timezone='original'):
377
## TODO: Perhaps a global option to use either universal or local time?
378
## Or perhaps just let people set $TZ?
379
assert isinstance(t, float)
381
if timezone == 'utc':
384
elif timezone == 'original':
387
tt = time.gmtime(t + offset)
388
elif timezone == 'local':
389
tt = time.localtime(t)
390
offset = local_time_offset(t)
392
raise BzrError("unsupported timezone format %r" % timezone,
393
['options are "utc", "original", "local"'])
395
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
396
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
399
def compact_date(when):
400
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
405
"""Return size of given open file."""
406
return os.fstat(f.fileno())[ST_SIZE]
409
if hasattr(os, 'urandom'): # python 2.4 and later
410
rand_bytes = os.urandom
411
elif sys.platform == 'linux2':
412
rand_bytes = file('/dev/urandom', 'rb').read
414
# not well seeded, but better than nothing
419
s += chr(random.randint(0, 255))
424
## TODO: We could later have path objects that remember their list
425
## decomposition (might be too tricksy though.)
428
"""Turn string into list of parts.
434
>>> splitpath('a/./b')
436
>>> splitpath('a/.b')
438
>>> splitpath('a/../b')
439
Traceback (most recent call last):
441
BzrError: sorry, '..' not allowed in path
443
assert isinstance(p, types.StringTypes)
445
# split on either delimiter because people might use either on
447
ps = re.split(r'[\\/]', p)
452
raise BzrError("sorry, %r not allowed in path" % f)
453
elif (f == '.') or (f == ''):
460
assert isinstance(p, list)
462
if (f == '..') or (f == None) or (f == ''):
463
raise BzrError("sorry, %r not allowed in path" % f)
464
return os.path.join(*p)
467
def appendpath(p1, p2):
471
return os.path.join(p1, p2)
474
def extern_command(cmd, ignore_errors = False):
475
mutter('external command: %s' % `cmd`)
477
if not ignore_errors:
478
raise BzrError('command failed')
481
def _read_config_value(name):
482
"""Read a config value from the file ~/.bzr.conf/<name>
483
Return None if the file does not exist"""
485
f = file(os.path.join(config_dir(), name), "r")
486
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
488
if e.errno == errno.ENOENT:
494
"""Return a sequence of possible editor binaries for the current platform"""
495
e = _read_config_value("editor")
499
if os.name == "windows":
501
elif os.name == "posix":
503
yield os.environ["EDITOR"]
508
def _run_editor(filename):
509
"""Try to execute an editor to edit the commit message. Returns True on success,
511
for e in _get_editor():
512
x = os.spawnvp(os.P_WAIT, e, (e, filename))
519
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
523
def get_text_message(infotext, ignoreline = "default"):
526
if ignoreline == "default":
527
ignoreline = "-- This line and the following will be ignored --"
530
tmp_fileno, msgfilename = tempfile.mkstemp()
531
msgfile = os.close(tmp_fileno)
532
if infotext is not None and infotext != "":
534
msgfile = file(msgfilename, "w")
535
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
540
if not _run_editor(msgfilename):
545
lastline, nlines = 0, 0
546
for line in file(msgfilename, "r"):
547
stripped_line = line.strip()
548
# strip empty line before the log message starts
550
if stripped_line != "":
554
# check for the ignore line only if there
555
# is additional information at the end
556
if hasinfo and stripped_line == ignoreline:
559
# keep track of the last line that had some content
560
if stripped_line != "":
566
# delete empty lines at the end
568
# add a newline at the end, if needed
569
if not msg[-1].endswith("\n"):
570
return "%s%s" % ("".join(msg), "\n")
574
# delete the msg file in any case
575
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
