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($gSummaryList $gMirrorList $gMailer $gBug),
48 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
49 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
50 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
51 qw($gMaintainerFileOverride $gPseudoDescFile $gPackageSource),
52 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
53 qw($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
54 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
56 qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
58 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
60 config => [qw(%config)],
63 Exporter::export_ok_tags(qw(globals text config));
64 $EXPORT_TAGS{all} = [@EXPORT_OK];
67 use File::Basename qw(dirname);
71 =head1 CONFIGURATION VARIABLES
73 =head2 General Configuration
81 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
82 # This enables us to test things that are -T.
83 if (exists $ENV{DEBBUGS_CONFIG_FILE} and
84 ${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
85 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
86 $ENV{DEBBUGS_CONFIG_FILE} = $1;
88 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
90 =item email_domain $gEmailDomain
92 The email domain of the bts
96 set_default(\%config,'email_domain','bugs.something');
98 =item list_domain $gListDomain
100 The list domain of the bts, defaults to the email domain
104 set_default(\%config,'list_domain',$config{email_domain});
106 =item web_host $gWebHost
108 The web host of the bts; defaults to the email domain
112 set_default(\%config,'web_host',$config{email_domain});
114 =item web_host_bug_dir $gWebHostDir
116 The directory of the web host on which bugs are kept, defaults to C<''>
120 set_default(\%config,'web_host_bug_dir','');
122 =item web_domain $gWebDomain
124 Full path of the web domain where bugs are kept, defaults to the
125 concatenation of L</web_host> and L</web_host_bug_dir>
129 set_default(\%config,'web_domain',$config{web_host}.'/'.$config{web_host_bug_dir});
131 =item html_suffix $gHTMLSuffix
133 Suffix of html pages, defaults to .html
137 set_default(\%config,'html_suffix','.html');
139 =item cgi_domain $gCGIDomain
141 Full path of the web domain where cgi scripts are kept. Defaults to
142 the concatentation of L</web_host> and cgi.
146 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
148 =item mirrors @gMirrors
150 List of mirrors [What these mirrors are used for, no one knows.]
155 set_default(\%config,'mirrors',[]);
157 =item package_pages $gPackagePages
159 Domain where the package pages are kept; links should work in a
160 package_pages/foopackage manner. Defaults to undef, which means that
161 package links will not be made.
166 set_default(\%config,'package_pages',undef);
168 =item subscription_domain $gSubscriptionDomain
170 Domain where subscriptions to package lists happen
175 set_default(\%config,'subscription_domain',undef);
182 =head2 Project Identification
186 =item project $gProject
194 set_default(\%config,'project','Something');
196 =item project_title $gProjectTitle
198 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
200 Default: "$config{project} Debbugs Install"
204 set_default(\%config,'project_title',"$config{project} Debbugs Install");
206 =item maintainer $gMaintainer
208 Name of the maintainer of this debbugs install
210 Default: 'Local DebBugs Owner's
214 set_default(\%config,'maintainer','Local DebBugs Owner');
216 =item maintainer_webpage $gMaintainerWebpage
218 Webpage of the maintainer of this install of debbugs
220 Default: "$config{web_domain}/~owner"
224 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
226 =item maintainer_email
228 Email address of the maintainer of this Debbugs install
230 Default: 'root@'.$config{email_domain}
234 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
236 =item unknown_maintainer_email
238 Email address where packages with an unknown maintainer will be sent
240 Default: $config{maintainer_email}
246 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
248 =head2 BTS Mailing Lists
275 set_default(\%config, 'submit_list', 'bug-submit-list');
276 set_default(\%config, 'maint_list', 'bug-maint-list');
277 set_default(\%config, 'quiet_list', 'bug-quiet-list');
278 set_default(\%config, 'forward_list', 'bug-forward-list');
279 set_default(\%config, 'done_list', 'bug-done-list');
280 set_default(\%config, 'request_list', 'bug-request-list');
281 set_default(\%config,'submitter_list','bug-submitter-list');
282 set_default(\%config, 'control_list', 'bug-control-list');
283 set_default(\%config, 'summary_list', 'bug-summary-list');
284 set_default(\%config, 'mirror_list', 'bug-mirror-list');
285 set_default(\%config, 'strong_list', 'bug-strong-list');
293 set_default(\%config,'mailer','exim');
294 set_default(\%config,'bug','bug');
295 set_default(\%config,'bugs','bugs');
299 Age at which bugs are archived/removed
305 set_default(\%config,'remove_age',28);
309 Whether old bugs are saved or deleted
315 set_default(\%config,'save_old_bugs',1);
319 List of valid distributions
321 Default: qw(experimental unstable testing stable oldstable);
325 set_default(\%config,'distributions',[qw(experimental unstable testing stable oldstable)]);
327 =item removal_distribution_tags
329 Tags which specifiy distributions to check
331 Default: @{$config{distributions}}
335 set_default(\%config,'removal_distribution_tags',
336 [@{$config{distributions}}]);
338 =item removal_default_distribution_tags
340 For removal/archival purposes, all bugs are assumed to have these tags
343 Default: qw(unstable testing);
347 set_default(\%config,'removal_default_distribution_tags',
348 [qw(unstable testing)]
351 =item removal_architectures
353 For removal/archival purposes, these architectures are consulted if
354 there is more than one architecture applicable. If the bug is in a
355 package not in any of these architectures, the architecture actually
356 checked is undefined.
358 Default: qw(i386 amd64 arm ppc sparc alpha);
362 set_default(\%config,'removal_architectures',
363 [qw(i386 amd64 arm ppc sparc alpha)]
367 =item package_name_re
369 The regex which will match a package name
371 Default: '[a-z0-9][a-z0-9\.+-]+'
375 set_default(\%config,'package_name_re',
376 '[a-z0-9][a-z0-9\.+-]+');
378 =item package_version_re
380 The regex which will match a package version
382 Default: '[A-Za-z0-9:+\.-]+'
386 set_default(\%config,'package_version_re',
387 '[A-Za-z0-9:+\.-]+');
391 =item exclude_from_control
393 Addresses which are not allowed to send messages to control
397 set_default(\%config,'exclude_from_control',[]);
402 set_default(\%config,'default_severity','normal');
403 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
404 set_default(\%config,'strong_severities',[qw(critical grave)]);
405 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
406 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
407 grave => "Grave $config{bugs}",
408 normal => "Normal $config{bugs}",
409 wishlist => "Wishlist $config{bugs}",
412 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
413 @{$config{distributions}}
416 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
417 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
418 '^mail.*agent|^tcpmail|^bitmail|^mailman');
420 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
421 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
422 set_default(\%config,'incoming_dir','incoming');
423 set_default(\%config,'web_dir','/var/lib/debbugs/www');
424 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
425 set_default(\%config,'lib_path','/usr/lib/debbugs');
427 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
428 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
429 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
430 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
432 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
434 set_default(\%config,'post_processall',[]);
438 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
442 set_default(\%config,'sendmail','/usr/lib/sendmail');
446 Whether or not spamscan is being used; defaults to 0 (not being used
450 set_default(\%config,'spam_scan',0);
458 The following are the only text fields in general use in the scripts;
459 a few additional text fields are defined in text.in, but are only used
460 in db2html and a few other specialty scripts.
462 Earlier versions of debbugs defined these values in /etc/debbugs/text,
463 but now they are required to be in the configuration file. [Eventually
464 the longer ones will move out into a fully fledged template system.]
470 =item bad_email_prefix
472 This prefixes the text of all lines in a bad e-mail message ack.
476 set_default(\%config,'bad_email_prefix','');
479 =item text_instructions
481 This gives more information about bad e-mails to receive.in
485 set_default(\%config,'text_instructions',$config{bad_email_prefix});
489 This shows up at the end of (most) html pages
493 set_default(\%config,'html_tail',<<END);
494 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
500 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
501 Copyright (C) 1999 Darren O. Benham,
502 1997,2003 nCipher Corporation Ltd,
508 =item html_expire_note
510 This message explains what happens to archive/remove-able bugs
514 set_default(\%config,'html_expire_note',
515 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
523 my ($conf_file) = @_;
524 # first, figure out what type of file we're reading in.
525 my $fh = new IO::File $conf_file,'r'
526 or die "Unable to open configuration file $conf_file for reading: $!";
527 # A new version configuration file must have a comment as its first line
528 my $first_line = <$fh>;
529 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
530 if (defined $version) {
533 die "Version 1 configuration files not implemented yet";
536 die "Version $version configuration files are not supported";
540 # Ugh. Old configuration file
541 # What we do here is we create a new Safe compartment
542 # so fucked up crap in the config file doesn't sink us.
543 my $cpt = new Safe or die "Unable to create safe compartment";
544 # perldoc Opcode; for details
545 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
546 $cpt->reval(qq(require '$conf_file';));
547 die "Error in configuration file: $@" if $@;
548 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
549 # we want to glob in from the configuration file
550 for my $variable (@{$EXPORT_TAGS{globals}}) {
551 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
552 my $var_glob = $cpt->varglob($glob_name);
553 my $value; #= $cpt->reval("return $variable");
554 # print STDERR "$variable $value",qq(\n);
555 if (defined $var_glob) {{
557 if ($glob_type eq '%') {
558 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
560 elsif ($glob_type eq '@') {
561 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
564 $value = ${*{$var_glob}};
566 # We punt here, because we can't tell if the value was
567 # defined intentionally, or if it was just left alone;
568 # this tries to set sane defaults.
569 set_default(\%config,$hash_name,$value) if defined $value;
577 my $hash_name = $variable;
578 $hash_name =~ s/^([\$\%\@])g//;
580 my $glob_name = 'g'.$hash_name;
581 $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
582 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
583 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
584 return $hash_name unless wantarray;
585 return ($hash_name,$glob_name,$glob_type);
590 # sets the configuration hash to the default value if it's not set,
591 # otherwise doesn't do anything
592 # If $USING_GLOBALS, then sets an appropriate global.
595 my ($config,$option,$value) = @_;
597 if ($USING_GLOBALS) {
598 # fix up the variable name
599 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
600 # Fix stupid HTML names
601 $varname =~ s/(Html|Cgi)/uc($1)/ge;
603 # update the configuration value
604 if (not $USING_GLOBALS and not exists $config->{$option}) {
605 $config->{$option} = $value;
607 elsif ($USING_GLOBALS) {{
609 # Need to check if a value has already been set in a global
610 if (defined *{"Debbugs::Config::${varname}"}) {
611 $config->{$option} = *{"Debbugs::Config::${varname}"};
614 $config->{$option} = $value;
617 if ($USING_GLOBALS) {{
619 *{"Debbugs::Config::${varname}"} = $config->{$option};
626 # All we care about here is whether we've been called with the globals or text option;
627 # if so, then we need to export some symbols back up.
628 # In any event, we call exporter.
631 if (grep /^:(?:text|globals)$/, @_) {
633 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
636 # Yes, I don't care if these are only used once
638 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
640 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
641 $tmp =~ s/^[\%\$\@]//;
642 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
645 Debbugs::Config->export_to_level(1,@_);