4 use vars qw( @ISA $DEBUG $me $ignore_quantity $conf $ticket_system );
6 #use Scalar::Util qw( blessed );
7 use List::Util qw( max );
9 use FS::Record qw( qsearch qsearchs dbh str2time_sql str2time_sql_closing );
14 use FS::domain_record;
18 use FS::export_cust_svc;
20 #most FS::svc_ classes are autoloaded in svc_x emthod
21 use FS::svc_acct; #this one is used in the cache stuff
23 @ISA = qw( FS::cust_main_Mixin FS::option_Common ); #FS::Record );
30 #ask FS::UID to run this stuff for us later
31 FS::UID->install_callback( sub {
33 $ticket_system = $conf->config('ticket_system')
36 our $cache_enabled = 0;
39 my( $self, $hashref ) = @_;
40 if ( $cache_enabled && $hashref->{'svc'} ) {
41 $self->{'_svcpart'} = FS::part_svc->new($hashref);
47 my ( $hashref, $cache ) = @_;
48 if ( $hashref->{'username'} ) {
49 $self->{'_svc_acct'} = FS::svc_acct->new($hashref, '');
51 if ( $hashref->{'svc'} ) {
52 $self->{'_svcpart'} = FS::part_svc->new($hashref);
58 FS::cust_svc - Object method for cust_svc objects
64 $record = new FS::cust_svc \%hash
65 $record = new FS::cust_svc { 'column' => 'value' };
67 $error = $record->insert;
69 $error = $new_record->replace($old_record);
71 $error = $record->delete;
73 $error = $record->check;
75 ($label, $value) = $record->label;
79 An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record.
80 The following fields are currently supported:
84 =item svcnum - primary key (assigned automatically for new services)
86 =item pkgnum - Package (see L<FS::cust_pkg>)
88 =item svcpart - Service definition (see L<FS::part_svc>)
90 =item agent_svcid - Optional legacy service ID
92 =item overlimit - date the service exceeded its usage limit
102 Creates a new service. To add the refund to the database, see L<"insert">.
103 Services are normally created by creating FS::svc_ objects (see
104 L<FS::svc_acct>, L<FS::svc_domain>, and L<FS::svc_forward>, among others).
108 sub table { 'cust_svc'; }
112 Adds this service to the database. If there is an error, returns the error,
113 otherwise returns false.
120 local $SIG{HUP} = 'IGNORE';
121 local $SIG{INT} = 'IGNORE';
122 local $SIG{QUIT} = 'IGNORE';
123 local $SIG{TERM} = 'IGNORE';
124 local $SIG{TSTP} = 'IGNORE';
125 local $SIG{PIPE} = 'IGNORE';
127 my $oldAutoCommit = $FS::UID::AutoCommit;
128 local $FS::UID::AutoCommit = 0;
131 my $error = $self->SUPER::insert;
133 #check if this releases a hold (see FS::pkg_svc provision_hold)
134 $error ||= $self->_check_provision_hold;
137 $dbh->rollback if $oldAutoCommit;
138 return $error if $error
141 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
148 Deletes this service from the database. If there is an error, returns the
149 error, otherwise returns false. Note that this only removes the cust_svc
150 record - you should probably use the B<cancel> method instead.
159 my $cust_pkg = $self->cust_pkg;
160 my $custnum = $cust_pkg->custnum if $cust_pkg;
162 local $SIG{HUP} = 'IGNORE';
163 local $SIG{INT} = 'IGNORE';
164 local $SIG{QUIT} = 'IGNORE';
165 local $SIG{TERM} = 'IGNORE';
166 local $SIG{TSTP} = 'IGNORE';
167 local $SIG{PIPE} = 'IGNORE';
169 my $oldAutoCommit = $FS::UID::AutoCommit;
170 local $FS::UID::AutoCommit = 0;
173 # delete associated export_cust_svc
174 foreach my $export_cust_svc (
175 qsearch('export_cust_svc',{ 'svcnum' => $self->svcnum })
177 my $error = $export_cust_svc->delete;
179 $dbh->rollback if $oldAutoCommit;
184 my $error = $self->SUPER::delete;
186 $dbh->rollback if $oldAutoCommit;
190 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
192 if ( $ticket_system eq 'RT_Internal' ) {
193 unless ( $rt_session ) {
194 FS::TicketSystem->init;
195 $rt_session = FS::TicketSystem->session;
197 my $links = RT::Links->new($rt_session->{CurrentUser});
198 my $svcnum = $self->svcnum;
199 $links->Limit(FIELD => 'Target',
200 VALUE => 'freeside://freeside/cust_svc/'.$svcnum);
201 while ( my $l = $links->Next ) {
204 # re-link to point to the customer instead
206 $l->SetTarget('freeside://freeside/cust_main/'.$custnum);
209 ($val, $msg) = $l->Delete;
211 # can't do anything useful on error
212 warn "error unlinking ticket $svcnum: $msg\n" if !$val;
219 Cancels the relevant service by calling the B<cancel> method of the associated
220 FS::svc_XXX object (i.e. an FS::svc_acct object or FS::svc_domain object),
221 deleting the FS::svc_XXX record and then deleting this record.
223 If there is an error, returns the error, otherwise returns false.
230 local $SIG{HUP} = 'IGNORE';
231 local $SIG{INT} = 'IGNORE';
232 local $SIG{QUIT} = 'IGNORE';
233 local $SIG{TERM} = 'IGNORE';
234 local $SIG{TSTP} = 'IGNORE';
235 local $SIG{PIPE} = 'IGNORE';
237 my $oldAutoCommit = $FS::UID::AutoCommit;
238 local $FS::UID::AutoCommit = 0;
241 my $part_svc = $self->part_svc;
243 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
244 $dbh->rollback if $oldAutoCommit;
245 return "Illegal svcdb value in part_svc!";
248 require "FS/$svcdb.pm";
250 my $svc = $self->svc_x;
252 if ( %opt && $opt{'date'} ) {
253 my $error = $svc->expire($opt{'date'});
255 $dbh->rollback if $oldAutoCommit;
256 return "Error expiring service: $error";
259 my $error = $svc->cancel;
261 $dbh->rollback if $oldAutoCommit;
262 return "Error canceling service: $error";
264 $error = $svc->delete; #this deletes this cust_svc record as well
266 $dbh->rollback if $oldAutoCommit;
267 return "Error deleting service: $error";
274 warn "WARNING: no svc_ record found for svcnum ". $self->svcnum.
275 "; deleting cust_svc only\n";
277 my $error = $self->delete;
279 $dbh->rollback if $oldAutoCommit;
280 return "Error deleting cust_svc: $error";
285 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
291 =item overlimit [ ACTION ]
293 Retrieves or sets the overlimit date. If ACTION is absent, return
294 the present value of overlimit. If ACTION is present, it can
295 have the value 'suspend' or 'unsuspend'. In the case of 'suspend' overlimit
296 is set to the current time if it is not already set. The 'unsuspend' value
297 causes the time to be cleared.
299 If there is an error on setting, returns the error, otherwise returns false.
305 my $action = shift or return $self->getfield('overlimit');
307 local $SIG{HUP} = 'IGNORE';
308 local $SIG{INT} = 'IGNORE';
309 local $SIG{QUIT} = 'IGNORE';
310 local $SIG{TERM} = 'IGNORE';
311 local $SIG{TSTP} = 'IGNORE';
312 local $SIG{PIPE} = 'IGNORE';
314 my $oldAutoCommit = $FS::UID::AutoCommit;
315 local $FS::UID::AutoCommit = 0;
318 if ( $action eq 'suspend' ) {
319 $self->setfield('overlimit', time) unless $self->getfield('overlimit');
320 }elsif ( $action eq 'unsuspend' ) {
321 $self->setfield('overlimit', '');
323 die "unexpected action value: $action";
326 local $ignore_quantity = 1;
327 my $error = $self->replace;
329 $dbh->rollback if $oldAutoCommit;
330 return "Error setting overlimit: $error";
333 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
339 =item replace OLD_RECORD
341 Replaces the OLD_RECORD with this one in the database. If there is an error,
342 returns the error, otherwise returns false.
349 # my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
351 # : $new->replace_old;
352 my ( $new, $old ) = ( shift, shift );
353 $old = $new->replace_old unless defined($old);
355 local $SIG{HUP} = 'IGNORE';
356 local $SIG{INT} = 'IGNORE';
357 local $SIG{QUIT} = 'IGNORE';
358 local $SIG{TERM} = 'IGNORE';
359 local $SIG{TSTP} = 'IGNORE';
360 local $SIG{PIPE} = 'IGNORE';
362 my $oldAutoCommit = $FS::UID::AutoCommit;
363 local $FS::UID::AutoCommit = 0;
366 if ( $new->svcpart != $old->svcpart ) {
367 my $svc_x = $new->svc_x;
368 my $new_svc_x = ref($svc_x)->new({$svc_x->hash, svcpart=>$new->svcpart });
369 local($FS::Record::nowarn_identical) = 1;
370 my $error = $new_svc_x->replace($svc_x);
372 $dbh->rollback if $oldAutoCommit;
373 return $error if $error;
377 # #trigger a re-export on pkgnum changes?
378 # # (of prepaid packages), for Expiration RADIUS attribute
379 # if ( $new->pkgnum != $old->pkgnum && $new->cust_pkg->part_pkg->is_prepaid ) {
380 # my $svc_x = $new->svc_x;
381 # local($FS::Record::nowarn_identical) = 1;
382 # my $error = $svc_x->export('replace');
384 # $dbh->rollback if $oldAutoCommit;
385 # return $error if $error;
389 #trigger a pkg_change export on pkgnum changes
390 if ( $new->pkgnum != $old->pkgnum ) {
391 my $error = $new->svc_x->export('pkg_change', $new->cust_pkg,
396 $dbh->rollback if $oldAutoCommit;
397 return $error if $error;
399 } # if pkgnum is changing
401 #my $error = $new->SUPER::replace($old, @_);
402 my $error = $new->SUPER::replace($old);
404 #trigger a relocate export on location changes
405 if ( $new->cust_pkg->locationnum != $old->cust_pkg->locationnum ) {
406 my $svc_x = $new->svc_x;
407 if ( $svc_x->locationnum ) {
408 if ( $svc_x->locationnum == $old->cust_pkg->locationnum ) {
409 # in this case, set the service location to be the same as the new
411 $svc_x->set('locationnum', $new->cust_pkg->locationnum);
412 # and replace it, which triggers a relocate export so we don't
414 $error ||= $svc_x->replace;
416 # the service already has a different location from its package
420 # the service doesn't have a locationnum (either isn't of a type
421 # that has the locationnum field, or the locationnum is null and
422 # defaults to cust_pkg->locationnum)
423 # so just trigger the export here
424 $error ||= $new->svc_x->export('relocate',
425 $new->cust_pkg->cust_location,
426 $old->cust_pkg->cust_location,
428 } # if ($svc_x->locationnum)
429 } # if this is a location change
431 #check if this releases a hold (see FS::pkg_svc provision_hold)
432 $error ||= $new->_check_provision_hold;
435 $dbh->rollback if $oldAutoCommit;
436 return $error if $error
439 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
446 Checks all fields to make sure this is a valid service. If there is an error,
447 returns the error, otherwise returns false. Called by the insert and
456 $self->ut_numbern('svcnum')
457 || $self->ut_numbern('pkgnum')
458 || $self->ut_number('svcpart')
459 || $self->ut_numbern('agent_svcid')
460 || $self->ut_numbern('overlimit')
462 return $error if $error;
464 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
465 return "Unknown svcpart" unless $part_svc;
467 if ( $self->pkgnum && ! $ignore_quantity ) {
469 #slightly inefficient since ->pkg_svc will also look it up, but fixing
470 # a much larger perf problem and have bigger fish to fry
471 my $cust_pkg = $self->cust_pkg;
473 my $pkg_svc = $self->pkg_svc
474 || new FS::pkg_svc { 'svcpart' => $self->svcpart,
475 'pkgpart' => $cust_pkg->pkgpart,
479 #service add-ons, kinda false laziness/reimplementation of part_pkg->pkg_svc
480 foreach my $part_pkg_link ( $cust_pkg->part_pkg->svc_part_pkg_link ) {
481 my $addon_pkg_svc = qsearchs('pkg_svc', {
482 pkgpart => $part_pkg_link->dst_pkgpart,
483 svcpart => $self->svcpart,
485 $pkg_svc->quantity( $pkg_svc->quantity + $addon_pkg_svc->quantity )
489 #better error message? UI shouldn't get here
490 return "No svcpart ". $self->svcpart.
491 " services in pkgpart ". $cust_pkg->pkgpart
492 unless $pkg_svc->quantity > 0;
494 my $num_cust_svc = $cust_pkg->num_cust_svc( $self->svcpart );
496 #false laziness w/cust_pkg->part_svc
497 my $num_avail = max( 0, ($cust_pkg->quantity || 1) * $pkg_svc->quantity
501 #better error message? again, UI shouldn't get here
502 return "Already $num_cust_svc ". $pkg_svc->part_svc->svc.
503 " services for pkgnum ". $self->pkgnum
513 Returns the displayed service number for this service: agent_svcid if it has a
514 value, svcnum otherwise
520 $self->agent_svcid || $self->svcnum;
525 Returns the definition for this service, as a FS::part_svc object (see
532 return $self->{_svcpart} if $self->{_svcpart};
533 cluck 'cust_svc->part_svc called' if $DEBUG;
534 qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
539 Returns the package this service belongs to, as a FS::cust_pkg object (see
546 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
551 Returns the pkg_svc record for for this service, if applicable.
557 my $cust_pkg = $self->cust_pkg;
558 return undef unless $cust_pkg;
560 qsearchs( 'pkg_svc', { 'svcpart' => $self->svcpart,
561 'pkgpart' => $cust_pkg->pkgpart,
568 Returns the date this service was inserted.
574 $self->h_date('insert');
577 =item pkg_cancel_date
579 Returns the date this service's package was canceled. This normally only
580 exists for a service that's been preserved through cancellation with the
581 part_pkg.preserve flag.
585 sub pkg_cancel_date {
587 my $cust_pkg = $self->cust_pkg or return;
588 return $cust_pkg->getfield('cancel') || '';
591 =item label [ LOCALE ]
593 Returns a list consisting of:
594 - The name of this service (from part_svc), optionally localized
595 - A meaningful identifier (username, domain, or mail alias)
596 - The table name (i.e. svc_domain) for this service
601 my($label, $value, $svcdb) = $cust_svc->label;
603 =item label_long [ LOCALE ]
605 Like the B<label> method, except the second item in the list ("meaningful
606 identifier") may be longer - typically, a full name is included.
610 sub label { shift->_label('svc_label', @_); }
611 sub label_long { shift->_label('svc_label_long', @_); }
617 my $svc_x = $self->svc_x
618 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
620 $self->$method($svc_x, undef, undef, $locale);
623 # svc_label(_long) takes three arguments: end date, start date, locale
624 # and FS::svc_*::label methods must accept those also, if they even care
626 sub svc_label { shift->_svc_label('label', @_); }
627 sub svc_label_long { shift->_svc_label('label_long', @_); }
630 my( $self, $method, $svc_x ) = ( shift, shift, shift );
631 my ($end, $start, $locale) = @_;
634 $self->part_svc->svc_locale($locale),
636 $self->part_svc->svcdb,
644 Returns a listref of html elements associated with this service's exports.
650 my $svc_x = $self->svc_x
651 or return [ "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum ];
653 $svc_x->export_links;
656 =item export_getsettings
658 Returns two hashrefs of settings associated with this service's exports.
662 sub export_getsettings {
664 my $svc_x = $self->svc_x
665 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
667 $svc_x->export_getsettings;
673 Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or
674 FS::svc_domain object, etc.)
680 my $svcdb = $self->part_svc->svcdb;
681 if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
682 $self->{'_svc_acct'};
684 require "FS/$svcdb.pm";
685 warn "$me svc_x: part_svc.svcpart ". $self->part_svc->svcpart.
686 ", so searching for $svcdb.svcnum ". $self->svcnum. "\n"
688 qsearchs( $svcdb, { 'svcnum' => $self->svcnum } );
692 =item seconds_since TIMESTAMP
694 See L<FS::svc_acct/seconds_since>. Equivalent to
695 $cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records
696 where B<svcdb> is not "svc_acct".
700 #internal session db deprecated (or at least on hold)
701 sub seconds_since { 'internal session db deprecated'; };
702 ##note: implementation here, POD in FS::svc_acct
704 # my($self, $since) = @_;
706 # my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session
709 # AND logout IS NOT NULL'
710 # ) or die $dbh->errstr;
711 # $sth->execute($self->svcnum, $since) or die $sth->errstr;
712 # $sth->fetchrow_arrayref->[0];
715 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
717 Equivalent to $cust_svc->svc_x->seconds_since_sqlradacct, but
718 more efficient. Meaningless for records where B<svcdb> is not
719 svc_acct or svc_broadband.
723 sub seconds_since_sqlradacct {
724 my($self, $start, $end) = @_;
726 my $mes = "$me seconds_since_sqlradacct:";
728 my $svc_x = $self->svc_x;
730 my @part_export = $self->part_svc->part_export_usage;
731 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
732 " service definition"
737 foreach my $part_export ( @part_export ) {
739 next if $part_export->option('ignore_accounting');
741 warn "$mes connecting to sqlradius database\n"
744 my $dbh = DBI->connect( map { $part_export->option($_) }
745 qw(datasrc username password) )
746 or die "can't connect to sqlradius database: ". $DBI::errstr;
748 warn "$mes connected to sqlradius database\n"
751 #select a unix time conversion function based on database type
752 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
753 my $closing = str2time_sql_closing( $dbh->{Driver}->{Name} );
755 my $username = $part_export->export_username($svc_x);
759 warn "$mes finding closed sessions completely within the given range\n"
764 if ($part_export->option('process_single_realm')) {
765 $realm = 'AND Realm = ?';
766 $realmparam = $part_export->option('realm');
769 my $sth = $dbh->prepare("SELECT SUM(acctsessiontime)
773 AND $str2time AcctStartTime $closing >= ?
774 AND $str2time AcctStopTime $closing < ?
775 AND $str2time AcctStopTime $closing > 0
776 AND AcctStopTime IS NOT NULL"
777 ) or die $dbh->errstr;
778 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end)
780 my $regular = $sth->fetchrow_arrayref->[0];
782 warn "$mes finding open sessions which start in the range\n"
785 # count session start->range end
786 $query = "SELECT SUM( ? - $str2time AcctStartTime $closing )
790 AND $str2time AcctStartTime $closing >= ?
791 AND $str2time AcctStartTime $closing < ?
792 AND ( ? - $str2time AcctStartTime $closing ) < 86400
793 AND ( $str2time AcctStopTime $closing = 0
794 OR AcctStopTime IS NULL )";
795 $sth = $dbh->prepare($query) or die $dbh->errstr;
798 ($realm ? $realmparam : ()),
802 or die $sth->errstr. " executing query $query";
803 my $start_during = $sth->fetchrow_arrayref->[0];
805 warn "$mes finding closed sessions which start before the range but stop during\n"
808 #count range start->session end
809 $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime $closing - ? )
813 AND $str2time AcctStartTime $closing < ?
814 AND $str2time AcctStopTime $closing >= ?
815 AND $str2time AcctStopTime $closing < ?
816 AND $str2time AcctStopTime $closing > 0
817 AND AcctStopTime IS NOT NULL"
818 ) or die $dbh->errstr;
819 $sth->execute( $start,
821 ($realm ? $realmparam : ()),
826 my $end_during = $sth->fetchrow_arrayref->[0];
828 warn "$mes finding closed sessions which start before the range but stop after\n"
831 # count range start->range end
832 # don't count open sessions anymore (probably missing stop record)
833 $sth = $dbh->prepare("SELECT COUNT(*)
837 AND $str2time AcctStartTime $closing < ?
838 AND ( $str2time AcctStopTime $closing >= ?
840 # OR AcctStopTime = 0
841 # OR AcctStopTime IS NULL )"
842 ) or die $dbh->errstr;
843 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end )
845 my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0];
847 $seconds += $regular + $end_during + $start_during + $entire_range;
849 warn "$mes done finding sessions\n"
858 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
860 See L<FS::svc_acct/attribute_since_sqlradacct>. Equivalent to
861 $cust_svc->svc_x->attribute_since_sqlradacct, but more efficient.
862 Meaningless for records where B<svcdb> is not svc_acct or svc_broadband.
866 #(false laziness w/seconds_since_sqlradacct above)
867 sub attribute_since_sqlradacct {
868 my($self, $start, $end, $attrib) = @_;
870 my $mes = "$me attribute_since_sqlradacct:";
872 my $svc_x = $self->svc_x;
874 my @part_export = $self->part_svc->part_export_usage;
875 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
876 " service definition"
882 foreach my $part_export ( @part_export ) {
884 next if $part_export->option('ignore_accounting');
886 warn "$mes connecting to sqlradius database\n"
889 my $dbh = DBI->connect( map { $part_export->option($_) }
890 qw(datasrc username password) )
891 or die "can't connect to sqlradius database: ". $DBI::errstr;
893 warn "$mes connected to sqlradius database\n"
896 #select a unix time conversion function based on database type
897 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
898 my $closing = str2time_sql_closing( $dbh->{Driver}->{Name} );
900 my $username = $part_export->export_username($svc_x);
902 warn "$mes SUMing $attrib sessions\n"
907 if ($part_export->option('process_single_realm')) {
908 $realm = 'AND Realm = ?';
909 $realmparam = $part_export->option('realm');
912 my $sth = $dbh->prepare("SELECT SUM($attrib)
916 AND $str2time AcctStopTime $closing >= ?
917 AND $str2time AcctStopTime $closing < ?
918 AND AcctStopTime IS NOT NULL"
919 ) or die $dbh->errstr;
920 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end)
923 my $row = $sth->fetchrow_arrayref;
924 $sum += $row->[0] if defined($row->[0]);
926 warn "$mes done SUMing sessions\n"
935 #note: implementation here, POD in FS::svc_acct
936 # false laziness w/above
937 sub attribute_last_sqlradacct {
938 my($self, $attrib) = @_;
940 my $mes = "$me attribute_last_sqlradacct:";
942 my $svc_x = $self->svc_x;
944 my @part_export = $self->part_svc->part_export_usage;
945 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
946 " service definition"
951 my $AcctStartTime = 0;
953 foreach my $part_export ( @part_export ) {
955 next if $part_export->option('ignore_accounting');
957 warn "$mes connecting to sqlradius database\n"
960 my $dbh = DBI->connect( map { $part_export->option($_) }
961 qw(datasrc username password) )
962 or die "can't connect to sqlradius database: ". $DBI::errstr;
964 warn "$mes connected to sqlradius database\n"
967 #select a unix time conversion function based on database type
968 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
969 my $closing = str2time_sql_closing( $dbh->{Driver}->{Name} );
971 my $username = $part_export->export_username($svc_x);
973 warn "$mes finding most-recent $attrib\n"
978 if ($part_export->option('process_single_realm')) {
979 $realm = 'AND Realm = ?';
980 $realmparam = $part_export->option('realm');
983 my $sth = $dbh->prepare("SELECT $attrib, $str2time AcctStartTime $closing
987 ORDER BY AcctStartTime DESC LIMIT 1
988 ") or die $dbh->errstr;
989 $sth->execute($username, ($realm ? $realmparam : ()) )
992 my $row = $sth->fetchrow_arrayref;
993 if ( defined($row->[0]) && $row->[1] > $AcctStartTime ) {
995 $AcctStartTime = $row->[1];
1007 =item get_session_history TIMESTAMP_START TIMESTAMP_END
1009 See L<FS::svc_acct/get_session_history>. Equivalent to
1010 $cust_svc->svc_x->get_session_history, but more efficient. Meaningless for
1011 records where B<svcdb> is not "svc_acct".
1015 sub get_session_history {
1016 my($self, $start, $end, $attrib) = @_;
1020 my @part_export = $self->part_svc->part_export_usage;
1021 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
1022 " service definition"
1023 unless @part_export;
1028 foreach my $part_export ( @part_export ) {
1030 @{ $part_export->usage_sessions( $start, $end, $self->svc_x ) };
1037 =item tickets [ STATUS ]
1039 Returns an array of hashes representing the tickets linked to this service.
1041 An optional status (or arrayref or hashref of statuses) may be specified.
1047 my $status = ( @_ && $_[0] ) ? shift : '';
1049 my $conf = FS::Conf->new;
1050 my $num = $conf->config('cust_main-max_tickets') || 10;
1053 if ( $conf->config('ticket_system') ) {
1054 unless ( $conf->config('ticket_system-custom_priority_field') ) {
1056 @tickets = @{ FS::TicketSystem->service_tickets( $self->svcnum,
1065 foreach my $priority (
1066 $conf->config('ticket_system-custom_priority_field-values'), ''
1068 last if scalar(@tickets) >= $num;
1070 @{ FS::TicketSystem->service_tickets( $self->svcnum,
1071 $num - scalar(@tickets),
1089 =item smart_search OPTION => VALUE ...
1091 Accepts the option I<search>, the string to search for. The string will
1092 be searched for as a username, email address, IP address, MAC address,
1093 phone number, and hardware serial number. Unlike the I<smart_search> on
1094 customers, this always requires an exact match.
1098 # though perhaps it should be fuzzy in some cases?
1101 my %param = __PACKAGE__->smart_search_param(@_);
1105 sub smart_search_param {
1109 my $string = $opt{'search'};
1110 $string =~ s/(^\s+|\s+$)//; #trim leading & trailing whitespace
1113 map { my $table = $_;
1114 my $search_sql = "FS::$table"->search_sql($string);
1115 my $addl_from = "FS::$table"->search_sql_addl_from();
1117 "SELECT $table.svcnum AS svcnum, '$table' AS svcdb ".
1118 "FROM $table $addl_from WHERE $search_sql";
1120 FS::part_svc->svc_tables;
1122 if ( $string =~ /^(\d+)$/ ) {
1123 unshift @or, "SELECT cust_svc.svcnum, NULL as svcdb FROM cust_svc WHERE agent_svcid = $1";
1126 my $addl_from = " RIGHT JOIN (\n" . join("\nUNION\n", @or) . "\n) AS svc_all ".
1127 " ON (svc_all.svcnum = cust_svc.svcnum) ";
1131 push @extra_sql, $FS::CurrentUser::CurrentUser->agentnums_sql(
1132 'null_right' => 'View/link unlinked services'
1134 my $extra_sql = ' WHERE '.join(' AND ', @extra_sql);
1136 $addl_from .= ' LEFT JOIN cust_pkg USING ( pkgnum )'.
1137 FS::UI::Web::join_cust_main('cust_pkg', 'cust_pkg').
1138 ' LEFT JOIN part_svc USING ( svcpart )';
1141 'table' => 'cust_svc',
1142 'select' => 'svc_all.svcnum AS svcnum, '.
1143 'COALESCE(svc_all.svcdb, part_svc.svcdb) AS svcdb, '.
1145 'addl_from' => $addl_from,
1147 'extra_sql' => $extra_sql,
1151 # If the associated cust_pkg is 'on hold'
1152 # and the associated pkg_svc has the provision_hold flag
1153 # and there are no more available_part_svcs on the cust_pkg similarly flagged,
1154 # then removes hold from pkg
1155 # returns $error or '' on success,
1156 # does not indicate if pkg status was changed
1157 sub _check_provision_hold {
1160 # check status of cust_pkg
1161 my $cust_pkg = $self->cust_pkg;
1162 return '' unless $cust_pkg && $cust_pkg->status eq 'on hold';
1164 # check flag on this svc
1165 # small false laziness with $self->pkg_svc
1166 # to avoid looking up cust_pkg twice
1167 my $pkg_svc = qsearchs( 'pkg_svc', {
1168 'svcpart' => $self->svcpart,
1169 'pkgpart' => $cust_pkg->pkgpart,
1171 return '' unless $pkg_svc->provision_hold;
1173 # check for any others available with that flag
1174 return '' if $cust_pkg->available_part_svc( 'provision_hold' => 1 );
1176 # conditions met, remove hold
1177 return $cust_pkg->unsuspend;
1183 # fix missing (deleted by mistake) svc_x records
1184 warn "searching for missing svc_x records...\n";
1186 'table' => 'cust_svc',
1187 'select' => 'cust_svc.*',
1188 'addl_from' => ' LEFT JOIN ( ' .
1190 map { "SELECT svcnum FROM $_" }
1191 FS::part_svc->svc_tables
1192 ) . ' ) AS svc_all ON cust_svc.svcnum = svc_all.svcnum',
1193 'extra_sql' => ' WHERE svc_all.svcnum IS NULL',
1195 my @svcs = qsearch(\%search);
1196 warn "found ".scalar(@svcs)."\n";
1198 local $FS::Record::nowarn_classload = 1; # for h_svc_
1199 local $FS::svc_Common::noexport_hack = 1; # because we're inserting services
1202 'hashref' => { history_action => 'delete' },
1203 'order_by' => ' ORDER BY history_date DESC LIMIT 1',
1205 foreach my $cust_svc (@svcs) {
1206 my $svcnum = $cust_svc->svcnum;
1207 my $svcdb = $cust_svc->part_svc->svcdb;
1208 $h_search{'hashref'}{'svcnum'} = $svcnum;
1209 $h_search{'table'} = "h_$svcdb";
1210 my $h_svc_x = qsearchs(\%h_search)
1212 my $class = "FS::$svcdb";
1213 my $new_svc_x = $class->new({ $h_svc_x->hash });
1214 my $error = $new_svc_x->insert;
1215 warn "error repairing svcnum $svcnum ($svcdb) from history:\n$error\n"
1226 Behaviour of changing the svcpart of cust_svc records is undefined and should
1227 possibly be prohibited, and pkg_svc records are not checked.
1229 pkg_svc records are not checked in general (here).
1231 Deleting this record doesn't check or delete the svc_* record associated
1234 In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of
1235 a DBI database handle is not yet implemented.
1239 L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,
1240 schema.html from the base documentation