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
19
import os, types, re, time, types
20
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
22
from errors import bailout
26
24
def make_readonly(filename):
27
25
"""Make a filename read-only."""
62
54
elif S_ISLNK(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)
57
bailout("can't handle file kind with mode %o of %r" % (mode, f))
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
78
def pumpfile(fromfile, tofile):
182
79
"""Copy contents of one file to another."""
183
80
tofile.write(fromfile.read())
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
118
"""Return email-style username.
120
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
122
:todo: Check it's reasonably well-formed.
124
:todo: Allow taking it from a dotfile to help people on windows
125
who can't easily set variables.
127
:todo: Cope without pwd module, which is only on unix.
129
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
249
# XXX: Any good way to get real user name on win32?
253
136
uid = os.getuid()
254
137
w = pwd.getpwuid(uid)
255
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
256
username = w.pw_name.decode(bzrlib.user_encoding)
257
139
comma = gecos.find(',')
261
143
realname = gecos[:comma]
144
return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
265
145
except ImportError:
267
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
269
return realname, (username + '@' + socket.gethostname())
273
"""Return the full user id from a file or environment variable.
275
TODO: Allow taking this from a file in the branch directory too
276
for per-branch ids."""
277
v = os.environ.get('BZREMAIL')
279
return v.decode(bzrlib.user_encoding)
282
return (open(os.path.join(config_dir(), "email"))
284
.decode(bzrlib.user_encoding)
287
if e.errno != errno.ENOENT:
290
v = os.environ.get('EMAIL')
292
return v.decode(bzrlib.user_encoding)
298
"""Return email-style username.
300
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
302
TODO: Check it's reasonably well-formed.
308
name, email = _auto_user_id()
310
return '%s <%s>' % (name, email)
315
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
148
import getpass, socket
149
return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
316
152
def user_email():
317
153
"""Return just the email component of a username."""
154
e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
320
m = _EMAIL_RE.search(e)
157
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
322
raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
159
bailout('%r is not a reasonable email address' % e)
323
160
return m.group(0)
325
return _auto_user_id()[1]
163
import getpass, socket
164
return '%s@%s' % (getpass.getuser(), socket.getfqdn())
329
169
def compare_files(a, b):
330
170
"""Returns true if equal in contents"""
171
# TODO: don't read the whole thing in one go.
172
result = a.read() == b.read()
342
177
def local_time_offset(t=None):
343
178
"""Return offset of local zone from GMT, either at present or at time t."""
344
# python2.3 localtime() can't take None
348
179
if time.localtime(t).tm_isdst and time.daylight:
349
180
return -time.altzone
367
200
tt = time.localtime(t)
368
201
offset = local_time_offset(t)
370
raise BzrError("unsupported timezone format %r" % timezone,
371
['options are "utc", "original", "local"'])
203
bailout("unsupported timezone format %r",
204
['options are "utc", "original", "local"'])
373
206
return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
374
207
+ ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
387
220
if hasattr(os, 'urandom'): # python 2.4 and later
388
221
rand_bytes = os.urandom
389
elif sys.platform == 'linux2':
390
rand_bytes = file('/dev/urandom', 'rb').read
392
# not well seeded, but better than nothing
397
s += chr(random.randint(0, 255))
223
# FIXME: No good on non-Linux
224
_rand_file = file('/dev/urandom', 'rb')
225
rand_bytes = _rand_file.read
402
228
## TODO: We could later have path objects that remember their list
416
242
>>> splitpath('a/../b')
417
243
Traceback (most recent call last):
419
BzrError: sorry, '..' not allowed in path
245
BzrError: ("sorry, '..' not allowed in path", [])
421
247
assert isinstance(p, types.StringTypes)
423
# split on either delimiter because people might use either on
425
ps = re.split(r'[\\/]', p)
248
ps = [f for f in p.split('/') if f != '.']
430
raise BzrError("sorry, %r not allowed in path" % f)
431
elif (f == '.') or (f == ''):
251
bailout("sorry, %r not allowed in path" % f)
438
255
assert isinstance(p, list)
440
if (f == '..') or (f == None) or (f == ''):
441
raise BzrError("sorry, %r not allowed in path" % f)
442
return os.path.join(*p)
257
if (f == '..') or (f is None) or (f == ''):
258
bailout("sorry, %r not allowed in path" % f)
445
262
def appendpath(p1, p2):
449
return os.path.join(p1, p2)
452
269
def extern_command(cmd, ignore_errors = False):
453
270
mutter('external command: %s' % `cmd`)
454
271
if os.system(cmd):
455
272
if not ignore_errors:
456
raise BzrError('command failed')
459
def _read_config_value(name):
460
"""Read a config value from the file ~/.bzr.conf/<name>
461
Return None if the file does not exist"""
463
f = file(os.path.join(config_dir(), name), "r")
464
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
466
if e.errno == errno.ENOENT:
472
"""Return a sequence of possible editor binaries for the current platform"""
473
e = _read_config_value("editor")
477
if os.name == "windows":
479
elif os.name == "posix":
481
yield os.environ["EDITOR"]
486
def _run_editor(filename):
487
"""Try to execute an editor to edit the commit message. Returns True on success,
489
for e in _get_editor():
490
x = os.spawnvp(os.P_WAIT, e, (e, filename))
497
raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
501
def get_text_message(infotext, ignoreline = "default"):
504
if ignoreline == "default":
505
ignoreline = "-- This line and the following will be ignored --"
508
tmp_fileno, msgfilename = tempfile.mkstemp()
509
msgfile = os.close(tmp_fileno)
510
if infotext is not None and infotext != "":
512
msgfile = file(msgfilename, "w")
513
msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
518
if not _run_editor(msgfilename):
523
lastline, nlines = 0, 0
524
for line in file(msgfilename, "r"):
525
stripped_line = line.strip()
526
# strip empty line before the log message starts
528
if stripped_line != "":
532
# check for the ignore line only if there
533
# is additional information at the end
534
if hasinfo and stripped_line == ignoreline:
537
# keep track of the last line that had some content
538
if stripped_line != "":
544
# delete empty lines at the end
546
# add a newline at the end, if needed
547
if not msg[-1].endswith("\n"):
548
return "%s%s" % ("".join(msg), "\n")
552
# delete the msg file in any case
553
try: os.unlink(msgfilename)
273
bailout('command failed')
added
removed
bzrlib/osutils.py
