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),
67 qw(@gDefaultArchitectures),
71 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
73 config => [qw(%config)],
76 Exporter::export_ok_tags(qw(globals text config));
77 $EXPORT_TAGS{all} = [@EXPORT_OK];
80 use File::Basename qw(dirname);
84 =head1 CONFIGURATION VARIABLES
86 =head2 General Configuration
94 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
95 # This enables us to test things that are -T.
96 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
97 if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
98 $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
99 $ENV{DEBBUGS_CONFIG_FILE} = $1;
102 die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
105 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
107 =item email_domain $gEmailDomain
109 The email domain of the bts
113 set_default(\%config,'email_domain','bugs.something');
115 =item list_domain $gListDomain
117 The list domain of the bts, defaults to the email domain
121 set_default(\%config,'list_domain',$config{email_domain});
123 =item web_host $gWebHost
125 The web host of the bts; defaults to the email domain
129 set_default(\%config,'web_host',$config{email_domain});
131 =item web_host_bug_dir $gWebHostDir
133 The directory of the web host on which bugs are kept, defaults to C<''>
137 set_default(\%config,'web_host_bug_dir','');
139 =item web_domain $gWebDomain
141 Full path of the web domain where bugs are kept, defaults to the
142 concatenation of L</web_host> and L</web_host_bug_dir>
146 set_default(\%config,'web_domain',$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
148 =item html_suffix $gHTMLSuffix
150 Suffix of html pages, defaults to .html
154 set_default(\%config,'html_suffix','.html');
156 =item cgi_domain $gCGIDomain
158 Full path of the web domain where cgi scripts are kept. Defaults to
159 the concatentation of L</web_host> and cgi.
163 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
165 =item mirrors @gMirrors
167 List of mirrors [What these mirrors are used for, no one knows.]
172 set_default(\%config,'mirrors',[]);
174 =item package_pages $gPackagePages
176 Domain where the package pages are kept; links should work in a
177 package_pages/foopackage manner. Defaults to undef, which means that
178 package links will not be made.
183 set_default(\%config,'package_pages',undef);
185 =item package_pages $gUsertagPackageDomain
187 Domain where where usertags of packages belong; defaults to $gPackagePages
191 set_default(\%config,'usertag_package_domain',$config{package_pages});
194 =item subscription_domain $gSubscriptionDomain
196 Domain where subscriptions to package lists happen
201 set_default(\%config,'subscription_domain',undef);
208 =head2 Project Identification
212 =item project $gProject
220 set_default(\%config,'project','Something');
222 =item project_title $gProjectTitle
224 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
226 Default: "$config{project} Debbugs Install"
230 set_default(\%config,'project_title',"$config{project} Debbugs Install");
232 =item maintainer $gMaintainer
234 Name of the maintainer of this debbugs install
236 Default: 'Local DebBugs Owner's
240 set_default(\%config,'maintainer','Local DebBugs Owner');
242 =item maintainer_webpage $gMaintainerWebpage
244 Webpage of the maintainer of this install of debbugs
246 Default: "$config{web_domain}/~owner"
250 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
252 =item maintainer_email $gMaintainerEmail
254 Email address of the maintainer of this Debbugs install
256 Default: 'root@'.$config{email_domain}
260 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
262 =item unknown_maintainer_email
264 Email address where packages with an unknown maintainer will be sent
266 Default: $config{maintainer_email}
272 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
274 =head2 BTS Mailing Lists
301 set_default(\%config, 'submit_list', 'bug-submit-list');
302 set_default(\%config, 'maint_list', 'bug-maint-list');
303 set_default(\%config, 'quiet_list', 'bug-quiet-list');
304 set_default(\%config, 'forward_list', 'bug-forward-list');
305 set_default(\%config, 'done_list', 'bug-done-list');
306 set_default(\%config, 'request_list', 'bug-request-list');
307 set_default(\%config,'submitter_list','bug-submitter-list');
308 set_default(\%config, 'control_list', 'bug-control-list');
309 set_default(\%config, 'summary_list', 'bug-summary-list');
310 set_default(\%config, 'mirror_list', 'bug-mirror-list');
311 set_default(\%config, 'strong_list', 'bug-strong-list');
319 set_default(\%config,'mailer','exim');
320 set_default(\%config,'bug','bug');
321 set_default(\%config,'bugs','bugs');
325 Age at which bugs are archived/removed
331 set_default(\%config,'remove_age',28);
335 Whether old bugs are saved or deleted
341 set_default(\%config,'save_old_bugs',1);
343 =item distribution_aliases
345 Map of distribution aliases to the distribution name
348 {experimental => 'experimental',
349 unstable => 'unstable',
350 testing => 'testing',
352 oldstable => 'oldstable',
356 sarge => 'oldstable',
361 set_default(\%config,'distribution_aliases',
362 {experimental => 'experimental',
363 unstable => 'unstable',
364 testing => 'testing',
366 oldstable => 'oldstable',
370 sarge => 'oldstable',
378 List of valid distributions
380 Default: The values of the distribution aliases map.
384 my %_distributions_default;
385 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
386 set_default(\%config,'distributions',[keys %_distributions_default]);
389 =item default_architectures
391 List of default architectures to use when architecture(s) are not
394 Default: i386 amd64 arm ppc sparc alpha
398 set_default(\%config,'default_architectures',
399 [qw(i386 amd64 arm powerpc sparc alpha)]
402 =item removal_distribution_tags
404 Tags which specifiy distributions to check
406 Default: @{$config{distributions}}
410 set_default(\%config,'removal_distribution_tags',
411 [@{$config{distributions}}]);
413 =item removal_default_distribution_tags
415 For removal/archival purposes, all bugs are assumed to have these tags
418 Default: qw(unstable testing);
422 set_default(\%config,'removal_default_distribution_tags',
423 [qw(unstable testing)]
426 =item removal_strong_severity_default_distribution_tags
428 For removal/archival purposes, all bugs with strong severity are
429 assumed to have these tags set.
431 Default: qw(unstable testing stable);
435 set_default(\%config,'removal_strong_severity_default_distribution_tags',
436 [qw(unstable testing stable)]
440 =item removal_architectures
442 For removal/archival purposes, these architectures are consulted if
443 there is more than one architecture applicable. If the bug is in a
444 package not in any of these architectures, the architecture actually
445 checked is undefined.
447 Default: value of default_architectures
451 set_default(\%config,'removal_architectures',
452 $config{default_architectures},
456 =item package_name_re
458 The regex which will match a package name
460 Default: '[a-z0-9][a-z0-9\.+-]+'
464 set_default(\%config,'package_name_re',
465 '[a-z0-9][a-z0-9\.+-]+');
467 =item package_version_re
469 The regex which will match a package version
471 Default: '[A-Za-z0-9:+\.-]+'
476 set_default(\%config,'package_version_re',
477 '[A-Za-z0-9:+\.~-]+');
480 =item default_package
482 This is the name of the default package. If set, bugs assigned to
483 packages without a maintainer and bugs missing a Package: psuedoheader
484 will be assigned to this package instead.
486 Defaults to unset, which is the traditional debbugs behavoir
490 set_default(\%config,'default_package',
495 =item control_internal_requester
497 This address is used by Debbugs::Control as the request address which
498 sent a control request for faked log messages.
500 Default:"Debbugs Internal Request <$config{maintainer_email}>"
504 set_default(\%config,'control_internal_requester',
505 "Debbugs Internal Request <$config{maintainer_email}>",
508 =item control_internal_request_addr
510 This address is used by Debbugs::Control as the address to which a
511 faked log message request was sent.
513 Default: "internal_control\@$config{email_domain}";
517 set_default(\%config,'control_internal_request_addr',
518 'internal_control@'.$config{email_domain},
522 =item exclude_from_control
524 Addresses which are not allowed to send messages to control
528 set_default(\%config,'exclude_from_control',[]);
533 set_default(\%config,'default_severity','normal');
534 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
535 set_default(\%config,'strong_severities',[qw(critical grave)]);
536 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
537 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
538 grave => "Grave $config{bugs}",
539 normal => "Normal $config{bugs}",
540 wishlist => "Wishlist $config{bugs}",
543 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
544 @{$config{distributions}}
547 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
548 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
549 '^mail.*agent|^tcpmail|^bitmail|^mailman');
551 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
552 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
553 set_default(\%config,'incoming_dir','incoming');
554 set_default(\%config,'web_dir','/var/lib/debbugs/www');
555 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
556 set_default(\%config,'lib_path','/usr/lib/debbugs');
561 directory of templates; defaults to /usr/share/debbugs/templates.
565 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
568 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
569 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
570 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maint');
571 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
572 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
575 =item version_packages_dir
577 Location where the version package information is kept; defaults to
578 spool_dir/../versions/pkg
582 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
584 =item version_time_index
586 Location of the version/time index file. Defaults to
587 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
588 exists; otherwise defaults to undef.
593 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
597 Location of the version index file. Defaults to
598 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
599 exists; otherwise defaults to undef.
603 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
605 =item binary_source_map
607 Location of the binary -> source map. Defaults to
608 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
609 exists; otherwise defaults to undef.
613 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
615 =item source_binary_map
617 Location of the source -> binary map. Defaults to
618 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
619 exists; otherwise defaults to undef.
623 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
627 set_default(\%config,'post_processall',[]);
631 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
635 set_default(\%config,'sendmail','/usr/lib/sendmail');
639 Whether or not spamscan is being used; defaults to 0 (not being used
643 set_default(\%config,'spam_scan',0);
651 The following are the only text fields in general use in the scripts;
652 a few additional text fields are defined in text.in, but are only used
653 in db2html and a few other specialty scripts.
655 Earlier versions of debbugs defined these values in /etc/debbugs/text,
656 but now they are required to be in the configuration file. [Eventually
657 the longer ones will move out into a fully fledged template system.]
663 =item bad_email_prefix
665 This prefixes the text of all lines in a bad e-mail message ack.
669 set_default(\%config,'bad_email_prefix','');
672 =item text_instructions
674 This gives more information about bad e-mails to receive.in
678 set_default(\%config,'text_instructions',$config{bad_email_prefix});
682 This shows up at the end of (most) html pages
686 set_default(\%config,'html_tail',<<END);
687 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
693 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
694 Copyright (C) 1999 Darren O. Benham,
695 1997,2003 nCipher Corporation Ltd,
701 =item html_expire_note
703 This message explains what happens to archive/remove-able bugs
707 set_default(\%config,'html_expire_note',
708 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
716 my ($conf_file) = @_;
717 # first, figure out what type of file we're reading in.
718 my $fh = new IO::File $conf_file,'r'
719 or die "Unable to open configuration file $conf_file for reading: $!";
720 # A new version configuration file must have a comment as its first line
721 my $first_line = <$fh>;
722 my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
723 if (defined $version) {
726 die "Version 1 configuration files not implemented yet";
729 die "Version $version configuration files are not supported";
733 # Ugh. Old configuration file
734 # What we do here is we create a new Safe compartment
735 # so fucked up crap in the config file doesn't sink us.
736 my $cpt = new Safe or die "Unable to create safe compartment";
737 # perldoc Opcode; for details
738 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
739 $cpt->reval(qq(require '$conf_file';));
740 die "Error in configuration file: $@" if $@;
741 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
742 # we want to glob in from the configuration file
743 for my $variable (@{$EXPORT_TAGS{globals}}) {
744 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
745 my $var_glob = $cpt->varglob($glob_name);
746 my $value; #= $cpt->reval("return $variable");
747 # print STDERR "$variable $value",qq(\n);
748 if (defined $var_glob) {{
750 if ($glob_type eq '%') {
751 $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
753 elsif ($glob_type eq '@') {
754 $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
757 $value = ${*{$var_glob}};
759 # We punt here, because we can't tell if the value was
760 # defined intentionally, or if it was just left alone;
761 # this tries to set sane defaults.
762 set_default(\%config,$hash_name,$value) if defined $value;
770 my $hash_name = $variable;
771 $hash_name =~ s/^([\$\%\@])g//;
773 my $glob_name = 'g'.$hash_name;
774 $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
775 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
776 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
777 return $hash_name unless wantarray;
778 return ($hash_name,$glob_name,$glob_type);
783 # sets the configuration hash to the default value if it's not set,
784 # otherwise doesn't do anything
785 # If $USING_GLOBALS, then sets an appropriate global.
788 my ($config,$option,$value) = @_;
790 if ($USING_GLOBALS) {
791 # fix up the variable name
792 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
793 # Fix stupid HTML names
794 $varname =~ s/(Html|Cgi)/uc($1)/ge;
796 # update the configuration value
797 if (not $USING_GLOBALS and not exists $config->{$option}) {
798 $config->{$option} = $value;
800 elsif ($USING_GLOBALS) {{
802 # Need to check if a value has already been set in a global
803 if (defined *{"Debbugs::Config::${varname}"}) {
804 $config->{$option} = *{"Debbugs::Config::${varname}"};
807 $config->{$option} = $value;
810 if ($USING_GLOBALS) {{
812 *{"Debbugs::Config::${varname}"} = $config->{$option};
819 # All we care about here is whether we've been called with the globals or text option;
820 # if so, then we need to export some symbols back up.
821 # In any event, we call exporter.
824 if (grep /^:(?:text|globals)$/, @_) {
826 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
829 # Yes, I don't care if these are only used once
831 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
833 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
834 $tmp =~ s/^[\%\$\@]//;
835 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
838 Debbugs::Config->export_to_level(1,@_);