FS/FS/Conf.pm

   1 package FS::Conf;
   2
   3 use vars qw($default_dir @config_items $DEBUG );
   4 use IO::File;
   5 use FS::ConfItem;
   6
   7 $DEBUG = 0;
   8
   9 =head1 NAME
  10
  11 FS::Conf - Read access to Freeside configuration values
  12
  13 =head1 SYNOPSIS
  14
  15   use FS::Conf;
  16
  17   $conf = new FS::Conf "/config/directory";
  18
  19   $FS::Conf::default_dir = "/config/directory";
  20   $conf = new FS::Conf;
  21
  22   $dir = $conf->dir;
  23
  24   $value = $conf->config('key');
  25   @list  = $conf->config('key');
  26   $bool  = $conf->exists('key');
  27
  28   @config_items = $conf->config_items;
  29
  30 =head1 DESCRIPTION
  31
  32 Read access to Freeside configuration values.  Keys currently map to filenames,
  33 but this may change in the future.
  34
  35 =head1 METHODS
  36
  37 =over 4
  38
  39 =item new [ DIRECTORY ]
  40
  41 Create a new configuration object.  A directory arguement is required if
  42 $FS::Conf::default_dir has not been set.
  43
  44 =cut
  45
  46 sub new {
  47   my($proto,$dir) = @_;
  48   my($class) = ref($proto) || $proto;
  49   my($self) = { 'dir' => $dir || $default_dir } ;
  50   bless ($self, $class);
  51 }
  52
  53 =item dir
  54
  55 Returns the directory.
  56
  57 =cut
  58
  59 sub dir {
  60   my($self) = @_;
  61   my $dir = $self->{dir};
  62   -e $dir or die "FATAL: $dir doesn't exist!";
  63   -d $dir or die "FATAL: $dir isn't a directory!";
  64   -r $dir or die "FATAL: Can't read $dir!";
  65   -x $dir or die "FATAL: $dir not searchable (executable)!";
  66   $dir =~ /^(.*)$/;
  67   $1;
  68 }
  69
  70 =item config
  71
  72 Returns the configuration value or values (depending on context) for key.
  73
  74 =cut
  75
  76 sub config {
  77   my($self,$file)=@_;
  78   my($dir)=$self->dir;
  79   my $fh = new IO::File "<$dir/$file" or return;
  80   if ( wantarray ) {
  81     map {
  82       /^(.*)$/
  83         or die "Illegal line (array context) in $dir/$file:\n$_\n";
  84       $1;
  85     } <$fh>;
  86   } else {
  87     <$fh> =~ /^(.*)$/
  88       or die "Illegal line (scalar context) in $dir/$file:\n$_\n";
  89     $1;
  90   }
  91 }
  92
  93 =item exists
  94
  95 Returns true if the specified key exists, even if the corresponding value
  96 is undefined.
  97
  98 =cut
  99
 100 sub exists {
 101   my($self,$file)=@_;
 102   my($dir) = $self->dir;
 103   -e "$dir/$file";
 104 }
 105
 106 =item touch
 107
 108 =cut
 109
 110 sub touch {
 111   my($self, $file) = @_;
 112   my $dir = $self->dir;
 113   unless ( $self->exists($file) ) {
 114     warn "[FS::Conf] TOUCH $file\n" if $DEBUG;
 115     system('touch', "$dir/$file");
 116   }
 117 }
 118
 119 =item set
 120
 121 =cut
 122
 123 sub set {
 124   my($self, $file, $value) = @_;
 125   my $dir = $self->dir;
 126   $value =~ /^(.*)$/s;
 127   $value = $1;
 128   unless ( $self->config($file) eq $value ) {
 129     warn "[FS::Conf] SET $file\n" if $DEBUG;
 130     warn "$dir" if is_tainted($dir);
 131     warn "$dir" if is_tainted($file);
 132     my $fh = new IO::File ">$dir/$file" or return;
 133     print $fh "$value\n";
 134   }
 135 }
 136 sub is_tainted {
 137              return ! eval { join('',@_), kill 0; 1; };
 138          }
 139
 140 =item delete
 141
 142 =cut
 143
 144 sub delete {
 145   my($self, $file) = @_;
 146   my $dir = $self->dir;
 147   if ( $self->exists($file) ) {
 148     warn "[FS::Conf] DELETE $file\n";
 149     unlink "$dir/$file";
 150   }
 151 }
 152
 153 =item config_items
 154
 155 Returns all of the possible configuration items as FS::ConfItem objects.  See
 156 L<FS::ConfItem>.
 157
 158 =cut
 159
 160 sub config_items {
 161 #  my $self = shift;
 162   @config_items;
 163 }
 164
 165 =back
 166
 167 =head1 BUGS
 168
 169 Write access (touch, set, delete) should be documented.
 170
 171 If this was more than just crud that will never be useful outside Freeside I'd
 172 worry that config_items is freeside-specific and icky.
 173
 174 =head1 SEE ALSO
 175
 176 "Configuration" in the web interface (config/config.cgi).
 177
 178 httemplate/docs/config.html
 179
 180 =cut
 181
 182 @config_items = map { new FS::ConfItem $_ } (
 183
 184   {
 185     'key'         => 'address',
 186     'section'     => 'depreciated',
 187     'description' => 'This configuration file is no longer used.  See <a href="#invoice_template">invoice_template</a> instead.',
 188     'type'        => 'text',
 189   },
 190
 191   {
 192     'key'         => 'apacheroot',
 193     'section'     => 'apache',
 194     'description' => 'The directory containing Apache virtual hosts',
 195     'type'        => 'text',
 196   },
 197
 198   {
 199     'key'         => 'apachemachine',
 200     'section'     => 'apache',
 201     'description' => '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.',
 202     'type'        => 'text',
 203   },
 204
 205   {
 206     'key'         => 'apachemachines',
 207     'section'     => 'apache',
 208     'description' => 'Your 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.',
 209     'type'        => 'textarea',
 210   },
 211
 212   {
 213     'key'         => 'bindprimary',
 214     'section'     => 'BIND',
 215     'description' => 'Your BIND primary nameserver.  This enables export of /var/named/named.conf and zone files into /var/named',
 216     'type'        => 'text',
 217   },
 218
 219   {
 220     'key'         => 'bindsecondaries',
 221     'section'     => 'BIND',
 222     'description' => 'Your BIND secondary nameservers, one per line.  This enables export of /var/named/named.conf',
 223     'type'        => 'textarea',
 224   },
 225
 226   {
 227     'key'         => 'business-onlinepayment',
 228     'section'     => 'billing',
 229     '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.',
 230     'type'        => 'textarea',
 231   },
 232
 233   {
 234     'key'         => 'bsdshellmachines',
 235     'section'     => '',
 236     'description' => 'Your BSD flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd\' and `/etc/master.passwd\'.',
 237     'type'        => 'textarea',
 238   },
 239
 240   {
 241     'key'         => 'countrydefault',
 242     'section'     => 'UI',
 243     'description' => 'Default two-letter country code (if not supplied, the default is `US\')',
 244     'type'        => 'text',
 245   },
 246
 247   {
 248     'key'         => 'cybercash3.2',
 249     'section'     => 'billing',
 250     'description' => '<a href="http://www.cybercash.com/cashregister/">CyberCash Cashregister v3.2</a> support.  Two lines: the full path and name of your merchant_conf file, and the transaction type (`mauthonly\' or `mauthcapture\').',
 251     'type'        => 'textarea',
 252   },
 253
 254   {
 255     'key'         => 'cyrus',
 256     'section'     => '',
 257     'description' => 'Integration 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.',
 258     'type'        => 'textarea',
 259   },
 260
 261   {
 262     'key'         => 'deletecustomers',
 263     'section'     => 'UI',
 264     'description' => 'The existance of this file will 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.',
 265     'type'        => 'checkbox',
 266   },
 267
 268   {
 269     'key'         => 'dirhash',
 270     'section'     => 'shell',
 271     '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>',
 272     'type'        => 'text',
 273   },
 274
 275   {
 276     'key'         => 'disable_customer_referrals',
 277     'section'     => 'UI',
 278     'description' => 'The existance of this file will disable new customer-to-customer referrals in the web interface.',
 279     'type'        => 'checkbox',
 280   },
 281
 282   {
 283     'key'         => 'domain',
 284     'section'     => 'depreciated',
 285     'description' => 'Your domain name.',
 286     'type'        => 'text',
 287   },
 288
 289   {
 290     'key'         => 'editreferrals',
 291     'section'     => 'UI',
 292     'description' => 'The existance of this file will allow you to change the referral of existing customers.',
 293     'type'       => 'checkbox',
 294   },
 295
 296   {
 297     'key'         => 'emailinvoiceonly',
 298     'section'     => 'billing',
 299     'description' => 'Disables postal mail invoices.',
 300     'type'       => 'checkbox',
 301   },
 302
 303   {
 304     'key'         => 'emailinvoiceauto',
 305     'section'     => 'billing',
 306     'description' => 'Automatically adds new accounts to the email invoice list upon customer creation.',
 307     'type'       => 'checkbox',
 308   },
 309
 310   {
 311     'key'         => 'erpcdmachines',
 312     'section'     => '',
 313     'description' => 'Your ERPCD authenticaion machines, one per line.  This enables export of `/usr/annex/acp_passwd\' and `/usr/annex/acp_dialup\'.',
 314     'type'        => 'textarea',
 315   },
 316
 317   {
 318     'key'         => 'hidecancelledpackages',
 319     'section'     => 'UI',
 320     'description' => 'The existance of this file will prevent cancelled packages from showing up in listings (though they will still be in the database)',
 321     'type'        => 'checkbox',
 322   },
 323
 324   {
 325     'key'         => 'hidecancelledcustomers',
 326     'section'     => 'UI',
 327     'description' => 'The existance of this file will prevent customers with only cancelled packages from showing up in listings (though they will still be in the database)',
 328     'type'        => 'checkbox',
 329   },
 330
 331   {
 332     'key'         => 'home',
 333     'section'     => 'required',
 334     'description' => 'For new users, prefixed to username to create a directory name.  Should have a leading but not a trailing slash.',
 335     'type'        => 'text',
 336   },
 337
 338   {
 339     'key'         => 'icradiusmachines',
 340     'section'     => '',
 341     'description' => 'Your <a href="ftp://ftp.cheapnet.net/pub/icradius">ICRADIUS</a> machines, one per line.  The existance of this file (even if empty) turns on radcheck table creation (in the freeside database - the radcheck table needs to be created manually).  Machines listed in this file will have the radcheck table exported to them.  Each line of this file 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>".  You do not need to use MySQL for your Freeside database to export to an ICRADIUS mysql database with this option.',
 342     'type'        => [qw( checkbox textarea )],
 343   },
 344
 345   {
 346     'key'         => 'icradius_mysqldest',
 347     'section'     => '',
 348     'description' => 'Destination directory for the MySQL databases, on the ICRADIUS machines.  Defaults to "/usr/local/var/".',
 349     'type'        => 'text',
 350   },
 351
 352   {
 353     'key'         => 'icradius_mysqlsource',
 354     'section'     => '',
 355     'description' => 'Source directory for for the MySQL radcheck table files, on the Freeside machine.  Defaults to "/usr/local/var/freeside".',
 356     'type'        => 'text',
 357   },
 358
 359   {
 360     'key'         => 'icradius_secrets',
 361     'section'     => '',
 362     'description' => 'Optionally specifies a MySQL database for ICRADIUS export, if you\'re not running MySQL for your Freeside database.  The database should be on the Freeside machine and store data in the <a href="#icradius_mysqlsource">icradius_mysqlsource</a> directory.  Three lines: DBI data source, username and password.  This file should not be world readable.',
 363     'type'        => 'textarea',
 364   },
 365
 366   {
 367     'key'         => 'invoice_from',
 368     'section'     => 'required',
 369     'description' => 'Return address on email invoices.',
 370     'type'        => 'text',
 371   },
 372
 373   {
 374     'key'         => 'invoice_template',
 375     'section'     => 'required',
 376     'description' => 'Required template file for invoices.  See the <a href="../docs/billing.html">billing documentation</a> for details.',
 377     'type'        => 'textarea',
 378   },
 379
 380   {
 381     'key'         => 'lpr',
 382     'section'     => 'required',
 383     'description' => 'Print command for paper invoices, for example `lpr -h\'.',
 384     'type'        => 'text',
 385   },
 386
 387   {
 388     'key'         => 'maildisablecatchall',
 389     'section'     => 'depreciated',
 390     'description' => '<b>DEPRECIATED</b>, now the default.  The existance of this file used to disable the requirement that each virtual domain have a catch-all mailbox.',
 391     'type'        => 'checkbox',
 392   },
 393
 394   {
 395     'key'         => 'money_char',
 396     'section'     => '',
 397     'description' => 'Currency symbol - defaults to `$\'.',
 398     'type'        => 'text',
 399   },
 400
 401   {
 402     'key'         => 'mxmachines',
 403     'section'     => 'BIND',
 404     'description' => 'MX entries for new domains, weight and machine, one per line, with trailing `.\'',
 405     'type'        => 'textarea',
 406   },
 407
 408   {
 409     'key'         => 'nsmachines',
 410     'section'     => 'BIND',
 411     'description' => 'NS nameservers for new domains, one per line, with trailing `.\'',
 412     'type'        => 'textarea',
 413   },
 414
 415   {
 416     'key'         => 'nismachines',
 417     'section'     => '',
 418     'description' => 'Your NIS master (not slave master) machines, one per line.  This enables export of `/etc/global/passwd\' and `/etc/global/shadow\'.',
 419     'type'        => 'textarea',
 420   },
 421
 422   {
 423     'key'         => 'passwordmin',
 424     'section'     => 'password',
 425     'description' => 'Minimum password length (default 6)',
 426     'type'        => 'text',
 427   },
 428
 429   {
 430     'key'         => 'passwordmax',
 431     'section'     => 'password',
 432     'description' => 'Maximum password length (default 8) (don\'t set this over 12 if you need to import or export crypt() passwords)',
 433     'type'        => 'text',
 434   },
 435
 436   {
 437     'key'         => 'qmailmachines',
 438     'section'     => '',
 439     'description' => 'Your qmail machines, one per line.  This enables export of `/var/qmail/control/virtualdomains\', `/var/qmail/control/recipientmap\', and `/var/qmail/control/rcpthosts\'.  The existance of this file (even if empty) also turns on user `.qmail-extension\' file maintenance in conjunction with `shellmachine\'.',
 440     'type'        => [qw( checkbox textarea )],
 441   },
 442
 443   {
 444     'key'         => 'radiusmachines',
 445     'section'     => '',
 446     'description' => 'Your RADIUS authentication machines, one per line.  This enables export of `/etc/raddb/users\'.',
 447     'type'        => 'textarea',
 448   },
 449
 450   {
 451     'key'         => 'referraldefault',
 452     'section'     => 'UI',
 453     'description' => 'Default referral, specified by refnum.',
 454     'type'        => 'text',
 455   },
 456
 457 #  {
 458 #    'key'         => 'registries',
 459 #    'section'     => 'required',
 460 #    'description' => 'Directory which contains domain registry information.  Each registry is a directory.',
 461 #  },
 462
 463   {
 464     'key'         => 'sendmailconfigpath',
 465     'section'     => '',
 466     'description' => 'Sendmail configuration file path - defaults to `/etc\'.  Many newer distributions use `/etc/mail\'.',
 467     'type'        => 'text',
 468   },
 469
 470   {
 471     'key'         => 'sendmailmachines',
 472     'section'     => '',
 473     'description' => 'Your sendmail machines, one per line.  This enables export of `/etc/virtusertable\' and `/etc/sendmail.cw\'.',
 474     'type'        => 'textarea',
 475   },
 476
 477   {
 478     'key'         => 'sendmailrestart',
 479     'section'     => '',
 480     'description' => 'If defined, the command which is run on sendmail machines after files are copied.',
 481     'type'        => 'text',
 482   },
 483
 484   {
 485     'key'         => 'session-start',
 486     'section'     => 'session',
 487     '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.',
 488     'type'        => 'text',
 489   },
 490
 491   {
 492     'key'         => 'session-stop',
 493     'section'     => 'session',
 494     '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.',
 495     'type'        => 'text',
 496   },
 497
 498   {
 499     'key'         => 'shellmachine',
 500     'section'     => 'shell',
 501     'description' => '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.',
 502     'type'        => 'text',
 503   },
 504
 505   {
 506     'key'         => 'shellmachine-useradd',
 507     'section'     => 'shell',
 508     'description' => 'The command(s) to run on shellmachine when an account is created.  If this file does not exist, <code>useradd -d $dir -m -s $shell -u $uid $username</code> is the default.  If the file exists but is empty, <code>cp -pr /etc/skel $dir; chown -R $uid.$gid $dir</code> is the default instead.  Otherwise the contents of the file are treated 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>.',
 509     'type'        => [qw( checkbox text )],
 510   },
 511
 512   {
 513     'key'         => 'shellmachine-userdel',
 514     'section'     => 'shell',
 515     'description' => 'The command(s) to run on shellmachine when an account is deleted.  If this file does not exist, <code>userdel $username</code> is the default.  If the file exists but is empty, <code>rm -rf $dir</code> is the default instead.  Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$username</code> and <code>$dir</code>.',
 516     'type'        => [qw( checkbox text )],
 517   },
 518
 519   {
 520     'key'         => 'shellmachine-usermod',
 521     'section'     => 'shell',
 522     'description' => 'The command(s) to run on shellmachine when an account is modified.  If this file does not exist or 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>.',
 523     'type'        => [qw( checkbox text )],
 524   },
 525
 526   {
 527     'key'         => 'shellmachines',
 528     'section'     => 'shell',
 529     'description' => 'Your Linux and System V flavored shell (and mail) machines, one per line.  This enables export of `/etc/passwd\' and `/etc/shadow\' files.',
 530      'type'        => 'textarea',
 531  },
 532
 533   {
 534     'key'         => 'shells',
 535     'section'     => 'required',
 536     '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.',
 537     'type'        => 'textarea',
 538   },
 539
 540   {
 541     'key'         => 'showpasswords',
 542     'section'     => 'UI',
 543     'description' => 'The existance of this file will allow unencrypted user passwords to be displayed.',
 544     'type'        => 'checkbox',
 545   },
 546
 547   {
 548     'key'         => 'signupurl',
 549     'section'     => 'UI',
 550     'description' => 'if you are using customer-to-customer referrals, and you enter the URL of your <a href="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.',
 551     'type'        => 'text',
 552   },
 553
 554   {
 555     'key'         => 'smtpmachine',
 556     'section'     => 'required',
 557     'description' => 'SMTP relay for Freeside\'s outgoing mail.',
 558     'type'        => 'text',
 559   },
 560
 561   {
 562     'key'         => 'soadefaultttl',
 563     'section'     => 'BIND',
 564     'description' => 'SOA default TTL for new domains.',
 565     'type'        => 'text',
 566   },
 567
 568   {
 569     'key'         => 'soaemail',
 570     'section'     => 'BIND',
 571     'description' => 'SOA email for new domains, in BIND form (`.\' instead of `@\'), with trailing `.\'',
 572     'type'        => 'text',
 573   },
 574
 575   {
 576     'key'         => 'soaexpire',
 577     'section'     => 'BIND',
 578     'description' => 'SOA expire for new domains',
 579     'type'        => 'text',
 580   },
 581
 582   {
 583     'key'         => 'soamachine',
 584     'section'     => 'BIND',
 585     'description' => 'SOA machine for new domains, with trailing `.\'',
 586     'type'        => 'text',
 587   },
 588
 589   {
 590     'key'         => 'soarefresh',
 591     'section'     => 'BIND',
 592     'description' => 'SOA refresh for new domains',
 593     'type'        => 'text',
 594   },
 595
 596   {
 597     'key'         => 'soaretry',
 598     'section'     => 'BIND',
 599     'description' => 'SOA retry for new domains',
 600     'type'        => 'text',
 601   },
 602
 603   {
 604     'key'         => 'statedefault',
 605     'section'     => 'UI',
 606     'description' => 'Default state or province (if not supplied, the default is `CA\')',
 607     'type'        => 'text',
 608   },
 609
 610   {
 611     'key'         => 'textradiusprepend',
 612     'section'     => 'depreciated',
 613     'description' => '<b>DEPRECIATED</b>, use RADIUS check attributes instead.  This option will be removed soon.  The contents of this file will be prepended to the first line of a user\'s RADIUS entry in text exports.',
 614     'type'        => 'text',
 615   },
 616
 617   {
 618     'key'         => 'unsuspendauto',
 619     'section'     => 'billing',
 620     'description' => 'The existance of this file will enable 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.',
 621     'type'        => 'checkbox',
 622   },
 623
 624   {
 625     'key'         => 'usernamemin',
 626     'section'     => 'username',
 627     'description' => 'Minimum username length (default 2);',
 628     'type'        => 'text',
 629   },
 630
 631   {
 632     'key'         => 'usernamemax',
 633     'section'     => 'username',
 634     'description' => 'Maximum username length (default is the size of the SQL column, probably specified when fs-setup was run)',
 635     'type'        => 'text',
 636   },
 637
 638   {
 639     'key'         => 'username-ampersand',
 640     'section'     => 'username',
 641     'description' => 'The existance of this file will allow the ampersand character (&amp;) in usernames.  Be careful when using this option in conjunction with <a href="#shellmachine-useradd">shellmachine-useradd</a> and other configuration options which execute shell commands, as the ampersand will be interpreted by the shell if not quoted.',
 642     'type'        => 'checkbox',
 643   },
 644
 645   {
 646     'key'         => 'username-letter',
 647     'section'     => 'username',
 648     'description' => 'The existance of this file will turn on the requirement that usernames contain at least one letter.',
 649     'type'        => 'checkbox',
 650   },
 651
 652   {
 653     'key'         => 'username-letterfirst',
 654     'section'     => 'username',
 655     'description' => 'The existance of this file will turn on the requirement that usernames start with a letter.',
 656     'type'        => 'checkbox',
 657   },
 658
 659   {
 660     'key'         => 'username-noperiod',
 661     'section'     => 'username',
 662     'description' => 'The existance of this file will disallow periods in usernames.',
 663     'type'        => 'checkbox',
 664   },
 665
 666   {
 667     'key'         => 'username-uppercase',
 668     'section'     => 'username',
 669     'description' => 'The existance of this file will allow uppercase characters in username.',
 670     'type'        => 'checkbox',
 671   },
 672
 673   {
 674     'key'         => 'username_policy',
 675     'section'     => '',
 676     '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\' or \'append domain\'',
 677 #    'type'        => 'select',
 678     'type'        => '',
 679   },
 680
 681   {
 682     'key'         => 'vpopmailmachines',
 683     'section'     => '',
 684     'description' => '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',
 685     'type'        => 'textarea',
 686   },
 687
 688 );
 689
 690 1;
 691