1
 
# Bazaar-NG -- distributed version control
 
3
 
# Copyright (C) 2005 by Canonical Ltd
 
5
 
# This program is free software; you can redistribute it and/or modify
 
6
 
# it under the terms of the GNU General Public License as published by
 
7
 
# the Free Software Foundation; either version 2 of the License, or
 
8
 
# (at your option) any later version.
 
10
 
# This program is distributed in the hope that it will be useful,
 
11
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 
# GNU General Public License for more details.
 
15
 
# You should have received a copy of the GNU General Public License
 
16
 
# along with this program; if not, write to the Free Software
 
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
19
 
import os, types, re, time, types
 
20
 
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
22
 
from errors import bailout
 
24
 
def make_readonly(filename):
 
25
 
    """Make a filename read-only."""
 
26
 
    # TODO: probably needs to be fixed for windows
 
27
 
    mod = os.stat(filename).st_mode
 
29
 
    os.chmod(filename, mod)
 
32
 
def make_writable(filename):
 
33
 
    mod = os.stat(filename).st_mode
 
35
 
    os.chmod(filename, mod)
 
38
 
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
40
 
    """Return shell-quoted filename"""
 
41
 
    ## We could be a bit more terse by using double-quotes etc
 
42
 
    f = _QUOTE_RE.sub(r'\\\1', f)
 
49
 
    mode = os.lstat(f)[ST_MODE]
 
57
 
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
 
62
 
    """True if f is an accessible directory."""
 
64
 
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
71
 
    """True if f is a regular file."""
 
73
 
        return S_ISREG(os.lstat(f)[ST_MODE])
 
78
 
def pumpfile(fromfile, tofile):
 
79
 
    """Copy contents of one file to another."""
 
80
 
    tofile.write(fromfile.read())
 
84
 
    """Return a new UUID"""
 
86
 
    ## XXX: Could alternatively read /proc/sys/kernel/random/uuid on
 
87
 
    ## Linux, but we need something portable for other systems;
 
88
 
    ## preferably an implementation in Python.
 
90
 
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
 
92
 
        return chomp(os.popen('uuidgen').readline())
 
96
 
    if s and (s[-1] == '\n'):
 
104
 
    ## TODO: Maybe read in chunks to handle big files
 
105
 
    if hasattr(f, 'tell'):
 
120
 
def fingerprint_file(f):
 
126
 
    return {'size': size,
 
127
 
            'sha1': s.hexdigest()}
 
132
 
    """Return email-style username.
 
134
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
136
 
    :todo: Check it's reasonably well-formed.
 
138
 
    :todo: Allow taking it from a dotfile to help people on windows
 
139
 
           who can't easily set variables.
 
141
 
    :todo: Cope without pwd module, which is only on unix. 
 
143
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
151
 
        w = pwd.getpwuid(uid)
 
153
 
        comma = gecos.find(',')
 
157
 
            realname = gecos[:comma]
 
158
 
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
162
 
    import getpass, socket
 
163
 
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
167
 
    """Return just the email component of a username."""
 
168
 
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
171
 
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
173
 
            bailout('%r is not a reasonable email address' % e)
 
177
 
    import getpass, socket
 
178
 
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
183
 
def compare_files(a, b):
 
184
 
    """Returns true if equal in contents"""
 
185
 
    # TODO: don't read the whole thing in one go.
 
197
 
def local_time_offset(t=None):
 
198
 
    """Return offset of local zone from GMT, either at present or at time t."""
 
199
 
    # python2.3 localtime() can't take None
 
203
 
    if time.localtime(t).tm_isdst and time.daylight:
 
206
 
        return -time.timezone
 
209
 
def format_date(t, offset=0, timezone='original'):
 
210
 
    ## TODO: Perhaps a global option to use either universal or local time?
 
211
 
    ## Or perhaps just let people set $TZ?
 
214
 
    assert isinstance(t, float)
 
216
 
    if timezone == 'utc':
 
219
 
    elif timezone == 'original':
 
222
 
        tt = time.gmtime(t + offset)
 
223
 
    elif timezone == 'local':
 
224
 
        tt = time.localtime(t)
 
225
 
        offset = local_time_offset(t)
 
227
 
        bailout("unsupported timezone format %r",
 
228
 
                ['options are "utc", "original", "local"'])
 
230
 
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
231
 
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
234
 
def compact_date(when):
 
235
 
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
240
 
    """Return size of given open file."""
 
241
 
    return os.fstat(f.fileno())[ST_SIZE]
 
244
 
if hasattr(os, 'urandom'): # python 2.4 and later
 
245
 
    rand_bytes = os.urandom
 
247
 
    # FIXME: No good on non-Linux
 
248
 
    _rand_file = file('/dev/urandom', 'rb')
 
249
 
    rand_bytes = _rand_file.read
 
252
 
## TODO: We could later have path objects that remember their list
 
253
 
## decomposition (might be too tricksy though.)
 
256
 
    """Turn string into list of parts.
 
262
 
    >>> splitpath('a/./b')
 
264
 
    >>> splitpath('a/.b')
 
266
 
    >>> splitpath('a/../b')
 
267
 
    Traceback (most recent call last):
 
269
 
    BzrError: ("sorry, '..' not allowed in path", [])
 
271
 
    assert isinstance(p, types.StringTypes)
 
272
 
    ps = [f for f in p.split('/') if f != '.']
 
275
 
            bailout("sorry, %r not allowed in path" % f)
 
279
 
    assert isinstance(p, list)
 
281
 
        if (f == '..') or (f is None) or (f == ''):
 
282
 
            bailout("sorry, %r not allowed in path" % f)
 
286
 
def appendpath(p1, p2):
 
293
 
def extern_command(cmd, ignore_errors = False):
 
294
 
    mutter('external command: %s' % `cmd`)
 
296
 
        if not ignore_errors:
 
297
 
            bailout('command failed')