← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-19 01:41:44 UTC
  • Revision ID: mbp@sourcefrog.net-20050319014144-5298a74caebaf378
fix local-time-offset calculation

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
 
 
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.
 
9
 
 
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.
 
14
 
 
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
 
18
 
 
19
import os, types, re, time, types
 
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
 
21
 
 
22
from errors import bailout
 
23
 
 
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
 
28
    mod = mod & 0777555
 
29
    os.chmod(filename, mod)
 
30
 
 
31
 
 
32
def make_writable(filename):
 
33
    mod = os.stat(filename).st_mode
 
34
    mod = mod | 0200
 
35
    os.chmod(filename, mod)
 
36
 
 
37
 
 
38
_QUOTE_RE = re.compile(r'([^a-zA-Z0-9.,:/_~-])')
 
39
def quotefn(f):
 
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)
 
43
    if f[0] == '~':
 
44
        f[0:1] = r'\~' 
 
45
    return f
 
46
 
 
47
 
 
48
def file_kind(f):
 
49
    mode = os.lstat(f)[ST_MODE]
 
50
    if S_ISREG(mode):
 
51
        return 'file'
 
52
    elif S_ISDIR(mode):
 
53
        return 'directory'
 
54
    elif S_ISLNK(mode):
 
55
        return 'symlink'
 
56
    else:
 
57
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
 
58
 
 
59
 
 
60
 
 
61
def isdir(f):
 
62
    """True if f is an accessible directory."""
 
63
    try:
 
64
        return S_ISDIR(os.lstat(f)[ST_MODE])
 
65
    except OSError:
 
66
        return False
 
67
 
 
68
 
 
69
 
 
70
def isfile(f):
 
71
    """True if f is a regular file."""
 
72
    try:
 
73
        return S_ISREG(os.lstat(f)[ST_MODE])
 
74
    except OSError:
 
75
        return False
 
76
 
 
77
 
 
78
def pumpfile(fromfile, tofile):
 
79
    """Copy contents of one file to another."""
 
80
    tofile.write(fromfile.read())
 
81
 
 
82
 
 
83
def uuid():
 
84
    """Return a new UUID"""
 
85
    
 
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.
 
89
    bailout('uuids not allowed!')
 
90
    return chomp(os.popen('uuidgen').readline())
 
91
 
 
92
def chomp(s):
 
93
    if s and (s[-1] == '\n'):
 
94
        return s[:-1]
 
95
    else:
 
96
        return s
 
97
 
 
98
 
 
99
def sha_file(f):
 
100
    import sha
 
101
    ## TODO: Maybe read in chunks to handle big files
 
102
    if hasattr(f, 'tell'):
 
103
        assert f.tell() == 0
 
104
    s = sha.new()
 
105
    s.update(f.read())
 
106
    return s.hexdigest()
 
107
 
 
108
 
 
109
def sha_string(f):
 
110
    import sha
 
111
    s = sha.new()
 
112
    s.update(f)
 
113
    return s.hexdigest()
 
114
 
 
115
 
 
116
 
 
117
def username():
 
118
    """Return email-style username.
 
119
 
 
120
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
121
 
 
122
    :todo: Check it's reasonably well-formed.
 
123
 
 
124
    :todo: Allow taking it from a dotfile to help people on windows
 
125
           who can't easily set variables.
 
126
 
 
127
    :todo: Cope without pwd module, which is only on unix. 
 
128
    """
 
129
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
130
    if e: return e
 
131
 
 
132
    import socket
 
133
    
 
134
    try:
 
135
        import pwd
 
136
        uid = os.getuid()
 
137
        w = pwd.getpwuid(uid)
 
138
        gecos = w.pw_gecos
 
139
        comma = gecos.find(',')
 
140
        if comma == -1:
 
141
            realname = gecos
 
142
        else:
 
143
            realname = gecos[:comma]
 
144
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
 
145
    except ImportError:
 
146
        pass
 
147
 
 
148
    import getpass, socket
 
149
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
150
 
 
151
 
 
152
def user_email():
 
153
    """Return just the email component of a username."""
 
154
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
155
    if e:
 
156
        import re
 
157
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
 
158
        if not m:
 
159
            bailout('%r is not a reasonable email address' % e)
 
160
        return m.group(0)
 
161
 
 
162
 
 
163
    import getpass, socket
 
164
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
165
 
 
166
    
 
167
 
 
168
 
 
169
def compare_files(a, b):
 
170
    """Returns true if equal in contents"""
 
171
    # TODO: don't read the whole thing in one go.
 
172
    result = a.read() == b.read()
 
173
    return result
 
174
 
 
175
 
 
176
 
 
177
def local_time_offset(t=None):
 
178
    """Return offset of local zone from GMT, either at present or at time t."""
 
179
    if time.localtime(t).tm_isdst and time.daylight:
 
180
        return -time.altzone
 
181
    else:
 
182
        return -time.timezone
 
183
 
 
184
    
 
185
def format_date(t, offset=0, timezone='original'):
 
186
    ## TODO: Perhaps a global option to use either universal or local time?
 
187
    ## Or perhaps just let people set $TZ?
 
188
    import time
 
189
    
 
190
    assert isinstance(t, float)
 
191
    
 
192
    if timezone == 'utc':
 
193
        tt = time.gmtime(t)
 
194
        offset = 0
 
195
    elif timezone == 'original':
 
196
        if offset == None:
 
197
            offset = 0
 
198
        tt = time.gmtime(t + offset)
 
199
    elif timezone == 'local':
 
200
        tt = time.localtime(t)
 
201
        offset = local_time_offset(t)
 
202
    else:
 
203
        bailout("unsupported timezone format %r",
 
204
                ['options are "utc", "original", "local"'])
 
205
 
 
206
    return (time.strftime("%a %Y-%m-%d %H:%M:%S", tt)
 
207
            + ' %+03d%02d' % (offset / 3600, (offset / 60) % 60))
 
208
 
 
209
 
 
210
def compact_date(when):
 
211
    return time.strftime('%Y%m%d%H%M%S', time.gmtime(when))
 
212
    
 
213
 
 
214
 
 
215
def filesize(f):
 
216
    """Return size of given open file."""
 
217
    return os.fstat(f.fileno())[ST_SIZE]
 
218
 
 
219
 
 
220
if hasattr(os, 'urandom'): # python 2.4 and later
 
221
    rand_bytes = os.urandom
 
222
else:
 
223
    # FIXME: No good on non-Linux
 
224
    _rand_file = file('/dev/urandom', 'rb')
 
225
    rand_bytes = _rand_file.read
 
226
 
 
227
 
 
228
## TODO: We could later have path objects that remember their list
 
229
## decomposition (might be too tricksy though.)
 
230
 
 
231
def splitpath(p):
 
232
    """Turn string into list of parts.
 
233
 
 
234
    >>> splitpath('a')
 
235
    ['a']
 
236
    >>> splitpath('a/b')
 
237
    ['a', 'b']
 
238
    >>> splitpath('a/./b')
 
239
    ['a', 'b']
 
240
    >>> splitpath('a/.b')
 
241
    ['a', '.b']
 
242
    >>> splitpath('a/../b')
 
243
    Traceback (most recent call last):
 
244
    ...
 
245
    BzrError: ("sorry, '..' not allowed in path", [])
 
246
    """
 
247
    assert isinstance(p, types.StringTypes)
 
248
    ps = [f for f in p.split('/') if f != '.']
 
249
    for f in ps:
 
250
        if f == '..':
 
251
            bailout("sorry, %r not allowed in path" % f)
 
252
    return ps
 
253
 
 
254
def joinpath(p):
 
255
    assert isinstance(p, list)
 
256
    for f in p:
 
257
        if (f == '..') or (f is None) or (f == ''):
 
258
            bailout("sorry, %r not allowed in path" % f)
 
259
    return '/'.join(p)
 
260
 
 
261
 
 
262
def appendpath(p1, p2):
 
263
    if p1 == '':
 
264
        return p2
 
265
    else:
 
266
        return p1 + '/' + p2
 
267
    
 
268
 
 
269
def extern_command(cmd, ignore_errors = False):
 
270
    mutter('external command: %s' % `cmd`)
 
271
    if os.system(cmd):
 
272
        if not ignore_errors:
 
273
            bailout('command failed')
 
274