4 use vars qw( @ISA $DEBUG $me $ignore_quantity );
6 #use Scalar::Util qw( blessed );
8 use FS::Record qw( qsearch qsearchs dbh str2time_sql );
13 use FS::domain_record;
17 #most FS::svc_ classes are autoloaded in svc_x emthod
18 use FS::svc_acct; #this one is used in the cache stuff
20 @ISA = qw( FS::cust_main_Mixin FS::option_Common ); #FS::Record );
29 my ( $hashref, $cache ) = @_;
30 if ( $hashref->{'username'} ) {
31 $self->{'_svc_acct'} = FS::svc_acct->new($hashref, '');
33 if ( $hashref->{'svc'} ) {
34 $self->{'_svcpart'} = FS::part_svc->new($hashref);
40 FS::cust_svc - Object method for cust_svc objects
46 $record = new FS::cust_svc \%hash
47 $record = new FS::cust_svc { 'column' => 'value' };
49 $error = $record->insert;
51 $error = $new_record->replace($old_record);
53 $error = $record->delete;
55 $error = $record->check;
57 ($label, $value) = $record->label;
61 An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record.
62 The following fields are currently supported:
66 =item svcnum - primary key (assigned automatically for new services)
68 =item pkgnum - Package (see L<FS::cust_pkg>)
70 =item svcpart - Service definition (see L<FS::part_svc>)
72 =item overlimit - date the service exceeded its usage limit
82 Creates a new service. To add the refund to the database, see L<"insert">.
83 Services are normally created by creating FS::svc_ objects (see
84 L<FS::svc_acct>, L<FS::svc_domain>, and L<FS::svc_forward>, among others).
88 sub table { 'cust_svc'; }
92 Adds this service to the database. If there is an error, returns the error,
93 otherwise returns false.
97 Deletes this service from the database. If there is an error, returns the
98 error, otherwise returns false. Note that this only removes the cust_svc
99 record - you should probably use the B<cancel> method instead.
103 Cancels the relevant service by calling the B<cancel> method of the associated
104 FS::svc_XXX object (i.e. an FS::svc_acct object or FS::svc_domain object),
105 deleting the FS::svc_XXX record and then deleting this record.
107 If there is an error, returns the error, otherwise returns false.
114 local $SIG{HUP} = 'IGNORE';
115 local $SIG{INT} = 'IGNORE';
116 local $SIG{QUIT} = 'IGNORE';
117 local $SIG{TERM} = 'IGNORE';
118 local $SIG{TSTP} = 'IGNORE';
119 local $SIG{PIPE} = 'IGNORE';
121 my $oldAutoCommit = $FS::UID::AutoCommit;
122 local $FS::UID::AutoCommit = 0;
125 my $part_svc = $self->part_svc;
127 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
128 $dbh->rollback if $oldAutoCommit;
129 return "Illegal svcdb value in part_svc!";
132 require "FS/$svcdb.pm";
134 my $svc = $self->svc_x;
136 if ( %opt && $opt{'date'} ) {
137 my $error = $svc->expire($opt{'date'});
139 $dbh->rollback if $oldAutoCommit;
140 return "Error expiring service: $error";
143 my $error = $svc->cancel;
145 $dbh->rollback if $oldAutoCommit;
146 return "Error canceling service: $error";
148 $error = $svc->delete; #this deletes this cust_svc record as well
150 $dbh->rollback if $oldAutoCommit;
151 return "Error deleting service: $error";
158 warn "WARNING: no svc_ record found for svcnum ". $self->svcnum.
159 "; deleting cust_svc only\n";
161 my $error = $self->delete;
163 $dbh->rollback if $oldAutoCommit;
164 return "Error deleting cust_svc: $error";
169 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
175 =item overlimit [ ACTION ]
177 Retrieves or sets the overlimit date. If ACTION is absent, return
178 the present value of overlimit. If ACTION is present, it can
179 have the value 'suspend' or 'unsuspend'. In the case of 'suspend' overlimit
180 is set to the current time if it is not already set. The 'unsuspend' value
181 causes the time to be cleared.
183 If there is an error on setting, returns the error, otherwise returns false.
189 my $action = shift or return $self->getfield('overlimit');
191 local $SIG{HUP} = 'IGNORE';
192 local $SIG{INT} = 'IGNORE';
193 local $SIG{QUIT} = 'IGNORE';
194 local $SIG{TERM} = 'IGNORE';
195 local $SIG{TSTP} = 'IGNORE';
196 local $SIG{PIPE} = 'IGNORE';
198 my $oldAutoCommit = $FS::UID::AutoCommit;
199 local $FS::UID::AutoCommit = 0;
202 if ( $action eq 'suspend' ) {
203 $self->setfield('overlimit', time) unless $self->getfield('overlimit');
204 }elsif ( $action eq 'unsuspend' ) {
205 $self->setfield('overlimit', '');
207 die "unexpected action value: $action";
210 local $ignore_quantity = 1;
211 my $error = $self->replace;
213 $dbh->rollback if $oldAutoCommit;
214 return "Error setting overlimit: $error";
217 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
223 =item replace OLD_RECORD
225 Replaces the OLD_RECORD with this one in the database. If there is an error,
226 returns the error, otherwise returns false.
233 # my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
235 # : $new->replace_old;
236 my ( $new, $old ) = ( shift, shift );
237 $old = $new->replace_old unless defined($old);
239 local $SIG{HUP} = 'IGNORE';
240 local $SIG{INT} = 'IGNORE';
241 local $SIG{QUIT} = 'IGNORE';
242 local $SIG{TERM} = 'IGNORE';
243 local $SIG{TSTP} = 'IGNORE';
244 local $SIG{PIPE} = 'IGNORE';
246 my $oldAutoCommit = $FS::UID::AutoCommit;
247 local $FS::UID::AutoCommit = 0;
250 if ( $new->svcpart != $old->svcpart ) {
251 my $svc_x = $new->svc_x;
252 my $new_svc_x = ref($svc_x)->new({$svc_x->hash, svcpart=>$new->svcpart });
253 local($FS::Record::nowarn_identical) = 1;
254 my $error = $new_svc_x->replace($svc_x);
256 $dbh->rollback if $oldAutoCommit;
257 return $error if $error;
261 # #trigger a re-export on pkgnum changes?
262 # # (of prepaid packages), for Expiration RADIUS attribute
263 # if ( $new->pkgnum != $old->pkgnum && $new->cust_pkg->part_pkg->is_prepaid ) {
264 # my $svc_x = $new->svc_x;
265 # local($FS::Record::nowarn_identical) = 1;
266 # my $error = $svc_x->export('replace');
268 # $dbh->rollback if $oldAutoCommit;
269 # return $error if $error;
273 #my $error = $new->SUPER::replace($old, @_);
274 my $error = $new->SUPER::replace($old);
276 $dbh->rollback if $oldAutoCommit;
277 return $error if $error;
280 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
287 Checks all fields to make sure this is a valid service. If there is an error,
288 returns the error, otherwise returns false. Called by the insert and
297 $self->ut_numbern('svcnum')
298 || $self->ut_numbern('pkgnum')
299 || $self->ut_number('svcpart')
300 || $self->ut_numbern('overlimit')
302 return $error if $error;
304 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
305 return "Unknown svcpart" unless $part_svc;
307 if ( $self->pkgnum ) {
308 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
309 return "Unknown pkgnum" unless $cust_pkg;
310 ($part_svc) = grep { $_->svcpart == $self->svcpart } $cust_pkg->part_svc;
312 return "Already ". $part_svc->get('num_cust_svc'). " ". $part_svc->svc.
313 " services for pkgnum ". $self->pkgnum
314 if $part_svc->get('num_avail') == 0 and !$ignore_quantity;
322 Returns the definition for this service, as a FS::part_svc object (see
330 ? $self->{'_svcpart'}
331 : qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
336 Returns the package this service belongs to, as a FS::cust_pkg object (see
343 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
348 Returns the pkg_svc record for for this service, if applicable.
354 my $cust_pkg = $self->cust_pkg;
355 return undef unless $cust_pkg;
357 qsearchs( 'pkg_svc', { 'svcpart' => $self->svcpart,
358 'pkgpart' => $cust_pkg->pkgpart,
365 Returns the date this service was inserted.
371 $self->h_date('insert');
376 Returns a list consisting of:
377 - The name of this service (from part_svc)
378 - A meaningful identifier (username, domain, or mail alias)
379 - The table name (i.e. svc_domain) for this service
384 my($label, $value, $svcdb) = $cust_svc->label;
388 Like the B<label> method, except the second item in the list ("meaningful
389 identifier") may be longer - typically, a full name is included.
393 sub label { shift->_label('svc_label', @_); }
394 sub label_long { shift->_label('svc_label_long', @_); }
399 my $svc_x = $self->svc_x
400 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
402 $self->$method($svc_x);
405 sub svc_label { shift->_svc_label('label', @_); }
406 sub svc_label_long { shift->_svc_label('label_long', @_); }
409 my( $self, $method, $svc_x ) = ( shift, shift, shift );
412 $self->part_svc->svc,
414 $self->part_svc->svcdb,
422 Returns a listref of html elements associated with this service's exports.
428 my $svc_x = $self->svc_x
429 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
431 $svc_x->export_links;
434 =item export_getsettings
436 Returns two hashrefs of settings associated with this service's exports.
440 sub export_getsettings {
442 my $svc_x = $self->svc_x
443 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
445 $svc_x->export_getsettings;
451 Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or
452 FS::svc_domain object, etc.)
458 my $svcdb = $self->part_svc->svcdb;
459 if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
460 $self->{'_svc_acct'};
462 require "FS/$svcdb.pm";
463 warn "$me svc_x: part_svc.svcpart ". $self->part_svc->svcpart.
464 ", so searching for $svcdb.svcnum ". $self->svcnum. "\n"
466 qsearchs( $svcdb, { 'svcnum' => $self->svcnum } );
470 =item seconds_since TIMESTAMP
472 See L<FS::svc_acct/seconds_since>. Equivalent to
473 $cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records
474 where B<svcdb> is not "svc_acct".
478 #internal session db deprecated (or at least on hold)
479 sub seconds_since { 'internal session db deprecated'; };
480 ##note: implementation here, POD in FS::svc_acct
482 # my($self, $since) = @_;
484 # my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session
487 # AND logout IS NOT NULL'
488 # ) or die $dbh->errstr;
489 # $sth->execute($self->svcnum, $since) or die $sth->errstr;
490 # $sth->fetchrow_arrayref->[0];
493 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
495 See L<FS::svc_acct/seconds_since_sqlradacct>. Equivalent to
496 $cust_svc->svc_x->seconds_since_sqlradacct, but more efficient. Meaningless
497 for records where B<svcdb> is not "svc_acct".
501 #note: implementation here, POD in FS::svc_acct
502 sub seconds_since_sqlradacct {
503 my($self, $start, $end) = @_;
505 my $mes = "$me seconds_since_sqlradacct:";
507 my $svc_x = $self->svc_x;
509 my @part_export = $self->part_svc->part_export_usage;
510 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
511 " service definition"
516 foreach my $part_export ( @part_export ) {
518 next if $part_export->option('ignore_accounting');
520 warn "$mes connecting to sqlradius database\n"
523 my $dbh = DBI->connect( map { $part_export->option($_) }
524 qw(datasrc username password) )
525 or die "can't connect to sqlradius database: ". $DBI::errstr;
527 warn "$mes connected to sqlradius database\n"
530 #select a unix time conversion function based on database type
531 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
533 my $username = $part_export->export_username($svc_x);
537 warn "$mes finding closed sessions completely within the given range\n"
542 if ($part_export->option('process_single_realm')) {
543 $realm = 'AND Realm = ?';
544 $realmparam = $part_export->option('realm');
547 my $sth = $dbh->prepare("SELECT SUM(acctsessiontime)
551 AND $str2time AcctStartTime) >= ?
552 AND $str2time AcctStopTime ) < ?
553 AND $str2time AcctStopTime ) > 0
554 AND AcctStopTime IS NOT NULL"
555 ) or die $dbh->errstr;
556 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end)
558 my $regular = $sth->fetchrow_arrayref->[0];
560 warn "$mes finding open sessions which start in the range\n"
563 # count session start->range end
564 $query = "SELECT SUM( ? - $str2time AcctStartTime ) )
568 AND $str2time AcctStartTime ) >= ?
569 AND $str2time AcctStartTime ) < ?
570 AND ( ? - $str2time AcctStartTime ) ) < 86400
571 AND ( $str2time AcctStopTime ) = 0
572 OR AcctStopTime IS NULL )";
573 $sth = $dbh->prepare($query) or die $dbh->errstr;
576 ($realm ? $realmparam : ()),
580 or die $sth->errstr. " executing query $query";
581 my $start_during = $sth->fetchrow_arrayref->[0];
583 warn "$mes finding closed sessions which start before the range but stop during\n"
586 #count range start->session end
587 $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime ) - ? )
591 AND $str2time AcctStartTime ) < ?
592 AND $str2time AcctStopTime ) >= ?
593 AND $str2time AcctStopTime ) < ?
594 AND $str2time AcctStopTime ) > 0
595 AND AcctStopTime IS NOT NULL"
596 ) or die $dbh->errstr;
597 $sth->execute( $start,
599 ($realm ? $realmparam : ()),
604 my $end_during = $sth->fetchrow_arrayref->[0];
606 warn "$mes finding closed sessions which start before the range but stop after\n"
609 # count range start->range end
610 # don't count open sessions anymore (probably missing stop record)
611 $sth = $dbh->prepare("SELECT COUNT(*)
615 AND $str2time AcctStartTime ) < ?
616 AND ( $str2time AcctStopTime ) >= ?
618 # OR AcctStopTime = 0
619 # OR AcctStopTime IS NULL )"
620 ) or die $dbh->errstr;
621 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end )
623 my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0];
625 $seconds += $regular + $end_during + $start_during + $entire_range;
627 warn "$mes done finding sessions\n"
636 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
638 See L<FS::svc_acct/attribute_since_sqlradacct>. Equivalent to
639 $cust_svc->svc_x->attribute_since_sqlradacct, but more efficient. Meaningless
640 for records where B<svcdb> is not "svc_acct".
644 #note: implementation here, POD in FS::svc_acct
645 #(false laziness w/seconds_since_sqlradacct above)
646 sub attribute_since_sqlradacct {
647 my($self, $start, $end, $attrib) = @_;
649 my $mes = "$me attribute_since_sqlradacct:";
651 my $svc_x = $self->svc_x;
653 my @part_export = $self->part_svc->part_export_usage;
654 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
655 " service definition"
661 foreach my $part_export ( @part_export ) {
663 next if $part_export->option('ignore_accounting');
665 warn "$mes connecting to sqlradius database\n"
668 my $dbh = DBI->connect( map { $part_export->option($_) }
669 qw(datasrc username password) )
670 or die "can't connect to sqlradius database: ". $DBI::errstr;
672 warn "$mes connected to sqlradius database\n"
675 #select a unix time conversion function based on database type
676 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
678 my $username = $part_export->export_username($svc_x);
680 warn "$mes SUMing $attrib sessions\n"
685 if ($part_export->option('process_single_realm')) {
686 $realm = 'AND Realm = ?';
687 $realmparam = $part_export->option('realm');
690 my $sth = $dbh->prepare("SELECT SUM($attrib)
694 AND $str2time AcctStopTime ) >= ?
695 AND $str2time AcctStopTime ) < ?
696 AND AcctStopTime IS NOT NULL"
697 ) or die $dbh->errstr;
698 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end)
701 my $row = $sth->fetchrow_arrayref;
702 $sum += $row->[0] if defined($row->[0]);
704 warn "$mes done SUMing sessions\n"
713 =item get_session_history TIMESTAMP_START TIMESTAMP_END
715 See L<FS::svc_acct/get_session_history>. Equivalent to
716 $cust_svc->svc_x->get_session_history, but more efficient. Meaningless for
717 records where B<svcdb> is not "svc_acct".
721 sub get_session_history {
722 my($self, $start, $end, $attrib) = @_;
726 my @part_export = $self->part_svc->part_export_usage;
727 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
728 " service definition"
734 foreach my $part_export ( @part_export ) {
736 @{ $part_export->usage_sessions( $start, $end, $self->svc_x ) };
747 Behaviour of changing the svcpart of cust_svc records is undefined and should
748 possibly be prohibited, and pkg_svc records are not checked.
750 pkg_svc records are not checked in general (here).
752 Deleting this record doesn't check or delete the svc_* record associated
755 In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of
756 a DBI database handle is not yet implemented.
760 L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,
761 schema.html from the base documentation