← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

Merge from integration.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
28
28
import sys
29
29
import time
30
30
import types
 
31
import tempfile
31
32
 
32
33
import bzrlib
33
 
from bzrlib.errors import BzrError, NotBranchError
 
34
from bzrlib.errors import (BzrError,
 
35
                           BzrBadParameter,
 
36
                           NoSuchFile,
 
37
                           PathNotChild,
 
38
                           )
34
39
from bzrlib.trace import mutter
35
40
 
36
41
 
97
102
        raise BzrError('invalid file kind %r' % kind)
98
103
 
99
104
def lexists(f):
 
105
    if hasattr(os.path, 'lexists'):
 
106
        return os.path.lexists(f)
100
107
    try:
101
108
        if hasattr(os, 'lstat'):
102
109
            os.lstat(f)
109
116
        else:
110
117
            raise BzrError("lstat/stat of (%r): %r" % (f, e))
111
118
 
112
 
def normalizepath(f):
113
 
    if hasattr(os.path, 'realpath'):
114
 
        F = os.path.realpath
115
 
    else:
116
 
        F = os.path.abspath
117
 
    [p,e] = os.path.split(f)
118
 
    if e == "" or e == "." or e == "..":
119
 
        return F(f)
120
 
    else:
121
 
        return os.path.join(F(p), e)
 
119
def fancy_rename(old, new, rename_func, unlink_func):
 
120
    """A fancy rename, when you don't have atomic rename.
 
121
    
 
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
 
126
    """
 
127
 
 
128
    # sftp rename doesn't allow overwriting, so play tricks:
 
129
    import random
 
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)
 
134
 
 
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
 
140
    file_existed = False
 
141
    try:
 
142
        rename_func(new, tmp_name)
 
143
    except (NoSuchFile,), e:
 
144
        pass
 
145
    except IOError, 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):
 
150
            raise
 
151
    except Exception, e:
 
152
        if (not hasattr(e, 'errno') 
 
153
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
154
            raise
 
155
    else:
 
156
        file_existed = True
 
157
 
 
158
    success = False
 
159
    try:
 
160
        # This may throw an exception, in which case success will
 
161
        # not be set.
 
162
        rename_func(old, new)
 
163
        success = True
 
164
    finally:
 
165
        if file_existed:
 
166
            # If the file used to exist, rename it back into place
 
167
            # otherwise just delete it from the tmp location
 
168
            if success:
 
169
                unlink_func(tmp_name)
 
170
            else:
 
171
                rename_func(tmp_name, new)
 
172
 
 
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
 
178
getcwd = os.getcwdu
 
179
mkdtemp = tempfile.mkdtemp
 
180
rename = os.rename
 
181
dirname = os.path.dirname
 
182
basename = os.path.basename
122
183
 
123
184
if os.name == "posix":
124
185
    # In Python 2.4.2 and older, os.path.abspath and os.path.realpath
128
189
    _fs_enc = sys.getfilesystemencoding()
129
190
    def abspath(path):
130
191
        return os.path.abspath(path.encode(_fs_enc)).decode(_fs_enc)
 
192
 
131
193
    def realpath(path):
132
194
        return os.path.realpath(path.encode(_fs_enc)).decode(_fs_enc)
133
 
else:
 
195
 
 
196
if sys.platform == 'win32':
134
197
    # We need to use the Unicode-aware os.path.abspath and
135
198
    # os.path.realpath on Windows systems.
136
 
    abspath = os.path.abspath
137
 
    realpath = os.path.realpath
 
199
    def abspath(path):
 
200
        return os.path.abspath(path).replace('\\', '/')
 
201
 
 
202
    def realpath(path):
 
203
        return os.path.realpath(path).replace('\\', '/')
 
204
 
 
205
    def pathjoin(*args):
 
206
        return os.path.join(*args).replace('\\', '/')
 
207
 
 
208
    def normpath(path):
 
209
        return os.path.normpath(path).replace('\\', '/')
 
210
 
 
211
    def getcwd():
 
212
        return os.getcwdu().replace('\\', '/')
 
213
 
 
214
    def mkdtemp(*args, **kwargs):
 
215
        return tempfile.mkdtemp(*args, **kwargs).replace('\\', '/')
 
216
 
 
217
    def rename(old, new):
 
218
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
219
 
 
220
 
 
221
def normalizepath(f):
 
222
    if hasattr(os.path, 'realpath'):
 
223
        F = realpath
 
224
    else:
 
225
        F = abspath
 
226
    [p,e] = os.path.split(f)
 
227
    if e == "" or e == "." or e == "..":
 
228
        return F(f)
 
229
    else:
 
230
        return pathjoin(F(p), e)
 
231
 
138
232
 
139
233
def backup_file(fn):
140
234
    """Copy a file to a backup.
163
257
    finally:
164
258
        outf.close()
165
259
 
166
 
if os.name == 'nt':
167
 
    import shutil
168
 
    rename = shutil.move
169
 
else:
170
 
    rename = os.rename
171
 
 
172
260
 
173
261
def isdir(f):
174
262
    """True if f is an accessible directory."""
195
283
def is_inside(dir, fname):
196
284
    """True if fname is inside dir.
197
285
    
198
 
    The parameters should typically be passed to os.path.normpath first, so
 
286
    The parameters should typically be passed to osutils.normpath first, so
199
287
    that . and .. and repeated slashes are eliminated, and the separators
200
288
    are canonical for the platform.
201
289
    
202
290
    The empty string as a dir name is taken as top-of-tree and matches 
203
291
    everything.
204
292
    
205
 
    >>> is_inside('src', os.path.join('src', 'foo.c'))
 
293
    >>> is_inside('src', pathjoin('src', 'foo.c'))
206
294
    True
207
295
    >>> is_inside('src', 'srccontrol')
208
296
    False
209
 
    >>> is_inside('src', os.path.join('src', 'a', 'a', 'a', 'foo.c'))
 
297
    >>> is_inside('src', pathjoin('src', 'a', 'a', 'a', 'foo.c'))
210
298
    True
211
299
    >>> is_inside('foo.c', 'foo.c')
212
300
    True
223
311
    if dir == '':
224
312
        return True
225
313
 
226
 
    if dir[-1] != os.sep:
227
 
        dir += os.sep
 
314
    if dir[-1] != '/':
 
315
        dir += '/'
228
316
 
229
317
    return fname.startswith(dir)
230
318
 
240
328
 
241
329
def pumpfile(fromfile, tofile):
242
330
    """Copy contents of one file to another."""
243
 
    tofile.write(fromfile.read())
 
331
    BUFSIZE = 32768
 
332
    while True:
 
333
        b = fromfile.read(BUFSIZE)
 
334
        if not b:
 
335
            break
 
336
        tofile.write(b)
244
337
 
245
338
 
246
339
def sha_file(f):
402
495
    for f in p:
403
496
        if (f == '..') or (f == None) or (f == ''):
404
497
            raise BzrError("sorry, %r not allowed in path" % f)
405
 
    return os.path.join(*p)
 
498
    return pathjoin(*p)
406
499
 
407
500
 
408
501
def appendpath(p1, p2):
409
502
    if p1 == '':
410
503
        return p2
411
504
    else:
412
 
        return os.path.join(p1, p2)
 
505
        return pathjoin(p1, p2)
413
506
    
414
507
 
415
508
def split_lines(s):
481
574
    else:
482
575
        # XXX This should raise a NotChildPath exception, as its not tied
483
576
        # to branch anymore.
484
 
        raise NotBranchError("path %r is not within branch %r" % (rp, base))
485
 
 
486
 
    return os.sep.join(s)
 
577
        raise PathNotChild(rp, base)
 
578
 
 
579
    if s:
 
580
        return pathjoin(*s)
 
581
    else:
 
582
        return ''
 
583
 
 
584
 
 
585
def safe_unicode(unicode_or_utf8_string):
 
586
    """Coerce unicode_or_utf8_string into unicode.
 
587
 
 
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.
 
592
    """
 
593
    if isinstance(unicode_or_utf8_string, unicode):
 
594
        return unicode_or_utf8_string
 
595
    try:
 
596
        return unicode_or_utf8_string.decode('utf8')
 
597
    except UnicodeDecodeError:
 
598
        raise BzrBadParameter(unicode_or_utf8_string)
 
599
 
 
600
 
 
601
def terminal_width():
 
602
    """Return estimated terminal width."""
 
603
 
 
604
    # TODO: Do something smart on Windows?
 
605
 
 
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
 
608
    # library.
 
609
    try:
 
610
        return int(os.environ['COLUMNS'])
 
611
    except (IndexError, KeyError, ValueError):
 
612
        return 80