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