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;
300 cluck "warning: asked for label of unsupported svcdb; using svcnum";
301 $tag = $svc_x->getfield('svcnum');
303 $self->part_svc->svc, $tag, $svcdb;
308 Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or
309 FS::svc_domain object, etc.)
315 my $svcdb = $self->part_svc->svcdb;
316 if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) {
317 $self->{'_svc_acct'};
319 qsearchs( $svcdb, { 'svcnum' => $self->svcnum } );
323 =item seconds_since TIMESTAMP
325 See L<FS::svc_acct/seconds_since>. Equivalent to
326 $cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records
327 where B<svcdb> is not "svc_acct".
331 #note: implementation here, POD in FS::svc_acct
333 my($self, $since) = @_;
335 my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session
338 AND logout IS NOT NULL'
339 ) or die $dbh->errstr;
340 $sth->execute($self->svcnum, $since) or die $sth->errstr;
341 $sth->fetchrow_arrayref->[0];
344 =item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END
346 See L<FS::svc_acct/seconds_since_sqlradacct>. Equivalent to
347 $cust_svc->svc_x->seconds_since_sqlradacct, but more efficient. Meaningless
348 for records where B<svcdb> is not "svc_acct".
352 #note: implementation here, POD in FS::svc_acct
353 sub seconds_since_sqlradacct {
354 my($self, $start, $end) = @_;
356 my $username = $self->svc_x->username;
358 my @part_export = $self->part_svc->part_export('sqlradius')
359 or die "no sqlradius export configured for this service type";
363 foreach my $part_export ( @part_export ) {
365 my $dbh = DBI->connect( map { $part_export->option($_) }
366 qw(datasrc username password) )
367 or die "can't connect to sqlradius database: ". $DBI::errstr;
369 #select a unix time conversion function based on database type
371 if ( $dbh->{Driver}->{Name} eq 'mysql' ) {
372 $str2time = 'UNIX_TIMESTAMP(';
373 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
374 $str2time = 'EXTRACT( EPOCH FROM ';
376 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
377 "; guessing how to convert to UNIX timestamps";
378 $str2time = 'extract(epoch from ';
383 #find closed sessions completely within the given range
384 my $sth = $dbh->prepare("SELECT SUM(acctsessiontime)
387 AND $str2time AcctStartTime) >= ?
388 AND $str2time AcctStopTime ) < ?
389 AND $str2time AcctStopTime ) > 0
390 AND AcctStopTime IS NOT NULL"
391 ) or die $dbh->errstr;
392 $sth->execute($username, $start, $end) or die $sth->errstr;
393 my $regular = $sth->fetchrow_arrayref->[0];
395 #find open sessions which start in the range, count session start->range end
396 $query = "SELECT SUM( ? - $str2time AcctStartTime ) )
399 AND $str2time AcctStartTime ) >= ?
400 AND $str2time AcctStartTime ) < ?
401 AND ( ? - $str2time AcctStartTime ) ) < 86400
402 AND ( $str2time AcctStopTime ) = 0
403 OR AcctStopTime IS NULL )";
404 $sth = $dbh->prepare($query) or die $dbh->errstr;
405 $sth->execute($end, $username, $start, $end, $end)
406 or die $sth->errstr. " executing query $query";
407 my $start_during = $sth->fetchrow_arrayref->[0];
409 #find closed sessions which start before the range but stop during,
410 #count range start->session end
411 $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime ) - ? )
414 AND $str2time AcctStartTime ) < ?
415 AND $str2time AcctStopTime ) >= ?
416 AND $str2time AcctStopTime ) < ?
417 AND $str2time AcctStopTime ) > 0
418 AND AcctStopTime IS NOT NULL"
419 ) or die $dbh->errstr;
420 $sth->execute($start, $username, $start, $start, $end ) or die $sth->errstr;
421 my $end_during = $sth->fetchrow_arrayref->[0];
423 #find closed (not anymore - or open) sessions which start before the range
424 # but stop after, or are still open, count range start->range end
425 # don't count open sessions (probably missing stop record)
426 $sth = $dbh->prepare("SELECT COUNT(*)
429 AND $str2time AcctStartTime ) < ?
430 AND ( $str2time AcctStopTime ) >= ?
432 # OR AcctStopTime = 0
433 # OR AcctStopTime IS NULL )"
434 ) or die $dbh->errstr;
435 $sth->execute($username, $start, $end ) or die $sth->errstr;
436 my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0];
438 $seconds += $regular + $end_during + $start_during + $entire_range;
446 =item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE
448 See L<FS::svc_acct/attribute_since_sqlradacct>. Equivalent to
449 $cust_svc->svc_x->attribute_since_sqlradacct, but more efficient. Meaningless
450 for records where B<svcdb> is not "svc_acct".
454 #note: implementation here, POD in FS::svc_acct
455 #(false laziness w/seconds_since_sqlradacct above)
456 sub attribute_since_sqlradacct {
457 my($self, $start, $end, $attrib) = @_;
459 my $username = $self->svc_x->username;
461 my @part_export = $self->part_svc->part_export('sqlradius')
462 or die "no sqlradius export configured for this service type";
467 foreach my $part_export ( @part_export ) {
469 my $dbh = DBI->connect( map { $part_export->option($_) }
470 qw(datasrc username password) )
471 or die "can't connect to sqlradius database: ". $DBI::errstr;
473 #select a unix time conversion function based on database type
475 if ( $dbh->{Driver}->{Name} eq 'mysql' ) {
476 $str2time = 'UNIX_TIMESTAMP(';
477 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
478 $str2time = 'EXTRACT( EPOCH FROM ';
480 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
481 "; guessing how to convert to UNIX timestamps";
482 $str2time = 'extract(epoch from ';
485 my $sth = $dbh->prepare("SELECT SUM($attrib)
488 AND $str2time AcctStopTime ) >= ?
489 AND $str2time AcctStopTime ) < ?
490 AND AcctStopTime IS NOT NULL"
491 ) or die $dbh->errstr;
492 $sth->execute($username, $start, $end) or die $sth->errstr;
494 $sum += $sth->fetchrow_arrayref->[0];
502 =item get_session_history_sqlradacct TIMESTAMP_START TIMESTAMP_END
504 See L<FS::svc_acct/get_session_history_sqlradacct>. Equivalent to
505 $cust_svc->svc_x->get_session_history_sqlradacct, but more efficient.
506 Meaningless for records where B<svcdb> is not "svc_acct".
510 sub get_session_history {
511 my($self, $start, $end, $attrib) = @_;
513 my $username = $self->svc_x->username;
515 my @part_export = $self->part_svc->part_export('sqlradius')
516 or die "no sqlradius export configured for this service type";
521 foreach my $part_export ( @part_export ) {
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 #select a unix time conversion function based on database type
529 if ( $dbh->{Driver}->{Name} eq 'mysql' ) {
530 $str2time = 'UNIX_TIMESTAMP(';
531 } elsif ( $dbh->{Driver}->{Name} eq 'Pg' ) {
532 $str2time = 'EXTRACT( EPOCH FROM ';
534 warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
535 "; guessing how to convert to UNIX timestamps";
536 $str2time = 'extract(epoch from ';
539 my @fields = qw( acctstarttime acctstoptime acctsessiontime
540 acctinputoctets acctoutputoctets framedipaddress );
542 my $sth = $dbh->prepare('SELECT '. join(', ', @fields).
545 AND $str2time AcctStopTime ) >= ?
546 AND $str2time AcctStopTime ) <= ?
547 ORDER BY AcctStartTime DESC
548 ") or die $dbh->errstr;
549 $sth->execute($username, $start, $end) or die $sth->errstr;
551 push @sessions, map { { %$_ } } @{ $sth->fetchall_arrayref({}) };
562 Behaviour of changing the svcpart of cust_svc records is undefined and should
563 possibly be prohibited, and pkg_svc records are not checked.
565 pkg_svc records are not checked in general (here).
567 Deleting this record doesn't check or delete the svc_* record associated
570 In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of
571 a DBI database handle is not yet implemented.
575 L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,
576 schema.html from the base documentation