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),
46 qw($gSummaryList $gMirrorList $gMailer $gBug),
47 qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
48 qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
49 qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
50 qw($gMaintainerFileOverride $gPseudoDescFile $gPackageSource),
51 qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
52 qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
55 text => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
57 config => [qw(%config)],
60 Exporter::export_ok_tags(qw(globals text config));
61 $EXPORT_TAGS{all} = [@EXPORT_OK];
64 use File::Basename qw(dirname);
68 =head1 CONFIGURATION VARIABLES
70 =head2 General Configuration
78 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
80 =item email_domain $gEmailDomain
82 The email domain of the bts
86 set_default(\%config,'email_domain','bugs.something');
88 =item list_domain $gListDomain
90 The list domain of the bts, defaults to the email domain
94 set_default(\%config,'list_domain',$config{email_domain});
96 =item web_host $gWebHost
98 The web host of the bts; defaults to the email domain
102 set_default(\%config,'web_host',$config{email_domain});
104 =item web_host_bug_dir $gWebHostDir
106 The directory of the web host on which bugs are kept, defaults to C<''>
110 set_default(\%config,'web_host_bug_dir','');
112 =item web_domain $gWebDomain
114 Full path of the web domain where bugs are kept, defaults to the
115 concatenation of L</web_host> and L</web_host_bug_dir>
119 set_default(\%config,'web_domain',$config{web_host}.'/'.$config{web_host_bug_dir});
121 =item html_suffix $gHTMLSuffix
123 Suffix of html pages, defaults to .html
127 set_default(\%config,'html_suffix','.html');
129 =item cgi_domain $gCGIDomain
131 Full path of the web domain where cgi scripts are kept. Defaults to
132 the concatentation of L</web_host> and cgi.
136 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
138 =item mirrors @gMirrors
140 List of mirrors [What these mirrors are used for, no one knows.]
145 set_default(\%config,'mirrors',[]);
147 =item package_pages $gPackagePages
149 Domain where the package pages are kept; links should work in a
150 package_pages/foopackage manner. Defaults to undef, which means that
151 package links will not be made.
156 set_default(\%config,'package_pages',undef);
158 =item subscription_domain $gSubscriptionDomain
160 Domain where subscriptions to package lists happen
165 set_default(\%config,'subscription_domain',undef);
172 =head2 Project Identification
176 =item project $gProject
184 set_default(\%config,'project','Something');
186 =item project_title $gProjectTitle
188 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
190 Default: "$config{project} Debbugs Install"
194 set_default(\%config,'project_title',"$config{project} Debbugs Install");
196 =item maintainer $gMaintainer
198 Name of the maintainer of this debbugs install
200 Default: 'Local DebBugs Owner's
204 set_default(\%config,'maintainer','Local DebBugs Owner');
206 =item maintainer_webpage $gMaintainerWebpage
208 Webpage of the maintainer of this install of debbugs
210 Default: "$config{web_domain}/~owner"
214 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
216 =item maintainer_email
218 Email address of the maintainer of this Debbugs install
220 Default: 'root@'.$config{email_domain}
224 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
226 =item unknown_maintainer_email
228 Email address where packages with an unknown maintainer will be sent
230 Default: $config{maintainer_email}
236 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
238 =head2 BTS Mailing Lists
265 set_default(\%config, 'submit_list', 'bug-submit-list');
266 set_default(\%config, 'maint_list', 'bug-maint-list');
267 set_default(\%config, 'quiet_list', 'bug-quiet-list');
268 set_default(\%config, 'forward_list', 'bug-forward-list');
269 set_default(\%config, 'done_list', 'bug-done-list');
270 set_default(\%config, 'request_list', 'bug-request-list');
271 set_default(\%config,'submitter_list','bug-submitter-list');
272 set_default(\%config, 'control_list', 'bug-control-list');
273 set_default(\%config, 'summary_list', 'bug-summary-list');
274 set_default(\%config, 'mirror_list', 'bug-mirror-list');
282 set_default(\%config,'mailer','exim');
283 set_default(\%config,'bug','bug');
284 set_default(\%config,'bugs','bugs');
288 Age at which bugs are archived/removed
294 set_default(\%config,'remove_age',28);
298 Whether old bugs are saved or deleted
304 set_default(\%config,'save_old_bugs',1);
308 List of valid distributions
310 Default: qw(experimental unstable testing stable oldstable);
314 set_default(\%config,'distributions',[qw(experimental unstable testing stable oldstable)]);
316 =item removal_distribution_tags
318 Tags which specifiy distributions to check
320 Default: @{$config{distributions}}
324 set_default(\%config,'removal_distribution_tags',
325 [@{$config{distributions}}]);
327 =item removal_default_distribution_tags
329 For removal/archival purposes, all bugs are assumed to have these tags
332 Default: qw(unstable testing);
336 set_default(\%config,'removal_default_distribution_tags',
337 [qw(unstable testing)]
340 set_default(\%config,'default_severity','normal');
341 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
342 set_default(\%config,'strong_severities',[qw(critical grave)]);
343 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
344 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
345 grave => "Grave $config{bugs}",
346 normal => "Normal $config{bugs}",
347 wishlist => "Wishlist $config{bugs}",
350 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
351 @{$config{distributions}}
354 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
355 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
356 '^mail.*agent|^tcpmail|^bitmail|^mailman');
358 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
359 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
360 set_default(\%config,'incoming_dir','incoming');
361 set_default(\%config,'web_dir','/var/lib/debbugs/www');
362 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
364 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
365 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
366 set_default(\%config,'pseduo_desc_file',$config{config_dir}.'/pseudo-packages.description');
367 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
369 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
376 The following are the only text fields in general use in the scripts;
377 a few additional text fields are defined in text.in, but are only used
378 in db2html and a few other specialty scripts.
380 Earlier versions of debbugs defined these values in /etc/debbugs/text,
381 but now they are required to be in the configuration file. [Eventually
382 the longer ones will move out into a fully fledged template system.]
388 =item bad_email_prefix
390 This prefixes the text of all lines in a bad e-mail message ack.
394 set_default(\%config,'bad_email_prefix','');
398 This shows up at the end of (most) html pages
402 set_default(\%config,'html_tail',<<END);
403 <ADDRESS>$config{maintainer} <<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>>.
409 <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
410 Copyright (C) 1999 Darren O. Benham,
411 1997,2003 nCipher Corporation Ltd,
417 =item html_expire_note
419 This message explains what happens to archive/remove-able bugs
423 set_default(\%config,'html_expire_note',
424 "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
432 my ($conf_file) = @_;
433 # first, figure out what type of file we're reading in.
434 my $fh = new IO::File $conf_file,'r'
435 or die "Unable to open configuration file $conf_file for reading: $!";
436 # A new version configuration file must have a comment as its first line
437 my $first_line = <$fh>;
438 my ($version) = $first_line =~ /VERSION:\s*(\d+)/i;
439 if (defined $version) {
442 die "Version 1 configuration files not implemented yet";
445 die "Version $version configuration files are not supported";
449 # Ugh. Old configuration file
450 # What we do here is we create a new Safe compartment
451 # so fucked up crap in the config file doesn't sink us.
452 my $cpt = new Safe or die "Unable to create safe compartment";
453 # perldoc Opcode; for details
454 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
455 $cpt->reval(q($gMaintainerFile = 'FOOOO'));
456 $cpt->reval(qq(require '$conf_file';));
457 die "Error in configuration file: $@" if $@;
458 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
459 # we want to glob in from the configuration file
460 for my $variable (@{$EXPORT_TAGS{globals}}) {
461 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
462 my $var_glob = $cpt->varglob($glob_name);
463 my $value; #= $cpt->reval("return $variable");
464 #print STDERR $value,qq(\n);
465 if (defined $var_glob) {{
467 if ($glob_type eq '%') {
468 $value = {%{*{$var_glob}}};
470 elsif ($glob_type eq '@') {
471 $value = [@{*{$var_glob}}];
474 $value = ${*{$var_glob}};
476 # We punt here, because we can't tell if the value was
477 # defined intentionally, or if it was just left alone;
478 # this tries to set sane defaults.
479 set_default(\%config,$hash_name,$value) if defined $value;
487 my $hash_name = $variable;
488 $hash_name =~ s/^([\$\%\@])g//;
490 my $glob_name = 'g'.$hash_name;
491 $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
492 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
493 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
494 return $hash_name unless wantarray;
495 return ($hash_name,$glob_name,$glob_type);
500 # sets the configuration hash to the default value if it's not set,
501 # otherwise doesn't do anything
502 # If $USING_GLOBALS, then sets an appropriate global.
505 my ($config,$option,$value) = @_;
507 if ($USING_GLOBALS) {
508 # fix up the variable name
509 $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
510 # Fix stupid HTML names
511 $varname =~ s/(Html|Cgi)/uc($1)/ge;
513 # update the configuration value
514 if (not $USING_GLOBALS and not exists $config{$option}) {
515 $config{$option} = $value;
517 elsif ($USING_GLOBALS) {{
519 # Need to check if a value has already been set in a global
520 if (defined *{"Debbugs::Config::${varname}"}) {
521 $config{$option} = *{"Debbugs::Config::${varname}"};
524 if ($USING_GLOBALS) {{
526 *{"Debbugs::Config::${varname}"} = $config{$option};
533 # All we care about here is whether we've been called with the globals or text option;
534 # if so, then we need to export some symbols back up.
535 # In any event, we call exporter.
538 if (grep /^:(?:text|globals)$/, @_) {
540 for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
543 # Yes, I don't care if these are only used once
545 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
547 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
548 $tmp =~ s/^[\%\$\@]//;
549 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
552 Debbugs::Config->export_to_level(1,@_);