1 package FS::svc_Common;
2 use base qw( FS::cust_main_Mixin FS::Record );
5 use vars qw( $noexport_hack $DEBUG $me
6 $overlimit_missing_cust_svc_nonfatal_kludge );
7 use Carp qw( cluck carp croak confess ); #specify cluck have to specify them all
8 use Scalar::Util qw( blessed );
9 use Lingua::EN::Inflect qw( PL_N );
11 use FS::Record qw( qsearch qsearchs fields dbh );
16 use FS::inventory_item;
17 use FS::inventory_class;
18 use FS::NetworkMonitoringSystem;
20 $me = '[FS::svc_Common]';
23 $overlimit_missing_cust_svc_nonfatal_kludge = 0;
27 FS::svc_Common - Object method for all svc_ records
31 package svc_myservice;
32 use base qw( FS::svc_Common );
36 FS::svc_Common is intended as a base class for table-specific classes to
37 inherit from, i.e. FS::svc_acct. FS::svc_Common inherits from FS::Record.
49 my $class = ref($proto) || $proto;
51 bless ($self, $class);
53 unless ( defined ( $self->table ) ) {
54 $self->{'Table'} = shift;
55 carp "warning: FS::Record::new called with table name ". $self->{'Table'};
58 #$self->{'Hash'} = shift;
60 $self->{'Hash'} = { map { $_ => $newhash->{$_} } qw(svcnum svcpart) };
62 $self->setdefault( $self->_fieldhandlers )
65 $self->{'Hash'}{$_} = $newhash->{$_}
66 foreach grep { defined($newhash->{$_}) && length($newhash->{$_}) }
69 foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) {
70 $self->{'Hash'}{$field}='';
73 $self->_rebless if $self->can('_rebless');
75 $self->{'modified'} = 0;
77 $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
83 sub _fieldhandlers { {}; }
87 # This restricts the fields based on part_svc_column and the svcpart of
88 # the service. There are four possible cases:
89 # 1. svcpart passed as part of the svc_x hash.
90 # 2. svcpart fetched via cust_svc based on svcnum.
91 # 3. No svcnum or svcpart. In this case, return ALL the fields with
92 # dbtable eq $self->table.
93 # 4. Called via "fields('svc_acct')" or something similar. In this case
94 # there is no $self object.
98 my @vfields = $self->SUPER::virtual_fields;
100 return @vfields unless (ref $self); # Case 4
102 if ($self->svcpart) { # Case 1
103 $svcpart = $self->svcpart;
104 } elsif ( $self->svcnum
105 && qsearchs('cust_svc',{'svcnum'=>$self->svcnum} )
107 $svcpart = $self->cust_svc->svcpart;
112 if ($svcpart) { #Cases 1 and 2
113 my %flags = map { $_->columnname, $_->columnflag } (
114 qsearch ('part_svc_column', { svcpart => $svcpart } )
116 return grep { not ( defined($flags{$_}) && $flags{$_} eq 'X') } @vfields;
125 Returns a label to identify a record of this service.
126 Label may be displayed on freeside screens, and within customer bills.
128 For example, $obj->label may return:
130 - A provisioned phone number for svc_phone
131 - The mailing list name and e-mail address for svc_mailinglist
132 - The address of a rental property svc_realestate
134 svc_Common provides a fallback label subroutine that just returns the svcnum.
140 cluck "warning: ". ref($self). " not loaded or missing label method; ".
152 (($self->cust_svc || return)->cust_pkg || return)->cust_main || return
157 defined($self->cust_main);
162 Checks the validity of fields in this record.
164 Only checks fields marked as required in table_info or
165 part_svc_column definition. Should be invoked by service-specific
166 check using SUPER. Invokes FS::Record::check using SUPER.
173 ## Checking required fields
175 # get fields marked as required in table_info
178 my $tinfo = $self->can('table_info') ? $self->table_info : {};
179 if ($tinfo->{'manual_require'}) {
180 my $fields = $tinfo->{'fields'} || {};
181 foreach my $field (keys %$fields) {
182 if (ref($fields->{$field}) && $fields->{$field}->{'required'}) {
183 $required->{$field} = 1;
184 $labels->{$field} = $fields->{$field}->{'label'};
187 # add fields marked as required in database
189 qsearch('part_svc_column',{
190 'svcpart' => $self->svcpart,
194 $required->{$column->columnname} = 1;
195 $labels->{$column->columnname} = $column->columnlabel;
197 # do the actual checking
198 foreach my $field (keys %$required) {
199 unless (length($self->get($field)) > 0) {
200 my $name = $labels->{$field} || $field;
201 return "$name is required\n"
209 =item insert [ , OPTION => VALUE ... ]
211 Adds this record to the database. If there is an error, returns the error,
212 otherwise returns false.
214 The additional fields pkgnum and svcpart (see L<FS::cust_svc>) should be
215 defined. An FS::cust_svc record will be created and inserted.
217 Currently available options are: I<jobnums>, I<child_objects> and
220 If I<jobnum> is set to an array reference, the jobnums of any export jobs will
221 be added to the referenced array.
223 If I<child_objects> is set to an array reference of FS::tablename objects
224 (for example, FS::svc_export_machine or FS::acct_snarf objects), they
225 will have their svcnum field set and will be inserted after this record,
226 but before any exports are run. Each element of the array can also
227 optionally be a two-element array reference containing the child object
228 and the name of an alternate field to be filled in with the newly-inserted
229 svcnum, for example C<[ $svc_forward, 'srcsvc' ]>
231 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
232 jobnums), all provisioning jobs will have a dependancy on the supplied
233 jobnum(s) (they will not run until the specific job(s) complete(s)).
235 If I<export_args> is set to an array reference, the referenced list will be
236 passed to export commands.
243 warn "[$me] insert called with options ".
244 join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
248 local $FS::queue::jobnums = \@jobnums;
249 warn "[$me] insert: set \$FS::queue::jobnums to $FS::queue::jobnums\n"
251 my $objects = $options{'child_objects'} || [];
252 my $depend_jobnums = $options{'depend_jobnum'} || [];
253 $depend_jobnums = [ $depend_jobnums ] unless ref($depend_jobnums);
255 local $SIG{HUP} = 'IGNORE';
256 local $SIG{INT} = 'IGNORE';
257 local $SIG{QUIT} = 'IGNORE';
258 local $SIG{TERM} = 'IGNORE';
259 local $SIG{TSTP} = 'IGNORE';
260 local $SIG{PIPE} = 'IGNORE';
262 my $oldAutoCommit = $FS::UID::AutoCommit;
263 local $FS::UID::AutoCommit = 0;
266 my $svcnum = $self->svcnum;
267 my $cust_svc = $svcnum ? qsearchs('cust_svc',{'svcnum'=>$self->svcnum}) : '';
268 my $inserted_cust_svc = 0;
269 #unless ( $svcnum ) {
270 if ( !$svcnum or !$cust_svc ) {
271 $cust_svc = new FS::cust_svc ( {
272 #hua?# 'svcnum' => $svcnum,
273 'svcnum' => $self->svcnum,
274 'pkgnum' => $self->pkgnum,
275 'svcpart' => $self->svcpart,
277 my $error = $cust_svc->insert;
279 $dbh->rollback if $oldAutoCommit;
282 $inserted_cust_svc = 1;
283 $svcnum = $self->svcnum($cust_svc->svcnum);
285 #$cust_svc = qsearchs('cust_svc',{'svcnum'=>$self->svcnum});
286 unless ( $cust_svc ) {
287 $dbh->rollback if $oldAutoCommit;
288 return "no cust_svc record found for svcnum ". $self->svcnum;
290 $self->pkgnum($cust_svc->pkgnum);
291 $self->svcpart($cust_svc->svcpart);
294 my $error = $self->preinsert_hook_first(%options)
295 || $self->set_auto_inventory
297 || $self->_check_duplicate
298 || $self->preinsert_hook
299 || $self->SUPER::insert;
301 if ( $inserted_cust_svc ) {
302 my $derror = $cust_svc->delete;
303 die $derror if $derror;
305 $dbh->rollback if $oldAutoCommit;
309 foreach my $object ( @$objects ) {
311 if ( ref($object) eq 'ARRAY' ) {
312 ($obj, $field) = @$object;
317 $obj->$field($self->svcnum);
318 $error = $obj->insert;
320 $dbh->rollback if $oldAutoCommit;
326 unless ( $noexport_hack ) {
328 warn "[$me] insert: \$FS::queue::jobnums is $FS::queue::jobnums\n"
331 my $export_args = $options{'export_args'} || [];
333 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
334 my $error = $part_export->export_insert($self, @$export_args);
336 $dbh->rollback if $oldAutoCommit;
337 return "exporting to ". $part_export->exporttype.
338 " (transaction rolled back): $error";
342 foreach my $depend_jobnum ( @$depend_jobnums ) {
343 warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
345 foreach my $jobnum ( @jobnums ) {
346 my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
347 warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
349 my $error = $queue->depend_insert($depend_jobnum);
351 $dbh->rollback if $oldAutoCommit;
352 return "error queuing job dependancy: $error";
359 my $nms_ip_error = $self->nms_ip_insert;
360 if ( $nms_ip_error ) {
361 $dbh->rollback if $oldAutoCommit;
362 return "error queuing IP insert: $nms_ip_error";
365 if ( exists $options{'jobnums'} ) {
366 push @{ $options{'jobnums'} }, @jobnums;
369 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
375 sub preinsert_hook_first { ''; }
376 sub _check_duplcate { ''; }
377 sub preinsert_hook { ''; }
378 sub table_dupcheck_fields { (); }
379 sub prereplace_hook { ''; }
380 sub prereplace_hook_first { ''; }
381 sub predelete_hook { ''; }
382 sub predelete_hook_first { ''; }
384 =item delete [ , OPTION => VALUE ... ]
386 Deletes this account from the database. If there is an error, returns the
387 error, otherwise returns false.
389 The corresponding FS::cust_svc record will be deleted as well.
396 my $export_args = $options{'export_args'} || [];
398 local $SIG{HUP} = 'IGNORE';
399 local $SIG{INT} = 'IGNORE';
400 local $SIG{QUIT} = 'IGNORE';
401 local $SIG{TERM} = 'IGNORE';
402 local $SIG{TSTP} = 'IGNORE';
403 local $SIG{PIPE} = 'IGNORE';
405 my $oldAutoCommit = $FS::UID::AutoCommit;
406 local $FS::UID::AutoCommit = 0;
409 my $error = $self->cust_svc->check_part_svc_link_unprovision
410 || $self->predelete_hook_first
411 || $self->SUPER::delete
412 || $self->export('delete', @$export_args)
413 || $self->return_inventory
414 || $self->release_router
415 || $self->predelete_hook
416 || $self->cust_svc->delete
419 $dbh->rollback if $oldAutoCommit;
423 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
430 Currently this will only run expire exports if any are attached
435 my($self,$date) = (shift,shift);
437 return 'Expire date must be specified' unless $date;
439 local $SIG{HUP} = 'IGNORE';
440 local $SIG{INT} = 'IGNORE';
441 local $SIG{QUIT} = 'IGNORE';
442 local $SIG{TERM} = 'IGNORE';
443 local $SIG{TSTP} = 'IGNORE';
444 local $SIG{PIPE} = 'IGNORE';
446 my $oldAutoCommit = $FS::UID::AutoCommit;
447 local $FS::UID::AutoCommit = 0;
450 my $export_args = [$date];
451 my $error = $self->export('expire', @$export_args);
453 $dbh->rollback if $oldAutoCommit;
457 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
462 =item replace [ OLD_RECORD ] [ HASHREF | OPTION => VALUE ]
464 Replaces OLD_RECORD with this one. If there is an error, returns the error,
465 otherwise returns false.
467 Currently available options are: I<child_objects>, I<export_args> and
470 If I<child_objects> is set to an array reference of FS::tablename objects
471 (for example, FS::svc_export_machine or FS::acct_snarf objects), they
472 will have their svcnum field set and will be inserted or replaced after
473 this record, but before any exports are run. Each element of the array
474 can also optionally be a two-element array reference containing the
475 child object and the name of an alternate field to be filled in with
476 the newly-inserted svcnum, for example C<[ $svc_forward, 'srcsvc' ]>
478 If I<depend_jobnum> is set (to a scalar jobnum or an array reference of
479 jobnums), all provisioning jobs will have a dependancy on the supplied
480 jobnum(s) (they will not run until the specific job(s) complete(s)).
482 If I<export_args> is set to an array reference, the referenced list will be
483 passed to export commands.
490 my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
495 ( ref($_[0]) eq 'HASH' )
499 my $objects = $options->{'child_objects'} || [];
502 local $FS::queue::jobnums = \@jobnums;
503 warn "[$me] replace: set \$FS::queue::jobnums to $FS::queue::jobnums\n"
505 my $depend_jobnums = $options->{'depend_jobnum'} || [];
506 $depend_jobnums = [ $depend_jobnums ] unless ref($depend_jobnums);
508 local $SIG{HUP} = 'IGNORE';
509 local $SIG{INT} = 'IGNORE';
510 local $SIG{QUIT} = 'IGNORE';
511 local $SIG{TERM} = 'IGNORE';
512 local $SIG{TSTP} = 'IGNORE';
513 local $SIG{PIPE} = 'IGNORE';
515 my $oldAutoCommit = $FS::UID::AutoCommit;
516 local $FS::UID::AutoCommit = 0;
519 my $error = $new->prereplace_hook_first($old)
520 || $new->set_auto_inventory($old)
521 || $new->check; #redundant, but so any duplicate fields are
522 #maniuplated as appropriate (svc_phone.phonenum)
524 $dbh->rollback if $oldAutoCommit;
528 #if ( $old->username ne $new->username || $old->domsvc != $new->domsvc ) {
529 if ( grep { $old->$_ ne $new->$_ } $new->table_dupcheck_fields ) {
531 $new->svcpart( $new->cust_svc->svcpart ) unless $new->svcpart;
532 $error = $new->_check_duplicate;
534 $dbh->rollback if $oldAutoCommit;
539 $error = $new->SUPER::replace($old);
541 $dbh->rollback if $oldAutoCommit;
545 foreach my $object ( @$objects ) {
547 if ( ref($object) eq 'ARRAY' ) {
548 ($obj, $field) = @$object;
553 $obj->$field($new->svcnum);
555 my $oldobj = qsearchs( $obj->table, {
556 $field => $new->svcnum,
557 map { $_ => $obj->$_ } $obj->_svc_child_partfields,
561 my $pkey = $oldobj->primary_key;
562 $obj->$pkey($oldobj->$pkey);
563 $obj->replace($oldobj);
565 $error = $obj->insert;
568 $dbh->rollback if $oldAutoCommit;
574 unless ( $noexport_hack ) {
576 warn "[$me] replace: \$FS::queue::jobnums is $FS::queue::jobnums\n"
579 my $export_args = $options->{'export_args'} || [];
581 #not quite false laziness, but same pattern as FS::svc_acct::replace and
582 #FS::part_export::sqlradius::_export_replace. List::Compare or something
583 #would be useful but too much of a pain in the ass to deploy
585 my @old_part_export = $old->cust_svc->part_svc->part_export;
586 my %old_exportnum = map { $_->exportnum => 1 } @old_part_export;
587 my @new_part_export =
589 ? qsearchs('part_svc', { svcpart=>$new->svcpart } )->part_export
590 : $new->cust_svc->part_svc->part_export;
591 my %new_exportnum = map { $_->exportnum => 1 } @new_part_export;
593 foreach my $delete_part_export (
594 grep { ! $new_exportnum{$_->exportnum} } @old_part_export
596 my $error = $delete_part_export->export_delete($old, @$export_args);
598 $dbh->rollback if $oldAutoCommit;
599 return "error deleting, export to ". $delete_part_export->exporttype.
600 " (transaction rolled back): $error";
604 foreach my $replace_part_export (
605 grep { $old_exportnum{$_->exportnum} } @new_part_export
608 $replace_part_export->export_replace( $new, $old, @$export_args);
610 $dbh->rollback if $oldAutoCommit;
611 return "error exporting to ". $replace_part_export->exporttype.
612 " (transaction rolled back): $error";
616 foreach my $insert_part_export (
617 grep { ! $old_exportnum{$_->exportnum} } @new_part_export
619 my $error = $insert_part_export->export_insert($new, @$export_args );
621 $dbh->rollback if $oldAutoCommit;
622 return "error inserting export to ". $insert_part_export->exporttype.
623 " (transaction rolled back): $error";
627 foreach my $depend_jobnum ( @$depend_jobnums ) {
628 warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
630 foreach my $jobnum ( @jobnums ) {
631 my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
632 warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
634 my $error = $queue->depend_insert($depend_jobnum);
636 $dbh->rollback if $oldAutoCommit;
637 return "error queuing job dependancy: $error";
644 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
650 Sets any fixed fields for this service (see L<FS::part_svc>). If there is an
651 error, returns the error, otherwise returns the FS::part_svc object (use ref()
652 to test the return). Usually called by the check method.
658 $self->setx('F', @_);
663 Sets all fields to their defaults (see L<FS::part_svc>), overriding their
664 current values. If there is an error, returns the error, otherwise returns
665 the FS::part_svc object (use ref() to test the return).
671 $self->setx('D', @_ );
674 =item set_default_and_fixed
678 sub set_default_and_fixed {
680 $self->setx( [ 'D', 'F' ], @_ );
683 =item setx FLAG | FLAG_ARRAYREF , [ CALLBACK_HASHREF ]
685 Sets fields according to the passed in flag or arrayref of flags.
687 Optionally, a hashref of field names and callback coderefs can be passed.
688 If a coderef exists for a given field name, instead of setting the field,
689 the coderef is called with the column value (part_svc_column.columnvalue)
690 as the single parameter.
697 my @x = ref($x) ? @$x : ($x);
698 my $coderef = scalar(@_) ? shift : $self->_fieldhandlers;
701 $self->ut_numbern('svcnum')
703 return $error if $error;
705 my $part_svc = $self->part_svc;
706 return "Unknown svcpart" unless $part_svc;
708 #set default/fixed/whatever fields from part_svc
710 foreach my $part_svc_column (
711 grep { my $f = $_->columnflag; grep { $f eq $_ } @x } #columnflag in @x
712 $part_svc->all_part_svc_column
715 my $columnname = $part_svc_column->columnname;
716 my $columnvalue = $part_svc_column->columnvalue;
718 $columnvalue = &{ $coderef->{$columnname} }( $self, $columnvalue )
719 if exists( $coderef->{$columnname} );
720 $self->setfield( $columnname, $columnvalue );
731 cluck 'svc_X->part_svc called' if $DEBUG;
735 if ( $self->get('svcpart') ) {
736 $svcpart = $self->get('svcpart');
737 } elsif ( $self->svcnum && qsearchs('cust_svc', {'svcnum'=>$self->svcnum}) ) {
738 my $cust_svc = $self->cust_svc;
739 return "Unknown svcnum" unless $cust_svc;
740 $svcpart = $cust_svc->svcpart;
743 qsearchs( 'part_svc', { 'svcpart' => $svcpart } );
749 Returns the FS::svc_pbx record for this service, if any (see L<FS::svc_pbx>).
751 Only makes sense if the service has a pbxsvc field (currently, svc_phone and
756 # XXX FS::h_svc_{acct,phone} could have a history-aware svc_pbx override
760 return '' unless $self->pbxsvc;
761 qsearchs( 'svc_pbx', { 'svcnum' => $self->pbxsvc } );
766 Returns the title of the FS::svc_pbx record associated with this service, if
769 Only makes sense if the service has a pbxsvc field (currently, svc_phone and
776 my $svc_pbx = $self->svc_pbx or return '';
780 =item pbx_select_hash %OPTIONS
782 Can be called as an object method or a class method.
784 Returns a hash SVCNUM => TITLE ... representing the PBXes this customer
785 that may be associated with this service.
787 Currently available options are: I<pkgnum> I<svcpart>
789 Only makes sense if the service has a pbxsvc field (currently, svc_phone and
794 #false laziness w/svc_acct::domain_select_hash
795 sub pbx_select_hash {
796 my ($self, %options) = @_;
802 $part_svc = $self->part_svc;
803 $cust_pkg = $self->cust_svc->cust_pkg
807 $part_svc = qsearchs('part_svc', { 'svcpart' => $options{svcpart} })
808 if $options{'svcpart'};
810 $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $options{pkgnum} })
811 if $options{'pkgnum'};
813 if ($part_svc && ( $part_svc->part_svc_column('pbxsvc')->columnflag eq 'S'
814 || $part_svc->part_svc_column('pbxsvc')->columnflag eq 'F')) {
815 %pbxes = map { $_->svcnum => $_->title }
816 map { qsearchs('svc_pbx', { 'svcnum' => $_ }) }
817 split(',', $part_svc->part_svc_column('pbxsvc')->columnvalue);
818 } elsif ($cust_pkg) { # && !$conf->exists('svc_acct-alldomains') ) {
819 %pbxes = map { $_->svcnum => $_->title }
820 map { qsearchs('svc_pbx', { 'svcnum' => $_->svcnum }) }
821 map { qsearch('cust_svc', { 'pkgnum' => $_->pkgnum } ) }
822 qsearch('cust_pkg', { 'custnum' => $cust_pkg->custnum });
825 %pbxes = map { $_->svcnum => $_->title } qsearch('svc_pbx', {} );
828 if ($part_svc && $part_svc->part_svc_column('pbxsvc')->columnflag eq 'D') {
829 my $svc_pbx = qsearchs('svc_pbx',
830 { 'svcnum' => $part_svc->part_svc_column('pbxsvc')->columnvalue } );
832 $pbxes{$svc_pbx->svcnum} = $svc_pbx->title;
834 warn "unknown svc_pbx.svcnum for part_svc_column pbxsvc: ".
835 $part_svc->part_svc_column('pbxsvc')->columnvalue;
844 =item set_auto_inventory
846 Sets any fields which auto-populate from inventory (see L<FS::part_svc>), and
847 also check any manually populated inventory fields.
849 If there is an error, returns the error, otherwise returns false.
853 sub set_auto_inventory {
854 # don't try to do this during an upgrade
855 return '' if $FS::CurrentUser::upgrade_hack;
858 my $old = @_ ? shift : '';
861 $self->ut_numbern('svcnum')
863 return $error if $error;
865 my $part_svc = $self->part_svc;
866 return "Unkonwn svcpart" unless $part_svc;
868 local $SIG{HUP} = 'IGNORE';
869 local $SIG{INT} = 'IGNORE';
870 local $SIG{QUIT} = 'IGNORE';
871 local $SIG{TERM} = 'IGNORE';
872 local $SIG{TSTP} = 'IGNORE';
873 local $SIG{PIPE} = 'IGNORE';
875 my $oldAutoCommit = $FS::UID::AutoCommit;
876 local $FS::UID::AutoCommit = 0;
879 #set default/fixed/whatever fields from part_svc
880 my $table = $self->table;
881 foreach my $field ( grep { $_ ne 'svcnum' } $self->fields ) {
883 my $part_svc_column = $part_svc->part_svc_column($field);
884 my $columnflag = $part_svc_column->columnflag;
885 next unless $columnflag =~ /^[AM]$/;
887 next if $columnflag eq 'A' && $self->$field() ne '';
889 my $classnum = $part_svc_column->columnvalue;
892 if ( $columnflag eq 'A' && $self->$field() eq '' ) {
893 $hash{'svcnum'} = '';
894 } elsif ( $columnflag eq 'M' ) {
895 return "Select inventory item for $field" unless $self->getfield($field);
896 $hash{'item'} = $self->getfield($field);
897 my $chosen_classnum = $self->getfield($field.'_classnum');
898 if ( grep {$_ == $chosen_classnum} split(',', $classnum) ) {
899 $classnum = $chosen_classnum;
901 # otherwise the chosen classnum is either (all), or somehow not on
902 # the list, so ignore it and choose the first item that's in any
906 my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql(
908 'table' => 'inventory_item',
911 my $inventory_item = qsearchs({
912 'table' => 'inventory_item',
914 'extra_sql' => "AND classnum IN ($classnum) AND $agentnums_sql",
915 'order_by' => 'ORDER BY ( agentnum IS NULL ) '. #agent inventory first
916 ' LIMIT 1 FOR UPDATE',
919 unless ( $inventory_item ) {
920 # should really only be shown if columnflag eq 'A'...
921 $dbh->rollback if $oldAutoCommit;
922 my $message = 'Out of ';
923 my @classnums = split(',', $classnum);
924 foreach ( @classnums ) {
925 my $class = FS::inventory_class->by_key($_)
926 or return "Can't find inventory_class.classnum $_";
927 $message .= PL_N($class->classname);
928 if ( scalar(@classnums) > 2 ) { # english is hard
929 if ( $_ != $classnums[-1] ) {
933 if ( scalar(@classnums) > 1 and $_ == $classnums[-2] ) {
940 next if $columnflag eq 'M' && $inventory_item->svcnum == $self->svcnum;
942 $self->setfield( $field, $inventory_item->item );
943 #if $columnflag eq 'A' && $self->$field() eq '';
945 # release the old inventory item, if there was one
946 if ( $old && $old->$field() && $old->$field() ne $self->$field() ) {
947 my $old_inv = qsearchs({
948 'table' => 'inventory_item',
950 'svcnum' => $old->svcnum,
952 'extra_sql' => "AND classnum IN ($classnum) AND ".
953 '( ( svc_field IS NOT NULL AND svc_field = '.$dbh->quote($field).' )'.
954 ' OR ( svc_field IS NULL AND item = '. dbh->quote($old->$field).' )'.
958 $old_inv->svcnum('');
959 $old_inv->svc_field('');
960 my $oerror = $old_inv->replace;
962 $dbh->rollback if $oldAutoCommit;
963 return "Error unprovisioning inventory: $oerror";
966 warn "old inventory_item not found for $field ". $self->$field;
970 $inventory_item->svcnum( $self->svcnum );
971 $inventory_item->svc_field( $field );
972 my $ierror = $inventory_item->replace();
974 $dbh->rollback if $oldAutoCommit;
975 return "Error provisioning inventory: $ierror";
980 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
986 =item return_inventory
988 Release all inventory items attached to this service's fields. Call
989 when unprovisioning the service.
993 sub return_inventory {
996 local $SIG{HUP} = 'IGNORE';
997 local $SIG{INT} = 'IGNORE';
998 local $SIG{QUIT} = 'IGNORE';
999 local $SIG{TERM} = 'IGNORE';
1000 local $SIG{TSTP} = 'IGNORE';
1001 local $SIG{PIPE} = 'IGNORE';
1003 my $oldAutoCommit = $FS::UID::AutoCommit;
1004 local $FS::UID::AutoCommit = 0;
1007 foreach my $inventory_item ( $self->inventory_item ) {
1008 $inventory_item->svcnum('');
1009 $inventory_item->svc_field('');
1010 my $error = $inventory_item->replace();
1012 $dbh->rollback if $oldAutoCommit;
1013 return "Error returning inventory: $error";
1017 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1022 =item inventory_item
1024 Returns the inventory items associated with this svc_ record, as
1025 FS::inventory_item objects (see L<FS::inventory_item>.
1029 sub inventory_item {
1032 'table' => 'inventory_item',
1033 'hashref' => { 'svcnum' => $self->svcnum, },
1037 =item release_router
1039 Delete any routers associated with this service. This will release their
1040 address blocks, also.
1044 sub release_router {
1046 my @routers = qsearch('router', { svcnum => $self->svcnum });
1047 foreach (@routers) {
1048 my $error = $_->delete;
1049 return "$error (removing router '".$_->routername."')" if $error;
1057 Returns the cust_svc record associated with this svc_ record, as a FS::cust_svc
1058 object (see L<FS::cust_svc>).
1062 Runs export_suspend callbacks.
1069 my $export_args = $options{'export_args'} || [];
1070 $self->export('suspend', @$export_args);
1075 Runs export_unsuspend callbacks.
1082 my $export_args = $options{'export_args'} || [];
1083 $self->export('unsuspend', @$export_args);
1088 Runs export_links callbacks and returns the links.
1095 $self->export('links', $return);
1099 =item export_getsettings
1101 Runs export_getsettings callbacks and returns the two hashrefs.
1105 sub export_getsettings {
1109 my $error = $self->export('getsettings', \%settings, \%defaults);
1111 warn "error running export_getsetings: $error";
1112 return ( { 'error' => $error }, {} );
1114 ( \%settings, \%defaults );
1117 =item export_getstatus
1119 Runs export_getstatus callbacks and returns a two item list consisting of an
1120 HTML status and a status hashref.
1124 sub export_getstatus {
1128 my $error = $self->export('getstatus', \$html, \%hash);
1130 warn "error running export_getstatus: $error";
1131 return ( '', { 'error' => $error } );
1136 =item export_setstatus
1138 Runs export_setstatus callbacks. If there is an error, returns the error,
1139 otherwise returns false.
1143 sub export_setstatus { shift->_export_setstatus_X('setstatus', @_) }
1144 sub export_setstatus_listadd { shift->_export_setstatus_X('setstatus_listadd', @_) }
1145 sub export_setstatus_listdel { shift->_export_setstatus_X('setstatus_listdel', @_) }
1146 sub export_setstatus_vacationadd { shift->_export_setstatus_X('setstatus_vacationadd', @_) }
1147 sub export_setstatus_vacationdel { shift->_export_setstatus_X('setstatus_vacationdel', @_) }
1149 sub _export_setstatus_X {
1150 my( $self, $method, @args ) = @_;
1151 my $error = $self->export($method, @args);
1153 warn "error running export_$method: $error";
1159 =item export HOOK [ EXPORT_ARGS ]
1161 Runs the provided export hook (i.e. "suspend", "unsuspend") for this service.
1166 my( $self, $method ) = ( shift, shift );
1168 # $method must start with export_, $action must be the part after that
1169 $method = "export_$method" unless $method =~ /^export_/;
1170 my ($action) = $method =~ /^export_(\w+)/;
1172 local $SIG{HUP} = 'IGNORE';
1173 local $SIG{INT} = 'IGNORE';
1174 local $SIG{QUIT} = 'IGNORE';
1175 local $SIG{TERM} = 'IGNORE';
1176 local $SIG{TSTP} = 'IGNORE';
1177 local $SIG{PIPE} = 'IGNORE';
1179 my $oldAutoCommit = $FS::UID::AutoCommit;
1180 local $FS::UID::AutoCommit = 0;
1184 unless ( $noexport_hack ) {
1185 foreach my $part_export ( $self->cust_svc->part_svc->part_export ) {
1186 next unless $part_export->can($method);
1187 next if $part_export->get("no_$action"); # currently only 'no_suspend'
1188 my $error = $part_export->$method($self, @_);
1190 $dbh->rollback if $oldAutoCommit;
1191 return "error exporting $method event to ". $part_export->exporttype.
1192 " (transaction rolled back): $error";
1197 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1204 Sets or retrieves overlimit date.
1210 #$self->cust_svc->overlimit(@_);
1211 my $cust_svc = $self->cust_svc;
1212 unless ( $cust_svc ) { #wtf?
1213 my $error = "$me overlimit: missing cust_svc record for svc_acct svcnum ".
1215 if ( $overlimit_missing_cust_svc_nonfatal_kludge ) {
1216 cluck "$error; continuing anyway as requested";
1222 $cust_svc->overlimit(@_);
1227 Stub - returns false (no error) so derived classes don't need to define this
1228 methods. Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
1230 This method is called *before* the deletion step which actually deletes the
1231 services. This method should therefore only be used for "pre-deletion"
1232 cancellation steps, if necessary.
1238 =item clone_suspended
1240 Constructor used by FS::part_export::_export_suspend fallback. Stub returning
1241 same object for svc_ classes which don't implement a suspension fallback
1242 (everything except svc_acct at the moment). Document better.
1246 sub clone_suspended {
1250 =item clone_kludge_unsuspend
1252 Constructor used by FS::part_export::_export_unsuspend fallback. Stub returning
1253 same object for svc_ classes which don't implement a suspension fallback
1254 (everything except svc_acct at the moment). Document better.
1258 sub clone_kludge_unsuspend {
1262 =item find_duplicates MODE FIELDS...
1264 Method used by _check_duplicate routines to find services with duplicate
1265 values in specified fields. Set MODE to 'global' to search across all
1266 services, or 'export' to limit to those that share one or more exports
1267 with this service. FIELDS is a list of field names; only services
1268 matching in all fields will be returned. Empty fields will be skipped.
1272 sub find_duplicates {
1277 my %search = map { $_ => $self->getfield($_) }
1278 grep { length($self->getfield($_)) } @fields;
1279 return () if !%search;
1280 my @dup = grep { ! $self->svcnum or $_->svcnum != $self->svcnum }
1281 qsearch( $self->table, \%search );
1283 return @dup if $mode eq 'global';
1284 die "incorrect find_duplicates mode '$mode'" if $mode ne 'export';
1286 my $exports = FS::part_export::export_info($self->table);
1287 my %conflict_svcparts;
1288 my $part_svc = $self->part_svc;
1289 foreach my $part_export ( $part_svc->part_export ) {
1290 %conflict_svcparts = map { $_->svcpart => 1 } $part_export->export_svc;
1292 return grep { $conflict_svcparts{$_->cust_svc->svcpart} } @dup;
1295 =item getstatus_html
1299 sub getstatus_html {
1302 my $part_svc = $self->cust_svc->part_svc;
1306 foreach my $export ( grep $_->can('export_getstatus'), $part_svc->part_export ) {
1307 my $export_html = '';
1309 $export->export_getstatus( $self, \$export_html, \%hash );
1310 $html .= $export_html;
1323 my $conf = new FS::Conf;
1324 return '' unless grep { $self->table eq $_ }
1325 $conf->config('nms-auto_add-svc_ips');
1326 my $ip_field = $self->table_info->{'ip_field'};
1328 my $queue = FS::queue->new( {
1329 'job' => 'FS::NetworkMonitoringSystem::queued_add_router',
1330 'svcnum' => $self->svcnum,
1332 $queue->insert( 'FS::NetworkMonitoringSystem',
1334 $conf->config('nms-auto_add-community')
1343 #XXX not yet implemented
1346 =item search_sql_field FIELD STRING
1348 Class method which returns an SQL fragment to search for STRING in FIELD.
1350 It is now case-insensitive by default.
1354 sub search_sql_field {
1355 my( $class, $field, $string ) = @_;
1356 my $table = $class->table;
1357 my $q_string = dbh->quote($string);
1358 "LOWER($table.$field) = LOWER($q_string)";
1361 #fallback for services that don't provide a search...
1363 #my( $class, $string ) = @_;
1366 sub search_sql_addl_from {
1370 =item search HASHREF
1372 Class method which returns a qsearch hash expression to search for parameters
1373 specified in HASHREF.
1379 =item unlinked - set to search for all unlinked services. Overrides all other options.
1389 =item pkgpart - arrayref
1391 =item routernum - arrayref
1393 =item sectornum - arrayref
1395 =item towernum - arrayref
1399 =item cancelled - if true, only returns svcs attached to cancelled pkgs;
1400 if defined and false, only returns svcs not attached to cancelled packages
1406 ### Don't call the 'cancelled' option 'Service Status'
1407 ### There is no such thing
1408 ### See cautionary note in httemplate/browse/part_svc.cgi
1411 my ($class, $params) = @_;
1414 'LEFT JOIN cust_svc USING ( svcnum )',
1415 'LEFT JOIN part_svc USING ( svcpart )',
1416 'LEFT JOIN cust_pkg USING ( pkgnum )',
1417 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg'),
1422 $class->_search_svc($params, \@from, \@where) if $class->can('_search_svc');
1425 # if ( $params->{'domain'} ) {
1426 # my $svc_domain = qsearchs('svc_domain', { 'domain'=>$params->{'domain'} } );
1427 # #preserve previous behavior & bubble up an error if $svc_domain not found?
1428 # push @where, 'domsvc = '. $svc_domain->svcnum if $svc_domain;
1432 # if ( $params->{'domsvc'} =~ /^(\d+)$/ ) {
1433 # push @where, "domsvc = $1";
1437 push @where, 'pkgnum IS NULL' if $params->{'unlinked'};
1440 if ( $params->{'agentnum'} =~ /^(\d+)$/ && $1 ) {
1441 push @where, "cust_main.agentnum = $1";
1445 if ( $params->{'custnum'} =~ /^(\d+)$/ && $1 ) {
1446 push @where, "cust_pkg.custnum = $1";
1450 if ( $params->{'cust_status'} =~ /^([a-z]+)$/ ) {
1451 push @where, FS::cust_main->cust_status_sql . " = '$1'";
1455 if ( $params->{'balance'} =~ /^\s*(\-?\d*(\.\d{1,2})?)\s*$/ && length($1) ) {
1459 if ( $params->{'balance_days'} =~ /^\s*(\d*(\.\d{1,3})?)\s*$/ && length($1) ) {
1460 $age = time - 86400 * $1;
1462 push @where, FS::cust_main->balance_date_sql($age) . " > $balance";
1466 if ( $params->{'payby'} && scalar(@{ $params->{'payby'} }) ) {
1467 my @payby = map "'$_'", grep /^(\w+)$/, @{ $params->{'payby'} };
1468 push @where, 'payby IN ('. join(',', @payby ). ')';
1472 ##pkgpart, now properly untainted, can be arrayref
1473 #for my $pkgpart ( $params->{'pkgpart'} ) {
1474 # if ( ref $pkgpart ) {
1475 # my $where = join(',', map { /^(\d+)$/ ? $1 : () } @$pkgpart );
1476 # push @where, "cust_pkg.pkgpart IN ($where)" if $where;
1478 # elsif ( $pkgpart =~ /^(\d+)$/ ) {
1479 # push @where, "cust_pkg.pkgpart = $1";
1482 if ( $params->{'pkgpart'} ) {
1483 my @pkgpart = ref( $params->{'pkgpart'} )
1484 ? @{ $params->{'pkgpart'} }
1485 : $params->{'pkgpart'}
1486 ? ( $params->{'pkgpart'} )
1488 @pkgpart = grep /^(\d+)$/, @pkgpart;
1489 push @where, 'cust_pkg.pkgpart IN ('. join(',', @pkgpart ). ')' if @pkgpart;
1493 if ( $params->{'svcnum'} ) {
1494 my @svcnum = ref( $params->{'svcnum'} )
1495 ? @{ $params->{'svcnum'} }
1496 : $params->{'svcnum'};
1497 @svcnum = grep /^\d+$/, @svcnum;
1498 push @where, 'svcnum IN ('. join(',', @svcnum) . ')' if @svcnum;
1502 if ( $params->{'svcpart'} ) {
1503 my @svcpart = ref( $params->{'svcpart'} )
1504 ? @{ $params->{'svcpart'} }
1505 : $params->{'svcpart'}
1506 ? ( $params->{'svcpart'} )
1508 @svcpart = grep /^(\d+)$/, @svcpart;
1509 push @where, 'svcpart IN ('. join(',', @svcpart ). ')' if @svcpart;
1512 if ( $params->{'exportnum'} =~ /^(\d+)$/ ) {
1513 push @from, ' LEFT JOIN export_svc USING ( svcpart )';
1514 push @where, "exportnum = $1";
1517 if ( defined($params->{'cancelled'}) ) {
1518 if ($params->{'cancelled'}) {
1519 push @where, "cust_pkg.cancel IS NOT NULL";
1521 push @where, "cust_pkg.cancel IS NULL";
1525 # # sector and tower
1526 # my @where_sector = $class->tower_sector_sql($params);
1527 # if ( @where_sector ) {
1528 # push @where, @where_sector;
1529 # push @from, ' LEFT JOIN tower_sector USING ( sectornum )';
1532 # here is the agent virtualization
1533 #if ($params->{CurrentUser}) {
1535 # qsearchs('access_user', { username => $params->{CurrentUser} });
1537 # if ($access_user) {
1538 # push @where, $access_user->agentnums_sql('table'=>'cust_main');
1540 # push @where, "1=0";
1543 push @where, $FS::CurrentUser::CurrentUser->agentnums_sql(
1544 'table' => 'cust_main',
1545 'null_right' => 'View/link unlinked services',
1549 push @where, @{ $params->{'where'} } if $params->{'where'};
1551 my $addl_from = join(' ', @from);
1552 my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
1554 my $table = $class->table;
1556 my $count_query = "SELECT COUNT(*) FROM $table $addl_from $extra_sql";
1557 #if ( keys %svc_X ) {
1558 # $count_query .= ' WHERE '.
1559 # join(' AND ', map "$_ = ". dbh->quote($svc_X{$_}),
1567 'select' => join(', ',
1570 'cust_main.custnum',
1571 @{ $params->{'addl_select'} || [] },
1572 FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
1574 'addl_from' => $addl_from,
1575 'extra_sql' => $extra_sql,
1576 'order_by' => $params->{'order_by'},
1577 'count_query' => $count_query,
1586 The setfixed method return value.
1588 B<export> method isn't used by insert and replace methods yet.
1592 L<FS::Record>, L<FS::cust_svc>, L<FS::part_svc>, L<FS::cust_pkg>, schema.html
1593 from the base documentation.