FS/FS/part_export.pm

   1 package FS::part_export;
   2
   3 use strict;
   4 use vars qw( @ISA );
   5 use FS::Record qw( qsearch qsearchs dbh );
   6 use FS::part_svc;
   7 use FS::part_export_option;
   8
   9 @ISA = qw(FS::Record);
  10
  11 =head1 NAME
  12
  13 FS::part_export - Object methods for part_export records
  14
  15 =head1 SYNOPSIS
  16
  17   use FS::part_export;
  18
  19   $record = new FS::part_export \%hash;
  20   $record = new FS::part_export { 'column' => 'value' };
  21
  22   ($new_record, $options) = $template_recored->clone( $svcpart );
  23
  24   $error = $record->insert( { 'option' => 'value' } );
  25   $error = $record->insert( \%options );
  26
  27   $error = $new_record->replace($old_record);
  28
  29   $error = $record->delete;
  30
  31   $error = $record->check;
  32
  33 =head1 DESCRIPTION
  34
  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:
  38
  39 =over 4
  40
  41 =item exportnum - primary key
  42
  43 =item svcpart - Service definition (see L<FS::part_svc>) to which this export applies
  44
  45 =item machine - Machine name
  46
  47 =item exporttype - Export type
  48
  49 =item nodomain - blank or "Y" : usernames are exported to this service with no domain
  50
  51 =back
  52
  53 =head1 METHODS
  54
  55 =over 4
  56
  57 =item new HASHREF
  58
  59 Creates a new export.  To add the export to the database, see L<"insert">.
  60
  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.
  63
  64 =cut
  65
  66 # the new method can be inherited from FS::Record, if a table method is defined
  67
  68 sub table { 'part_export'; }
  69
  70 =item clone SVCPART
  71
  72 An alternate constructor.  Creates a new export by duplicating an existing
  73 export.  The given svcpart is assigned to the new export.
  74
  75 Returns a list consisting of the new export object and a hashref of options.
  76
  77 =cut
  78
  79 sub clone {
  80   my $self = shift;
  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 } )
  88     }
  89   );
  90 }
  91
  92 =item insert HASHREF
  93
  94 Adds this record to the database.  If there is an error, returns the error,
  95 otherwise returns false.
  96
  97 If a hash reference of options is supplied, part_export_option records are
  98 created (see L<FS::part_export_option>).
  99
 100 =cut
 101
 102 #false laziness w/queue.pm
 103 sub insert {
 104   my $self = shift;
 105   my $options = shift;
 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';
 112
 113   my $oldAutoCommit = $FS::UID::AutoCommit;
 114   local $FS::UID::AutoCommit = 0;
 115   my $dbh = dbh;
 116
 117   my $error = $self->SUPER::insert;
 118   if ( $error ) {
 119     $dbh->rollback if $oldAutoCommit;
 120     return $error;
 121   }
 122
 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},
 128     } );
 129     $error = $part_export_option->insert;
 130     if ( $error ) {
 131       $dbh->rollback if $oldAutoCommit;
 132       return $error;
 133     }
 134   }
 135
 136   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 137
 138   '';
 139
 140 };
 141
 142 =item delete
 143
 144 Delete this record from the database.
 145
 146 =cut
 147
 148 #foreign keys would make this much less tedious... grr dumb mysql
 149 sub delete {
 150   my $self = shift;
 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';
 157
 158   my $oldAutoCommit = $FS::UID::AutoCommit;
 159   local $FS::UID::AutoCommit = 0;
 160   my $dbh = dbh;
 161
 162   my $error = $self->SUPER::delete;
 163   if ( $error ) {
 164     $dbh->rollback if $oldAutoCommit;
 165     return $error;
 166   }
 167
 168   foreach my $part_export_option ( $self->part_export_option ) {
 169     my $error = $part_export_option->delete;
 170     if ( $error ) {
 171       $dbh->rollback if $oldAutoCommit;
 172       return $error;
 173     }
 174   }
 175
 176   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 177
 178   '';
 179
 180 }
 181
 182 =item replace OLD_RECORD HASHREF
 183
 184 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 185 returns the error, otherwise returns false.
 186
 187 If a hash reference of options is supplied, part_export_option records are
 188 created or modified (see L<FS::part_export_option>).
 189
 190 =cut
 191
 192 sub replace {
 193   my $self = shift;
 194   my $old = shift;
 195   my $options = shift;
 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';
 202
 203   my $oldAutoCommit = $FS::UID::AutoCommit;
 204   local $FS::UID::AutoCommit = 0;
 205   my $dbh = dbh;
 206
 207   my $error = $self->SUPER::replace($old);
 208   if ( $error ) {
 209     $dbh->rollback if $oldAutoCommit;
 210     return $error;
 211   }
 212
 213   foreach my $optionname ( keys %{$options} ) {
 214     my $old = qsearchs( 'part_export_option', {
 215         'exportnum'   => $self->exportnum,
 216         'optionname'  => $optionname,
 217     } );
 218     my $new = new FS::part_export_option ( {
 219         'exportnum'   => $self->exportnum,
 220         'optionname'  => $optionname,
 221         'optionvalue' => $options->{$optionname},
 222     } );
 223     $new->optionnum($old->optionnum) if $old;
 224     my $error = $old ? $new->replace($old) : $new->insert;
 225     if ( $error ) {
 226       $dbh->rollback if $oldAutoCommit;
 227       return $error;
 228     }
 229   }
 230
 231   #remove extraneous old options
 232   foreach my $opt (
 233     grep { !exists $options->{$_->optionname} } $old->part_export_option
 234   ) {
 235     my $error = $opt->delete;
 236     if ( $error ) {
 237       $dbh->rollback if $oldAutoCommit;
 238       return $error;
 239     }
 240   }
 241
 242   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 243
 244   '';
 245
 246 };
 247
 248 =item check
 249
 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
 252 and replace methods.
 253
 254 =cut
 255
 256 sub check {
 257   my $self = shift;
 258   my $error =
 259     $self->ut_numbern('exportnum')
 260     || $self->ut_domain('machine')
 261     || $self->ut_number('svcpart')
 262     || $self->ut_alpha('exporttype')
 263   ;
 264   return $error if $error;
 265
 266   return "Unknown svcpart: ". $self->svcpart
 267     unless qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
 268
 269   $self->machine =~ /^([\w\-\.]*)$/
 270     or return "Illegal machine: ". $self->machine;
 271   $self->machine($1);
 272
 273   $self->nodomain =~ /^(Y?)$/ or return "Illegal nodomain: ". $self->nodomain;
 274   $self->nodomain($1);
 275
 276   #check exporttype?
 277
 278   ''; #no error
 279 }
 280
 281 =item part_svc
 282
 283 Returns the service definition (see L<FS::part_svc>) for this export.
 284
 285 =cut
 286
 287 sub part_svc {
 288   my $self = shift;
 289   qsearchs('part_svc', { svcpart => $self->svcpart } );
 290 }
 291
 292 =item part_export_option
 293
 294 Returns all options as FS::part_export_option objects (see
 295 L<FS::part_export_option>).
 296
 297 =cut
 298
 299 sub part_export_option {
 300   my $self = shift;
 301   qsearch('part_export_option', { 'exportnum' => $self->exportnum } );
 302 }
 303
 304 =item options
 305
 306 Returns a list of option names and values suitable for assigning to a hash.
 307
 308 =cut
 309
 310 sub options {
 311   my $self = shift;
 312   map { $_->optionname => $_->optionvalue } $self->part_export_option;
 313 }
 314
 315 =item option OPTIONNAME
 316
 317 Returns the option value for the given name, or the empty string.
 318
 319 =cut
 320
 321 sub option {
 322   my $self = shift;
 323   my $part_export_option =
 324     qsearchs('part_export_option', {
 325       exportnum  => $self->exportnum,
 326       optionname => shift,
 327   } );
 328   $part_export_option ? $part_export_option->optionvalue : '';
 329 }
 330
 331 =item rebless
 332
 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>.
 337
 338 =cut
 339
 340 sub rebless {
 341   my $self = shift;
 342   my $exporttype = $self->exporttype;
 343   my $class = ref($self). "::$exporttype";
 344   eval "use $class;";
 345   bless($self, $class);
 346 }
 347
 348 =item export_insert SVC_OBJECT
 349
 350 =cut
 351
 352 sub export_insert {
 353   my $self = shift;
 354   $self->rebless;
 355   $self->_export_insert(@_);
 356 }
 357
 358 #sub AUTOLOAD {
 359 #  my $self = shift;
 360 #  $self->rebless;
 361 #  my $method = $AUTOLOAD;
 362 #  #$method =~ s/::(\w+)$/::_$1/; #infinite loop prevention
 363 #  $method =~ s/::(\w+)$/_$1/; #infinite loop prevention
 364 #  $self->$method(@_);
 365 #}
 366
 367 =item export_replace NEW OLD
 368
 369 =cut
 370
 371 sub export_replace {
 372   my $self = shift;
 373   $self->rebless;
 374   $self->_export_replace(@_);
 375 }
 376
 377 =item export_delete
 378
 379 =cut
 380
 381 sub export_delete {
 382   my $self = shift;
 383   $self->rebless;
 384   $self->_export_delete(@_);
 385 }
 386
 387 #fallbacks providing useful error messages intead of infinite loops
 388 sub _export_insert {
 389   my $self = shift;
 390   return "_export_insert: unknown export type ". $self->exporttype;
 391 }
 392
 393 sub _export_replace {
 394   my $self = shift;
 395   return "_export_replace: unknown export type ". $self->exporttype;
 396 }
 397
 398 sub _export_delete {
 399   my $self = shift;
 400   return "_export_delete: unknown export type ". $self->exporttype;
 401 }
 402
 403 =back
 404
 405 =head1 NEW EXPORT CLASSES
 406
 407 Should be added to httemplate/edit/part_export.cgi and a module should
 408 be FS/FS/part_export/ (an example may be found in eg/export_template.pm)
 409
 410 =head1 BUGS
 411
 412 Probably.
 413
 414 Hmm... cust_export class (not necessarily a database table...) ... ?
 415
 416 =head1 SEE ALSO
 417
 418 L<FS::part_export_option>, L<FS::part_svc>, L<FS::svc_acct>, L<FS::svc_domain>,
 419 L<FS::svc_forward>, L<FS::Record>, schema.html from the base documentation.
 420
 421 =cut
 422
 423 1;
 424