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