/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

Fix 1 more lock-related test failure.

* tests/test_rename_map.py:
(TestRenameMap.test_guess_renames_preserves_children): Add the
forgotten unlock.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
1
 
# Bazaar-NG -- distributed version control
2
 
 
3
 
# Copyright (C) 2005 by Canonical Ltd
4
 
 
 
1
# Copyright (C) 2005, 2006, 2007, 2009 Canonical Ltd
 
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
7
5
# the Free Software Foundation; either version 2 of the License, or
8
6
# (at your option) any later version.
9
 
 
 
7
#
10
8
# This program is distributed in the hope that it will be useful,
11
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
11
# GNU General Public License for more details.
14
 
 
 
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
 
 
19
 
import os, types, re, time, errno, sys
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
 
 
22
 
from bzrlib.errors import BzrError
23
 
from bzrlib.trace import mutter
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
import os
 
18
import re
 
19
import stat
 
20
from stat import (S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE,
 
21
                  S_ISCHR, S_ISBLK, S_ISFIFO, S_ISSOCK)
 
22
import sys
 
23
import time
 
24
 
 
25
from bzrlib.lazy_import import lazy_import
 
26
lazy_import(globals(), """
 
27
import codecs
 
28
from datetime import datetime
 
29
import errno
 
30
from ntpath import (abspath as _nt_abspath,
 
31
                    join as _nt_join,
 
32
                    normpath as _nt_normpath,
 
33
                    realpath as _nt_realpath,
 
34
                    splitdrive as _nt_splitdrive,
 
35
                    )
 
36
import posixpath
 
37
import shutil
 
38
from shutil import (
 
39
    rmtree,
 
40
    )
 
41
import tempfile
 
42
from tempfile import (
 
43
    mkdtemp,
 
44
    )
 
45
import unicodedata
 
46
 
 
47
from bzrlib import (
 
48
    cache_utf8,
 
49
    errors,
 
50
    win32utils,
 
51
    )
 
52
""")
 
53
 
 
54
# sha and md5 modules are deprecated in python2.6 but hashlib is available as
 
55
# of 2.5
 
56
if sys.version_info < (2, 5):
 
57
    import md5 as _mod_md5
 
58
    md5 = _mod_md5.new
 
59
    import sha as _mod_sha
 
60
    sha = _mod_sha.new
 
61
else:
 
62
    from hashlib import (
 
63
        md5,
 
64
        sha1 as sha,
 
65
        )
 
66
 
 
67
 
24
68
import bzrlib
 
69
from bzrlib import symbol_versioning
 
70
 
 
71
 
 
72
# On win32, O_BINARY is used to indicate the file should
 
73
# be opened in binary mode, rather than text mode.
 
74
# On other platforms, O_BINARY doesn't exist, because
 
75
# they always open in binary mode, so it is okay to
 
76
# OR with 0 on those platforms
 
77
O_BINARY = getattr(os, 'O_BINARY', 0)
 
78
 
25
79
 
26
80
def make_readonly(filename):
27
81
    """Make a filename read-only."""
28
 
    # TODO: probably needs to be fixed for windows
29
 
    mod = os.stat(filename).st_mode
30
 
    mod = mod & 0777555
31
 
    os.chmod(filename, mod)
 
82
    mod = os.lstat(filename).st_mode
 
83
    if not stat.S_ISLNK(mod):
 
84
        mod = mod & 0777555
 
85
        os.chmod(filename, mod)
32
86
 
33
87
 
34
88
def make_writable(filename):
35
 
    mod = os.stat(filename).st_mode
36
 
    mod = mod | 0200
37
 
    os.chmod(filename, mod)
38
 
 
39
 
 
40
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
41
 
 
42
 
_SLASH_RE = re.compile(r'[\\/]+')
 
89
    mod = os.lstat(filename).st_mode
 
90
    if not stat.S_ISLNK(mod):
 
91
        mod = mod | 0200
 
92
        os.chmod(filename, mod)
 
93
 
 
94
 
 
95
def minimum_path_selection(paths):
 
96
    """Return the smallset subset of paths which are outside paths.
 
97
 
 
98
    :param paths: A container (and hence not None) of paths.
 
99
    :return: A set of paths sufficient to include everything in paths via
 
100
        is_inside_any, drawn from the paths parameter.
 
101
    """
 
102
    search_paths = set()
 
103
    paths = set(paths)
 
104
    for path in paths:
 
105
        other_paths = paths.difference([path])
 
106
        if not is_inside_any(other_paths, path):
 
107
            # this is a top level path, we must check it.
 
108
            search_paths.add(path)
 
109
    return search_paths
 
110
 
 
111
 
 
112
_QUOTE_RE = None
 
113
 
43
114
 
44
115
def quotefn(f):
45
116
    """Return a quoted filename filename
47
118
    This previously used backslash quoting, but that works poorly on
48
119
    Windows."""
49
120
    # TODO: I'm not really sure this is the best format either.x
 
121
    global _QUOTE_RE
 
122
    if _QUOTE_RE is None:
 
123
        _QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/\\_~-])')
 
124
 
50
125
    if _QUOTE_RE.search(f):
51
126
        return '"' + f + '"'
52
127
    else:
53
128
        return f
54
129
 
55
130
 
56
 
def file_kind(f):
57
 
    mode = os.lstat(f)[ST_MODE]
58
 
    if S_ISREG(mode):
59
 
        return 'file'
60
 
    elif S_ISDIR(mode):
61
 
        return 'directory'
62
 
    elif S_ISLNK(mode):
63
 
        return 'symlink'
64
 
    else:
65
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
 
131
_directory_kind = 'directory'
 
132
 
 
133
def get_umask():
 
134
    """Return the current umask"""
 
135
    # Assume that people aren't messing with the umask while running
 
136
    # XXX: This is not thread safe, but there is no way to get the
 
137
    #      umask without setting it
 
138
    umask = os.umask(0)
 
139
    os.umask(umask)
 
140
    return umask
 
141
 
 
142
 
 
143
_kind_marker_map = {
 
144
    "file": "",
 
145
    _directory_kind: "/",
 
146
    "symlink": "@",
 
147
    'tree-reference': '+',
 
148
}
66
149
 
67
150
 
68
151
def kind_marker(kind):
69
 
    if kind == 'file':
70
 
        return ''
71
 
    elif kind == 'directory':
72
 
        return '/'
73
 
    elif kind == 'symlink':
74
 
        return '@'
75
 
    else:
76
 
        raise BzrError('invalid file kind %r' % kind)
77
 
 
78
 
 
79
 
 
80
 
def backup_file(fn):
81
 
    """Copy a file to a backup.
82
 
 
83
 
    Backups are named in GNU-style, with a ~ suffix.
84
 
 
85
 
    If the file is already a backup, it's not copied.
86
 
    """
87
 
    import os
88
 
    if fn[-1] == '~':
89
 
        return
90
 
    bfn = fn + '~'
91
 
 
92
 
    inf = file(fn, 'rb')
93
 
    try:
94
 
        content = inf.read()
95
 
    finally:
96
 
        inf.close()
97
 
    
98
 
    outf = file(bfn, 'wb')
99
 
    try:
100
 
        outf.write(content)
101
 
    finally:
102
 
        outf.close()
103
 
 
104
 
def rename(path_from, path_to):
105
 
    """Basically the same as os.rename() just special for win32"""
106
 
    if sys.platform == 'win32':
 
152
    try:
 
153
        return _kind_marker_map[kind]
 
154
    except KeyError:
 
155
        raise errors.BzrError('invalid file kind %r' % kind)
 
156
 
 
157
 
 
158
lexists = getattr(os.path, 'lexists', None)
 
159
if lexists is None:
 
160
    def lexists(f):
107
161
        try:
108
 
            os.remove(path_to)
 
162
            stat = getattr(os, 'lstat', os.stat)
 
163
            stat(f)
 
164
            return True
109
165
        except OSError, e:
110
 
            if e.errno != e.ENOENT:
 
166
            if e.errno == errno.ENOENT:
 
167
                return False;
 
168
            else:
 
169
                raise errors.BzrError("lstat/stat of (%r): %r" % (f, e))
 
170
 
 
171
 
 
172
def fancy_rename(old, new, rename_func, unlink_func):
 
173
    """A fancy rename, when you don't have atomic rename.
 
174
 
 
175
    :param old: The old path, to rename from
 
176
    :param new: The new path, to rename to
 
177
    :param rename_func: The potentially non-atomic rename function
 
178
    :param unlink_func: A way to delete the target file if the full rename succeeds
 
179
    """
 
180
 
 
181
    # sftp rename doesn't allow overwriting, so play tricks:
 
182
    base = os.path.basename(new)
 
183
    dirname = os.path.dirname(new)
 
184
    tmp_name = u'tmp.%s.%.9f.%d.%s' % (base, time.time(), os.getpid(), rand_chars(10))
 
185
    tmp_name = pathjoin(dirname, tmp_name)
 
186
 
 
187
    # Rename the file out of the way, but keep track if it didn't exist
 
188
    # We don't want to grab just any exception
 
189
    # something like EACCES should prevent us from continuing
 
190
    # The downside is that the rename_func has to throw an exception
 
191
    # with an errno = ENOENT, or NoSuchFile
 
192
    file_existed = False
 
193
    try:
 
194
        rename_func(new, tmp_name)
 
195
    except (errors.NoSuchFile,), e:
 
196
        pass
 
197
    except IOError, e:
 
198
        # RBC 20060103 abstraction leakage: the paramiko SFTP clients rename
 
199
        # function raises an IOError with errno is None when a rename fails.
 
200
        # This then gets caught here.
 
201
        if e.errno not in (None, errno.ENOENT, errno.ENOTDIR):
 
202
            raise
 
203
    except Exception, e:
 
204
        if (getattr(e, 'errno', None) is None
 
205
            or e.errno not in (errno.ENOENT, errno.ENOTDIR)):
 
206
            raise
 
207
    else:
 
208
        file_existed = True
 
209
 
 
210
    success = False
 
211
    try:
 
212
        try:
 
213
            # This may throw an exception, in which case success will
 
214
            # not be set.
 
215
            rename_func(old, new)
 
216
            success = True
 
217
        except (IOError, OSError), e:
 
218
            # source and target may be aliases of each other (e.g. on a
 
219
            # case-insensitive filesystem), so we may have accidentally renamed
 
220
            # source by when we tried to rename target
 
221
            if not (file_existed and e.errno in (None, errno.ENOENT)):
111
222
                raise
112
 
    os.rename(path_from, path_to)
113
 
 
114
 
 
115
 
 
 
223
    finally:
 
224
        if file_existed:
 
225
            # If the file used to exist, rename it back into place
 
226
            # otherwise just delete it from the tmp location
 
227
            if success:
 
228
                unlink_func(tmp_name)
 
229
            else:
 
230
                rename_func(tmp_name, new)
 
231
 
 
232
 
 
233
# In Python 2.4.2 and older, os.path.abspath and os.path.realpath
 
234
# choke on a Unicode string containing a relative path if
 
235
# os.getcwd() returns a non-sys.getdefaultencoding()-encoded
 
236
# string.
 
237
_fs_enc = sys.getfilesystemencoding() or 'utf-8'
 
238
def _posix_abspath(path):
 
239
    # jam 20060426 rather than encoding to fsencoding
 
240
    # copy posixpath.abspath, but use os.getcwdu instead
 
241
    if not posixpath.isabs(path):
 
242
        path = posixpath.join(getcwd(), path)
 
243
    return posixpath.normpath(path)
 
244
 
 
245
 
 
246
def _posix_realpath(path):
 
247
    return posixpath.realpath(path.encode(_fs_enc)).decode(_fs_enc)
 
248
 
 
249
 
 
250
def _win32_fixdrive(path):
 
251
    """Force drive letters to be consistent.
 
252
 
 
253
    win32 is inconsistent whether it returns lower or upper case
 
254
    and even if it was consistent the user might type the other
 
255
    so we force it to uppercase
 
256
    running python.exe under cmd.exe return capital C:\\
 
257
    running win32 python inside a cygwin shell returns lowercase c:\\
 
258
    """
 
259
    drive, path = _nt_splitdrive(path)
 
260
    return drive.upper() + path
 
261
 
 
262
 
 
263
def _win32_abspath(path):
 
264
    # Real _nt_abspath doesn't have a problem with a unicode cwd
 
265
    return _win32_fixdrive(_nt_abspath(unicode(path)).replace('\\', '/'))
 
266
 
 
267
 
 
268
def _win98_abspath(path):
 
269
    """Return the absolute version of a path.
 
270
    Windows 98 safe implementation (python reimplementation
 
271
    of Win32 API function GetFullPathNameW)
 
272
    """
 
273
    # Corner cases:
 
274
    #   C:\path     => C:/path
 
275
    #   C:/path     => C:/path
 
276
    #   \\HOST\path => //HOST/path
 
277
    #   //HOST/path => //HOST/path
 
278
    #   path        => C:/cwd/path
 
279
    #   /path       => C:/path
 
280
    path = unicode(path)
 
281
    # check for absolute path
 
282
    drive = _nt_splitdrive(path)[0]
 
283
    if drive == '' and path[:2] not in('//','\\\\'):
 
284
        cwd = os.getcwdu()
 
285
        # we cannot simply os.path.join cwd and path
 
286
        # because os.path.join('C:','/path') produce '/path'
 
287
        # and this is incorrect
 
288
        if path[:1] in ('/','\\'):
 
289
            cwd = _nt_splitdrive(cwd)[0]
 
290
            path = path[1:]
 
291
        path = cwd + '\\' + path
 
292
    return _win32_fixdrive(_nt_normpath(path).replace('\\', '/'))
 
293
 
 
294
 
 
295
def _win32_realpath(path):
 
296
    # Real _nt_realpath doesn't have a problem with a unicode cwd
 
297
    return _win32_fixdrive(_nt_realpath(unicode(path)).replace('\\', '/'))
 
298
 
 
299
 
 
300
def _win32_pathjoin(*args):
 
301
    return _nt_join(*args).replace('\\', '/')
 
302
 
 
303
 
 
304
def _win32_normpath(path):
 
305
    return _win32_fixdrive(_nt_normpath(unicode(path)).replace('\\', '/'))
 
306
 
 
307
 
 
308
def _win32_getcwd():
 
309
    return _win32_fixdrive(os.getcwdu().replace('\\', '/'))
 
310
 
 
311
 
 
312
def _win32_mkdtemp(*args, **kwargs):
 
313
    return _win32_fixdrive(tempfile.mkdtemp(*args, **kwargs).replace('\\', '/'))
 
314
 
 
315
 
 
316
def _win32_rename(old, new):
 
317
    """We expect to be able to atomically replace 'new' with old.
 
318
 
 
319
    On win32, if new exists, it must be moved out of the way first,
 
320
    and then deleted.
 
321
    """
 
322
    try:
 
323
        fancy_rename(old, new, rename_func=os.rename, unlink_func=os.unlink)
 
324
    except OSError, e:
 
325
        if e.errno in (errno.EPERM, errno.EACCES, errno.EBUSY, errno.EINVAL):
 
326
            # If we try to rename a non-existant file onto cwd, we get
 
327
            # EPERM or EACCES instead of ENOENT, this will raise ENOENT
 
328
            # if the old path doesn't exist, sometimes we get EACCES
 
329
            # On Linux, we seem to get EBUSY, on Mac we get EINVAL
 
330
            os.lstat(old)
 
331
        raise
 
332
 
 
333
 
 
334
def _mac_getcwd():
 
335
    return unicodedata.normalize('NFC', os.getcwdu())
 
336
 
 
337
 
 
338
# Default is to just use the python builtins, but these can be rebound on
 
339
# particular platforms.
 
340
abspath = _posix_abspath
 
341
realpath = _posix_realpath
 
342
pathjoin = os.path.join
 
343
normpath = os.path.normpath
 
344
getcwd = os.getcwdu
 
345
rename = os.rename
 
346
dirname = os.path.dirname
 
347
basename = os.path.basename
 
348
split = os.path.split
 
349
splitext = os.path.splitext
 
350
# These were already imported into local scope
 
351
# mkdtemp = tempfile.mkdtemp
 
352
# rmtree = shutil.rmtree
 
353
 
 
354
MIN_ABS_PATHLENGTH = 1
 
355
 
 
356
 
 
357
if sys.platform == 'win32':
 
358
    if win32utils.winver == 'Windows 98':
 
359
        abspath = _win98_abspath
 
360
    else:
 
361
        abspath = _win32_abspath
 
362
    realpath = _win32_realpath
 
363
    pathjoin = _win32_pathjoin
 
364
    normpath = _win32_normpath
 
365
    getcwd = _win32_getcwd
 
366
    mkdtemp = _win32_mkdtemp
 
367
    rename = _win32_rename
 
368
 
 
369
    MIN_ABS_PATHLENGTH = 3
 
370
 
 
371
    def _win32_delete_readonly(function, path, excinfo):
 
372
        """Error handler for shutil.rmtree function [for win32]
 
373
        Helps to remove files and dirs marked as read-only.
 
374
        """
 
375
        exception = excinfo[1]
 
376
        if function in (os.remove, os.rmdir) \
 
377
            and isinstance(exception, OSError) \
 
378
            and exception.errno == errno.EACCES:
 
379
            make_writable(path)
 
380
            function(path)
 
381
        else:
 
382
            raise
 
383
 
 
384
    def rmtree(path, ignore_errors=False, onerror=_win32_delete_readonly):
 
385
        """Replacer for shutil.rmtree: could remove readonly dirs/files"""
 
386
        return shutil.rmtree(path, ignore_errors, onerror)
 
387
elif sys.platform == 'darwin':
 
388
    getcwd = _mac_getcwd
 
389
 
 
390
 
 
391
def get_terminal_encoding():
 
392
    """Find the best encoding for printing to the screen.
 
393
 
 
394
    This attempts to check both sys.stdout and sys.stdin to see
 
395
    what encoding they are in, and if that fails it falls back to
 
396
    osutils.get_user_encoding().
 
397
    The problem is that on Windows, locale.getpreferredencoding()
 
398
    is not the same encoding as that used by the console:
 
399
    http://mail.python.org/pipermail/python-list/2003-May/162357.html
 
400
 
 
401
    On my standard US Windows XP, the preferred encoding is
 
402
    cp1252, but the console is cp437
 
403
    """
 
404
    from bzrlib.trace import mutter
 
405
    output_encoding = getattr(sys.stdout, 'encoding', None)
 
406
    if not output_encoding:
 
407
        input_encoding = getattr(sys.stdin, 'encoding', None)
 
408
        if not input_encoding:
 
409
            output_encoding = get_user_encoding()
 
410
            mutter('encoding stdout as osutils.get_user_encoding() %r',
 
411
                   output_encoding)
 
412
        else:
 
413
            output_encoding = input_encoding
 
414
            mutter('encoding stdout as sys.stdin encoding %r', output_encoding)
 
415
    else:
 
416
        mutter('encoding stdout as sys.stdout encoding %r', output_encoding)
 
417
    if output_encoding == 'cp0':
 
418
        # invalid encoding (cp0 means 'no codepage' on Windows)
 
419
        output_encoding = get_user_encoding()
 
420
        mutter('cp0 is invalid encoding.'
 
421
               ' encoding stdout as osutils.get_user_encoding() %r',
 
422
               output_encoding)
 
423
    # check encoding
 
424
    try:
 
425
        codecs.lookup(output_encoding)
 
426
    except LookupError:
 
427
        sys.stderr.write('bzr: warning:'
 
428
                         ' unknown terminal encoding %s.\n'
 
429
                         '  Using encoding %s instead.\n'
 
430
                         % (output_encoding, get_user_encoding())
 
431
                        )
 
432
        output_encoding = get_user_encoding()
 
433
 
 
434
    return output_encoding
 
435
 
 
436
 
 
437
def normalizepath(f):
 
438
    if getattr(os.path, 'realpath', None) is not None:
 
439
        F = realpath
 
440
    else:
 
441
        F = abspath
 
442
    [p,e] = os.path.split(f)
 
443
    if e == "" or e == "." or e == "..":
 
444
        return F(f)
 
445
    else:
 
446
        return pathjoin(F(p), e)
116
447
 
117
448
 
118
449
def isdir(f):
123
454
        return False
124
455
 
125
456
 
126
 
 
127
457
def isfile(f):
128
458
    """True if f is a regular file."""
129
459
    try:
131
461
    except OSError:
132
462
        return False
133
463
 
 
464
def islink(f):
 
465
    """True if f is a symlink."""
 
466
    try:
 
467
        return S_ISLNK(os.lstat(f)[ST_MODE])
 
468
    except OSError:
 
469
        return False
134
470
 
135
471
def is_inside(dir, fname):
136
472
    """True if fname is inside dir.
137
 
    
138
 
    The parameters should typically be passed to os.path.normpath first, so
 
473
 
 
474
    The parameters should typically be passed to osutils.normpath first, so
139
475
    that . and .. and repeated slashes are eliminated, and the separators
140
476
    are canonical for the platform.
141
 
    
142
 
    The empty string as a dir name is taken as top-of-tree and matches 
 
477
 
 
478
    The empty string as a dir name is taken as top-of-tree and matches
143
479
    everything.
144
 
    
145
 
    >>> is_inside('src', 'src/foo.c')
146
 
    True
147
 
    >>> is_inside('src', 'srccontrol')
148
 
    False
149
 
    >>> is_inside('src', 'src/a/a/a/foo.c')
150
 
    True
151
 
    >>> is_inside('foo.c', 'foo.c')
152
 
    True
153
 
    >>> is_inside('foo.c', '')
154
 
    False
155
 
    >>> is_inside('', 'foo.c')
156
 
    True
157
480
    """
158
 
    # XXX: Most callers of this can actually do something smarter by 
 
481
    # XXX: Most callers of this can actually do something smarter by
159
482
    # looking at the inventory
160
483
    if dir == fname:
161
484
        return True
162
 
    
 
485
 
163
486
    if dir == '':
164
487
        return True
165
 
    
166
 
    if dir[-1] != os.sep:
167
 
        dir += os.sep
168
 
    
 
488
 
 
489
    if dir[-1] != '/':
 
490
        dir += '/'
 
491
 
169
492
    return fname.startswith(dir)
170
493
 
171
494
 
174
497
    for dirname in dir_list:
175
498
        if is_inside(dirname, fname):
176
499
            return True
 
500
    return False
 
501
 
 
502
 
 
503
def is_inside_or_parent_of_any(dir_list, fname):
 
504
    """True if fname is a child or a parent of any of the given files."""
 
505
    for dirname in dir_list:
 
506
        if is_inside(dirname, fname) or is_inside(fname, dirname):
 
507
            return True
 
508
    return False
 
509
 
 
510
 
 
511
def pumpfile(from_file, to_file, read_length=-1, buff_size=32768,
 
512
             report_activity=None, direction='read'):
 
513
    """Copy contents of one file to another.
 
514
 
 
515
    The read_length can either be -1 to read to end-of-file (EOF) or
 
516
    it can specify the maximum number of bytes to read.
 
517
 
 
518
    The buff_size represents the maximum size for each read operation
 
519
    performed on from_file.
 
520
 
 
521
    :param report_activity: Call this as bytes are read, see
 
522
        Transport._report_activity
 
523
    :param direction: Will be passed to report_activity
 
524
 
 
525
    :return: The number of bytes copied.
 
526
    """
 
527
    length = 0
 
528
    if read_length >= 0:
 
529
        # read specified number of bytes
 
530
 
 
531
        while read_length > 0:
 
532
            num_bytes_to_read = min(read_length, buff_size)
 
533
 
 
534
            block = from_file.read(num_bytes_to_read)
 
535
            if not block:
 
536
                # EOF reached
 
537
                break
 
538
            if report_activity is not None:
 
539
                report_activity(len(block), direction)
 
540
            to_file.write(block)
 
541
 
 
542
            actual_bytes_read = len(block)
 
543
            read_length -= actual_bytes_read
 
544
            length += actual_bytes_read
177
545
    else:
178
 
        return False
179
 
 
180
 
 
181
 
def pumpfile(fromfile, tofile):
182
 
    """Copy contents of one file to another."""
183
 
    tofile.write(fromfile.read())
184
 
 
185
 
 
186
 
def uuid():
187
 
    """Return a new UUID"""
188
 
    try:
189
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
190
 
    except IOError:
191
 
        return chomp(os.popen('uuidgen').readline())
 
546
        # read to EOF
 
547
        while True:
 
548
            block = from_file.read(buff_size)
 
549
            if not block:
 
550
                # EOF reached
 
551
                break
 
552
            if report_activity is not None:
 
553
                report_activity(len(block), direction)
 
554
            to_file.write(block)
 
555
            length += len(block)
 
556
    return length
 
557
 
 
558
 
 
559
def pump_string_file(bytes, file_handle, segment_size=None):
 
560
    """Write bytes to file_handle in many smaller writes.
 
561
 
 
562
    :param bytes: The string to write.
 
563
    :param file_handle: The file to write to.
 
564
    """
 
565
    # Write data in chunks rather than all at once, because very large
 
566
    # writes fail on some platforms (e.g. Windows with SMB  mounted
 
567
    # drives).
 
568
    if not segment_size:
 
569
        segment_size = 5242880 # 5MB
 
570
    segments = range(len(bytes) / segment_size + 1)
 
571
    write = file_handle.write
 
572
    for segment_index in segments:
 
573
        segment = buffer(bytes, segment_index * segment_size, segment_size)
 
574
        write(segment)
 
575
 
 
576
 
 
577
def file_iterator(input_file, readsize=32768):
 
578
    while True:
 
579
        b = input_file.read(readsize)
 
580
        if len(b) == 0:
 
581
            break
 
582
        yield b
192
583
 
193
584
 
194
585
def sha_file(f):
195
 
    import sha
196
 
    if hasattr(f, 'tell'):
197
 
        assert f.tell() == 0
198
 
    s = sha.new()
199
 
    BUFSIZE = 128<<10
200
 
    while True:
201
 
        b = f.read(BUFSIZE)
202
 
        if not b:
203
 
            break
204
 
        s.update(b)
205
 
    return s.hexdigest()
206
 
 
207
 
 
208
 
def sha_string(f):
209
 
    import sha
210
 
    s = sha.new()
211
 
    s.update(f)
212
 
    return s.hexdigest()
213
 
 
 
586
    """Calculate the hexdigest of an open file.
 
587
 
 
588
    The file cursor should be already at the start.
 
589
    """
 
590
    s = sha()
 
591
    BUFSIZE = 128<<10
 
592
    while True:
 
593
        b = f.read(BUFSIZE)
 
594
        if not b:
 
595
            break
 
596
        s.update(b)
 
597
    return s.hexdigest()
 
598
 
 
599
 
 
600
def size_sha_file(f):
 
601
    """Calculate the size and hexdigest of an open file.
 
602
 
 
603
    The file cursor should be already at the start and
 
604
    the caller is responsible for closing the file afterwards.
 
605
    """
 
606
    size = 0
 
607
    s = sha()
 
608
    BUFSIZE = 128<<10
 
609
    while True:
 
610
        b = f.read(BUFSIZE)
 
611
        if not b:
 
612
            break
 
613
        size += len(b)
 
614
        s.update(b)
 
615
    return size, s.hexdigest()
 
616
 
 
617
 
 
618
def sha_file_by_name(fname):
 
619
    """Calculate the SHA1 of a file by reading the full text"""
 
620
    s = sha()
 
621
    f = os.open(fname, os.O_RDONLY | O_BINARY)
 
622
    try:
 
623
        while True:
 
624
            b = os.read(f, 1<<16)
 
625
            if not b:
 
626
                return s.hexdigest()
 
627
            s.update(b)
 
628
    finally:
 
629
        os.close(f)
 
630
 
 
631
 
 
632
def sha_strings(strings, _factory=sha):
 
633
    """Return the sha-1 of concatenation of strings"""
 
634
    s = _factory()
 
635
    map(s.update, strings)
 
636
    return s.hexdigest()
 
637
 
 
638
 
 
639
def sha_string(f, _factory=sha):
 
640
    return _factory(f).hexdigest()
214
641
 
215
642
 
216
643
def fingerprint_file(f):
217
 
    import sha
218
 
    s = sha.new()
219
644
    b = f.read()
220
 
    s.update(b)
221
 
    size = len(b)
222
 
    return {'size': size,
223
 
            'sha1': s.hexdigest()}
224
 
 
225
 
 
226
 
def config_dir():
227
 
    """Return per-user configuration directory.
228
 
 
229
 
    By default this is ~/.bzr.conf/
230
 
    
231
 
    TODO: Global option --config-dir to override this.
232
 
    """
233
 
    return os.path.expanduser("~/.bzr.conf")
234
 
 
235
 
 
236
 
def _auto_user_id():
237
 
    """Calculate automatic user identification.
238
 
 
239
 
    Returns (realname, email).
240
 
 
241
 
    Only used when none is set in the environment or the id file.
242
 
 
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
245
 
    use the hostname.
246
 
    """
247
 
    import socket
248
 
 
249
 
    # XXX: Any good way to get real user name on win32?
250
 
 
251
 
    try:
252
 
        import pwd
253
 
        uid = os.getuid()
254
 
        w = pwd.getpwuid(uid)
255
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
256
 
        username = w.pw_name.decode(bzrlib.user_encoding)
257
 
        comma = gecos.find(',')
258
 
        if comma == -1:
259
 
            realname = gecos
260
 
        else:
261
 
            realname = gecos[:comma]
262
 
        if not realname:
263
 
            realname = username
264
 
 
265
 
    except ImportError:
266
 
        import getpass
267
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
268
 
 
269
 
    return realname, (username + '@' + socket.gethostname())
270
 
 
271
 
 
272
 
def _get_user_id():
273
 
    """Return the full user id from a file or environment variable.
274
 
 
275
 
    TODO: Allow taking this from a file in the branch directory too
276
 
    for per-branch ids."""
277
 
    v = os.environ.get('BZREMAIL')
278
 
    if v:
279
 
        return v.decode(bzrlib.user_encoding)
280
 
    
281
 
    try:
282
 
        return (open(os.path.join(config_dir(), "email"))
283
 
                .read()
284
 
                .decode(bzrlib.user_encoding)
285
 
                .rstrip("\r\n"))
286
 
    except IOError, e:
287
 
        if e.errno != errno.ENOENT:
288
 
            raise e
289
 
 
290
 
    v = os.environ.get('EMAIL')
291
 
    if v:
292
 
        return v.decode(bzrlib.user_encoding)
293
 
    else:    
294
 
        return None
295
 
 
296
 
 
297
 
def username():
298
 
    """Return email-style username.
299
 
 
300
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
301
 
 
302
 
    TODO: Check it's reasonably well-formed.
303
 
    """
304
 
    v = _get_user_id()
305
 
    if v:
306
 
        return v
307
 
    
308
 
    name, email = _auto_user_id()
309
 
    if name:
310
 
        return '%s <%s>' % (name, email)
311
 
    else:
312
 
        return email
313
 
 
314
 
 
315
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
316
 
def user_email():
317
 
    """Return just the email component of a username."""
318
 
    e = _get_user_id()
319
 
    if e:
320
 
        m = _EMAIL_RE.search(e)
321
 
        if not m:
322
 
            raise BzrError("%r doesn't seem to contain a reasonable email address" % e)
323
 
        return m.group(0)
324
 
 
325
 
    return _auto_user_id()[1]
326
 
    
 
645
    return {'size': len(b),
 
646
            'sha1': sha(b).hexdigest()}
327
647
 
328
648
 
329
649
def compare_files(a, b):
338
658
            return True
339
659
 
340
660
 
341
 
 
342
661
def local_time_offset(t=None):
343
662
    """Return offset of local zone from GMT, either at present or at time t."""
344
 
    # python2.3 localtime() can't take None
345
 
    if t == None:
 
663
    if t is None:
346
664
        t = time.time()
347
 
        
348
 
    if time.localtime(t).tm_isdst and time.daylight:
349
 
        return -time.altzone
350
 
    else:
351
 
        return -time.timezone
352
 
 
353
 
    
354
 
def format_date(t, offset=0, timezone='original'):
355
 
    ## TODO: Perhaps a global option to use either universal or local time?
356
 
    ## Or perhaps just let people set $TZ?
357
 
    assert isinstance(t, float)
358
 
    
 
665
    offset = datetime.fromtimestamp(t) - datetime.utcfromtimestamp(t)
 
666
    return offset.days * 86400 + offset.seconds
 
667
 
 
668
weekdays = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
 
669
 
 
670
def format_date(t, offset=0, timezone='original', date_fmt=None,
 
671
                show_offset=True):
 
672
    """Return a formatted date string.
 
673
 
 
674
    :param t: Seconds since the epoch.
 
675
    :param offset: Timezone offset in seconds east of utc.
 
676
    :param timezone: How to display the time: 'utc', 'original' for the
 
677
         timezone specified by offset, or 'local' for the process's current
 
678
         timezone.
 
679
    :param date_fmt: strftime format.
 
680
    :param show_offset: Whether to append the timezone.
 
681
    """
 
682
    (date_fmt, tt, offset_str) = \
 
683
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
684
    date_fmt = date_fmt.replace('%a', weekdays[tt[6]])
 
685
    date_str = time.strftime(date_fmt, tt)
 
686
    return date_str + offset_str
 
687
 
 
688
def format_local_date(t, offset=0, timezone='original', date_fmt=None,
 
689
                      show_offset=True):
 
690
    """Return an unicode date string formatted according to the current locale.
 
691
 
 
692
    :param t: Seconds since the epoch.
 
693
    :param offset: Timezone offset in seconds east of utc.
 
694
    :param timezone: How to display the time: 'utc', 'original' for the
 
695
         timezone specified by offset, or 'local' for the process's current
 
696
         timezone.
 
697
    :param date_fmt: strftime format.
 
698
    :param show_offset: Whether to append the timezone.
 
699
    """
 
700
    (date_fmt, tt, offset_str) = \
 
701
               _format_date(t, offset, timezone, date_fmt, show_offset)
 
702
    date_str = time.strftime(date_fmt, tt)
 
703
    if not isinstance(date_str, unicode):
 
704
        date_str = date_str.decode(bzrlib.user_encoding, 'replace')
 
705
    return date_str + offset_str
 
706
 
 
707
def _format_date(t, offset, timezone, date_fmt, show_offset):
359
708
    if timezone == 'utc':
360
709
        tt = time.gmtime(t)
361
710
        offset = 0
362
711
    elif timezone == 'original':
363
 
        if offset == None:
 
712
        if offset is None:
364
713
            offset = 0
365
714
        tt = time.gmtime(t + offset)
366
715
    elif timezone == 'local':
367
716
        tt = time.localtime(t)
368
717
        offset = local_time_offset(t)
369
718
    else:
370
 
        raise BzrError("unsupported timezone format %r" % timezone,
371
 
                       ['options are "utc", "original", "local"'])
372
 
 
373
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
374
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
719
        raise errors.UnsupportedTimezoneFormat(timezone)
 
720
    if date_fmt is None:
 
721
        date_fmt = "%a %Y-%m-%d %H:%M:%S"
 
722
    if show_offset:
 
723
        offset_str = ' %+03d%02d' % (offset / 3600, (offset / 60) % 60)
 
724
    else:
 
725
        offset_str = ''
 
726
    return (date_fmt, tt, offset_str)
375
727
 
376
728
 
377
729
def compact_date(when):
378
730
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
379
 
    
380
 
 
 
731
 
 
732
 
 
733
def format_delta(delta):
 
734
    """Get a nice looking string for a time delta.
 
735
 
 
736
    :param delta: The time difference in seconds, can be positive or negative.
 
737
        positive indicates time in the past, negative indicates time in the
 
738
        future. (usually time.time() - stored_time)
 
739
    :return: String formatted to show approximate resolution
 
740
    """
 
741
    delta = int(delta)
 
742
    if delta >= 0:
 
743
        direction = 'ago'
 
744
    else:
 
745
        direction = 'in the future'
 
746
        delta = -delta
 
747
 
 
748
    seconds = delta
 
749
    if seconds < 90: # print seconds up to 90 seconds
 
750
        if seconds == 1:
 
751
            return '%d second %s' % (seconds, direction,)
 
752
        else:
 
753
            return '%d seconds %s' % (seconds, direction)
 
754
 
 
755
    minutes = int(seconds / 60)
 
756
    seconds -= 60 * minutes
 
757
    if seconds == 1:
 
758
        plural_seconds = ''
 
759
    else:
 
760
        plural_seconds = 's'
 
761
    if minutes < 90: # print minutes, seconds up to 90 minutes
 
762
        if minutes == 1:
 
763
            return '%d minute, %d second%s %s' % (
 
764
                    minutes, seconds, plural_seconds, direction)
 
765
        else:
 
766
            return '%d minutes, %d second%s %s' % (
 
767
                    minutes, seconds, plural_seconds, direction)
 
768
 
 
769
    hours = int(minutes / 60)
 
770
    minutes -= 60 * hours
 
771
    if minutes == 1:
 
772
        plural_minutes = ''
 
773
    else:
 
774
        plural_minutes = 's'
 
775
 
 
776
    if hours == 1:
 
777
        return '%d hour, %d minute%s %s' % (hours, minutes,
 
778
                                            plural_minutes, direction)
 
779
    return '%d hours, %d minute%s %s' % (hours, minutes,
 
780
                                         plural_minutes, direction)
381
781
 
382
782
def filesize(f):
383
783
    """Return size of given open file."""
384
784
    return os.fstat(f.fileno())[ST_SIZE]
385
785
 
386
786
 
387
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
787
# Define rand_bytes based on platform.
 
788
try:
 
789
    # Python 2.4 and later have os.urandom,
 
790
    # but it doesn't work on some arches
 
791
    os.urandom(1)
388
792
    rand_bytes = os.urandom
389
 
elif sys.platform == 'linux2':
390
 
    rand_bytes = file('/dev/urandom', 'rb').read
391
 
else:
392
 
    # not well seeded, but better than nothing
393
 
    def rand_bytes(n):
394
 
        import random
395
 
        s = ''
396
 
        while n:
397
 
            s += chr(random.randint(0, 255))
398
 
            n -= 1
399
 
        return s
 
793
except (NotImplementedError, AttributeError):
 
794
    # If python doesn't have os.urandom, or it doesn't work,
 
795
    # then try to first pull random data from /dev/urandom
 
796
    try:
 
797
        rand_bytes = file('/dev/urandom', 'rb').read
 
798
    # Otherwise, use this hack as a last resort
 
799
    except (IOError, OSError):
 
800
        # not well seeded, but better than nothing
 
801
        def rand_bytes(n):
 
802
            import random
 
803
            s = ''
 
804
            while n:
 
805
                s += chr(random.randint(0, 255))
 
806
                n -= 1
 
807
            return s
 
808
 
 
809
 
 
810
ALNUM = '0123456789abcdefghijklmnopqrstuvwxyz'
 
811
def rand_chars(num):
 
812
    """Return a random string of num alphanumeric characters
 
813
 
 
814
    The result only contains lowercase chars because it may be used on
 
815
    case-insensitive filesystems.
 
816
    """
 
817
    s = ''
 
818
    for raw_byte in rand_bytes(num):
 
819
        s += ALNUM[ord(raw_byte) % 36]
 
820
    return s
400
821
 
401
822
 
402
823
## TODO: We could later have path objects that remember their list
403
824
## decomposition (might be too tricksy though.)
404
825
 
405
826
def splitpath(p):
406
 
    """Turn string into list of parts.
407
 
 
408
 
    >>> splitpath('a')
409
 
    ['a']
410
 
    >>> splitpath('a/b')
411
 
    ['a', 'b']
412
 
    >>> splitpath('a/./b')
413
 
    ['a', 'b']
414
 
    >>> splitpath('a/.b')
415
 
    ['a', '.b']
416
 
    >>> splitpath('a/../b')
417
 
    Traceback (most recent call last):
418
 
    ...
419
 
    BzrError: sorry, '..' not allowed in path
420
 
    """
421
 
    assert isinstance(p, types.StringTypes)
422
 
 
 
827
    """Turn string into list of parts."""
423
828
    # split on either delimiter because people might use either on
424
829
    # Windows
425
830
    ps = re.split(r'[\\/]', p)
427
832
    rps = []
428
833
    for f in ps:
429
834
        if f == '..':
430
 
            raise BzrError("sorry, %r not allowed in path" % f)
 
835
            raise errors.BzrError("sorry, %r not allowed in path" % f)
431
836
        elif (f == '.') or (f == ''):
432
837
            pass
433
838
        else:
434
839
            rps.append(f)
435
840
    return rps
436
841
 
 
842
 
437
843
def joinpath(p):
438
 
    assert isinstance(p, list)
439
844
    for f in p:
440
 
        if (f == '..') or (f == None) or (f == ''):
441
 
            raise BzrError("sorry, %r not allowed in path" % f)
442
 
    return os.path.join(*p)
443
 
 
444
 
 
445
 
def appendpath(p1, p2):
446
 
    if p1 == '':
447
 
        return p2
448
 
    else:
449
 
        return os.path.join(p1, p2)
450
 
    
451
 
 
452
 
def extern_command(cmd, ignore_errors = False):
453
 
    mutter('external command: %s' % `cmd`)
454
 
    if os.system(cmd):
455
 
        if not ignore_errors:
456
 
            raise BzrError('command failed')
457
 
 
458
 
 
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"""
462
 
    try:
463
 
        f = file(os.path.join(config_dir(), name), "r")
464
 
        return f.read().decode(bzrlib.user_encoding).rstrip("\r\n")
465
 
    except IOError, e:
466
 
        if e.errno == errno.ENOENT:
467
 
            return None
 
845
        if (f == '..') or (f is None) or (f == ''):
 
846
            raise errors.BzrError("sorry, %r not allowed in path" % f)
 
847
    return pathjoin(*p)
 
848
 
 
849
 
 
850
try:
 
851
    from bzrlib._chunks_to_lines_pyx import chunks_to_lines
 
852
except ImportError:
 
853
    from bzrlib._chunks_to_lines_py import chunks_to_lines
 
854
 
 
855
 
 
856
def split_lines(s):
 
857
    """Split s into lines, but without removing the newline characters."""
 
858
    # Trivially convert a fulltext into a 'chunked' representation, and let
 
859
    # chunks_to_lines do the heavy lifting.
 
860
    if isinstance(s, str):
 
861
        # chunks_to_lines only supports 8-bit strings
 
862
        return chunks_to_lines([s])
 
863
    else:
 
864
        return _split_lines(s)
 
865
 
 
866
 
 
867
def _split_lines(s):
 
868
    """Split s into lines, but without removing the newline characters.
 
869
 
 
870
    This supports Unicode or plain string objects.
 
871
    """
 
872
    lines = s.split('\n')
 
873
    result = [line + '\n' for line in lines[:-1]]
 
874
    if lines[-1]:
 
875
        result.append(lines[-1])
 
876
    return result
 
877
 
 
878
 
 
879
def hardlinks_good():
 
880
    return sys.platform not in ('win32', 'cygwin', 'darwin')
 
881
 
 
882
 
 
883
def link_or_copy(src, dest):
 
884
    """Hardlink a file, or copy it if it can't be hardlinked."""
 
885
    if not hardlinks_good():
 
886
        shutil.copyfile(src, dest)
 
887
        return
 
888
    try:
 
889
        os.link(src, dest)
 
890
    except (OSError, IOError), e:
 
891
        if e.errno != errno.EXDEV:
 
892
            raise
 
893
        shutil.copyfile(src, dest)
 
894
 
 
895
 
 
896
# Look Before You Leap (LBYL) is appropriate here instead of Easier to Ask for
 
897
# Forgiveness than Permission (EAFP) because:
 
898
# - root can damage a solaris file system by using unlink,
 
899
# - unlink raises different exceptions on different OSes (linux: EISDIR, win32:
 
900
#   EACCES, OSX: EPERM) when invoked on a directory.
 
901
def delete_any(path):
 
902
    """Delete a file or directory."""
 
903
    if isdir(path): # Takes care of symlinks
 
904
        os.rmdir(path)
 
905
    else:
 
906
        os.unlink(path)
 
907
 
 
908
 
 
909
def has_symlinks():
 
910
    if getattr(os, 'symlink', None) is not None:
 
911
        return True
 
912
    else:
 
913
        return False
 
914
 
 
915
 
 
916
def has_hardlinks():
 
917
    if getattr(os, 'link', None) is not None:
 
918
        return True
 
919
    else:
 
920
        return False
 
921
 
 
922
 
 
923
def host_os_dereferences_symlinks():
 
924
    return (has_symlinks()
 
925
            and sys.platform not in ('cygwin', 'win32'))
 
926
 
 
927
 
 
928
def contains_whitespace(s):
 
929
    """True if there are any whitespace characters in s."""
 
930
    # string.whitespace can include '\xa0' in certain locales, because it is
 
931
    # considered "non-breaking-space" as part of ISO-8859-1. But it
 
932
    # 1) Isn't a breaking whitespace
 
933
    # 2) Isn't one of ' \t\r\n' which are characters we sometimes use as
 
934
    #    separators
 
935
    # 3) '\xa0' isn't unicode safe since it is >128.
 
936
 
 
937
    # This should *not* be a unicode set of characters in case the source
 
938
    # string is not a Unicode string. We can auto-up-cast the characters since
 
939
    # they are ascii, but we don't want to auto-up-cast the string in case it
 
940
    # is utf-8
 
941
    for ch in ' \t\n\r\v\f':
 
942
        if ch in s:
 
943
            return True
 
944
    else:
 
945
        return False
 
946
 
 
947
 
 
948
def contains_linebreaks(s):
 
949
    """True if there is any vertical whitespace in s."""
 
950
    for ch in '\f\n\r':
 
951
        if ch in s:
 
952
            return True
 
953
    else:
 
954
        return False
 
955
 
 
956
 
 
957
def relpath(base, path):
 
958
    """Return path relative to base, or raise exception.
 
959
 
 
960
    The path may be either an absolute path or a path relative to the
 
961
    current working directory.
 
962
 
 
963
    os.path.commonprefix (python2.4) has a bad bug that it works just
 
964
    on string prefixes, assuming that '/u' is a prefix of '/u2'.  This
 
965
    avoids that problem.
 
966
    """
 
967
 
 
968
    if len(base) < MIN_ABS_PATHLENGTH:
 
969
        # must have space for e.g. a drive letter
 
970
        raise ValueError('%r is too short to calculate a relative path'
 
971
            % (base,))
 
972
 
 
973
    rp = abspath(path)
 
974
 
 
975
    s = []
 
976
    head = rp
 
977
    while len(head) >= len(base):
 
978
        if head == base:
 
979
            break
 
980
        head, tail = os.path.split(head)
 
981
        if tail:
 
982
            s.insert(0, tail)
 
983
    else:
 
984
        raise errors.PathNotChild(rp, base)
 
985
 
 
986
    if s:
 
987
        return pathjoin(*s)
 
988
    else:
 
989
        return ''
 
990
 
 
991
 
 
992
def _cicp_canonical_relpath(base, path):
 
993
    """Return the canonical path relative to base.
 
994
 
 
995
    Like relpath, but on case-insensitive-case-preserving file-systems, this
 
996
    will return the relpath as stored on the file-system rather than in the
 
997
    case specified in the input string, for all existing portions of the path.
 
998
 
 
999
    This will cause O(N) behaviour if called for every path in a tree; if you
 
1000
    have a number of paths to convert, you should use canonical_relpaths().
 
1001
    """
 
1002
    # TODO: it should be possible to optimize this for Windows by using the
 
1003
    # win32 API FindFiles function to look for the specified name - but using
 
1004
    # os.listdir() still gives us the correct, platform agnostic semantics in
 
1005
    # the short term.
 
1006
 
 
1007
    rel = relpath(base, path)
 
1008
    # '.' will have been turned into ''
 
1009
    if not rel:
 
1010
        return rel
 
1011
 
 
1012
    abs_base = abspath(base)
 
1013
    current = abs_base
 
1014
    _listdir = os.listdir
 
1015
 
 
1016
    # use an explicit iterator so we can easily consume the rest on early exit.
 
1017
    bit_iter = iter(rel.split('/'))
 
1018
    for bit in bit_iter:
 
1019
        lbit = bit.lower()
 
1020
        for look in _listdir(current):
 
1021
            if lbit == look.lower():
 
1022
                current = pathjoin(current, look)
 
1023
                break
 
1024
        else:
 
1025
            # got to the end, nothing matched, so we just return the
 
1026
            # non-existing bits as they were specified (the filename may be
 
1027
            # the target of a move, for example).
 
1028
            current = pathjoin(current, bit, *list(bit_iter))
 
1029
            break
 
1030
    return current[len(abs_base)+1:]
 
1031
 
 
1032
# XXX - TODO - we need better detection/integration of case-insensitive
 
1033
# file-systems; Linux often sees FAT32 devices (or NFS-mounted OSX
 
1034
# filesystems), for example, so could probably benefit from the same basic
 
1035
# support there.  For now though, only Windows and OSX get that support, and
 
1036
# they get it for *all* file-systems!
 
1037
if sys.platform in ('win32', 'darwin'):
 
1038
    canonical_relpath = _cicp_canonical_relpath
 
1039
else:
 
1040
    canonical_relpath = relpath
 
1041
 
 
1042
def canonical_relpaths(base, paths):
 
1043
    """Create an iterable to canonicalize a sequence of relative paths.
 
1044
 
 
1045
    The intent is for this implementation to use a cache, vastly speeding
 
1046
    up multiple transformations in the same directory.
 
1047
    """
 
1048
    # but for now, we haven't optimized...
 
1049
    return [canonical_relpath(base, p) for p in paths]
 
1050
 
 
1051
def safe_unicode(unicode_or_utf8_string):
 
1052
    """Coerce unicode_or_utf8_string into unicode.
 
1053
 
 
1054
    If it is unicode, it is returned.
 
1055
    Otherwise it is decoded from utf-8. If decoding fails, the exception is
 
1056
    wrapped in a BzrBadParameterNotUnicode exception.
 
1057
    """
 
1058
    if isinstance(unicode_or_utf8_string, unicode):
 
1059
        return unicode_or_utf8_string
 
1060
    try:
 
1061
        return unicode_or_utf8_string.decode('utf8')
 
1062
    except UnicodeDecodeError:
 
1063
        raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
1064
 
 
1065
 
 
1066
def safe_utf8(unicode_or_utf8_string):
 
1067
    """Coerce unicode_or_utf8_string to a utf8 string.
 
1068
 
 
1069
    If it is a str, it is returned.
 
1070
    If it is Unicode, it is encoded into a utf-8 string.
 
1071
    """
 
1072
    if isinstance(unicode_or_utf8_string, str):
 
1073
        # TODO: jam 20070209 This is overkill, and probably has an impact on
 
1074
        #       performance if we are dealing with lots of apis that want a
 
1075
        #       utf-8 revision id
 
1076
        try:
 
1077
            # Make sure it is a valid utf-8 string
 
1078
            unicode_or_utf8_string.decode('utf-8')
 
1079
        except UnicodeDecodeError:
 
1080
            raise errors.BzrBadParameterNotUnicode(unicode_or_utf8_string)
 
1081
        return unicode_or_utf8_string
 
1082
    return unicode_or_utf8_string.encode('utf-8')
 
1083
 
 
1084
 
 
1085
_revision_id_warning = ('Unicode revision ids were deprecated in bzr 0.15.'
 
1086
                        ' Revision id generators should be creating utf8'
 
1087
                        ' revision ids.')
 
1088
 
 
1089
 
 
1090
def safe_revision_id(unicode_or_utf8_string, warn=True):
 
1091
    """Revision ids should now be utf8, but at one point they were unicode.
 
1092
 
 
1093
    :param unicode_or_utf8_string: A possibly Unicode revision_id. (can also be
 
1094
        utf8 or None).
 
1095
    :param warn: Functions that are sanitizing user data can set warn=False
 
1096
    :return: None or a utf8 revision id.
 
1097
    """
 
1098
    if (unicode_or_utf8_string is None
 
1099
        or unicode_or_utf8_string.__class__ == str):
 
1100
        return unicode_or_utf8_string
 
1101
    if warn:
 
1102
        symbol_versioning.warn(_revision_id_warning, DeprecationWarning,
 
1103
                               stacklevel=2)
 
1104
    return cache_utf8.encode(unicode_or_utf8_string)
 
1105
 
 
1106
 
 
1107
_file_id_warning = ('Unicode file ids were deprecated in bzr 0.15. File id'
 
1108
                    ' generators should be creating utf8 file ids.')
 
1109
 
 
1110
 
 
1111
def safe_file_id(unicode_or_utf8_string, warn=True):
 
1112
    """File ids should now be utf8, but at one point they were unicode.
 
1113
 
 
1114
    This is the same as safe_utf8, except it uses the cached encode functions
 
1115
    to save a little bit of performance.
 
1116
 
 
1117
    :param unicode_or_utf8_string: A possibly Unicode file_id. (can also be
 
1118
        utf8 or None).
 
1119
    :param warn: Functions that are sanitizing user data can set warn=False
 
1120
    :return: None or a utf8 file id.
 
1121
    """
 
1122
    if (unicode_or_utf8_string is None
 
1123
        or unicode_or_utf8_string.__class__ == str):
 
1124
        return unicode_or_utf8_string
 
1125
    if warn:
 
1126
        symbol_versioning.warn(_file_id_warning, DeprecationWarning,
 
1127
                               stacklevel=2)
 
1128
    return cache_utf8.encode(unicode_or_utf8_string)
 
1129
 
 
1130
 
 
1131
_platform_normalizes_filenames = False
 
1132
if sys.platform == 'darwin':
 
1133
    _platform_normalizes_filenames = True
 
1134
 
 
1135
 
 
1136
def normalizes_filenames():
 
1137
    """Return True if this platform normalizes unicode filenames.
 
1138
 
 
1139
    Mac OSX does, Windows/Linux do not.
 
1140
    """
 
1141
    return _platform_normalizes_filenames
 
1142
 
 
1143
 
 
1144
def _accessible_normalized_filename(path):
 
1145
    """Get the unicode normalized path, and if you can access the file.
 
1146
 
 
1147
    On platforms where the system normalizes filenames (Mac OSX),
 
1148
    you can access a file by any path which will normalize correctly.
 
1149
    On platforms where the system does not normalize filenames
 
1150
    (Windows, Linux), you have to access a file by its exact path.
 
1151
 
 
1152
    Internally, bzr only supports NFC normalization, since that is
 
1153
    the standard for XML documents.
 
1154
 
 
1155
    So return the normalized path, and a flag indicating if the file
 
1156
    can be accessed by that path.
 
1157
    """
 
1158
 
 
1159
    return unicodedata.normalize('NFC', unicode(path)), True
 
1160
 
 
1161
 
 
1162
def _inaccessible_normalized_filename(path):
 
1163
    __doc__ = _accessible_normalized_filename.__doc__
 
1164
 
 
1165
    normalized = unicodedata.normalize('NFC', unicode(path))
 
1166
    return normalized, normalized == path
 
1167
 
 
1168
 
 
1169
if _platform_normalizes_filenames:
 
1170
    normalized_filename = _accessible_normalized_filename
 
1171
else:
 
1172
    normalized_filename = _inaccessible_normalized_filename
 
1173
 
 
1174
 
 
1175
def terminal_width():
 
1176
    """Return estimated terminal width."""
 
1177
    if sys.platform == 'win32':
 
1178
        return win32utils.get_console_size()[0]
 
1179
    width = 0
 
1180
    try:
 
1181
        import struct, fcntl, termios
 
1182
        s = struct.pack('HHHH', 0, 0, 0, 0)
 
1183
        x = fcntl.ioctl(1, termios.TIOCGWINSZ, s)
 
1184
        width = struct.unpack('HHHH', x)[1]
 
1185
    except IOError:
 
1186
        pass
 
1187
    if width <= 0:
 
1188
        try:
 
1189
            width = int(os.environ['COLUMNS'])
 
1190
        except:
 
1191
            pass
 
1192
    if width <= 0:
 
1193
        width = 80
 
1194
 
 
1195
    return width
 
1196
 
 
1197
 
 
1198
def supports_executable():
 
1199
    return sys.platform != "win32"
 
1200
 
 
1201
 
 
1202
def supports_posix_readonly():
 
1203
    """Return True if 'readonly' has POSIX semantics, False otherwise.
 
1204
 
 
1205
    Notably, a win32 readonly file cannot be deleted, unlike POSIX where the
 
1206
    directory controls creation/deletion, etc.
 
1207
 
 
1208
    And under win32, readonly means that the directory itself cannot be
 
1209
    deleted.  The contents of a readonly directory can be changed, unlike POSIX
 
1210
    where files in readonly directories cannot be added, deleted or renamed.
 
1211
    """
 
1212
    return sys.platform != "win32"
 
1213
 
 
1214
 
 
1215
def set_or_unset_env(env_variable, value):
 
1216
    """Modify the environment, setting or removing the env_variable.
 
1217
 
 
1218
    :param env_variable: The environment variable in question
 
1219
    :param value: The value to set the environment to. If None, then
 
1220
        the variable will be removed.
 
1221
    :return: The original value of the environment variable.
 
1222
    """
 
1223
    orig_val = os.environ.get(env_variable)
 
1224
    if value is None:
 
1225
        if orig_val is not None:
 
1226
            del os.environ[env_variable]
 
1227
    else:
 
1228
        if isinstance(value, unicode):
 
1229
            value = value.encode(get_user_encoding())
 
1230
        os.environ[env_variable] = value
 
1231
    return orig_val
 
1232
 
 
1233
 
 
1234
_validWin32PathRE = re.compile(r'^([A-Za-z]:[/\\])?[^:<>*"?\|]*$')
 
1235
 
 
1236
 
 
1237
def check_legal_path(path):
 
1238
    """Check whether the supplied path is legal.
 
1239
    This is only required on Windows, so we don't test on other platforms
 
1240
    right now.
 
1241
    """
 
1242
    if sys.platform != "win32":
 
1243
        return
 
1244
    if _validWin32PathRE.match(path) is None:
 
1245
        raise errors.IllegalPath(path)
 
1246
 
 
1247
 
 
1248
_WIN32_ERROR_DIRECTORY = 267 # Similar to errno.ENOTDIR
 
1249
 
 
1250
def _is_error_enotdir(e):
 
1251
    """Check if this exception represents ENOTDIR.
 
1252
 
 
1253
    Unfortunately, python is very inconsistent about the exception
 
1254
    here. The cases are:
 
1255
      1) Linux, Mac OSX all versions seem to set errno == ENOTDIR
 
1256
      2) Windows, Python2.4, uses errno == ERROR_DIRECTORY (267)
 
1257
         which is the windows error code.
 
1258
      3) Windows, Python2.5 uses errno == EINVAL and
 
1259
         winerror == ERROR_DIRECTORY
 
1260
 
 
1261
    :param e: An Exception object (expected to be OSError with an errno
 
1262
        attribute, but we should be able to cope with anything)
 
1263
    :return: True if this represents an ENOTDIR error. False otherwise.
 
1264
    """
 
1265
    en = getattr(e, 'errno', None)
 
1266
    if (en == errno.ENOTDIR
 
1267
        or (sys.platform == 'win32'
 
1268
            and (en == _WIN32_ERROR_DIRECTORY
 
1269
                 or (en == errno.EINVAL
 
1270
                     and getattr(e, 'winerror', None) == _WIN32_ERROR_DIRECTORY)
 
1271
        ))):
 
1272
        return True
 
1273
    return False
 
1274
 
 
1275
 
 
1276
def walkdirs(top, prefix=""):
 
1277
    """Yield data about all the directories in a tree.
 
1278
 
 
1279
    This yields all the data about the contents of a directory at a time.
 
1280
    After each directory has been yielded, if the caller has mutated the list
 
1281
    to exclude some directories, they are then not descended into.
 
1282
 
 
1283
    The data yielded is of the form:
 
1284
    ((directory-relpath, directory-path-from-top),
 
1285
    [(relpath, basename, kind, lstat, path-from-top), ...]),
 
1286
     - directory-relpath is the relative path of the directory being returned
 
1287
       with respect to top. prefix is prepended to this.
 
1288
     - directory-path-from-root is the path including top for this directory.
 
1289
       It is suitable for use with os functions.
 
1290
     - relpath is the relative path within the subtree being walked.
 
1291
     - basename is the basename of the path
 
1292
     - kind is the kind of the file now. If unknown then the file is not
 
1293
       present within the tree - but it may be recorded as versioned. See
 
1294
       versioned_kind.
 
1295
     - lstat is the stat data *if* the file was statted.
 
1296
     - planned, not implemented:
 
1297
       path_from_tree_root is the path from the root of the tree.
 
1298
 
 
1299
    :param prefix: Prefix the relpaths that are yielded with 'prefix'. This
 
1300
        allows one to walk a subtree but get paths that are relative to a tree
 
1301
        rooted higher up.
 
1302
    :return: an iterator over the dirs.
 
1303
    """
 
1304
    #TODO there is a bit of a smell where the results of the directory-
 
1305
    # summary in this, and the path from the root, may not agree
 
1306
    # depending on top and prefix - i.e. ./foo and foo as a pair leads to
 
1307
    # potentially confusing output. We should make this more robust - but
 
1308
    # not at a speed cost. RBC 20060731
 
1309
    _lstat = os.lstat
 
1310
    _directory = _directory_kind
 
1311
    _listdir = os.listdir
 
1312
    _kind_from_mode = file_kind_from_stat_mode
 
1313
    pending = [(safe_unicode(prefix), "", _directory, None, safe_unicode(top))]
 
1314
    while pending:
 
1315
        # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1316
        relroot, _, _, _, top = pending.pop()
 
1317
        if relroot:
 
1318
            relprefix = relroot + u'/'
 
1319
        else:
 
1320
            relprefix = ''
 
1321
        top_slash = top + u'/'
 
1322
 
 
1323
        dirblock = []
 
1324
        append = dirblock.append
 
1325
        try:
 
1326
            names = sorted(_listdir(top))
 
1327
        except OSError, e:
 
1328
            if not _is_error_enotdir(e):
 
1329
                raise
 
1330
        else:
 
1331
            for name in names:
 
1332
                abspath = top_slash + name
 
1333
                statvalue = _lstat(abspath)
 
1334
                kind = _kind_from_mode(statvalue.st_mode)
 
1335
                append((relprefix + name, name, kind, statvalue, abspath))
 
1336
        yield (relroot, top), dirblock
 
1337
 
 
1338
        # push the user specified dirs from dirblock
 
1339
        pending.extend(d for d in reversed(dirblock) if d[2] == _directory)
 
1340
 
 
1341
 
 
1342
class DirReader(object):
 
1343
    """An interface for reading directories."""
 
1344
 
 
1345
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1346
        """Converts top and prefix to a starting dir entry
 
1347
 
 
1348
        :param top: A utf8 path
 
1349
        :param prefix: An optional utf8 path to prefix output relative paths
 
1350
            with.
 
1351
        :return: A tuple starting with prefix, and ending with the native
 
1352
            encoding of top.
 
1353
        """
 
1354
        raise NotImplementedError(self.top_prefix_to_starting_dir)
 
1355
 
 
1356
    def read_dir(self, prefix, top):
 
1357
        """Read a specific dir.
 
1358
 
 
1359
        :param prefix: A utf8 prefix to be preprended to the path basenames.
 
1360
        :param top: A natively encoded path to read.
 
1361
        :return: A list of the directories contents. Each item contains:
 
1362
            (utf8_relpath, utf8_name, kind, lstatvalue, native_abspath)
 
1363
        """
 
1364
        raise NotImplementedError(self.read_dir)
 
1365
 
 
1366
 
 
1367
_selected_dir_reader = None
 
1368
 
 
1369
 
 
1370
def _walkdirs_utf8(top, prefix=""):
 
1371
    """Yield data about all the directories in a tree.
 
1372
 
 
1373
    This yields the same information as walkdirs() only each entry is yielded
 
1374
    in utf-8. On platforms which have a filesystem encoding of utf8 the paths
 
1375
    are returned as exact byte-strings.
 
1376
 
 
1377
    :return: yields a tuple of (dir_info, [file_info])
 
1378
        dir_info is (utf8_relpath, path-from-top)
 
1379
        file_info is (utf8_relpath, utf8_name, kind, lstat, path-from-top)
 
1380
        if top is an absolute path, path-from-top is also an absolute path.
 
1381
        path-from-top might be unicode or utf8, but it is the correct path to
 
1382
        pass to os functions to affect the file in question. (such as os.lstat)
 
1383
    """
 
1384
    global _selected_dir_reader
 
1385
    if _selected_dir_reader is None:
 
1386
        fs_encoding = _fs_enc.upper()
 
1387
        if sys.platform == "win32" and win32utils.winver == 'Windows NT':
 
1388
            # Win98 doesn't have unicode apis like FindFirstFileW
 
1389
            # TODO: We possibly could support Win98 by falling back to the
 
1390
            #       original FindFirstFile, and using TCHAR instead of WCHAR,
 
1391
            #       but that gets a bit tricky, and requires custom compiling
 
1392
            #       for win98 anyway.
 
1393
            try:
 
1394
                from bzrlib._walkdirs_win32 import Win32ReadDir
 
1395
            except ImportError:
 
1396
                _selected_dir_reader = UnicodeDirReader()
 
1397
            else:
 
1398
                _selected_dir_reader = Win32ReadDir()
 
1399
        elif fs_encoding not in ('UTF-8', 'US-ASCII', 'ANSI_X3.4-1968'):
 
1400
            # ANSI_X3.4-1968 is a form of ASCII
 
1401
            _selected_dir_reader = UnicodeDirReader()
 
1402
        else:
 
1403
            try:
 
1404
                from bzrlib._readdir_pyx import UTF8DirReader
 
1405
            except ImportError:
 
1406
                # No optimised code path
 
1407
                _selected_dir_reader = UnicodeDirReader()
 
1408
            else:
 
1409
                _selected_dir_reader = UTF8DirReader()
 
1410
    # 0 - relpath, 1- basename, 2- kind, 3- stat, 4-toppath
 
1411
    # But we don't actually uses 1-3 in pending, so set them to None
 
1412
    pending = [[_selected_dir_reader.top_prefix_to_starting_dir(top, prefix)]]
 
1413
    read_dir = _selected_dir_reader.read_dir
 
1414
    _directory = _directory_kind
 
1415
    while pending:
 
1416
        relroot, _, _, _, top = pending[-1].pop()
 
1417
        if not pending[-1]:
 
1418
            pending.pop()
 
1419
        dirblock = sorted(read_dir(relroot, top))
 
1420
        yield (relroot, top), dirblock
 
1421
        # push the user specified dirs from dirblock
 
1422
        next = [d for d in reversed(dirblock) if d[2] == _directory]
 
1423
        if next:
 
1424
            pending.append(next)
 
1425
 
 
1426
 
 
1427
class UnicodeDirReader(DirReader):
 
1428
    """A dir reader for non-utf8 file systems, which transcodes."""
 
1429
 
 
1430
    __slots__ = ['_utf8_encode']
 
1431
 
 
1432
    def __init__(self):
 
1433
        self._utf8_encode = codecs.getencoder('utf8')
 
1434
 
 
1435
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
1436
        """See DirReader.top_prefix_to_starting_dir."""
 
1437
        return (safe_utf8(prefix), None, None, None, safe_unicode(top))
 
1438
 
 
1439
    def read_dir(self, prefix, top):
 
1440
        """Read a single directory from a non-utf8 file system.
 
1441
 
 
1442
        top, and the abspath element in the output are unicode, all other paths
 
1443
        are utf8. Local disk IO is done via unicode calls to listdir etc.
 
1444
 
 
1445
        This is currently the fallback code path when the filesystem encoding is
 
1446
        not UTF-8. It may be better to implement an alternative so that we can
 
1447
        safely handle paths that are not properly decodable in the current
 
1448
        encoding.
 
1449
 
 
1450
        See DirReader.read_dir for details.
 
1451
        """
 
1452
        _utf8_encode = self._utf8_encode
 
1453
        _lstat = os.lstat
 
1454
        _listdir = os.listdir
 
1455
        _kind_from_mode = file_kind_from_stat_mode
 
1456
 
 
1457
        if prefix:
 
1458
            relprefix = prefix + '/'
 
1459
        else:
 
1460
            relprefix = ''
 
1461
        top_slash = top + u'/'
 
1462
 
 
1463
        dirblock = []
 
1464
        append = dirblock.append
 
1465
        for name in sorted(_listdir(top)):
 
1466
            try:
 
1467
                name_utf8 = _utf8_encode(name)[0]
 
1468
            except UnicodeDecodeError:
 
1469
                raise errors.BadFilenameEncoding(
 
1470
                    _utf8_encode(relprefix)[0] + name, _fs_enc)
 
1471
            abspath = top_slash + name
 
1472
            statvalue = _lstat(abspath)
 
1473
            kind = _kind_from_mode(statvalue.st_mode)
 
1474
            append((relprefix + name_utf8, name_utf8, kind, statvalue, abspath))
 
1475
        return dirblock
 
1476
 
 
1477
 
 
1478
def copy_tree(from_path, to_path, handlers={}):
 
1479
    """Copy all of the entries in from_path into to_path.
 
1480
 
 
1481
    :param from_path: The base directory to copy.
 
1482
    :param to_path: The target directory. If it does not exist, it will
 
1483
        be created.
 
1484
    :param handlers: A dictionary of functions, which takes a source and
 
1485
        destinations for files, directories, etc.
 
1486
        It is keyed on the file kind, such as 'directory', 'symlink', or 'file'
 
1487
        'file', 'directory', and 'symlink' should always exist.
 
1488
        If they are missing, they will be replaced with 'os.mkdir()',
 
1489
        'os.readlink() + os.symlink()', and 'shutil.copy2()', respectively.
 
1490
    """
 
1491
    # Now, just copy the existing cached tree to the new location
 
1492
    # We use a cheap trick here.
 
1493
    # Absolute paths are prefixed with the first parameter
 
1494
    # relative paths are prefixed with the second.
 
1495
    # So we can get both the source and target returned
 
1496
    # without any extra work.
 
1497
 
 
1498
    def copy_dir(source, dest):
 
1499
        os.mkdir(dest)
 
1500
 
 
1501
    def copy_link(source, dest):
 
1502
        """Copy the contents of a symlink"""
 
1503
        link_to = os.readlink(source)
 
1504
        os.symlink(link_to, dest)
 
1505
 
 
1506
    real_handlers = {'file':shutil.copy2,
 
1507
                     'symlink':copy_link,
 
1508
                     'directory':copy_dir,
 
1509
                    }
 
1510
    real_handlers.update(handlers)
 
1511
 
 
1512
    if not os.path.exists(to_path):
 
1513
        real_handlers['directory'](from_path, to_path)
 
1514
 
 
1515
    for dir_info, entries in walkdirs(from_path, prefix=to_path):
 
1516
        for relpath, name, kind, st, abspath in entries:
 
1517
            real_handlers[kind](abspath, relpath)
 
1518
 
 
1519
 
 
1520
def path_prefix_key(path):
 
1521
    """Generate a prefix-order path key for path.
 
1522
 
 
1523
    This can be used to sort paths in the same way that walkdirs does.
 
1524
    """
 
1525
    return (dirname(path) , path)
 
1526
 
 
1527
 
 
1528
def compare_paths_prefix_order(path_a, path_b):
 
1529
    """Compare path_a and path_b to generate the same order walkdirs uses."""
 
1530
    key_a = path_prefix_key(path_a)
 
1531
    key_b = path_prefix_key(path_b)
 
1532
    return cmp(key_a, key_b)
 
1533
 
 
1534
 
 
1535
_cached_user_encoding = None
 
1536
 
 
1537
 
 
1538
def get_user_encoding(use_cache=True):
 
1539
    """Find out what the preferred user encoding is.
 
1540
 
 
1541
    This is generally the encoding that is used for command line parameters
 
1542
    and file contents. This may be different from the terminal encoding
 
1543
    or the filesystem encoding.
 
1544
 
 
1545
    :param  use_cache:  Enable cache for detected encoding.
 
1546
                        (This parameter is turned on by default,
 
1547
                        and required only for selftesting)
 
1548
 
 
1549
    :return: A string defining the preferred user encoding
 
1550
    """
 
1551
    global _cached_user_encoding
 
1552
    if _cached_user_encoding is not None and use_cache:
 
1553
        return _cached_user_encoding
 
1554
 
 
1555
    if sys.platform == 'darwin':
 
1556
        # python locale.getpreferredencoding() always return
 
1557
        # 'mac-roman' on darwin. That's a lie.
 
1558
        sys.platform = 'posix'
 
1559
        try:
 
1560
            if os.environ.get('LANG', None) is None:
 
1561
                # If LANG is not set, we end up with 'ascii', which is bad
 
1562
                # ('mac-roman' is more than ascii), so we set a default which
 
1563
                # will give us UTF-8 (which appears to work in all cases on
 
1564
                # OSX). Users are still free to override LANG of course, as
 
1565
                # long as it give us something meaningful. This work-around
 
1566
                # *may* not be needed with python 3k and/or OSX 10.5, but will
 
1567
                # work with them too -- vila 20080908
 
1568
                os.environ['LANG'] = 'en_US.UTF-8'
 
1569
            import locale
 
1570
        finally:
 
1571
            sys.platform = 'darwin'
 
1572
    else:
 
1573
        import locale
 
1574
 
 
1575
    try:
 
1576
        user_encoding = locale.getpreferredencoding()
 
1577
    except locale.Error, e:
 
1578
        sys.stderr.write('bzr: warning: %s\n'
 
1579
                         '  Could not determine what text encoding to use.\n'
 
1580
                         '  This error usually means your Python interpreter\n'
 
1581
                         '  doesn\'t support the locale set by $LANG (%s)\n'
 
1582
                         "  Continuing with ascii encoding.\n"
 
1583
                         % (e, os.environ.get('LANG')))
 
1584
        user_encoding = 'ascii'
 
1585
 
 
1586
    # Windows returns 'cp0' to indicate there is no code page. So we'll just
 
1587
    # treat that as ASCII, and not support printing unicode characters to the
 
1588
    # console.
 
1589
    #
 
1590
    # For python scripts run under vim, we get '', so also treat that as ASCII
 
1591
    if user_encoding in (None, 'cp0', ''):
 
1592
        user_encoding = 'ascii'
 
1593
    else:
 
1594
        # check encoding
 
1595
        try:
 
1596
            codecs.lookup(user_encoding)
 
1597
        except LookupError:
 
1598
            sys.stderr.write('bzr: warning:'
 
1599
                             ' unknown encoding %s.'
 
1600
                             ' Continuing with ascii encoding.\n'
 
1601
                             % user_encoding
 
1602
                            )
 
1603
            user_encoding = 'ascii'
 
1604
 
 
1605
    if use_cache:
 
1606
        _cached_user_encoding = user_encoding
 
1607
 
 
1608
    return user_encoding
 
1609
 
 
1610
 
 
1611
def get_host_name():
 
1612
    """Return the current unicode host name.
 
1613
 
 
1614
    This is meant to be used in place of socket.gethostname() because that
 
1615
    behaves inconsistently on different platforms.
 
1616
    """
 
1617
    if sys.platform == "win32":
 
1618
        import win32utils
 
1619
        return win32utils.get_host_name()
 
1620
    else:
 
1621
        import socket
 
1622
        return socket.gethostname().decode(get_user_encoding())
 
1623
 
 
1624
 
 
1625
def recv_all(socket, bytes):
 
1626
    """Receive an exact number of bytes.
 
1627
 
 
1628
    Regular Socket.recv() may return less than the requested number of bytes,
 
1629
    dependning on what's in the OS buffer.  MSG_WAITALL is not available
 
1630
    on all platforms, but this should work everywhere.  This will return
 
1631
    less than the requested amount if the remote end closes.
 
1632
 
 
1633
    This isn't optimized and is intended mostly for use in testing.
 
1634
    """
 
1635
    b = ''
 
1636
    while len(b) < bytes:
 
1637
        new = until_no_eintr(socket.recv, bytes - len(b))
 
1638
        if new == '':
 
1639
            break # eof
 
1640
        b += new
 
1641
    return b
 
1642
 
 
1643
 
 
1644
def send_all(socket, bytes, report_activity=None):
 
1645
    """Send all bytes on a socket.
 
1646
 
 
1647
    Regular socket.sendall() can give socket error 10053 on Windows.  This
 
1648
    implementation sends no more than 64k at a time, which avoids this problem.
 
1649
 
 
1650
    :param report_activity: Call this as bytes are read, see
 
1651
        Transport._report_activity
 
1652
    """
 
1653
    chunk_size = 2**16
 
1654
    for pos in xrange(0, len(bytes), chunk_size):
 
1655
        block = bytes[pos:pos+chunk_size]
 
1656
        if report_activity is not None:
 
1657
            report_activity(len(block), 'write')
 
1658
        until_no_eintr(socket.sendall, block)
 
1659
 
 
1660
 
 
1661
def dereference_path(path):
 
1662
    """Determine the real path to a file.
 
1663
 
 
1664
    All parent elements are dereferenced.  But the file itself is not
 
1665
    dereferenced.
 
1666
    :param path: The original path.  May be absolute or relative.
 
1667
    :return: the real path *to* the file
 
1668
    """
 
1669
    parent, base = os.path.split(path)
 
1670
    # The pathjoin for '.' is a workaround for Python bug #1213894.
 
1671
    # (initial path components aren't dereferenced)
 
1672
    return pathjoin(realpath(pathjoin('.', parent)), base)
 
1673
 
 
1674
 
 
1675
def supports_mapi():
 
1676
    """Return True if we can use MAPI to launch a mail client."""
 
1677
    return sys.platform == "win32"
 
1678
 
 
1679
 
 
1680
def resource_string(package, resource_name):
 
1681
    """Load a resource from a package and return it as a string.
 
1682
 
 
1683
    Note: Only packages that start with bzrlib are currently supported.
 
1684
 
 
1685
    This is designed to be a lightweight implementation of resource
 
1686
    loading in a way which is API compatible with the same API from
 
1687
    pkg_resources. See
 
1688
    http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
 
1689
    If and when pkg_resources becomes a standard library, this routine
 
1690
    can delegate to it.
 
1691
    """
 
1692
    # Check package name is within bzrlib
 
1693
    if package == "bzrlib":
 
1694
        resource_relpath = resource_name
 
1695
    elif package.startswith("bzrlib."):
 
1696
        package = package[len("bzrlib."):].replace('.', os.sep)
 
1697
        resource_relpath = pathjoin(package, resource_name)
 
1698
    else:
 
1699
        raise errors.BzrError('resource package %s not in bzrlib' % package)
 
1700
 
 
1701
    # Map the resource to a file and read its contents
 
1702
    base = dirname(bzrlib.__file__)
 
1703
    if getattr(sys, 'frozen', None):    # bzr.exe
 
1704
        base = abspath(pathjoin(base, '..', '..'))
 
1705
    filename = pathjoin(base, resource_relpath)
 
1706
    return open(filename, 'rU').read()
 
1707
 
 
1708
 
 
1709
def file_kind_from_stat_mode_thunk(mode):
 
1710
    global file_kind_from_stat_mode
 
1711
    if file_kind_from_stat_mode is file_kind_from_stat_mode_thunk:
 
1712
        try:
 
1713
            from bzrlib._readdir_pyx import UTF8DirReader
 
1714
            file_kind_from_stat_mode = UTF8DirReader().kind_from_mode
 
1715
        except ImportError:
 
1716
            from bzrlib._readdir_py import (
 
1717
                _kind_from_mode as file_kind_from_stat_mode
 
1718
                )
 
1719
    return file_kind_from_stat_mode(mode)
 
1720
file_kind_from_stat_mode = file_kind_from_stat_mode_thunk
 
1721
 
 
1722
 
 
1723
def file_kind(f, _lstat=os.lstat):
 
1724
    try:
 
1725
        return file_kind_from_stat_mode(_lstat(f).st_mode)
 
1726
    except OSError, e:
 
1727
        if getattr(e, 'errno', None) in (errno.ENOENT, errno.ENOTDIR):
 
1728
            raise errors.NoSuchFile(f)
468
1729
        raise
469
1730
 
470
1731
 
471
 
def _get_editor():
472
 
    """Return a sequence of possible editor binaries for the current platform"""
473
 
    e = _read_config_value("editor")
474
 
    if e is not None:
475
 
        yield e
476
 
        
477
 
    if os.name == "windows":
478
 
        yield "notepad.exe"
479
 
    elif os.name == "posix":
 
1732
def until_no_eintr(f, *a, **kw):
 
1733
    """Run f(*a, **kw), retrying if an EINTR error occurs."""
 
1734
    # Borrowed from Twisted's twisted.python.util.untilConcludes function.
 
1735
    while True:
480
1736
        try:
481
 
            yield os.environ["EDITOR"]
482
 
        except KeyError:
483
 
            yield "/usr/bin/vi"
484
 
 
485
 
 
486
 
def _run_editor(filename):
487
 
    """Try to execute an editor to edit the commit message. Returns True on success,
488
 
    False on failure"""
489
 
    for e in _get_editor():
490
 
        x = os.spawnvp(os.P_WAIT, e, (e, filename))
491
 
        if x == 0:
492
 
            return True
493
 
        elif x == 127:
494
 
            continue
495
 
        else:
496
 
            break
497
 
    raise BzrError("Could not start any editor. Please specify $EDITOR or use ~/.bzr.conf/editor")
498
 
    return False
499
 
                          
500
 
 
501
 
def get_text_message(infotext, ignoreline = "default"):
502
 
    import tempfile
 
1737
            return f(*a, **kw)
 
1738
        except (IOError, OSError), e:
 
1739
            if e.errno == errno.EINTR:
 
1740
                continue
 
1741
            raise
 
1742
 
 
1743
def re_compile_checked(re_string, flags=0, where=""):
 
1744
    """Return a compiled re, or raise a sensible error.
503
1745
    
504
 
    if ignoreline == "default":
505
 
        ignoreline = "-- This line and the following will be ignored --"
506
 
        
 
1746
    This should only be used when compiling user-supplied REs.
 
1747
 
 
1748
    :param re_string: Text form of regular expression.
 
1749
    :param flags: eg re.IGNORECASE
 
1750
    :param where: Message explaining to the user the context where 
 
1751
        it occurred, eg 'log search filter'.
 
1752
    """
 
1753
    # from https://bugs.launchpad.net/bzr/+bug/251352
507
1754
    try:
508
 
        tmp_fileno, msgfilename = tempfile.mkstemp()
509
 
        msgfile = os.close(tmp_fileno)
510
 
        if infotext is not None and infotext != "":
511
 
            hasinfo = True
512
 
            msgfile = file(msgfilename, "w")
513
 
            msgfile.write("\n\n%s\n\n%s" % (ignoreline, infotext))
514
 
            msgfile.close()
515
 
        else:
516
 
            hasinfo = False
517
 
 
518
 
        if not _run_editor(msgfilename):
519
 
            return None
520
 
        
521
 
        started = False
522
 
        msg = []
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
527
 
            if not started:
528
 
                if stripped_line != "":
529
 
                    started = True
530
 
                else:
531
 
                    continue
532
 
            # check for the ignore line only if there
533
 
            # is additional information at the end
534
 
            if hasinfo and stripped_line == ignoreline:
535
 
                break
536
 
            nlines += 1
537
 
            # keep track of the last line that had some content
538
 
            if stripped_line != "":
539
 
                lastline = nlines
540
 
            msg.append(line)
541
 
            
542
 
        if len(msg) == 0:
543
 
            return None
544
 
        # delete empty lines at the end
545
 
        del msg[lastline:]
546
 
        # add a newline at the end, if needed
547
 
        if not msg[-1].endswith("\n"):
548
 
            return "%s%s" % ("".join(msg), "\n")
549
 
        else:
550
 
            return "".join(msg)
551
 
    finally:
552
 
        # delete the msg file in any case
553
 
        try: os.unlink(msgfilename)
554
 
        except IOError: pass
 
1755
        re_obj = re.compile(re_string, flags)
 
1756
        re_obj.search("")
 
1757
        return re_obj
 
1758
    except re.error, e:
 
1759
        if where:
 
1760
            where = ' in ' + where
 
1761
        # despite the name 'error' is a type
 
1762
        raise errors.BzrCommandError('Invalid regular expression%s: %r: %s'
 
1763
            % (where, re_string, e))
 
1764
 
 
1765
 
 
1766
if sys.platform == "win32":
 
1767
    import msvcrt
 
1768
    def getchar():
 
1769
        return msvcrt.getch()
 
1770
else:
 
1771
    import tty
 
1772
    import termios
 
1773
    def getchar():
 
1774
        fd = sys.stdin.fileno()
 
1775
        settings = termios.tcgetattr(fd)
 
1776
        try:
 
1777
            tty.setraw(fd)
 
1778
            ch = sys.stdin.read(1)
 
1779
        finally:
 
1780
            termios.tcsetattr(fd, termios.TCSADRAIN, settings)
 
1781
        return ch