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;
137 my $error = $svc->cancel;
139 $dbh->rollback if $oldAutoCommit;
140 return "Error canceling service: $error";
142 $error = $svc->delete; #this deletes this cust_svc record as well
144 $dbh->rollback if $oldAutoCommit;
145 return "Error deleting service: $error";
151 warn "WARNING: no svc_ record found for svcnum ". $self->svcnum.
152 "; deleting cust_svc only\n";
154 my $error = $self->delete;
156 $dbh->rollback if $oldAutoCommit;
157 return "Error deleting cust_svc: $error";
162 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
168 =item overlimit [ ACTION ]
170 Retrieves or sets the overlimit date. If ACTION is absent, return
171 the present value of overlimit. If ACTION is present, it can
172 have the value 'suspend' or 'unsuspend'. In the case of 'suspend' overlimit
173 is set to the current time if it is not already set. The 'unsuspend' value
174 causes the time to be cleared.
176 If there is an error on setting, returns the error, otherwise returns false.
182 my $action = shift or return $self->getfield('overlimit');
184 local $SIG{HUP} = 'IGNORE';
185 local $SIG{INT} = 'IGNORE';
186 local $SIG{QUIT} = 'IGNORE';
187 local $SIG{TERM} = 'IGNORE';
188 local $SIG{TSTP} = 'IGNORE';
189 local $SIG{PIPE} = 'IGNORE';
191 my $oldAutoCommit = $FS::UID::AutoCommit;
192 local $FS::UID::AutoCommit = 0;
195 if ( $action eq 'suspend' ) {
196 $self->setfield('overlimit', time) unless $self->getfield('overlimit');
197 }elsif ( $action eq 'unsuspend' ) {
198 $self->setfield('overlimit', '');
200 die "unexpected action value: $action";
203 local $ignore_quantity = 1;
204 my $error = $self->replace;
206 $dbh->rollback if $oldAutoCommit;
207 return "Error setting overlimit: $error";
210 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
216 =item replace OLD_RECORD
218 Replaces the OLD_RECORD with this one in the database. If there is an error,
219 returns the error, otherwise returns false.
226 # my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
228 # : $new->replace_old;
229 my ( $new, $old ) = ( shift, shift );
230 $old = $new->replace_old unless defined($old);
232 local $SIG{HUP} = 'IGNORE';
233 local $SIG{INT} = 'IGNORE';
234 local $SIG{QUIT} = 'IGNORE';
235 local $SIG{TERM} = 'IGNORE';
236 local $SIG{TSTP} = 'IGNORE';
237 local $SIG{PIPE} = 'IGNORE';
239 my $oldAutoCommit = $FS::UID::AutoCommit;
240 local $FS::UID::AutoCommit = 0;
243 if ( $new->svcpart != $old->svcpart ) {
244 my $svc_x = $new->svc_x;
245 my $new_svc_x = ref($svc_x)->new({$svc_x->hash, svcpart=>$new->svcpart });
246 local($FS::Record::nowarn_identical) = 1;
247 my $error = $new_svc_x->replace($svc_x);
249 $dbh->rollback if $oldAutoCommit;
250 return $error if $error;
254 # #trigger a re-export on pkgnum changes?
255 # # (of prepaid packages), for Expiration RADIUS attribute
256 # if ( $new->pkgnum != $old->pkgnum && $new->cust_pkg->part_pkg->is_prepaid ) {
257 # my $svc_x = $new->svc_x;
258 # local($FS::Record::nowarn_identical) = 1;
259 # my $error = $svc_x->export('replace');
261 # $dbh->rollback if $oldAutoCommit;
262 # return $error if $error;
266 #my $error = $new->SUPER::replace($old, @_);
267 my $error = $new->SUPER::replace($old);
269 $dbh->rollback if $oldAutoCommit;
270 return $error if $error;
273 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
280 Checks all fields to make sure this is a valid service. If there is an error,
281 returns the error, otherwise returns false. Called by the insert and
290 $self->ut_numbern('svcnum')
291 || $self->ut_numbern('pkgnum')
292 || $self->ut_number('svcpart')
293 || $self->ut_numbern('overlimit')
295 return $error if $error;
297 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
298 return "Unknown svcpart" unless $part_svc;
300 if ( $self->pkgnum ) {
301 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
302 return "Unknown pkgnum" unless $cust_pkg;
303 ($part_svc) = grep { $_->svcpart == $self->svcpart } $cust_pkg->part_svc;
304 return "No svcpart ". $self->svcpart.
305 " services in pkgpart ". $cust_pkg->pkgpart
307 return "Already ". $part_svc->get('num_cust_svc'). " ". $part_svc->svc.
308 " services for pkgnum ". $self->pkgnum
309 if $part_svc->get('num_avail') == 0 and !$ignore_quantity;
317 Returns the definition for this service, as a FS::part_svc object (see
325 ? $self->{'_svcpart'}
326 : qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
331 Returns the package this service belongs to, as a FS::cust_pkg object (see
338 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
343 Returns the pkg_svc record for for this service, if applicable.
349 my $cust_pkg = $self->cust_pkg;
350 return undef unless $cust_pkg;
352 qsearchs( 'pkg_svc', { 'svcpart' => $self->svcpart,
353 'pkgpart' => $cust_pkg->pkgpart,
360 Returns the date this service was inserted.
366 $self->h_date('insert');
371 Returns a list consisting of:
372 - The name of this service (from part_svc)
373 - A meaningful identifier (username, domain, or mail alias)
374 - The table name (i.e. svc_domain) for this service
379 my($label, $value, $svcdb) = $cust_svc->label;
383 Like the B<label> method, except the second item in the list ("meaningful
384 identifier") may be longer - typically, a full name is included.
388 sub label { shift->_label('svc_label', @_); }
389 sub label_long { shift->_label('svc_label_long', @_); }
394 my $svc_x = $self->svc_x
395 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
397 $self->$method($svc_x);
400 sub svc_label { shift->_svc_label('label', @_); }
401 sub svc_label_long { shift->_svc_label('label_long', @_); }
404 my( $self, $method, $svc_x ) = ( shift, shift, shift );
407 $self->part_svc->svc,
409 $self->part_svc->svcdb,
417 Returns a listref of html elements associated with this service's exports.
423 my $svc_x = $self->svc_x
424 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
426 $svc_x->export_links;
429 =item export_getsettings
431 Returns two hashrefs of settings associated with this service's exports.
435 sub export_getsettings {
437 my $svc_x = $self->svc_x
438 or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
440 $svc_x->export_getsettings;
446 Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or
447 FS::svc_domain object, etc.)
453 my $svcdb = $self->part_svc->svcdb;
454 if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
455 $self->{'_svc_acct'};
457 require "FS/$svcdb.pm";
458 warn "$me svc_x: part_svc.svcpart ". $self->part_svc->svcpart.
459 ", so searching for $svcdb.svcnum ". $self->svcnum. "\n"
461 qsearchs( $svcdb, { 'svcnum' => $self->svcnum } );
465 =item seconds_since TIMESTAMP
467 See L<FS::svc_acct/seconds_since>. Equivalent to
468 $cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records
469 where B<svcdb> is not "svc_acct".
473 #internal session db deprecated (or at least on hold)
474 sub seconds_since { 'internal session db deprecated'; };
475 ##note: implementation here, POD in FS::svc_acct
477 # my($self, $since) = @_;
479 # my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session
482 # AND logout IS NOT NULL'
483 # ) or die $dbh->errstr;
484 # $sth->execute($self->svcnum, $since) or die $sth->errstr;
485 # $sth->fetchrow_arrayref->[0];
488 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
490 See L<FS::svc_acct/seconds_since_sqlradacct>. Equivalent to
491 $cust_svc->svc_x->seconds_since_sqlradacct, but more efficient. Meaningless
492 for records where B<svcdb> is not "svc_acct".
496 #note: implementation here, POD in FS::svc_acct
497 sub seconds_since_sqlradacct {
498 my($self, $start, $end) = @_;
500 my $mes = "$me seconds_since_sqlradacct:";
502 my $svc_x = $self->svc_x;
504 my @part_export = $self->part_svc->part_export_usage;
505 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
506 " service definition"
511 foreach my $part_export ( @part_export ) {
513 next if $part_export->option('ignore_accounting');
515 warn "$mes connecting to sqlradius database\n"
518 my $dbh = DBI->connect( map { $part_export->option($_) }
519 qw(datasrc username password) )
520 or die "can't connect to sqlradius database: ". $DBI::errstr;
522 warn "$mes connected to sqlradius database\n"
525 #select a unix time conversion function based on database type
526 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
528 my $username = $part_export->export_username($svc_x);
532 warn "$mes finding closed sessions completely within the given range\n"
537 if ($part_export->option('process_single_realm')) {
538 $realm = 'AND Realm = ?';
539 $realmparam = $part_export->option('realm');
542 my $sth = $dbh->prepare("SELECT SUM(acctsessiontime)
546 AND $str2time AcctStartTime) >= ?
547 AND $str2time AcctStopTime ) < ?
548 AND $str2time AcctStopTime ) > 0
549 AND AcctStopTime IS NOT NULL"
550 ) or die $dbh->errstr;
551 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end)
553 my $regular = $sth->fetchrow_arrayref->[0];
555 warn "$mes finding open sessions which start in the range\n"
558 # count session start->range end
559 $query = "SELECT SUM( ? - $str2time AcctStartTime ) )
563 AND $str2time AcctStartTime ) >= ?
564 AND $str2time AcctStartTime ) < ?
565 AND ( ? - $str2time AcctStartTime ) ) < 86400
566 AND ( $str2time AcctStopTime ) = 0
567 OR AcctStopTime IS NULL )";
568 $sth = $dbh->prepare($query) or die $dbh->errstr;
571 ($realm ? $realmparam : ()),
575 or die $sth->errstr. " executing query $query";
576 my $start_during = $sth->fetchrow_arrayref->[0];
578 warn "$mes finding closed sessions which start before the range but stop during\n"
581 #count range start->session end
582 $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime ) - ? )
586 AND $str2time AcctStartTime ) < ?
587 AND $str2time AcctStopTime ) >= ?
588 AND $str2time AcctStopTime ) < ?
589 AND $str2time AcctStopTime ) > 0
590 AND AcctStopTime IS NOT NULL"
591 ) or die $dbh->errstr;
592 $sth->execute( $start,
594 ($realm ? $realmparam : ()),
599 my $end_during = $sth->fetchrow_arrayref->[0];
601 warn "$mes finding closed sessions which start before the range but stop after\n"
604 # count range start->range end
605 # don't count open sessions anymore (probably missing stop record)
606 $sth = $dbh->prepare("SELECT COUNT(*)
610 AND $str2time AcctStartTime ) < ?
611 AND ( $str2time AcctStopTime ) >= ?
613 # OR AcctStopTime = 0
614 # OR AcctStopTime IS NULL )"
615 ) or die $dbh->errstr;
616 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end )
618 my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0];
620 $seconds += $regular + $end_during + $start_during + $entire_range;
622 warn "$mes done finding sessions\n"
631 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
633 See L<FS::svc_acct/attribute_since_sqlradacct>. Equivalent to
634 $cust_svc->svc_x->attribute_since_sqlradacct, but more efficient. Meaningless
635 for records where B<svcdb> is not "svc_acct".
639 #note: implementation here, POD in FS::svc_acct
640 #(false laziness w/seconds_since_sqlradacct above)
641 sub attribute_since_sqlradacct {
642 my($self, $start, $end, $attrib) = @_;
644 my $mes = "$me attribute_since_sqlradacct:";
646 my $svc_x = $self->svc_x;
648 my @part_export = $self->part_svc->part_export_usage;
649 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
650 " service definition"
656 foreach my $part_export ( @part_export ) {
658 next if $part_export->option('ignore_accounting');
660 warn "$mes connecting to sqlradius database\n"
663 my $dbh = DBI->connect( map { $part_export->option($_) }
664 qw(datasrc username password) )
665 or die "can't connect to sqlradius database: ". $DBI::errstr;
667 warn "$mes connected to sqlradius database\n"
670 #select a unix time conversion function based on database type
671 my $str2time = str2time_sql( $dbh->{Driver}->{Name} );
673 my $username = $part_export->export_username($svc_x);
675 warn "$mes SUMing $attrib sessions\n"
680 if ($part_export->option('process_single_realm')) {
681 $realm = 'AND Realm = ?';
682 $realmparam = $part_export->option('realm');
685 my $sth = $dbh->prepare("SELECT SUM($attrib)
689 AND $str2time AcctStopTime ) >= ?
690 AND $str2time AcctStopTime ) < ?
691 AND AcctStopTime IS NOT NULL"
692 ) or die $dbh->errstr;
693 $sth->execute($username, ($realm ? $realmparam : ()), $start, $end)
696 my $row = $sth->fetchrow_arrayref;
697 $sum += $row->[0] if defined($row->[0]);
699 warn "$mes done SUMing sessions\n"
708 =item get_session_history TIMESTAMP_START TIMESTAMP_END
710 See L<FS::svc_acct/get_session_history>. Equivalent to
711 $cust_svc->svc_x->get_session_history, but more efficient. Meaningless for
712 records where B<svcdb> is not "svc_acct".
716 sub get_session_history {
717 my($self, $start, $end, $attrib) = @_;
721 my @part_export = $self->part_svc->part_export_usage;
722 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
723 " service definition"
729 foreach my $part_export ( @part_export ) {
731 @{ $part_export->usage_sessions( $start, $end, $self->svc_x ) };
742 Behaviour of changing the svcpart of cust_svc records is undefined and should
743 possibly be prohibited, and pkg_svc records are not checked.
745 pkg_svc records are not checked in general (here).
747 Deleting this record doesn't check or delete the svc_* record associated
750 In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of
751 a DBI database handle is not yet implemented.
755 L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,
756 schema.html from the base documentation