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