102
96
raise BzrError('invalid file kind %r' % kind)
105
if hasattr(os.path, 'lexists'):
106
return os.path.lexists(f)
108
if hasattr(os, 'lstat'):
114
if e.errno == errno.ENOENT:
117
raise BzrError("lstat/stat of (%r): %r" % (f, e))
119
def fancy_rename(old, new, rename_func, unlink_func):
120
"""A fancy rename, when you don't have atomic rename.
122
:param old: The old path, to rename from
123
:param new: The new path, to rename to
124
:param rename_func: The potentially non-atomic rename function
125
:param unlink_func: A way to delete the target file if the full rename succeeds
128
# sftp rename doesn't allow overwriting, so play tricks:
130
base = os.path.basename(new)
131
dirname = os.path.dirname(new)
132
tmp_name = u'tmp.%s.%.9f.%d.%d' % (base, time.time(), os.getpid(), random.randint(0, 0x7FFFFFFF))
133
tmp_name = pathjoin(dirname, tmp_name)
135
# Rename the file out of the way, but keep track if it didn't exist
136
# We don't want to grab just any exception
137
# something like EACCES should prevent us from continuing
138
# The downside is that the rename_func has to throw an exception
139
# with an errno = ENOENT, or NoSuchFile
142
rename_func(new, tmp_name)
143
except (NoSuchFile,), e:
146
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
147
# function raises an IOError with errno == None when a rename fails.
148
# This then gets caught here.
149
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
152
if (not hasattr(e, 'errno')
153
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
160
# This may throw an exception, in which case success will
162
rename_func(old, new)
166
# If the file used to exist, rename it back into place
167
# otherwise just delete it from the tmp location
169
unlink_func(tmp_name)
171
rename_func(tmp_name, new)
173
# Default is to just use the python builtins
174
abspath = os.path.abspath
175
realpath = os.path.realpath
176
pathjoin = os.path.join
177
normpath = os.path.normpath
179
mkdtemp = tempfile.mkdtemp
181
dirname = os.path.dirname
182
basename = os.path.basename
184
if os.name == "posix":
185
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
186
# choke on a Unicode string containing a relative path if
187
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
189
_fs_enc = sys.getfilesystemencoding()
191
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
194
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
196
if sys.platform == 'win32':
197
# We need to use the Unicode-aware os.path.abspath and
198
# os.path.realpath on Windows systems.
200
return os.path.abspath(path).replace('\\', '/')
203
return os.path.realpath(path).replace('\\', '/')
206
return os.path.join(*args).replace('\\', '/')
209
return os.path.normpath(path).replace('\\', '/')
212
return os.getcwdu().replace('\\', '/')
214
def mkdtemp(*args, **kwargs):
215
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
217
def rename(old, new):
218
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
221
def normalizepath(f):
222
if hasattr(os.path, 'realpath'):
226
[p,e] = os.path.split(f)
227
if e == "" or e == "." or e == "..":
230
return pathjoin(F(p), e)
233
99
def backup_file(fn):
234
100
"""Copy a file to a backup.
277
"""True if f is a symlink."""
279
return S_ISLNK(os.lstat(f)[ST_MODE])
283
145
def is_inside(dir, fname):
284
146
"""True if fname is inside dir.
286
The parameters should typically be passed to osutils.normpath first, so
148
The parameters should typically be passed to os.path.normpath first, so
287
149
that . and .. and repeated slashes are eliminated, and the separators
288
150
are canonical for the platform.
290
152
The empty string as a dir name is taken as top-of-tree and matches
293
>>> is_inside('src', pathjoin('src', 'foo.c'))
155
>>> is_inside('src', os.path.join('src', 'foo.c'))
295
157
>>> is_inside('src', 'srccontrol')
297
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
159
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
299
161
>>> is_inside('foo.c', 'foo.c')
372
229
'sha1': s.hexdigest()}
233
"""Return per-user configuration directory.
235
By default this is ~/.bzr.conf/
237
TODO: Global option --config-dir to override this.
239
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
243
"""Calculate automatic user identification.
245
Returns (realname, email).
247
Only used when none is set in the environment or the id file.
249
This previously used the FQDN as the default domain, but that can
250
be very slow on machines where DNS is broken. So now we simply
255
# XXX: Any good way to get real user name on win32?
260
w = pwd.getpwuid(uid)
261
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
262
username = w.pw_name.decode(bzrlib.user_encoding)
263
comma = gecos.find(',')
267
realname = gecos[:comma]
273
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
275
return realname, (username + '@' + socket.gethostname())
278
def _get_user_id(branch):
279
"""Return the full user id from a file or environment variable.
281
e.g. "John Hacker <jhacker@foo.org>"
284
A branch to use for a per-branch configuration, or None.
286
The following are searched in order:
289
2. .bzr/email for this branch.
293
v = os.environ.get('BZREMAIL')
295
return v.decode(bzrlib.user_encoding)
299
return (branch.controlfile("email", "r")
301
.decode(bzrlib.user_encoding)
304
if e.errno != errno.ENOENT:
310
return (open(os.path.join(config_dir(), "email"))
312
.decode(bzrlib.user_encoding)
315
if e.errno != errno.ENOENT:
318
v = os.environ.get('EMAIL')
320
return v.decode(bzrlib.user_encoding)
325
def username(branch):
326
"""Return email-style username.
328
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
330
TODO: Check it's reasonably well-formed.
332
v = _get_user_id(branch)
336
name, email = _auto_user_id()
338
return '%s <%s>' % (name, email)
343
def user_email(branch):
344
"""Return just the email component of a username."""
345
e = _get_user_id(branch)
347
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
349
raise BzrError("%r doesn't seem to contain "
350
"a reasonable email address" % e)
353
return _auto_user_id()[1]
375
356
def compare_files(a, b):
376
357
"""Returns true if equal in contents"""
496
472
if (f == '..') or (f == None) or (f == ''):
497
473
raise BzrError("sorry, %r not allowed in path" % f)
474
return os.path.join(*p)
501
477
def appendpath(p1, p2):
505
return pathjoin(p1, p2)
481
return os.path.join(p1, p2)
484
def _read_config_value(name):
485
"""Read a config value from the file ~/.bzr.conf/<name>
486
Return None if the file does not exist"""
488
f = file(os.path.join(config_dir(), name), "r")
489
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
491
if e.errno == errno.ENOENT:
508
496
def split_lines(s):
509
497
"""Split s into lines, but without removing the newline characters."""
510
498
return StringIO(s).readlines()
525
513
if e.errno != errno.EXDEV:
527
515
copyfile(src, dest)
531
if hasattr(os, 'symlink'):
537
def contains_whitespace(s):
538
"""True if there are any whitespace characters in s."""
539
for ch in string.whitespace:
546
def contains_linebreaks(s):
547
"""True if there is any vertical whitespace in s."""
555
def relpath(base, path):
556
"""Return path relative to base, or raise exception.
558
The path may be either an absolute path or a path relative to the
559
current working directory.
561
os.path.commonprefix (python2.4) has a bad bug that it works just
562
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
563
avoids that problem."""
568
while len(head) >= len(base):
571
head, tail = os.path.split(head)
575
# XXX This should raise a NotChildPath exception, as its not tied
577
raise PathNotChild(rp, base)
585
def safe_unicode(unicode_or_utf8_string):
586
"""Coerce unicode_or_utf8_string into unicode.
588
If it is unicode, it is returned.
589
Otherwise it is decoded from utf-8. If a decoding error
590
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
591
as a BzrBadParameter exception.
593
if isinstance(unicode_or_utf8_string, unicode):
594
return unicode_or_utf8_string
596
return unicode_or_utf8_string.decode('utf8')
597
except UnicodeDecodeError:
598
raise BzrBadParameter(unicode_or_utf8_string)
601
def terminal_width():
602
"""Return estimated terminal width."""
604
# TODO: Do something smart on Windows?
606
# TODO: Is there anything that gets a better update when the window
607
# is resized while the program is running? We could use the Python termcap
610
return int(os.environ['COLUMNS'])
611
except (IndexError, KeyError, ValueError):
added
removed
bzrlib/osutils.py
