4 use vars qw( @ISA $ignore_quantity );
6 use FS::Record qw( qsearch qsearchs dbh );
14 use FS::svc_broadband;
15 use FS::domain_record;
18 @ISA = qw( FS::Record );
24 my ( $hashref, $cache ) = @_;
25 if ( $hashref->{'username'} ) {
26 $self->{'_svc_acct'} = FS::svc_acct->new($hashref, '');
28 if ( $hashref->{'svc'} ) {
29 $self->{'_svcpart'} = FS::part_svc->new($hashref);
35 FS::cust_svc - Object method for cust_svc objects
41 $record = new FS::cust_svc \%hash
42 $record = new FS::cust_svc { 'column' => 'value' };
44 $error = $record->insert;
46 $error = $new_record->replace($old_record);
48 $error = $record->delete;
50 $error = $record->check;
52 ($label, $value) = $record->label;
56 An FS::cust_svc represents a service. FS::cust_svc inherits from FS::Record.
57 The following fields are currently supported:
61 =item svcnum - primary key (assigned automatically for new services)
63 =item pkgnum - Package (see L<FS::cust_pkg>)
65 =item svcpart - Service definition (see L<FS::part_svc>)
75 Creates a new service. To add the refund to the database, see L<"insert">.
76 Services are normally created by creating FS::svc_ objects (see
77 L<FS::svc_acct>, L<FS::svc_domain>, and L<FS::svc_forward>, among others).
81 sub table { 'cust_svc'; }
85 Adds this service to the database. If there is an error, returns the error,
86 otherwise returns false.
90 Deletes this service from the database. If there is an error, returns the
91 error, otherwise returns false. Note that this only removes the cust_svc
92 record - you should probably use the B<cancel> method instead.
96 Cancels the relevant service by calling the B<cancel> method of the associated
97 FS::svc_XXX object (i.e. an FS::svc_acct object or FS::svc_domain object),
98 deleting the FS::svc_XXX record and then deleting this record.
100 If there is an error, returns the error, otherwise returns false.
107 local $SIG{HUP} = 'IGNORE';
108 local $SIG{INT} = 'IGNORE';
109 local $SIG{QUIT} = 'IGNORE';
110 local $SIG{TERM} = 'IGNORE';
111 local $SIG{TSTP} = 'IGNORE';
112 local $SIG{PIPE} = 'IGNORE';
114 my $oldAutoCommit = $FS::UID::AutoCommit;
115 local $FS::UID::AutoCommit = 0;
118 my $part_svc = $self->part_svc;
120 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
121 $dbh->rollback if $oldAutoCommit;
122 return "Illegal svcdb value in part_svc!";
125 require "FS/$svcdb.pm";
127 my $svc = $self->svc_x;
129 my $error = $svc->cancel;
131 $dbh->rollback if $oldAutoCommit;
132 return "Error canceling service: $error";
134 $error = $svc->delete;
136 $dbh->rollback if $oldAutoCommit;
137 return "Error deleting service: $error";
141 my $error = $self->delete;
143 $dbh->rollback if $oldAutoCommit;
144 return "Error deleting cust_svc: $error";
147 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
153 =item replace OLD_RECORD
155 Replaces the OLD_RECORD with this one in the database. If there is an error,
156 returns the error, otherwise returns false.
161 my ( $new, $old ) = ( shift, shift );
163 local $SIG{HUP} = 'IGNORE';
164 local $SIG{INT} = 'IGNORE';
165 local $SIG{QUIT} = 'IGNORE';
166 local $SIG{TERM} = 'IGNORE';
167 local $SIG{TSTP} = 'IGNORE';
168 local $SIG{PIPE} = 'IGNORE';
170 my $oldAutoCommit = $FS::UID::AutoCommit;
171 local $FS::UID::AutoCommit = 0;
174 my $error = $new->SUPER::replace($old);
176 $dbh->rollback if $oldAutoCommit;
177 return $error if $error;
180 if ( $new->svcpart != $old->svcpart ) {
181 my $svc_x = $new->svc_x;
182 my $new_svc_x = ref($svc_x)->new({$svc_x->hash});
183 my $error = $new_svc_x->replace($svc_x);
185 $dbh->rollback if $oldAutoCommit;
186 return $error if $error;
190 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
197 Checks all fields to make sure this is a valid service. If there is an error,
198 returns the error, otehrwise returns false. Called by the insert and
207 $self->ut_numbern('svcnum')
208 || $self->ut_numbern('pkgnum')
209 || $self->ut_number('svcpart')
211 return $error if $error;
213 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
214 return "Unknown svcpart" unless $part_svc;
216 if ( $self->pkgnum ) {
217 my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
218 return "Unknown pkgnum" unless $cust_pkg;
219 my $pkg_svc = qsearchs( 'pkg_svc', {
220 'pkgpart' => $cust_pkg->pkgpart,
221 'svcpart' => $self->svcpart,
223 # or new FS::pkg_svc ( { 'pkgpart' => $cust_pkg->pkgpart,
224 # 'svcpart' => $self->svcpart,
225 # 'quantity' => 0 } );
226 my $quantity = $pkg_svc ? $pkg_svc->quantity : 0;
228 my @cust_svc = qsearch('cust_svc', {
229 'pkgnum' => $self->pkgnum,
230 'svcpart' => $self->svcpart,
232 return "Already ". scalar(@cust_svc). " ". $part_svc->svc.
233 " services for pkgnum ". $self->pkgnum
234 if scalar(@cust_svc) >= $quantity && !$ignore_quantity;
242 Returns the definition for this service, as a FS::part_svc object (see
250 ? $self->{'_svcpart'}
251 : qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } );
256 Returns the definition for this service, as a FS::part_svc object (see
263 qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } );
268 Returns a list consisting of:
269 - The name of this service (from part_svc)
270 - A meaningful identifier (username, domain, or mail alias)
271 - The table name (i.e. svc_domain) for this service
277 my $svcdb = $self->part_svc->svcdb;
278 my $svc_x = $self->svc_x
279 or die "can't find $svcdb.svcnum ". $self->svcnum;
281 if ( $svcdb eq 'svc_acct' ) {
282 $tag = $svc_x->email;
283 } elsif ( $svcdb eq 'svc_forward' ) {
284 my $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $svc_x->srcsvc } );
285 $tag = $svc_acct->email. '->';
286 if ( $svc_x->dstsvc ) {
287 $svc_acct = qsearchs( 'svc_acct', { 'svcnum' => $svc_x->dstsvc } );
288 $tag .= $svc_acct->email;
292 } elsif ( $svcdb eq 'svc_domain' ) {
293 $tag = $svc_x->getfield('domain');
294 } elsif ( $svcdb eq 'svc_www' ) {
295 my $domain = qsearchs( 'domain_record', { 'recnum' => $svc_x->recnum } );
296 $tag = $domain->zone;
297 } elsif ( $svcdb eq 'svc_broadband' ) {
298 $tag = $svc_x->ip_addr;
299 } elsif ( $svcdb eq 'svc_external' ) {
300 $tag = $svc_x->id. ': '. $svc_x->title;
302 cluck "warning: asked for label of unsupported svcdb; using svcnum";
303 $tag = $svc_x->getfield('svcnum');
305 $self->part_svc->svc, $tag, $svcdb;
310 Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or
311 FS::svc_domain object, etc.)
317 my $svcdb = $self->part_svc->svcdb;
318 if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
319 $self->{'_svc_acct'};
321 qsearchs( $svcdb, { 'svcnum' => $self->svcnum } );
325 =item seconds_since TIMESTAMP
327 See L<FS::svc_acct/seconds_since>. Equivalent to
328 $cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records
329 where B<svcdb> is not "svc_acct".
333 #note: implementation here, POD in FS::svc_acct
335 my($self, $since) = @_;
337 my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session
340 AND logout IS NOT NULL'
341 ) or die $dbh->errstr;
342 $sth->execute($self->svcnum, $since) or die $sth->errstr;
343 $sth->fetchrow_arrayref->[0];
346 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
348 See L<FS::svc_acct/seconds_since_sqlradacct>. Equivalent to
349 $cust_svc->svc_x->seconds_since_sqlradacct, but more efficient. Meaningless
350 for records where B<svcdb> is not "svc_acct".
354 #note: implementation here, POD in FS::svc_acct
355 sub seconds_since_sqlradacct {
356 my($self, $start, $end) = @_;
358 my $svc_x = $self->svc_x;
360 my @part_export = $self->part_svc->part_export('sqlradius');
361 push @part_export, $self->part_svc->part_export('sqlradius_withdomain');
362 die "no sqlradius or sqlradius_withdomain export configured for this".
368 foreach my $part_export ( @part_export ) {
370 next if $part_export->option('ignore_accounting');
372 my $dbh = DBI->connect( map { $part_export->option($_) }
373 qw(datasrc username password) )
374 or die "can't connect to sqlradius database: ". $DBI::errstr;
376 #select a unix time conversion function based on database type
378 if ( $dbh->{Driver}->{Name} eq 'mysql' ) {
379 $str2time = 'UNIX_TIMESTAMP(';
380 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
381 $str2time = 'EXTRACT( EPOCH FROM ';
383 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
384 "; guessing how to convert to UNIX timestamps";
385 $str2time = 'extract(epoch from ';
389 if ( $part_export->exporttype eq 'sqlradius' ) {
390 $username = $svc_x->username;
391 } elsif ( $part_export->exporttype eq 'sqlradius_withdomain' ) {
392 $username = $svc_x->email;
394 die 'unknown exporttype '. $part_export->exporttype;
399 #find closed sessions completely within the given range
400 my $sth = $dbh->prepare("SELECT SUM(acctsessiontime)
403 AND $str2time AcctStartTime) >= ?
404 AND $str2time AcctStopTime ) < ?
405 AND $str2time AcctStopTime ) > 0
406 AND AcctStopTime IS NOT NULL"
407 ) or die $dbh->errstr;
408 $sth->execute($username, $start, $end) or die $sth->errstr;
409 my $regular = $sth->fetchrow_arrayref->[0];
411 #find open sessions which start in the range, count session start->range end
412 $query = "SELECT SUM( ? - $str2time AcctStartTime ) )
415 AND $str2time AcctStartTime ) >= ?
416 AND $str2time AcctStartTime ) < ?
417 AND ( ? - $str2time AcctStartTime ) ) < 86400
418 AND ( $str2time AcctStopTime ) = 0
419 OR AcctStopTime IS NULL )";
420 $sth = $dbh->prepare($query) or die $dbh->errstr;
421 $sth->execute($end, $username, $start, $end, $end)
422 or die $sth->errstr. " executing query $query";
423 my $start_during = $sth->fetchrow_arrayref->[0];
425 #find closed sessions which start before the range but stop during,
426 #count range start->session end
427 $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime ) - ? )
430 AND $str2time AcctStartTime ) < ?
431 AND $str2time AcctStopTime ) >= ?
432 AND $str2time AcctStopTime ) < ?
433 AND $str2time AcctStopTime ) > 0
434 AND AcctStopTime IS NOT NULL"
435 ) or die $dbh->errstr;
436 $sth->execute($start, $username, $start, $start, $end ) or die $sth->errstr;
437 my $end_during = $sth->fetchrow_arrayref->[0];
439 #find closed (not anymore - or open) sessions which start before the range
440 # but stop after, or are still open, count range start->range end
441 # don't count open sessions (probably missing stop record)
442 $sth = $dbh->prepare("SELECT COUNT(*)
445 AND $str2time AcctStartTime ) < ?
446 AND ( $str2time AcctStopTime ) >= ?
448 # OR AcctStopTime = 0
449 # OR AcctStopTime IS NULL )"
450 ) or die $dbh->errstr;
451 $sth->execute($username, $start, $end ) or die $sth->errstr;
452 my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0];
454 $seconds += $regular + $end_during + $start_during + $entire_range;
462 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
464 See L<FS::svc_acct/attribute_since_sqlradacct>. Equivalent to
465 $cust_svc->svc_x->attribute_since_sqlradacct, but more efficient. Meaningless
466 for records where B<svcdb> is not "svc_acct".
470 #note: implementation here, POD in FS::svc_acct
471 #(false laziness w/seconds_since_sqlradacct above)
472 sub attribute_since_sqlradacct {
473 my($self, $start, $end, $attrib) = @_;
475 my $svc_x = $self->svc_x;
477 my @part_export = $self->part_svc->part_export('sqlradius');
478 push @part_export, $self->part_svc->part_export('sqlradius_withdomain');
479 die "no sqlradius or sqlradius_withdomain export configured for this".
486 foreach my $part_export ( @part_export ) {
488 next if $part_export->option('ignore_accounting');
490 my $dbh = DBI->connect( map { $part_export->option($_) }
491 qw(datasrc username password) )
492 or die "can't connect to sqlradius database: ". $DBI::errstr;
494 #select a unix time conversion function based on database type
496 if ( $dbh->{Driver}->{Name} eq 'mysql' ) {
497 $str2time = 'UNIX_TIMESTAMP(';
498 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
499 $str2time = 'EXTRACT( EPOCH FROM ';
501 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
502 "; guessing how to convert to UNIX timestamps";
503 $str2time = 'extract(epoch from ';
507 if ( $part_export->exporttype eq 'sqlradius' ) {
508 $username = $svc_x->username;
509 } elsif ( $part_export->exporttype eq 'sqlradius_withdomain' ) {
510 $username = $svc_x->email;
512 die 'unknown exporttype '. $part_export->exporttype;
515 my $sth = $dbh->prepare("SELECT SUM($attrib)
518 AND $str2time AcctStopTime ) >= ?
519 AND $str2time AcctStopTime ) < ?
520 AND AcctStopTime IS NOT NULL"
521 ) or die $dbh->errstr;
522 $sth->execute($username, $start, $end) or die $sth->errstr;
524 $sum += $sth->fetchrow_arrayref->[0];
532 =item get_session_history_sqlradacct TIMESTAMP_START TIMESTAMP_END
534 See L<FS::svc_acct/get_session_history_sqlradacct>. Equivalent to
535 $cust_svc->svc_x->get_session_history_sqlradacct, but more efficient.
536 Meaningless for records where B<svcdb> is not "svc_acct".
540 sub get_session_history {
541 my($self, $start, $end, $attrib) = @_;
543 my $username = $self->svc_x->username;
545 my @part_export = $self->part_svc->part_export('sqlradius')
546 or die "no sqlradius export configured for this service type";
551 foreach my $part_export ( @part_export ) {
553 my $dbh = DBI->connect( map { $part_export->option($_) }
554 qw(datasrc username password) )
555 or die "can't connect to sqlradius database: ". $DBI::errstr;
557 #select a unix time conversion function based on database type
559 if ( $dbh->{Driver}->{Name} eq 'mysql' ) {
560 $str2time = 'UNIX_TIMESTAMP(';
561 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
562 $str2time = 'EXTRACT( EPOCH FROM ';
564 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
565 "; guessing how to convert to UNIX timestamps";
566 $str2time = 'extract(epoch from ';
569 my @fields = qw( acctstarttime acctstoptime acctsessiontime
570 acctinputoctets acctoutputoctets framedipaddress );
572 my $sth = $dbh->prepare('SELECT '. join(', ', @fields).
575 AND $str2time AcctStopTime ) >= ?
576 AND $str2time AcctStopTime ) <= ?
577 ORDER BY AcctStartTime DESC
578 ") or die $dbh->errstr;
579 $sth->execute($username, $start, $end) or die $sth->errstr;
581 push @sessions, map { { %$_ } } @{ $sth->fetchall_arrayref({}) };
592 Behaviour of changing the svcpart of cust_svc records is undefined and should
593 possibly be prohibited, and pkg_svc records are not checked.
595 pkg_svc records are not checked in general (here).
597 Deleting this record doesn't check or delete the svc_* record associated
600 In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of
601 a DBI database handle is not yet implemented.
605 L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,
606 schema.html from the base documentation