FS/FS/Conf_compat17.pm

   1 package FS::Conf_compat17;
   2
   3 use vars qw($default_dir $base_dir @config_items @card_types $DEBUG );
   4 use IO::File;
   5 use File::Basename;
   6 use FS::ConfItem;
   7 use FS::ConfDefaults;
   8
   9 $base_dir = '%%%FREESIDE_CONF%%%';
  10 $default_dir = '%%%FREESIDE_CONF%%%';
  11
  12
  13 $DEBUG = 0;
  14
  15 =head1 NAME
  16
  17 FS::Conf - Freeside configuration values
  18
  19 =head1 SYNOPSIS
  20
  21   use FS::Conf;
  22
  23   $conf = new FS::Conf "/config/directory";
  24
  25   $FS::Conf::default_dir = "/config/directory";
  26   $conf = new FS::Conf;
  27
  28   $dir = $conf->dir;
  29
  30   $value = $conf->config('key');
  31   @list  = $conf->config('key');
  32   $bool  = $conf->exists('key');
  33
  34   $conf->touch('key');
  35   $conf->set('key' => 'value');
  36   $conf->delete('key');
  37
  38   @config_items = $conf->config_items;
  39
  40 =head1 DESCRIPTION
  41
  42 Read and write Freeside configuration values.  Keys currently map to filenames,
  43 but this may change in the future.
  44
  45 =head1 METHODS
  46
  47 =over 4
  48
  49 =item new [ DIRECTORY ]
  50
  51 Create a new configuration object.  A directory arguement is required if
  52 $FS::Conf::default_dir has not been set.
  53
  54 =cut
  55
  56 sub new {
  57   my($proto,$dir) = @_;
  58   my($class) = ref($proto) || $proto;
  59   my($self) = { 'dir'      => $dir || $default_dir,
  60                 'base_dir' => $base_dir,
  61               };
  62   bless ($self, $class);
  63 }
  64
  65 =item dir
  66
  67 Returns the conf directory.
  68
  69 =cut
  70
  71 sub dir {
  72   my($self) = @_;
  73   my $dir = $self->{dir};
  74   -e $dir or die "FATAL: $dir doesn't exist!";
  75   -d $dir or die "FATAL: $dir isn't a directory!";
  76   -r $dir or die "FATAL: Can't read $dir!";
  77   -x $dir or die "FATAL: $dir not searchable (executable)!";
  78   $dir =~ /^(.*)$/;
  79   $1;
  80 }
  81
  82 =item base_dir
  83
  84 Returns the base directory.  By default this is /usr/local/etc/freeside.
  85
  86 =cut
  87
  88 sub base_dir {
  89   my($self) = @_;
  90   my $base_dir = $self->{base_dir};
  91   -e $base_dir or die "FATAL: $base_dir doesn't exist!";
  92   -d $base_dir or die "FATAL: $base_dir isn't a directory!";
  93   -r $base_dir or die "FATAL: Can't read $base_dir!";
  94   -x $base_dir or die "FATAL: $base_dir not searchable (executable)!";
  95   $base_dir =~ /^(.*)$/;
  96   $1;
  97 }
  98
  99 =item config KEY
 100
 101 Returns the configuration value or values (depending on context) for key.
 102
 103 =cut
 104
 105 sub config {
 106   my($self,$file)=@_;
 107   my($dir)=$self->dir;
 108   my $fh = new IO::File "<$dir/$file" or return;
 109   if ( wantarray ) {
 110     map {
 111       /^(.*)$/
 112         or die "Illegal line (array context) in $dir/$file:\n$_\n";
 113       $1;
 114     } <$fh>;
 115   } else {
 116     <$fh> =~ /^(.*)$/
 117       or die "Illegal line (scalar context) in $dir/$file:\n$_\n";
 118     $1;
 119   }
 120 }
 121
 122 =item config_binary KEY
 123
 124 Returns the exact scalar value for key.
 125
 126 =cut
 127
 128 sub config_binary {
 129   my($self,$file)=@_;
 130   my($dir)=$self->dir;
 131   my $fh = new IO::File "<$dir/$file" or return;
 132   local $/;
 133   my $content = <$fh>;
 134   $content;
 135 }
 136
 137 =item exists KEY
 138
 139 Returns true if the specified key exists, even if the corresponding value
 140 is undefined.
 141
 142 =cut
 143
 144 sub exists {
 145   my($self,$file)=@_;
 146   my($dir) = $self->dir;
 147   -e "$dir/$file";
 148 }
 149
 150 =item config_orbase KEY SUFFIX
 151
 152 Returns the configuration value or values (depending on context) for
 153 KEY_SUFFIX, if it exists, otherwise for KEY
 154
 155 =cut
 156
 157 sub config_orbase {
 158   my( $self, $file, $suffix ) = @_;
 159   if ( $self->exists("${file}_$suffix") ) {
 160     $self->config("${file}_$suffix");
 161   } else {
 162     $self->config($file);
 163   }
 164 }
 165
 166 =item touch KEY
 167
 168 Creates the specified configuration key if it does not exist.
 169
 170 =cut
 171
 172 sub touch {
 173   my($self, $file) = @_;
 174   my $dir = $self->dir;
 175   unless ( $self->exists($file) ) {
 176     warn "[FS::Conf] TOUCH $file\n" if $DEBUG;
 177     system('touch', "$dir/$file");
 178   }
 179 }
 180
 181 =item set KEY VALUE
 182
 183 Sets the specified configuration key to the given value.
 184
 185 =cut
 186
 187 sub set {
 188   my($self, $file, $value) = @_;
 189   my $dir = $self->dir;
 190   $value =~ /^(.*)$/s;
 191   $value = $1;
 192   unless ( join("\n", @{[ $self->config($file) ]}) eq $value ) {
 193     warn "[FS::Conf] SET $file\n" if $DEBUG;
 194 #    warn "$dir" if is_tainted($dir);
 195 #    warn "$dir" if is_tainted($file);
 196     chmod 0644, "$dir/$file";
 197     my $fh = new IO::File ">$dir/$file" or return;
 198     chmod 0644, "$dir/$file";
 199     print $fh "$value\n";
 200   }
 201 }
 202 #sub is_tainted {
 203 #             return ! eval { join('',@_), kill 0; 1; };
 204 #         }
 205
 206 =item delete KEY
 207
 208 Deletes the specified configuration key.
 209
 210 =cut
 211
 212 sub delete {
 213   my($self, $file) = @_;
 214   my $dir = $self->dir;
 215   if ( $self->exists($file) ) {
 216     warn "[FS::Conf] DELETE $file\n";
 217     unlink "$dir/$file";
 218   }
 219 }
 220
 221 =item config_items
 222
 223 Returns all of the possible configuration items as FS::ConfItem objects.  See
 224 L<FS::ConfItem>.
 225
 226 =cut
 227
 228 sub config_items {
 229   my $self = shift;
 230   #quelle kludge
 231   @config_items,
 232   ( map {
 233         my $basename = basename($_);
 234         $basename =~ /^(.*)$/;
 235         $basename = $1;
 236         new FS::ConfItem {
 237                            'key'         => $basename,
 238                            'section'     => 'billing',
 239                            'description' => 'Alternate template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 240                            'type'        => 'textarea',
 241                          }
 242       } glob($self->dir. '/invoice_template_*')
 243   ),
 244   ( map {
 245         my $basename = basename($_);
 246         $basename =~ /^(.*)$/;
 247         $basename = $1;
 248         new FS::ConfItem {
 249                            'key'         => $basename,
 250                            'section'     => 'billing',
 251                            'description' => 'Alternate HTML template for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 252                            'type'        => 'textarea',
 253                          }
 254       } glob($self->dir. '/invoice_html_*')
 255   ),
 256   ( map {
 257         my $basename = basename($_);
 258         $basename =~ /^(.*)$/;
 259         $basename = $1;
 260         ($latexname = $basename ) =~ s/latex/html/;
 261         new FS::ConfItem {
 262                            'key'         => $basename,
 263                            'section'     => 'billing',
 264                            'description' => "Alternate Notes section for HTML invoices.  Defaults to the same data in $latexname if not specified.",
 265                            'type'        => 'textarea',
 266                          }
 267       } glob($self->dir. '/invoice_htmlnotes_*')
 268   ),
 269   ( map {
 270         my $basename = basename($_);
 271         $basename =~ /^(.*)$/;
 272         $basename = $1;
 273         new FS::ConfItem {
 274                            'key'         => $basename,
 275                            'section'     => 'billing',
 276                            'description' => 'Alternate LaTeX template for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 277                            'type'        => 'textarea',
 278                          }
 279       } glob($self->dir. '/invoice_latex_*')
 280   ),
 281   ( map {
 282         my $basename = basename($_);
 283         $basename =~ /^(.*)$/;
 284         $basename = $1;
 285         new FS::ConfItem {
 286                            'key'         => $basename,
 287                            'section'     => 'billing',
 288                            'description' => 'Alternate Notes section for LaTeX typeset PostScript invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 289                            'type'        => 'textarea',
 290                          }
 291       } glob($self->dir. '/invoice_latexnotes_*')
 292   );
 293 }
 294
 295 =back
 296
 297 =head1 BUGS
 298
 299 If this was more than just crud that will never be useful outside Freeside I'd
 300 worry that config_items is freeside-specific and icky.
 301
 302 =head1 SEE ALSO
 303
 304 "Configuration" in the web interface (config/config.cgi).
 305
 306 httemplate/docs/config.html
 307
 308 =cut
 309
 310 #Business::CreditCard
 311 @card_types = (
 312   "VISA card",
 313   "MasterCard",
 314   "Discover card",
 315   "American Express card",
 316   "Diner's Club/Carte Blanche",
 317   "enRoute",
 318   "JCB",
 319   "BankCard",
 320   "Switch",
 321   "Solo",
 322 );
 323
 324 @config_items = map { new FS::ConfItem $_ } (
 325
 326   {
 327     'key'         => 'address',
 328     'section'     => 'deprecated',
 329     'description' => 'This configuration option is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 330     'type'        => 'text',
 331   },
 332
 333   {
 334     'key'         => 'alerter_template',
 335     'section'     => 'billing',
 336     'description' => 'Template file for billing method expiration alerts.  See the <a href="../docs/billing.html#invoice_template">billing documentation</a> for details.',
 337     'type'        => 'textarea',
 338   },
 339
 340   {
 341     'key'         => 'apacheroot',
 342     'section'     => 'deprecated',
 343     'description' => '<b>DEPRECATED</b>, add a <i>www_shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  The directory containing Apache virtual hosts',
 344     'type'        => 'text',
 345   },
 346
 347   {
 348     'key'         => 'apacheip',
 349     'section'     => 'deprecated',
 350     'description' => '<b>DEPRECATED</b>, add an <i>apache</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the current IP address to assign to new virtual hosts',
 351     'type'        => 'text',
 352   },
 353
 354   {
 355     'key'         => 'apachemachine',
 356     'section'     => 'deprecated',
 357     'description' => '<b>DEPRECATED</b>, add a <i>www_shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  A machine with the apacheroot directory and user home directories.  The existance of this file enables setup of virtual host directories, and, in conjunction with the `home\' configuration file, symlinks into user home directories.',
 358     'type'        => 'text',
 359   },
 360
 361   {
 362     'key'         => 'apachemachines',
 363     'section'     => 'deprecated',
 364     'description' => '<b>DEPRECATED</b>, add an <i>apache</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be Apache machines, one per line.  This enables export of `/etc/apache/vhosts.conf\', which can be included in your Apache configuration via the <a href="http://www.apache.org/docs/mod/core.html#include">Include</a> directive.',
 365     'type'        => 'textarea',
 366   },
 367
 368   {
 369     'key'         => 'bindprimary',
 370     'section'     => 'deprecated',
 371     'description' => '<b>DEPRECATED</b>, add a <i>bind</i> <a href="../browse/part_export.cgi">export</a> instead.  Your BIND primary nameserver.  This enables export of /var/named/named.conf and zone files into /var/named',
 372     'type'        => 'text',
 373   },
 374
 375   {
 376     'key'         => 'bindsecondaries',
 377     'section'     => 'deprecated',
 378     'description' => '<b>DEPRECATED</b>, add a <i>bind_slave</i> <a href="../browse/part_export.cgi">export</a> instead.  Your BIND secondary nameservers, one per line.  This enables export of /var/named/named.conf',
 379     'type'        => 'textarea',
 380   },
 381
 382   {
 383     'key'         => 'encryption',
 384     'section'     => 'billing',
 385     'description' => 'Enable encryption of credit cards.',
 386     'type'        => 'checkbox',
 387   },
 388
 389   {
 390     'key'         => 'encryptionmodule',
 391     'section'     => 'billing',
 392     'description' => 'Use which module for encryption?',
 393     'type'        => 'text',
 394   },
 395
 396   {
 397     'key'         => 'encryptionpublickey',
 398     'section'     => 'billing',
 399     'description' => 'Your RSA Public Key - Required if Encryption is turned on.',
 400     'type'        => 'textarea',
 401   },
 402
 403   {
 404     'key'         => 'encryptionprivatekey',
 405     'section'     => 'billing',
 406     'description' => 'Your RSA Private Key - Including this will enable the "Bill Now" feature.  However if the system is compromised, a hacker can use this key to decode the stored credit card information.  This is generally not a good idea.',
 407     'type'        => 'textarea',
 408   },
 409
 410   {
 411     'key'         => 'business-onlinepayment',
 412     'section'     => 'billing',
 413     'description' => '<a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support, at least three lines: processor, login, and password.  An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\').    Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
 414     'type'        => 'textarea',
 415   },
 416
 417   {
 418     'key'         => 'business-onlinepayment-ach',
 419     'section'     => 'billing',
 420     'description' => 'Alternate <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a> support for ACH transactions (defaults to regular <b>business-onlinepayment</b>).  At least three lines: processor, login, and password.  An optional fourth line specifies the action or actions (multiple actions are separated with `,\': for example: `Authorization Only, Post Authorization\').    Optional additional lines are passed to Business::OnlinePayment as %processor_options.',
 421     'type'        => 'textarea',
 422   },
 423
 424   {
 425     'key'         => 'business-onlinepayment-description',
 426     'section'     => 'billing',
 427     'description' => 'String passed as the description field to <a href="http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment">Business::OnlinePayment</a>.  Evaluated as a double-quoted perl string, with the following variables available: <code>$agent</code> (the agent name), and <code>$pkgs</code> (a comma-separated list of packages for which these charges apply)',
 428     'type'        => 'text',
 429   },
 430
 431   {
 432     'key'         => 'business-onlinepayment-email-override',
 433     'section'     => 'billing',
 434     'description' => 'Email address used instead of customer email address when submitting a BOP transaction.',
 435     'type'        => 'text',
 436   },
 437
 438   {
 439     'key'         => 'bsdshellmachines',
 440     'section'     => 'deprecated',
 441     'description' => '<b>DEPRECATED</b>, add a <i>bsdshell</i> <a href="../browse/part_export.cgi">export</a> instead.  Your BSD flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd\' and `/etc/master.passwd\'.',
 442     'type'        => 'textarea',
 443   },
 444
 445   {
 446    'key'         => 'business-onlinepayment-email_customer',
 447    'section'     => 'billing',
 448    'description' => 'Controls the "email_customer" flag used by some Business::OnlinePayment processors to enable customer receipts.',
 449    'type'        => 'checkbox',
 450   },
 451
 452   {
 453     'key'         => 'countrydefault',
 454     'section'     => 'UI',
 455     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
 456     'type'        => 'text',
 457   },
 458
 459   {
 460     'key'         => 'date_format',
 461     'section'     => 'UI',
 462     'description' => 'Format for displaying dates',
 463     'type'        => 'select',
 464     'select_hash' => [
 465                        '%m/%d/%Y' => 'MM/DD/YYYY',
 466                        '%Y/%m/%d' => 'YYYY/MM/DD',
 467                      ],
 468   },
 469
 470   {
 471     'key'         => 'cyrus',
 472     'section'     => 'deprecated',
 473     'description' => '<b>DEPRECATED</b>, add a <i>cyrus</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to integrate with <a href="http://asg.web.cmu.edu/cyrus/imapd/">Cyrus IMAP Server</a>, three lines: IMAP server, admin username, and admin password.  Cyrus::IMAP::Admin should be installed locally and the connection to the server secured.',
 474     'type'        => 'textarea',
 475   },
 476
 477   {
 478     'key'         => 'cp_app',
 479     'section'     => 'deprecated',
 480     'description' => '<b>DEPRECATED</b>, add a <i>cp</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to integrate with <a href="http://www.cp.net/">Critial Path Account Provisioning Protocol</a>, four lines: "host:port", username, password, and workgroup (for new users).',
 481     'type'        => 'textarea',
 482   },
 483
 484   {
 485     'key'         => 'deletecustomers',
 486     'section'     => 'UI',
 487     'description' => 'Enable customer deletions.  Be very careful!  Deleting a customer will remove all traces that this customer ever existed!  It should probably only be used when auditing a legacy database.  Normally, you cancel all of a customers\' packages if they cancel service.',
 488     'type'        => 'checkbox',
 489   },
 490
 491   {
 492     'key'         => 'deletepayments',
 493     'section'     => 'billing',
 494     'description' => 'Enable deletion of unclosed payments.  Really, with voids this is pretty much not recommended in any situation anymore.  Be very careful!  Only delete payments that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a payment is deleted.',
 495     'type'        => [qw( checkbox text )],
 496   },
 497
 498   {
 499     'key'         => 'deletecredits',
 500     'section'     => 'deprecated',
 501     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable deletion of unclosed credits.  Be very careful!  Only delete credits that were data-entry errors, not adjustments.  Optionally specify one or more comma-separated email addresses to be notified when a credit is deleted.',
 502     'type'        => [qw( checkbox text )],
 503   },
 504
 505   {
 506     'key'         => 'deleterefunds',
 507     'section'     => 'billing',
 508     'description' => 'Enable deletion of unclosed refunds.  Be very careful!  Only delete refunds that were data-entry errors, not adjustments.',
 509     'type'        => 'checkbox',
 510   },
 511
 512   {
 513     'key'         => 'unapplypayments',
 514     'section'     => 'deprecated',
 515     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable "unapplication" of unclosed payments.',
 516     'type'        => 'checkbox',
 517   },
 518
 519   {
 520     'key'         => 'unapplycredits',
 521     'section'     => 'deprecated',
 522     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to nable "unapplication" of unclosed credits.',
 523     'type'        => 'checkbox',
 524   },
 525
 526   {
 527     'key'         => 'dirhash',
 528     'section'     => 'shell',
 529     'description' => 'Optional numeric value to control directory hashing.  If positive, hashes directories for the specified number of levels from the front of the username.  If negative, hashes directories for the specified number of levels from the end of the username.  Some examples: <ul><li>1: user -> <a href="#home">/home</a>/u/user<li>2: user -> <a href="#home">/home</a>/u/s/user<li>-1: user -> <a href="#home">/home</a>/r/user<li>-2: user -> <a href="#home">home</a>/r/e/user</ul>',
 530     'type'        => 'text',
 531   },
 532
 533   {
 534     'key'         => 'disable_customer_referrals',
 535     'section'     => 'UI',
 536     'description' => 'Disable new customer-to-customer referrals in the web interface',
 537     'type'        => 'checkbox',
 538   },
 539
 540   {
 541     'key'         => 'editreferrals',
 542     'section'     => 'UI',
 543     'description' => 'Enable advertising source modification for existing customers',
 544     'type'       => 'checkbox',
 545   },
 546
 547   {
 548     'key'         => 'emailinvoiceonly',
 549     'section'     => 'billing',
 550     'description' => 'Disables postal mail invoices',
 551     'type'       => 'checkbox',
 552   },
 553
 554   {
 555     'key'         => 'disablepostalinvoicedefault',
 556     'section'     => 'billing',
 557     'description' => 'Disables postal mail invoices as the default option in the UI.  Be careful not to setup customers which are not sent invoices.  See <a href ="#emailinvoiceauto">emailinvoiceauto</a>.',
 558     'type'       => 'checkbox',
 559   },
 560
 561   {
 562     'key'         => 'emailinvoiceauto',
 563     'section'     => 'billing',
 564     'description' => 'Automatically adds new accounts to the email invoice list',
 565     'type'       => 'checkbox',
 566   },
 567
 568   {
 569     'key'         => 'emailinvoiceautoalways',
 570     'section'     => 'billing',
 571     'description' => 'Automatically adds new accounts to the email invoice list even when the list contains email addresses',
 572     'type'       => 'checkbox',
 573   },
 574
 575   {
 576     'key'         => 'exclude_ip_addr',
 577     'section'     => '',
 578     'description' => 'Exclude these from the list of available broadband service IP addresses. (One per line)',
 579     'type'        => 'textarea',
 580   },
 581
 582   {
 583     'key'         => 'erpcdmachines',
 584     'section'     => 'deprecated',
 585     'description' => '<b>DEPRECATED</b>, ERPCD is no longer supported.  Used to be ERPCD authentication machines, one per line.  This enables export of `/usr/annex/acp_passwd\' and `/usr/annex/acp_dialup\'',
 586     'type'        => 'textarea',
 587   },
 588
 589   {
 590     'key'         => 'hidecancelledpackages',
 591     'section'     => 'UI',
 592     'description' => 'Prevent cancelled packages from showing up in listings (though they will still be in the database)',
 593     'type'        => 'checkbox',
 594   },
 595
 596   {
 597     'key'         => 'hidecancelledcustomers',
 598     'section'     => 'UI',
 599     'description' => 'Prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
 600     'type'        => 'checkbox',
 601   },
 602
 603   {
 604     'key'         => 'home',
 605     'section'     => 'required',
 606     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
 607     'type'        => 'text',
 608   },
 609
 610   {
 611     'key'         => 'icradiusmachines',
 612     'section'     => 'deprecated',
 613     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to enable radcheck and radreply table population - by default in the Freeside database, or in the database specified by the <a href="http://rootwood.haze.st/aspside/config/config-view.cgi#icradius_secrets">icradius_secrets</a> config option (the radcheck and radreply tables needs to be created manually).  You do not need to use MySQL for your Freeside database to export to an ICRADIUS/FreeRADIUS MySQL database with this option.  <blockquote><b>ADDITIONAL DEPRECATED FUNCTIONALITY</b> (instead use <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Replication">MySQL replication</a> or point icradius_secrets to the external database) - your <a href="ftp://ftp.cheapnet.net/pub/icradius">ICRADIUS</a> machines or <a href="http://www.freeradius.org/">FreeRADIUS</a> (with MySQL authentication) machines, one per line.  Machines listed in this file will have the radcheck table exported to them.  Each line should contain four items, separted by whitespace: machine name, MySQL database name, MySQL username, and MySQL password.  For example: <CODE>"radius.isp.tld&nbsp;radius_db&nbsp;radius_user&nbsp;passw0rd"</CODE></blockquote>',
 614     'type'        => [qw( checkbox textarea )],
 615   },
 616
 617   {
 618     'key'         => 'icradius_mysqldest',
 619     'section'     => 'deprecated',
 620     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the destination directory for the MySQL databases, on the ICRADIUS/FreeRADIUS machines.  Defaults to "/usr/local/var/".',
 621     'type'        => 'text',
 622   },
 623
 624   {
 625     'key'         => 'icradius_mysqlsource',
 626     'section'     => 'deprecated',
 627     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be the source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".',
 628     'type'        => 'text',
 629   },
 630
 631   {
 632     'key'         => 'icradius_secrets',
 633     'section'     => 'deprecated',
 634     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to specify a database for ICRADIUS/FreeRADIUS export.  Three lines: DBI data source, username and password.',
 635     'type'        => 'textarea',
 636   },
 637
 638   {
 639     'key'         => 'invoice_from',
 640     'section'     => 'required',
 641     'description' => 'Return address on email invoices',
 642     'type'        => 'text',
 643   },
 644
 645   {
 646     'key'         => 'invoice_template',
 647     'section'     => 'required',
 648     'description' => 'Required template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 649     'type'        => 'textarea',
 650   },
 651
 652   {
 653     'key'         => 'invoice_html',
 654     'section'     => 'billing',
 655     'description' => 'Optional HTML template for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 656
 657     'type'        => 'textarea',
 658   },
 659
 660   {
 661     'key'         => 'invoice_htmlnotes',
 662     'section'     => 'billing',
 663     'description' => 'Notes section for HTML invoices.  Defaults to the same data in invoice_latexnotes if not specified.',
 664     'type'        => 'textarea',
 665   },
 666
 667   {
 668     'key'         => 'invoice_htmlfooter',
 669     'section'     => 'billing',
 670     'description' => 'Footer for HTML invoices.  Defaults to the same data in invoice_latexfooter if not specified.',
 671     'type'        => 'textarea',
 672   },
 673
 674   {
 675     'key'         => 'invoice_htmlreturnaddress',
 676     'section'     => 'billing',
 677     'description' => 'Return address for HTML invoices.  Defaults to the same data in invoice_latexreturnaddress if not specified.',
 678     'type'        => 'textarea',
 679   },
 680
 681   {
 682     'key'         => 'invoice_latex',
 683     'section'     => 'billing',
 684     'description' => 'Optional LaTeX template for typeset PostScript invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 685     'type'        => 'textarea',
 686   },
 687
 688   {
 689     'key'         => 'invoice_latexnotes',
 690     'section'     => 'billing',
 691     'description' => 'Notes section for LaTeX typeset PostScript invoices.',
 692     'type'        => 'textarea',
 693   },
 694
 695   {
 696     'key'         => 'invoice_latexfooter',
 697     'section'     => 'billing',
 698     'description' => 'Footer for LaTeX typeset PostScript invoices.',
 699     'type'        => 'textarea',
 700   },
 701
 702   {
 703     'key'         => 'invoice_latexcoupon',
 704     'section'     => 'billing',
 705     'description' => 'Remittance coupon for LaTeX typeset PostScript invoices.',
 706     'type'        => 'textarea',
 707   },
 708
 709   {
 710     'key'         => 'invoice_latexreturnaddress',
 711     'section'     => 'billing',
 712     'description' => 'Return address for LaTeX typeset PostScript invoices.',
 713     'type'        => 'textarea',
 714   },
 715
 716   {
 717     'key'         => 'invoice_latexsmallfooter',
 718     'section'     => 'billing',
 719     'description' => 'Optional small footer for multi-page LaTeX typeset PostScript invoices.',
 720     'type'        => 'textarea',
 721   },
 722
 723   {
 724     'key'         => 'invoice_email_pdf',
 725     'section'     => 'billing',
 726     'description' => 'Send PDF invoice as an attachment to emailed invoices.  By default, includes the plain text invoice as the email body, unless invoice_email_pdf_note is set.',
 727     'type'        => 'checkbox'
 728   },
 729
 730   {
 731     'key'         => 'invoice_email_pdf_note',
 732     'section'     => 'billing',
 733     'description' => 'If defined, this text will replace the default plain text invoice as the body of emailed PDF invoices.',
 734     'type'        => 'textarea'
 735   },
 736
 737
 738   {
 739     'key'         => 'invoice_default_terms',
 740     'section'     => 'billing',
 741     'description' => 'Optional default invoice term, used to calculate a due date printed on invoices.',
 742     'type'        => 'select',
 743     'select_enum' => [ '', 'Payable upon receipt', 'Net 0', 'Net 10', 'Net 15', 'Net 30', 'Net 45', 'Net 60' ],
 744   },
 745
 746   {
 747     'key'         => 'invoice_send_receipts',
 748     'section'     => 'deprecated',
 749     'description' => '<b>DEPRECATED</b>, this used to send an invoice copy on payments and credits.  See the payment_receipt_email and XXXX instead.',
 750     'type'        => 'checkbox',
 751   },
 752
 753   {
 754     'key'         => 'payment_receipt_email',
 755     'section'     => 'billing',
 756     'description' => 'Template file for payment receipts.  Payment receipts are sent to the customer email invoice destination(s) when a payment is received.  See the <a href="http://search.cpan.org/~mjd/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language.  The following variables are available: <ul><li><code>$date</code> <li><code>$name</code> <li><code>$paynum</code> - Freeside payment number <li><code>$paid</code> - Amount of payment <li><code>$payby</code> - Payment type (Card, Check, Electronic check, etc.) <li><code>$payinfo</code> - Masked credit card number or check number <li><code>$balance</code> - New balance</ul>',
 757     'type'        => [qw( checkbox textarea )],
 758   },
 759
 760   {
 761     'key'         => 'lpr',
 762     'section'     => 'required',
 763     'description' => 'Print command for paper invoices, for example `lpr -h\'',
 764     'type'        => 'text',
 765   },
 766
 767   {
 768     'key'         => 'maildisablecatchall',
 769     'section'     => 'deprecated',
 770     'description' => '<b>DEPRECATED</b>, now the default.  Turning this option on used to disable the requirement that each virtual domain have a catch-all mailbox.',
 771     'type'        => 'checkbox',
 772   },
 773
 774   {
 775     'key'         => 'lpr-postscript_prefix',
 776     'section'     => 'billing',
 777     'description' => 'Raw printer commands prepended to the beginning of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
 778     'type'        => 'text',
 779   },
 780
 781   {
 782     'key'         => 'lpr-postscript_suffix',
 783     'section'     => 'billing',
 784     'description' => 'Raw printer commands added to the end of postscript print jobs (evaluated as a double-quoted perl string - backslash escapes are available)',
 785     'type'        => 'text',
 786   },
 787
 788   {
 789     'key'         => 'money_char',
 790     'section'     => '',
 791     'description' => 'Currency symbol - defaults to `$\'',
 792     'type'        => 'text',
 793   },
 794
 795   {
 796     'key'         => 'mxmachines',
 797     'section'     => 'deprecated',
 798     'description' => 'MX entries for new domains, weight and machine, one per line, with trailing `.\'',
 799     'type'        => 'textarea',
 800   },
 801
 802   {
 803     'key'         => 'nsmachines',
 804     'section'     => 'deprecated',
 805     'description' => 'NS nameservers for new domains, one per line, with trailing `.\'',
 806     'type'        => 'textarea',
 807   },
 808
 809   {
 810     'key'         => 'defaultrecords',
 811     'section'     => 'BIND',
 812     'description' => 'DNS entries to add automatically when creating a domain',
 813     'type'        => 'editlist',
 814     'editlist_parts' => [ { type=>'text' },
 815                           { type=>'immutable', value=>'IN' },
 816                           { type=>'select',
 817                             select_enum=>{ map { $_=>$_ } qw(A CNAME MX NS TXT)} },
 818                           { type=> 'text' }, ],
 819   },
 820
 821   {
 822     'key'         => 'arecords',
 823     'section'     => 'deprecated',
 824     'description' => 'A list of tab seperated CNAME records to add automatically when creating a domain',
 825     'type'        => 'textarea',
 826   },
 827
 828   {
 829     'key'         => 'cnamerecords',
 830     'section'     => 'deprecated',
 831     'description' => 'A list of tab seperated CNAME records to add automatically when creating a domain',
 832     'type'        => 'textarea',
 833   },
 834
 835   {
 836     'key'         => 'nismachines',
 837     'section'     => 'deprecated',
 838     'description' => '<b>DEPRECATED</b>.  Your NIS master (not slave master) machines, one per line.  This enables export of `/etc/global/passwd\' and `/etc/global/shadow\'.',
 839     'type'        => 'textarea',
 840   },
 841
 842   {
 843     'key'         => 'passwordmin',
 844     'section'     => 'password',
 845     'description' => 'Minimum password length (default 6)',
 846     'type'        => 'text',
 847   },
 848
 849   {
 850     'key'         => 'passwordmax',
 851     'section'     => 'password',
 852     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
 853     'type'        => 'text',
 854   },
 855
 856   {
 857     'key' => 'password-noampersand',
 858     'section' => 'password',
 859     'description' => 'Disallow ampersands in passwords',
 860     'type' => 'checkbox',
 861   },
 862
 863   {
 864     'key' => 'password-noexclamation',
 865     'section' => 'password',
 866     'description' => 'Disallow exclamations in passwords (Not setting this could break old text Livingston or Cistron Radius servers)',
 867     'type' => 'checkbox',
 868   },
 869
 870   {
 871     'key'         => 'qmailmachines',
 872     'section'     => 'deprecated',
 873     'description' => '<b>DEPRECATED</b>, add <i>qmail</i> and <i>shellcommands</i> <a href="../browse/part_export.cgi">exports</a> instead.  This option used to export `/var/qmail/control/virtualdomains\', `/var/qmail/control/recipientmap\', and `/var/qmail/control/rcpthosts\'.  Setting this option (even if empty) also turns on user `.qmail-extension\' file maintenance in conjunction with the <b>shellmachine</b> option.',
 874     'type'        => [qw( checkbox textarea )],
 875   },
 876
 877   {
 878     'key'         => 'radiusmachines',
 879     'section'     => 'deprecated',
 880     'description' => '<b>DEPRECATED</b>, add an <i>sqlradius</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to export to be: your RADIUS authentication machines, one per line.  This enables export of `/etc/raddb/users\'.',
 881     'type'        => 'textarea',
 882   },
 883
 884   {
 885     'key'         => 'referraldefault',
 886     'section'     => 'UI',
 887     'description' => 'Default referral, specified by refnum',
 888     'type'        => 'text',
 889   },
 890
 891 #  {
 892 #    'key'         => 'registries',
 893 #    'section'     => 'required',
 894 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
 895 #  },
 896
 897   {
 898     'key'         => 'report_template',
 899     'section'     => 'deprecated',
 900     'description' => 'Deprecated template file for reports.',
 901     'type'        => 'textarea',
 902   },
 903
 904
 905   {
 906     'key'         => 'maxsearchrecordsperpage',
 907     'section'     => 'UI',
 908     'description' => 'If set, number of search records to return per page.',
 909     'type'        => 'text',
 910   },
 911
 912   {
 913     'key'         => 'sendmailconfigpath',
 914     'section'     => 'deprecated',
 915     'description' => '<b>DEPRECATED</b>, add a <i>sendmail</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be sendmail configuration file path.  Defaults to `/etc\'.  Many newer distributions use `/etc/mail\'.',
 916     'type'        => 'text',
 917   },
 918
 919   {
 920     'key'         => 'sendmailmachines',
 921     'section'     => 'deprecated',
 922     'description' => '<b>DEPRECATED</b>, add a <i>sendmail</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to be sendmail machines, one per line.  This enables export of `/etc/virtusertable\' and `/etc/sendmail.cw\'.',
 923     'type'        => 'textarea',
 924   },
 925
 926   {
 927     'key'         => 'sendmailrestart',
 928     'section'     => 'deprecated',
 929     'description' => '<b>DEPRECATED</b>, add a <i>sendmail</i> <a href="../browse/part_export.cgi">export</a> instead.  Used to define the command which is run on sendmail machines after files are copied.',
 930     'type'        => 'text',
 931   },
 932
 933   {
 934     'key'         => 'session-start',
 935     'section'     => 'session',
 936     'description' => 'If defined, the command which is executed on the Freeside machine when a session begins.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
 937     'type'        => 'text',
 938   },
 939
 940   {
 941     'key'         => 'session-stop',
 942     'section'     => 'session',
 943     'description' => 'If defined, the command which is executed on the Freeside machine when a session ends.  The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on.',
 944     'type'        => 'text',
 945   },
 946
 947   {
 948     'key'         => 'shellmachine',
 949     'section'     => 'deprecated',
 950     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain a single machine with user home directories mounted.  This enables home directory creation, renaming and archiving/deletion.  In conjunction with `qmailmachines\', it also enables `.qmail-extension\' file maintenance.',
 951     'type'        => 'text',
 952   },
 953
 954   {
 955     'key'         => 'shellmachine-useradd',
 956     'section'     => 'deprecated',
 957     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain command(s) to run on shellmachine when an account is created.  If the <b>shellmachine</b> option is set but this option is not, <code>useradd -d $dir -m -s $shell -u $uid $username</code> is the default.  If this option is set but empty, <code>cp -pr /etc/skel $dir; chown -R $uid.$gid $dir</code> is the default instead.  Otherwise the value is evaluated as a double-quoted perl string, with the following variables available: <code>$username</code>, <code>$uid</code>, <code>$gid</code>, <code>$dir</code>, and <code>$shell</code>.',
 958     'type'        => [qw( checkbox text )],
 959   },
 960
 961   {
 962     'key'         => 'shellmachine-userdel',
 963     'section'     => 'deprecated',
 964     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain command(s) to run on shellmachine when an account is deleted.  If the <b>shellmachine</b> option is set but this option is not, <code>userdel $username</code> is the default.  If this option is set but empty, <code>rm -rf $dir</code> is the default instead.  Otherwise the value is evaluated as a double-quoted perl string, with the following variables available: <code>$username</code> and <code>$dir</code>.',
 965     'type'        => [qw( checkbox text )],
 966   },
 967
 968   {
 969     'key'         => 'shellmachine-usermod',
 970     'section'     => 'deprecated',
 971     'description' => '<b>DEPRECATED</b>, add a <i>shellcommands</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain command(s) to run on shellmachine when an account is modified.  If the <b>shellmachine</b> option is set but this option is empty, <code>[ -d $old_dir ] &amp;&amp; mv $old_dir $new_dir || ( chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; find . -depth -print | cpio -pdm $new_dir; chmod u-t $new_dir; chown -R $uid.$gid $new_dir; rm -rf $old_dir )</code> is the default.  Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$old_dir</code>, <code>$new_dir</code>, <code>$uid</code> and <code>$gid</code>.',
 972     #'type'        => [qw( checkbox text )],
 973     'type'        => 'text',
 974   },
 975
 976   {
 977     'key'         => 'shellmachines',
 978     'section'     => 'deprecated',
 979     'description' => '<b>DEPRECATED</b>, add a <i>sysvshell</i> <a href="../browse/part_export.cgi">export</a> instead.  Your Linux and System V flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd\' and `/etc/shadow\' files.',
 980      'type'        => 'textarea',
 981  },
 982
 983   {
 984     'key'         => 'shells',
 985     'section'     => 'required',
 986     'description' => 'Legal shells (think /etc/shells).  You probably want to `cut -d: -f7 /etc/passwd | sort | uniq\' initially so that importing doesn\'t fail with `Illegal shell\' errors, then remove any special entries afterwords.  A blank line specifies that an empty shell is permitted.',
 987     'type'        => 'textarea',
 988   },
 989
 990   {
 991     'key'         => 'showpasswords',
 992     'section'     => 'UI',
 993     'description' => 'Display unencrypted user passwords in the backend (employee) web interface',
 994     'type'        => 'checkbox',
 995   },
 996
 997   {
 998     'key'         => 'signupurl',
 999     'section'     => 'UI',
1000     'description' => 'if you are using customer-to-customer referrals, and you enter the URL of your <a href="../docs/signup.html">signup server CGI</a>, the customer view screen will display a customized link to the signup server with the appropriate customer as referral',
1001     'type'        => 'text',
1002   },
1003
1004   {
1005     'key'         => 'smtpmachine',
1006     'section'     => 'required',
1007     'description' => 'SMTP relay for Freeside\'s outgoing mail',
1008     'type'        => 'text',
1009   },
1010
1011   {
1012     'key'         => 'soadefaultttl',
1013     'section'     => 'BIND',
1014     'description' => 'SOA default TTL for new domains.',
1015     'type'        => 'text',
1016   },
1017
1018   {
1019     'key'         => 'soaemail',
1020     'section'     => 'BIND',
1021     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
1022     'type'        => 'text',
1023   },
1024
1025   {
1026     'key'         => 'soaexpire',
1027     'section'     => 'BIND',
1028     'description' => 'SOA expire for new domains',
1029     'type'        => 'text',
1030   },
1031
1032   {
1033     'key'         => 'soamachine',
1034     'section'     => 'BIND',
1035     'description' => 'SOA machine for new domains, with trailing `.\'',
1036     'type'        => 'text',
1037   },
1038
1039   {
1040     'key'         => 'soarefresh',
1041     'section'     => 'BIND',
1042     'description' => 'SOA refresh for new domains',
1043     'type'        => 'text',
1044   },
1045
1046   {
1047     'key'         => 'soaretry',
1048     'section'     => 'BIND',
1049     'description' => 'SOA retry for new domains',
1050     'type'        => 'text',
1051   },
1052
1053   {
1054     'key'         => 'statedefault',
1055     'section'     => 'UI',
1056     'description' => 'Default state or province (if not supplied, the default is `CA\')',
1057     'type'        => 'text',
1058   },
1059
1060   {
1061     'key'         => 'radiusprepend',
1062     'section'     => 'deprecated',
1063     'description' => '<b>DEPRECATED</b>, real-time text radius now edits an existing file in place - just (turn off freeside-queued and) edit your RADIUS users file directly.  The contents used to be be prepended to the top of the RADIUS users file (text exports only).',
1064     'type'        => 'textarea',
1065   },
1066
1067   {
1068     'key'         => 'textradiusprepend',
1069     'section'     => 'deprecated',
1070     'description' => '<b>DEPRECATED</b>, use RADIUS check attributes instead.  The contents used to be prepended to the first line of a user\'s RADIUS entry in text exports.',
1071     'type'        => 'text',
1072   },
1073
1074   {
1075     'key'         => 'unsuspendauto',
1076     'section'     => 'billing',
1077     'description' => 'Enables the automatic unsuspension of suspended packages when a customer\'s balance due changes from positive to zero or negative as the result of a payment or credit',
1078     'type'        => 'checkbox',
1079   },
1080
1081   {
1082     'key'         => 'unsuspend-always_adjust_next_bill_date',
1083     'section'     => 'billing',
1084     'description' => 'Global override that causes unsuspensions to always adjust the next bill date under any circumstances.  This is now controlled on a per-package bases - probably best not to use this option unless you are a legacy installation that requires this behaviour.',
1085     'type'        => 'checkbox',
1086   },
1087
1088   {
1089     'key'         => 'usernamemin',
1090     'section'     => 'username',
1091     'description' => 'Minimum username length (default 2)',
1092     'type'        => 'text',
1093   },
1094
1095   {
1096     'key'         => 'usernamemax',
1097     'section'     => 'username',
1098     'description' => 'Maximum username length',
1099     'type'        => 'text',
1100   },
1101
1102   {
1103     'key'         => 'username-ampersand',
1104     'section'     => 'username',
1105     'description' => 'Allow the ampersand character (&amp;) in usernames.  Be careful when using this option in conjunction with <a href="../browse/part_export.cgi">exports</a> which execute shell commands, as the ampersand will be interpreted by the shell if not quoted.',
1106     'type'        => 'checkbox',
1107   },
1108
1109   {
1110     'key'         => 'username-letter',
1111     'section'     => 'username',
1112     'description' => 'Usernames must contain at least one letter',
1113     'type'        => 'checkbox',
1114   },
1115
1116   {
1117     'key'         => 'username-letterfirst',
1118     'section'     => 'username',
1119     'description' => 'Usernames must start with a letter',
1120     'type'        => 'checkbox',
1121   },
1122
1123   {
1124     'key'         => 'username-noperiod',
1125     'section'     => 'username',
1126     'description' => 'Disallow periods in usernames',
1127     'type'        => 'checkbox',
1128   },
1129
1130   {
1131     'key'         => 'username-nounderscore',
1132     'section'     => 'username',
1133     'description' => 'Disallow underscores in usernames',
1134     'type'        => 'checkbox',
1135   },
1136
1137   {
1138     'key'         => 'username-nodash',
1139     'section'     => 'username',
1140     'description' => 'Disallow dashes in usernames',
1141     'type'        => 'checkbox',
1142   },
1143
1144   {
1145     'key'         => 'username-uppercase',
1146     'section'     => 'username',
1147     'description' => 'Allow uppercase characters in usernames',
1148     'type'        => 'checkbox',
1149   },
1150
1151   {
1152     'key'         => 'username-percent',
1153     'section'     => 'username',
1154     'description' => 'Allow the percent character (%) in usernames.',
1155     'type'        => 'checkbox',
1156   },
1157
1158   {
1159     'key'         => 'username_policy',
1160     'section'     => 'deprecated',
1161     'description' => 'This file controls the mechanism for preventing duplicate usernames in passwd/radius files exported from svc_accts.  This should be one of \'prepend domsvc\' \'append domsvc\' \'append domain\' or \'append @domain\'',
1162     'type'        => 'select',
1163     'select_enum' => [ 'prepend domsvc', 'append domsvc', 'append domain', 'append @domain' ],
1164     #'type'        => 'text',
1165   },
1166
1167   {
1168     'key'         => 'vpopmailmachines',
1169     'section'     => 'deprecated',
1170     'description' => '<b>DEPRECATED</b>, add a <i>vpopmail</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to contain your vpopmail pop toasters, one per line.  Each line is of the form "machinename vpopdir vpopuid vpopgid".  For example: <code>poptoaster.domain.tld /home/vpopmail 508 508</code>  Note: vpopuid and vpopgid are values taken from the vpopmail machine\'s /etc/passwd',
1171     'type'        => 'textarea',
1172   },
1173
1174   {
1175     'key'         => 'vpopmailrestart',
1176     'section'     => 'deprecated',
1177     'description' => '<b>DEPRECATED</b>, add a <i>vpopmail</i> <a href="../browse/part_export.cgi">export</a> instead.  This option used to define the shell commands to run on vpopmail machines after files are copied.  An example can be found in eg/vpopmailrestart of the source distribution.',
1178     'type'        => 'textarea',
1179   },
1180
1181   {
1182     'key'         => 'safe-part_pkg',
1183     'section'     => 'deprecated',
1184     'description' => '<b>DEPRECATED</b>, obsolete.  Used to validate package definition setup and recur expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
1185     'type'        => 'checkbox',
1186   },
1187
1188   {
1189     'key'         => 'safe-part_bill_event',
1190     'section'     => 'UI',
1191     'description' => 'Validates invoice event expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
1192     'type'        => 'checkbox',
1193   },
1194
1195   {
1196     'key'         => 'show_ss',
1197     'section'     => 'UI',
1198     'description' => 'Turns on display/collection of SS# in the web interface.',
1199     'type'        => 'checkbox',
1200   },
1201
1202   {
1203     'key'         => 'show_stateid',
1204     'section'     => 'UI',
1205     'description' => "Turns on display/collection of driver's license/state issued id numbers in the web interface.  Sometimes required by electronic check (ACH) processors.",
1206     'type'        => 'checkbox',
1207   },
1208
1209   {
1210     'key'         => 'show_bankstate',
1211     'section'     => 'UI',
1212     'description' => "Turns on display/collection of state for bank accounts in the web interface.  Sometimes required by electronic check (ACH) processors.",
1213     'type'        => 'checkbox',
1214   },
1215
1216   {
1217     'key'         => 'agent_defaultpkg',
1218     'section'     => 'UI',
1219     'description' => 'Setting this option will cause new packages to be available to all agent types by default.',
1220     'type'        => 'checkbox',
1221   },
1222
1223   {
1224     'key'         => 'legacy_link',
1225     'section'     => 'UI',
1226     'description' => 'Display options in the web interface to link legacy pre-Freeside services.',
1227     'type'        => 'checkbox',
1228   },
1229
1230   {
1231     'key'         => 'legacy_link-steal',
1232     'section'     => 'UI',
1233     'description' => 'Allow "stealing" an already-audited service from one customer (or package) to another using the link function.',
1234     'type'        => 'checkbox',
1235   },
1236
1237   {
1238     'key'         => 'queue_dangerous_controls',
1239     'section'     => 'UI',
1240     'description' => 'Enable queue modification controls on account pages and for new jobs.  Unless you are a developer working on new export code, you should probably leave this off to avoid causing provisioning problems.',
1241     'type'        => 'checkbox',
1242   },
1243
1244   {
1245     'key'         => 'security_phrase',
1246     'section'     => 'password',
1247     'description' => 'Enable the tracking of a "security phrase" with each account.  Not recommended, as it is vulnerable to social engineering.',
1248     'type'        => 'checkbox',
1249   },
1250
1251   {
1252     'key'         => 'locale',
1253     'section'     => 'UI',
1254     'description' => 'Message locale',
1255     'type'        => 'select',
1256     'select_enum' => [ qw(en_US) ],
1257   },
1258
1259   {
1260     'key'         => 'selfservice_server-quiet',
1261     'section'     => 'deprecated',
1262     'description' => '<b>DEPRECATED</b>, the self-service server no longer sends superfluous decline and cancel emails.  Used to disable decline and cancel emails generated by transactions initiated by the selfservice server.',
1263     'type'        => 'checkbox',
1264   },
1265
1266   {
1267     'key'         => 'signup_server-quiet',
1268     'section'     => 'deprecated',
1269     'description' => '<b>DEPRECATED</b>, the signup server is now part of the self-service server and no longer sends superfluous decline and cancel emails.  Used to disable decline and cancel emails generated by transactions initiated by the signup server.  Does not disable welcome emails.',
1270     'type'        => 'checkbox',
1271   },
1272
1273   {
1274     'key'         => 'signup_server-payby',
1275     'section'     => '',
1276     'description' => 'Acceptable payment types for the signup server',
1277     'type'        => 'selectmultiple',
1278     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB PREPAY BILL COMP) ],
1279   },
1280
1281   {
1282     'key'         => 'signup_server-email',
1283     'section'     => 'deprecated',
1284     'description' => '<b>DEPRECATED</b>, this feature is no longer available.  See the ***fill me in*** report instead.  Used to contain a comma-separated list of email addresses to receive notification of signups via the signup server.',
1285     'type'        => 'text',
1286   },
1287
1288   {
1289     'key'         => 'signup_server-default_agentnum',
1290     'section'     => '',
1291     'description' => 'Default agent for the signup server',
1292     'type'        => 'select-sub',
1293     'options_sub' => sub { require FS::Record;
1294                            require FS::agent;
1295                            map { $_->agentnum => $_->agent }
1296                                FS::Record::qsearch('agent', { disabled=>'' } );
1297                          },
1298     'option_sub'  => sub { require FS::Record;
1299                            require FS::agent;
1300                            my $agent = FS::Record::qsearchs(
1301                              'agent', { 'agentnum'=>shift }
1302                            );
1303                            $agent ? $agent->agent : '';
1304                          },
1305   },
1306
1307   {
1308     'key'         => 'signup_server-default_refnum',
1309     'section'     => '',
1310     'description' => 'Default advertising source for the signup server',
1311     'type'        => 'select-sub',
1312     'options_sub' => sub { require FS::Record;
1313                            require FS::part_referral;
1314                            map { $_->refnum => $_->referral }
1315                                FS::Record::qsearch( 'part_referral',
1316                                                     { 'disabled' => '' }
1317                                                   );
1318                          },
1319     'option_sub'  => sub { require FS::Record;
1320                            require FS::part_referral;
1321                            my $part_referral = FS::Record::qsearchs(
1322                              'part_referral', { 'refnum'=>shift } );
1323                            $part_referral ? $part_referral->referral : '';
1324                          },
1325   },
1326
1327   {
1328     'key'         => 'signup_server-default_pkgpart',
1329     'section'     => '',
1330     'description' => 'Default pakcage for the signup server',
1331     'type'        => 'select-sub',
1332     'options_sub' => sub { require FS::Record;
1333                            require FS::part_pkg;
1334                            map { $_->pkgpart => $_->pkg.' - '.$_->comment }
1335                                FS::Record::qsearch( 'part_pkg',
1336                                                     { 'disabled' => ''}
1337                                                   );
1338                          },
1339     'option_sub'  => sub { require FS::Record;
1340                            require FS::part_pkg;
1341                            my $part_pkg = FS::Record::qsearchs(
1342                              'part_pkg', { 'pkgpart'=>shift }
1343                            );
1344                            $part_pkg
1345                              ? $part_pkg->pkg.' - '.$part_pkg->comment
1346                              : '';
1347                          },
1348   },
1349
1350   {
1351     'key'         => 'show-msgcat-codes',
1352     'section'     => 'UI',
1353     'description' => 'Show msgcat codes in error messages.  Turn this option on before reporting errors to the mailing list.',
1354     'type'        => 'checkbox',
1355   },
1356
1357   {
1358     'key'         => 'signup_server-realtime',
1359     'section'     => '',
1360     'description' => 'Run billing for signup server signups immediately, and do not provision accounts which subsequently have a balance.',
1361     'type'        => 'checkbox',
1362   },
1363   {
1364     'key'         => 'signup_server-classnum2',
1365     'section'     => '',
1366     'description' => 'Package Class for first optional purchase',
1367     'type'        => 'select-sub',
1368     'options_sub' => sub { require FS::Record;
1369                            require FS::pkg_class;
1370                            map { $_->classnum => $_->classname }
1371                                FS::Record::qsearch('pkg_class', {} );
1372                          },
1373     'option_sub'  => sub { require FS::Record;
1374                            require FS::pkg_class;
1375                            my $pkg_class = FS::Record::qsearchs(
1376                              'pkg_class', { 'classnum'=>shift }
1377                            );
1378                            $pkg_class ? $pkg_class->classname : '';
1379                          },
1380   },
1381
1382   {
1383     'key'         => 'signup_server-classnum3',
1384     'section'     => '',
1385     'description' => 'Package Class for second optional purchase',
1386     'type'        => 'select-sub',
1387     'options_sub' => sub { require FS::Record;
1388                            require FS::pkg_class;
1389                            map { $_->classnum => $_->classname }
1390                                FS::Record::qsearch('pkg_class', {} );
1391                          },
1392     'option_sub'  => sub { require FS::Record;
1393                            require FS::pkg_class;
1394                            my $pkg_class = FS::Record::qsearchs(
1395                              'pkg_class', { 'classnum'=>shift }
1396                            );
1397                            $pkg_class ? $pkg_class->classname : '';
1398                          },
1399   },
1400
1401   {
1402     'key'         => 'backend-realtime',
1403     'section'     => '',
1404     'description' => 'Run billing for backend signups immediately.',
1405     'type'        => 'checkbox',
1406   },
1407
1408   {
1409     'key'         => 'declinetemplate',
1410     'section'     => 'billing',
1411     'description' => 'Template file for credit card decline emails.',
1412     'type'        => 'textarea',
1413   },
1414
1415   {
1416     'key'         => 'emaildecline',
1417     'section'     => 'billing',
1418     'description' => 'Enable emailing of credit card decline notices.',
1419     'type'        => 'checkbox',
1420   },
1421
1422   {
1423     'key'         => 'emaildecline-exclude',
1424     'section'     => 'billing',
1425     'description' => 'List of error messages that should not trigger email decline notices, one per line.',
1426     'type'        => 'textarea',
1427   },
1428
1429   {
1430     'key'         => 'cancelmessage',
1431     'section'     => 'billing',
1432     'description' => 'Template file for cancellation emails.',
1433     'type'        => 'textarea',
1434   },
1435
1436   {
1437     'key'         => 'cancelsubject',
1438     'section'     => 'billing',
1439     'description' => 'Subject line for cancellation emails.',
1440     'type'        => 'text',
1441   },
1442
1443   {
1444     'key'         => 'emailcancel',
1445     'section'     => 'billing',
1446     'description' => 'Enable emailing of cancellation notices.',
1447     'type'        => 'checkbox',
1448   },
1449
1450   {
1451     'key'         => 'require_cardname',
1452     'section'     => 'billing',
1453     'description' => 'Require an "Exact name on card" to be entered explicitly; don\'t default to using the first and last name.',
1454     'type'        => 'checkbox',
1455   },
1456
1457   {
1458     'key'         => 'enable_taxclasses',
1459     'section'     => 'billing',
1460     'description' => 'Enable per-package tax classes',
1461     'type'        => 'checkbox',
1462   },
1463
1464   {
1465     'key'         => 'require_taxclasses',
1466     'section'     => 'billing',
1467     'description' => 'Require a taxclass to be entered for every package',
1468     'type'        => 'checkbox',
1469   },
1470
1471   {
1472     'key'         => 'welcome_email',
1473     'section'     => '',
1474     'description' => 'Template file for welcome email.  Welcome emails are sent to the customer email invoice destination(s) each time a svc_acct record is created.  See the <a href="http://search.cpan.org/~mjd/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language.  The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code></ul>',
1475     'type'        => 'textarea',
1476   },
1477
1478   {
1479     'key'         => 'welcome_email-from',
1480     'section'     => '',
1481     'description' => 'From: address header for welcome email',
1482     'type'        => 'text',
1483   },
1484
1485   {
1486     'key'         => 'welcome_email-subject',
1487     'section'     => '',
1488     'description' => 'Subject: header for welcome email',
1489     'type'        => 'text',
1490   },
1491
1492   {
1493     'key'         => 'welcome_email-mimetype',
1494     'section'     => '',
1495     'description' => 'MIME type for welcome email',
1496     'type'        => 'select',
1497     'select_enum' => [ 'text/plain', 'text/html' ],
1498   },
1499
1500   {
1501     'key'         => 'welcome_letter',
1502     'section'     => '',
1503     'description' => 'Optional LaTex template file for a printed welcome letter.  A welcome letter is printed the first time a cust_pkg record is created.  See the <a href="http://search.cpan.org/~mjd/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation and the billing documentation for details on the template substitution language.  A variable exists for each fieldname in the customer record (<code>$first, $last, etc</code>).  The following additional variables are available<ul><li><code>$payby</code> - a friendler represenation of the field<li><code>$payinfo</code> - the masked payment information<li><code>$expdate</code> - the time at which the payment method expires (a UNIX timestamp)<li><code>$returnaddress</code> - the invoice return address for this customer\'s agent</ul>',
1504     'type'        => 'textarea',
1505   },
1506
1507   {
1508     'key'         => 'warning_email',
1509     'section'     => '',
1510     'description' => 'Template file for warning email.  Warning emails are sent to the customer email invoice destination(s) each time a svc_acct record has its usage drop below a threshold or 0.  See the <a href="http://search.cpan.org/~mjd/Text-Template/lib/Text/Template.pm">Text::Template</a> documentation for details on the template substitution language.  The following variables are available<ul><li><code>$username</code> <li><code>$password</code> <li><code>$first</code> <li><code>$last</code> <li><code>$pkg</code> <li><code>$column</code> <li><code>$amount</code> <li><code>$threshold</code></ul>',
1511     'type'        => 'textarea',
1512   },
1513
1514   {
1515     'key'         => 'warning_email-from',
1516     'section'     => '',
1517     'description' => 'From: address header for warning email',
1518     'type'        => 'text',
1519   },
1520
1521   {
1522     'key'         => 'warning_email-cc',
1523     'section'     => '',
1524     'description' => 'Additional recipient(s) (comma separated) for warning email when remaining usage reaches zero.',
1525     'type'        => 'text',
1526   },
1527
1528   {
1529     'key'         => 'warning_email-subject',
1530     'section'     => '',
1531     'description' => 'Subject: header for warning email',
1532     'type'        => 'text',
1533   },
1534
1535   {
1536     'key'         => 'warning_email-mimetype',
1537     'section'     => '',
1538     'description' => 'MIME type for warning email',
1539     'type'        => 'select',
1540     'select_enum' => [ 'text/plain', 'text/html' ],
1541   },
1542
1543   {
1544     'key'         => 'payby',
1545     'section'     => 'billing',
1546     'description' => 'Available payment types.',
1547     'type'        => 'selectmultiple',
1548     'select_enum' => [ qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP) ],
1549   },
1550
1551   {
1552     'key'         => 'payby-default',
1553     'section'     => 'UI',
1554     'description' => 'Default payment type.  HIDE disables display of billing information and sets customers to BILL.',
1555     'type'        => 'select',
1556     'select_enum' => [ '', qw(CARD DCRD CHEK DCHK LECB BILL CASH WEST MCRD COMP HIDE) ],
1557   },
1558
1559   {
1560     'key'         => 'paymentforcedtobatch',
1561     'section'     => 'UI',
1562     'description' => 'Causes per customer payment entry to be forced to a batch processor rather than performed realtime.',
1563     'type'        => 'checkbox',
1564   },
1565
1566   {
1567     'key'         => 'svc_acct-notes',
1568     'section'     => 'UI',
1569     'description' => 'Extra HTML to be displayed on the Account View screen.',
1570     'type'        => 'textarea',
1571   },
1572
1573   {
1574     'key'         => 'radius-password',
1575     'section'     => '',
1576     'description' => 'RADIUS attribute for plain-text passwords.',
1577     'type'        => 'select',
1578     'select_enum' => [ 'Password', 'User-Password' ],
1579   },
1580
1581   {
1582     'key'         => 'radius-ip',
1583     'section'     => '',
1584     'description' => 'RADIUS attribute for IP addresses.',
1585     'type'        => 'select',
1586     'select_enum' => [ 'Framed-IP-Address', 'Framed-Address' ],
1587   },
1588
1589   {
1590     'key'         => 'svc_acct-alldomains',
1591     'section'     => '',
1592     'description' => 'Allow accounts to select any domain in the database.  Normally accounts can only select from the domain set in the service definition and those purchased by the customer.',
1593     'type'        => 'checkbox',
1594   },
1595
1596   {
1597     'key'         => 'dump-scpdest',
1598     'section'     => '',
1599     'description' => 'destination for scp database dumps: user@host:/path',
1600     'type'        => 'text',
1601   },
1602
1603   {
1604     'key'         => 'dump-pgpid',
1605     'section'     => '',
1606     'description' => "Optional PGP public key user or key id for database dumps.  The public key should exist on the freeside user's public keyring, and the gpg binary and GnuPG perl module should be installed.",
1607     'type'        => 'text',
1608   },
1609
1610   {
1611     'key'         => 'users-allow_comp',
1612     'section'     => 'deprecated',
1613     'description' => '<b>DEPRECATED</b>, enable the <i>Complimentary customer</i> access right instead.  Was: Usernames (Freeside users, created with <a href="../docs/man/bin/freeside-adduser.html">freeside-adduser</a>) which can create complimentary customers, one per line.  If no usernames are entered, all users can create complimentary accounts.',
1614     'type'        => 'textarea',
1615   },
1616
1617   {
1618     'key'         => 'cvv-save',
1619     'section'     => 'billing',
1620     'description' => 'Save CVV2 information after the initial transaction for the selected credit card types.  Enabling this option may be in violation of your merchant agreement(s), so please check them carefully before enabling this option for any credit card types.',
1621     'type'        => 'selectmultiple',
1622     'select_enum' => \@card_types,
1623   },
1624
1625   {
1626     'key'         => 'allow_negative_charges',
1627     'section'     => 'billing',
1628     'description' => 'Allow negative charges.  Normally not used unless importing data from a legacy system that requires this.',
1629     'type'        => 'checkbox',
1630   },
1631   {
1632       'key'         => 'auto_unset_catchall',
1633       'section'     => '',
1634       'description' => 'When canceling a svc_acct that is the email catchall for one or more svc_domains, automatically set their catchall fields to null.  If this option is not set, the attempt will simply fail.',
1635       'type'        => 'checkbox',
1636   },
1637
1638   {
1639     'key'         => 'system_usernames',
1640     'section'     => 'username',
1641     'description' => 'A list of system usernames that cannot be edited or removed, one per line.  Use a bare username to prohibit modification/deletion of the username in any domain, or username@domain to prohibit modification/deletetion of a specific username and domain.',
1642     'type'        => 'textarea',
1643   },
1644
1645   {
1646     'key'         => 'cust_pkg-change_svcpart',
1647     'section'     => '',
1648     'description' => "When changing packages, move services even if svcparts don't match between old and new pacakge definitions.",
1649     'type'        => 'checkbox',
1650   },
1651
1652   {
1653     'key'         => 'disable_autoreverse',
1654     'section'     => 'BIND',
1655     'description' => 'Disable automatic synchronization of reverse-ARPA entries.',
1656     'type'        => 'checkbox',
1657   },
1658
1659   {
1660     'key'         => 'svc_www-enable_subdomains',
1661     'section'     => '',
1662     'description' => 'Enable selection of specific subdomains for virtual host creation.',
1663     'type'        => 'checkbox',
1664   },
1665
1666   {
1667     'key'         => 'svc_www-usersvc_svcpart',
1668     'section'     => '',
1669     'description' => 'Allowable service definition svcparts for virtual hosts, one per line.',
1670     'type'        => 'textarea',
1671   },
1672
1673   {
1674     'key'         => 'selfservice_server-primary_only',
1675     'section'     => '',
1676     'description' => 'Only allow primary accounts to access self-service functionality.',
1677     'type'        => 'checkbox',
1678   },
1679
1680   {
1681     'key'         => 'card_refund-days',
1682     'section'     => 'billing',
1683     'description' => 'After a payment, the number of days a refund link will be available for that payment.  Defaults to 120.',
1684     'type'        => 'text',
1685   },
1686
1687   {
1688     'key'         => 'agent-showpasswords',
1689     'section'     => '',
1690     'description' => 'Display unencrypted user passwords in the agent (reseller) interface',
1691     'type'        => 'checkbox',
1692   },
1693
1694   {
1695     'key'         => 'global_unique-username',
1696     'section'     => 'username',
1697     'description' => 'Global username uniqueness control: none (usual setting - check uniqueness per exports), username (all usernames are globally unique, regardless of domain or exports), or username@domain (all username@domain pairs are globally unique, regardless of exports).  disabled turns off duplicate checking completely and is STRONGLY NOT RECOMMENDED unless you REALLY need to turn this off.',
1698     'type'        => 'select',
1699     'select_enum' => [ 'none', 'username', 'username@domain', 'disabled' ],
1700   },
1701
1702   {
1703     'key'         => 'svc_external-skip_manual',
1704     'section'     => 'UI',
1705     'description' => 'When provisioning svc_external services, skip manual entry of id and title fields in the UI.  Usually used in conjunction with an export that populates these fields (i.e. artera_turbo).',
1706     'type'        => 'checkbox',
1707   },
1708
1709   {
1710     'key'         => 'svc_external-display_type',
1711     'section'     => 'UI',
1712     'description' => 'Select a specific svc_external type to enable some UI changes specific to that type (i.e. artera_turbo).',
1713     'type'        => 'select',
1714     'select_enum' => [ 'generic', 'artera_turbo', ],
1715   },
1716
1717   {
1718     'key'         => 'ticket_system',
1719     'section'     => '',
1720     'description' => 'Ticketing system integration.  <b>RT_Internal</b> uses the built-in RT ticketing system (see the <a href="../docs/install-rt">integrated ticketing installation instructions</a>).   <b>RT_External</b> accesses an external RT installation in a separate database (local or remote).',
1721     'type'        => 'select',
1722     #'select_enum' => [ '', qw(RT_Internal RT_Libs RT_External) ],
1723     'select_enum' => [ '', qw(RT_Internal RT_External) ],
1724   },
1725
1726   {
1727     'key'         => 'ticket_system-default_queueid',
1728     'section'     => '',
1729     'description' => 'Default queue used when creating new customer tickets.',
1730     'type'        => 'select-sub',
1731     'options_sub' => sub {
1732                            my $conf = new FS::Conf;
1733                            if ( $conf->config('ticket_system') ) {
1734                              eval "use FS::TicketSystem;";
1735                              die $@ if $@;
1736                              FS::TicketSystem->queues();
1737                            } else {
1738                              ();
1739                            }
1740                          },
1741     'option_sub'  => sub {
1742                            my $conf = new FS::Conf;
1743                            if ( $conf->config('ticket_system') ) {
1744                              eval "use FS::TicketSystem;";
1745                              die $@ if $@;
1746                              FS::TicketSystem->queue(shift);
1747                            } else {
1748                              '';
1749                            }
1750                          },
1751   },
1752
1753   {
1754     'key'         => 'ticket_system-custom_priority_field',
1755     'section'     => '',
1756     'description' => 'Custom field from the ticketing system to use as a custom priority classification.',
1757     'type'        => 'text',
1758   },
1759
1760   {
1761     'key'         => 'ticket_system-custom_priority_field-values',
1762     'section'     => '',
1763     'description' => 'Values for the custom field from the ticketing system to break down and sort customer ticket lists.',
1764     'type'        => 'textarea',
1765   },
1766
1767   {
1768     'key'         => 'ticket_system-custom_priority_field_queue',
1769     'section'     => '',
1770     'description' => 'Ticketing system queue in which the custom field specified in ticket_system-custom_priority_field is located.',
1771     'type'        => 'text',
1772   },
1773
1774   {
1775     'key'         => 'ticket_system-rt_external_datasrc',
1776     'section'     => '',
1777     'description' => 'With external RT integration, the DBI data source for the external RT installation, for example, <code>DBI:Pg:user=rt_user;password=rt_word;host=rt.example.com;dbname=rt</code>',
1778     'type'        => 'text',
1779
1780   },
1781
1782   {
1783     'key'         => 'ticket_system-rt_external_url',
1784     'section'     => '',
1785     'description' => 'With external RT integration, the URL for the external RT installation, for example, <code>https://rt.example.com/rt</code>',
1786     'type'        => 'text',
1787   },
1788
1789   {
1790     'key'         => 'company_name',
1791     'section'     => 'required',
1792     'description' => 'Your company name',
1793     'type'        => 'text',
1794   },
1795
1796   {
1797     'key'         => 'echeck-void',
1798     'section'     => 'deprecated',
1799     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable local-only voiding of echeck payments in addition to refunds against the payment gateway',
1800     'type'        => 'checkbox',
1801   },
1802
1803   {
1804     'key'         => 'cc-void',
1805     'section'     => 'deprecated',
1806     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable local-only voiding of credit card payments in addition to refunds against the payment gateway',
1807     'type'        => 'checkbox',
1808   },
1809
1810   {
1811     'key'         => 'unvoid',
1812     'section'     => 'deprecated',
1813     'description' => '<B>DEPRECATED</B>, now controlled by ACLs.  Used to enable unvoiding of voided payments',
1814     'type'        => 'checkbox',
1815   },
1816
1817   {
1818     'key'         => 'address2-search',
1819     'section'     => 'UI',
1820     'description' => 'Enable a "Unit" search box which searches the second address field',
1821    'type'        => 'checkbox',
1822   },
1823
1824   {
1825    'key'         => 'cust_main-require_address2',
1826    'section'     => 'UI',
1827    'description' => 'Second address field is required (on service address only, if billing and service addresses differ).  Also enables "Unit" labeling of address2 on customer view and edit pages.  Useful for multi-tenant applications.  See also: address2-search',
1828     'type'        => 'checkbox',
1829   },
1830
1831   { 'key'         => 'referral_credit',
1832     'section'     => 'billing',
1833     'description' => "Enables one-time referral credits in the amount of one month <i>referred</i> customer's recurring fee (irregardless of frequency).",
1834     'type'        => 'checkbox',
1835   },
1836
1837   { 'key'         => 'selfservice_server-cache_module',
1838     'section'     => '',
1839     'description' => 'Module used to store self-service session information.  All modules handle any number of self-service servers.  Cache::SharedMemoryCache is appropriate for a single database / single Freeside server.  Cache::FileCache is useful for multiple databases on a single server, or when IPC::ShareLite is not available (i.e. FreeBSD).', #  _Database stores session information in the database and is appropriate for multiple Freeside servers, but may be slower.',
1840     'type'        => 'select',
1841     'select_enum' => [ 'Cache::SharedMemoryCache', 'Cache::FileCache', ], # '_Database' ],
1842   },
1843
1844   {
1845     'key'         => 'hylafax',
1846     'section'     => 'billing',
1847     'description' => 'Options for a HylaFAX server to enable the FAX invoice destination.  They should be in the form of a space separated list of arguments to the Fax::Hylafax::Client::sendfax subroutine.  You probably shouldn\'t override things like \'docfile\'.  *Note* Only supported when using typeset invoices (see the invoice_latex configuration option).',
1848     'type'        => [qw( checkbox textarea )],
1849   },
1850
1851   {
1852     'key'         => 'cust_bill-ftpformat',
1853     'section'     => 'billing',
1854     'description' => 'Enable FTP of raw invoice data - format.',
1855     'type'        => 'select',
1856     'select_enum' => [ '', 'default', 'billco', ],
1857   },
1858
1859   {
1860     'key'         => 'cust_bill-ftpserver',
1861     'section'     => 'billing',
1862     'description' => 'Enable FTP of raw invoice data - server.',
1863     'type'        => 'text',
1864   },
1865
1866   {
1867     'key'         => 'cust_bill-ftpusername',
1868     'section'     => 'billing',
1869     'description' => 'Enable FTP of raw invoice data - server.',
1870     'type'        => 'text',
1871   },
1872
1873   {
1874     'key'         => 'cust_bill-ftppassword',
1875     'section'     => 'billing',
1876     'description' => 'Enable FTP of raw invoice data - server.',
1877     'type'        => 'text',
1878   },
1879
1880   {
1881     'key'         => 'cust_bill-ftpdir',
1882     'section'     => 'billing',
1883     'description' => 'Enable FTP of raw invoice data - server.',
1884     'type'        => 'text',
1885   },
1886
1887   {
1888     'key'         => 'cust_bill-spoolformat',
1889     'section'     => 'billing',
1890     'description' => 'Enable spooling of raw invoice data - format.',
1891     'type'        => 'select',
1892     'select_enum' => [ '', 'default', 'billco', ],
1893   },
1894
1895   {
1896     'key'         => 'cust_bill-spoolagent',
1897     'section'     => 'billing',
1898     'description' => 'Enable per-agent spooling of raw invoice data.',
1899     'type'        => 'checkbox',
1900   },
1901
1902   {
1903     'key'         => 'svc_acct-usage_suspend',
1904     'section'     => 'billing',
1905     'description' => 'Suspends the package an account belongs to when svc_acct.seconds or a bytecount is decremented to 0 or below (accounts with an empty seconds and up|down|totalbytes value are ignored).  Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
1906     'type'        => 'checkbox',
1907   },
1908
1909   {
1910     'key'         => 'svc_acct-usage_unsuspend',
1911     'section'     => 'billing',
1912     'description' => 'Unuspends the package an account belongs to when svc_acct.seconds or a bytecount is incremented from 0 or below to a positive value (accounts with an empty seconds and up|down|totalbytes value are ignored).  Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.',
1913     'type'        => 'checkbox',
1914   },
1915
1916   {
1917     'key'         => 'svc_acct-usage_threshold',
1918     'section'     => 'billing',
1919     'description' => 'The threshold (expressed as percentage) of acct.seconds or acct.up|down|totalbytes at which a warning message is sent to a service holder.  Typically used in conjunction with prepaid packages and freeside-sqlradius-radacctd.  Defaults to 80.',
1920     'type'        => 'text',
1921   },
1922
1923   {
1924     'key'         => 'cust-fields',
1925     'section'     => 'UI',
1926     'description' => 'Which customer fields to display on reports by default',
1927     'type'        => 'select',
1928     'select_hash' => [ FS::ConfDefaults->cust_fields_avail() ],
1929   },
1930
1931   {
1932     'key'         => 'cust_pkg-display_times',
1933     'section'     => 'UI',
1934     'description' => 'Display full timestamps (not just dates) for customer packages.  Useful if you are doing real-time things like hourly prepaid.',
1935     'type'        => 'checkbox',
1936   },
1937
1938   {
1939     'key'         => 'svc_acct-edit_uid',
1940     'section'     => 'shell',
1941     'description' => 'Allow UID editing.',
1942     'type'        => 'checkbox',
1943   },
1944
1945   {
1946     'key'         => 'svc_acct-edit_gid',
1947     'section'     => 'shell',
1948     'description' => 'Allow GID editing.',
1949     'type'        => 'checkbox',
1950   },
1951
1952   {
1953     'key'         => 'zone-underscore',
1954     'section'     => 'BIND',
1955     'description' => 'Allow underscores in zone names.  As underscores are illegal characters in zone names, this option is not recommended.',
1956     'type'        => 'checkbox',
1957   },
1958
1959   #these should become per-user...
1960   {
1961     'key'         => 'vonage-username',
1962     'section'     => '',
1963     'description' => 'Vonage Click2Call username (see <a href="https://secure.click2callu.com/">https://secure.click2callu.com/</a>)',
1964     'type'        => 'text',
1965   },
1966   {
1967     'key'         => 'vonage-password',
1968     'section'     => '',
1969     'description' => 'Vonage Click2Call username (see <a href="https://secure.click2callu.com/">https://secure.click2callu.com/</a>)',
1970     'type'        => 'text',
1971   },
1972   {
1973     'key'         => 'vonage-fromnumber',
1974     'section'     => '',
1975     'description' => 'Vonage Click2Call number (see <a href="https://secure.click2callu.com/">https://secure.click2callu.com/</a>)',
1976     'type'        => 'text',
1977   },
1978
1979   {
1980     'key'         => 'echeck-nonus',
1981     'section'     => 'billing',
1982     'description' => 'Disable ABA-format account checking for Electronic Check payment info',
1983     'type'        => 'checkbox',
1984   },
1985
1986   {
1987     'key'         => 'voip-cust_cdr_spools',
1988     'section'     => '',
1989     'description' => 'Enable the per-customer option for individual CDR spools.',
1990     'type'        => 'checkbox',
1991   },
1992
1993   {
1994     'key'         => 'svc_forward-arbitrary_dst',
1995     'section'     => '',
1996     'description' => "Allow forwards to point to arbitrary strings that don't necessarily look like email addresses.  Only used when using forwards for weird, non-email things.",
1997     'type'        => 'checkbox',
1998   },
1999
2000   {
2001     'key'         => 'tax-ship_address',
2002     'section'     => 'billing',
2003     'description' => 'By default, tax calculations are done based on the billing address.  Enable this switch to calculate tax based on the shipping address instead.  Note: Tax reports can take a long time when enabled.',
2004     'type'        => 'checkbox',
2005   },
2006
2007   {
2008     'key'         => 'invoice-ship_address',
2009     'section'     => 'billing',
2010     'description' => 'Enable this switch to include the ship address on the invoice.',
2011     'type'        => 'checkbox',
2012   },
2013
2014   {
2015     'key'         => 'invoice-unitprice',
2016     'section'     => 'billing',
2017     'description' => 'This switch enables unit pricing on the invoice.',
2018     'type'        => 'checkbox',
2019   },
2020
2021   {
2022     'key'         => 'postal_invoice-fee_pkgpart',
2023     'section'     => 'billing',
2024     'description' => 'This allows selection of a package to insert on invoices for customers with postal invoices selected.',
2025     'type'        => 'select-sub',
2026     'options_sub' => sub { require FS::Record;
2027                            require FS::part_pkg;
2028                           map { $_->pkgpart => $_->pkg }
2029                                FS::Record::qsearch('part_pkg', { disabled=>'' } );
2030                         },
2031     'option_sub'  => sub { require FS::Record;
2032                            require FS::part_pkg;
2033                           my $part_pkg = FS::Record::qsearchs(
2034                             'part_pkg', { 'pkgpart'=>shift }
2035                           );
2036                            $part_pkg ? $part_pkg->pkg : '';
2037                         },
2038   },
2039
2040   {
2041     'key'         => 'batch-enable',
2042     'section'     => 'billing',
2043     'description' => 'Enable credit card and/or ACH batching - leave disabled for real-time installations.',
2044     'type'        => 'checkbox',
2045   },
2046
2047   {
2048     'key'         => 'batch-enable_payby',
2049     'section'     => 'billing',
2050     'description' => 'Enable batch processing for the specified payment types.',
2051     'type'        => 'selectmultiple',
2052     'select_enum' => [qw( CARD CHEK )],
2053   },
2054
2055   {
2056     'key'         => 'realtime-disable_payby',
2057     'section'     => 'billing',
2058     'description' => 'Disable realtime processing for the specified payment types.',
2059     'type'        => 'selectmultiple',
2060     'select_enum' => [qw( CARD CHEK )],
2061   },
2062
2063   {
2064     'key'         => 'batch-default_format',
2065     'section'     => 'billing',
2066     'description' => 'Default format for batches.',
2067     'type'        => 'select',
2068     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch',
2069                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP',
2070                        'ach-spiritone',
2071                     ]
2072   },
2073
2074   {
2075     'key'         => 'batch-fixed_format-CARD',
2076     'section'     => 'billing',
2077     'description' => 'Fixed (unchangeable) format for credit card batches.',
2078     'type'        => 'select',
2079     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP' ,
2080                        'csv-chase_canada-E-xactBatch', 'BoM', 'PAP' ]
2081   },
2082
2083   {
2084     'key'         => 'batch-fixed_format-CHEK',
2085     'section'     => 'billing',
2086     'description' => 'Fixed (unchangeable) format for electronic check batches.',
2087     'type'        => 'select',
2088     'select_enum' => [ 'csv-td_canada_trust-merchant_pc_batch', 'BoM', 'PAP',
2089                        'ach-spiritone',
2090                      ]
2091   },
2092
2093   {
2094     'key'         => 'batch-increment_expiration',
2095     'section'     => 'billing',
2096     'description' => 'Increment expiration date years in batches until cards are current.  Make sure this is acceptable to your batching provider before enabling.',
2097     'type'        => 'checkbox'
2098   },
2099
2100   {
2101     'key'         => 'batchconfig-BoM',
2102     'section'     => 'billing',
2103     'description' => 'Configuration for Bank of Montreal batching, seven lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Long name, 6. Bank, 7. Bank account',
2104     'type'        => 'textarea',
2105   },
2106
2107   {
2108     'key'         => 'batchconfig-PAP',
2109     'section'     => 'billing',
2110     'description' => 'Configuration for PAP batching, seven lines: 1. Origin ID, 2. Datacenter, 3. Typecode, 4. Short name, 5. Long name, 6. Bank, 7. Bank account',
2111     'type'        => 'textarea',
2112   },
2113
2114   {
2115     'key'         => 'batchconfig-csv-chase_canada-E-xactBatch',
2116     'section'     => 'billing',
2117     'description' => 'Gateway ID for Chase Canada E-xact batching',
2118     'type'        => 'text',
2119   },
2120
2121   {
2122     'key'         => 'payment_history-years',
2123     'section'     => 'UI',
2124     'description' => 'Number of years of payment history to show by default.  Currently defaults to 2.',
2125     'type'        => 'text',
2126   },
2127
2128   {
2129     'key'         => 'cust_main-use_comments',
2130     'section'     => 'UI',
2131     'description' => 'Display free form comments on the customer edit screen.  Useful as a scratch pad.',
2132     'type'        => 'checkbox',
2133   },
2134
2135   {
2136     'key'         => 'cust_main-disable_notes',
2137     'section'     => 'UI',
2138     'description' => 'Disable new style customer notes - timestamped and user identified customer notes.  Useful in tracking who did what.',
2139     'type'        => 'checkbox',
2140   },
2141
2142   {
2143     'key'         => 'cust_main_note-display_times',
2144     'section'     => 'UI',
2145     'description' => 'Display full timestamps (not just dates) for customer notes.',
2146     'type'        => 'checkbox',
2147   },
2148
2149   {
2150     'key'         => 'cust_main-ticket_statuses',
2151     'section'     => 'UI',
2152     'description' => 'Show tickets with these statuses on the customer view page.',
2153     'type'        => 'selectmultiple',
2154     'select_enum' => [qw( new open stalled resolved rejected deleted )],
2155   },
2156
2157   {
2158     'key'         => 'cust_main-max_tickets',
2159     'section'     => 'UI',
2160     'description' => 'Maximum number of tickets to show on the customer view page.',
2161     'type'        => 'text',
2162   },
2163
2164   {
2165     'key'         => 'cust_main-skeleton_tables',
2166     'section'     => '',
2167     'description' => 'Tables which will have skeleton records inserted into them for each customer.  Syntax for specifying tables is unfortunately a tricky perl data structure for now.',
2168     'type'        => 'textarea',
2169   },
2170
2171   {
2172     'key'         => 'cust_main-skeleton_custnum',
2173     'section'     => '',
2174     'description' => 'Customer number specifying the source data to copy into skeleton tables for new customers.',
2175     'type'        => 'text',
2176   },
2177
2178   {
2179     'key'         => 'cust_main-enable_birthdate',
2180     'section'     => 'UI',
2181     'descritpion' => 'Enable tracking of a birth date with each customer record',
2182     'type'        => 'checkbox',
2183   },
2184
2185   {
2186     'key'         => 'support-key',
2187     'section'     => '',
2188     'description' => 'A support key enables access to commercial services delivered over the network, such as the payroll module, access to the internal ticket system, priority support and optional backups.',
2189     'type'        => 'text',
2190   },
2191
2192   {
2193     'key'         => 'card-types',
2194     'section'     => 'billing',
2195     'description' => 'Select one or more card types to enable only those card types.  If no card types are selected, all card types are available.',
2196     'type'        => 'selectmultiple',
2197     'select_enum' => \@card_types,
2198   },
2199
2200   {
2201     'key'         => 'dashboard-toplist',
2202     'section'     => 'UI',
2203     'description' => 'List of items to display on the top of the front page',
2204     'type'        => 'textarea',
2205   },
2206
2207   {
2208     'key'         => 'impending_recur_template',
2209     'section'     => 'billing',
2210     'description' => 'Template file for alerts about looming first time recurrant billing.  See the <a href="http://search.cpan.org/~mjd/Text-Template.pm">Text::Template</a> documentation for details on the template substitition language.  Also see packages with a <a href="../browse/part_pkg.cgi">flat price plan</a>  The following variables are available<ul><li><code>$packages</code> allowing <code>$packages->[0]</code> thru <code>$packages->[n]</code> <li><code>$package</code> the first package, same as <code>$packages->[0]</code> <li><code>$recurdates</code> allowing <code>$recurdates->[0]</code> thru <code>$recurdates->[n]</code> <li><code>$recurdate</code> the first recurdate, same as <code>$recurdate->[0]</code> <li><code>$first</code> <li><code>$last</code></ul>',
2211 # <li><code>$payby</code> <li><code>$expdate</code> most likely only confuse
2212     'type'        => 'textarea',
2213   },
2214
2215   {
2216     'key'         => 'selfservice-session_timeout',
2217     'section'     => '',
2218     'description' => 'Self-service session timeout.  Defaults to 1 hour.',
2219     'type'        => 'select',
2220     'select_enum' => [ '1 hour', '2 hours', '4 hours', '8 hours', '1 day', '1 week', ],
2221   },
2222
2223   {
2224     'key'         => 'disable_setup_suspended_pkgs',
2225     'section'     => 'billing',
2226     'description' => 'Disables charging of setup fees for suspended packages.',
2227     'type'       => 'checkbox',
2228   },
2229
2230   {
2231     'key'         => 'cust_main-require_phone',
2232     'section'     => '',
2233     'description' => 'Require daytime or night for all customer records.',
2234     'type'        => 'checkbox',
2235   },
2236
2237   {
2238     'key'         => 'cust_main-require_invoicing_list_email',
2239     'section'     => '',
2240     'description' => 'Email address field is required: require at least one invoicing email address for all customer records.',
2241     'type'        => 'checkbox',
2242   },
2243
2244   {
2245     'key' => 'password-generated-allcaps',
2246     'section' => 'password',
2247     'description' => 'Causes passwords automatically generated to consist entirely of capital letters',
2248     'type' => 'checkbox',
2249   },
2250
2251   {
2252     'key'         => 'datavolume-forcemegabytes',
2253     'section'     => 'UI',
2254     'description' => 'All data volumes are expressed in megabytes',
2255     'type'        => 'checkbox',
2256   },
2257
2258   {
2259     'key'         => 'datavolume-significantdigits',
2260     'section'     => 'UI',
2261     'description' => 'number of significant digits to use to represent data volumes',
2262     'type'        => 'text',
2263   },
2264
2265   {
2266     'key'         => 'disable_void_after',
2267     'section'     => 'billing',
2268     'description' => 'Number of seconds after which freeside won\'t attempt to VOID a payment first when performing a refund.',
2269     'type'        => 'text',
2270   },
2271
2272   {
2273     'key'         => 'disable_line_item_date_ranges',
2274     'section'     => 'billing',
2275     'description' => 'Prevent freeside from automatically generating date ranges on invoice line items.',
2276     'type'        => 'checkbox',
2277   },
2278
2279   {
2280     'key'         => 'cancel_credit_type',
2281     'section'     => 'billing',
2282     'description' => 'The group to use for new, automatically generated credit reasons resulting from cancellation.',
2283     'type'        => 'select-sub',
2284     'options_sub' => sub { require FS::Record;
2285                            require FS::reason_type;
2286                            map { $_->typenum => $_->type }
2287                                FS::Record::qsearch('reason_type', { class=>'R' } );
2288                          },
2289     'option_sub'  => sub { require FS::Record;
2290                            require FS::reason_type;
2291                            my $reason_type = FS::Record::qsearchs(
2292                              'reason_type', { 'typenum' => shift }
2293                            );
2294                            $reason_type ? $reason_type->type : '';
2295                          },
2296   },
2297
2298   {
2299     'key'         => 'referral_credit_type',
2300     'section'     => 'billing',
2301     'description' => 'The group to use for new, automatically generated credit reasons resulting from referrals.',
2302     'type'        => 'select-sub',
2303     'options_sub' => sub { require FS::Record;
2304                            require FS::reason_type;
2305                            map { $_->typenum => $_->type }
2306                                FS::Record::qsearch('reason_type', { class=>'R' } );
2307                          },
2308     'option_sub'  => sub { require FS::Record;
2309                            require FS::reason_type;
2310                            my $reason_type = FS::Record::qsearchs(
2311                              'reason_type', { 'typenum' => shift }
2312                            );
2313                            $reason_type ? $reason_type->type : '';
2314                          },
2315   },
2316
2317   {
2318     'key'         => 'signup_credit_type',
2319     'section'     => 'billing',
2320     'description' => 'The group to use for new, automatically generated credit reasons resulting from signup and self-service declines.',
2321     'type'        => 'select-sub',
2322     'options_sub' => sub { require FS::Record;
2323                            require FS::reason_type;
2324                            map { $_->typenum => $_->type }
2325                                FS::Record::qsearch('reason_type', { class=>'R' } );
2326                          },
2327     'option_sub'  => sub { require FS::Record;
2328                            require FS::reason_type;
2329                            my $reason_type = FS::Record::qsearchs(
2330                              'reason_type', { 'typenum' => shift }
2331                            );
2332                            $reason_type ? $reason_type->type : '';
2333                          },
2334   },
2335
2336   {
2337     'key'         => 'cust_main-agent_custid-format',
2338     'section'     => '',
2339     'description' => 'Enables searching of various formatted values in cust_main.agent_custid',
2340     'type'        => 'select',
2341     'select_hash' => [
2342                        ''      => 'Numeric only',
2343                        'ww?d+' => 'Numeric with one or two letter prefix',
2344                      ],
2345   },
2346
2347   {
2348     'key'         => 'card_masking_method',
2349     'section'     => 'UI',
2350     'description' => 'Digits to display when masking credit cards.  Note that the first six digits are necessary to canonically identify the credit card type (Visa/MC, Amex, Discover, Maestro, etc.) in all cases.  The first four digits can identify the most common credit card types in most cases (Visa/MC, Amex, and Discover).  The first two digits can distinguish between Visa/MC and Amex.',
2351     'type'        => 'select',
2352     'select_hash' => [
2353                        ''            => '123456xxxxxx1234',
2354                        'first6last2' => '123456xxxxxxxx12',
2355                        'first4last4' => '1234xxxxxxxx1234',
2356                        'first4last2' => '1234xxxxxxxxxx12',
2357                        'first2last4' => '12xxxxxxxxxx1234',
2358                        'first2last2' => '12xxxxxxxxxxxx12',
2359                        'first0last4' => 'xxxxxxxxxxxx1234',
2360                        'first0last2' => 'xxxxxxxxxxxxxx12',
2361                      ],
2362   },
2363
2364   {
2365     'key'         => 'disable_previous_balance',
2366     'section'     => 'billing',
2367     'description' => 'Disable inclusion of previous balance lines on invoices',
2368     'type'        => 'checkbox',
2369   },
2370
2371   {
2372     'key'         => 'disable_acl_changes',
2373     'section'     => '',
2374     'description' => 'Disable all ACL changes, for demos.',
2375     'type'        => 'checkbox',
2376   },
2377
2378   {
2379     'key'         => 'cust_main-edit_agent_custid',
2380     'section'     => 'UI',
2381     'description' => 'Enable editing of the agent_custid field.',
2382     'type'        => 'checkbox',
2383   },
2384
2385   {
2386     'key'         => 'cust_main-default_areacode',
2387     'section'     => 'UI',
2388     'description' => 'Default area code for customers.',
2389     'type'        => 'text',
2390   },
2391
2392   {
2393     'key'         => 'cust_bill-max_same_services',
2394     'section'     => 'billing',
2395     'description' => 'Maximum number of the same service to list individually on invoices before condensing to a single line listing the number of services.  Defaults to 5.',
2396     'type'        => 'text',
2397   },
2398
2399 );
2400
2401 1;
2402