/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
2323.6.2 by Martin Pool
Move responsibility for suggesting upgrades to ui object
1
# Copyright (C) 2005, 2007 Canonical Ltd
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
2
#   Authors: Robert Collins <robert.collins@canonical.com>
2323.6.2 by Martin Pool
Move responsibility for suggesting upgrades to ui object
3
#            and others
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
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
1442.1.20 by Robert Collins
add some documentation on options
19
"""Configuration that affects the behaviour of Bazaar.
20
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
1442.1.20 by Robert Collins
add some documentation on options
23
1461 by Robert Collins
Typo in config.py (Thanks Fabbione)
24
In bazaar.conf the following options may be set:
1442.1.20 by Robert Collins
add some documentation on options
25
[DEFAULT]
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
1442.1.56 by Robert Collins
gpg_signing_command configuration item
30
gpg_signing_command=name-of-program
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
31
log_format=name-of-format
1442.1.20 by Robert Collins
add some documentation on options
32
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
33
in locations.conf, you specify the url of a branch and options for it.
1442.1.20 by Robert Collins
add some documentation on options
34
Wildcards may be used - * and ? as normal in shell completion. Options
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
1442.1.20 by Robert Collins
add some documentation on options
36
setting.
37
[/home/robertc/source]
38
recurse=False|True(default)
39
email= as above
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
40
check_signatures= as above 
1442.1.20 by Robert Collins
add some documentation on options
41
create_signatures= as above.
42
43
explanation of options
44
----------------------
45
editor - this option sets the pop up editor to use during commits.
46
email - this option sets the user id bzr will use when committing.
47
check_signatures - this option controls whether bzr will require good gpg
48
                   signatures, ignore them, or check them if they are 
49
                   present.
50
create_signatures - this option controls whether bzr will always create 
51
                    gpg signatures, never create them, or create them if the
52
                    branch is configured to require them.
1887.2.1 by Adeodato Simó
Fix some typos and grammar issues.
53
log_format - this option sets the default log format.  Possible values are
54
             long, short, line, or a plugin can register new formats.
1553.6.2 by Erik Bågfors
documentation and NEWS
55
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
57
58
[ALIASES]
59
lastlog=log --line -r-10..-1
60
ll=log --line -r-10..-1
61
h=help
62
up=pull
1442.1.20 by Robert Collins
add some documentation on options
63
"""
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
64
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
65
import os
66
import sys
1474 by Robert Collins
Merge from Aaron Bentley.
67
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
1474 by Robert Collins
Merge from Aaron Bentley.
70
import errno
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
71
from fnmatch import fnmatch
72
import re
73
from StringIO import StringIO
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
74
75
import bzrlib
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
76
from bzrlib import (
77
    errors,
2681.1.8 by Aaron Bentley
Add Thunderbird support to bzr send
78
    mail_client,
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
79
    osutils,
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
80
    symbol_versioning,
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
81
    trace,
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
82
    urlutils,
2245.4.3 by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils
83
    win32utils,
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
84
    )
85
import bzrlib.util.configobj.configobj as configobj
86
""")
87
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
88
from bzrlib.trace import mutter, warning
89
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
90
1442.1.14 by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE
91
CHECK_IF_POSSIBLE=0
92
CHECK_ALWAYS=1
93
CHECK_NEVER=2
94
95
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
96
SIGN_WHEN_REQUIRED=0
97
SIGN_ALWAYS=1
98
SIGN_NEVER=2
99
100
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
101
POLICY_NONE = 0
102
POLICY_NORECURSE = 1
103
POLICY_APPENDPATH = 2
104
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
105
_policy_name = {
106
    POLICY_NONE: None,
107
    POLICY_NORECURSE: 'norecurse',
108
    POLICY_APPENDPATH: 'appendpath',
109
    }
110
_policy_value = {
111
    None: POLICY_NONE,
112
    'none': POLICY_NONE,
113
    'norecurse': POLICY_NORECURSE,
114
    'appendpath': POLICY_APPENDPATH,
115
    }
2120.6.4 by James Henstridge
add support for specifying policy when storing options
116
117
118
STORE_LOCATION = POLICY_NONE
119
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
120
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
121
STORE_BRANCH = 3
122
STORE_GLOBAL = 4
123
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
124
1474 by Robert Collins
Merge from Aaron Bentley.
125
class ConfigObj(configobj.ConfigObj):
126
127
    def get_bool(self, section, key):
1556.2.2 by Aaron Bentley
Fixed get_bool
128
        return self[section].as_bool(key)
1474 by Robert Collins
Merge from Aaron Bentley.
129
130
    def get_value(self, section, name):
131
        # Try [] for the old DEFAULT section.
132
        if section == "DEFAULT":
133
            try:
134
                return self[name]
135
            except KeyError:
136
                pass
137
        return self[section][name]
138
139
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
140
class Config(object):
141
    """A configuration policy - what username, editor, gpg needs etc."""
142
143
    def get_editor(self):
144
        """Get the users pop up editor."""
145
        raise NotImplementedError
146
2681.1.8 by Aaron Bentley
Add Thunderbird support to bzr send
147
    def get_mail_client(self):
148
        """Get a mail client to use"""
149
        selected_client = self.get_user_option('mail_client')
2681.1.10 by Aaron Bentley
Clean up handling of unknown mail clients
150
        try:
151
            mail_client_class = {
152
                None : mail_client.Editor,
153
                'editor': mail_client.Editor,
154
                'thunderbird': mail_client.Thunderbird,
2681.2.1 by Lukáš Lalinsky
Support for Evolution mail client.
155
                'evolution': mail_client.Evolution,
2681.1.10 by Aaron Bentley
Clean up handling of unknown mail clients
156
            }[selected_client]
157
        except KeyError:
158
            raise errors.UnknownMailClient(selected_client)
159
        return mail_client_class(self)
2681.1.8 by Aaron Bentley
Add Thunderbird support to bzr send
160
1442.1.15 by Robert Collins
make getting the signature checking policy a template method
161
    def _get_signature_checking(self):
162
        """Template method to override signature checking policy."""
163
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
164
    def _get_signing_policy(self):
165
        """Template method to override signature creation policy."""
166
1993.3.6 by James Henstridge
get rid of the recurse argument to get_user_option()
167
    def _get_user_option(self, option_name):
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
168
        """Template method to provide a user option."""
169
        return None
170
1993.3.6 by James Henstridge
get rid of the recurse argument to get_user_option()
171
    def get_user_option(self, option_name):
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
172
        """Get a generic option - no special process, no default."""
1993.3.6 by James Henstridge
get rid of the recurse argument to get_user_option()
173
        return self._get_user_option(option_name)
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
174
1442.1.56 by Robert Collins
gpg_signing_command configuration item
175
    def gpg_signing_command(self):
176
        """What program should be used to sign signatures?"""
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
177
        result = self._gpg_signing_command()
178
        if result is None:
179
            result = "gpg"
180
        return result
181
182
    def _gpg_signing_command(self):
183
        """See gpg_signing_command()."""
184
        return None
1442.1.56 by Robert Collins
gpg_signing_command configuration item
185
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
186
    def log_format(self):
187
        """What log format should be used"""
188
        result = self._log_format()
1553.2.4 by Erik Bågfors
Support for setting the default log format at a configuration option
189
        if result is None:
190
            result = "long"
191
        return result
192
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
193
    def _log_format(self):
194
        """See log_format()."""
1553.2.4 by Erik Bågfors
Support for setting the default log format at a configuration option
195
        return None
196
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
197
    def __init__(self):
198
        super(Config, self).__init__()
199
1472 by Robert Collins
post commit hook, first pass implementation
200
    def post_commit(self):
201
        """An ordered list of python functions to call.
202
203
        Each function takes branch, rev_id as parameters.
204
        """
205
        return self._post_commit()
206
207
    def _post_commit(self):
208
        """See Config.post_commit."""
209
        return None
210
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
211
    def user_email(self):
212
        """Return just the email component of a username."""
1185.33.31 by Martin Pool
Make annotate cope better with revisions committed without a valid
213
        return extract_email_address(self.username())
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
214
215
    def username(self):
216
        """Return email-style username.
217
    
218
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
219
        
1861.4.1 by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL.
220
        $BZR_EMAIL can be set to override this (as well as the
221
        deprecated $BZREMAIL), then
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
222
        the concrete policy type is checked, and finally
1185.37.2 by Jamie Wilkinson
Fix a typo and grammar in Config.username() docstring.
223
        $EMAIL is examined.
224
        If none is found, a reasonable default is (hopefully)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
225
        created.
226
    
227
        TODO: Check it's reasonably well-formed.
228
        """
1861.4.1 by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL.
229
        v = os.environ.get('BZR_EMAIL')
230
        if v:
231
            return v.decode(bzrlib.user_encoding)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
232
        v = os.environ.get('BZREMAIL')
233
        if v:
1861.4.1 by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL.
234
            warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
235
            return v.decode(bzrlib.user_encoding)
236
    
237
        v = self._get_user_id()
238
        if v:
239
            return v
240
        
241
        v = os.environ.get('EMAIL')
242
        if v:
243
            return v.decode(bzrlib.user_encoding)
244
245
        name, email = _auto_user_id()
246
        if name:
247
            return '%s <%s>' % (name, email)
248
        else:
249
            return email
250
1442.1.14 by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE
251
    def signature_checking(self):
252
        """What is the current policy for signature checking?."""
1442.1.15 by Robert Collins
make getting the signature checking policy a template method
253
        policy = self._get_signature_checking()
254
        if policy is not None:
255
            return policy
1442.1.14 by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE
256
        return CHECK_IF_POSSIBLE
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
257
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
258
    def signing_policy(self):
259
        """What is the current policy for signature checking?."""
260
        policy = self._get_signing_policy()
261
        if policy is not None:
262
            return policy
263
        return SIGN_WHEN_REQUIRED
264
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
265
    def signature_needed(self):
266
        """Is a signature needed when committing ?."""
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
267
        policy = self._get_signing_policy()
268
        if policy is None:
269
            policy = self._get_signature_checking()
270
            if policy is not None:
271
                warning("Please use create_signatures, not check_signatures "
272
                        "to set signing policy.")
273
            if policy == CHECK_ALWAYS:
274
                return True
275
        elif policy == SIGN_ALWAYS:
1442.1.21 by Robert Collins
create signature_needed() call for commit to trigger creating signatures
276
            return True
277
        return False
278
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
279
    def get_alias(self, value):
280
        return self._get_alias(value)
281
282
    def _get_alias(self, value):
283
        pass
284
1770.2.7 by Aaron Bentley
Set/get nickname using BranchConfig
285
    def get_nickname(self):
286
        return self._get_nickname()
287
288
    def _get_nickname(self):
289
        return None
290
1442.1.15 by Robert Collins
make getting the signature checking policy a template method
291
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
292
class IniBasedConfig(Config):
293
    """A configuration policy that draws from ini files."""
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
294
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
295
    def _get_parser(self, file=None):
1185.12.51 by Aaron Bentley
Allowed second call of _get_parser() to not require a file
296
        if self._parser is not None:
297
            return self._parser
1185.12.49 by Aaron Bentley
Switched to ConfigObj
298
        if file is None:
299
            input = self._get_filename()
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
300
        else:
1185.12.49 by Aaron Bentley
Switched to ConfigObj
301
            input = file
1185.12.51 by Aaron Bentley
Allowed second call of _get_parser() to not require a file
302
        try:
1551.2.20 by Aaron Bentley
Treated config files as utf-8
303
            self._parser = ConfigObj(input, encoding='utf-8')
1474 by Robert Collins
Merge from Aaron Bentley.
304
        except configobj.ConfigObjError, e:
1185.12.51 by Aaron Bentley
Allowed second call of _get_parser() to not require a file
305
            raise errors.ParseConfigError(e.errors, e.config.filename)
1185.12.49 by Aaron Bentley
Switched to ConfigObj
306
        return self._parser
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
307
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
308
    def _get_matching_sections(self):
309
        """Return an ordered list of (section_name, extra_path) pairs.
310
311
        If the section contains inherited configuration, extra_path is
312
        a string containing the additional path components.
313
        """
314
        section = self._get_section()
315
        if section is not None:
316
            return [(section, '')]
317
        else:
318
            return []
319
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
320
    def _get_section(self):
321
        """Override this to define the section used by the config."""
322
        return "DEFAULT"
323
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
324
    def _get_option_policy(self, section, option_name):
325
        """Return the policy for the given (section, option_name) pair."""
326
        return POLICY_NONE
327
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
328
    def _get_signature_checking(self):
329
        """See Config._get_signature_checking."""
1474 by Robert Collins
Merge from Aaron Bentley.
330
        policy = self._get_user_option('check_signatures')
331
        if policy:
332
            return self._string_to_signature_policy(policy)
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
333
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
334
    def _get_signing_policy(self):
1773.4.3 by Martin Pool
[merge] bzr.dev
335
        """See Config._get_signing_policy"""
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
336
        policy = self._get_user_option('create_signatures')
337
        if policy:
338
            return self._string_to_signing_policy(policy)
339
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
340
    def _get_user_id(self):
341
        """Get the user id from the 'email' key in the current section."""
1474 by Robert Collins
Merge from Aaron Bentley.
342
        return self._get_user_option('email')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
343
1993.3.6 by James Henstridge
get rid of the recurse argument to get_user_option()
344
    def _get_user_option(self, option_name):
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
345
        """See Config._get_user_option."""
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
346
        for (section, extra_path) in self._get_matching_sections():
347
            try:
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
348
                value = self._get_parser().get_value(section, option_name)
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
349
            except KeyError:
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
350
                continue
351
            policy = self._get_option_policy(section, option_name)
352
            if policy == POLICY_NONE:
353
                return value
354
            elif policy == POLICY_NORECURSE:
355
                # norecurse items only apply to the exact path
356
                if extra_path:
357
                    continue
358
                else:
359
                    return value
360
            elif policy == POLICY_APPENDPATH:
2120.6.3 by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies
361
                if extra_path:
362
                    value = urlutils.join(value, extra_path)
363
                return value
2120.6.6 by James Henstridge
fix test_set_push_location test
364
            else:
365
                raise AssertionError('Unexpected config policy %r' % policy)
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
366
        else:
1993.3.1 by James Henstridge
first go at making location config lookup recursive
367
            return None
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
368
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
369
    def _gpg_signing_command(self):
1442.1.56 by Robert Collins
gpg_signing_command configuration item
370
        """See Config.gpg_signing_command."""
1472 by Robert Collins
post commit hook, first pass implementation
371
        return self._get_user_option('gpg_signing_command')
1442.1.56 by Robert Collins
gpg_signing_command configuration item
372
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
373
    def _log_format(self):
374
        """See Config.log_format."""
375
        return self._get_user_option('log_format')
1553.2.4 by Erik Bågfors
Support for setting the default log format at a configuration option
376
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
377
    def __init__(self, get_filename):
378
        super(IniBasedConfig, self).__init__()
379
        self._get_filename = get_filename
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
380
        self._parser = None
1472 by Robert Collins
post commit hook, first pass implementation
381
        
382
    def _post_commit(self):
383
        """See Config.post_commit."""
384
        return self._get_user_option('post_commit')
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
385
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
386
    def _string_to_signature_policy(self, signature_string):
387
        """Convert a string to a signing policy."""
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
388
        if signature_string.lower() == 'check-available':
389
            return CHECK_IF_POSSIBLE
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
390
        if signature_string.lower() == 'ignore':
391
            return CHECK_NEVER
1442.1.17 by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking
392
        if signature_string.lower() == 'require':
393
            return CHECK_ALWAYS
1442.1.16 by Robert Collins
allow global overriding of signature policy to never check
394
        raise errors.BzrError("Invalid signatures policy '%s'"
395
                              % signature_string)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
396
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
397
    def _string_to_signing_policy(self, signature_string):
398
        """Convert a string to a signing policy."""
399
        if signature_string.lower() == 'when-required':
400
            return SIGN_WHEN_REQUIRED
401
        if signature_string.lower() == 'never':
402
            return SIGN_NEVER
403
        if signature_string.lower() == 'always':
404
            return SIGN_ALWAYS
405
        raise errors.BzrError("Invalid signing policy '%s'"
406
                              % signature_string)
407
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
408
    def _get_alias(self, value):
409
        try:
410
            return self._get_parser().get_value("ALIASES", 
411
                                                value)
412
        except KeyError:
413
            pass
414
1770.2.7 by Aaron Bentley
Set/get nickname using BranchConfig
415
    def _get_nickname(self):
416
        return self.get_user_option('nickname')
417
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
418
419
class GlobalConfig(IniBasedConfig):
420
    """The configuration that should be used for a specific location."""
421
422
    def get_editor(self):
1474 by Robert Collins
Merge from Aaron Bentley.
423
        return self._get_user_option('editor')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
424
425
    def __init__(self):
426
        super(GlobalConfig, self).__init__(config_filename)
427
1816.2.1 by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings
428
    def set_user_option(self, option, value):
429
        """Save option and its value in the configuration."""
430
        # FIXME: RBC 20051029 This should refresh the parser and also take a
431
        # file lock on bazaar.conf.
432
        conf_dir = os.path.dirname(self._get_filename())
433
        ensure_config_dir_exists(conf_dir)
434
        if 'DEFAULT' not in self._get_parser():
435
            self._get_parser()['DEFAULT'] = {}
436
        self._get_parser()['DEFAULT'][option] = value
437
        f = open(self._get_filename(), 'wb')
438
        self._get_parser().write(f)
439
        f.close()
440
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
441
442
class LocationConfig(IniBasedConfig):
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
443
    """A configuration object that gives the policy for a location."""
444
445
    def __init__(self, location):
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
446
        name_generator = locations_config_filename
447
        if (not os.path.exists(name_generator()) and 
448
                os.path.exists(branches_config_filename())):
1830.2.1 by John Arbash Meinel
Make it clearer what config file needs to be renamed.
449
            if sys.platform == 'win32':
450
                warning('Please rename %s to %s' 
451
                         % (branches_config_filename(),
452
                            locations_config_filename()))
453
            else:
454
                warning('Please rename ~/.bazaar/branches.conf'
455
                        ' to ~/.bazaar/locations.conf')
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
456
            name_generator = branches_config_filename
457
        super(LocationConfig, self).__init__(name_generator)
1878.1.1 by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653)
458
        # local file locations are looked up by local path, rather than
459
        # by file url. This is because the config file is a user
460
        # file, and we would rather not expose the user to file urls.
461
        if location.startswith('file://'):
462
            location = urlutils.local_path_from_url(location)
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
463
        self.location = location
464
1993.3.1 by James Henstridge
first go at making location config lookup recursive
465
    def _get_matching_sections(self):
466
        """Return an ordered list of section names matching this location."""
1185.12.49 by Aaron Bentley
Switched to ConfigObj
467
        sections = self._get_parser()
1442.1.12 by Robert Collins
LocationConfig section retrieval falls into my lap
468
        location_names = self.location.split('/')
1442.1.18 by Robert Collins
permit per branch location overriding of signature checking policy
469
        if self.location.endswith('/'):
470
            del location_names[-1]
1442.1.12 by Robert Collins
LocationConfig section retrieval falls into my lap
471
        matches=[]
1442.1.10 by Robert Collins
explicit over glob test passes
472
        for section in sections:
1878.1.1 by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653)
473
            # location is a local path if possible, so we need
474
            # to convert 'file://' urls to local paths if necessary.
475
            # This also avoids having file:///path be a more exact
476
            # match than '/path'.
477
            if section.startswith('file://'):
478
                section_path = urlutils.local_path_from_url(section)
479
            else:
480
                section_path = section
481
            section_names = section_path.split('/')
1442.1.12 by Robert Collins
LocationConfig section retrieval falls into my lap
482
            if section.endswith('/'):
483
                del section_names[-1]
484
            names = zip(location_names, section_names)
485
            matched = True
486
            for name in names:
487
                if not fnmatch(name[0], name[1]):
488
                    matched = False
489
                    break
490
            if not matched:
491
                continue
492
            # so, for the common prefix they matched.
493
            # if section is longer, no match.
494
            if len(section_names) > len(location_names):
495
                continue
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
496
            matches.append((len(section_names), section,
497
                            '/'.join(location_names[len(section_names):])))
1442.1.12 by Robert Collins
LocationConfig section retrieval falls into my lap
498
        matches.sort(reverse=True)
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
499
        sections = []
500
        for (length, section, extra_path) in matches:
501
            sections.append((section, extra_path))
502
            # should we stop looking for parent configs here?
1993.3.1 by James Henstridge
first go at making location config lookup recursive
503
            try:
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
504
                if self._get_parser()[section].as_bool('ignore_parents'):
505
                    break
1993.3.1 by James Henstridge
first go at making location config lookup recursive
506
            except KeyError:
507
                pass
1993.3.3 by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match
508
        return sections
1442.1.9 by Robert Collins
exact section test passes
509
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
510
    def _get_option_policy(self, section, option_name):
511
        """Return the policy for the given (section, option_name) pair."""
512
        # check for the old 'recurse=False' flag
513
        try:
514
            recurse = self._get_parser()[section].as_bool('recurse')
515
        except KeyError:
516
            recurse = True
517
        if not recurse:
518
            return POLICY_NORECURSE
519
2120.6.10 by James Henstridge
Catch another deprecation warning, and more cleanup
520
        policy_key = option_name + ':policy'
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
521
        try:
522
            policy_name = self._get_parser()[section][policy_key]
523
        except KeyError:
524
            policy_name = None
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
525
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
526
        return _policy_value[policy_name]
2120.6.1 by James Henstridge
add support for norecurse and appendpath policies when reading configuration files
527
2120.6.4 by James Henstridge
add support for specifying policy when storing options
528
    def _set_option_policy(self, section, option_name, option_policy):
529
        """Set the policy for the given option name in the given section."""
530
        # The old recurse=False option affects all options in the
531
        # section.  To handle multiple policies in the section, we
532
        # need to convert it to a policy_norecurse key.
533
        try:
534
            recurse = self._get_parser()[section].as_bool('recurse')
535
        except KeyError:
536
            pass
537
        else:
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
538
            symbol_versioning.warn(
2120.6.11 by James Henstridge
s/0.13/0.14/ in deprecation warning
539
                'The recurse option is deprecated as of 0.14.  '
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
540
                'The section "%s" has been converted to use policies.'
541
                % section,
542
                DeprecationWarning)
2120.6.4 by James Henstridge
add support for specifying policy when storing options
543
            del self._get_parser()[section]['recurse']
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
544
            if not recurse:
545
                for key in self._get_parser()[section].keys():
546
                    if not key.endswith(':policy'):
547
                        self._get_parser()[section][key +
548
                                                    ':policy'] = 'norecurse'
2120.6.4 by James Henstridge
add support for specifying policy when storing options
549
2120.6.9 by James Henstridge
Fixes for issues brought up in John's review
550
        policy_key = option_name + ':policy'
2120.6.8 by James Henstridge
Change syntax for setting config option policies. Rather than
551
        policy_name = _policy_name[option_policy]
552
        if policy_name is not None:
553
            self._get_parser()[section][policy_key] = policy_name
554
        else:
555
            if policy_key in self._get_parser()[section]:
556
                del self._get_parser()[section][policy_key]
2120.6.4 by James Henstridge
add support for specifying policy when storing options
557
558
    def set_user_option(self, option, value, store=STORE_LOCATION):
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
559
        """Save option and its value in the configuration."""
2120.6.4 by James Henstridge
add support for specifying policy when storing options
560
        assert store in [STORE_LOCATION,
561
                         STORE_LOCATION_NORECURSE,
562
                         STORE_LOCATION_APPENDPATH], 'bad storage policy'
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
563
        # FIXME: RBC 20051029 This should refresh the parser and also take a
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
564
        # file lock on locations.conf.
1185.31.39 by John Arbash Meinel
Replacing os.getcwdu() with osutils.getcwd(),
565
        conf_dir = os.path.dirname(self._get_filename())
1185.31.43 by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp
566
        ensure_config_dir_exists(conf_dir)
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
567
        location = self.location
568
        if location.endswith('/'):
569
            location = location[:-1]
570
        if (not location in self._get_parser() and
571
            not location + '/' in self._get_parser()):
572
            self._get_parser()[location]={}
573
        elif location + '/' in self._get_parser():
574
            location = location + '/'
575
        self._get_parser()[location][option]=value
2120.6.4 by James Henstridge
add support for specifying policy when storing options
576
        # the allowed values of store match the config policies
577
        self._set_option_policy(location, option, store)
1551.2.49 by abentley
Made ConfigObj output binary-identical files on win32 and *nix
578
        self._get_parser().write(file(self._get_filename(), 'wb'))
1490 by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1.
579
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
580
581
class BranchConfig(Config):
582
    """A configuration object giving the policy for a branch."""
583
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
584
    def _get_branch_data_config(self):
585
        if self._branch_data_config is None:
586
            self._branch_data_config = TreeConfig(self.branch)
587
        return self._branch_data_config
588
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
589
    def _get_location_config(self):
590
        if self._location_config is None:
591
            self._location_config = LocationConfig(self.branch.base)
592
        return self._location_config
593
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
594
    def _get_global_config(self):
595
        if self._global_config is None:
596
            self._global_config = GlobalConfig()
597
        return self._global_config
598
599
    def _get_best_value(self, option_name):
600
        """This returns a user option from local, tree or global config.
601
602
        They are tried in that order.  Use get_safe_value if trusted values
603
        are necessary.
604
        """
605
        for source in self.option_sources:
606
            value = getattr(source(), option_name)()
607
            if value is not None:
608
                return value
609
        return None
610
611
    def _get_safe_value(self, option_name):
612
        """This variant of get_best_value never returns untrusted values.
613
        
614
        It does not return values from the branch data, because the branch may
615
        not be controlled by the user.
616
617
        We may wish to allow locations.conf to control whether branches are
618
        trusted in the future.
619
        """
620
        for source in (self._get_location_config, self._get_global_config):
621
            value = getattr(source(), option_name)()
622
            if value is not None:
623
                return value
624
        return None
625
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
626
    def _get_user_id(self):
627
        """Return the full user id for the branch.
628
    
629
        e.g. "John Hacker <jhacker@foo.org>"
630
        This is looked up in the email controlfile for the branch.
631
        """
632
        try:
1185.65.29 by Robert Collins
Implement final review suggestions.
633
            return (self.branch.control_files.get_utf8("email") 
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
634
                    .read()
635
                    .decode(bzrlib.user_encoding)
636
                    .rstrip("\r\n"))
637
        except errors.NoSuchFile, e:
638
            pass
639
        
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
640
        return self._get_best_value('_get_user_id')
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
641
1442.1.19 by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig.
642
    def _get_signature_checking(self):
643
        """See Config._get_signature_checking."""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
644
        return self._get_best_value('_get_signature_checking')
1442.1.19 by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig.
645
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
646
    def _get_signing_policy(self):
647
        """See Config._get_signing_policy."""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
648
        return self._get_best_value('_get_signing_policy')
1770.2.1 by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this
649
1993.3.6 by James Henstridge
get rid of the recurse argument to get_user_option()
650
    def _get_user_option(self, option_name):
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
651
        """See Config._get_user_option."""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
652
        for source in self.option_sources:
1993.3.6 by James Henstridge
get rid of the recurse argument to get_user_option()
653
            value = source()._get_user_option(option_name)
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
654
            if value is not None:
655
                return value
656
        return None
657
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
658
    def set_user_option(self, name, value, store=STORE_BRANCH,
659
        warn_masked=False):
2120.6.4 by James Henstridge
add support for specifying policy when storing options
660
        if store == STORE_BRANCH:
1770.2.6 by Aaron Bentley
Ensure branch.conf works properly
661
            self._get_branch_data_config().set_option(value, name)
2120.6.4 by James Henstridge
add support for specifying policy when storing options
662
        elif store == STORE_GLOBAL:
2120.6.7 by James Henstridge
Fix GlobalConfig.set_user_option() call
663
            self._get_global_config().set_user_option(name, value)
2120.6.4 by James Henstridge
add support for specifying policy when storing options
664
        else:
665
            self._get_location_config().set_user_option(name, value, store)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
666
        if not warn_masked:
667
            return
668
        if store in (STORE_GLOBAL, STORE_BRANCH):
669
            mask_value = self._get_location_config().get_user_option(name)
670
            if mask_value is not None:
671
                trace.warning('Value "%s" is masked by "%s" from'
672
                              ' locations.conf', value, mask_value)
673
            else:
674
                if store == STORE_GLOBAL:
675
                    branch_config = self._get_branch_data_config()
676
                    mask_value = branch_config.get_user_option(name)
677
                    if mask_value is not None:
678
                        trace.warning('Value "%s" is masked by "%s" from'
1551.15.37 by Aaron Bentley
Don't treat a format string as a normal string
679
                                      ' branch.conf', value, mask_value)
1551.15.35 by Aaron Bentley
Warn when setting config values that will be masked (#122286)
680
1442.1.69 by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name.
681
1442.1.59 by Robert Collins
Add re-sign command to generate a digital signature on a single revision.
682
    def _gpg_signing_command(self):
1442.1.56 by Robert Collins
gpg_signing_command configuration item
683
        """See Config.gpg_signing_command."""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
684
        return self._get_safe_value('_gpg_signing_command')
1442.1.56 by Robert Collins
gpg_signing_command configuration item
685
        
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
686
    def __init__(self, branch):
687
        super(BranchConfig, self).__init__()
688
        self._location_config = None
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
689
        self._branch_data_config = None
690
        self._global_config = None
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
691
        self.branch = branch
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
692
        self.option_sources = (self._get_location_config, 
693
                               self._get_branch_data_config,
694
                               self._get_global_config)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
695
1472 by Robert Collins
post commit hook, first pass implementation
696
    def _post_commit(self):
697
        """See Config.post_commit."""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
698
        return self._get_safe_value('_post_commit')
1472 by Robert Collins
post commit hook, first pass implementation
699
1770.2.7 by Aaron Bentley
Set/get nickname using BranchConfig
700
    def _get_nickname(self):
1824.1.1 by Robert Collins
Add BranchConfig.has_explicit_nickname call.
701
        value = self._get_explicit_nickname()
1770.2.7 by Aaron Bentley
Set/get nickname using BranchConfig
702
        if value is not None:
703
            return value
2120.5.2 by Alexander Belchenko
(jam) Fix for bug #66857
704
        return urlutils.unescape(self.branch.base.split('/')[-2])
1770.2.7 by Aaron Bentley
Set/get nickname using BranchConfig
705
1824.1.1 by Robert Collins
Add BranchConfig.has_explicit_nickname call.
706
    def has_explicit_nickname(self):
707
        """Return true if a nickname has been explicitly assigned."""
708
        return self._get_explicit_nickname() is not None
709
710
    def _get_explicit_nickname(self):
711
        return self._get_best_value('_get_nickname')
712
1553.2.9 by Erik Bågfors
log_formatter => log_format for "named" formatters
713
    def _log_format(self):
714
        """See Config.log_format."""
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
715
        return self._get_best_value('_log_format')
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
716
1553.6.12 by Erik Bågfors
remove AliasConfig, based on input from abentley
717
1185.31.43 by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp
718
def ensure_config_dir_exists(path=None):
719
    """Make sure a configuration directory exists.
720
    This makes sure that the directory exists.
721
    On windows, since configuration directories are 2 levels deep,
722
    it makes sure both the directory and the parent directory exists.
723
    """
724
    if path is None:
725
        path = config_dir()
726
    if not os.path.isdir(path):
727
        if sys.platform == 'win32':
728
            parent_dir = os.path.dirname(path)
729
            if not os.path.isdir(parent_dir):
730
                mutter('creating config parent directory: %r', parent_dir)
731
            os.mkdir(parent_dir)
732
        mutter('creating config directory: %r', path)
733
        os.mkdir(path)
734
1532 by Robert Collins
Merge in John Meinels integration branch.
735
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
736
def config_dir():
737
    """Return per-user configuration directory.
738
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
739
    By default this is ~/.bazaar/
1442.1.1 by Robert Collins
move config_dir into bzrlib.config
740
    
741
    TODO: Global option --config-dir to override this.
742
    """
1185.38.1 by John Arbash Meinel
Adding my win32 patch for moving the home directory.
743
    base = os.environ.get('BZR_HOME', None)
744
    if sys.platform == 'win32':
745
        if base is None:
2245.4.3 by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils
746
            base = win32utils.get_appdata_location_unicode()
1185.38.1 by John Arbash Meinel
Adding my win32 patch for moving the home directory.
747
        if base is None:
748
            base = os.environ.get('HOME', None)
749
        if base is None:
1773.4.1 by Martin Pool
Add pyflakes makefile target; fix many warnings
750
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
751
        return osutils.pathjoin(base, 'bazaar', '2.0')
1185.38.1 by John Arbash Meinel
Adding my win32 patch for moving the home directory.
752
    else:
753
        # cygwin, linux, and darwin all have a $HOME directory
754
        if base is None:
755
            base = os.path.expanduser("~")
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
756
        return osutils.pathjoin(base, ".bazaar")
1185.31.32 by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \
757
758
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
759
def config_filename():
760
    """Return per-user configuration ini file filename."""
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
761
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
762
763
1442.1.6 by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs
764
def branches_config_filename():
765
    """Return per-user configuration ini file filename."""
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
766
    return osutils.pathjoin(config_dir(), 'branches.conf')
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
767
1830.2.1 by John Arbash Meinel
Make it clearer what config file needs to be renamed.
768
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
769
def locations_config_filename():
770
    """Return per-user configuration ini file filename."""
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
771
    return osutils.pathjoin(config_dir(), 'locations.conf')
1770.2.2 by Aaron Bentley
Rename branches.conf to locations.conf
772
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
773
1836.1.6 by John Arbash Meinel
Creating a helper function for getting the user ignore filename
774
def user_ignore_config_filename():
775
    """Return the user default ignore filename"""
1996.3.31 by John Arbash Meinel
Make bzrlib.config use lazy importing
776
    return osutils.pathjoin(config_dir(), 'ignore')
1836.1.6 by John Arbash Meinel
Creating a helper function for getting the user ignore filename
777
778
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
779
def _auto_user_id():
780
    """Calculate automatic user identification.
781
782
    Returns (realname, email).
783
784
    Only used when none is set in the environment or the id file.
785
786
    This previously used the FQDN as the default domain, but that can
787
    be very slow on machines where DNS is broken.  So now we simply
788
    use the hostname.
789
    """
790
    import socket
791
2245.4.3 by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils
792
    if sys.platform == 'win32':
793
        name = win32utils.get_user_name_unicode()
794
        if name is None:
795
            raise errors.BzrError("Cannot autodetect user name.\n"
796
                                  "Please, set your name with command like:\n"
797
                                  'bzr whoami "Your Name <name@domain.com>"')
798
        host = win32utils.get_host_name_unicode()
799
        if host is None:
800
            host = socket.gethostname()
801
        return name, (name + '@' + host)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
802
803
    try:
804
        import pwd
805
        uid = os.getuid()
806
        w = pwd.getpwuid(uid)
1553.4.5 by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in
807
1816.2.1 by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings
808
        # we try utf-8 first, because on many variants (like Linux),
809
        # /etc/passwd "should" be in utf-8, and because it's unlikely to give
810
        # false positives.  (many users will have their user encoding set to
811
        # latin-1, which cannot raise UnicodeError.)
812
        try:
813
            gecos = w.pw_gecos.decode('utf-8')
814
            encoding = 'utf-8'
815
        except UnicodeError:
816
            try:
817
                gecos = w.pw_gecos.decode(bzrlib.user_encoding)
818
                encoding = bzrlib.user_encoding
819
            except UnicodeError:
820
                raise errors.BzrCommandError('Unable to determine your name.  '
821
                   'Use "bzr whoami" to set it.')
822
        try:
823
            username = w.pw_name.decode(encoding)
824
        except UnicodeError:
825
            raise errors.BzrCommandError('Unable to determine your name.  '
826
                'Use "bzr whoami" to set it.')
1553.4.5 by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in
827
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
828
        comma = gecos.find(',')
829
        if comma == -1:
830
            realname = gecos
831
        else:
832
            realname = gecos[:comma]
833
        if not realname:
834
            realname = username
835
836
    except ImportError:
837
        import getpass
1553.4.5 by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in
838
        try:
839
            realname = username = getpass.getuser().decode(bzrlib.user_encoding)
840
        except UnicodeDecodeError:
841
            raise errors.BzrError("Can't decode username as %s." % \
842
                    bzrlib.user_encoding)
1442.1.2 by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing.
843
844
    return realname, (username + '@' + socket.gethostname())
845
846
1185.16.52 by Martin Pool
- add extract_email_address
847
def extract_email_address(e):
848
    """Return just the address part of an email string.
849
    
850
    That is just the user@domain part, nothing else. 
851
    This part is required to contain only ascii characters.
852
    If it can't be extracted, raises an error.
853
    
854
    >>> extract_email_address('Jane Tester <jane@test.com>')
855
    "jane@test.com"
856
    """
857
    m = re.search(r'[\w+.-]+@[\w+.-]+', e)
858
    if not m:
2055.2.2 by John Arbash Meinel
Switch extract_email_address() to use a more specific exception
859
        raise errors.NoEmailInUsername(e)
1185.16.52 by Martin Pool
- add extract_email_address
860
    return m.group(0)
1185.35.11 by Aaron Bentley
Added support for branch nicks
861
1185.85.30 by John Arbash Meinel
Fixing 'bzr push' exposed that IniBasedConfig didn't handle unicode.
862
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
863
class TreeConfig(IniBasedConfig):
1185.35.11 by Aaron Bentley
Added support for branch nicks
864
    """Branch configuration data associated with its contents, not location"""
865
    def __init__(self, branch):
866
        self.branch = branch
867
1770.2.5 by Aaron Bentley
Integrate branch.conf into BranchConfig
868
    def _get_parser(self, file=None):
869
        if file is not None:
870
            return IniBasedConfig._get_parser(file)
871
        return self._get_config()
872
1185.35.11 by Aaron Bentley
Added support for branch nicks
873
    def _get_config(self):
874
        try:
2018.5.59 by Robert Collins
Get BranchConfig working somewhat on RemoteBranches (Robert Collins, Vincent Ladeuil).
875
            obj = ConfigObj(self.branch.control_files.get('branch.conf'),
1556.2.1 by Aaron Bentley
Switched to ConfigObj 4.2.0
876
                            encoding='utf-8')
1185.35.11 by Aaron Bentley
Added support for branch nicks
877
        except errors.NoSuchFile:
1556.2.1 by Aaron Bentley
Switched to ConfigObj 4.2.0
878
            obj = ConfigObj(encoding='utf=8')
1185.35.11 by Aaron Bentley
Added support for branch nicks
879
        return obj
880
881
    def get_option(self, name, section=None, default=None):
882
        self.branch.lock_read()
883
        try:
884
            obj = self._get_config()
885
            try:
886
                if section is not None:
2533.1.1 by James Westby
Fix TreeConfig to return values from sections.
887
                    obj = obj[section]
1185.35.11 by Aaron Bentley
Added support for branch nicks
888
                result = obj[name]
889
            except KeyError:
890
                result = default
891
        finally:
892
            self.branch.unlock()
893
        return result
894
895
    def set_option(self, value, name, section=None):
896
        """Set a per-branch configuration option"""
897
        self.branch.lock_write()
898
        try:
899
            cfg_obj = self._get_config()
900
            if section is None:
901
                obj = cfg_obj
902
            else:
903
                try:
904
                    obj = cfg_obj[section]
905
                except KeyError:
906
                    cfg_obj[section] = {}
907
                    obj = cfg_obj[section]
908
            obj[name] = value
1556.2.1 by Aaron Bentley
Switched to ConfigObj 4.2.0
909
            out_file = StringIO()
910
            cfg_obj.write(out_file)
1185.35.11 by Aaron Bentley
Added support for branch nicks
911
            out_file.seek(0)
1185.65.12 by Robert Collins
Remove the only-used-once put_controlfiles, and change put_controlfile to put and put_utf8.
912
            self.branch.control_files.put('branch.conf', out_file)
1185.35.11 by Aaron Bentley
Added support for branch nicks
913
        finally:
914
            self.branch.unlock()