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
"""Return a quoted filename filename
44
This previously used backslash quoting, but that works poorly on
46
# TODO: I'm not really sure this is the best format either.x
47
if _QUOTE_RE.search(f):
54
mode = os.lstat(f)[ST_MODE]
62
raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
65
def kind_marker(kind):
68
elif kind == 'directory':
70
elif kind == 'symlink':
73
raise BzrError('invalid file kind %r' % kind)
78
"""Copy a file to a backup.
80
Backups are named in GNU-style, with a ~ suffix.
82
If the file is already a backup, it's not copied.
95
outf = file(bfn, 'wb')
105
"""True if f is an accessible directory."""
107
return S_ISDIR(os.lstat(f)[ST_MODE])
114
"""True if f is a regular file."""
116
return S_ISREG(os.lstat(f)[ST_MODE])
121
def is_inside(dir, fname):
122
"""True if fname is inside dir.
124
return os.path.commonprefix([dir, fname]) == dir
127
def is_inside_any(dir_list, fname):
128
"""True if fname is inside any of given dirs."""
129
# quick scan for perfect match
130
if fname in dir_list:
133
for dirname in dir_list:
134
if is_inside(dirname, fname):
140
def pumpfile(fromfile, tofile):
141
"""Copy contents of one file to another."""
142
tofile.write(fromfile.read())
146
"""Return a new UUID"""
148
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
150
return chomp(os.popen('uuidgen').readline())
155
if hasattr(f, 'tell'):
175
def fingerprint_file(f):
181
return {'size': size,
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]
288
def compare_files(a, b):
289
"""Returns true if equal in contents"""
301
def local_time_offset(t=None):
302
"""Return offset of local zone from GMT, either at present or at time t."""
303
# python2.3 localtime() can't take None
307
if time.localtime(t).tm_isdst and time.daylight:
310
return -time.timezone
313
def format_date(t, offset=0, timezone='original'):
314
## TODO: Perhaps a global option to use either universal or local time?
315
## Or perhaps just let people set $TZ?
316
assert isinstance(t, float)
318
if timezone == 'utc':
321
elif timezone == 'original':
324
tt = time.gmtime(t + offset)
325
elif timezone == 'local':
326
tt = time.localtime(t)
327
offset = local_time_offset(t)
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))
336
def compact_date(when):
337
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
342
"""Return size of given open file."""
343
return os.fstat(f.fileno())[ST_SIZE]
346
if hasattr(os, 'urandom'): # python 2.4 and later
347
rand_bytes = os.urandom
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))
361
## TODO: We could later have path objects that remember their list
362
## decomposition (might be too tricksy though.)
365
"""Turn string into list of parts.
371
>>> splitpath('a/./b')
373
>>> splitpath('a/.b')
375
>>> splitpath('a/../b')
376
Traceback (most recent call last):
378
BzrError: sorry, '..' not allowed in path
380
assert isinstance(p, types.StringTypes)
382
# split on either delimiter because people might use either on
384
ps = re.split(r'[\\/]', p)
389
raise BzrError("sorry, %r not allowed in path" % f)
390
elif (f == '.') or (f == ''):
397
assert isinstance(p, list)
399
if (f == '..') or (f == None) or (f == ''):
400
raise BzrError("sorry, %r not allowed in path" % f)
401
return os.path.join(*p)
404
def appendpath(p1, p2):
408
return os.path.join(p1, p2)
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"""
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")
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))
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
