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')
101
def rename(path_from, path_to):
102
"""Basically the same as os.rename() just special for win32"""
103
if sys.platform == 'win32':
107
if e.errno != e.ENOENT:
109
os.rename(path_from, path_to)
116
"""True if f is an accessible directory."""
118
return S_ISDIR(os.lstat(f)[ST_MODE])
125
"""True if f is a regular file."""
127
return S_ISREG(os.lstat(f)[ST_MODE])
132
def is_inside(dir, fname):
133
"""True if fname is inside dir.
135
return os.path.commonprefix([dir, fname]) == dir
138
def is_inside_any(dir_list, fname):
139
"""True if fname is inside any of given dirs."""
140
# quick scan for perfect match
141
if fname in dir_list:
144
for dirname in dir_list:
145
if is_inside(dirname, fname):
151
def pumpfile(fromfile, tofile):
152
"""Copy contents of one file to another."""
153
tofile.write(fromfile.read())
157
"""Return a new UUID"""
159
return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
161
return chomp(os.popen('uuidgen').readline())
166
if hasattr(f, 'tell'):
186
def fingerprint_file(f):
192
return {'size': size,
193
'sha1': s.hexdigest()}
197
"""Return per-user configuration directory.
199
By default this is ~/.bzr.conf/
201
TODO: Global option --config-dir to override this.
203
return os.path.expanduser("~/.bzr.conf")
207
"""Calculate automatic user identification.
209
Returns (realname, email).
211
Only used when none is set in the environment or the id file.
213
This previously used the FQDN as the default domain, but that can
214
be very slow on machines where DNS is broken. So now we simply
219
# XXX: Any good way to get real user name on win32?
224
w = pwd.getpwuid(uid)
225
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
226
username = w.pw_name.decode(bzrlib.user_encoding)
227
comma = gecos.find(',')
231
realname = gecos[:comma]
237
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
239
return realname, (username + '@' + socket.gethostname())
243
"""Return the full user id from a file or environment variable.
245
TODO: Allow taking this from a file in the branch directory too
246
for per-branch ids."""
247
v = os.environ.get('BZREMAIL')
249
return v.decode(bzrlib.user_encoding)
252
return (open(os.path.join(config_dir(), "email"))
254
.decode(bzrlib.user_encoding)
257
if e.errno != errno.ENOENT:
260
v = os.environ.get('EMAIL')
262
return v.decode(bzrlib.user_encoding)
268
"""Return email-style username.
270
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
272
TODO: Check it's reasonably well-formed.
278
name, email = _auto_user_id()
280
return '%s <%s>' % (name, email)
285
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
287
"""Return just the email component of a username."""
290
m = _EMAIL_RE.search(e)
292
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
295
return _auto_user_id()[1]
299
def compare_files(a, b):
300
"""Returns true if equal in contents"""
312
def local_time_offset(t=None):
313
"""Return offset of local zone from GMT, either at present or at time t."""
314
# python2.3 localtime() can't take None
318
if time.localtime(t).tm_isdst and time.daylight:
321
return -time.timezone
324
def format_date(t, offset=0, timezone='original'):
325
## TODO: Perhaps a global option to use either universal or local time?
326
## Or perhaps just let people set $TZ?
327
assert isinstance(t, float)
329
if timezone == 'utc':
332
elif timezone == 'original':
335
tt = time.gmtime(t + offset)
336
elif timezone == 'local':
337
tt = time.localtime(t)
338
offset = local_time_offset(t)
340
raise BzrError("unsupported timezone format %r",
341
['options are "utc", "original", "local"'])
343
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
344
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
347
def compact_date(when):
348
return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
353
"""Return size of given open file."""
354
return os.fstat(f.fileno())[ST_SIZE]
357
if hasattr(os, 'urandom'): # python 2.4 and later
358
rand_bytes = os.urandom
359
elif sys.platform == 'linux2':
360
rand_bytes = file('/dev/urandom', 'rb').read
362
# not well seeded, but better than nothing
367
s += chr(random.randint(0, 255))
372
## TODO: We could later have path objects that remember their list
373
## decomposition (might be too tricksy though.)
376
"""Turn string into list of parts.
382
>>> splitpath('a/./b')
384
>>> splitpath('a/.b')
386
>>> splitpath('a/../b')
387
Traceback (most recent call last):
389
BzrError: sorry, '..' not allowed in path
391
assert isinstance(p, types.StringTypes)
393
# split on either delimiter because people might use either on
395
ps = re.split(r'[\\/]', p)
400
raise BzrError("sorry, %r not allowed in path" % f)
401
elif (f == '.') or (f == ''):
408
assert isinstance(p, list)
410
if (f == '..') or (f == None) or (f == ''):
411
raise BzrError("sorry, %r not allowed in path" % f)
412
return os.path.join(*p)
415
def appendpath(p1, p2):
419
return os.path.join(p1, p2)
422
def extern_command(cmd, ignore_errors = False):
423
mutter('external command: %s' % `cmd`)
425
if not ignore_errors:
426
raise BzrError('command failed')
429
def _read_config_value(name):
430
"""Read a config value from the file ~/.bzr.conf/<name>
431
Return None if the file does not exist"""
433
f = file(os.path.join(config_dir(), name), "r")
434
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
436
if e.errno == errno.ENOENT:
442
"""Return a sequence of possible editor binaries for the current platform"""
443
e = _read_config_value("editor")
447
if os.name == "windows":
449
elif os.name == "posix":
451
yield os.environ["EDITOR"]
456
def _run_editor(filename):
457
"""Try to execute an editor to edit the commit message. Returns True on success,
459
for e in _get_editor():
460
x = os.spawnvp(os.P_WAIT, e, (e, filename))
467
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
471
def get_text_message(infotext, ignoreline = "default"):
474
if ignoreline == "default":
475
ignoreline = "-- This line and the following will be ignored --"
478
tmp_fileno, msgfilename = tempfile.mkstemp()
479
msgfile = os.close(tmp_fileno)
480
if infotext is not None and infotext != "":
482
msgfile = file(msgfilename, "w")
483
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
488
if not _run_editor(msgfilename):
493
lastline, nlines = 0, 0
494
for line in file(msgfilename, "r"):
495
stripped_line = line.strip()
496
# strip empty line before the log message starts
498
if stripped_line != "":
502
# check for the ignore line only if there
503
# is additional information at the end
504
if hasinfo and stripped_line == ignoreline:
507
# keep track of the last line that had some content
508
if stripped_line != "":
514
# delete empty lines at the end
516
# add a newline at the end, if needed
517
if not msg[-1].endswith("\n"):
518
return "%s%s" % ("".join(msg), "\n")
522
# delete the msg file in any case
523
try: os.unlink(msgfilename)
added
removed
bzrlib/osutils.py
