FS/FS/part_export.pm

   1 package FS::part_export;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK %exports );
   5 use Exporter;
   6 use Tie::IxHash;
   7 use FS::Record qw( qsearch qsearchs dbh );
   8 use FS::part_svc;
   9 use FS::part_export_option;
  10 use FS::export_svc;
  11
  12 @ISA = qw(FS::Record);
  13 @EXPORT_OK = qw(export_info);
  14
  15 =head1 NAME
  16
  17 FS::part_export - Object methods for part_export records
  18
  19 =head1 SYNOPSIS
  20
  21   use FS::part_export;
  22
  23   $record = new FS::part_export \%hash;
  24   $record = new FS::part_export { 'column' => 'value' };
  25
  26   #($new_record, $options) = $template_recored->clone( $svcpart );
  27
  28   $error = $record->insert( { 'option' => 'value' } );
  29   $error = $record->insert( \%options );
  30
  31   $error = $new_record->replace($old_record);
  32
  33   $error = $record->delete;
  34
  35   $error = $record->check;
  36
  37 =head1 DESCRIPTION
  38
  39 An FS::part_export object represents an export of Freeside data to an external
  40 provisioning system.  FS::part_export inherits from FS::Record.  The following
  41 fields are currently supported:
  42
  43 =over 4
  44
  45 =item exportnum - primary key
  46
  47 =item machine - Machine name
  48
  49 =item exporttype - Export type
  50
  51 =item nodomain - blank or "Y" : usernames are exported to this service with no domain
  52
  53 =back
  54
  55 =head1 METHODS
  56
  57 =over 4
  58
  59 =item new HASHREF
  60
  61 Creates a new export.  To add the export to the database, see L<"insert">.
  62
  63 Note that this stores the hash reference, not a distinct copy of the hash it
  64 points to.  You can ask the object for a copy with the I<hash> method.
  65
  66 =cut
  67
  68 # the new method can be inherited from FS::Record, if a table method is defined
  69
  70 sub table { 'part_export'; }
  71
  72 =cut
  73
  74 #=item clone SVCPART
  75 #
  76 #An alternate constructor.  Creates a new export by duplicating an existing
  77 #export.  The given svcpart is assigned to the new export.
  78 #
  79 #Returns a list consisting of the new export object and a hashref of options.
  80 #
  81 #=cut
  82 #
  83 #sub clone {
  84 #  my $self = shift;
  85 #  my $class = ref($self);
  86 #  my %hash = $self->hash;
  87 #  $hash{'exportnum'} = '';
  88 #  $hash{'svcpart'} = shift;
  89 #  ( $class->new( \%hash ),
  90 #    { map { $_->optionname => $_->optionvalue }
  91 #        qsearch('part_export_option', { 'exportnum' => $self->exportnum } )
  92 #    }
  93 #  );
  94 #}
  95
  96 =item insert HASHREF
  97
  98 Adds this record to the database.  If there is an error, returns the error,
  99 otherwise returns false.
 100
 101 If a hash reference of options is supplied, part_export_option records are
 102 created (see L<FS::part_export_option>).
 103
 104 =cut
 105
 106 #false laziness w/queue.pm
 107 sub insert {
 108   my $self = shift;
 109   my $options = shift;
 110   local $SIG{HUP} = 'IGNORE';
 111   local $SIG{INT} = 'IGNORE';
 112   local $SIG{QUIT} = 'IGNORE';
 113   local $SIG{TERM} = 'IGNORE';
 114   local $SIG{TSTP} = 'IGNORE';
 115   local $SIG{PIPE} = 'IGNORE';
 116
 117   my $oldAutoCommit = $FS::UID::AutoCommit;
 118   local $FS::UID::AutoCommit = 0;
 119   my $dbh = dbh;
 120
 121   my $error = $self->SUPER::insert;
 122   if ( $error ) {
 123     $dbh->rollback if $oldAutoCommit;
 124     return $error;
 125   }
 126
 127   foreach my $optionname ( keys %{$options} ) {
 128     my $part_export_option = new FS::part_export_option ( {
 129       'exportnum'   => $self->exportnum,
 130       'optionname'  => $optionname,
 131       'optionvalue' => $options->{$optionname},
 132     } );
 133     $error = $part_export_option->insert;
 134     if ( $error ) {
 135       $dbh->rollback if $oldAutoCommit;
 136       return $error;
 137     }
 138   }
 139
 140   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 141
 142   '';
 143
 144 }
 145
 146 =item delete
 147
 148 Delete this record from the database.
 149
 150 =cut
 151
 152 #foreign keys would make this much less tedious... grr dumb mysql
 153 sub delete {
 154   my $self = shift;
 155   local $SIG{HUP} = 'IGNORE';
 156   local $SIG{INT} = 'IGNORE';
 157   local $SIG{QUIT} = 'IGNORE';
 158   local $SIG{TERM} = 'IGNORE';
 159   local $SIG{TSTP} = 'IGNORE';
 160   local $SIG{PIPE} = 'IGNORE';
 161
 162   my $oldAutoCommit = $FS::UID::AutoCommit;
 163   local $FS::UID::AutoCommit = 0;
 164   my $dbh = dbh;
 165
 166   my $error = $self->SUPER::delete;
 167   if ( $error ) {
 168     $dbh->rollback if $oldAutoCommit;
 169     return $error;
 170   }
 171
 172   foreach my $part_export_option ( $self->part_export_option ) {
 173     my $error = $part_export_option->delete;
 174     if ( $error ) {
 175       $dbh->rollback if $oldAutoCommit;
 176       return $error;
 177     }
 178   }
 179
 180   foreach my $export_svc ( $self->export_svc ) {
 181     my $error = $export_svc->delete;
 182     if ( $error ) {
 183       $dbh->rollback if $oldAutoCommit;
 184       return $error;
 185     }
 186   }
 187
 188   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 189
 190   '';
 191
 192 }
 193
 194 =item replace OLD_RECORD HASHREF
 195
 196 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 197 returns the error, otherwise returns false.
 198
 199 If a hash reference of options is supplied, part_export_option records are
 200 created or modified (see L<FS::part_export_option>).
 201
 202 =cut
 203
 204 sub replace {
 205   my $self = shift;
 206   my $old = shift;
 207   my $options = shift;
 208   local $SIG{HUP} = 'IGNORE';
 209   local $SIG{INT} = 'IGNORE';
 210   local $SIG{QUIT} = 'IGNORE';
 211   local $SIG{TERM} = 'IGNORE';
 212   local $SIG{TSTP} = 'IGNORE';
 213   local $SIG{PIPE} = 'IGNORE';
 214
 215   my $oldAutoCommit = $FS::UID::AutoCommit;
 216   local $FS::UID::AutoCommit = 0;
 217   my $dbh = dbh;
 218
 219   my $error = $self->SUPER::replace($old);
 220   if ( $error ) {
 221     $dbh->rollback if $oldAutoCommit;
 222     return $error;
 223   }
 224
 225   foreach my $optionname ( keys %{$options} ) {
 226     my $old = qsearchs( 'part_export_option', {
 227         'exportnum'   => $self->exportnum,
 228         'optionname'  => $optionname,
 229     } );
 230     my $new = new FS::part_export_option ( {
 231         'exportnum'   => $self->exportnum,
 232         'optionname'  => $optionname,
 233         'optionvalue' => $options->{$optionname},
 234     } );
 235     $new->optionnum($old->optionnum) if $old;
 236     my $error = $old ? $new->replace($old) : $new->insert;
 237     if ( $error ) {
 238       $dbh->rollback if $oldAutoCommit;
 239       return $error;
 240     }
 241   }
 242
 243   #remove extraneous old options
 244   foreach my $opt (
 245     grep { !exists $options->{$_->optionname} } $old->part_export_option
 246   ) {
 247     my $error = $opt->delete;
 248     if ( $error ) {
 249       $dbh->rollback if $oldAutoCommit;
 250       return $error;
 251     }
 252   }
 253
 254   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 255
 256   '';
 257
 258 };
 259
 260 =item check
 261
 262 Checks all fields to make sure this is a valid export.  If there is
 263 an error, returns the error, otherwise returns false.  Called by the insert
 264 and replace methods.
 265
 266 =cut
 267
 268 sub check {
 269   my $self = shift;
 270   my $error =
 271     $self->ut_numbern('exportnum')
 272     || $self->ut_domain('machine')
 273     || $self->ut_alpha('exporttype')
 274   ;
 275   return $error if $error;
 276
 277   $self->machine =~ /^([\w\-\.]*)$/
 278     or return "Illegal machine: ". $self->machine;
 279   $self->machine($1);
 280
 281   $self->nodomain =~ /^(Y?)$/ or return "Illegal nodomain: ". $self->nodomain;
 282   $self->nodomain($1);
 283
 284   $self->deprecated(1); #BLAH
 285
 286   #check exporttype?
 287
 288   ''; #no error
 289 }
 290
 291 #=item part_svc
 292 #
 293 #Returns the service definition (see L<FS::part_svc>) for this export.
 294 #
 295 #=cut
 296 #
 297 #sub part_svc {
 298 #  my $self = shift;
 299 #  qsearchs('part_svc', { svcpart => $self->svcpart } );
 300 #}
 301
 302 sub part_svc {
 303   use Carp;
 304   croak "FS::part_export::part_svc deprecated";
 305   #confess "FS::part_export::part_svc deprecated";
 306 }
 307
 308 =item svc_x
 309
 310 Returns a list of associate FS::svc_* records.
 311
 312 =cut
 313
 314 sub svc_x {
 315   my $self = shift;
 316   map { $_->svc_x } $self->cust_svc;
 317 }
 318
 319 =item cust_svc
 320
 321 Returns a list of associated FS::cust_svc records.
 322
 323 =cut
 324
 325 sub cust_svc {
 326   my $self = shift;
 327   map { qsearch('cust_svc', { 'svcpart' => $_->svcpart } ) }
 328     grep { qsearch('cust_svc', { 'svcpart' => $_->svcpart } ) }
 329       $self->export_svc;
 330 }
 331
 332 =item export_svc
 333
 334 Returns a list of associated FS::export_svc records.
 335
 336 =cut
 337
 338 sub export_svc {
 339   my $self = shift;
 340   qsearch('export_svc', { 'exportnum' => $self->exportnum } );
 341 }
 342
 343 =item part_export_option
 344
 345 Returns all options as FS::part_export_option objects (see
 346 L<FS::part_export_option>).
 347
 348 =cut
 349
 350 sub part_export_option {
 351   my $self = shift;
 352   qsearch('part_export_option', { 'exportnum' => $self->exportnum } );
 353 }
 354
 355 =item options
 356
 357 Returns a list of option names and values suitable for assigning to a hash.
 358
 359 =cut
 360
 361 sub options {
 362   my $self = shift;
 363   map { $_->optionname => $_->optionvalue } $self->part_export_option;
 364 }
 365
 366 =item option OPTIONNAME
 367
 368 Returns the option value for the given name, or the empty string.
 369
 370 =cut
 371
 372 sub option {
 373   my $self = shift;
 374   my $part_export_option =
 375     qsearchs('part_export_option', {
 376       exportnum  => $self->exportnum,
 377       optionname => shift,
 378   } );
 379   $part_export_option ? $part_export_option->optionvalue : '';
 380 }
 381
 382 =item rebless
 383
 384 Reblesses the object into the FS::part_export::EXPORTTYPE class, where
 385 EXPORTTYPE is the object's I<exporttype> field.  There should be better docs
 386 on how to create new exports (and they should live in their own files and be
 387 autoloaded-on-demand), but until then, see L</NEW EXPORT CLASSES>.
 388
 389 =cut
 390
 391 sub rebless {
 392   my $self = shift;
 393   my $exporttype = $self->exporttype;
 394   my $class = ref($self). "::$exporttype";
 395   eval "use $class;";
 396   die $@ if $@;
 397   bless($self, $class);
 398 }
 399
 400 =item export_insert SVC_OBJECT
 401
 402 =cut
 403
 404 sub export_insert {
 405   my $self = shift;
 406   $self->rebless;
 407   $self->_export_insert(@_);
 408 }
 409
 410 #sub AUTOLOAD {
 411 #  my $self = shift;
 412 #  $self->rebless;
 413 #  my $method = $AUTOLOAD;
 414 #  #$method =~ s/::(\w+)$/::_$1/; #infinite loop prevention
 415 #  $method =~ s/::(\w+)$/_$1/; #infinite loop prevention
 416 #  $self->$method(@_);
 417 #}
 418
 419 =item export_replace NEW OLD
 420
 421 =cut
 422
 423 sub export_replace {
 424   my $self = shift;
 425   $self->rebless;
 426   $self->_export_replace(@_);
 427 }
 428
 429 =item export_delete
 430
 431 =cut
 432
 433 sub export_delete {
 434   my $self = shift;
 435   $self->rebless;
 436   $self->_export_delete(@_);
 437 }
 438
 439 =item export_suspend
 440
 441 =cut
 442
 443 sub export_suspend {
 444   my $self = shift;
 445   $self->rebless;
 446   $self->_export_suspend(@_);
 447 }
 448
 449 =item export_unsuspend
 450
 451 =cut
 452
 453 sub export_unsuspend {
 454   my $self = shift;
 455   $self->rebless;
 456   $self->_export_unsuspend(@_);
 457 }
 458
 459 #fallbacks providing useful error messages intead of infinite loops
 460 sub _export_insert {
 461   my $self = shift;
 462   return "_export_insert: unknown export type ". $self->exporttype;
 463 }
 464
 465 sub _export_replace {
 466   my $self = shift;
 467   return "_export_replace: unknown export type ". $self->exporttype;
 468 }
 469
 470 sub _export_delete {
 471   my $self = shift;
 472   return "_export_delete: unknown export type ". $self->exporttype;
 473 }
 474
 475 #fallbacks providing null operations
 476
 477 sub _export_suspend {
 478   my $self = shift;
 479   #warn "warning: _export_suspened unimplemented for". ref($self);
 480   '';
 481 }
 482
 483 sub _export_unsuspend {
 484   my $self = shift;
 485   #warn "warning: _export_unsuspend unimplemented for ". ref($self);
 486   '';
 487 }
 488
 489 =back
 490
 491 =head1 SUBROUTINES
 492
 493 =over 4
 494
 495 =item export_info [ SVCDB ]
 496
 497 Returns a hash reference of the exports for the given I<svcdb>, or if no
 498 I<svcdb> is specified, for all exports.  The keys of the hash are
 499 I<exporttype>s and the values are again hash references containing information
 500 on the export:
 501
 502   'desc'     => 'Description',
 503   'options'  => {
 504                   'option'  => { label=>'Option Label' },
 505                   'option2' => { label=>'Another label' },
 506                 },
 507   'nodomain' => 'Y', #or ''
 508   'notes'    => 'Additional notes',
 509
 510 =cut
 511
 512 sub export_info {
 513   #warn $_[0];
 514   return $exports{$_[0]} if @_;
 515   #{ map { %{$exports{$_}} } keys %exports };
 516   my $r = { map { %{$exports{$_}} } keys %exports };
 517 }
 518
 519 #=item exporttype2svcdb EXPORTTYPE
 520 #
 521 #Returns the applicable I<svcdb> for an I<exporttype>.
 522 #
 523 #=cut
 524 #
 525 #sub exporttype2svcdb {
 526 #  my $exporttype = $_[0];
 527 #  foreach my $svcdb ( keys %exports ) {
 528 #    return $svcdb if grep { $exporttype eq $_ } keys %{$exports{$svcdb}};
 529 #  }
 530 #  '';
 531 #}
 532
 533 tie my %sysvshell_options, 'Tie::IxHash',
 534   'crypt' => { label=>'Password encryption',
 535                type=>'select', options=>[qw(crypt md5)],
 536                default=>'crypt',
 537              },
 538 ;
 539
 540 tie my %bsdshell_options, 'Tie::IxHash',
 541   'crypt' => { label=>'Password encryption',
 542                type=>'select', options=>[qw(crypt md5)],
 543                default=>'crypt',
 544              },
 545 ;
 546
 547 tie my %shellcommands_options, 'Tie::IxHash',
 548   #'machine' => { label=>'Remote machine' },
 549   'user' => { label=>'Remote username', default=>'root' },
 550   'useradd' => { label=>'Insert command',
 551                  default=>'useradd -d $dir -m -s $shell -u $uid -p $crypt_password $username'
 552                 #default=>'cp -pr /etc/skel $dir; chown -R $uid.$gid $dir'
 553                },
 554   'useradd_stdin' => { label=>'Insert command STDIN',
 555                        type =>'textarea',
 556                        default=>'',
 557                      },
 558   'userdel' => { label=>'Delete command',
 559                  default=>'userdel -r $username',
 560                  #default=>'rm -rf $dir',
 561                },
 562   'userdel_stdin' => { label=>'Delete command STDIN',
 563                        type =>'textarea',
 564                        default=>'',
 565                      },
 566   'usermod' => { label=>'Modify command',
 567                  default=>'usermod -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -p $new_crypt_password $old_username',
 568                 #default=>'[ -d $old_dir ] && mv $old_dir $new_dir || ( '.
 569                  #  'chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; '.
 570                  #  'find . -depth -print | cpio -pdm $new_dir; '.
 571                  #  'chmod u-t $new_dir; chown -R $uid.$gid $new_dir; '.
 572                  #  'rm -rf $old_dir'.
 573                  #')'
 574                },
 575   'usermod_stdin' => { label=>'Modify command STDIN',
 576                        type =>'textarea',
 577                        default=>'',
 578                      },
 579   'suspend' => { label=>'Suspension command',
 580                  default=>'',
 581                },
 582   'suspend_stdin' => { label=>'Suspension command STDIN',
 583                        default=>'',
 584                      },
 585   'unsuspend' => { label=>'Unsuspension command',
 586                    default=>'',
 587                  },
 588   'unsuspend_stdin' => { label=>'Unsuspension command STDIN',
 589                          default=>'',
 590                        },
 591 ;
 592
 593 tie my %shellcommands_withdomain_options, 'Tie::IxHash',
 594   'user' => { label=>'Remote username', default=>'root' },
 595   'useradd' => { label=>'Insert command',
 596                  #default=>''
 597                },
 598   'useradd_stdin' => { label=>'Insert command STDIN',
 599                        type =>'textarea',
 600                        #default=>"$_password\n$_password\n",
 601                      },
 602   'userdel' => { label=>'Delete command',
 603                  #default=>'',
 604                },
 605   'userdel_stdin' => { label=>'Delete command STDIN',
 606                        type =>'textarea',
 607                        #default=>'',
 608                      },
 609   'usermod' => { label=>'Modify command',
 610                  default=>'',
 611                },
 612   'usermod_stdin' => { label=>'Modify command STDIN',
 613                        type =>'textarea',
 614                        #default=>"$_password\n$_password\n",
 615                      },
 616   'suspend' => { label=>'Suspension command',
 617                  default=>'',
 618                },
 619   'suspend_stdin' => { label=>'Suspension command STDIN',
 620                        default=>'',
 621                      },
 622   'unsuspend' => { label=>'Unsuspension command',
 623                    default=>'',
 624                  },
 625   'unsuspend_stdin' => { label=>'Unsuspension command STDIN',
 626                          default=>'',
 627                        },
 628 ;
 629
 630 tie my %www_shellcommands_options, 'Tie::IxHash',
 631   'user' => { label=>'Remote username', default=>'root' },
 632   'useradd' => { label=>'Insert command',
 633                  default=>'mkdir /var/www/$zone; chown $username /var/www/$zone; ln -s /var/www/$zone $homedir/$zone',
 634                },
 635   'userdel'  => { label=>'Delete command',
 636                   default=>'[ -n &quot;$zone&quot; ] && rm -rf /var/www/$zone; rm $homedir/$zone',
 637                 },
 638   'usermod'  => { label=>'Modify command',
 639                   default=>'[ -n &quot;$old_zone&quot; ] && rm $old_homedir/$old_zone; [ &quot;$old_zone&quot; != &quot;$new_zone&quot; -a -n &quot;$new_zone&quot; ] && mv /var/www/$old_zone /var/www/$new_zone; [ &quot;$old_username&quot; != &quot;$new_username&quot; ] && chown -R $new_username /var/www/$new_zone; ln -s /var/www/$new_zone $new_homedir/$new_zone',
 640                 },
 641 ;
 642
 643 tie my %apache_options, 'Tie::IxHash',
 644   'user'       => { label=>'Remote username', default=>'root' },
 645   'httpd_conf' => { label=>'httpd.conf snippet location',
 646                     default=>'/etc/apache/httpd-freeside.conf', },
 647   'template'   => {
 648     label   => 'Template',
 649     type    => 'textarea',
 650     default => <<'END',
 651 <VirtualHost $domain> #generic
 652 #<VirtualHost ip.addr> #preferred, http://httpd.apache.org/docs/dns-caveats.html
 653 DocumentRoot /var/www/$zone
 654 ServerName $zone
 655 ServerAlias *.$zone
 656 #BandWidthModule On
 657 #LargeFileLimit 4096 12288
 658 </VirtualHost>
 659
 660 END
 661   },
 662 ;
 663
 664 tie my %domain_shellcommands_options, 'Tie::IxHash',
 665   'user' => { lable=>'Remote username', default=>'root' },
 666   'useradd' => { label=>'Insert command',
 667                  default=>'',
 668                },
 669   'userdel'  => { label=>'Delete command',
 670                   default=>'',
 671                 },
 672   'usermod'  => { label=>'Modify command',
 673                   default=>'',
 674                 },
 675 ;
 676
 677 tie my %textradius_options, 'Tie::IxHash',
 678   'user' => { label=>'Remote username', default=>'root' },
 679   'users' => { label=>'users file location', default=>'/etc/raddb/users' },
 680 ;
 681
 682 tie my %sqlradius_options, 'Tie::IxHash',
 683   'datasrc'  => { label=>'DBI data source ' },
 684   'username' => { label=>'Database username' },
 685   'password' => { label=>'Database password' },
 686 ;
 687
 688 tie my %cyrus_options, 'Tie::IxHash',
 689   'server' => { label=>'IMAP server' },
 690   'username' => { label=>'Admin username' },
 691   'password' => { label=>'Admin password' },
 692 ;
 693
 694 tie my %cp_options, 'Tie::IxHash',
 695   'host'      => { label=>'Hostname' },
 696   'port'      => { label=>'Port number' },
 697   'username'  => { label=>'Username' },
 698   'password'  => { label=>'Password' },
 699   'domain'    => { label=>'Domain' },
 700   'workgroup' => { label=>'Default Workgroup' },
 701 ;
 702
 703 tie my %infostreet_options, 'Tie::IxHash',
 704   'url'      => { label=>'XML-RPC Access URL', },
 705   'login'    => { label=>'InfoStreet login', },
 706   'password' => { label=>'InfoStreet password', },
 707   'groupID'  => { label=>'InfoStreet groupID', },
 708 ;
 709
 710 tie my %vpopmail_options, 'Tie::IxHash',
 711   #'machine' => { label=>'vpopmail machine', },
 712   'dir'     => { label=>'directory', }, # ?more info? default?
 713   'uid'     => { label=>'vpopmail uid' },
 714   'gid'     => { label=>'vpopmail gid' },
 715   'restart' => { label=> 'vpopmail restart command',
 716                  default=> 'cd /home/vpopmail/domains; for domain in *; do /home/vpopmail/bin/vmkpasswd $domain; done; /var/qmail/bin/qmail-newu; killall -HUP qmail-send',
 717                },
 718 ;
 719
 720 tie my %bind_options, 'Tie::IxHash',
 721   #'machine'     => { label=>'named machine' },
 722   'named_conf'   => { label  => 'named.conf location',
 723                       default=> '/etc/bind/named.conf' },
 724   'zonepath'     => { label => 'path to zone files',
 725                       default=> '/etc/bind/', },
 726   'bind_release' => { label => 'ISC BIND Release',
 727                       type  => 'select',
 728                       options => [qw(BIND8 BIND9)],
 729                       default => 'BIND8' },
 730   'bind9_minttl' => { label => 'The minttl required by bind9 and RFC1035.',
 731                       default => '1D' },
 732 ;
 733
 734 tie my %bind_slave_options, 'Tie::IxHash',
 735   #'machine'     => { label=> 'Slave machine' },
 736   'master'       => { label=> 'Master IP address(s) (semicolon-separated)' },
 737   'named_conf'   => { label   => 'named.conf location',
 738                       default => '/etc/bind/named.conf' },
 739   'bind_release' => { label => 'ISC BIND Release',
 740                       type  => 'select',
 741                       options => [qw(BIND8 BIND9)],
 742                       default => 'BIND8' },
 743   'bind9_minttl' => { label => 'The minttl required by bind9 and RFC1035.',
 744                       default => '1D' },
 745 ;
 746
 747 tie my %http_options, 'Tie::IxHash',
 748   'method' => { label   =>'Method',
 749                 type    =>'select',
 750                 #options =>[qw(POST GET)],
 751                 options =>[qw(POST)],
 752                 default =>'POST' },
 753   'url'    => { label   => 'URL', default => 'http://', },
 754   'insert_data' => {
 755     label   => 'Insert data',
 756     type    => 'textarea',
 757     default => join("\n",
 758       'DomainName $svc_x->domain',
 759       'Email ( grep { $_ ne "POST" } $svc_x->cust_svc->cust_pkg->cust_main->invoicing_list)[0]',
 760       'test 1',
 761       'reseller $svc_x->cust_svc->cust_pkg->part_pkg->pkg =~ /reseller/i',
 762     ),
 763   },
 764   'delete_data' => {
 765     label   => 'Delete data',
 766     type    => 'textarea',
 767     default => join("\n",
 768     ),
 769   },
 770   'replace_data' => {
 771     label   => 'Replace data',
 772     type    => 'textarea',
 773     default => join("\n",
 774     ),
 775   },
 776 ;
 777
 778 tie my %sqlmail_options, 'Tie::IxHash',
 779   'datasrc'            => { label => 'DBI data source' },
 780   'username'           => { label => 'Database username' },
 781   'password'           => { label => 'Database password' },
 782   'server_type'        => {
 783     label   => 'Server type',
 784     type    => 'select',
 785     options => [qw(dovecot_plain dovecot_crypt dovecot_digest_md5 courier_plain
 786                    courier_crypt)],
 787     default => ['dovecot_plain'], },
 788   'svc_acct_table'     => { label => 'User Table', default => 'user_acct' },
 789   'svc_forward_table'  => { label => 'Forward Table', default => 'forward' },
 790   'svc_domain_table'   => { label => 'Domain Table', default => 'domain' },
 791   'svc_acct_fields'    => { label => 'svc_acct Export Fields',
 792                             default => 'username _password domsvc svcnum' },
 793   'svc_forward_fields' => { label => 'svc_forward Export Fields',
 794                             default => 'domain svcnum catchall' },
 795   'svc_domain_fields'  => { label => 'svc_domain Export Fields',
 796                             default => 'srcsvc dstsvc dst' },
 797   'resolve_dstsvc'     => { label => q{Resolve svc_forward.dstsvc to an email address and store it in dst. (Doesn't require that you also export dstsvc.)},
 798                             type => 'checkbox' },
 799
 800 ;
 801
 802 tie my %ldap_options, 'Tie::IxHash',
 803   'dn'         => { label=>'Root DN' },
 804   'password'   => { label=>'Root DN password' },
 805   'userdn'     => { label=>'User DN' },
 806   'attributes' => { label=>'Attributes',
 807                     type=>'textarea',
 808                     default=>join("\n",
 809                       'uid $username',
 810                       'mail $username\@$domain',
 811                       'uidno $uid',
 812                       'gidno $gid',
 813                       'cn $first',
 814                       'sn $last',
 815                       'mailquota $quota',
 816                       'vmail',
 817                       'location',
 818                       'mailtag',
 819                       'mailhost',
 820                       'mailmessagestore $dir',
 821                       'userpassword $crypt_password',
 822                       'hint',
 823                       'answer $sec_phrase',
 824                       'objectclass top,person,inetOrgPerson',
 825                     ),
 826                   },
 827   'radius'     => { label=>'Export RADIUS attributes', type=>'checkbox', },
 828 ;
 829
 830 tie my %forward_shellcommands_options, 'Tie::IxHash',
 831   'user' => { lable=>'Remote username', default=>'root' },
 832   'useradd' => { label=>'Insert command',
 833                  default=>'',
 834                },
 835   'userdel'  => { label=>'Delete command',
 836                   default=>'',
 837                 },
 838   'usermod'  => { label=>'Modify command',
 839                   default=>'',
 840                 },
 841 ;
 842
 843 #export names cannot have dashes...
 844 %exports = (
 845   'svc_acct' => {
 846     'sysvshell' => {
 847       'desc' =>
 848         'Batch export of /etc/passwd and /etc/shadow files (Linux/SysV).',
 849       'options' => \%sysvshell_options,
 850       'nodomain' => 'Y',
 851       'notes' => 'MD5 crypt requires installation of <a href="http://search.cpan.org/search?dist=Crypt-PasswdMD5">Crypt::PasswdMD5</a> from CPAN.    Run bin/sysvshell.export to export the files.',
 852     },
 853     'bsdshell' => {
 854       'desc' =>
 855         'Batch export of /etc/passwd and /etc/master.passwd files (BSD).',
 856       'options' => \%bsdshell_options,
 857       'nodomain' => 'Y',
 858       'notes' => 'MD5 crypt requires installation of <a href="http://search.cpan.org/search?dist=Crypt-PasswdMD5">Crypt::PasswdMD5</a> from CPAN.  Run bin/bsdshell.export to export the files.',
 859     },
 860 #    'nis' => {
 861 #      'desc' =>
 862 #        'Batch export of /etc/global/passwd and /etc/global/shadow for NIS ',
 863 #      'options' => {},
 864 #    },
 865     'textradius' => {
 866       'desc' => 'Real-time export to a text /etc/raddb/users file (Livingston, Cistron)',
 867       'options' => \%textradius_options,
 868       'notes' => 'This will edit a text RADIUS users file in place on a remote server.  Requires installation of <a href="http://search.cpan.org/search?dist=RADIUS-UserFile">RADIUS::UserFile</a> from CPAN.  If using RADIUS::UserFile 1.01, make sure to apply <a href="http://rt.cpan.org/NoAuth/Bug.html?id=1210">this patch</a>.  Also make sure <a href="http://rsync.samba.org/">rsync</a> is installed on the remote machine, and <a href="../docs/ssh.html">SSH is setup for unattended operation</a>.',
 869     },
 870
 871     'shellcommands' => {
 872       'desc' => 'Real-time export via remote SSH (i.e. useradd, userdel, etc.)',
 873       'options' => \%shellcommands_options,
 874       'nodomain' => 'Y',
 875       'notes' => 'Run remote commands via SSH.  Usernames are considered unique (also see shellcommands_withdomain).  You probably want this if the commands you are running will not accept a domain as a parameter.  You will need to <a href="../docs/ssh.html">setup SSH for unattended operation</a>.<BR><BR>Use these buttons for some useful presets:<UL><LI><INPUT TYPE="button" VALUE="Linux/NetBSD" onClick=\'this.form.useradd.value = "useradd -c $finger -d $dir -m -s $shell -u $uid -p $crypt_password $username"; this.form.useradd_stdin.value = ""; this.form.userdel.value = "userdel -r $username"; this.form.userdel_stdin.value=""; this.form.usermod.value = "usermod -c $new_finger -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -p $new_crypt_password $old_username"; this.form.usermod_stdin.value = "";\'><LI><INPUT TYPE="button" VALUE="FreeBSD" onClick=\'this.form.useradd.value = "pw useradd $username -d $dir -m -s $shell -u $uid -g $gid -c $finger -h 0"; this.form.useradd_stdin.value = "$_password\n"; this.form.userdel.value = "pw userdel $username -r"; this.form.userdel_stdin.value=""; this.form.usermod.value = "pw usermod $old_username -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -c $new_finger -h 0"; this.form.usermod_stdin.value = "$new__password\n";\'><LI><INPUT TYPE="button" VALUE="Just maintain directories (use with sysvshell or bsdshell)" onClick=\'this.form.useradd.value = "cp -pr /etc/skel $dir; chown -R $uid.$gid $dir"; this.form.useradd_stdin.value = ""; this.form.usermod.value = "[ -d $old_dir ] && 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 )"; this.form.usermod_stdin.value = ""; this.form.userdel.value = "rm -rf $dir"; this.form.userdel_stdin.value="";\'></UL>',
 876     },
 877
 878     'shellcommands_withdomain' => {
 879       'desc' => 'Real-time export via remote SSH.',
 880       'options' => \%shellcommands_withdomain_options,
 881       'notes' => 'Run remote commands via SSH.  username@domain (rather than just usernames) are considered unique (also see shellcommands).  You probably want this if the commands you are running will accept a domain as a parameter, and will allow the same username with different domains.  You will need to <a href="../docs/ssh.html">setup SSH for unattended operation</a>.',
 882     },
 883
 884     'ldap' => {
 885       'desc' => 'Real-time export to LDAP',
 886       'options' => \%ldap_options,
 887       'notes' => 'Real-time export to arbitrary LDAP attributes.  Requires installation of <a href="http://search.cpan.org/search?dist=Net-LDAP">Net::LDAP</a> from CPAN.',
 888     },
 889
 890     'sqlradius' => {
 891       'desc' => 'Real-time export to SQL-backed RADIUS (ICRADIUS, FreeRADIUS)',
 892       'options' => \%sqlradius_options,
 893       'nodomain' => 'Y',
 894       'notes' => 'Real-time export of radcheck, radreply and usergroup tables to any SQL database for <a href="http://www.freeradius.org/">FreeRADIUS</a> or <a href="http://radius.innercite.com/">ICRADIUS</a>.  An existing RADIUS database will be updated in realtime, but you can use <a href="../docs/man/bin/freeside-sqlradius-reset">freeside-sqlradius-reset</a> to delete the entire RADIUS database and repopulate the tables from the Freeside database.  See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.23/DBI.pm">DBI documentation</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">documentation for your DBD</a> for the exact syntax of a DBI data source.  If using <a href="http://www.freeradius.org/">FreeRADIUS</a> 0.5 or above, make sure your <b>op</b> fields are set to allow NULL values.',
 895     },
 896
 897     'sqlmail' => {
 898       'desc' => 'Real-time export to SQL-backed mail server',
 899       'options' => \%sqlmail_options,
 900       'nodomain' => '',
 901       'notes' => 'Database schema can be made to work with Courier IMAP and Exim.  Others could work but are untested. (...extended description from pc-intouch?...)',
 902     },
 903
 904     'cyrus' => {
 905       'desc' => 'Real-time export to Cyrus IMAP server',
 906       'options' => \%cyrus_options,
 907       'nodomain' => 'Y',
 908       'notes' => 'Integration with <a href="http://asg.web.cmu.edu/cyrus/imapd/">Cyrus IMAP Server</a>.  Cyrus::IMAP::Admin should be installed locally and the connection to the server secured.  <B>svc_acct.quota</B>, if available, is used to set the Cyrus quota. '
 909     },
 910
 911     'cp' => {
 912       'desc' => 'Real-time export to Critical Path Account Provisioning Protocol',
 913       'options' => \%cp_options,
 914       'notes' => 'Real-time export to <a href="http://www.cp.net/">Critial Path Account Provisioning Protocol</a>.  Requires installation of <a href="http://search.cpan.org/search?dist=Net-APP">Net::APP</a> from CPAN.',
 915     },
 916
 917     'infostreet' => {
 918       'desc' => 'Real-time export to InfoStreet streetSmartAPI',
 919       'options' => \%infostreet_options,
 920       'nodomain' => 'Y',
 921       'notes' => 'Real-time export to <a href="http://www.infostreet.com/">InfoStreet</a> streetSmartAPI.  Requires installation of <a href="http://search.cpan.org/search?dist=Frontier-Client">Frontier::Client</a> from CPAN.',
 922     },
 923
 924     'vpopmail' => {
 925       'desc' => 'Real-time export to vpopmail text files',
 926       'options' => \%vpopmail_options,
 927       'notes' => 'Real time export to <a href="http://inter7.com/vpopmail/">vpopmail</a> text files.  <a href="http://search.cpan.org/search?dist=File-Rsync">File::Rsync</a> must be installed, and you will need to <a href="../docs/ssh.html">setup SSH for unattended operation</a> to <b>vpopmail</b>@<i>export.host</i>.',
 928     },
 929
 930   },
 931
 932   'svc_domain' => {
 933
 934     'bind' => {
 935       'desc' =>'Batch export to BIND named',
 936       'options' => \%bind_options,
 937       'notes' => 'Batch export of BIND zone and configuration files to primary nameserver.  <a href="http://search.cpan.org/search?dist=File-Rsync">File::Rsync</a> must be installed.  Run bin/bind.export to export the files.',
 938     },
 939
 940     'bind_slave' => {
 941       'desc' =>'Batch export to slave BIND named',
 942       'options' => \%bind_slave_options,
 943       'notes' => 'Batch export of BIND configuration file to a secondary nameserver.  Zones are slaved from the listed masters.  <a href="http://search.cpan.org/search?dist=File-Rsync">File::Rsync</a> must be installed.  Run bin/bind.export to export the files.',
 944     },
 945
 946     'http' => {
 947       'desc' => 'Send an HTTP or HTTPS GET or POST request',
 948       'options' => \%http_options,
 949       'notes' => 'Send an HTTP or HTTPS GET or POST to the specified URL.  <a href="http://search.cpan.org/search?dist=libwww-perl">libwww-perl</a> must be installed.  For HTTPS support, <a href="http://search.cpan.org/search?dist=Crypt-SSLeay">Crypt::SSLeay</a> or <a href="http://search.cpan.org/search?dist=IO-Socket-SSL">IO::Socket::SSL</a> is required.',
 950     },
 951
 952     'sqlmail' => {
 953       'desc' => 'Real-time export to SQL-backed mail server',
 954       'options' => \%sqlmail_options,
 955       #'nodomain' => 'Y',
 956       'notes' => 'Database schema can be made to work with Courier IMAP and Exim.  Others could work but are untested. (...extended description from pc-intouch?...)',
 957     },
 958
 959     'domain_shellcommands' => {
 960       'desc' => 'Run remote commands via SSH, for domains.',
 961       'options' => \%domain_shellcommands_options,
 962       'notes'    => 'Run remote commands via SSH, for domains.  You will need to <a href="../docs/ssh.html">setup SSH for unattended operation</a>.<BR><BR>Use these buttons for some useful presets:<UL><LI><INPUT TYPE="button" VALUE="qmail catchall .qmail-domain-default maintenance" onClick=\'this.form.useradd.value = "[ \"$uid\" -a \"$gid\" -a \"$dir\" -a \"$qdomain\" ] && [ -e $dir/.qmail-$qdomain-default ] || { touch $dir/.qmail-$qdomain-default; chown $uid:$gid $dir/.qmail-$qdomain-default; }"; this.form.userdel.value = ""; this.form.usermod.value = "";\'></UL>',
 963     },
 964
 965
 966   },
 967
 968   'svc_forward' => {
 969     'sqlmail' => {
 970       'desc' => 'Real-time export to SQL-backed mail server',
 971       'options' => \%sqlmail_options,
 972       #'nodomain' => 'Y',
 973       'notes' => 'Database schema can be made to work with Courier IMAP and Exim.  Others could work but are untested. (...extended description from pc-intouch?...)',
 974     },
 975
 976     'forward_shellcommands' => {
 977       'desc' => 'Run remote commands via SSH, for forwards',
 978       'options' => \%forward_shellcommands_options,
 979       'notes' => 'Run remote commands via SSH, for forwards.  You will need to <a href="../docs/ssh.html">setup SSH for unattended operation</a>.<BR><BR>Use these buttons for some useful presets:<UL><LI><INPUT TYPE="button" VALUE="text vpopmail maintenance" onClick=\'this.form.useradd.value = "[ -d /home/vpopmail/domains/$domain/$username ] && { echo \"$destination\" > /home/vpopmail/domains/$domain/$username/.qmail; chown vpopmail:vchkpw /home/vpopmail/domains/$domain/$username/.qmail; }"; this.form.userdel.value = "rm /home/vpopmail/domains/$domain/$username/.qmail"; this.form.usermod.value = "mv /home/vpopmail/domains/$old_domain/$old_username/.qmail /home/vpopmail/domains/$new_domain/$new_username; [ \"$old_destination\" != \"$new_destination\" ] && { echo \"$new_destination\" > /home/vpopmail/domains/$new_domain/$new_username/.qmail; chown vpopmail:vchkpw /home/vpopmail/domains/$new_domain/$new_username/.qmail; }";\'></UL>',
 980     },
 981   },
 982
 983   'svc_www' => {
 984     'www_shellcommands' => {
 985       'desc' => 'Run remote commands via SSH, for virtual web sites.',
 986       'options' => \%www_shellcommands_options,
 987       'notes'    => 'Run remote commands via SSH, for virtual web sites.  You will need to <a href="../docs/ssh.html">setup SSH for unattended operation</a>.',
 988     },
 989
 990     'apache' => {
 991       'desc' => 'Export an Apache httpd.conf file snippet.',
 992       'options' => \%apache_options,
 993       'notes' => 'Batch export of an httpd.conf snippet from a template.  Typically used with something like <code>Include /etc/apache/httpd-freeside.conf</code> in httpd.conf.  <a href="http://search.cpan.org/search?dist=File-Rsync">File::Rsync</a> must be installed.  Run bin/apache.export to export the files.',
 994     },
 995   },
 996
 997   'svc_broadband' => {
 998   },
 999
1000 );
1001
1002 =back
1003
1004 =head1 NEW EXPORT CLASSES
1005
1006 Should be added to the %export hash here, and a module should be added in
1007 FS/FS/part_export/ (an example may be found in eg/export_template.pm)
1008
1009 =head1 BUGS
1010
1011 All the stuff in the %exports hash should be generated from the specific
1012 export modules.
1013
1014 Hmm... cust_export class (not necessarily a database table...) ... ?
1015
1016 deprecated column...
1017
1018 =head1 SEE ALSO
1019
1020 L<FS::part_export_option>, L<FS::export_svc>, L<FS::svc_acct>,
1021 L<FS::svc_domain>,
1022 L<FS::svc_forward>, L<FS::Record>, schema.html from the base documentation.
1023
1024 =cut
1025
1026 1;
1027