~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/osutils.py

  • Committer: Martin Pool
  • Date: 2005-03-14 07:07:24 UTC
  • Revision ID: mbp@sourcefrog.net-20050314070724-ba6c85db7d96c508
- add setup.py and install instructions
- rename main script to just bzr

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
# along with this program; if not, write to the Free Software
17
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
 
19
 
import os, types, re, time, errno, sys
 
19
import os, types, re, time, types
20
20
from stat import S_ISREG, S_ISDIR, S_ISLNK, ST_MODE, ST_SIZE
21
21
 
22
 
from errors import bailout, BzrError
23
 
from trace import mutter
24
 
import bzrlib
 
22
from errors import bailout
25
23
 
26
24
def make_readonly(filename):
27
25
    """Make a filename read-only."""
56
54
    elif S_ISLNK(mode):
57
55
        return 'symlink'
58
56
    else:
59
 
        raise BzrError("can't handle file kind with mode %o of %r" % (mode, f))
60
 
 
61
 
 
62
 
def kind_marker(kind):
63
 
    if kind == 'file':
64
 
        return ''
65
 
    elif kind == 'directory':
66
 
        return '/'
67
 
    elif kind == 'symlink':
68
 
        return '@'
69
 
    else:
70
 
        raise BzrError('invalid file kind %r' % kind)
 
57
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
71
58
 
72
59
 
73
60
 
88
75
        return False
89
76
 
90
77
 
91
 
def is_inside(dir, fname):
92
 
    """True if fname is inside dir.
93
 
    """
94
 
    return os.path.commonprefix([dir, fname]) == dir
95
 
 
96
 
 
97
 
def is_inside_any(dir_list, fname):
98
 
    """True if fname is inside any of given dirs."""
99
 
    # quick scan for perfect match
100
 
    if fname in dir_list:
101
 
        return True
102
 
    
103
 
    for dirname in dir_list:
104
 
        if is_inside(dirname, fname):
105
 
            return True
106
 
    else:
107
 
        return False
108
 
 
109
 
 
110
78
def pumpfile(fromfile, tofile):
111
79
    """Copy contents of one file to another."""
112
80
    tofile.write(fromfile.read())
114
82
 
115
83
def uuid():
116
84
    """Return a new UUID"""
117
 
    try:
118
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
119
 
    except IOError:
120
 
        return chomp(os.popen('uuidgen').readline())
 
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
121
97
 
122
98
 
123
99
def sha_file(f):
124
100
    import sha
 
101
    ## TODO: Maybe read in chunks to handle big files
125
102
    if hasattr(f, 'tell'):
126
103
        assert f.tell() == 0
127
104
    s = sha.new()
128
 
    BUFSIZE = 128<<10
129
 
    while True:
130
 
        b = f.read(BUFSIZE)
131
 
        if not b:
132
 
            break
133
 
        s.update(b)
 
105
    s.update(f.read())
134
106
    return s.hexdigest()
135
107
 
136
108
 
142
114
 
143
115
 
144
116
 
145
 
def fingerprint_file(f):
146
 
    import sha
147
 
    s = sha.new()
148
 
    b = f.read()
149
 
    s.update(b)
150
 
    size = len(b)
151
 
    return {'size': size,
152
 
            'sha1': s.hexdigest()}
153
 
 
154
 
 
155
 
def config_dir():
156
 
    """Return per-user configuration directory.
157
 
 
158
 
    By default this is ~/.bzr.conf/
159
 
    
160
 
    TODO: Global option --config-dir to override this.
161
 
    """
162
 
    return os.path.expanduser("~/.bzr.conf")
163
 
 
164
 
 
165
 
def _auto_user_id():
166
 
    """Calculate automatic user identification.
167
 
 
168
 
    Returns (realname, email).
169
 
 
170
 
    Only used when none is set in the environment or the id file.
171
 
 
172
 
    This previously used the FQDN as the default domain, but that can
173
 
    be very slow on machines where DNS is broken.  So now we simply
174
 
    use the hostname.
175
 
    """
 
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
 
176
132
    import socket
177
 
 
178
 
    # XXX: Any good way to get real user name on win32?
179
 
 
 
133
    
180
134
    try:
181
135
        import pwd
182
136
        uid = os.getuid()
183
137
        w = pwd.getpwuid(uid)
184
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
185
 
        username = w.pw_name.decode(bzrlib.user_encoding)
 
138
        gecos = w.pw_gecos
186
139
        comma = gecos.find(',')
187
140
        if comma == -1:
188
141
            realname = gecos
189
142
        else:
190
143
            realname = gecos[:comma]
191
 
        if not realname:
192
 
            realname = username
193
 
 
 
144
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
194
145
    except ImportError:
195
 
        import getpass
196
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
197
 
 
198
 
    return realname, (username + '@' + socket.gethostname())
199
 
 
200
 
 
201
 
def _get_user_id():
202
 
    """Return the full user id from a file or environment variable.
203
 
 
204
 
    TODO: Allow taking this from a file in the branch directory too
205
 
    for per-branch ids."""
206
 
    v = os.environ.get('BZREMAIL')
207
 
    if v:
208
 
        return v.decode(bzrlib.user_encoding)
209
 
    
210
 
    try:
211
 
        return (open(os.path.join(config_dir(), "email"))
212
 
                .read()
213
 
                .decode(bzrlib.user_encoding)
214
 
                .rstrip("\r\n"))
215
 
    except IOError, e:
216
 
        if e.errno != errno.ENOENT:
217
 
            raise e
218
 
 
219
 
    v = os.environ.get('EMAIL')
220
 
    if v:
221
 
        return v.decode(bzrlib.user_encoding)
222
 
    else:    
223
 
        return None
224
 
 
225
 
 
226
 
def username():
227
 
    """Return email-style username.
228
 
 
229
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
230
 
 
231
 
    TODO: Check it's reasonably well-formed.
232
 
    """
233
 
    v = _get_user_id()
234
 
    if v:
235
 
        return v
236
 
    
237
 
    name, email = _auto_user_id()
238
 
    if name:
239
 
        return '%s <%s>' % (name, email)
240
 
    else:
241
 
        return email
242
 
 
243
 
 
244
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
146
        pass
 
147
 
 
148
    import getpass, socket
 
149
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
150
 
 
151
 
245
152
def user_email():
246
153
    """Return just the email component of a username."""
247
 
    e = _get_user_id()
 
154
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
248
155
    if e:
249
 
        m = _EMAIL_RE.search(e)
 
156
        import re
 
157
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
250
158
        if not m:
251
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
159
            bailout('%r is not a reasonable email address' % e)
252
160
        return m.group(0)
253
161
 
254
 
    return _auto_user_id()[1]
 
162
 
 
163
    import getpass, socket
 
164
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
165
 
255
166
    
256
167
 
257
168
 
258
169
def compare_files(a, b):
259
170
    """Returns true if equal in contents"""
260
 
    BUFSIZE = 4096
261
 
    while True:
262
 
        ai = a.read(BUFSIZE)
263
 
        bi = b.read(BUFSIZE)
264
 
        if ai != bi:
265
 
            return False
266
 
        if ai == '':
267
 
            return True
268
 
 
269
 
 
270
 
 
271
 
def local_time_offset(t=None):
272
 
    """Return offset of local zone from GMT, either at present or at time t."""
273
 
    # python2.3 localtime() can't take None
274
 
    if t == None:
275
 
        t = time.time()
276
 
        
277
 
    if time.localtime(t).tm_isdst and time.daylight:
 
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():
 
178
    if time.daylight:
278
179
        return -time.altzone
279
180
    else:
280
181
        return -time.timezone
283
184
def format_date(t, offset=0, timezone='original'):
284
185
    ## TODO: Perhaps a global option to use either universal or local time?
285
186
    ## Or perhaps just let people set $TZ?
 
187
    import time
 
188
    
286
189
    assert isinstance(t, float)
287
190
    
288
191
    if timezone == 'utc':
294
197
        tt = time.gmtime(t + offset)
295
198
    elif timezone == 'local':
296
199
        tt = time.localtime(t)
297
 
        offset = local_time_offset(t)
 
200
        offset = local_time_offset()
298
201
    else:
299
202
        bailout("unsupported timezone format %r",
300
203
                ['options are "utc", "original", "local"'])
315
218
 
316
219
if hasattr(os, 'urandom'): # python 2.4 and later
317
220
    rand_bytes = os.urandom
318
 
elif sys.platform == 'linux2':
319
 
    rand_bytes = file('/dev/urandom', 'rb').read
320
221
else:
321
 
    # not well seeded, but better than nothing
322
 
    def rand_bytes(n):
323
 
        import random
324
 
        s = ''
325
 
        while n:
326
 
            s += chr(random.randint(0, 255))
327
 
            n -= 1
328
 
        return s
 
222
    # FIXME: No good on non-Linux
 
223
    _rand_file = file('/dev/urandom', 'rb')
 
224
    rand_bytes = _rand_file.read
329
225
 
330
226
 
331
227
## TODO: We could later have path objects that remember their list
348
244
    BzrError: ("sorry, '..' not allowed in path", [])
349
245
    """
350
246
    assert isinstance(p, types.StringTypes)
351
 
 
352
 
    # split on either delimiter because people might use either on
353
 
    # Windows
354
 
    ps = re.split(r'[\\/]', p)
355
 
 
356
 
    rps = []
 
247
    ps = [f for f in p.split('/') if f != '.']
357
248
    for f in ps:
358
249
        if f == '..':
359
250
            bailout("sorry, %r not allowed in path" % f)
360
 
        elif (f == '.') or (f == ''):
361
 
            pass
362
 
        else:
363
 
            rps.append(f)
364
 
    return rps
 
251
    return ps
365
252
 
366
253
def joinpath(p):
367
254
    assert isinstance(p, list)
368
255
    for f in p:
369
 
        if (f == '..') or (f == None) or (f == ''):
 
256
        if (f == '..') or (f is None) or (f == ''):
370
257
            bailout("sorry, %r not allowed in path" % f)
371
 
    return os.path.join(*p)
 
258
    return '/'.join(p)
372
259
 
373
260
 
374
261
def appendpath(p1, p2):
375
262
    if p1 == '':
376
263
        return p2
377
264
    else:
378
 
        return os.path.join(p1, p2)
 
265
        return p1 + '/' + p2
379
266
    
380
267
 
381
268
def extern_command(cmd, ignore_errors = False):