← 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-11 23:23:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050311232353-f5e33da490872c6a
Add .bzrignore file

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
 
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"""
87
 
    try:
88
 
        return file('/proc/sys/kernel/random/uuid').readline().rstrip('\n')
89
 
    except IOError:
90
 
        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
91
97
 
92
98
 
93
99
def sha_file(f):
94
100
    import sha
 
101
    ## TODO: Maybe read in chunks to handle big files
95
102
    if hasattr(f, 'tell'):
96
103
        assert f.tell() == 0
97
104
    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)
 
105
    s.update(f.read())
104
106
    return s.hexdigest()
105
107
 
106
108
 
112
114
 
113
115
 
114
116
 
115
 
def fingerprint_file(f):
116
 
    import sha
117
 
    s = sha.new()
118
 
    b = f.read()
119
 
    s.update(b)
120
 
    size = len(b)
121
 
    return {'size': size,
122
 
            'sha1': s.hexdigest()}
123
 
 
124
 
 
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
 
    """
 
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
 
146
132
    import socket
147
 
 
148
 
    # XXX: Any good way to get real user name on win32?
149
 
 
 
133
    
150
134
    try:
151
135
        import pwd
152
136
        uid = os.getuid()
153
137
        w = pwd.getpwuid(uid)
154
 
        gecos = w.pw_gecos.decode(bzrlib.user_encoding)
155
 
        username = w.pw_name.decode(bzrlib.user_encoding)
156
 
        comma = gecos.find(',')
157
 
        if comma == -1:
158
 
            realname = gecos
159
 
        else:
160
 
            realname = gecos[:comma]
161
 
        if not realname:
162
 
            realname = username
163
 
 
 
138
        realname, junk = w.pw_gecos.split(',', 1)
 
139
        return '%s <%s@%s>' % (realname, w.pw_name, socket.getfqdn())
164
140
    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+.-]+')
 
141
        pass
 
142
 
 
143
    import getpass, socket
 
144
    return '<%s@%s>' % (getpass.getuser(), socket.getfqdn())
 
145
 
 
146
 
215
147
def user_email():
216
148
    """Return just the email component of a username."""
217
 
    e = _get_user_id()
 
149
    e = os.environ.get('BZREMAIL') or os.environ.get('EMAIL')
218
150
    if e:
219
 
        m = _EMAIL_RE.search(e)
 
151
        import re
 
152
        m = re.search(r'[\w+.-]+@[\w+.-]+', e)
220
153
        if not m:
221
 
            bailout("%r doesn't seem to contain a reasonable email address" % e)
 
154
            bailout('%r is not a reasonable email address' % e)
222
155
        return m.group(0)
223
156
 
224
 
    return _auto_user_id()[1]
 
157
 
 
158
    import getpass, socket
 
159
    return '%s@%s' % (getpass.getuser(), socket.getfqdn())
 
160
 
225
161
    
226
162
 
227
163
 
228
164
def compare_files(a, b):
229
165
    """Returns true if equal in contents"""
230
 
    BUFSIZE = 4096
231
 
    while True:
232
 
        ai = a.read(BUFSIZE)
233
 
        bi = b.read(BUFSIZE)
234
 
        if ai != bi:
235
 
            return False
236
 
        if ai == '':
237
 
            return True
238
 
 
239
 
 
240
 
 
241
 
def local_time_offset(t=None):
242
 
    """Return offset of local zone from GMT, either at present or at time t."""
243
 
    # python2.3 localtime() can't take None
244
 
    if t == None:
245
 
        t = time.time()
246
 
        
247
 
    if time.localtime(t).tm_isdst and time.daylight:
 
166
    # TODO: don't read the whole thing in one go.
 
167
    result = a.read() == b.read()
 
168
    return result
 
169
 
 
170
 
 
171
 
 
172
def local_time_offset():
 
173
    if time.daylight:
248
174
        return -time.altzone
249
175
    else:
250
176
        return -time.timezone
253
179
def format_date(t, offset=0, timezone='original'):
254
180
    ## TODO: Perhaps a global option to use either universal or local time?
255
181
    ## Or perhaps just let people set $TZ?
 
182
    import time
 
183
    
256
184
    assert isinstance(t, float)
257
185
    
258
186
    if timezone == 'utc':
264
192
        tt = time.gmtime(t + offset)
265
193
    elif timezone == 'local':
266
194
        tt = time.localtime(t)
267
 
        offset = local_time_offset(t)
 
195
        offset = local_time_offset()
268
196
    else:
269
197
        bailout("unsupported timezone format %r",
270
198
                ['options are "utc", "original", "local"'])
311
239
    BzrError: ("sorry, '..' not allowed in path", [])
312
240
    """
313
241
    assert isinstance(p, types.StringTypes)
314
 
 
315
 
    # split on either delimiter because people might use either on
316
 
    # Windows
317
 
    ps = re.split(r'[\\/]', p)
318
 
 
319
 
    rps = []
 
242
    ps = [f for f in p.split('/') if f != '.']
320
243
    for f in ps:
321
244
        if f == '..':
322
245
            bailout("sorry, %r not allowed in path" % f)
323
 
        elif (f == '.') or (f == ''):
324
 
            pass
325
 
        else:
326
 
            rps.append(f)
327
 
    return rps
 
246
    return ps
328
247
 
329
248
def joinpath(p):
330
249
    assert isinstance(p, list)
331
250
    for f in p:
332
 
        if (f == '..') or (f == None) or (f == ''):
 
251
        if (f == '..') or (f is None) or (f == ''):
333
252
            bailout("sorry, %r not allowed in path" % f)
334
 
    return os.path.join(*p)
 
253
    return '/'.join(p)
335
254
 
336
255
 
337
256
def appendpath(p1, p2):
338
257
    if p1 == '':
339
258
        return p2
340
259
    else:
341
 
        return os.path.join(p1, p2)
 
260
        return p1 + '/' + p2
342
261
    
343
262
 
344
263
def extern_command(cmd, ignore_errors = False):