1 package FS::part_export;
4 use vars qw( @ISA @EXPORT_OK $DEBUG %exports );
7 use FS::Record qw( qsearch qsearchs dbh );
10 use FS::part_export_option;
13 #for export modules, though they should probably just use it themselves
16 @ISA = qw( FS::option_Common );
17 @EXPORT_OK = qw(export_info);
23 FS::part_export - Object methods for part_export records
29 $record = new FS::part_export \%hash;
30 $record = new FS::part_export { 'column' => 'value' };
32 #($new_record, $options) = $template_recored->clone( $svcpart );
34 $error = $record->insert( { 'option' => 'value' } );
35 $error = $record->insert( \%options );
37 $error = $new_record->replace($old_record);
39 $error = $record->delete;
41 $error = $record->check;
45 An FS::part_export object represents an export of Freeside data to an external
46 provisioning system. FS::part_export inherits from FS::Record. The following
47 fields are currently supported:
51 =item exportnum - primary key
53 =item machine - Machine name
55 =item exporttype - Export type
57 =item nodomain - blank or "Y" : usernames are exported to this service with no domain
67 Creates a new export. To add the export to the database, see L<"insert">.
69 Note that this stores the hash reference, not a distinct copy of the hash it
70 points to. You can ask the object for a copy with the I<hash> method.
74 # the new method can be inherited from FS::Record, if a table method is defined
76 sub table { 'part_export'; }
82 #An alternate constructor. Creates a new export by duplicating an existing
83 #export. The given svcpart is assigned to the new export.
85 #Returns a list consisting of the new export object and a hashref of options.
91 # my $class = ref($self);
92 # my %hash = $self->hash;
93 # $hash{'exportnum'} = '';
94 # $hash{'svcpart'} = shift;
95 # ( $class->new( \%hash ),
96 # { map { $_->optionname => $_->optionvalue }
97 # qsearch('part_export_option', { 'exportnum' => $self->exportnum } )
104 Adds this record to the database. If there is an error, returns the error,
105 otherwise returns false.
107 If a hash reference of options is supplied, part_export_option records are
108 created (see L<FS::part_export_option>).
112 Delete this record from the database.
116 #foreign keys would make this much less tedious... grr dumb mysql
119 local $SIG{HUP} = 'IGNORE';
120 local $SIG{INT} = 'IGNORE';
121 local $SIG{QUIT} = 'IGNORE';
122 local $SIG{TERM} = 'IGNORE';
123 local $SIG{TSTP} = 'IGNORE';
124 local $SIG{PIPE} = 'IGNORE';
126 my $oldAutoCommit = $FS::UID::AutoCommit;
127 local $FS::UID::AutoCommit = 0;
130 my $error = $self->SUPER::delete;
132 $dbh->rollback if $oldAutoCommit;
136 foreach my $export_svc ( $self->export_svc ) {
137 my $error = $export_svc->delete;
139 $dbh->rollback if $oldAutoCommit;
144 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
152 Checks all fields to make sure this is a valid export. If there is
153 an error, returns the error, otherwise returns false. Called by the insert
161 $self->ut_numbern('exportnum')
162 || $self->ut_domain('machine')
163 || $self->ut_alpha('exporttype')
165 return $error if $error;
167 $self->nodomain =~ /^(Y?)$/ or return "Illegal nodomain: ". $self->nodomain;
170 $self->deprecated(1); #BLAH
179 #Returns the service definition (see L<FS::part_svc>) for this export.
185 # qsearchs('part_svc', { svcpart => $self->svcpart } );
190 croak "FS::part_export::part_svc deprecated";
191 #confess "FS::part_export::part_svc deprecated";
196 Returns a list of associated FS::svc_* records.
202 map { $_->svc_x } $self->cust_svc;
207 Returns a list of associated FS::cust_svc records.
213 map { qsearch('cust_svc', { 'svcpart' => $_->svcpart } ) }
214 grep { qsearch('cust_svc', { 'svcpart' => $_->svcpart } ) }
220 Returns a list of associated FS::export_svc records.
226 qsearch('export_svc', { 'exportnum' => $self->exportnum } );
229 =item part_export_option
231 Returns all options as FS::part_export_option objects (see
232 L<FS::part_export_option>).
236 sub part_export_option {
238 $self->option_objects;
243 Returns a list of option names and values suitable for assigning to a hash.
245 =item option OPTIONNAME
247 Returns the option value for the given name, or the empty string.
251 Reblesses the object into the FS::part_export::EXPORTTYPE class, where
252 EXPORTTYPE is the object's I<exporttype> field. There should be better docs
253 on how to create new exports, but until then, see L</NEW EXPORT CLASSES>.
259 my $exporttype = $self->exporttype;
260 my $class = ref($self). "::$exporttype";
263 bless($self, $class) unless $@;
267 #these should probably all go away, just let the subclasses define em
269 =item export_insert SVC_OBJECT
276 $self->_export_insert(@_);
282 # my $method = $AUTOLOAD;
283 # #$method =~ s/::(\w+)$/::_$1/; #infinite loop prevention
284 # $method =~ s/::(\w+)$/_$1/; #infinite loop prevention
285 # $self->$method(@_);
288 =item export_replace NEW OLD
295 $self->_export_replace(@_);
305 $self->_export_delete(@_);
315 $self->_export_suspend(@_);
318 =item export_unsuspend
322 sub export_unsuspend {
325 $self->_export_unsuspend(@_);
328 #fallbacks providing useful error messages intead of infinite loops
331 return "_export_insert: unknown export type ". $self->exporttype;
334 sub _export_replace {
336 return "_export_replace: unknown export type ". $self->exporttype;
341 return "_export_delete: unknown export type ". $self->exporttype;
344 #call svcdb-specific fallbacks
346 sub _export_suspend {
348 #warn "warning: _export_suspened unimplemented for". ref($self);
350 my $new = $svc_x->clone_suspended;
351 $self->_export_replace( $new, $svc_x );
354 sub _export_unsuspend {
356 #warn "warning: _export_unsuspend unimplemented for ". ref($self);
358 my $old = $svc_x->clone_kludge_unsuspend;
359 $self->_export_replace( $svc_x, $old );
362 =item export_links SVC_OBJECT ARRAYREF
364 Adds a list of web elements to ARRAYREF specific to this export and SVC_OBJECT.
365 The elements are displayed in the UI to lead the the operator to external
366 configuration, monitoring, and similar tools.
376 =item export_info [ SVCDB ]
378 Returns a hash reference of the exports for the given I<svcdb>, or if no
379 I<svcdb> is specified, for all exports. The keys of the hash are
380 I<exporttype>s and the values are again hash references containing information
383 'desc' => 'Description',
385 'option' => { label=>'Option Label' },
386 'option2' => { label=>'Another label' },
388 'nodomain' => 'Y', #or ''
389 'notes' => 'Additional notes',
395 return $exports{$_[0]} || {} if @_;
396 #{ map { %{$exports{$_}} } keys %exports };
397 my $r = { map { %{$exports{$_}} } keys %exports };
400 #=item exporttype2svcdb EXPORTTYPE
402 #Returns the applicable I<svcdb> for an I<exporttype>.
406 #sub exporttype2svcdb {
407 # my $exporttype = $_[0];
408 # foreach my $svcdb ( keys %exports ) {
409 # return $svcdb if grep { $exporttype eq $_ } keys %{$exports{$svcdb}};
414 #false laziness w/part_pkg & cdr
415 foreach my $INC ( @INC ) {
416 foreach my $file ( glob("$INC/FS/part_export/*.pm") ) {
417 warn "attempting to load export info from $file\n" if $DEBUG;
418 $file =~ /\/(\w+)\.pm$/ or do {
419 warn "unrecognized file in $INC/FS/part_export/: $file\n";
423 my $info = eval "use FS::part_export::$mod; ".
424 "\\%FS::part_export::$mod\::info;";
426 die "error using FS::part_export::$mod (skipping): $@\n" if $@;
429 unless ( keys %$info ) {
430 warn "no %info hash found in FS::part_export::$mod, skipping\n"
431 unless $mod =~ /^(passwdfile|null)$/; #hack but what the heck
434 warn "got export info from FS::part_export::$mod: $info\n" if $DEBUG;
437 ref($info->{'svc'}) ? @{$info->{'svc'}} : $info->{'svc'}
440 warn "blank svc for FS::part_export::$mod (skipping)\n";
443 $exports{$svc}->{$mod} = $info;
450 =head1 NEW EXPORT CLASSES
452 A module should be added in FS/FS/part_export/ (an example may be found in
453 eg/export_template.pm)
457 Hmm... cust_export class (not necessarily a database table...) ... ?
463 L<FS::part_export_option>, L<FS::export_svc>, L<FS::svc_acct>,
465 L<FS::svc_forward>, L<FS::Record>, schema.html from the base documentation.