1
1
# Bazaar-NG -- distributed version control
3
3
# Copyright (C) 2005 by Canonical Ltd
5
5
# This program is free software; you can redistribute it and/or modify
6
6
# it under the terms of the GNU General Public License as published by
7
7
# the Free Software Foundation; either version 2 of the License, or
8
8
# (at your option) any later version.
10
10
# This program is distributed in the hope that it will be useful,
11
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
13
# GNU General Public License for more details.
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
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
19
from shutil import copyfile
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
21
S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
22
from cStringIO import StringIO
22
32
from bzrlib.errors import BzrError
23
33
from bzrlib.trace import mutter
26
36
def make_readonly(filename):
27
37
"""Make a filename read-only."""
28
# TODO: probably needs to be fixed for windows
29
38
mod = os.stat(filename).st_mode
30
39
mod = mod & 0777555
31
40
os.chmod(filename, mod)
37
46
os.chmod(filename, mod)
40
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
42
53
"""Return a quoted filename filename
44
55
This previously used backslash quoting, but that works poorly on
46
57
# TODO: I'm not really sure this is the best format either.x
60
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
47
62
if _QUOTE_RE.search(f):
48
63
return '"' + f + '"'
73
96
raise BzrError('invalid file kind %r' % kind)
100
if hasattr(os, 'lstat'):
106
if e.errno == errno.ENOENT:
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
111
def normalizepath(f):
112
if hasattr(os.path, 'realpath'):
116
[p,e] = os.path.split(f)
117
if e == "" or e == "." or e == "..":
120
return os.path.join(F(p), e)
77
123
def backup_file(fn):
78
124
"""Copy a file to a backup.
169
"""True if f is a symlink."""
171
return S_ISLNK(os.lstat(f)[ST_MODE])
121
175
def is_inside(dir, fname):
122
176
"""True if fname is inside dir.
178
The parameters should typically be passed to os.path.normpath first, so
179
that . and .. and repeated slashes are eliminated, and the separators
180
are canonical for the platform.
182
The empty string as a dir name is taken as top-of-tree and matches
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
187
>>> is_inside('src', 'srccontrol')
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
191
>>> is_inside('foo.c', 'foo.c')
193
>>> is_inside('foo.c', '')
195
>>> is_inside('', 'foo.c')
124
return os.path.commonprefix([dir, fname]) == dir
198
# XXX: Most callers of this can actually do something smarter by
199
# looking at the inventory
206
if dir[-1] != os.sep:
209
return fname.startswith(dir)
127
212
def is_inside_any(dir_list, fname):
128
213
"""True if fname is inside any of given dirs."""
129
# quick scan for perfect match
130
if fname in dir_list:
133
214
for dirname in dir_list:
134
215
if is_inside(dirname, fname):
228
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
232
309
"""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."""
311
e.g. "John Hacker <jhacker@foo.org>"
314
A branch to use for a per-branch configuration, or None.
316
The following are searched in order:
319
2. .bzr/email for this branch.
236
323
v = os.environ.get('BZREMAIL')
238
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
241
340
return (open(os.path.join(config_dir(), "email"))
274
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
373
def user_email(branch):
276
374
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
279
m = _EMAIL_RE.search(e)
377
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
281
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
282
381
return m.group(0)
284
383
return _auto_user_id()[1]
288
386
def compare_files(a, b):
326
423
tt = time.localtime(t)
327
424
offset = local_time_offset(t)
329
raise BzrError("unsupported timezone format %r",
330
['options are "utc", "original", "local"'])
426
raise BzrError("unsupported timezone format %r" % timezone,
427
['options are "utc", "original", "local"'])
332
429
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
333
430
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
342
439
"""Return size of given open file."""
343
440
return os.fstat(f.fileno())[ST_SIZE]
346
if hasattr(os, 'urandom'): # python 2.4 and later
442
# Define rand_bytes based on platform.
444
# Python 2.4 and later have os.urandom,
445
# but it doesn't work on some arches
347
447
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))
448
except (NotImplementedError, AttributeError):
449
# If python doesn't have os.urandom, or it doesn't work,
450
# then try to first pull random data from /dev/urandom
451
if os.path.exists("/dev/urandom"):
452
rand_bytes = file('/dev/urandom', 'rb').read
453
# Otherwise, use this hack as a last resort
455
# not well seeded, but better than nothing
460
s += chr(random.randint(0, 255))
361
464
## TODO: We could later have path objects that remember their list
362
465
## decomposition (might be too tricksy though.)
408
511
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
514
def _read_config_value(name):
419
515
"""Read a config value from the file ~/.bzr.conf/<name>
420
516
Return None if the file does not exist"""
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 --"
527
"""Split s into lines, but without removing the newline characters."""
528
return StringIO(s).readlines()
531
def hardlinks_good():
532
return sys.platform not in ('win32', 'cygwin', 'darwin')
535
def link_or_copy(src, dest):
536
"""Hardlink a file, or copy it if it can't be hardlinked."""
537
if not hardlinks_good():
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)
542
except (OSError, IOError), e:
543
if e.errno != errno.EXDEV:
549
if hasattr(os, 'symlink'):
added
removed
bzrlib/osutils.py
