1 # This module is part of debbugs, and is released
2 # under the terms of the GPL version 2, or any later
3 # version at your option.
4 # See the file README and COPYING for more information.
6 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
8 package Debbugs::Config;
12 Debbugs::Config -- Configuration information for debbugs
18 # to get the compatiblity interface
20 use Debbugs::Config qw(:globals);
24 This module provides configuration variables for all of debbugs.
26 =head1 CONFIGURATION FILES
28 The default configuration file location is /etc/debbugs/config; this
29 configuration file location can be set by modifying the
30 DEBBUGS_CONFIG_FILE env variable to point at a different location.
36 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT $USING_GLOBALS %config);
37 use base qw(Exporter);
40 # set the version for version checking
42 $DEBUG = 0 unless defined $DEBUG;
46 %EXPORT_TAGS = (globals => [qw($gEmailDomain $gListDomain $gWebHost $gWebHostBugDir),
47 qw($gWebDomain $gHTMLSuffix $gCGIDomain $gMirrors),
48 qw($gPackagePages $gSubscriptionDomain $gProject $gProjectTitle),
49 qw($gMaintainer $gMaintainerWebpage $gMaintainerEmail $gUnknownMaintainerEmail),
50 qw($gSubmitList $gMaintList $gQuietList $gForwardList),
51 qw($gDoneList $gRequestList $gSubmitterList $gControlList),
53 qw($gPackageVersionRe),
54 qw($gSummaryList $gMirrorList $gMailer $gBug),
55 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
56 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
57 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
58 qw($gMaintainerFileOverride $gPseudoMaintFile $gPseudoDescFile $gPackageSource),
59 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
60 qw($gVersionTimeIndex),
61 qw($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
62 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
64 qw(%gDistributionAliases),
65 qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
66 qw(@gRemovalStrongSeverityDefaultDistributionTags),
68 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
70 config => [qw(%config)],
73 Exporter::export_ok_tags(qw(globals text config));
74 $EXPORT_TAGS{all} = [@EXPORT_OK];
77 use File::Basename qw(dirname);
81 =head1 CONFIGURATION VARIABLES
83 =head2 General Configuration
91 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
92 # This enables us to test things that are -T.
93 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
94 if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
95 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
96 $ENV{DEBBUGS_CONFIG_FILE} = $1;
99 die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
102 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
104 =item email_domain $gEmailDomain
106 The email domain of the bts
110 set_default(\%config,'email_domain','bugs.something');
112 =item list_domain $gListDomain
114 The list domain of the bts, defaults to the email domain
118 set_default(\%config,'list_domain',$config{email_domain});
120 =item web_host $gWebHost
122 The web host of the bts; defaults to the email domain
126 set_default(\%config,'web_host',$config{email_domain});
128 =item web_host_bug_dir $gWebHostDir
130 The directory of the web host on which bugs are kept, defaults to C<''>
134 set_default(\%config,'web_host_bug_dir','');
136 =item web_domain $gWebDomain
138 Full path of the web domain where bugs are kept, defaults to the
139 concatenation of L</web_host> and L</web_host_bug_dir>
143 set_default(\%config,'web_domain',$config{web_host}.'/'.$config{web_host_bug_dir});
145 =item html_suffix $gHTMLSuffix
147 Suffix of html pages, defaults to .html
151 set_default(\%config,'html_suffix','.html');
153 =item cgi_domain $gCGIDomain
155 Full path of the web domain where cgi scripts are kept. Defaults to
156 the concatentation of L</web_host> and cgi.
160 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
162 =item mirrors @gMirrors
164 List of mirrors [What these mirrors are used for, no one knows.]
169 set_default(\%config,'mirrors',[]);
171 =item package_pages $gPackagePages
173 Domain where the package pages are kept; links should work in a
174 package_pages/foopackage manner. Defaults to undef, which means that
175 package links will not be made.
180 set_default(\%config,'package_pages',undef);
182 =item package_pages $gUsertagPackageDomain
184 Domain where where usertags of packages belong; defaults to $gPackagePages
188 set_default(\%config,'usertag_package_domain',$config{package_pages});
191 =item subscription_domain $gSubscriptionDomain
193 Domain where subscriptions to package lists happen
198 set_default(\%config,'subscription_domain',undef);
205 =head2 Project Identification
209 =item project $gProject
217 set_default(\%config,'project','Something');
219 =item project_title $gProjectTitle
221 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
223 Default: "$config{project} Debbugs Install"
227 set_default(\%config,'project_title',"$config{project} Debbugs Install");
229 =item maintainer $gMaintainer
231 Name of the maintainer of this debbugs install
233 Default: 'Local DebBugs Owner's
237 set_default(\%config,'maintainer','Local DebBugs Owner');
239 =item maintainer_webpage $gMaintainerWebpage
241 Webpage of the maintainer of this install of debbugs
243 Default: "$config{web_domain}/~owner"
247 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
249 =item maintainer_email
251 Email address of the maintainer of this Debbugs install
253 Default: 'root@'.$config{email_domain}
257 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
259 =item unknown_maintainer_email
261 Email address where packages with an unknown maintainer will be sent
263 Default: $config{maintainer_email}
269 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
271 =head2 BTS Mailing Lists
298 set_default(\%config, 'submit_list', 'bug-submit-list');
299 set_default(\%config, 'maint_list', 'bug-maint-list');
300 set_default(\%config, 'quiet_list', 'bug-quiet-list');
301 set_default(\%config, 'forward_list', 'bug-forward-list');
302 set_default(\%config, 'done_list', 'bug-done-list');
303 set_default(\%config, 'request_list', 'bug-request-list');
304 set_default(\%config,'submitter_list','bug-submitter-list');
305 set_default(\%config, 'control_list', 'bug-control-list');
306 set_default(\%config, 'summary_list', 'bug-summary-list');
307 set_default(\%config, 'mirror_list', 'bug-mirror-list');
308 set_default(\%config, 'strong_list', 'bug-strong-list');
316 set_default(\%config,'mailer','exim');
317 set_default(\%config,'bug','bug');
318 set_default(\%config,'bugs','bugs');
322 Age at which bugs are archived/removed
328 set_default(\%config,'remove_age',28);
332 Whether old bugs are saved or deleted
338 set_default(\%config,'save_old_bugs',1);
340 =item distribution_aliases
342 Map of distribution aliases to the distribution name
345 {experimental => 'experimental',
346 unstable => 'unstable',
347 testing => 'testing',
349 oldstable => 'oldstable',
353 sarge => 'oldstable',
358 set_default(\%config,'distribution_aliases',
359 {experimental => 'experimental',
360 unstable => 'unstable',
361 testing => 'testing',
363 oldstable => 'oldstable',
367 sarge => 'oldstable',
375 List of valid distributions
377 Default: The values of the distribution aliases map.
381 my %_distributions_default;
382 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
383 set_default(\%config,'distributions',[keys %_distributions_default]);
385 =item removal_distribution_tags
387 Tags which specifiy distributions to check
389 Default: @{$config{distributions}}
393 set_default(\%config,'removal_distribution_tags',
394 [@{$config{distributions}}]);
396 =item removal_default_distribution_tags
398 For removal/archival purposes, all bugs are assumed to have these tags
401 Default: qw(unstable testing);
405 set_default(\%config,'removal_default_distribution_tags',
406 [qw(unstable testing)]
409 =item removal_strong_severity_default_distribution_tags
411 For removal/archival purposes, all bugs with strong severity are
412 assumed to have these tags set.
414 Default: qw(unstable testing stable);
418 set_default(\%config,'removal_strong_severity_default_distribution_tags',
419 [qw(unstable testing stable)]
423 =item removal_architectures
425 For removal/archival purposes, these architectures are consulted if
426 there is more than one architecture applicable. If the bug is in a
427 package not in any of these architectures, the architecture actually
428 checked is undefined.
430 Default: qw(i386 amd64 arm ppc sparc alpha);
434 set_default(\%config,'removal_architectures',
435 [qw(i386 amd64 arm ppc sparc alpha)]
439 =item package_name_re
441 The regex which will match a package name
443 Default: '[a-z0-9][a-z0-9\.+-]+'
447 set_default(\%config,'package_name_re',
448 '[a-z0-9][a-z0-9\.+-]+');
450 =item package_version_re
452 The regex which will match a package version
454 Default: '[A-Za-z0-9:+\.-]+'
458 set_default(\%config,'package_version_re',
459 '[A-Za-z0-9:+\.~-]+');
462 =item control_internal_requester
464 This address is used by Debbugs::Control as the request address which
465 sent a control request for faked log messages.
467 Default:"Debbugs Internal Request <$config{maintainer_email}>"
471 set_default(\%config,'control_internal_requester',
472 "Debbugs Internal Request <$config{maintainer_email}>",
475 =item control_internal_request_addr
477 This address is used by Debbugs::Control as the address to which a
478 faked log message request was sent.
480 Default: "internal_control\@$config{email_domain}";
484 set_default(\%config,'control_internal_request_addr',
485 'internal_control@'.$config{email_domain},
489 =item exclude_from_control
491 Addresses which are not allowed to send messages to control
495 set_default(\%config,'exclude_from_control',[]);
500 set_default(\%config,'default_severity','normal');
501 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
502 set_default(\%config,'strong_severities',[qw(critical grave)]);
503 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
504 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
505 grave => "Grave $config{bugs}",
506 normal => "Normal $config{bugs}",
507 wishlist => "Wishlist $config{bugs}",
510 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
511 @{$config{distributions}}
514 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
515 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
516 '^mail.*agent|^tcpmail|^bitmail|^mailman');
518 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
519 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
520 set_default(\%config,'incoming_dir','incoming');
521 set_default(\%config,'web_dir','/var/lib/debbugs/www');
522 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
523 set_default(\%config,'lib_path','/usr/lib/debbugs');
525 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
526 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
527 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maint');
528 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
529 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
532 =item version_packages_dir
534 Location where the version package information is kept; defaults to
535 spool_dir/../versions/pkg
539 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
541 =item version_time_index
543 Location of the version/time index file. Defaults to
544 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
545 exists; otherwise defaults to undef.
550 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
554 Location of the version index file. Defaults to
555 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
556 exists; otherwise defaults to undef.
560 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
562 =item binary_source_map
564 Location of the binary -> source map. Defaults to
565 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
566 exists; otherwise defaults to undef.
570 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
572 =item source_binary_map
574 Location of the source -> binary map. Defaults to
575 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
576 exists; otherwise defaults to undef.
580 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
584 set_default(\%config,'post_processall',[]);
588 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
592 set_default(\%config,'sendmail','/usr/lib/sendmail');
596 Whether or not spamscan is being used; defaults to 0 (not being used
600 set_default(\%config,'spam_scan',0);
608 The following are the only text fields in general use in the scripts;
609 a few additional text fields are defined in text.in, but are only used
610 in db2html and a few other specialty scripts.
612 Earlier versions of debbugs defined these values in /etc/debbugs/text,
613 but now they are required to be in the configuration file. [Eventually
614 the longer ones will move out into a fully fledged template system.]
620 =item bad_email_prefix
622 This prefixes the text of all lines in a bad e-mail message ack.
626 set_default(\%config,'bad_email_prefix','');
629 =item text_instructions
631 This gives more information about bad e-mails to receive.in
635 set_default(\%config,'text_instructions',$config{bad_email_prefix});
639 This shows up at the end of (most) html pages
643 set_default(\%config,'html_tail',<<END);
644 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
650 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
651 Copyright (C) 1999 Darren O. Benham,
652 1997,2003 nCipher Corporation Ltd,
658 =item html_expire_note
660 This message explains what happens to archive/remove-able bugs
664 set_default(\%config,'html_expire_note',
665 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
673 my ($conf_file) = @_;
674 # first, figure out what type of file we're reading in.
675 my $fh = new IO::File $conf_file,'r'
676 or die "Unable to open configuration file $conf_file for reading: $!";
677 # A new version configuration file must have a comment as its first line
678 my $first_line = <$fh>;
679 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
680 if (defined $version) {
683 die "Version 1 configuration files not implemented yet";
686 die "Version $version configuration files are not supported";
690 # Ugh. Old configuration file
691 # What we do here is we create a new Safe compartment
692 # so fucked up crap in the config file doesn't sink us.
693 my $cpt = new Safe or die "Unable to create safe compartment";
694 # perldoc Opcode; for details
695 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
696 $cpt->reval(qq(require '$conf_file';));
697 die "Error in configuration file: $@" if $@;
698 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
699 # we want to glob in from the configuration file
700 for my $variable (@{$EXPORT_TAGS{globals}}) {
701 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
702 my $var_glob = $cpt->varglob($glob_name);
703 my $value; #= $cpt->reval("return $variable");
704 # print STDERR "$variable $value",qq(\n);
705 if (defined $var_glob) {{
707 if ($glob_type eq '%') {
708 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
710 elsif ($glob_type eq '@') {
711 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
714 $value = ${*{$var_glob}};
716 # We punt here, because we can't tell if the value was
717 # defined intentionally, or if it was just left alone;
718 # this tries to set sane defaults.
719 set_default(\%config,$hash_name,$value) if defined $value;
727 my $hash_name = $variable;
728 $hash_name =~ s/^([\$\%\@])g//;
730 my $glob_name = 'g'.$hash_name;
731 $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
732 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
733 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
734 return $hash_name unless wantarray;
735 return ($hash_name,$glob_name,$glob_type);
740 # sets the configuration hash to the default value if it's not set,
741 # otherwise doesn't do anything
742 # If $USING_GLOBALS, then sets an appropriate global.
745 my ($config,$option,$value) = @_;
747 if ($USING_GLOBALS) {
748 # fix up the variable name
749 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
750 # Fix stupid HTML names
751 $varname =~ s/(Html|Cgi)/uc($1)/ge;
753 # update the configuration value
754 if (not $USING_GLOBALS and not exists $config->{$option}) {
755 $config->{$option} = $value;
757 elsif ($USING_GLOBALS) {{
759 # Need to check if a value has already been set in a global
760 if (defined *{"Debbugs::Config::${varname}"}) {
761 $config->{$option} = *{"Debbugs::Config::${varname}"};
764 $config->{$option} = $value;
767 if ($USING_GLOBALS) {{
769 *{"Debbugs::Config::${varname}"} = $config->{$option};
776 # All we care about here is whether we've been called with the globals or text option;
777 # if so, then we need to export some symbols back up.
778 # In any event, we call exporter.
781 if (grep /^:(?:text|globals)$/, @_) {
783 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
786 # Yes, I don't care if these are only used once
788 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
790 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
791 $tmp =~ s/^[\%\$\@]//;
792 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
795 Debbugs::Config->export_to_level(1,@_);