← 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-04-05 09:05:32 UTC
  • Revision ID: mbp@sourcefrog.net-20050405090532-af541f6893fd6b75
- clearer check against attempts to introduce directory loops in   the inventory

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/osutils.py
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)) 
 
57
        bailout("can't handle file kind with mode %o of %r" % (mode, f)) 
60
58
 
61
59
 
62
60
 
84
82
 
85
83
def uuid():
86
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.
87
89
    try:
88
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
 
90
        return chomp(file('/proc/sys/kernel/random/uuid').readline())
89
91
    except IOError:
90
92
        return chomp(os.popen('uuidgen').readline())
91
93
 
92
94
 
 
95
def chomp(s):
 
96
    if s and (s[-1] == '\n'):
 
97
        return s[:-1]
 
98
    else:
 
99
        return s
 
100
 
 
101
 
93
102
def sha_file(f):
94
103
    import sha
 
104
    ## TODO: Maybe read in chunks to handle big files
95
105
    if hasattr(f, 'tell'):
96
106
        assert f.tell() == 0
97
107
    s = sha.new()
98
 
    BUFSIZE = 128<<10
99
 
    while True:
100
 
        b = f.read(BUFSIZE)
101
 
        if not b:
102
 
            break
103
 
        s.update(b)
 
108
    s.update(f.read())
104
109
    return s.hexdigest()
105
110
 
106
111
 
122
127
            'sha1': s.hexdigest()}
123
128
 
124
129
 
125
 
def config_dir():
126
 
    """Return per-user configuration directory.
127
 
 
128
 
    By default this is ~/.bzr.conf/
129
 
    
130
 
    TODO: Global option --config-dir to override this.
131
 
    """
132
 
    return os.path.expanduser("~/.bzr.conf")
133
 
 
134
 
 
135
 
def _auto_user_id():
136
 
    """Calculate automatic user identification.
137
 
 
138
 
    Returns (realname, email).
139
 
 
140
 
    Only used when none is set in the environment or the id file.
141
 
 
142
 
    This previously used the FQDN as the default domain, but that can
143
 
    be very slow on machines where DNS is broken.  So now we simply
144
 
    use the hostname.
145
 
    """
 
130
 
 
131
def username():
 
132
    """Return email-style username.
 
133
 
 
134
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
 
135
 
 
136
    :todo: Check it's reasonably well-formed.
 
137
 
 
138
    :todo: Allow taking it from a dotfile to help people on windows
 
139
           who can't easily set variables.
 
140
 
 
141
    :todo: Cope without pwd module, which is only on unix. 
 
142
    """
 
143
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
 
144
    if e: return e
 
145
 
146
146
    import socket
147
 
 
148
 
    # XXX: Any good way to get real user name on win32?
149
 
 
 
147
    
150
148
    try:
151
149
        import pwd
152
150
        uid = os.getuid()
153
151
        w = pwd.getpwuid(uid)
154
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
155
 
        username = w.pw_name.decode(bzrlib.user_encoding)
 
152
        gecos = w.pw_gecos
156
153
        comma = gecos.find(',')
157
154
        if comma == -1:
158
155
            realname = gecos
159
156
        else:
160
157
            realname = gecos[:comma]
161
 
        if not realname:
162
 
            realname = username
163
 
 
 
158
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
164
159
    except ImportError:
165
 
        import getpass
166
 
        realname = username = getpass.getuser().decode(bzrlib.user_encoding)
167
 
 
168
 
    return realname, (username + '@' + socket.gethostname())
169
 
 
170
 
 
171
 
def _get_user_id():
172
 
    """Return the full user id from a file or environment variable.
173
 
 
174
 
    TODO: Allow taking this from a file in the branch directory too
175
 
    for per-branch ids."""
176
 
    v = os.environ.get('BZREMAIL')
177
 
    if v:
178
 
        return v.decode(bzrlib.user_encoding)
179
 
    
180
 
    try:
181
 
        return (open(os.path.join(config_dir(), "email"))
182
 
                .read()
183
 
                .decode(bzrlib.user_encoding)
184
 
                .rstrip("\r\n"))
185
 
    except IOError, e:
186
 
        if e.errno != errno.ENOENT:
187
 
            raise e
188
 
 
189
 
    v = os.environ.get('EMAIL')
190
 
    if v:
191
 
        return v.decode(bzrlib.user_encoding)
192
 
    else:    
193
 
        return None
194
 
 
195
 
 
196
 
def username():
197
 
    """Return email-style username.
198
 
 
199
 
    Something similar to 'Martin Pool <mbp@sourcefrog.net>'
200
 
 
201
 
    TODO: Check it's reasonably well-formed.
202
 
    """
203
 
    v = _get_user_id()
204
 
    if v:
205
 
        return v
206
 
    
207
 
    name, email = _auto_user_id()
208
 
    if name:
209
 
        return '%s <%s>' % (name, email)
210
 
    else:
211
 
        return email
212
 
 
213
 
 
214
 
_EMAIL_RE = re.compile(r'[\w+.-]+@[\w+.-]+')
 
160
        pass
 
161
 
 
162
    import getpass, socket
 
163
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
164
 
 
165
 
215
166
def user_email():
216
167
    """Return just the email component of a username."""
217
 
    e = _get_user_id()
 
168
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
218
169
    if e:
219
 
        m = _EMAIL_RE.search(e)
 
170
        import re
 
171
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
220
172
        if not m:
221
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
173
            bailout('%r is not a reasonable email address' % e)
222
174
        return m.group(0)
223
175
 
224
 
    return _auto_user_id()[1]
 
176
 
 
177
    import getpass, socket
 
178
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
179
 
225
180
    
226
181
 
227
182
 
228
183
def compare_files(a, b):
229
184
    """Returns true if equal in contents"""
 
185
    # TODO: don't read the whole thing in one go.
230
186
    BUFSIZE = 4096
231
187
    while True:
232
188
        ai = a.read(BUFSIZE)
241
197
def local_time_offset(t=None):
242
198
    """Return offset of local zone from GMT, either at present or at time t."""
243
199
    # python2.3 localtime() can't take None
244
 
    if t == None:
 
200
    if t is None:
245
201
        t = time.time()
246
202
        
247
203
    if time.localtime(t).tm_isdst and time.daylight:
253
209
def format_date(t, offset=0, timezone='original'):
254
210
    ## TODO: Perhaps a global option to use either universal or local time?
255
211
    ## Or perhaps just let people set $TZ?
 
212
    import time
 
213
    
256
214
    assert isinstance(t, float)
257
215
    
258
216
    if timezone == 'utc':
285
243
 
286
244
if hasattr(os, 'urandom'): # python 2.4 and later
287
245
    rand_bytes = os.urandom
288
 
elif sys.platform == 'linux2':
289
 
    rand_bytes = file('/dev/urandom', 'rb').read
290
246
else:
291
 
    # not well seeded, but better than nothing
292
 
    def rand_bytes(n):
293
 
        import random
294
 
        s = ''
295
 
        while n:
296
 
            s += chr(random.randint(0, 255))
297
 
            n -= 1
298
 
        return s
 
247
    # FIXME: No good on non-Linux
 
248
    _rand_file = file('/dev/urandom', 'rb')
 
249
    rand_bytes = _rand_file.read
299
250
 
300
251
 
301
252
## TODO: We could later have path objects that remember their list
318
269
    BzrError: ("sorry, '..' not allowed in path", [])
319
270
    """
320
271
    assert isinstance(p, types.StringTypes)
321
 
 
322
 
    # split on either delimiter because people might use either on
323
 
    # Windows
324
 
    ps = re.split(r'[\\/]', p)
325
 
 
326
 
    rps = []
 
272
    ps = [f for f in p.split('/') if f != '.']
327
273
    for f in ps:
328
274
        if f == '..':
329
275
            bailout("sorry, %r not allowed in path" % f)
330
 
        elif (f == '.') or (f == ''):
331
 
            pass
332
 
        else:
333
 
            rps.append(f)
334
 
    return rps
 
276
    return ps
335
277
 
336
278
def joinpath(p):
337
279
    assert isinstance(p, list)
338
280
    for f in p:
339
 
        if (f == '..') or (f == None) or (f == ''):
 
281
        if (f == '..') or (f is None) or (f == ''):
340
282
            bailout("sorry, %r not allowed in path" % f)
341
 
    return os.path.join(*p)
 
283
    return '/'.join(p)
342
284
 
343
285
 
344
286
def appendpath(p1, p2):
345
287
    if p1 == '':
346
288
        return p2
347
289
    else:
348
 
        return os.path.join(p1, p2)
 
290
        return p1 + '/' + p2
349
291
    
350
292
 
351
293
def extern_command(cmd, ignore_errors = False):