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 exportname - Descriptive name
55 =item machine - Machine name
57 =item exporttype - Export type
59 =item nodomain - blank or "Y" : usernames are exported to this service with no domain
69 Creates a new export. To add the export to the database, see L<"insert">.
71 Note that this stores the hash reference, not a distinct copy of the hash it
72 points to. You can ask the object for a copy with the I<hash> method.
76 # the new method can be inherited from FS::Record, if a table method is defined
78 sub table { 'part_export'; }
84 #An alternate constructor. Creates a new export by duplicating an existing
85 #export. The given svcpart is assigned to the new export.
87 #Returns a list consisting of the new export object and a hashref of options.
93 # my $class = ref($self);
94 # my %hash = $self->hash;
95 # $hash{'exportnum'} = '';
96 # $hash{'svcpart'} = shift;
97 # ( $class->new( \%hash ),
98 # { map { $_->optionname => $_->optionvalue }
99 # qsearch('part_export_option', { 'exportnum' => $self->exportnum } )
106 Adds this record to the database. If there is an error, returns the error,
107 otherwise returns false.
109 If a hash reference of options is supplied, part_export_option records are
110 created (see L<FS::part_export_option>).
114 Delete this record from the database.
118 #foreign keys would make this much less tedious... grr dumb mysql
121 local $SIG{HUP} = 'IGNORE';
122 local $SIG{INT} = 'IGNORE';
123 local $SIG{QUIT} = 'IGNORE';
124 local $SIG{TERM} = 'IGNORE';
125 local $SIG{TSTP} = 'IGNORE';
126 local $SIG{PIPE} = 'IGNORE';
128 my $oldAutoCommit = $FS::UID::AutoCommit;
129 local $FS::UID::AutoCommit = 0;
132 my $error = $self->SUPER::delete;
134 $dbh->rollback if $oldAutoCommit;
138 foreach my $export_svc ( $self->export_svc ) {
139 my $error = $export_svc->delete;
141 $dbh->rollback if $oldAutoCommit;
146 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
154 Checks all fields to make sure this is a valid export. If there is
155 an error, returns the error, otherwise returns false. Called by the insert
163 $self->ut_numbern('exportnum')
164 || $self->ut_textn('exportname')
165 || $self->ut_domain('machine')
166 || $self->ut_alpha('exporttype')
168 return $error if $error;
170 $self->nodomain =~ /^(Y?)$/ or return "Illegal nodomain: ". $self->nodomain;
173 $self->deprecated(1); #BLAH
182 #Returns the service definition (see L<FS::part_svc>) for this export.
188 # qsearchs('part_svc', { svcpart => $self->svcpart } );
193 croak "FS::part_export::part_svc deprecated";
194 #confess "FS::part_export::part_svc deprecated";
199 Returns a list of associated FS::svc_* records.
205 map { $_->svc_x } $self->cust_svc;
210 Returns a list of associated FS::cust_svc records.
216 map { qsearch('cust_svc', { 'svcpart' => $_->svcpart } ) }
217 grep { qsearch('cust_svc', { 'svcpart' => $_->svcpart } ) }
223 Returns a list of associated FS::export_svc records.
229 qsearch('export_svc', { 'exportnum' => $self->exportnum } );
234 Returns a list of associated FS::export_device records.
240 qsearch('export_device', { 'exportnum' => $self->exportnum } );
243 =item part_export_option
245 Returns all options as FS::part_export_option objects (see
246 L<FS::part_export_option>).
250 sub part_export_option {
252 $self->option_objects;
257 Returns a list of option names and values suitable for assigning to a hash.
259 =item option OPTIONNAME
261 Returns the option value for the given name, or the empty string.
265 Reblesses the object into the FS::part_export::EXPORTTYPE class, where
266 EXPORTTYPE is the object's I<exporttype> field. There should be better docs
267 on how to create new exports, but until then, see L</NEW EXPORT CLASSES>.
273 my $exporttype = $self->exporttype;
274 my $class = ref($self). "::$exporttype";
277 bless($self, $class) unless $@;
281 #these should probably all go away, just let the subclasses define em
283 =item export_insert SVC_OBJECT
290 $self->_export_insert(@_);
296 # my $method = $AUTOLOAD;
297 # #$method =~ s/::(\w+)$/::_$1/; #infinite loop prevention
298 # $method =~ s/::(\w+)$/_$1/; #infinite loop prevention
299 # $self->$method(@_);
302 =item export_replace NEW OLD
309 $self->_export_replace(@_);
319 $self->_export_delete(@_);
329 $self->_export_suspend(@_);
332 =item export_unsuspend
336 sub export_unsuspend {
339 $self->_export_unsuspend(@_);
342 #fallbacks providing useful error messages intead of infinite loops
345 return "_export_insert: unknown export type ". $self->exporttype;
348 sub _export_replace {
350 return "_export_replace: unknown export type ". $self->exporttype;
355 return "_export_delete: unknown export type ". $self->exporttype;
358 #call svcdb-specific fallbacks
360 sub _export_suspend {
362 #warn "warning: _export_suspened unimplemented for". ref($self);
364 my $new = $svc_x->clone_suspended;
365 $self->_export_replace( $new, $svc_x );
368 sub _export_unsuspend {
370 #warn "warning: _export_unsuspend unimplemented for ". ref($self);
372 my $old = $svc_x->clone_kludge_unsuspend;
373 $self->_export_replace( $svc_x, $old );
376 =item export_links SVC_OBJECT ARRAYREF
378 Adds a list of web elements to ARRAYREF specific to this export and SVC_OBJECT.
379 The elements are displayed in the UI to lead the the operator to external
380 configuration, monitoring, and similar tools.
382 =item export_getsettings SVC_OBJECT SETTINGS_HASHREF DEFAUTS_HASHREF
384 Adds a hashref of settings to SETTINGSREF specific to this export and
385 SVC_OBJECT. The elements can be displayed in the UI on the service view.
387 DEFAULTSREF is a hashref with the same keys where true values indicate the
388 setting is a default (and thus can be displayed in the UI with less emphasis,
389 or hidden by default).
399 =item export_info [ SVCDB ]
401 Returns a hash reference of the exports for the given I<svcdb>, or if no
402 I<svcdb> is specified, for all exports. The keys of the hash are
403 I<exporttype>s and the values are again hash references containing information
406 'desc' => 'Description',
408 'option' => { label=>'Option Label' },
409 'option2' => { label=>'Another label' },
411 'nodomain' => 'Y', #or ''
412 'notes' => 'Additional notes',
418 return $exports{$_[0]} || {} if @_;
419 #{ map { %{$exports{$_}} } keys %exports };
420 my $r = { map { %{$exports{$_}} } keys %exports };
423 #=item exporttype2svcdb EXPORTTYPE
425 #Returns the applicable I<svcdb> for an I<exporttype>.
429 #sub exporttype2svcdb {
430 # my $exporttype = $_[0];
431 # foreach my $svcdb ( keys %exports ) {
432 # return $svcdb if grep { $exporttype eq $_ } keys %{$exports{$svcdb}};
437 #false laziness w/part_pkg & cdr
438 foreach my $INC ( @INC ) {
439 foreach my $file ( glob("$INC/FS/part_export/*.pm") ) {
440 warn "attempting to load export info from $file\n" if $DEBUG;
441 $file =~ /\/(\w+)\.pm$/ or do {
442 warn "unrecognized file in $INC/FS/part_export/: $file\n";
446 my $info = eval "use FS::part_export::$mod; ".
447 "\\%FS::part_export::$mod\::info;";
449 die "error using FS::part_export::$mod (skipping): $@\n" if $@;
452 unless ( keys %$info ) {
453 warn "no %info hash found in FS::part_export::$mod, skipping\n"
454 unless $mod =~ /^(passwdfile|null)$/; #hack but what the heck
457 warn "got export info from FS::part_export::$mod: $info\n" if $DEBUG;
460 ref($info->{'svc'}) ? @{$info->{'svc'}} : $info->{'svc'}
463 warn "blank svc for FS::part_export::$mod (skipping)\n";
466 $exports{$svc}->{$mod} = $info;
473 =head1 NEW EXPORT CLASSES
475 A module should be added in FS/FS/part_export/ (an example may be found in
476 eg/export_template.pm)
480 Hmm... cust_export class (not necessarily a database table...) ... ?
486 L<FS::part_export_option>, L<FS::export_svc>, L<FS::svc_acct>,
488 L<FS::svc_forward>, L<FS::Record>, schema.html from the base documentation.