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