2 package Debbugs::Config;
6 Debbugs::Config -- Configuration information for debbugs
12 # to get the compatiblity interface
14 use Debbugs::Config qw(:globals);
18 This module provides configuration variables for all of debbugs.
20 =head1 CONFIGURATION FILES
22 The default configuration file location is /etc/debbugs/config; this
23 configuration file location can be set by modifying the
24 DEBBUGS_CONFIG_FILE env variable to point at a different location.
30 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT $USING_GLOBALS %config);
31 use base qw(Exporter);
34 # set the version for version checking
36 $DEBUG = 0 unless defined $DEBUG;
40 %EXPORT_TAGS = (globals => [qw($gEmailDomain $gListDomain $gWebHost $gWebHostBugDir),
41 qw($gWebDomain $gHTMLSuffix $gCGIDomain $gMirrors),
42 qw($gPackagePages $gSubscriptionDomain $gProject $gProjectTitle),
43 qw($gMaintainer $gMaintainerWebpage $gMaintainerEmail $gUnknownMaintainerEmail),
44 qw($gSubmitList $gMaintList $gQuietList $gForwardList),
45 qw($gDoneList $gRequestList $gSubmitterList $gControlList),
47 qw($gPackageVersionRe),
48 qw($gSummaryList $gMirrorList $gMailer $gBug),
49 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
50 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
51 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
52 qw($gMaintainerFileOverride $gPseudoDescFile $gPackageSource),
53 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
54 qw($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
55 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
57 qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
59 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
61 config => [qw(%config)],
64 Exporter::export_ok_tags(qw(globals text config));
65 $EXPORT_TAGS{all} = [@EXPORT_OK];
68 use File::Basename qw(dirname);
72 =head1 CONFIGURATION VARIABLES
74 =head2 General Configuration
82 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
83 # This enables us to test things that are -T.
84 if (exists $ENV{DEBBUGS_CONFIG_FILE} and
85 ${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
86 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
87 $ENV{DEBBUGS_CONFIG_FILE} = $1;
89 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
91 =item email_domain $gEmailDomain
93 The email domain of the bts
97 set_default(\%config,'email_domain','bugs.something');
99 =item list_domain $gListDomain
101 The list domain of the bts, defaults to the email domain
105 set_default(\%config,'list_domain',$config{email_domain});
107 =item web_host $gWebHost
109 The web host of the bts; defaults to the email domain
113 set_default(\%config,'web_host',$config{email_domain});
115 =item web_host_bug_dir $gWebHostDir
117 The directory of the web host on which bugs are kept, defaults to C<''>
121 set_default(\%config,'web_host_bug_dir','');
123 =item web_domain $gWebDomain
125 Full path of the web domain where bugs are kept, defaults to the
126 concatenation of L</web_host> and L</web_host_bug_dir>
130 set_default(\%config,'web_domain',$config{web_host}.'/'.$config{web_host_bug_dir});
132 =item html_suffix $gHTMLSuffix
134 Suffix of html pages, defaults to .html
138 set_default(\%config,'html_suffix','.html');
140 =item cgi_domain $gCGIDomain
142 Full path of the web domain where cgi scripts are kept. Defaults to
143 the concatentation of L</web_host> and cgi.
147 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
149 =item mirrors @gMirrors
151 List of mirrors [What these mirrors are used for, no one knows.]
156 set_default(\%config,'mirrors',[]);
158 =item package_pages $gPackagePages
160 Domain where the package pages are kept; links should work in a
161 package_pages/foopackage manner. Defaults to undef, which means that
162 package links will not be made.
167 set_default(\%config,'package_pages',undef);
169 =item subscription_domain $gSubscriptionDomain
171 Domain where subscriptions to package lists happen
176 set_default(\%config,'subscription_domain',undef);
183 =head2 Project Identification
187 =item project $gProject
195 set_default(\%config,'project','Something');
197 =item project_title $gProjectTitle
199 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
201 Default: "$config{project} Debbugs Install"
205 set_default(\%config,'project_title',"$config{project} Debbugs Install");
207 =item maintainer $gMaintainer
209 Name of the maintainer of this debbugs install
211 Default: 'Local DebBugs Owner's
215 set_default(\%config,'maintainer','Local DebBugs Owner');
217 =item maintainer_webpage $gMaintainerWebpage
219 Webpage of the maintainer of this install of debbugs
221 Default: "$config{web_domain}/~owner"
225 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
227 =item maintainer_email
229 Email address of the maintainer of this Debbugs install
231 Default: 'root@'.$config{email_domain}
235 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
237 =item unknown_maintainer_email
239 Email address where packages with an unknown maintainer will be sent
241 Default: $config{maintainer_email}
247 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
249 =head2 BTS Mailing Lists
276 set_default(\%config, 'submit_list', 'bug-submit-list');
277 set_default(\%config, 'maint_list', 'bug-maint-list');
278 set_default(\%config, 'quiet_list', 'bug-quiet-list');
279 set_default(\%config, 'forward_list', 'bug-forward-list');
280 set_default(\%config, 'done_list', 'bug-done-list');
281 set_default(\%config, 'request_list', 'bug-request-list');
282 set_default(\%config,'submitter_list','bug-submitter-list');
283 set_default(\%config, 'control_list', 'bug-control-list');
284 set_default(\%config, 'summary_list', 'bug-summary-list');
285 set_default(\%config, 'mirror_list', 'bug-mirror-list');
286 set_default(\%config, 'strong_list', 'bug-strong-list');
294 set_default(\%config,'mailer','exim');
295 set_default(\%config,'bug','bug');
296 set_default(\%config,'bugs','bugs');
300 Age at which bugs are archived/removed
306 set_default(\%config,'remove_age',28);
310 Whether old bugs are saved or deleted
316 set_default(\%config,'save_old_bugs',1);
320 List of valid distributions
322 Default: qw(experimental unstable testing stable oldstable);
326 set_default(\%config,'distributions',[qw(experimental unstable testing stable oldstable)]);
328 =item removal_distribution_tags
330 Tags which specifiy distributions to check
332 Default: @{$config{distributions}}
336 set_default(\%config,'removal_distribution_tags',
337 [@{$config{distributions}}]);
339 =item removal_default_distribution_tags
341 For removal/archival purposes, all bugs are assumed to have these tags
344 Default: qw(unstable testing);
348 set_default(\%config,'removal_default_distribution_tags',
349 [qw(unstable testing)]
352 =item removal_architectures
354 For removal/archival purposes, these architectures are consulted if
355 there is more than one architecture applicable. If the bug is in a
356 package not in any of these architectures, the architecture actually
357 checked is undefined.
359 Default: qw(i386 amd64 arm ppc sparc alpha);
363 set_default(\%config,'removal_architectures',
364 [qw(i386 amd64 arm ppc sparc alpha)]
368 =item package_name_re
370 The regex which will match a package name
372 Default: '[a-z0-9][a-z0-9\.+-]+'
376 set_default(\%config,'package_name_re',
377 '[a-z0-9][a-z0-9\.+-]+');
379 =item package_version_re
381 The regex which will match a package version
383 Default: '[A-Za-z0-9:+\.-]+'
387 set_default(\%config,'package_version_re',
388 '[A-Za-z0-9:+\.~-]+');
392 =item exclude_from_control
394 Addresses which are not allowed to send messages to control
398 set_default(\%config,'exclude_from_control',[]);
403 set_default(\%config,'default_severity','normal');
404 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
405 set_default(\%config,'strong_severities',[qw(critical grave)]);
406 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
407 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
408 grave => "Grave $config{bugs}",
409 normal => "Normal $config{bugs}",
410 wishlist => "Wishlist $config{bugs}",
413 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
414 @{$config{distributions}}
417 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
418 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
419 '^mail.*agent|^tcpmail|^bitmail|^mailman');
421 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
422 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
423 set_default(\%config,'incoming_dir','incoming');
424 set_default(\%config,'web_dir','/var/lib/debbugs/www');
425 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
426 set_default(\%config,'lib_path','/usr/lib/debbugs');
428 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
429 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
430 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
431 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
433 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
435 set_default(\%config,'post_processall',[]);
439 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
443 set_default(\%config,'sendmail','/usr/lib/sendmail');
447 Whether or not spamscan is being used; defaults to 0 (not being used
451 set_default(\%config,'spam_scan',0);
459 The following are the only text fields in general use in the scripts;
460 a few additional text fields are defined in text.in, but are only used
461 in db2html and a few other specialty scripts.
463 Earlier versions of debbugs defined these values in /etc/debbugs/text,
464 but now they are required to be in the configuration file. [Eventually
465 the longer ones will move out into a fully fledged template system.]
471 =item bad_email_prefix
473 This prefixes the text of all lines in a bad e-mail message ack.
477 set_default(\%config,'bad_email_prefix','');
480 =item text_instructions
482 This gives more information about bad e-mails to receive.in
486 set_default(\%config,'text_instructions',$config{bad_email_prefix});
490 This shows up at the end of (most) html pages
494 set_default(\%config,'html_tail',<<END);
495 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
501 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
502 Copyright (C) 1999 Darren O. Benham,
503 1997,2003 nCipher Corporation Ltd,
509 =item html_expire_note
511 This message explains what happens to archive/remove-able bugs
515 set_default(\%config,'html_expire_note',
516 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
524 my ($conf_file) = @_;
525 # first, figure out what type of file we're reading in.
526 my $fh = new IO::File $conf_file,'r'
527 or die "Unable to open configuration file $conf_file for reading: $!";
528 # A new version configuration file must have a comment as its first line
529 my $first_line = <$fh>;
530 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
531 if (defined $version) {
534 die "Version 1 configuration files not implemented yet";
537 die "Version $version configuration files are not supported";
541 # Ugh. Old configuration file
542 # What we do here is we create a new Safe compartment
543 # so fucked up crap in the config file doesn't sink us.
544 my $cpt = new Safe or die "Unable to create safe compartment";
545 # perldoc Opcode; for details
546 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
547 $cpt->reval(qq(require '$conf_file';));
548 die "Error in configuration file: $@" if $@;
549 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
550 # we want to glob in from the configuration file
551 for my $variable (@{$EXPORT_TAGS{globals}}) {
552 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
553 my $var_glob = $cpt->varglob($glob_name);
554 my $value; #= $cpt->reval("return $variable");
555 # print STDERR "$variable $value",qq(\n);
556 if (defined $var_glob) {{
558 if ($glob_type eq '%') {
559 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
561 elsif ($glob_type eq '@') {
562 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
565 $value = ${*{$var_glob}};
567 # We punt here, because we can't tell if the value was
568 # defined intentionally, or if it was just left alone;
569 # this tries to set sane defaults.
570 set_default(\%config,$hash_name,$value) if defined $value;
578 my $hash_name = $variable;
579 $hash_name =~ s/^([\$\%\@])g//;
581 my $glob_name = 'g'.$hash_name;
582 $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
583 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
584 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
585 return $hash_name unless wantarray;
586 return ($hash_name,$glob_name,$glob_type);
591 # sets the configuration hash to the default value if it's not set,
592 # otherwise doesn't do anything
593 # If $USING_GLOBALS, then sets an appropriate global.
596 my ($config,$option,$value) = @_;
598 if ($USING_GLOBALS) {
599 # fix up the variable name
600 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
601 # Fix stupid HTML names
602 $varname =~ s/(Html|Cgi)/uc($1)/ge;
604 # update the configuration value
605 if (not $USING_GLOBALS and not exists $config->{$option}) {
606 $config->{$option} = $value;
608 elsif ($USING_GLOBALS) {{
610 # Need to check if a value has already been set in a global
611 if (defined *{"Debbugs::Config::${varname}"}) {
612 $config->{$option} = *{"Debbugs::Config::${varname}"};
615 $config->{$option} = $value;
618 if ($USING_GLOBALS) {{
620 *{"Debbugs::Config::${varname}"} = $config->{$option};
627 # All we care about here is whether we've been called with the globals or text option;
628 # if so, then we need to export some symbols back up.
629 # In any event, we call exporter.
632 if (grep /^:(?:text|globals)$/, @_) {
634 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
637 # Yes, I don't care if these are only used once
639 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
641 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
642 $tmp =~ s/^[\%\$\@]//;
643 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
646 Debbugs::Config->export_to_level(1,@_);