4 use vars qw( @ISA $DEBUG $ignore_quantity );
5 use Carp qw( carp cluck );
7 use FS::Record qw( qsearch qsearchs dbh );
15 use FS::svc_broadband;
17 use FS::domain_record;
20 @ISA = qw( FS::Record );
28 my ( $hashref, $cache ) = @_;
29 if ( $hashref->{'username'} ) {
30 $self->{'_svc_acct'} = FS::svc_acct->new($hashref, '');
32 if ( $hashref->{'svc'} ) {
33 $self->{'_svcpart'} = FS::part_svc->new($hashref);
39 FS::cust_svc - Object method for cust_svc objects
45 $record = new FS::cust_svc \%hash
46 $record = new FS::cust_svc { 'column' => 'value' };
48 $error = $record->insert;
50 $error = $new_record->replace($old_record);
52 $error = $record->delete;
54 $error = $record->check;
56 ($label, $value) = $record->label;
60 An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record.
61 The following fields are currently supported:
65 =item svcnum - primary key (assigned automatically for new services)
67 =item pkgnum - Package (see L<FS::cust_pkg>)
69 =item svcpart - Service definition (see L<FS::part_svc>)
79 Creates a new service. To add the refund to the database, see L<"insert">.
80 Services are normally created by creating FS::svc_ objects (see
81 L<FS::svc_acct>, L<FS::svc_domain>, and L<FS::svc_forward>, among others).
85 sub table { 'cust_svc'; }
89 Adds this service to the database. If there is an error, returns the error,
90 otherwise returns false.
94 Deletes this service from the database. If there is an error, returns the
95 error, otherwise returns false. Note that this only removes the cust_svc
96 record - you should probably use the B<cancel> method instead.
100 Cancels the relevant service by calling the B<cancel> method of the associated
101 FS::svc_XXX object (i.e. an FS::svc_acct object or FS::svc_domain object),
102 deleting the FS::svc_XXX record and then deleting this record.
104 If there is an error, returns the error, otherwise returns false.
111 local $SIG{HUP} = 'IGNORE';
112 local $SIG{INT} = 'IGNORE';
113 local $SIG{QUIT} = 'IGNORE';
114 local $SIG{TERM} = 'IGNORE';
115 local $SIG{TSTP} = 'IGNORE';
116 local $SIG{PIPE} = 'IGNORE';
118 my $oldAutoCommit = $FS::UID::AutoCommit;
119 local $FS::UID::AutoCommit = 0;
122 my $part_svc = $self->part_svc;
124 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
125 $dbh->rollback if $oldAutoCommit;
126 return "Illegal svcdb value in part_svc!";
129 require "FS/$svcdb.pm";
131 my $svc = $self->svc_x;
133 my $error = $svc->cancel;
135 $dbh->rollback if $oldAutoCommit;
136 return "Error canceling service: $error";
138 $error = $svc->delete;
140 $dbh->rollback if $oldAutoCommit;
141 return "Error deleting service: $error";
145 my $error = $self->delete;
147 $dbh->rollback if $oldAutoCommit;
148 return "Error deleting cust_svc: $error";
151 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
157 =item replace OLD_RECORD
159 Replaces the OLD_RECORD with this one in the database. If there is an error,
160 returns the error, otherwise returns false.
165 my ( $new, $old ) = ( shift, shift );
167 local $SIG{HUP} = 'IGNORE';
168 local $SIG{INT} = 'IGNORE';
169 local $SIG{QUIT} = 'IGNORE';
170 local $SIG{TERM} = 'IGNORE';
171 local $SIG{TSTP} = 'IGNORE';
172 local $SIG{PIPE} = 'IGNORE';
174 my $oldAutoCommit = $FS::UID::AutoCommit;
175 local $FS::UID::AutoCommit = 0;
178 if ( $new->svcpart != $old->svcpart ) {
179 my $svc_x = $new->svc_x;
180 my $new_svc_x = ref($svc_x)->new({$svc_x->hash, svcpart=>$new->svcpart });
181 local($FS::Record::nowarn_identical) = 1;
182 my $error = $new_svc_x->replace($svc_x);
184 $dbh->rollback if $oldAutoCommit;
185 return $error if $error;
189 my $error = $new->SUPER::replace($old);
191 $dbh->rollback if $oldAutoCommit;
192 return $error if $error;
195 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
202 Checks all fields to make sure this is a valid service. If there is an error,
203 returns the error, otherwise returns false. Called by the insert and
212 $self->ut_numbern('svcnum')
213 || $self->ut_numbern('pkgnum')
214 || $self->ut_number('svcpart')
216 return $error if $error;
218 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
219 return "Unknown svcpart" unless $part_svc;
221 if ( $self->pkgnum ) {
222 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
223 return "Unknown pkgnum" unless $cust_pkg;
224 my $pkg_svc = qsearchs( 'pkg_svc', {
225 'pkgpart' => $cust_pkg->pkgpart,
226 'svcpart' => $self->svcpart,
228 # or new FS::pkg_svc ( { 'pkgpart' => $cust_pkg->pkgpart,
229 # 'svcpart' => $self->svcpart,
230 # 'quantity' => 0 } );
231 my $quantity = $pkg_svc ? $pkg_svc->quantity : 0;
233 my @cust_svc = qsearch('cust_svc', {
234 'pkgnum' => $self->pkgnum,
235 'svcpart' => $self->svcpart,
237 return "Already ". scalar(@cust_svc). " ". $part_svc->svc.
238 " services for pkgnum ". $self->pkgnum
239 if scalar(@cust_svc) >= $quantity && !$ignore_quantity;
247 Returns the definition for this service, as a FS::part_svc object (see
255 ? $self->{'_svcpart'}
256 : qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
261 Returns the package this service belongs to, as a FS::cust_pkg object (see
268 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
273 Returns a list consisting of:
274 - The name of this service (from part_svc)
275 - A meaningful identifier (username, domain, or mail alias)
276 - The table name (i.e. svc_domain) for this service
283 carp "FS::cust_svc::label called on $self" if $DEBUG;
284 my $svc_x = $self->svc_x
285 or die "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum;
286 $self->_svc_label($svc_x);
290 my( $self, $svc_x ) = ( shift, shift );
291 my $svcdb = $self->part_svc->svcdb;
294 if ( $svcdb eq 'svc_acct' ) {
295 $tag = $svc_x->email(@_);
296 } elsif ( $svcdb eq 'svc_forward' ) {
297 if ( $svc_x->srcsvc ) {
298 my $svc_acct = $svc_x->srcsvc_acct(@_);
299 $tag = $svc_acct->email(@_);
304 if ( $svc_x->dstsvc ) {
305 my $svc_acct = $svc_x->dstsvc_acct(@_);
306 $tag .= $svc_acct->email(@_);
310 } elsif ( $svcdb eq 'svc_domain' ) {
311 $tag = $svc_x->getfield('domain');
312 } elsif ( $svcdb eq 'svc_www' ) {
313 my $domain_record = $svc_x->domain_record(@_);
314 $tag = $domain_record->zone;
315 } elsif ( $svcdb eq 'svc_broadband' ) {
316 $tag = $svc_x->ip_addr;
317 } elsif ( $svcdb eq 'svc_external' ) {
318 my $conf = new FS::Conf;
319 if ( $conf->config('svc_external-display_type') eq 'artera_turbo' ) {
320 $tag = sprintf('%010d', $svc_x->id). '-'.
321 substr('0000000000'.uc($svc_x->title), -10);
323 $tag = $svc_x->id. ': '. $svc_x->title;
326 cluck "warning: asked for label of unsupported svcdb; using svcnum";
327 $tag = $svc_x->getfield('svcnum');
330 $self->part_svc->svc, $tag, $svcdb, $self->svcnum;
336 Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or
337 FS::svc_domain object, etc.)
343 my $svcdb = $self->part_svc->svcdb;
344 if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
345 $self->{'_svc_acct'};
347 #require "FS/$svcdb.pm";
348 qsearchs( $svcdb, { 'svcnum' => $self->svcnum } );
352 =item seconds_since TIMESTAMP
354 See L<FS::svc_acct/seconds_since>. Equivalent to
355 $cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records
356 where B<svcdb> is not "svc_acct".
360 #note: implementation here, POD in FS::svc_acct
362 my($self, $since) = @_;
364 my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session
367 AND logout IS NOT NULL'
368 ) or die $dbh->errstr;
369 $sth->execute($self->svcnum, $since) or die $sth->errstr;
370 $sth->fetchrow_arrayref->[0];
373 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
375 See L<FS::svc_acct/seconds_since_sqlradacct>. Equivalent to
376 $cust_svc->svc_x->seconds_since_sqlradacct, but more efficient. Meaningless
377 for records where B<svcdb> is not "svc_acct".
381 #note: implementation here, POD in FS::svc_acct
382 sub seconds_since_sqlradacct {
383 my($self, $start, $end) = @_;
385 my $svc_x = $self->svc_x;
387 my @part_export = $self->part_svc->part_export_usage;
388 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
389 " service definition"
394 foreach my $part_export ( @part_export ) {
396 next if $part_export->option('ignore_accounting');
398 my $dbh = DBI->connect( map { $part_export->option($_) }
399 qw(datasrc username password) )
400 or die "can't connect to sqlradius database: ". $DBI::errstr;
402 #select a unix time conversion function based on database type
404 if ( $dbh->{Driver}->{Name} =~ /^mysql(PP)?$/ ) {
405 $str2time = 'UNIX_TIMESTAMP(';
406 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
407 $str2time = 'EXTRACT( EPOCH FROM ';
409 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
410 "; guessing how to convert to UNIX timestamps";
411 $str2time = 'extract(epoch from ';
414 my $username = $part_export->export_username($svc_x);
418 #find closed sessions completely within the given range
419 my $sth = $dbh->prepare("SELECT SUM(acctsessiontime)
422 AND $str2time AcctStartTime) >= ?
423 AND $str2time AcctStopTime ) < ?
424 AND $str2time AcctStopTime ) > 0
425 AND AcctStopTime IS NOT NULL"
426 ) or die $dbh->errstr;
427 $sth->execute($username, $start, $end) or die $sth->errstr;
428 my $regular = $sth->fetchrow_arrayref->[0];
430 #find open sessions which start in the range, count session start->range end
431 $query = "SELECT SUM( ? - $str2time AcctStartTime ) )
434 AND $str2time AcctStartTime ) >= ?
435 AND $str2time AcctStartTime ) < ?
436 AND ( ? - $str2time AcctStartTime ) ) < 86400
437 AND ( $str2time AcctStopTime ) = 0
438 OR AcctStopTime IS NULL )";
439 $sth = $dbh->prepare($query) or die $dbh->errstr;
440 $sth->execute($end, $username, $start, $end, $end)
441 or die $sth->errstr. " executing query $query";
442 my $start_during = $sth->fetchrow_arrayref->[0];
444 #find closed sessions which start before the range but stop during,
445 #count range start->session end
446 $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime ) - ? )
449 AND $str2time AcctStartTime ) < ?
450 AND $str2time AcctStopTime ) >= ?
451 AND $str2time AcctStopTime ) < ?
452 AND $str2time AcctStopTime ) > 0
453 AND AcctStopTime IS NOT NULL"
454 ) or die $dbh->errstr;
455 $sth->execute($start, $username, $start, $start, $end ) or die $sth->errstr;
456 my $end_during = $sth->fetchrow_arrayref->[0];
458 #find closed (not anymore - or open) sessions which start before the range
459 # but stop after, or are still open, count range start->range end
460 # don't count open sessions (probably missing stop record)
461 $sth = $dbh->prepare("SELECT COUNT(*)
464 AND $str2time AcctStartTime ) < ?
465 AND ( $str2time AcctStopTime ) >= ?
467 # OR AcctStopTime = 0
468 # OR AcctStopTime IS NULL )"
469 ) or die $dbh->errstr;
470 $sth->execute($username, $start, $end ) or die $sth->errstr;
471 my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0];
473 $seconds += $regular + $end_during + $start_during + $entire_range;
481 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
483 See L<FS::svc_acct/attribute_since_sqlradacct>. Equivalent to
484 $cust_svc->svc_x->attribute_since_sqlradacct, but more efficient. Meaningless
485 for records where B<svcdb> is not "svc_acct".
489 #note: implementation here, POD in FS::svc_acct
490 #(false laziness w/seconds_since_sqlradacct above)
491 sub attribute_since_sqlradacct {
492 my($self, $start, $end, $attrib) = @_;
494 my $svc_x = $self->svc_x;
496 my @part_export = $self->part_svc->part_export_usage;
497 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
498 " service definition"
504 foreach my $part_export ( @part_export ) {
506 next if $part_export->option('ignore_accounting');
508 my $dbh = DBI->connect( map { $part_export->option($_) }
509 qw(datasrc username password) )
510 or die "can't connect to sqlradius database: ". $DBI::errstr;
512 #select a unix time conversion function based on database type
514 if ( $dbh->{Driver}->{Name} =~ /^mysql(PP)?$/ ) {
515 $str2time = 'UNIX_TIMESTAMP(';
516 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
517 $str2time = 'EXTRACT( EPOCH FROM ';
519 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
520 "; guessing how to convert to UNIX timestamps";
521 $str2time = 'extract(epoch from ';
524 my $username = $part_export->export_username($svc_x);
526 my $sth = $dbh->prepare("SELECT SUM($attrib)
529 AND $str2time AcctStopTime ) >= ?
530 AND $str2time AcctStopTime ) < ?
531 AND AcctStopTime IS NOT NULL"
532 ) or die $dbh->errstr;
533 $sth->execute($username, $start, $end) or die $sth->errstr;
535 $sum += $sth->fetchrow_arrayref->[0];
543 =item get_session_history TIMESTAMP_START TIMESTAMP_END
545 See L<FS::svc_acct/get_session_history>. Equivalent to
546 $cust_svc->svc_x->get_session_history, but more efficient. Meaningless for
547 records where B<svcdb> is not "svc_acct".
551 sub get_session_history {
552 my($self, $start, $end, $attrib) = @_;
556 my @part_export = $self->part_svc->part_export_usage;
557 die "no accounting-capable exports are enabled for ". $self->part_svc->svc.
558 " service definition"
564 foreach my $part_export ( @part_export ) {
566 @{ $part_export->usage_sessions( $start, $end, $self->svc_x ) };
575 Returns the pkg_svc record for for this service, if applicable.
581 my $cust_pkg = $self->cust_pkg;
582 return undef unless $cust_pkg;
584 qsearchs( 'pkg_svc', { 'svcpart' => $self->svcpart,
585 'pkgpart' => $cust_pkg->pkgpart,
594 Behaviour of changing the svcpart of cust_svc records is undefined and should
595 possibly be prohibited, and pkg_svc records are not checked.
597 pkg_svc records are not checked in general (here).
599 Deleting this record doesn't check or delete the svc_* record associated
602 In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of
603 a DBI database handle is not yet implemented.
607 L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,
608 schema.html from the base documentation