Debbugs/Config.pm

   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.
   5 #
   6 # Copyright 2007 by Don Armstrong <don@donarmstrong.com>.
   7
   8 package Debbugs::Config;
   9
  10 =head1 NAME
  11
  12 Debbugs::Config -- Configuration information for debbugs
  13
  14 =head1 SYNOPSIS
  15
  16  use Debbugs::Config;
  17
  18 # to get the compatiblity interface
  19
  20  use Debbugs::Config qw(:globals);
  21
  22 =head1 DESCRIPTION
  23
  24 This module provides configuration variables for all of debbugs.
  25
  26 =head1 CONFIGURATION FILES
  27
  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.
  31
  32 =cut
  33
  34 use warnings;
  35 use strict;
  36 use vars qw($VERSION $DEBUG %EXPORT_TAGS @EXPORT_OK @EXPORT $USING_GLOBALS %config);
  37 use base qw(Exporter);
  38
  39 BEGIN {
  40      # set the version for version checking
  41      $VERSION     = 1.00;
  42      $DEBUG = 0 unless defined $DEBUG;
  43      $USING_GLOBALS = 0;
  44
  45      @EXPORT = ();
  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),
  52                                  qw($gStrongList),
  53                                  qw($gBugSubscriptionDomain),
  54                                  qw($gPackageVersionRe),
  55                                  qw($gSummaryList $gMirrorList $gMailer $gBug),
  56                                  qw($gBugs $gRemoveAge $gSaveOldBugs $gDefaultSeverity),
  57                                  qw($gShowSeverities $gBounceFroms $gConfigDir $gSpoolDir),
  58                                  qw($gIncomingDir $gWebDir $gDocDir $gMaintainerFile),
  59                                  qw($gMaintainerFileOverride $gPseudoMaintFile $gPseudoDescFile $gPackageSource),
  60                                  qw($gVersionPackagesDir $gVersionIndex $gBinarySourceMap $gSourceBinaryMap),
  61                                  qw($gVersionTimeIndex),
  62                                  qw($gSendmail $gLibPath $gSpamScan @gExcludeFromControl),
  63                                  qw(%gSeverityDisplay @gTags @gSeverityList @gStrongSeverities),
  64                                  qw(%gTagsSingleLetter),
  65                                  qw(%gSearchEstraier),
  66                                  qw(%gDistributionAliases),
  67                                  qw(%gObsoleteSeverities),
  68                                  qw(@gPostProcessall @gRemovalDefaultDistributionTags @gRemovalDistributionTags @gRemovalArchitectures),
  69                                  qw(@gRemovalStrongSeverityDefaultDistributionTags),
  70                                  qw(@gAffectsDistributionTags),
  71                                  qw(@gDefaultArchitectures),
  72                                  qw($gMachineName),
  73                                  qw($gTemplateDir),
  74                                  qw($gDefaultPackage),
  75                                  qw($gSpamMaxThreads $gSpamSpamsPerThread $gSpamKeepRunning $gSpamScan $gSpamCrossassassinDb),
  76                                 ],
  77                      text     => [qw($gBadEmailPrefix $gHTMLTail $gHTMLExpireNote),
  78                                  ],
  79                      config   => [qw(%config)],
  80                     );
  81      @EXPORT_OK = ();
  82      Exporter::export_ok_tags(qw(globals text config));
  83      $EXPORT_TAGS{all} = [@EXPORT_OK];
  84      $ENV{HOME} = '' if not defined $ENV{HOME};
  85 }
  86
  87 use File::Basename qw(dirname);
  88 use IO::File;
  89 use Safe;
  90
  91 =head1 CONFIGURATION VARIABLES
  92
  93 =head2 General Configuration
  94
  95 =over
  96
  97 =cut
  98
  99 # read in the files;
 100 %config = ();
 101 # untaint $ENV{DEBBUGS_CONFIG_FILE} if it's owned by us
 102 # This enables us to test things that are -T.
 103 if (exists $ENV{DEBBUGS_CONFIG_FILE}) {
 104      if (${[stat($ENV{DEBBUGS_CONFIG_FILE})]}[4] = $<) {
 105           $ENV{DEBBUGS_CONFIG_FILE} =~ /(.+)/;
 106           $ENV{DEBBUGS_CONFIG_FILE} = $1;
 107      }
 108      else {
 109           die "Environmental variable DEBBUGS_CONFIG_FILE set, and $ENV{DEBBUGS_CONFIG_FILE} is not owned by the user running this script.";
 110      }
 111 }
 112 read_config(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config');
 113
 114 =item email_domain $gEmailDomain
 115
 116 The email domain of the bts
 117
 118 =cut
 119
 120 set_default(\%config,'email_domain','bugs.something');
 121
 122 =item list_domain $gListDomain
 123
 124 The list domain of the bts, defaults to the email domain
 125
 126 =cut
 127
 128 set_default(\%config,'list_domain',$config{email_domain});
 129
 130 =item web_host $gWebHost
 131
 132 The web host of the bts; defaults to the email domain
 133
 134 =cut
 135
 136 set_default(\%config,'web_host',$config{email_domain});
 137
 138 =item web_host_bug_dir $gWebHostDir
 139
 140 The directory of the web host on which bugs are kept, defaults to C<''>
 141
 142 =cut
 143
 144 set_default(\%config,'web_host_bug_dir','');
 145
 146 =item web_domain $gWebDomain
 147
 148 Full path of the web domain where bugs are kept, defaults to the
 149 concatenation of L</web_host> and L</web_host_bug_dir>
 150
 151 =cut
 152
 153 set_default(\%config,'web_domain',$config{web_host}.($config{web_host}=~m{/$}?'':'/').$config{web_host_bug_dir});
 154
 155 =item html_suffix $gHTMLSuffix
 156
 157 Suffix of html pages, defaults to .html
 158
 159 =cut
 160
 161 set_default(\%config,'html_suffix','.html');
 162
 163 =item cgi_domain $gCGIDomain
 164
 165 Full path of the web domain where cgi scripts are kept. Defaults to
 166 the concatentation of L</web_host> and cgi.
 167
 168 =cut
 169
 170 set_default(\%config,'cgi_domain',$config{web_domain}.($config{web_domain}=~m{/$}?'':'/').'cgi');
 171
 172 =item mirrors @gMirrors
 173
 174 List of mirrors [What these mirrors are used for, no one knows.]
 175
 176 =cut
 177
 178
 179 set_default(\%config,'mirrors',[]);
 180
 181 =item package_pages  $gPackagePages
 182
 183 Domain where the package pages are kept; links should work in a
 184 package_pages/foopackage manner. Defaults to undef, which means that
 185 package links will not be made.
 186
 187 =cut
 188
 189
 190 set_default(\%config,'package_pages',undef);
 191
 192 =item package_pages  $gUsertagPackageDomain
 193
 194 Domain where where usertags of packages belong; defaults to $gPackagePages
 195
 196 =cut
 197
 198 set_default(\%config,'usertag_package_domain',$config{package_pages});
 199
 200
 201 =item subscription_domain $gSubscriptionDomain
 202
 203 Domain where subscriptions to package lists happen
 204
 205 =cut
 206
 207
 208 set_default(\%config,'subscription_domain',undef);
 209
 210 =back
 211
 212 =cut
 213
 214
 215 =head2 Project Identification
 216
 217 =over
 218
 219 =item project $gProject
 220
 221 Name of the project
 222
 223 Default: 'Something'
 224
 225 =cut
 226
 227 set_default(\%config,'project','Something');
 228
 229 =item project_title $gProjectTitle
 230
 231 Name of this install of Debbugs, defaults to "L</project> Debbugs Install"
 232
 233 Default: "$config{project} Debbugs Install"
 234
 235 =cut
 236
 237 set_default(\%config,'project_title',"$config{project} Debbugs Install");
 238
 239 =item maintainer $gMaintainer
 240
 241 Name of the maintainer of this debbugs install
 242
 243 Default: 'Local DebBugs Owner's
 244
 245 =cut
 246
 247 set_default(\%config,'maintainer','Local DebBugs Owner');
 248
 249 =item maintainer_webpage $gMaintainerWebpage
 250
 251 Webpage of the maintainer of this install of debbugs
 252
 253 Default: "$config{web_domain}/~owner"
 254
 255 =cut
 256
 257 set_default(\%config,'maintainer_webpage',"$config{web_domain}/~owner");
 258
 259 =item maintainer_email $gMaintainerEmail
 260
 261 Email address of the maintainer of this Debbugs install
 262
 263 Default: 'root@'.$config{email_domain}
 264
 265 =cut
 266
 267 set_default(\%config,'maintainer_email','root@'.$config{email_domain});
 268
 269 =item unknown_maintainer_email
 270
 271 Email address where packages with an unknown maintainer will be sent
 272
 273 Default: $config{maintainer_email}
 274
 275 =cut
 276
 277 set_default(\%config,'unknown_maintainer_email',$config{maintainer_email});
 278
 279 =item machine_name
 280
 281 The name of the machine that this instance of debbugs is running on
 282 (currently used for debbuging purposes and web page output.)
 283
 284 Default: qx(hostname --fqdn)
 285
 286 =back
 287
 288 =cut
 289
 290 my $_old_path = $ENV{PATH};
 291 $ENV{PATH} = '/bin:/usr/bin:/usr/local/bin';
 292 my $temp_hostname = qx(hostname --fqdn);
 293 chomp $temp_hostname;
 294 set_default(\%config,'machine_name',$temp_hostname);
 295 $ENV{PATH} = $_old_path;
 296
 297 =head2 BTS Mailing Lists
 298
 299
 300 =over
 301
 302 =item submit_list
 303
 304 =item maint_list
 305
 306 =item forward_list
 307
 308 =item done_list
 309
 310 =item request_list
 311
 312 =item submitter_list
 313
 314 =item control_list
 315
 316 =item summary_list
 317
 318 =item mirror_list
 319
 320 =item strong_list
 321
 322 =cut
 323
 324 set_default(\%config,   'submit_list',   'bug-submit-list');
 325 set_default(\%config,    'maint_list',    'bug-maint-list');
 326 set_default(\%config,    'quiet_list',    'bug-quiet-list');
 327 set_default(\%config,  'forward_list',  'bug-forward-list');
 328 set_default(\%config,     'done_list',     'bug-done-list');
 329 set_default(\%config,  'request_list',  'bug-request-list');
 330 set_default(\%config,'submitter_list','bug-submitter-list');
 331 set_default(\%config,  'control_list',  'bug-control-list');
 332 set_default(\%config,  'summary_list',  'bug-summary-list');
 333 set_default(\%config,   'mirror_list',   'bug-mirror-list');
 334 set_default(\%config,   'strong_list',   'bug-strong-list');
 335
 336 =item bug_subscription_domain
 337
 338 Domain of list for messages regarding a single bug; prefixed with
 339 bug=${bugnum}@ when bugs are actually sent out. Set to undef or '' to
 340 disable sending messages to the bug subscription list.
 341
 342 Default: list_domain
 343
 344 =back
 345
 346 =cut
 347
 348 set_default(\%config,'bug_subscription_domain',$config{list_domain});
 349
 350
 351 =head2 Misc Options
 352
 353 =over
 354
 355 =cut
 356
 357 set_default(\%config,'mailer','exim');
 358 set_default(\%config,'bug','bug');
 359 set_default(\%config,'bugs','bugs');
 360
 361 =item remove_age
 362
 363 Age at which bugs are archived/removed
 364
 365 Default: 28
 366
 367 =cut
 368
 369 set_default(\%config,'remove_age',28);
 370
 371 =item save_old_bugs
 372
 373 Whether old bugs are saved or deleted
 374
 375 Default: 1
 376
 377 =cut
 378
 379 set_default(\%config,'save_old_bugs',1);
 380
 381 =item distribution_aliases
 382
 383 Map of distribution aliases to the distribution name
 384
 385 Default:
 386          {experimental => 'experimental',
 387           unstable     => 'unstable',
 388           testing      => 'testing',
 389           stable       => 'stable',
 390           oldstable    => 'oldstable',
 391           sid          => 'unstable',
 392           lenny        => 'testing',
 393           etch         => 'stable',
 394           sarge        => 'oldstable',
 395          }
 396
 397 =cut
 398
 399 set_default(\%config,'distribution_aliases',
 400             {experimental => 'experimental',
 401              unstable     => 'unstable',
 402              testing      => 'testing',
 403              stable       => 'stable',
 404              oldstable    => 'oldstable',
 405              sid          => 'unstable',
 406              lenny        => 'testing',
 407              etch         => 'stable',
 408              sarge        => 'oldstable',
 409             },
 410            );
 411
 412
 413
 414 =item distributions
 415
 416 List of valid distributions
 417
 418 Default: The values of the distribution aliases map.
 419
 420 =cut
 421
 422 my %_distributions_default;
 423 @_distributions_default{values %{$config{distribution_aliases}}} = values %{$config{distribution_aliases}};
 424 set_default(\%config,'distributions',[keys %_distributions_default]);
 425
 426
 427 =item default_architectures
 428
 429 List of default architectures to use when architecture(s) are not
 430 specified
 431
 432 Default: i386 amd64 arm ppc sparc alpha
 433
 434 =cut
 435
 436 set_default(\%config,'default_architectures',
 437             [qw(i386 amd64 arm powerpc sparc alpha)]
 438            );
 439
 440 =item affects_distribution_tags
 441
 442 List of tags which restrict the buggy state to a set of distributions.
 443
 444 The set of distributions that are buggy is the intersection of the set
 445 of distributions that would be buggy without reference to these tags
 446 and the set of these tags that are distributions which are set on a
 447 bug.
 448
 449 Setting this to [] will remove this feature.
 450
 451 Default: @{$config{distributions}}
 452
 453 =cut
 454
 455 set_default(\%config,'affects_distribution_tags',
 456             [@{$config{distributions}}],
 457            );
 458
 459 =item removal_unremovable_tags
 460
 461 Bugs which have these tags set cannot be archived
 462
 463 Default: []
 464
 465 =cut
 466
 467 set_default(\%config,'removal_unremovable_tags',
 468             [],
 469            );
 470
 471 =item removal_distribution_tags
 472
 473 Tags which specifiy distributions to check
 474
 475 Default: @{$config{distributions}}
 476
 477 =cut
 478
 479 set_default(\%config,'removal_distribution_tags',
 480             [@{$config{distributions}}]);
 481
 482 =item removal_default_distribution_tags
 483
 484 For removal/archival purposes, all bugs are assumed to have these tags
 485 set.
 486
 487 Default: qw(unstable testing);
 488
 489 =cut
 490
 491 set_default(\%config,'removal_default_distribution_tags',
 492             [qw(unstable testing)]
 493            );
 494
 495 =item removal_strong_severity_default_distribution_tags
 496
 497 For removal/archival purposes, all bugs with strong severity are
 498 assumed to have these tags set.
 499
 500 Default: qw(unstable testing stable);
 501
 502 =cut
 503
 504 set_default(\%config,'removal_strong_severity_default_distribution_tags',
 505             [qw(unstable testing stable)]
 506            );
 507
 508
 509 =item removal_architectures
 510
 511 For removal/archival purposes, these architectures are consulted if
 512 there is more than one architecture applicable. If the bug is in a
 513 package not in any of these architectures, the architecture actually
 514 checked is undefined.
 515
 516 Default: value of default_architectures
 517
 518 =cut
 519
 520 set_default(\%config,'removal_architectures',
 521             $config{default_architectures},
 522            );
 523
 524
 525 =item package_name_re
 526
 527 The regex which will match a package name
 528
 529 Default: '[a-z0-9][a-z0-9\.+-]+'
 530
 531 =cut
 532
 533 set_default(\%config,'package_name_re',
 534             '[a-z0-9][a-z0-9\.+-]+');
 535
 536 =item package_version_re
 537
 538 The regex which will match a package version
 539
 540 Default: '[A-Za-z0-9:+\.-]+'
 541
 542 =cut
 543
 544
 545 set_default(\%config,'package_version_re',
 546             '[A-Za-z0-9:+\.~-]+');
 547
 548
 549 =item default_package
 550
 551 This is the name of the default package. If set, bugs assigned to
 552 packages without a maintainer and bugs missing a Package: psuedoheader
 553 will be assigned to this package instead.
 554
 555 Defaults to unset, which is the traditional debbugs behavoir
 556
 557 =cut
 558
 559 set_default(\%config,'default_package',
 560             undef
 561            );
 562
 563
 564 =item control_internal_requester
 565
 566 This address is used by Debbugs::Control as the request address which
 567 sent a control request for faked log messages.
 568
 569 Default:"Debbugs Internal Request <$config{maintainer_email}>"
 570
 571 =cut
 572
 573 set_default(\%config,'control_internal_requester',
 574             "Debbugs Internal Request <$config{maintainer_email}>",
 575            );
 576
 577 =item control_internal_request_addr
 578
 579 This address is used by Debbugs::Control as the address to which a
 580 faked log message request was sent.
 581
 582 Default: "internal_control\@$config{email_domain}";
 583
 584 =cut
 585
 586 set_default(\%config,'control_internal_request_addr',
 587             'internal_control@'.$config{email_domain},
 588            );
 589
 590
 591 =item exclude_from_control
 592
 593 Addresses which are not allowed to send messages to control
 594
 595 =cut
 596
 597 set_default(\%config,'exclude_from_control',[]);
 598
 599
 600
 601 =item default_severity
 602
 603 The default severity of bugs which have no severity set
 604
 605 Default: normal
 606
 607 =cut
 608
 609 set_default(\%config,'default_severity','normal');
 610
 611 =item severity_display
 612
 613 A hashref of severities and the informative text which describes them.
 614
 615 Default:
 616
 617  {critical => "Critical $config{bugs}",
 618   grave    => "Grave $config{bugs}",
 619   normal   => "Normal $config{bugs}",
 620   wishlist => "Wishlist $config{bugs}",
 621  }
 622
 623 =cut
 624
 625 set_default(\%config,'severity_display',{critical => "Critical $config{bugs}",
 626                                          grave    => "Grave $config{bugs}",
 627                                          serious  => "Serious $config{bugs}",
 628                                          important=> "Important $config{bugs}",
 629                                          normal   => "Normal $config{bugs}",
 630                                          minor    => "Minor $config{bugs}",
 631                                          wishlist => "Wishlist $config{bugs}",
 632                                         });
 633
 634 =item show_severities
 635
 636 A scalar list of the severities to show
 637
 638 Defaults to the concatenation of the keys of the severity_display
 639 hashlist with ', ' above.
 640
 641 =cut
 642
 643 set_default(\%config,'show_severities',join(', ',keys %{$config{severity_display}}));
 644
 645 =item strong_severities
 646
 647 An arrayref of the serious severities which shoud be emphasized
 648
 649 Default: [qw(critical grave)]
 650
 651 =cut
 652
 653 set_default(\%config,'strong_severities',[qw(critical grave)]);
 654
 655 =item severity_list
 656
 657 An arrayref of a list of the severities
 658
 659 Defaults to the keys of the severity display hashref
 660
 661 =cut
 662
 663 set_default(\%config,'severity_list',[keys %{$config{severity_display}}]);
 664
 665 =item obsolete_severities
 666
 667 A hashref of obsolete severities with the replacing severity
 668
 669 Default: {}
 670
 671 =cut
 672
 673 set_default(\%config,'obsolete_severities',{});
 674
 675 =item tags
 676
 677 An arrayref of the tags used
 678
 679 Default: [qw(patch wontfix moreinfo unreproducible fixed)] and also
 680 includes the distributions.
 681
 682 =cut
 683
 684 set_default(\%config,'tags',[qw(patch wontfix moreinfo unreproducible fixed),
 685                              @{$config{distributions}}
 686                             ]);
 687
 688 set_default(\%config,'tags_single_letter',
 689             {patch => '+',
 690              wontfix => '',
 691              moreinfo => 'M',
 692              unreproducible => 'R',
 693              fixed   => 'F',
 694             }
 695            );
 696
 697 set_default(\%config,'bounce_froms','^mailer|^da?emon|^post.*mast|^root|^wpuser|^mmdf|^smt.*|'.
 698             '^mrgate|^vmmail|^mail.*system|^uucp|-maiser-|^mal\@|'.
 699             '^mail.*agent|^tcpmail|^bitmail|^mailman');
 700
 701 set_default(\%config,'config_dir',dirname(exists $ENV{DEBBUGS_CONFIG_FILE}?$ENV{DEBBUGS_CONFIG_FILE}:'/etc/debbugs/config'));
 702 set_default(\%config,'spool_dir','/var/lib/debbugs/spool');
 703
 704 =item usertag_dir
 705
 706 Directory which contains the usertags
 707
 708 Default: $config{spool_dir}/user
 709
 710 =cut
 711
 712 set_default(\%config,'usertag_dir',$config{spool_dir}.'/user');
 713 set_default(\%config,'incoming_dir','incoming');
 714 set_default(\%config,'web_dir','/var/lib/debbugs/www');
 715 set_default(\%config,'doc_dir','/var/lib/debbugs/www/txt');
 716 set_default(\%config,'lib_path','/usr/lib/debbugs');
 717
 718
 719 =item template_dir
 720
 721 directory of templates; defaults to /usr/share/debbugs/templates.
 722
 723 =cut
 724
 725 set_default(\%config,'template_dir','/usr/share/debbugs/templates');
 726
 727
 728 set_default(\%config,'maintainer_file',$config{config_dir}.'/Maintainers');
 729 set_default(\%config,'maintainer_file_override',$config{config_dir}.'/Maintainers.override');
 730 set_default(\%config,'pseudo_maint_file',$config{config_dir}.'/pseudo-packages.maint');
 731 set_default(\%config,'pseudo_desc_file',$config{config_dir}.'/pseudo-packages.description');
 732 set_default(\%config,'package_source',$config{config_dir}.'/indices/sources');
 733
 734
 735 =item version_packages_dir
 736
 737 Location where the version package information is kept; defaults to
 738 spool_dir/../versions/pkg
 739
 740 =cut
 741
 742 set_default(\%config,'version_packages_dir',$config{spool_dir}.'/../versions/pkg');
 743
 744 =item version_time_index
 745
 746 Location of the version/time index file. Defaults to
 747 spool_dir/../versions/idx/versions_time.idx if spool_dir/../versions
 748 exists; otherwise defaults to undef.
 749
 750 =cut
 751
 752
 753 set_default(\%config,'version_time_index', -d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions_time.idx' : undef);
 754
 755 =item version_index
 756
 757 Location of the version index file. Defaults to
 758 spool_dir/../versions/indices/versions.idx if spool_dir/../versions
 759 exists; otherwise defaults to undef.
 760
 761 =cut
 762
 763 set_default(\%config,'version_index',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/versions.idx' : undef);
 764
 765 =item binary_source_map
 766
 767 Location of the binary -> source map. Defaults to
 768 spool_dir/../versions/indices/bin2src.idx if spool_dir/../versions
 769 exists; otherwise defaults to undef.
 770
 771 =cut
 772
 773 set_default(\%config,'binary_source_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/binsrc.idx' : undef);
 774
 775 =item source_binary_map
 776
 777 Location of the source -> binary map. Defaults to
 778 spool_dir/../versions/indices/src2bin.idx if spool_dir/../versions
 779 exists; otherwise defaults to undef.
 780
 781 =cut
 782
 783 set_default(\%config,'source_binary_map',-d $config{spool_dir}.'/../versions' ? $config{spool_dir}.'/../versions/indices/srcbin.idx' : undef);
 784
 785
 786
 787 set_default(\%config,'post_processall',[]);
 788
 789 =item sendmail
 790
 791 Sets the sendmail binary to execute; defaults to /usr/lib/sendmail
 792
 793 =cut
 794
 795 set_default(\%config,'sendmail','/usr/lib/sendmail');
 796
 797 =item spam_scan
 798
 799 Whether or not spamscan is being used; defaults to 0 (not being used
 800
 801 =cut
 802
 803 set_default(\%config,'spam_scan',0);
 804
 805 =item spam_crossassassin_db
 806
 807 Location of the crosassassin database, defaults to
 808 spool_dir/../CrossAssassinDb
 809
 810 =cut
 811
 812 set_default(\%config,'spam_crossassassin_db',$config{spool_dir}.'/../CrossAssassinDb');
 813
 814 =item spam_max_cross
 815
 816 Maximum number of cross-posted messages
 817
 818 =cut
 819
 820 set_default(\%config,'spam_max_cross',6);
 821
 822
 823 =item spam_spams_per_thread
 824
 825 Number of spams for each thread (on average). Defaults to 200
 826
 827 =cut
 828
 829 set_default(\%config,'spam_spams_per_thread',200);
 830
 831 =item spam_max_threads
 832
 833 Maximum number of threads to start. Defaults to 20
 834
 835 =cut
 836
 837 set_default(\%config,'spam_max_threads',20);
 838
 839 =item spam_keep_running
 840
 841 Maximum number of seconds to run without restarting. Defaults to 3600.
 842
 843 =cut
 844
 845 set_default(\%config,'spam_keep_running',3600);
 846
 847 =item spam_mailbox
 848
 849 Location to store spam messages; is run through strftime to allow for
 850 %d,%m,%Y, et al. Defaults to 'spool_dir/../mail/spam/assassinated.%Y-%m-%d'
 851
 852 =cut
 853
 854 set_default(\%config,'spam_mailbox',$config{spool_dir}.'/../mail/spam/assassinated.%Y-%m-%d');
 855
 856 =item spam_crossassassin_mailbox
 857
 858 Location to store crossassassinated messages; is run through strftime
 859 to allow for %d,%m,%Y, et al. Defaults to
 860 'spool_dir/../mail/spam/crossassassinated.%Y-%m-%d'
 861
 862 =cut
 863
 864 set_default(\%config,'spam_crossassassin_mailbox',$config{spool_dir}.'/../mail/spam/crossassassinated.%Y-%m-%d');
 865
 866 =item spam_local_tests_only
 867
 868 Whether only local tests are run, defaults to 0
 869
 870 =cut
 871
 872 set_default(\%config,'spam_local_tests_only',0);
 873
 874 =item spam_user_prefs
 875
 876 User preferences for spamassassin, defaults to $ENV{HOME}/.spamassassin/user_prefs
 877
 878 =cut
 879
 880 set_default(\%config,'spam_user_prefs',"$ENV{HOME}/.spamassassin/user_prefs");
 881
 882 =item spam_rules_dir
 883
 884 Site rules directory for spamassassin, defaults to
 885 '/usr/share/spamassassin'
 886
 887 =cut
 888
 889 set_default(\%config,'spam_rules_dir','/usr/share/spamassassin');
 890
 891 =back
 892
 893
 894 =head2 Text Fields
 895
 896 The following are the only text fields in general use in the scripts;
 897 a few additional text fields are defined in text.in, but are only used
 898 in db2html and a few other specialty scripts.
 899
 900 Earlier versions of debbugs defined these values in /etc/debbugs/text,
 901 but now they are required to be in the configuration file. [Eventually
 902 the longer ones will move out into a fully fledged template system.]
 903
 904 =cut
 905
 906 =over
 907
 908 =item bad_email_prefix
 909
 910 This prefixes the text of all lines in a bad e-mail message ack.
 911
 912 =cut
 913
 914 set_default(\%config,'bad_email_prefix','');
 915
 916
 917 =item text_instructions
 918
 919 This gives more information about bad e-mails to receive.in
 920
 921 =cut
 922
 923 set_default(\%config,'text_instructions',$config{bad_email_prefix});
 924
 925 =item html_tail
 926
 927 This shows up at the end of (most) html pages
 928
 929 In many pages this has been replaced by the html/tail template.
 930
 931 =cut
 932
 933 set_default(\%config,'html_tail',<<END);
 934  <ADDRESS>$config{maintainer} &lt;<A HREF=\"mailto:$config{maintainer_email}\">$config{maintainer_email}</A>&gt;.
 935  Last modified:
 936  <!--timestamp-->
 937  SUBSTITUTE_DTIME
 938  <!--timestamp-->
 939  <P>
 940  <A HREF=\"http://$config{web_domain}/\">Debian $config{bug} tracking system</A><BR>
 941  Copyright (C) 1999 Darren O. Benham,
 942  1997,2003 nCipher Corporation Ltd,
 943  1994-97 Ian Jackson.
 944  </ADDRESS>
 945 END
 946
 947
 948 =item html_expire_note
 949
 950 This message explains what happens to archive/remove-able bugs
 951
 952 =cut
 953
 954 set_default(\%config,'html_expire_note',
 955             "(Closed $config{bugs} are archived $config{remove_age} days after the last related message is received.)");
 956
 957 =back
 958
 959 =cut
 960
 961
 962 sub read_config{
 963      my ($conf_file) = @_;
 964      # first, figure out what type of file we're reading in.
 965      my $fh = new IO::File $conf_file,'r'
 966           or die "Unable to open configuration file $conf_file for reading: $!";
 967      # A new version configuration file must have a comment as its first line
 968      my $first_line = <$fh>;
 969      my ($version) = defined $first_line?$first_line =~ /VERSION:\s*(\d+)/i:undef;
 970      if (defined $version) {
 971           if ($version == 1) {
 972                # Do something here;
 973                die "Version 1 configuration files not implemented yet";
 974           }
 975           else {
 976                die "Version $version configuration files are not supported";
 977           }
 978      }
 979      else {
 980           # Ugh. Old configuration file
 981           # What we do here is we create a new Safe compartment
 982           # so fucked up crap in the config file doesn't sink us.
 983           my $cpt = new Safe or die "Unable to create safe compartment";
 984           # perldoc Opcode; for details
 985           $cpt->permit('require',':filesys_read','entereval','caller','pack','unpack','dofile');
 986           $cpt->reval(qq(require '$conf_file';));
 987           die "Error in configuration file: $@" if $@;
 988           # Now what we do is check out the contents of %EXPORT_TAGS to see exactly which variables
 989           # we want to glob in from the configuration file
 990           for my $variable (@{$EXPORT_TAGS{globals}}) {
 991                my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
 992                my $var_glob = $cpt->varglob($glob_name);
 993                my $value; #= $cpt->reval("return $variable");
 994                # print STDERR "$variable $value",qq(\n);
 995                if (defined $var_glob) {{
 996                     no strict 'refs';
 997                     if ($glob_type eq '%') {
 998                          $value = {%{*{$var_glob}}} if defined *{$var_glob}{HASH};
 999                     }
1000                     elsif ($glob_type eq '@') {
1001                          $value = [@{*{$var_glob}}] if defined *{$var_glob}{ARRAY};
1002                     }
1003                     else {
1004                          $value = ${*{$var_glob}};
1005                     }
1006                     # We punt here, because we can't tell if the value was
1007                     # defined intentionally, or if it was just left alone;
1008                     # this tries to set sane defaults.
1009                     set_default(\%config,$hash_name,$value) if defined $value;
1010                }}
1011           }
1012      }
1013 }
1014
1015 sub __convert_name{
1016      my ($variable) = @_;
1017      my $hash_name = $variable;
1018      $hash_name =~ s/^([\$\%\@])g//;
1019      my $glob_type = $1;
1020      my $glob_name = 'g'.$hash_name;
1021      $hash_name =~ s/(HTML|CGI)/ucfirst(lc($1))/ge;
1022      $hash_name =~ s/^([A-Z]+)/lc($1)/e;
1023      $hash_name =~ s/([A-Z]+)/'_'.lc($1)/ge;
1024      return $hash_name unless wantarray;
1025      return ($hash_name,$glob_name,$glob_type);
1026 }
1027
1028 # set_default
1029
1030 # sets the configuration hash to the default value if it's not set,
1031 # otherwise doesn't do anything
1032 # If $USING_GLOBALS, then sets an appropriate global.
1033
1034 sub set_default{
1035      my ($config,$option,$value) = @_;
1036      my $varname;
1037      if ($USING_GLOBALS) {
1038           # fix up the variable name
1039           $varname = 'g'.join('',map {ucfirst $_} split /_/, $option);
1040           # Fix stupid HTML names
1041           $varname =~ s/(Html|Cgi)/uc($1)/ge;
1042      }
1043      # update the configuration value
1044      if (not $USING_GLOBALS and not exists $config->{$option}) {
1045           $config->{$option} = $value;
1046      }
1047      elsif ($USING_GLOBALS) {{
1048           no strict 'refs';
1049           # Need to check if a value has already been set in a global
1050           if (defined *{"Debbugs::Config::${varname}"}) {
1051                $config->{$option} = *{"Debbugs::Config::${varname}"};
1052           }
1053           else {
1054                $config->{$option} = $value;
1055           }
1056      }}
1057      if ($USING_GLOBALS) {{
1058           no strict 'refs';
1059           *{"Debbugs::Config::${varname}"} = $config->{$option};
1060      }}
1061 }
1062
1063
1064 ### import magick
1065
1066 # All we care about here is whether we've been called with the globals or text option;
1067 # if so, then we need to export some symbols back up.
1068 # In any event, we call exporter.
1069
1070 sub import {
1071      if (grep /^:(?:text|globals)$/, @_) {
1072           $USING_GLOBALS=1;
1073           for my $variable (map {@$_} @EXPORT_TAGS{map{(/^:(text|globals)$/?($1):())} @_}) {
1074                my $tmp = $variable;
1075                no strict 'refs';
1076                # Yes, I don't care if these are only used once
1077                no warnings 'once';
1078                # No, it doesn't bother me that I'm assigning an undefined value to a typeglob
1079                no warnings 'misc';
1080                my ($hash_name,$glob_name,$glob_type) = __convert_name($variable);
1081                $tmp =~ s/^[\%\$\@]//;
1082                *{"Debbugs::Config::${tmp}"} = ref($config{$hash_name})?$config{$hash_name}:\$config{$hash_name};
1083           }
1084      }
1085      Debbugs::Config->export_to_level(1,@_);
1086 }
1087
1088
1089 1;