diff options
Diffstat (limited to 'FS/FS/cust_svc.pm')
| -rw-r--r-- | FS/FS/cust_svc.pm | 774 | 
1 files changed, 774 insertions, 0 deletions
| diff --git a/FS/FS/cust_svc.pm b/FS/FS/cust_svc.pm new file mode 100644 index 000000000..3c2820412 --- /dev/null +++ b/FS/FS/cust_svc.pm @@ -0,0 +1,774 @@ +package FS::cust_svc; + +use strict; +use vars qw( @ISA $DEBUG $me $ignore_quantity ); +use Carp; +#use Scalar::Util qw( blessed ); +use FS::Conf; +use FS::Record qw( qsearch qsearchs dbh str2time_sql ); +use FS::cust_pkg; +use FS::part_pkg; +use FS::part_svc; +use FS::pkg_svc; +use FS::domain_record; +use FS::part_export; +use FS::cdr; + +#most FS::svc_ classes are autoloaded in svc_x emthod +use FS::svc_acct;  #this one is used in the cache stuff + +@ISA = qw( FS::cust_main_Mixin FS::option_Common ); #FS::Record ); + +$DEBUG = 0; +$me = '[cust_svc]'; + +$ignore_quantity = 0; + +sub _cache { +  my $self = shift; +  my ( $hashref, $cache ) = @_; +  if ( $hashref->{'username'} ) { +    $self->{'_svc_acct'} = FS::svc_acct->new($hashref, ''); +  } +  if ( $hashref->{'svc'} ) { +    $self->{'_svcpart'} = FS::part_svc->new($hashref); +  } +} + +=head1 NAME + +FS::cust_svc - Object method for cust_svc objects + +=head1 SYNOPSIS + +  use FS::cust_svc; + +  $record = new FS::cust_svc \%hash +  $record = new FS::cust_svc { 'column' => 'value' }; + +  $error = $record->insert; + +  $error = $new_record->replace($old_record); + +  $error = $record->delete; + +  $error = $record->check; + +  ($label, $value) = $record->label; + +=head1 DESCRIPTION + +An FS::cust_svc represents a service.  FS::cust_svc inherits from FS::Record. +The following fields are currently supported: + +=over 4 + +=item svcnum - primary key (assigned automatically for new services) + +=item pkgnum - Package (see L<FS::cust_pkg>) + +=item svcpart - Service definition (see L<FS::part_svc>) + +=item overlimit - date the service exceeded its usage limit + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new service.  To add the refund to the database, see L<"insert">. +Services are normally created by creating FS::svc_ objects (see +L<FS::svc_acct>, L<FS::svc_domain>, and L<FS::svc_forward>, among others). + +=cut + +sub table { 'cust_svc'; } + +=item insert + +Adds this service to the database.  If there is an error, returns the error, +otherwise returns false. + +=item delete + +Deletes this service from the database.  If there is an error, returns the +error, otherwise returns false.  Note that this only removes the cust_svc +record - you should probably use the B<cancel> method instead. + +=item cancel + +Cancels the relevant service by calling the B<cancel> method of the associated +FS::svc_XXX object (i.e. an FS::svc_acct object or FS::svc_domain object), +deleting the FS::svc_XXX record and then deleting this record. + +If there is an error, returns the error, otherwise returns false. + +=cut + +sub cancel { +  my $self = shift; + +  local $SIG{HUP} = 'IGNORE'; +  local $SIG{INT} = 'IGNORE'; +  local $SIG{QUIT} = 'IGNORE';  +  local $SIG{TERM} = 'IGNORE'; +  local $SIG{TSTP} = 'IGNORE'; +  local $SIG{PIPE} = 'IGNORE'; + +  my $oldAutoCommit = $FS::UID::AutoCommit; +  local $FS::UID::AutoCommit = 0; +  my $dbh = dbh; + +  my $part_svc = $self->part_svc; + +  $part_svc->svcdb =~ /^([\w\-]+)$/ or do { +    $dbh->rollback if $oldAutoCommit; +    return "Illegal svcdb value in part_svc!"; +  }; +  my $svcdb = $1; +  require "FS/$svcdb.pm"; + +  my $svc = $self->svc_x; +  if ($svc) { + +    my $error = $svc->cancel; +    if ( $error ) { +      $dbh->rollback if $oldAutoCommit; +      return "Error canceling service: $error"; +    } +    $error = $svc->delete; #this deletes this cust_svc record as well +    if ( $error ) { +      $dbh->rollback if $oldAutoCommit; +      return "Error deleting service: $error"; +    } + +  } else { + +    #huh? +    warn "WARNING: no svc_ record found for svcnum ". $self->svcnum. +         "; deleting cust_svc only\n";  + +    my $error = $self->delete; +    if ( $error ) { +      $dbh->rollback if $oldAutoCommit; +      return "Error deleting cust_svc: $error"; +    } + +  } + +  $dbh->commit or die $dbh->errstr if $oldAutoCommit; + +  ''; #no errors + +} + +=item overlimit [ ACTION ] + +Retrieves or sets the overlimit date.  If ACTION is absent, return +the present value of overlimit.  If ACTION is present, it can +have the value 'suspend' or 'unsuspend'.  In the case of 'suspend' overlimit +is set to the current time if it is not already set.  The 'unsuspend' value +causes the time to be cleared.   + +If there is an error on setting, returns the error, otherwise returns false. + +=cut + +sub overlimit { +  my $self = shift; +  my $action = shift or return $self->getfield('overlimit'); + +  local $SIG{HUP} = 'IGNORE'; +  local $SIG{INT} = 'IGNORE'; +  local $SIG{QUIT} = 'IGNORE';  +  local $SIG{TERM} = 'IGNORE'; +  local $SIG{TSTP} = 'IGNORE'; +  local $SIG{PIPE} = 'IGNORE'; + +  my $oldAutoCommit = $FS::UID::AutoCommit; +  local $FS::UID::AutoCommit = 0; +  my $dbh = dbh; + +  if ( $action eq 'suspend' ) { +    $self->setfield('overlimit', time) unless $self->getfield('overlimit'); +  }elsif ( $action eq 'unsuspend' ) { +    $self->setfield('overlimit', ''); +  }else{ +    die "unexpected action value: $action"; +  } + +  local $ignore_quantity = 1; +  my $error = $self->replace; +  if ( $error ) { +    $dbh->rollback if $oldAutoCommit; +    return "Error setting overlimit: $error"; +  } + +  $dbh->commit or die $dbh->errstr if $oldAutoCommit; + +  ''; #no errors + +} + +=item replace OLD_RECORD + +Replaces the OLD_RECORD with this one in the database.  If there is an error, +returns the error, otherwise returns false. + +=cut + +sub replace { +#  my $new = shift; +# +#  my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') ) +#              ? shift +#              : $new->replace_old; +  my ( $new, $old ) = ( shift, shift ); +  $old = $new->replace_old unless defined($old); + +  local $SIG{HUP} = 'IGNORE'; +  local $SIG{INT} = 'IGNORE'; +  local $SIG{QUIT} = 'IGNORE'; +  local $SIG{TERM} = 'IGNORE'; +  local $SIG{TSTP} = 'IGNORE'; +  local $SIG{PIPE} = 'IGNORE'; + +  my $oldAutoCommit = $FS::UID::AutoCommit; +  local $FS::UID::AutoCommit = 0; +  my $dbh = dbh; + +  if ( $new->svcpart != $old->svcpart ) { +    my $svc_x = $new->svc_x; +    my $new_svc_x = ref($svc_x)->new({$svc_x->hash, svcpart=>$new->svcpart }); +    local($FS::Record::nowarn_identical) = 1; +    my $error = $new_svc_x->replace($svc_x); +    if ( $error ) { +      $dbh->rollback if $oldAutoCommit; +      return $error if $error; +    } +  } + +  #my $error = $new->SUPER::replace($old, @_); +  my $error = $new->SUPER::replace($old); +  if ( $error ) { +    $dbh->rollback if $oldAutoCommit; +    return $error if $error; +  } + +  $dbh->commit or die $dbh->errstr if $oldAutoCommit; +  ''; #no error + +} + +=item check + +Checks all fields to make sure this is a valid service.  If there is an error, +returns the error, otherwise returns false.  Called by the insert and +replace methods. + +=cut + +sub check { +  my $self = shift; + +  my $error = +    $self->ut_numbern('svcnum') +    || $self->ut_numbern('pkgnum') +    || $self->ut_number('svcpart') +    || $self->ut_numbern('overlimit') +  ; +  return $error if $error; + +  my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } ); +  return "Unknown svcpart" unless $part_svc; + +  if ( $self->pkgnum ) { +    my $cust_pkg = qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } ); +    return "Unknown pkgnum" unless $cust_pkg; +    my $pkg_svc = qsearchs( 'pkg_svc', { +      'pkgpart' => $cust_pkg->pkgpart, +      'svcpart' => $self->svcpart, +    }); +    # or new FS::pkg_svc ( { 'pkgpart'  => $cust_pkg->pkgpart, +    #                        'svcpart'  => $self->svcpart, +    #                        'quantity' => 0                   } ); +    my $quantity = $pkg_svc ? $pkg_svc->quantity : 0; + +    my @cust_svc = qsearch('cust_svc', { +      'pkgnum'  => $self->pkgnum, +      'svcpart' => $self->svcpart, +    }); +    return "Already ". scalar(@cust_svc). " ". $part_svc->svc. +           " services for pkgnum ". $self->pkgnum +      if scalar(@cust_svc) >= $quantity && !$ignore_quantity; +  } + +  $self->SUPER::check; +} + +=item part_svc + +Returns the definition for this service, as a FS::part_svc object (see +L<FS::part_svc>). + +=cut + +sub part_svc { +  my $self = shift; +  $self->{'_svcpart'} +    ? $self->{'_svcpart'} +    : qsearchs( 'part_svc', { 'svcpart' => $self->svcpart } ); +} + +=item cust_pkg + +Returns the package this service belongs to, as a FS::cust_pkg object (see +L<FS::cust_pkg>). + +=cut + +sub cust_pkg { +  my $self = shift; +  qsearchs( 'cust_pkg', { 'pkgnum' => $self->pkgnum } ); +} + +=item pkg_svc + +Returns the pkg_svc record for for this service, if applicable. + +=cut + +sub pkg_svc { +  my $self = shift; +  my $cust_pkg = $self->cust_pkg; +  return undef unless $cust_pkg; + +  qsearchs( 'pkg_svc', { 'svcpart' => $self->svcpart, +                         'pkgpart' => $cust_pkg->pkgpart, +                       } +          ); +} + +=item date_inserted + +Returns the date this service was inserted. + +=cut + +sub date_inserted { +  my $self = shift; +  $self->h_date('insert'); +} + +=item label + +Returns a list consisting of: +- The name of this service (from part_svc) +- A meaningful identifier (username, domain, or mail alias) +- The table name (i.e. svc_domain) for this service +- svcnum + +Usage example: + +  my($label, $value, $svcdb) = $cust_svc->label; + +=item label_long + +Like the B<label> method, except the second item in the list ("meaningful +identifier") may be longer - typically, a full name is included. + +=cut + +sub label      { shift->_label('svc_label',      @_); } +sub label_long { shift->_label('svc_label_long', @_); } + +sub _label { +  my $self = shift; +  my $method = shift; +  my $svc_x = $self->svc_x +    or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum; + +  $self->$method($svc_x); +} + +sub svc_label      { shift->_svc_label('label',      @_); } +sub svc_label_long { shift->_svc_label('label_long', @_); } + +sub _svc_label { +  my( $self, $method, $svc_x ) = ( shift, shift, shift ); + +  ( +    $self->part_svc->svc, +    $svc_x->$method(@_), +    $self->part_svc->svcdb, +    $self->svcnum +  ); + +} + +=item export_links + +Returns a list of html elements associated with this services exports. + +=cut + +sub export_links { +  my $self = shift; +  my $svc_x = $self->svc_x +    or return "can't find ". $self->part_svc->svcdb. '.svcnum '. $self->svcnum; + +  $svc_x->export_links; +} + +=item svc_x + +Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or +FS::svc_domain object, etc.) + +=cut + +sub svc_x { +  my $self = shift; +  my $svcdb = $self->part_svc->svcdb; +  if ( $svcdb eq 'svc_acct' && $self->{'_svc_acct'} ) { +    $self->{'_svc_acct'}; +  } else { +    require "FS/$svcdb.pm"; +    warn "$me svc_x: part_svc.svcpart ". $self->part_svc->svcpart. +         ", so searching for $svcdb.svcnum ". $self->svcnum. "\n" +      if $DEBUG; +    qsearchs( $svcdb, { 'svcnum' => $self->svcnum } ); +  } +} + +=item seconds_since TIMESTAMP + +See L<FS::svc_acct/seconds_since>.  Equivalent to +$cust_svc->svc_x->seconds_since, but more efficient.  Meaningless for records +where B<svcdb> is not "svc_acct". + +=cut + +#note: implementation here, POD in FS::svc_acct +sub seconds_since { +  my($self, $since) = @_; +  my $dbh = dbh; +  my $sth = $dbh->prepare(' SELECT SUM(logout-login) FROM session +                              WHERE svcnum = ? +                                AND login >= ? +                                AND logout IS NOT NULL' +  ) or die $dbh->errstr; +  $sth->execute($self->svcnum, $since) or die $sth->errstr; +  $sth->fetchrow_arrayref->[0]; +} + +=item seconds_since_sqlradacct TIMESTAMP_START TIMESTAMP_END + +See L<FS::svc_acct/seconds_since_sqlradacct>.  Equivalent to +$cust_svc->svc_x->seconds_since_sqlradacct, but more efficient.  Meaningless +for records where B<svcdb> is not "svc_acct". + +=cut + +#note: implementation here, POD in FS::svc_acct +sub seconds_since_sqlradacct { +  my($self, $start, $end) = @_; + +  my $mes = "$me seconds_since_sqlradacct:"; + +  my $svc_x = $self->svc_x; + +  my @part_export = $self->part_svc->part_export_usage; +  die "no accounting-capable exports are enabled for ". $self->part_svc->svc. +      " service definition" +    unless @part_export; +    #or return undef; + +  my $seconds = 0; +  foreach my $part_export ( @part_export ) { + +    next if $part_export->option('ignore_accounting'); + +    warn "$mes connecting to sqlradius database\n" +      if $DEBUG; + +    my $dbh = DBI->connect( map { $part_export->option($_) } +                            qw(datasrc username password)    ) +      or die "can't connect to sqlradius database: ". $DBI::errstr; + +    warn "$mes connected to sqlradius database\n" +      if $DEBUG; + +    #select a unix time conversion function based on database type +    my $str2time = str2time_sql( $dbh->{Driver}->{Name} ); +     +    my $username = $part_export->export_username($svc_x); + +    my $query; + +    warn "$mes finding closed sessions completely within the given range\n" +      if $DEBUG; +   +    my $sth = $dbh->prepare("SELECT SUM(acctsessiontime) +                               FROM radacct +                               WHERE UserName = ? +                                 AND $str2time AcctStartTime) >= ? +                                 AND $str2time AcctStopTime ) <  ? +                                 AND $str2time AcctStopTime ) > 0 +                                 AND AcctStopTime IS NOT NULL" +    ) or die $dbh->errstr; +    $sth->execute($username, $start, $end) or die $sth->errstr; +    my $regular = $sth->fetchrow_arrayref->[0]; +   +    warn "$mes finding open sessions which start in the range\n" +      if $DEBUG; + +    # count session start->range end +    $query = "SELECT SUM( ? - $str2time AcctStartTime ) ) +                FROM radacct +                WHERE UserName = ? +                  AND $str2time AcctStartTime ) >= ? +                  AND $str2time AcctStartTime ) <  ? +                  AND ( ? - $str2time AcctStartTime ) ) < 86400 +                  AND (    $str2time AcctStopTime ) = 0 +                                    OR AcctStopTime IS NULL )"; +    $sth = $dbh->prepare($query) or die $dbh->errstr; +    $sth->execute($end, $username, $start, $end, $end) +      or die $sth->errstr. " executing query $query"; +    my $start_during = $sth->fetchrow_arrayref->[0]; +   +    warn "$mes finding closed sessions which start before the range but stop during\n" +      if $DEBUG; + +    #count range start->session end +    $sth = $dbh->prepare("SELECT SUM( $str2time AcctStopTime ) - ? )  +                            FROM radacct +                            WHERE UserName = ? +                              AND $str2time AcctStartTime ) < ? +                              AND $str2time AcctStopTime  ) >= ? +                              AND $str2time AcctStopTime  ) <  ? +                              AND $str2time AcctStopTime ) > 0 +                              AND AcctStopTime IS NOT NULL" +    ) or die $dbh->errstr; +    $sth->execute($start, $username, $start, $start, $end ) or die $sth->errstr; +    my $end_during = $sth->fetchrow_arrayref->[0]; +   +    warn "$mes finding closed sessions which start before the range but stop after\n" +      if $DEBUG; + +    # count range start->range end +    # don't count open sessions anymore (probably missing stop record) +    $sth = $dbh->prepare("SELECT COUNT(*) +                            FROM radacct +                            WHERE UserName = ? +                              AND $str2time AcctStartTime ) < ? +                              AND ( $str2time AcctStopTime ) >= ? +                                                                  )" +                              #      OR AcctStopTime =  0 +                              #      OR AcctStopTime IS NULL       )" +    ) or die $dbh->errstr; +    $sth->execute($username, $start, $end ) or die $sth->errstr; +    my $entire_range = ($end-$start) * $sth->fetchrow_arrayref->[0]; + +    $seconds += $regular + $end_during + $start_during + $entire_range; + +    warn "$mes done finding sessions\n" +      if $DEBUG; + +  } + +  $seconds; + +} + +=item attribute_since_sqlradacct TIMESTAMP_START TIMESTAMP_END ATTRIBUTE + +See L<FS::svc_acct/attribute_since_sqlradacct>.  Equivalent to +$cust_svc->svc_x->attribute_since_sqlradacct, but more efficient.  Meaningless +for records where B<svcdb> is not "svc_acct". + +=cut + +#note: implementation here, POD in FS::svc_acct +#(false laziness w/seconds_since_sqlradacct above) +sub attribute_since_sqlradacct { +  my($self, $start, $end, $attrib) = @_; + +  my $mes = "$me attribute_since_sqlradacct:"; + +  my $svc_x = $self->svc_x; + +  my @part_export = $self->part_svc->part_export_usage; +  die "no accounting-capable exports are enabled for ". $self->part_svc->svc. +      " service definition" +    unless @part_export; +    #or return undef; + +  my $sum = 0; + +  foreach my $part_export ( @part_export ) { + +    next if $part_export->option('ignore_accounting'); + +    warn "$mes connecting to sqlradius database\n" +      if $DEBUG; + +    my $dbh = DBI->connect( map { $part_export->option($_) } +                            qw(datasrc username password)    ) +      or die "can't connect to sqlradius database: ". $DBI::errstr; + +    warn "$mes connected to sqlradius database\n" +      if $DEBUG; + +    #select a unix time conversion function based on database type +    my $str2time = str2time_sql( $dbh->{Driver}->{Name} ); + +    my $username = $part_export->export_username($svc_x); + +    warn "$mes SUMing $attrib sessions\n" +      if $DEBUG; + +    my $sth = $dbh->prepare("SELECT SUM($attrib) +                               FROM radacct +                               WHERE UserName = ? +                                 AND $str2time AcctStopTime ) >= ? +                                 AND $str2time AcctStopTime ) <  ? +                                 AND AcctStopTime IS NOT NULL" +    ) or die $dbh->errstr; +    $sth->execute($username, $start, $end) or die $sth->errstr; + +    my $row = $sth->fetchrow_arrayref; +    $sum += $row->[0] if defined($row->[0]); + +    warn "$mes done SUMing sessions\n" +      if $DEBUG; + +  } + +  $sum; + +} + +=item get_session_history TIMESTAMP_START TIMESTAMP_END + +See L<FS::svc_acct/get_session_history>.  Equivalent to +$cust_svc->svc_x->get_session_history, but more efficient.  Meaningless for +records where B<svcdb> is not "svc_acct". + +=cut + +sub get_session_history { +  my($self, $start, $end, $attrib) = @_; + +  #$attrib ??? + +  my @part_export = $self->part_svc->part_export_usage; +  die "no accounting-capable exports are enabled for ". $self->part_svc->svc. +      " service definition" +    unless @part_export; +    #or return undef; +                      +  my @sessions = (); + +  foreach my $part_export ( @part_export ) { +    push @sessions, +      @{ $part_export->usage_sessions( $start, $end, $self->svc_x ) }; +  } + +  @sessions; + +} + +=item get_cdrs_for_update + +Returns (and SELECTs "FOR UPDATE") all unprocessed (freesidestatus NULL) CDR +objects (see L<FS::cdr>) associated with this service. + +CDRs are associated with svc_phone services via svc_phone.phonenum + +=cut + +sub get_cdrs_for_update { +  my $self = shift; +  $self->get_cdrs( 'freesidestatus' => '', +                   'for_update'     => 1, +                   @_, +                 ); +} + +sub get_cdrs { +  my($self, %options) = @_; + +  my @fields = ( 'charged_party' ); +  push @fields, 'src' unless $options{'disable_src'}; + +  my $for_update = $options{'for_update'} ? 'FOR UPDATE' : ''; + +  my %hash = (); +  $hash{'freesidestatus'} = $options{'freesidestatus'} +    if exists($options{'freesidestatus'}); + +  #CDRs are associated with svc_phone services via svc_phone.phonenum + +  #return () unless $self->svc_x->isa('FS::svc_phone'); +  return () unless $self->part_svc->svcdb eq 'svc_phone'; +  my $number = $self->svc_x->phonenum; + +  my $prefix = $options{'default_prefix'}; + +  my @orwhere =  map " $_ = '$number'        ", @fields; +  push @orwhere, map " $_ = '$prefix$number' ", @fields +    if length($prefix); +  if ( $prefix =~ /^\+(\d+)$/ ) { +    push @orwhere, map " $_ = '$1$number' ", @fields +  } + +  my @where = ( ' ( '. join(' OR ', @orwhere ). ' ) ' ); + +  if ( $options{'begin'} ) { +    push @where, 'startdate >= '. $options{'begin'}; +  } +  if ( $options{'end'} ) { +    push @where, 'startdate < '.  $options{'end'}; +  } + +  my $extra_sql = ( keys(%hash) ? ' AND ' : ' WHERE ' ). join(' AND ', @where ); + +  my @cdrs = +    qsearch( { +      'table'      => 'cdr', +      'hashref'    => \%hash, +      'extra_sql'  => $extra_sql, +      'order_by'   => "ORDER BY startdate $for_update", +    } ); + +  @cdrs; +} + +=back + +=head1 BUGS + +Behaviour of changing the svcpart of cust_svc records is undefined and should +possibly be prohibited, and pkg_svc records are not checked. + +pkg_svc records are not checked in general (here). + +Deleting this record doesn't check or delete the svc_* record associated +with this record. + +In seconds_since_sqlradacct, specifying a DATASRC/USERNAME/PASSWORD instead of +a DBI database handle is not yet implemented. + +=head1 SEE ALSO + +L<FS::Record>, L<FS::cust_pkg>, L<FS::part_svc>, L<FS::pkg_svc>,  +schema.html from the base documentation + +=cut + +1; + | 
