1 package FS::part_export;
4 use vars qw( @ISA @EXPORT_OK %exports );
7 use FS::Record qw( qsearch qsearchs dbh );
9 use FS::part_export_option;
12 @ISA = qw(FS::Record);
13 @EXPORT_OK = qw(export_info);
17 FS::part_export - Object methods for part_export records
23 $record = new FS::part_export \%hash;
24 $record = new FS::part_export { 'column' => 'value' };
26 #($new_record, $options) = $template_recored->clone( $svcpart );
28 $error = $record->insert( { 'option' => 'value' } );
29 $error = $record->insert( \%options );
31 $error = $new_record->replace($old_record);
33 $error = $record->delete;
35 $error = $record->check;
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:
45 =item exportnum - primary key
47 =item machine - Machine name
49 =item exporttype - Export type
51 =item nodomain - blank or "Y" : usernames are exported to this service with no domain
61 Creates a new export. To add the export to the database, see L<"insert">.
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.
68 # the new method can be inherited from FS::Record, if a table method is defined
70 sub table { 'part_export'; }
76 #An alternate constructor. Creates a new export by duplicating an existing
77 #export. The given svcpart is assigned to the new export.
79 #Returns a list consisting of the new export object and a hashref of options.
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 } )
98 Adds this record to the database. If there is an error, returns the error,
99 otherwise returns false.
101 If a hash reference of options is supplied, part_export_option records are
102 created (see L<FS::part_export_option>).
106 #false laziness w/queue.pm
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';
117 my $oldAutoCommit = $FS::UID::AutoCommit;
118 local $FS::UID::AutoCommit = 0;
121 my $error = $self->SUPER::insert;
123 $dbh->rollback if $oldAutoCommit;
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},
133 $error = $part_export_option->insert;
135 $dbh->rollback if $oldAutoCommit;
140 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
148 Delete this record from the database.
152 #foreign keys would make this much less tedious... grr dumb mysql
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';
162 my $oldAutoCommit = $FS::UID::AutoCommit;
163 local $FS::UID::AutoCommit = 0;
166 my $error = $self->SUPER::delete;
168 $dbh->rollback if $oldAutoCommit;
172 foreach my $part_export_option ( $self->part_export_option ) {
173 my $error = $part_export_option->delete;
175 $dbh->rollback if $oldAutoCommit;
180 foreach my $export_svc ( $self->export_svc ) {
181 my $error = $export_svc->delete;
183 $dbh->rollback if $oldAutoCommit;
188 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
194 =item replace OLD_RECORD HASHREF
196 Replaces the OLD_RECORD with this one in the database. If there is an error,
197 returns the error, otherwise returns false.
199 If a hash reference of options is supplied, part_export_option records are
200 created or modified (see L<FS::part_export_option>).
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';
215 my $oldAutoCommit = $FS::UID::AutoCommit;
216 local $FS::UID::AutoCommit = 0;
219 my $error = $self->SUPER::replace($old);
221 $dbh->rollback if $oldAutoCommit;
225 foreach my $optionname ( keys %{$options} ) {
226 my $old = qsearchs( 'part_export_option', {
227 'exportnum' => $self->exportnum,
228 'optionname' => $optionname,
230 my $new = new FS::part_export_option ( {
231 'exportnum' => $self->exportnum,
232 'optionname' => $optionname,
233 'optionvalue' => $options->{$optionname},
235 $new->optionnum($old->optionnum) if $old;
236 my $error = $old ? $new->replace($old) : $new->insert;
238 $dbh->rollback if $oldAutoCommit;
243 #remove extraneous old options
245 grep { !exists $options->{$_->optionname} } $old->part_export_option
247 my $error = $opt->delete;
249 $dbh->rollback if $oldAutoCommit;
254 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
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
271 $self->ut_numbern('exportnum')
272 || $self->ut_domain('machine')
273 || $self->ut_alpha('exporttype')
275 return $error if $error;
277 warn $self->machine. "!!!\n";
279 $self->machine =~ /^([\w\-\.]*)$/
280 or return "Illegal machine: ". $self->machine;
283 $self->nodomain =~ /^(Y?)$/ or return "Illegal nodomain: ". $self->nodomain;
286 $self->deprecated(1); #BLAH
295 #Returns the service definition (see L<FS::part_svc>) for this export.
301 # qsearchs('part_svc', { svcpart => $self->svcpart } );
306 croak "FS::part_export::part_svc deprecated";
307 #confess "FS::part_export::part_svc deprecated";
312 Returns a list of associated FS::export_svc records.
318 qsearch('export_svc', { 'exportnum' => $self->exportnum } );
321 =item part_export_option
323 Returns all options as FS::part_export_option objects (see
324 L<FS::part_export_option>).
328 sub part_export_option {
330 qsearch('part_export_option', { 'exportnum' => $self->exportnum } );
335 Returns a list of option names and values suitable for assigning to a hash.
341 map { $_->optionname => $_->optionvalue } $self->part_export_option;
344 =item option OPTIONNAME
346 Returns the option value for the given name, or the empty string.
352 my $part_export_option =
353 qsearchs('part_export_option', {
354 exportnum => $self->exportnum,
357 $part_export_option ? $part_export_option->optionvalue : '';
362 Reblesses the object into the FS::part_export::EXPORTTYPE class, where
363 EXPORTTYPE is the object's I<exporttype> field. There should be better docs
364 on how to create new exports (and they should live in their own files and be
365 autoloaded-on-demand), but until then, see L</NEW EXPORT CLASSES>.
371 my $exporttype = $self->exporttype;
372 my $class = ref($self). "::$exporttype";
375 bless($self, $class);
378 =item export_insert SVC_OBJECT
385 $self->_export_insert(@_);
391 # my $method = $AUTOLOAD;
392 # #$method =~ s/::(\w+)$/::_$1/; #infinite loop prevention
393 # $method =~ s/::(\w+)$/_$1/; #infinite loop prevention
394 # $self->$method(@_);
397 =item export_replace NEW OLD
404 $self->_export_replace(@_);
414 $self->_export_delete(@_);
424 $self->_export_suspend(@_);
427 =item export_unsuspend
431 sub export_unsuspend {
434 $self->_export_unsuspend(@_);
437 #fallbacks providing useful error messages intead of infinite loops
440 return "_export_insert: unknown export type ". $self->exporttype;
443 sub _export_replace {
445 return "_export_replace: unknown export type ". $self->exporttype;
450 return "_export_delete: unknown export type ". $self->exporttype;
453 #fallbacks providing null operations
455 sub _export_suspend {
457 #warn "warning: _export_suspened unimplemented for". ref($self);
461 sub _export_unsuspend {
463 #warn "warning: _export_unsuspend unimplemented for ". ref($self);
473 =item export_info [ SVCDB ]
475 Returns a hash reference of the exports for the given I<svcdb>, or if no
476 I<svcdb> is specified, for all exports. The keys of the hash are
477 I<exporttype>s and the values are again hash references containing information
480 'desc' => 'Description',
482 'option' => { label=>'Option Label' },
483 'option2' => { label=>'Another label' },
485 'nodomain' => 'Y', #or ''
486 'notes' => 'Additional notes',
492 return $exports{$_[0]} if @_;
493 #{ map { %{$exports{$_}} } keys %exports };
494 my $r = { map { %{$exports{$_}} } keys %exports };
497 #=item exporttype2svcdb EXPORTTYPE
499 #Returns the applicable I<svcdb> for an I<exporttype>.
503 #sub exporttype2svcdb {
504 # my $exporttype = $_[0];
505 # foreach my $svcdb ( keys %exports ) {
506 # return $svcdb if grep { $exporttype eq $_ } keys %{$exports{$svcdb}};
511 tie my %sysvshell_options, 'Tie::IxHash',
512 'crypt' => { label=>'Password encryption',
513 type=>'select', options=>[qw(crypt md5)],
518 tie my %bsdshell_options, 'Tie::IxHash',
519 'crypt' => { label=>'Password encryption',
520 type=>'select', options=>[qw(crypt md5)],
525 tie my %shellcommands_options, 'Tie::IxHash',
526 #'machine' => { label=>'Remote machine' },
527 'user' => { label=>'Remote username', default=>'root' },
528 'useradd' => { label=>'Insert command',
529 default=>'useradd -d $dir -m -s $shell -u $uid $username; passwd $username'
530 #default=>'cp -pr /etc/skel $dir; chown -R $uid.$gid $dir'
532 'useradd_stdin' => { label=>'Insert command STDIN',
534 default=>"\$_password\n\$_password\n",
536 'userdel' => { label=>'Delete command',
537 default=>'userdel $username',
538 #default=>'rm -rf $dir',
540 'userdel_stdin' => { label=>'Delete command STDIN',
544 'usermod' => { label=>'Modify command',
545 default=>'usermod -d $new_dir -l $new_username -s $new_shell -u $new_uid $old_username; passwd $new_username',
546 #default=>'[ -d $old_dir ] && mv $old_dir $new_dir || ( '.
547 # 'chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; '.
548 # 'find . -depth -print | cpio -pdm $new_dir; '.
549 # 'chmod u-t $new_dir; chown -R $uid.$gid $new_dir; '.
553 'usermod_stdin' => { label=>'Modify command STDIN',
555 default=>"\$_password\n\$_password\n",
559 tie my %shellcommands_withdomain_options, 'Tie::IxHash',
560 'user' => { label=>'Remote username', default=>'root' },
561 'useradd' => { label=>'Insert command',
564 'useradd_stdin' => { label=>'Insert command STDIN',
566 #default=>"$_password\n$_password\n",
568 'userdel' => { label=>'Delete command',
571 'userdel_stdin' => { label=>'Delete command STDIN',
575 'usermod' => { label=>'Modify command',
578 'usermod_stdin' => { label=>'Modify command STDIN',
580 #default=>"$_password\n$_password\n",
584 tie my %textradius_options, 'Tie::IxHash',
585 'user' => { label=>'Remote username', default=>'root' },
586 'users' => { label=>'users file location', default=>'/etc/raddb/users' },
589 tie my %sqlradius_options, 'Tie::IxHash',
590 'datasrc' => { label=>'DBI data source ' },
591 'username' => { label=>'Database username' },
592 'password' => { label=>'Database password' },
595 tie my %cyrus_options, 'Tie::IxHash',
596 'server' => { label=>'IMAP server' },
597 'username' => { label=>'Admin username' },
598 'password' => { label=>'Admin password' },
601 tie my %cp_options, 'Tie::IxHash',
602 'host' => { label=>'Hostname' },
603 'port' => { label=>'Port number' },
604 'username' => { label=>'Username' },
605 'password' => { label=>'Password' },
606 'domain' => { label=>'Domain' },
607 'workgroup' => { label=>'Default Workgroup' },
610 tie my %infostreet_options, 'Tie::IxHash',
611 'url' => { label=>'XML-RPC Access URL', },
612 'login' => { label=>'InfoStreet login', },
613 'password' => { label=>'InfoStreet password', },
614 'groupID' => { label=>'InfoStreet groupID', },
617 tie my %vpopmail_options, 'Tie::IxHash',
618 'machine' => { label=>'vpopmail machine', },
619 'dir' => { label=>'directory', }, # ?more info? default?
620 'uid' => { label=>'vpopmail uid' },
621 'gid' => { label=>'vpopmail gid' },
624 tie my %bind_options, 'Tie::IxHash',
625 #'machine' => { label=>'named machine' },
626 'named_conf' => { label => 'named.conf location',
627 default=> '/etc/bind/named.conf' },
628 'zonepath' => { label => 'path to zone files',
629 default=> '/etc/bind/', },
632 tie my %bind_slave_options, 'Tie::IxHash',
633 #'machine' => { label=> 'Slave machine' },
634 'master' => { label=> 'Master IP address(s) (semicolon-separated)' },
635 'named_conf' => { label => 'named.conf location',
636 default => '/etc/bind/named.conf' },
639 tie my %sqlmail_options, 'Tie::IxHash',
640 'datasrc' => { label=>'DBI data source' },
641 'username' => { label=>'Database username' },
642 'password' => { label=>'Database password' },
646 #export names cannot have dashes...
651 'Batch export of /etc/passwd and /etc/shadow files (Linux/SysV).',
652 'options' => \%sysvshell_options,
654 '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.',
658 'Batch export of /etc/passwd and /etc/master.passwd files (BSD).',
659 'options' => \%bsdshell_options,
661 '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.',
665 # 'Batch export of /etc/global/passwd and /etc/global/shadow for NIS ',
669 'desc' => 'Real-time export to a text /etc/raddb/users file (Livingston, Cistron)',
670 'options' => \%textradius_options,
671 '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>.',
675 'desc' => 'Real-time export via remote SSH (i.e. useradd, userdel, etc.)',
676 'options' => \%shellcommands_options,
678 '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 -d $dir -m -s $shell -u $uid $username; passwd $username"; this.form.useradd_stdin.value = "$_password\n$_password\n"; this.form.userdel.value = "userdel $username"; this.form.userdel_stdin.value=""; this.form.usermod.value = "usermod -d $new_dir -l $new_username -s $new_shell -u $new_uid $old_username; passwd $new_username"; this.form.usermod_stdin.value = "$_password\n$_password\n";\'><LI><INPUT TYPE="button" VALUE="FreeBSD" onClick=\'this.form.useradd.value = "pw useradd $username -d $dir -m -s $shell -u $uid; passwd $username"; this.form.useradd_stdin.value = "$_password\n$_password\n"; this.form.userdel.value = "userdel $username"; this.form.userdel_stdin.value=""; this.form.usermod.value = "pw usermod $old_username -d $new_dir -l $new_username -s $new_shell -u $new_uid; passwd $new_username"; this.form.usermod_stdin.value = "$_password\n$_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>',
681 'shellcommands_withdomain' => {
682 'desc' => 'Real-time export via remote SSH.',
683 'options' => \%shellcommands_withdomain_options,
684 '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>.',
688 'desc' => 'Real-time export to SQL-backed RADIUS (ICRADIUS, FreeRADIUS)',
689 'options' => \%sqlradius_options,
691 '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.',
695 'desc' => 'Real-time export to SQL-backed mail server',
696 'options' => \%sqlmail_options,
698 'notes' => 'Database schema can be made to work with Courier IMAP and Exim. Others could work but are untested. (...extended description from pc-intouch?...)',
702 'desc' => 'Real-time export to Cyrus IMAP server',
703 'options' => \%cyrus_options,
705 '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. '
709 'desc' => 'Real-time export to Critical Path Account Provisioning Protocol',
710 'options' => \%cp_options,
711 '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.',
715 'desc' => 'Real-time export to InfoStreet streetSmartAPI',
716 'options' => \%infostreet_options,
718 '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.',
722 'desc' => 'Real-time export to vpopmail text files',
723 'options' => \%vpopmail_options,
724 'notes' => 'Real time export to <a href="http://inter7.com/vpopmail/">vpopmail</a> text files (...extended description from jeff?...)',
732 'desc' =>'Batch export to BIND named',
733 'options' => \%bind_options,
734 '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.',
738 'desc' =>'Batch export to slave BIND named',
739 'options' => \%bind_slave_options,
740 '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.',
744 'desc' => 'Real-time export to SQL-backed mail server',
745 'options' => \%sqlmail_options,
747 'notes' => 'Database schema can be made to work with Courier IMAP and Exim. Others could work but are untested. (...extended description from pc-intouch?...)',
757 'desc' => 'Real-time export to SQL-backed mail server',
758 'options' => \%sqlmail_options,
760 'notes' => 'Database schema can be made to work with Courier IMAP and Exim. Others could work but are untested. (...extended description from pc-intouch?...)',
765 'www_shellcommands' => {
766 'desc' => 'www_shellcommands',
767 'options' => {}, # \%www_shellcommands_options,
768 'notes' => 'unfinished...',
777 =head1 NEW EXPORT CLASSES
779 Should be added to the %export hash here, and a module should be added in
780 FS/FS/part_export/ (an example may be found in eg/export_template.pm)
784 All the stuff in the %exports hash should be generated from the specific
787 Hmm... cust_export class (not necessarily a database table...) ... ?
793 L<FS::part_export_option>, L<FS::export_svc>, L<FS::svc_acct>,
795 L<FS::svc_forward>, L<FS::Record>, schema.html from the base documentation.