1 package FS::part_export;
5 use FS::Record qw( qsearch qsearchs dbh );
7 use FS::part_export_option;
13 FS::part_export - Object methods for part_export records
19 $record = new FS::part_export \%hash;
20 $record = new FS::part_export { 'column' => 'value' };
22 ($new_record, $options) = $template_recored->clone( $svcpart );
24 $error = $record->insert( { 'option' => 'value' } );
25 $error = $record->insert( \%options );
27 $error = $new_record->replace($old_record);
29 $error = $record->delete;
31 $error = $record->check;
35 An FS::part_export object represents an export of Freeside data to an external
36 provisioning system. FS::part_export inherits from FS::Record. The following
37 fields are currently supported:
41 =item exportnum - primary key
43 =item svcpart - Service definition (see L<FS::part_svc>) to which this export applies
45 =item machine - Machine name
47 =item exporttype - Export type
49 =item nodomain - blank or "Y" : usernames are exported to this service with no domain
59 Creates a new export. To add the export to the database, see L<"insert">.
61 Note that this stores the hash reference, not a distinct copy of the hash it
62 points to. You can ask the object for a copy with the I<hash> method.
66 # the new method can be inherited from FS::Record, if a table method is defined
68 sub table { 'part_export'; }
72 An alternate constructor. Creates a new export by duplicating an existing
73 export. The given svcpart is assigned to the new export.
75 Returns a list consisting of the new export object and a hashref of options.
81 my $class = ref($self);
82 my %hash = $self->hash;
83 $hash{'exportnum'} = '';
84 $hash{'svcpart'} = shift;
85 ( $class->new( \%hash ),
86 { map { $_->optionname => $_->optionvalue }
87 qsearch('part_export_option', { 'exportnum' => $self->exportnum } )
94 Adds this record to the database. If there is an error, returns the error,
95 otherwise returns false.
97 If a hash reference of options is supplied, part_export_option records are
98 created (see L<FS::part_export_option>).
102 #false laziness w/queue.pm
106 local $SIG{HUP} = 'IGNORE';
107 local $SIG{INT} = 'IGNORE';
108 local $SIG{QUIT} = 'IGNORE';
109 local $SIG{TERM} = 'IGNORE';
110 local $SIG{TSTP} = 'IGNORE';
111 local $SIG{PIPE} = 'IGNORE';
113 my $oldAutoCommit = $FS::UID::AutoCommit;
114 local $FS::UID::AutoCommit = 0;
117 my $error = $self->SUPER::insert;
119 $dbh->rollback if $oldAutoCommit;
123 foreach my $optionname ( keys %{$options} ) {
124 my $part_export_option = new FS::part_export_option ( {
125 'exportnum' => $self->exportnum,
126 'optionname' => $optionname,
127 'optionvalue' => $options->{$optionname},
129 $error = $part_export_option->insert;
131 $dbh->rollback if $oldAutoCommit;
136 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
144 Delete this record from the database.
148 #foreign keys would make this much less tedious... grr dumb mysql
151 local $SIG{HUP} = 'IGNORE';
152 local $SIG{INT} = 'IGNORE';
153 local $SIG{QUIT} = 'IGNORE';
154 local $SIG{TERM} = 'IGNORE';
155 local $SIG{TSTP} = 'IGNORE';
156 local $SIG{PIPE} = 'IGNORE';
158 my $oldAutoCommit = $FS::UID::AutoCommit;
159 local $FS::UID::AutoCommit = 0;
162 my $error = $self->SUPER::delete;
164 $dbh->rollback if $oldAutoCommit;
168 foreach my $part_export_option ( $self->part_export_option ) {
169 my $error = $part_export_option->delete;
171 $dbh->rollback if $oldAutoCommit;
176 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
182 =item replace OLD_RECORD HASHREF
184 Replaces the OLD_RECORD with this one in the database. If there is an error,
185 returns the error, otherwise returns false.
187 If a hash reference of options is supplied, part_export_option records are
188 created or modified (see L<FS::part_export_option>).
196 local $SIG{HUP} = 'IGNORE';
197 local $SIG{INT} = 'IGNORE';
198 local $SIG{QUIT} = 'IGNORE';
199 local $SIG{TERM} = 'IGNORE';
200 local $SIG{TSTP} = 'IGNORE';
201 local $SIG{PIPE} = 'IGNORE';
203 my $oldAutoCommit = $FS::UID::AutoCommit;
204 local $FS::UID::AutoCommit = 0;
207 my $error = $self->SUPER::replace($old);
209 $dbh->rollback if $oldAutoCommit;
213 foreach my $optionname ( keys %{$options} ) {
214 my $old = qsearchs( 'part_export_option', {
215 'exportnum' => $self->exportnum,
216 'optionname' => $optionname,
218 my $new = new FS::part_export_option ( {
219 'exportnum' => $self->exportnum,
220 'optionname' => $optionname,
221 'optionvalue' => $options->{$optionname},
223 $new->optionnum($old->optionnum) if $old;
224 my $error = $old ? $new->replace($old) : $new->insert;
226 $dbh->rollback if $oldAutoCommit;
231 #remove extraneous old options
233 grep { !exists $options->{$_->optionname} } $old->part_export_option
235 my $error = $opt->delete;
237 $dbh->rollback if $oldAutoCommit;
242 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
250 Checks all fields to make sure this is a valid export. If there is
251 an error, returns the error, otherwise returns false. Called by the insert
259 $self->ut_numbern('exportnum')
260 || $self->ut_domain('machine')
261 || $self->ut_number('svcpart')
262 || $self->ut_alpha('exporttype')
264 return $error if $error;
266 return "Unknown svcpart: ". $self->svcpart
267 unless qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
269 $self->machine =~ /^([\w\-\.]*)$/
270 or return "Illegal machine: ". $self->machine;
273 $self->nodomain =~ /^(Y?)$/ or return "Illegal nodomain: ". $self->nodomain;
283 Returns the service definition (see L<FS::part_svc>) for this export.
289 qsearchs('part_svc', { svcpart => $self->svcpart } );
292 =item part_export_option
294 Returns all options as FS::part_export_option objects (see
295 L<FS::part_export_option>).
299 sub part_export_option {
301 qsearch('part_export_option', { 'exportnum' => $self->exportnum } );
306 Returns a list of option names and values suitable for assigning to a hash.
312 map { $_->optionname => $_->optionvalue } $self->part_export_option;
315 =item option OPTIONNAME
317 Returns the option value for the given name, or the empty string.
323 my $part_export_option =
324 qsearchs('part_export_option', {
325 exportnum => $self->exportnum,
328 $part_export_option ? $part_export_option->optionvalue : '';
333 Reblesses the object into the FS::part_export::EXPORTTYPE class, where
334 EXPORTTYPE is the object's I<exporttype> field. There should be better docs
335 on how to create new exports (and they should live in their own files and be
336 autoloaded-on-demand), but until then, see L</NEW EXPORT CLASSES>.
342 my $exporttype = $self->exporttype;
343 my $class = ref($self);
344 bless($self, $class."::$exporttype");
347 =item export_insert SVC_OBJECT
354 $self->_export_insert(@_);
360 # my $method = $AUTOLOAD;
361 # #$method =~ s/::(\w+)$/::_$1/; #infinite loop prevention
362 # $method =~ s/::(\w+)$/_$1/; #infinite loop prevention
363 # $self->$method(@_);
366 =item export_replace NEW OLD
373 $self->_export_replace(@_);
383 $self->_export_delete(@_);
392 package FS::part_export::infostreet;
394 @ISA = qw(FS::part_export);
397 my( $self, $svc_acct ) = (shift, shift);
398 $self->infostreet_queue( $svc_acct->svcnum,
399 'createUser', $svc_acct->username, $svc_acct->password );
402 sub _export_replace {
403 my( $self, $new, $old ) = (shift, shift, shift);
404 return "can't change username with InfoStreet"
405 if $old->username ne $new->username;
406 return '' unless $old->_password ne $new->_password;
407 $self->infostreet_queue( $new->svcnum,
408 'passwd', $new->username, $new->password );
412 my( $self, $svc_acct ) = (shift, shift);
413 $self->infostreet_queue( $svc_acct->svcnum,
414 'purgeAccount,releaseUsername', $svc_acct->username );
417 sub infostreet_queue {
418 my( $self, $svcnum, $method ) = (shift, shift, shift);
419 my $queue = new FS::queue {
421 'job' => 'FS::part_export::infostreet::infostreet_command',
424 $self->option('url'),
425 $self->option('login'),
426 $self->option('password'),
427 $self->option('groupID'),
433 sub infostreet_command { #subroutine, not method
434 my($url, $username, $password, $groupID, $method, @args) = @_;
437 if ( $method =~ /,/ ) {
438 foreach my $part ( split(/,\s*/, $method) ) {
439 infostreet_command($url, $username, $password, $groupID, $part, @args);
444 eval "use Frontier::Client;";
446 my $conn = Frontier::Client->new( url => $url );
447 my $key_result = $conn->call( 'authenticate', $username, $password, $groupID);
448 my %key_result = _infostreet_parse($key_result);
449 die $key_result{error} unless $key_result{success};
450 my $key = $key_result{data};
452 my $result = $conn->call($method, $key, @args);
453 my %result = _infostreet_parse($result);
454 die $result{error} unless $result{success};
458 sub _infostreet_parse { #subroutine, not method
461 my $value = $arg->{$_};
463 $value = $value->value()
464 if ref($value) && $value->isa('Frontier::RPC2::DataType');
471 package FS::part_export::sqlradius;
473 @ISA = qw(FS::part_export);
476 my($self, $svc_acct) = (shift, shift);
477 $self->sqlradius_queue( $svc_acct->svcnum, 'insert',
478 'reply', $svc_acct->username, $svc_acct->radius_reply );
479 $self->sqlradius_queue( $svc_acct->svcnum, 'insert',
480 'check', $svc_acct->username, $svc_acct->radius_check );
483 sub _export_replace {
484 my( $self, $new, $old ) = (shift, shift, shift);
486 #return "can't (yet) change username with sqlradius"
487 # if $old->username ne $new->username;
488 if ( $old->username ne $new->username ) {
489 my $error = $self->sqlradius_queue( $new->svcnum, 'rename',
490 $new->username, $old->username );
491 return $error if $error;
494 foreach my $table (qw(reply check)) {
495 my $method = "radius_$table";
496 my %new = $new->$method;
497 my %old = $old->$method;
498 if ( grep { !exists $old{$_} #new attributes
499 || $new{$_} ne $old{$_} #changed
502 my $error = $self->sqlradius_queue( $new->svcnum, 'insert',
503 $table, $new->username, %new );
504 return $error if $error;
507 my @del = grep { !exists $new{$_} } keys %old;
508 my $error = $self->sqlradius_queue( $new->svcnum, 'sqlradius_attrib_delete',
509 $table, $new->username, @del );
510 return $error if $error;
517 my( $self, $svc_acct ) = (shift, shift);
518 $self->sqlradius_queue( $svc_acct->svcnum, 'delete',
519 $svc_acct->username );
522 sub sqlradius_queue {
523 my( $self, $svcnum, $method ) = (shift, shift, shift);
524 my $queue = new FS::queue {
526 'job' => "FS::part_export::sqlradius::sqlradius_$method",
529 $self->option('datasrc'),
530 $self->option('username'),
531 $self->option('password'),
536 sub sqlradius_insert { #subroutine, not method
537 my $dbh = sqlradius_connect(shift, shift, shift);
538 my( $replycheck, $username, %attributes ) = @_;
540 foreach my $attribute ( keys %attributes ) {
541 my $u_sth = $dbh->prepare(
542 "UPDATE rad$replycheck SET Value = ? WHERE UserName = ? AND Attribute = ?" ) or die $dbh->errstr;
543 my $i_sth = $dbh->prepare(
544 "INSERT INTO rad$replycheck ( id, UserName, Attribute, Value ) ".
545 "VALUES ( ?, ?, ?, ? )" )
547 $u_sth->execute($attributes{$attribute}, $username, $attribute) > 0
548 or $i_sth->execute( '', $username, $attribute, $attributes{$attribute} )
549 or die "can't insert into rad$replycheck table: ". $i_sth->errstr;
554 sub sqlradius_rename { #subroutine, not method
555 my $dbh = sqlradius_connect(shift, shift, shift);
556 my($new_username, $old_username) = @_;
557 foreach my $table (qw(radreply radcheck)) {
558 my $sth = $dbh->prepare("UPDATE $table SET Username = ? WHERE UserName = ?")
560 $sth->execute($new_username, $old_username)
561 or die "can't update $table: ". $sth->errstr;
566 sub sqlradius_attrib_delete { #subroutine, not method
567 my $dbh = sqlradius_connect(shift, shift, shift);
568 my( $replycheck, $username, @attrib ) = @_;
570 foreach my $attribute ( @attrib ) {
571 my $sth = $dbh->prepare(
572 "DELETE FROM rad$replycheck WHERE UserName = ? AND Attribute = ?" )
574 $sth->execute($username,$attribute)
575 or die "can't delete from rad$replycheck table: ". $sth->errstr;
580 sub sqlradius_delete { #subroutine, not method
581 my $dbh = sqlradius_connect(shift, shift, shift);
582 my $username = shift;
584 foreach my $table (qw( radcheck radreply )) {
585 my $sth = $dbh->prepare( "DELETE FROM $table WHERE UserName = ?" );
586 $sth->execute($username)
587 or die "can't delete from $table table: ". $sth->errstr;
592 sub sqlradius_connect {
593 #my($datasrc, $username, $password) = @_;
594 #DBI->connect($datasrc, $username, $password) or die $DBI::errstr;
595 DBI->connect(@_) or die $DBI::errstr;
598 =head1 NEW EXPORT CLASSES
602 package FS::part_export::myexport;
604 @ISA = qw(FS::part_export);
607 my($self, $svc_something) = (shift, shift);
608 $self->myexport_queue( $svc_acct->svcnum, 'insert',
609 $svc_something->username, $svc_something->password );
612 sub _export_replace {
613 my( $self, $new, $old ) = (shift, shift, shift);
614 #return "can't change username with myexport"
615 # if $old->username ne $new->username;
616 #return '' unless $old->_password ne $new->_password;
617 $self->myexport_queue( $new->svcnum,
618 'replace', $new->username, $new->password );
622 my( $self, $svc_something ) = (shift, shift);
623 $self->myexport_queue( $svc_acct->svcnum,
624 'delete', $svc_something->username );
627 #a good idea to queue anything that could fail or take any time
629 my( $self, $svcnum, $method ) = (shift, shift, shift);
630 my $queue = new FS::queue {
632 'job' => "FS::part_export::myexport::myexport_$method",
634 $queue->insert( @_ );
637 sub myexport_insert { #subroutine, not method
639 sub myexport_replace { #subroutine, not method
641 sub myexport_delete { #subroutine, not method
648 Hmm, export code has wound up in here. Move those sub-classes out into their
649 own files, at least. Also hmm... cust_export class (not necessarily a
650 database table...) ... ?
654 L<FS::part_export_option>, L<FS::part_svc>, L<FS::svc_acct>, L<FS::svc_domain>,
655 L<FS::svc_forward>, L<FS::Record>, schema.html from the base documentation.