120
109
raise BzrError("lstat/stat of (%r): %r" % (f, e))
122
def fancy_rename(old, new, rename_func, unlink_func):
123
"""A fancy rename, when you don't have atomic rename.
125
:param old: The old path, to rename from
126
:param new: The new path, to rename to
127
:param rename_func: The potentially non-atomic rename function
128
:param unlink_func: A way to delete the target file if the full rename succeeds
131
# sftp rename doesn't allow overwriting, so play tricks:
133
base = os.path.basename(new)
134
dirname = os.path.dirname(new)
135
tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
136
tmp_name = pathjoin(dirname, tmp_name)
138
# Rename the file out of the way, but keep track if it didn't exist
139
# We don't want to grab just any exception
140
# something like EACCES should prevent us from continuing
141
# The downside is that the rename_func has to throw an exception
142
# with an errno = ENOENT, or NoSuchFile
145
rename_func(new, tmp_name)
146
except (NoSuchFile,), e:
149
# RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
150
# function raises an IOError with errno == None when a rename fails.
151
# This then gets caught here.
152
if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
155
if (not hasattr(e, 'errno')
156
or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
163
# This may throw an exception, in which case success will
165
rename_func(old, new)
169
# If the file used to exist, rename it back into place
170
# otherwise just delete it from the tmp location
172
unlink_func(tmp_name)
174
rename_func(tmp_name, new)
176
# Default is to just use the python builtins, but these can be rebound on
177
# particular platforms.
178
abspath = os.path.abspath
179
realpath = os.path.realpath
180
pathjoin = os.path.join
181
normpath = os.path.normpath
183
mkdtemp = tempfile.mkdtemp
185
dirname = os.path.dirname
186
basename = os.path.basename
187
rmtree = shutil.rmtree
189
MIN_ABS_PATHLENGTH = 1
191
if os.name == "posix":
192
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
193
# choke on a Unicode string containing a relative path if
194
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
196
_fs_enc = sys.getfilesystemencoding()
198
return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
201
return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
203
if sys.platform == 'win32':
204
# We need to use the Unicode-aware os.path.abspath and
205
# os.path.realpath on Windows systems.
207
return os.path.abspath(path).replace('\\', '/')
210
return os.path.realpath(path).replace('\\', '/')
213
return os.path.join(*args).replace('\\', '/')
216
return os.path.normpath(path).replace('\\', '/')
219
return os.getcwdu().replace('\\', '/')
221
def mkdtemp(*args, **kwargs):
222
return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
224
def rename(old, new):
225
fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
227
MIN_ABS_PATHLENGTH = 3
229
def _win32_delete_readonly(function, path, excinfo):
230
"""Error handler for shutil.rmtree function [for win32]
231
Helps to remove files and dirs marked as read-only.
233
type_, value = excinfo[:2]
234
if function in (os.remove, os.rmdir) \
235
and type_ == OSError \
236
and value.errno == errno.EACCES:
237
bzrlib.osutils.make_writable(path)
242
def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
243
"""Replacer for shutil.rmtree: could remove readonly dirs/files"""
244
return shutil.rmtree(path, ignore_errors, onerror)
247
111
def normalizepath(f):
248
112
if hasattr(os.path, 'realpath'):
252
116
[p,e] = os.path.split(f)
253
117
if e == "" or e == "." or e == "..":
256
return pathjoin(F(p), e)
120
return os.path.join(F(p), e)
259
123
def backup_file(fn):
260
124
"""Copy a file to a backup.
309
175
def is_inside(dir, fname):
310
176
"""True if fname is inside dir.
312
The parameters should typically be passed to osutils.normpath first, so
178
The parameters should typically be passed to os.path.normpath first, so
313
179
that . and .. and repeated slashes are eliminated, and the separators
314
180
are canonical for the platform.
316
182
The empty string as a dir name is taken as top-of-tree and matches
319
>>> is_inside('src', pathjoin('src', 'foo.c'))
185
>>> is_inside('src', os.path.join('src', 'foo.c'))
321
187
>>> is_inside('src', 'srccontrol')
323
>>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
189
>>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
325
191
>>> is_inside('foo.c', 'foo.c')
406
259
'sha1': s.hexdigest()}
263
"""Return per-user configuration directory.
265
By default this is ~/.bzr.conf/
267
TODO: Global option --config-dir to override this.
269
return os.path.join(os.path.expanduser("~"), ".bzr.conf")
273
"""Calculate automatic user identification.
275
Returns (realname, email).
277
Only used when none is set in the environment or the id file.
279
This previously used the FQDN as the default domain, but that can
280
be very slow on machines where DNS is broken. So now we simply
285
# XXX: Any good way to get real user name on win32?
290
w = pwd.getpwuid(uid)
291
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
292
username = w.pw_name.decode(bzrlib.user_encoding)
293
comma = gecos.find(',')
297
realname = gecos[:comma]
303
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
305
return realname, (username + '@' + socket.gethostname())
308
def _get_user_id(branch):
309
"""Return the full user id from a file or environment variable.
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.
323
v = os.environ.get('BZREMAIL')
325
return v.decode(bzrlib.user_encoding)
329
return (branch.controlfile("email", "r")
331
.decode(bzrlib.user_encoding)
334
if e.errno != errno.ENOENT:
340
return (open(os.path.join(config_dir(), "email"))
342
.decode(bzrlib.user_encoding)
345
if e.errno != errno.ENOENT:
348
v = os.environ.get('EMAIL')
350
return v.decode(bzrlib.user_encoding)
355
def username(branch):
356
"""Return email-style username.
358
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
360
TODO: Check it's reasonably well-formed.
362
v = _get_user_id(branch)
366
name, email = _auto_user_id()
368
return '%s <%s>' % (name, email)
373
def user_email(branch):
374
"""Return just the email component of a username."""
375
e = _get_user_id(branch)
377
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
379
raise BzrError("%r doesn't seem to contain "
380
"a reasonable email address" % e)
383
return _auto_user_id()[1]
409
386
def compare_files(a, b):
410
387
"""Returns true if equal in contents"""
545
502
if (f == '..') or (f == None) or (f == ''):
546
503
raise BzrError("sorry, %r not allowed in path" % f)
504
return os.path.join(*p)
550
507
def appendpath(p1, p2):
554
return pathjoin(p1, p2)
511
return os.path.join(p1, p2)
514
def _read_config_value(name):
515
"""Read a config value from the file ~/.bzr.conf/<name>
516
Return None if the file does not exist"""
518
f = file(os.path.join(config_dir(), name), "r")
519
return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
521
if e.errno == errno.ENOENT:
557
526
def split_lines(s):
558
527
"""Split s into lines, but without removing the newline characters."""
559
lines = s.split('\n')
560
result = [line + '\n' for line in lines[:-1]]
562
result.append(lines[-1])
528
return StringIO(s).readlines()
566
531
def hardlinks_good():
580
545
copyfile(src, dest)
582
def delete_any(full_path):
583
"""Delete a file or directory."""
587
# We may be renaming a dangling inventory id
588
if e.errno not in (errno.EISDIR, errno.EACCES, errno.EPERM):
593
548
def has_symlinks():
594
549
if hasattr(os, 'symlink'):
600
def contains_whitespace(s):
601
"""True if there are any whitespace characters in s."""
602
for ch in string.whitespace:
609
def contains_linebreaks(s):
610
"""True if there is any vertical whitespace in s."""
618
def relpath(base, path):
619
"""Return path relative to base, or raise exception.
621
The path may be either an absolute path or a path relative to the
622
current working directory.
624
os.path.commonprefix (python2.4) has a bad bug that it works just
625
on string prefixes, assuming that '/u' is a prefix of '/u2'. This
629
assert len(base) >= MIN_ABS_PATHLENGTH, ('Length of base must be equal or'
630
' exceed the platform minimum length (which is %d)' %
636
while len(head) >= len(base):
639
head, tail = os.path.split(head)
643
# XXX This should raise a NotChildPath exception, as its not tied
645
raise PathNotChild(rp, base)
653
def safe_unicode(unicode_or_utf8_string):
654
"""Coerce unicode_or_utf8_string into unicode.
656
If it is unicode, it is returned.
657
Otherwise it is decoded from utf-8. If a decoding error
658
occurs, it is wrapped as a If the decoding fails, the exception is wrapped
659
as a BzrBadParameter exception.
661
if isinstance(unicode_or_utf8_string, unicode):
662
return unicode_or_utf8_string
664
return unicode_or_utf8_string.decode('utf8')
665
except UnicodeDecodeError:
666
raise BzrBadParameterNotUnicode(unicode_or_utf8_string)
669
def terminal_width():
670
"""Return estimated terminal width."""
671
if sys.platform == 'win32':
672
import bzrlib.win32console
673
return bzrlib.win32console.get_console_size()[0]
676
import struct, fcntl, termios
677
s = struct.pack('HHHH', 0, 0, 0, 0)
678
x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
679
width = struct.unpack('HHHH', x)[1]
684
width = int(os.environ['COLUMNS'])
692
def supports_executable():
693
return sys.platform != "win32"
696
def strip_trailing_slash(path):
697
"""Strip trailing slash, except for root paths.
698
The definition of 'root path' is platform-dependent.
700
if len(path) != MIN_ABS_PATHLENGTH and path[-1] == '/':
706
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
709
def check_legal_path(path):
710
"""Check whether the supplied path is legal.
711
This is only required on Windows, so we don't test on other platforms
714
if sys.platform != "win32":
716
if _validWin32PathRE.match(path) is None:
717
raise IllegalPath(path)
added
removed
bzrlib/osutils.py
