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