/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/generate_ids.py

  • Committer: Robert Collins
  • Date: 2010-05-05 00:05:29 UTC
  • mto: This revision was merged to the branch mainline in revision 5206.
  • Revision ID: robertc@robertcollins.net-20100505000529-ltmllyms5watqj5u
Make 'pydoc bzrlib.tests.build_tree_shape' useful.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/generate_ids.py
1
 
# Copyright (C) 2006, 2007, 2009, 2010, 2011 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
16
16
 
17
17
"""Common code for generating file or revision ids."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
 
from ..lazy_import import lazy_import
 
19
from bzrlib.lazy_import import lazy_import
22
20
lazy_import(globals(), """
23
21
import time
 
22
import unicodedata
24
23
 
25
 
from breezy import (
 
24
from bzrlib import (
26
25
    config,
 
26
    errors,
27
27
    osutils,
28
28
    )
29
29
""")
30
30
 
31
 
from .. import (
 
31
from bzrlib import (
32
32
    lazy_regex,
33
33
    )
34
 
from ..sixish import text_type
35
34
 
36
35
# the regex removes any weird characters; we don't escape them
37
36
# but rather just pull them out
38
 
_file_id_chars_re = lazy_regex.lazy_compile(b'[^\\w.]')
39
 
_rev_id_chars_re = lazy_regex.lazy_compile(b'[^-\\w.+@]')
 
37
_file_id_chars_re = lazy_regex.lazy_compile(r'[^\w.]')
 
38
_rev_id_chars_re = lazy_regex.lazy_compile(r'[^-\w.+@]')
40
39
_gen_file_id_suffix = None
41
40
_gen_file_id_serial = 0
42
41
 
48
47
    give a highly probably globally unique number. Then each call in the same
49
48
    process adds 1 to a serial number we append to that unique value.
50
49
    """
51
 
    # XXX TODO: change breezy.add.smart_add_tree to call workingtree.add() rather
 
50
    # XXX TODO: change bzrlib.add.smart_add_tree to call workingtree.add() rather
52
51
    # than having to move the id randomness out of the inner loop like this.
53
52
    # XXX TODO: for the global randomness this uses we should add the thread-id
54
53
    # before the serial #.
59
58
    #           suffix forever.
60
59
    global _gen_file_id_suffix, _gen_file_id_serial
61
60
    if _gen_file_id_suffix is None:
62
 
        _gen_file_id_suffix = ("-%s-%s-" % (
63
 
            osutils.compact_date(time.time()), osutils.rand_chars(16))
64
 
            ).encode("ascii")
 
61
        _gen_file_id_suffix = "-%s-%s-" % (osutils.compact_date(time.time()),
 
62
                                           osutils.rand_chars(16))
65
63
    _gen_file_id_serial += 1
66
 
    return b"%s%d" % (_gen_file_id_suffix, _gen_file_id_serial)
 
64
    return _gen_file_id_suffix + str(_gen_file_id_serial)
67
65
 
68
66
 
69
67
def gen_file_id(name):
71
69
 
72
70
    The uniqueness is supplied from _next_id_suffix.
73
71
    """
74
 
    if isinstance(name, text_type):
75
 
        name = name.encode('ascii', 'replace')
76
72
    # The real randomness is in the _next_id_suffix, the
77
73
    # rest of the identifier is just to be nice.
78
74
    # So we:
84
80
    #    filesystems
85
81
    # 4) Removing starting '.' characters to prevent the file ids from
86
82
    #    being considered hidden.
87
 
    ascii_word_only = _file_id_chars_re.sub(b'', name.lower())
88
 
    short_no_dots = ascii_word_only.lstrip(b'.')[:20]
 
83
    ascii_word_only = str(_file_id_chars_re.sub('', name.lower()))
 
84
    short_no_dots = ascii_word_only.lstrip('.')[:20]
89
85
    return short_no_dots + _next_id_suffix()
90
86
 
91
87
 
97
93
def gen_revision_id(username, timestamp=None):
98
94
    """Return new revision-id.
99
95
 
100
 
    :param username: The username of the committer, in the format returned by
101
 
        config.username().  This is typically a real name, followed by an
102
 
        email address. If found, we will use just the email address portion.
103
 
        Otherwise we flatten the real name, and use that.
 
96
    :param username: This is the value returned by config.username(), which is
 
97
        typically a real name, followed by an email address. If found, we will
 
98
        use just the email address portion. Otherwise we flatten the real name,
 
99
        and use that.
104
100
    :return: A new revision id.
105
101
    """
106
102
    try:
107
103
        user_or_email = config.extract_email_address(username)
108
 
    except config.NoEmailInUsername:
 
104
    except errors.NoEmailInUsername:
109
105
        user_or_email = username
110
106
 
111
107
    user_or_email = user_or_email.lower()
112
108
    user_or_email = user_or_email.replace(' ', '_')
113
 
    user_or_email = _rev_id_chars_re.sub(b'', user_or_email.encode('utf-8'))
 
109
    user_or_email = _rev_id_chars_re.sub('', user_or_email)
114
110
 
115
111
    # This gives 36^16 ~= 2^82.7 ~= 83 bits of entropy
116
 
    unique_chunk = osutils.rand_chars(16).encode('utf-8')
 
112
    unique_chunk = osutils.rand_chars(16)
117
113
 
118
114
    if timestamp is None:
119
115
        timestamp = time.time()
120
116
 
121
 
    rev_id = b'-'.join((user_or_email,
122
 
                        osutils.compact_date(timestamp).encode('utf-8'),
 
117
    rev_id = u'-'.join((user_or_email,
 
118
                        osutils.compact_date(timestamp),
123
119
                        unique_chunk))
124
 
    return rev_id
 
120
    return rev_id.encode('utf8')