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