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
157
if dir[-1] != os.sep:
160
return fname.startswith(dir)
163
def is_inside_any(dir_list, fname):
164
"""True if fname is inside any of given dirs."""
165
for dirname in dir_list:
166
if is_inside(dirname, fname):
172
def pumpfile(fromfile, tofile):
173
"""Copy contents of one file to another."""
174
tofile.write(fromfile.read())
178
"""Return a new UUID"""
180
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
182
return chomp(os.popen('uuidgen').readline())
187
if hasattr(f, 'tell'):
207
def fingerprint_file(f):
213
return {'size': size,
214
'sha1': s.hexdigest()}
218
"""Return per-user configuration directory.
220
By default this is ~/.bzr.conf/
222
TODO: Global option --config-dir to override this.
224
return os.path.expanduser("~/.bzr.conf")
228
"""Calculate automatic user identification.
230
Returns (realname, email).
232
Only used when none is set in the environment or the id file.
234
This previously used the FQDN as the default domain, but that can
235
be very slow on machines where DNS is broken. So now we simply
240
# XXX: Any good way to get real user name on win32?
245
w = pwd.getpwuid(uid)
246
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
247
username = w.pw_name.decode(bzrlib.user_encoding)
248
comma = gecos.find(',')
252
realname = gecos[:comma]
258
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
260
return realname, (username + '@' + socket.gethostname())
264
"""Return the full user id from a file or environment variable.
266
TODO: Allow taking this from a file in the branch directory too
267
for per-branch ids."""
268
v = os.environ.get('BZREMAIL')
270
return v.decode(bzrlib.user_encoding)
273
return (open(os.path.join(config_dir(), "email"))
275
.decode(bzrlib.user_encoding)
278
if e.errno != errno.ENOENT:
281
v = os.environ.get('EMAIL')
283
return v.decode(bzrlib.user_encoding)
289
"""Return email-style username.
291
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
293
TODO: Check it's reasonably well-formed.
299
name, email = _auto_user_id()
301
return '%s <%s>' % (name, email)
306
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
308
"""Return just the email component of a username."""
311
m = _EMAIL_RE.search(e)
313
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
316
return _auto_user_id()[1]
320
def compare_files(a, b):
321
"""Returns true if equal in contents"""
333
def local_time_offset(t=None):
334
"""Return offset of local zone from GMT, either at present or at time t."""
335
# python2.3 localtime() can't take None
339
if time.localtime(t).tm_isdst and time.daylight:
342
return -time.timezone
345
def format_date(t, offset=0, timezone='original'):
346
## TODO: Perhaps a global option to use either universal or local time?
347
## Or perhaps just let people set $TZ?
348
assert isinstance(t, float)
350
if timezone == 'utc':
353
elif timezone == 'original':
356
tt = time.gmtime(t + offset)
357
elif timezone == 'local':
358
tt = time.localtime(t)
359
offset = local_time_offset(t)
361
raise BzrError("unsupported timezone format %r",
362
['options are "utc", "original", "local"'])
364
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
365
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
368
def compact_date(when):
369
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
374
"""Return size of given open file."""
375
return os.fstat(f.fileno())[ST_SIZE]
378
if hasattr(os, 'urandom'): # python 2.4 and later
379
rand_bytes = os.urandom
380
elif sys.platform == 'linux2':
381
rand_bytes = file('/dev/urandom', 'rb').read
383
# not well seeded, but better than nothing
388
s += chr(random.randint(0, 255))
393
## TODO: We could later have path objects that remember their list
394
## decomposition (might be too tricksy though.)
397
"""Turn string into list of parts.
403
>>> splitpath('a/./b')
405
>>> splitpath('a/.b')
407
>>> splitpath('a/../b')
408
Traceback (most recent call last):
410
BzrError: sorry, '..' not allowed in path
412
assert isinstance(p, types.StringTypes)
414
# split on either delimiter because people might use either on
416
ps = re.split(r'[\\/]', p)
421
raise BzrError("sorry, %r not allowed in path" % f)
422
elif (f == '.') or (f == ''):
429
assert isinstance(p, list)
431
if (f == '..') or (f == None) or (f == ''):
432
raise BzrError("sorry, %r not allowed in path" % f)
433
return os.path.join(*p)
436
def appendpath(p1, p2):
440
return os.path.join(p1, p2)
443
def extern_command(cmd, ignore_errors = False):
444
mutter('external command: %s' % `cmd`)
446
if not ignore_errors:
447
raise BzrError('command failed')
450
def _read_config_value(name):
451
"""Read a config value from the file ~/.bzr.conf/<name>
452
Return None if the file does not exist"""
454
f = file(os.path.join(config_dir(), name), "r")
455
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
457
if e.errno == errno.ENOENT:
463
"""Return a sequence of possible editor binaries for the current platform"""
464
e = _read_config_value("editor")
468
if os.name == "windows":
470
elif os.name == "posix":
472
yield os.environ["EDITOR"]
477
def _run_editor(filename):
478
"""Try to execute an editor to edit the commit message. Returns True on success,
480
for e in _get_editor():
481
x = os.spawnvp(os.P_WAIT, e, (e, filename))
488
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
492
def get_text_message(infotext, ignoreline = "default"):
495
if ignoreline == "default":
496
ignoreline = "-- This line and the following will be ignored --"
499
tmp_fileno, msgfilename = tempfile.mkstemp()
500
msgfile = os.close(tmp_fileno)
501
if infotext is not None and infotext != "":
503
msgfile = file(msgfilename, "w")
504
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
509
if not _run_editor(msgfilename):
514
lastline, nlines = 0, 0
515
for line in file(msgfilename, "r"):
516
stripped_line = line.strip()
517
# strip empty line before the log message starts
519
if stripped_line != "":
523
# check for the ignore line only if there
524
# is additional information at the end
525
if hasinfo and stripped_line == ignoreline:
528
# keep track of the last line that had some content
529
if stripped_line != "":
535
# delete empty lines at the end
537
# add a newline at the end, if needed
538
if not msg[-1].endswith("\n"):
539
return "%s%s" % ("".join(msg), "\n")
543
# delete the msg file in any case
544
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
