~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

• browse files at revision 3135
• compare with another revision
• download diff
• download tarball
• view history from revision 3135

• reverse the comparison (3135 to 3641.5.3)
• stop comparing with revision 3641.5.3

Show diffs side-by-side

added

removed

bzrlib/config.py

151

151

            mail_client_class = {

152

152

                None: mail_client.DefaultMail,

153

153

                # Specific clients

154

 

                'emacsclient': mail_client.EmacsMail,

155

154

                'evolution': mail_client.Evolution,

156

155

                'kmail': mail_client.KMail,

157

156

                'mutt': mail_client.Mutt,

440

439

 

441

440

    def set_user_option(self, option, value):

442

441

        """Save option and its value in the configuration."""

443

 

        self._set_option(option, value, 'DEFAULT')

444

 

 

445

 

    def get_aliases(self):

446

 

        """Return the aliases section."""

447

 

        if 'ALIASES' in self._get_parser():

448

 

            return self._get_parser()['ALIASES']

449

 

        else:

450

 

            return {}

451

 

 

452

 

    def set_alias(self, alias_name, alias_command):

453

 

        """Save the alias in the configuration."""

454

 

        self._set_option(alias_name, alias_command, 'ALIASES')

455

 

 

456

 

    def unset_alias(self, alias_name):

457

 

        """Unset an existing alias."""

458

 

        aliases = self._get_parser().get('ALIASES')

459

 

        if not aliases or alias_name not in aliases:

460

 

            raise errors.NoSuchAlias(alias_name)

461

 

        del aliases[alias_name]

462

 

        self._write_config_file()

463

 

 

464

 

    def _set_option(self, option, value, section):

465

442

        # FIXME: RBC 20051029 This should refresh the parser and also take a

466

443

        # file lock on bazaar.conf.

467

444

        conf_dir = os.path.dirname(self._get_filename())

468

445

        ensure_config_dir_exists(conf_dir)

469

 

        self._get_parser().setdefault(section, {})[option] = value

470

 

        self._write_config_file()

471

 

 

472

 

    def _write_config_file(self):

 

446

        if 'DEFAULT' not in self._get_parser():

 

447

            self._get_parser()['DEFAULT'] = {}

 

448

        self._get_parser()['DEFAULT'][option] = value

473

449

        f = open(self._get_filename(), 'wb')

474

450

        self._get_parser().write(f)

475

451

        f.close()

593

569

 

594

570

    def set_user_option(self, option, value, store=STORE_LOCATION):

595

571

        """Save option and its value in the configuration."""

596

 

        if store not in [STORE_LOCATION,

 

572

        assert store in [STORE_LOCATION,

597

573

                         STORE_LOCATION_NORECURSE,

598

 

                         STORE_LOCATION_APPENDPATH]:

599

 

            raise ValueError('bad storage policy %r for %r' %

600

 

                (store, option))

 

574

                         STORE_LOCATION_APPENDPATH], 'bad storage policy'

601

575

        # FIXME: RBC 20051029 This should refresh the parser and also take a

602

576

        # file lock on locations.conf.

603

577

        conf_dir = os.path.dirname(self._get_filename())

664

638

    def _get_user_id(self):

665

639

        """Return the full user id for the branch.

666

640

    

667

 

        e.g. "John Hacker <jhacker@example.com>"

 

641

        e.g. "John Hacker <jhacker@foo.org>"

668

642

        This is looked up in the email controlfile for the branch.

669

643

        """

670

644

        try:

671

 

            return (self.branch._transport.get_bytes("email")

 

645

            return (self.branch.control_files.get_utf8("email") 

 

646

                    .read()

672

647

                    .decode(bzrlib.user_encoding)

673

648

                    .rstrip("\r\n"))

674

649

        except errors.NoSuchFile, e:

915

890

class TreeConfig(IniBasedConfig):

916

891

    """Branch configuration data associated with its contents, not location"""

917

892

 

918

 

    # XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507

919

 

 

920

893

    def __init__(self, branch):

921

 

        # XXX: Really this should be asking the branch for its configuration

922

 

        # data, rather than relying on a Transport, so that it can work 

923

 

        # more cleanly with a RemoteBranch that has no transport.

924

 

        self._config = TransportConfig(branch._transport, 'branch.conf')

925

894

        self.branch = branch

926

895

 

927

896

    def _get_parser(self, file=None):

928

897

        if file is not None:

929

898

            return IniBasedConfig._get_parser(file)

930

 

        return self._config._get_configobj()

 

899

        return self._get_config()

 

900

 

 

901

    def _get_config(self):

 

902

        try:

 

903

            obj = ConfigObj(self.branch.control_files.get('branch.conf'),

 

904

                            encoding='utf-8')

 

905

        except errors.NoSuchFile:

 

906

            obj = ConfigObj(encoding='utf=8')

 

907

        return obj

931

908

 

932

909

    def get_option(self, name, section=None, default=None):

933

910

        self.branch.lock_read()

934

911

        try:

935

 

            return self._config.get_option(name, section, default)

 

912

            obj = self._get_config()

 

913

            try:

 

914

                if section is not None:

 

915

                    obj = obj[section]

 

916

                result = obj[name]

 

917

            except KeyError:

 

918

                result = default

936

919

        finally:

937

920

            self.branch.unlock()

938

921

        return result

941

924

        """Set a per-branch configuration option"""

942

925

        self.branch.lock_write()

943

926

        try:

944

 

            self._config.set_option(value, name, section)

 

927

            cfg_obj = self._get_config()

 

928

            if section is None:

 

929

                obj = cfg_obj

 

930

            else:

 

931

                try:

 

932

                    obj = cfg_obj[section]

 

933

                except KeyError:

 

934

                    cfg_obj[section] = {}

 

935

                    obj = cfg_obj[section]

 

936

            obj[name] = value

 

937

            out_file = StringIO()

 

938

            cfg_obj.write(out_file)

 

939

            out_file.seek(0)

 

940

            self.branch.control_files.put('branch.conf', out_file)

945

941

        finally:

946

942

            self.branch.unlock()

947

943

 

1019

1015

        """

1020

1016

        credentials = None

1021

1017

        for auth_def_name, auth_def in self._get_config().items():

1022

 

            if type(auth_def) is not configobj.Section:

1023

 

                raise ValueError("%s defined outside a section" % auth_def_name)

1024

 

 

1025

1018

            a_scheme, a_host, a_user, a_path = map(

1026

1019

                auth_def.get, ['scheme', 'host', 'user', 'path'])

1027

1020

 

1059

1052

                # Can't find a user

1060

1053

                continue

1061

1054

            credentials = dict(name=auth_def_name,

1062

 

                               user=a_user,

1063

 

                               password=auth_def.get('password', None),

 

1055

                               user=a_user, password=auth_def['password'],

1064

1056

                               verify_certificates=a_verify_certificates)

1065

1057

            self.decode_password(credentials,

1066

1058

                                 auth_def.get('password_encoding', None))

1115

1107

        credentials = self.get_credentials(scheme, host, port, user, path)

1116

1108

        if credentials is not None:

1117

1109

            password = credentials['password']

1118

 

            if password is not None and scheme is 'ssh':

1119

 

                trace.warning('password ignored in section [%s],'

1120

 

                              ' use an ssh agent instead'

1121

 

                              % credentials['name'])

1122

 

                password = None

1123

1110

        else:

1124

1111

            password = None

1125

1112

        # Prompt user only if we could't find a password

1126

1113

        if password is None:

1127

1114

            if prompt is None:

1128

 

                # Create a default prompt suitable for most cases

 

1115

                # Create a default prompt suitable for most of the cases

1129

1116

                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'

1130

1117

            # Special handling for optional fields in the prompt

1131

1118

            if port is not None:

1138

1125

 

1139

1126

    def decode_password(self, credentials, encoding):

1140

1127

        return credentials

1141

 

 

1142

 

 

1143

 

class BzrDirConfig(object):

1144

 

 

1145

 

    def __init__(self, transport):

1146

 

        self._config = TransportConfig(transport, 'control.conf')

1147

 

 

1148

 

    def set_default_stack_on(self, value):

1149

 

        """Set the default stacking location.

1150

 

 

1151

 

        It may be set to a location, or None.

1152

 

 

1153

 

        This policy affects all branches contained by this bzrdir, except for

1154

 

        those under repositories.

1155

 

        """

1156

 

        if value is None:

1157

 

            self._config.set_option('', 'default_stack_on')

1158

 

        else:

1159

 

            self._config.set_option(value, 'default_stack_on')

1160

 

 

1161

 

    def get_default_stack_on(self):

1162

 

        """Return the default stacking location.

1163

 

 

1164

 

        This will either be a location, or None.

1165

 

 

1166

 

        This policy affects all branches contained by this bzrdir, except for

1167

 

        those under repositories.

1168

 

        """

1169

 

        value = self._config.get_option('default_stack_on')

1170

 

        if value == '':

1171

 

            value = None

1172

 

        return value

1173

 

 

1174

 

 

1175

 

class TransportConfig(object):

1176

 

    """A Config that reads/writes a config file on a Transport.

1177

 

 

1178

 

    It is a low-level object that considers config data to be name/value pairs

1179

 

    that may be associated with a section.  Assigning meaning to the these

1180

 

    values is done at higher levels like TreeConfig.

1181

 

    """

1182

 

 

1183

 

    def __init__(self, transport, filename):

1184

 

        self._transport = transport

1185

 

        self._filename = filename

1186

 

 

1187

 

    def get_option(self, name, section=None, default=None):

1188

 

        """Return the value associated with a named option.

1189

 

 

1190

 

        :param name: The name of the value

1191

 

        :param section: The section the option is in (if any)

1192

 

        :param default: The value to return if the value is not set

1193

 

        :return: The value or default value

1194

 

        """

1195

 

        configobj = self._get_configobj()

1196

 

        if section is None:

1197

 

            section_obj = configobj

1198

 

        else:

1199

 

            try:

1200

 

                section_obj = configobj[section]

1201

 

            except KeyError:

1202

 

                return default

1203

 

        return section_obj.get(name, default)

1204

 

 

1205

 

    def set_option(self, value, name, section=None):

1206

 

        """Set the value associated with a named option.

1207

 

 

1208

 

        :param value: The value to set

1209

 

        :param name: The name of the value to set

1210

 

        :param section: The section the option is in (if any)

1211

 

        """

1212

 

        configobj = self._get_configobj()

1213

 

        if section is None:

1214

 

            configobj[name] = value

1215

 

        else:

1216

 

            configobj.setdefault(section, {})[name] = value

1217

 

        self._set_configobj(configobj)

1218

 

 

1219

 

    def _get_configobj(self):

1220

 

        try:

1221

 

            return ConfigObj(self._transport.get(self._filename),

1222

 

                             encoding='utf-8')

1223

 

        except errors.NoSuchFile:

1224

 

            return ConfigObj(encoding='utf-8')

1225

 

 

1226

 

    def _set_configobj(self, configobj):

1227

 

        out_file = StringIO()

1228

 

        configobj.write(out_file)

1229

 

        out_file.seek(0)

1230

 

        self._transport.put_file(self._filename, out_file)

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1