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 config => [qw(%config)],
58 Exporter::export_ok_tags(qw(globals config));
59 $EXPORT_TAGS{all} = [@EXPORT_OK];
62 use File::Basename qw(dirname);
66 =head1 CONFIGURATION VARIABLES
68 =head2 General Configuration
76 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
80 The email domain of the bts
84 set_default(\%config,'email_domain','bugs.something');
88 The list domain of the bts, defaults to the email domain
92 set_default(\%config,'list_domain',$config{email_domain});
96 The web host of the bts; defaults to the email domain
100 set_default(\%config,'web_host',$config{email_domain});
102 =item web_host_bug_dir
104 The directory of the web host on which bugs are kept, defaults to C<''>
108 set_default(\%config,'web_host_bug_dir','');
112 Full path of the web domain where bugs are kept, defaults to the
113 concatenation of L</web_host> and L</web_host_bug_dir>
117 set_default(\%config,'web_domain',$config{web_host}.'/'.$config{web_host_bug_dir});
121 Suffix of html pages, defaults to .html
125 set_default(\%config,'html_suffix','.html');
129 Full path of the web domain where cgi scripts are kept. Defaults to
130 the concatentation of L</web_host> and cgi.
134 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
138 List of mirrors [What these mirrors are used for, no one knows.]
143 set_default(\%config,'mirrors',[]);
147 Domain where the package pages are kept; links should work in a
148 package_pages/foopackage manner. Defaults to undef, which means that
149 package links will not be made.
154 set_default(\%config,'package_pages',undef);
156 =item subscription_domain
158 Domain where subscriptions to package lists happen
163 set_default(\%config,'subscription_domain',undef);
170 =head2 Project Identification
180 set_default(\%config,'project','Something');
184 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
188 set_default(\%config,'project_title',"$config{project} Debbugs Install");
192 Name of the maintainer of this debbugs install
196 set_default(\%config,'maintainer','Local DebBugs Owner');
198 =item maintainer_webpage
200 Webpage of the maintainer of this install of debbugs
204 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
206 =item maintainer_email
208 Email address of the maintainer of this Debbugs install
212 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
214 =item unknown_maintainer_email
216 Email address where packages with an unknown maintainer will be sent
220 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
222 =head2 BTS Mailing Lists
249 set_default(\%config, 'submit_list', 'bug-submit-list');
250 set_default(\%config, 'maint_list', 'bug-maint-list');
251 set_default(\%config, 'quiet_list', 'bug-quiet-list');
252 set_default(\%config, 'forward_list', 'bug-forward-list');
253 set_default(\%config, 'done_list', 'bug-done-list');
254 set_default(\%config, 'request_list', 'bug-request-list');
255 set_default(\%config,'submitter_list','bug-submitter-list');
256 set_default(\%config, 'control_list', 'bug-control-list');
257 set_default(\%config, 'summary_list', 'bug-summary-list');
258 set_default(\%config, 'mirror_list', 'bug-mirror-list');
264 set_default(\%config,'mailer','exim');
265 set_default(\%config,'bug','bug');
266 set_default(\%config,'bugs','bugs');
267 set_default(\%config,'remove_age',28);
269 set_default(\%config,'save_old_bugs',1);
271 set_default(\%config,'default_severity','normal');
272 set_default(\%config,'show_severities','critical, grave, normal, minor, wishlist');
273 set_default(\%config,'strong_severities',[qw(critical grave)]);
274 set_default(\%config,'severity_list',[qw(critical grave normal wishlist)]);
275 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
276 grave => "Grave $config{bugs}",
277 normal => "Normal $config{bugs}",
278 wishlist => "Wishlist $config{bugs}",
281 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed stable)]);
283 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
284 '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
285 '^mail.*agent|^tcpmail|^bitmail|^mailman');
287 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
288 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
289 set_default(\%config,'incoming_dir','incoming');
290 set_default(\%config,'web_dir','/var/lib/debbugs/www');
291 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
293 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
294 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
295 set_default(\%config,'pseduo_desc_file',$config{config_dir}.'/pseudo-packages.description');
296 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
298 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
299 #set_default(\%config,'version_packages_dir',$config{spool_dir}'/../versions/pkg');
303 my ($conf_file) = @_;
304 # first, figure out what type of file we're reading in.
305 my $fh = new IO::File $conf_file,'r'
306 or die "Unable to open configuration file $conf_file for reading: $!";
307 # A new version configuration file must have a comment as its first line
308 my $first_line = <$fh>;
309 my ($version) = $first_line =~ /VERSION:\s*(\d+)/i;
310 if (defined $version) {
313 die "Version 1 configuration files not implemented yet";
316 die "Version $version configuration files are not supported";
320 # Ugh. Old configuration file
321 # What we do here is we create a new Safe compartment
322 # so fucked up crap in the config file doesn't sink us.
323 my $cpt = new Safe or die "Unable to create safe compartment";
324 # perldoc Opcode; for details
325 $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
326 $cpt->reval(q($gMaintainerFile = 'FOOOO'));
327 $cpt->reval(qq(require '$conf_file';));
328 die "Error in configuration file: $@" if $@;
329 # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
330 # we want to glob in from the configuration file
331 for my $variable (@{$EXPORT_TAGS{globals}}) {
332 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
333 my $var_glob = $cpt->varglob($glob_name);
334 my $value; #= $cpt->reval("return $variable");
335 #print STDERR $value,qq(\n);
336 if (defined $var_glob) {{
338 if ($glob_type eq '%') {
339 $value = {%{*{$var_glob}}};
341 elsif ($glob_type eq '@') {
342 $value = [@{*{$var_glob}}];
345 $value = ${*{$var_glob}};
347 # We punt here, because we can't tell if the value was
348 # defined intentionally, or if it was just left alone;
349 # this tries to set sane defaults.
350 set_default(\%config,$hash_name,$value) if defined $value;
358 my $hash_name = $variable;
359 $hash_name =~ s/^([\$\%\@])g//;
361 my $glob_name = 'g'.$hash_name;
362 $hash_name =~ s/^([A-Z]+)/lc($1)/e;
363 $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
364 return $hash_name unless wantarray;
365 return ($hash_name,$glob_name,$glob_type);
370 # sets the configuration hash to the default value if it's not set,
371 # otherwise doesn't do anything
372 # If $USING_GLOBALS, then sets an appropriate global.
375 my ($config,$option,$value) = @_;
376 # update the configuration value
377 if (not $USING_GLOBALS and not exists $config{$option}) {
378 $config{$option} = $value;
381 # Need to check if a value has already been set in a global
383 if ($USING_GLOBALS) {{
384 # fix up the variable name
385 my $varname = 'g'.join('',map {ucfirst $_} $option);
386 # Fix stupid HTML names
387 $varname =~ s/Html/HTML/;
389 my $ref = ref $config{$option} || 'SCALAR';
390 *{"Debbugs::Config::${varname}"} = $config{$option};
397 # All we care about here is whether we've been called with the globals option;
398 # if so, then we need to export some symbols back up; otherwise we call exporter.
401 if (grep $_ eq ':globals', @_) {
403 for my $variable (@{$EXPORT_TAGS{globals}}) {
406 # Yes, I don't care if these are only used once
408 # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
410 my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
411 $tmp =~ s/^[\%\$\@]//;
412 *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
415 Debbugs::Config->export_to_level(1,@_);