← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2009-05-27 08:33:37 UTC
  • mto: (4398.5.1 bencode_serializer)
  • mto: This revision was merged to the branch mainline in revision 4410.
  • Revision ID: jelmer@samba.org-20090527083337-fij2klthhtsdl2hy
Fix copyright headers, add _bencode_py.py to the list of files that do not have to have canonical copyright.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2007, 2008 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
146
146
class Config(object):
147
147
    """A configuration policy - what username, editor, gpg needs etc."""
148
148
 
149
 
    def __init__(self):
150
 
        super(Config, self).__init__()
151
 
 
152
149
    def get_editor(self):
153
150
        """Get the users pop up editor."""
154
151
        raise NotImplementedError
155
152
 
156
 
    def get_change_editor(self, old_tree, new_tree):
157
 
        from bzrlib import diff
158
 
        cmd = self._get_change_editor()
159
 
        if cmd is None:
160
 
            return None
161
 
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
162
 
                                             sys.stdout)
163
 
 
164
 
 
165
153
    def get_mail_client(self):
166
154
        """Get a mail client to use"""
167
155
        selected_client = self.get_user_option('mail_client')
186
174
        """Get a generic option - no special process, no default."""
187
175
        return self._get_user_option(option_name)
188
176
 
189
 
    def get_user_option_as_bool(self, option_name):
190
 
        """Get a generic option as a boolean - no special process, no default.
191
 
 
192
 
        :return None if the option doesn't exist or its value can't be
193
 
            interpreted as a boolean. Returns True or False otherwise.
194
 
        """
195
 
        s = self._get_user_option(option_name)
196
 
        if s is None:
197
 
            # The option doesn't exist
198
 
            return None
199
 
        val = ui.bool_from_string(s)
200
 
        if val is None:
201
 
            # The value can't be interpreted as a boolean
202
 
            trace.warning('Value "%s" is not a boolean for "%s"',
203
 
                          s, option_name)
204
 
        return val
205
 
 
206
 
    def get_user_option_as_list(self, option_name):
207
 
        """Get a generic option as a list - no special process, no default.
208
 
 
209
 
        :return None if the option doesn't exist. Returns the value as a list
210
 
            otherwise.
211
 
        """
212
 
        l = self._get_user_option(option_name)
213
 
        if isinstance(l, (str, unicode)):
214
 
            # A single value, most probably the user forgot the final ','
215
 
            l = [l]
216
 
        return l
217
 
 
218
177
    def gpg_signing_command(self):
219
178
        """What program should be used to sign signatures?"""
220
179
        result = self._gpg_signing_command()
237
196
        """See log_format()."""
238
197
        return None
239
198
 
 
199
    def __init__(self):
 
200
        super(Config, self).__init__()
 
201
 
240
202
    def post_commit(self):
241
203
        """An ordered list of python functions to call.
242
204
 
333
295
                path = 'bzr'
334
296
            return path
335
297
 
336
 
    def suppress_warning(self, warning):
337
 
        """Should the warning be suppressed or emitted.
338
 
 
339
 
        :param warning: The name of the warning being tested.
340
 
 
341
 
        :returns: True if the warning should be suppressed, False otherwise.
342
 
        """
343
 
        warnings = self.get_user_option_as_list('suppress_warnings')
344
 
        if warnings is None or warning not in warnings:
345
 
            return False
346
 
        else:
347
 
            return True
348
 
 
349
298
 
350
299
class IniBasedConfig(Config):
351
300
    """A configuration policy that draws from ini files."""
352
301
 
353
 
    def __init__(self, get_filename):
354
 
        super(IniBasedConfig, self).__init__()
355
 
        self._get_filename = get_filename
356
 
        self._parser = None
357
 
 
358
302
    def _get_parser(self, file=None):
359
303
        if self._parser is not None:
360
304
            return self._parser
388
332
        """Return the policy for the given (section, option_name) pair."""
389
333
        return POLICY_NONE
390
334
 
391
 
    def _get_change_editor(self):
392
 
        return self.get_user_option('change_editor')
393
 
 
394
335
    def _get_signature_checking(self):
395
336
        """See Config._get_signature_checking."""
396
337
        policy = self._get_user_option('check_signatures')
440
381
        """See Config.log_format."""
441
382
        return self._get_user_option('log_format')
442
383
 
 
384
    def __init__(self, get_filename):
 
385
        super(IniBasedConfig, self).__init__()
 
386
        self._get_filename = get_filename
 
387
        self._parser = None
 
388
 
443
389
    def _post_commit(self):
444
390
        """See Config.post_commit."""
445
391
        return self._get_user_option('post_commit')
518
464
        self._write_config_file()
519
465
 
520
466
    def _write_config_file(self):
521
 
        path = self._get_filename()
522
 
        f = open(path, 'wb')
523
 
        osutils.copy_ownership_from_path(path)
 
467
        f = open(self._get_filename(), 'wb')
524
468
        self._get_parser().write(f)
525
469
        f.close()
526
470
 
726
670
 
727
671
        return self._get_best_value('_get_user_id')
728
672
 
729
 
    def _get_change_editor(self):
730
 
        return self._get_best_value('_get_change_editor')
731
 
 
732
673
    def _get_signature_checking(self):
733
674
        """See Config._get_signature_checking."""
734
675
        return self._get_best_value('_get_signature_checking')
820
761
            os.mkdir(parent_dir)
821
762
        trace.mutter('creating config directory: %r', path)
822
763
        os.mkdir(path)
823
 
        osutils.copy_ownership_from_path(path)
824
764
 
825
765
 
826
766
def config_dir():
872
812
    return osutils.pathjoin(config_dir(), 'ignore')
873
813
 
874
814
 
875
 
def crash_dir():
876
 
    """Return the directory name to store crash files.
877
 
 
878
 
    This doesn't implicitly create it.
879
 
 
880
 
    On Windows it's in the config directory; elsewhere it's /var/crash
881
 
    which may be monitored by apport.  It can be overridden by
882
 
    $APPORT_CRASH_DIR.
883
 
    """
884
 
    if sys.platform == 'win32':
885
 
        return osutils.pathjoin(config_dir(), 'Crash')
886
 
    else:
887
 
        # XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
888
 
        # 2010-01-31
889
 
        return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
890
 
 
891
 
 
892
 
def xdg_cache_dir():
893
 
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
894
 
    # Possibly this should be different on Windows?
895
 
    e = os.environ.get('XDG_CACHE_DIR', None)
896
 
    if e:
897
 
        return e
898
 
    else:
899
 
        return os.path.expanduser('~/.cache')
900
 
 
901
 
 
902
815
def _auto_user_id():
903
816
    """Calculate automatic user identification.
904
817
 
1017
930
            return self._config.get_option(name, section, default)
1018
931
        finally:
1019
932
            self.branch.unlock()
 
933
        return result
1020
934
 
1021
935
    def set_option(self, value, name, section=None):
1022
936
        """Set a per-branch configuration option"""
1417
1331
 
1418
1332
 
1419
1333
class PlainTextCredentialStore(CredentialStore):
1420
 
    __doc__ = """Plain text credential store for the authentication.conf file"""
 
1334
    """Plain text credential store for the authentication.conf file."""
1421
1335
 
1422
1336
    def decode_password(self, credentials):
1423
1337
        """See CredentialStore.decode_password."""
1512
1426
 
1513
1427
    def _get_config_file(self):
1514
1428
        try:
1515
 
            return StringIO(self._transport.get_bytes(self._filename))
 
1429
            return self._transport.get(self._filename)
1516
1430
        except errors.NoSuchFile:
1517
1431
            return StringIO()
1518
1432