5 use FS::UID qw( getotaker dbh );
6 use FS::Record qw( qsearch qsearchs );
13 # need to 'use' these instead of 'require' in sub { cancel, suspend, unsuspend,
15 # because they load configuraion by setting FS::UID::callback (see TODO)
22 @ISA = qw( FS::Record );
26 my ( $hashref, $cache ) = @_;
27 #if ( $hashref->{'pkgpart'} ) {
28 if ( $hashref->{'pkg'} ) {
29 # #@{ $self->{'_pkgnum'} } = ();
30 # my $subcache = $cache->subcache('pkgpart', 'part_pkg');
31 # $self->{'_pkgpart'} = $subcache;
32 # #push @{ $self->{'_pkgnum'} },
33 # FS::part_pkg->new_or_cached($hashref, $subcache);
34 $self->{'_pkgpart'} = FS::part_pkg->new($hashref);
36 if ( exists $hashref->{'svcnum'} ) {
37 #@{ $self->{'_pkgnum'} } = ();
38 my $subcache = $cache->subcache('svcnum', 'cust_svc', $hashref->{pkgnum});
39 $self->{'_svcnum'} = $subcache;
40 #push @{ $self->{'_pkgnum'} },
41 FS::cust_svc->new_or_cached($hashref, $subcache) if $hashref->{svcnum};
47 FS::cust_pkg - Object methods for cust_pkg objects
53 $record = new FS::cust_pkg \%hash;
54 $record = new FS::cust_pkg { 'column' => 'value' };
56 $error = $record->insert;
58 $error = $new_record->replace($old_record);
60 $error = $record->delete;
62 $error = $record->check;
64 $error = $record->cancel;
66 $error = $record->suspend;
68 $error = $record->unsuspend;
70 $part_pkg = $record->part_pkg;
72 @labels = $record->labels;
74 $seconds = $record->seconds_since($timestamp);
76 $error = FS::cust_pkg::order( $custnum, \@pkgparts );
77 $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
81 An FS::cust_pkg object represents a customer billing item. FS::cust_pkg
82 inherits from FS::Record. The following fields are currently supported:
86 =item pkgnum - primary key (assigned automatically for new billing items)
88 =item custnum - Customer (see L<FS::cust_main>)
90 =item pkgpart - Billing item definition (see L<FS::part_pkg>)
102 =item otaker - order taker (assigned automatically if null, see L<FS::UID>)
104 =item manual_flag - If this field is set to 1, disables the automatic
105 unsuspension of this package when using the B<unsuspendauto> config file.
109 Note: setup, bill, susp, expire and cancel are specified as UNIX timestamps;
110 see L<perlfunc/"time">. Also see L<Time::Local> and L<Date::Parse> for
111 conversion functions.
119 Create a new billing item. To add the item to the database, see L<"insert">.
123 sub table { 'cust_pkg'; }
127 Adds this billing item to the database ("Orders" the item). If there is an
128 error, returns the error, otherwise returns false.
135 # custnum might not have have been defined in sub check (for one-shot new
136 # customers), so check it here instead
137 # (is this still necessary with transactions?)
139 my $error = $self->ut_number('custnum');
140 return $error if $error;
142 my $cust_main = $self->cust_main;
143 return "Unknown customer ". $self->custnum unless $cust_main;
145 my $agent = qsearchs( 'agent', { 'agentnum' => $cust_main->agentnum } );
146 my $pkgpart_href = $agent->pkgpart_hashref;
147 return "agent ". $agent->agentnum. " can't purchase pkgpart ". $self->pkgpart
148 unless $pkgpart_href->{ $self->pkgpart };
150 $self->SUPER::insert;
156 This method now works but you probably shouldn't use it.
158 You don't want to delete billing items, because there would then be no record
159 the customer ever purchased the item. Instead, see the cancel method.
164 # return "Can't delete cust_pkg records!";
167 =item replace OLD_RECORD
169 Replaces the OLD_RECORD with this one in the database. If there is an error,
170 returns the error, otherwise returns false.
172 Currently, custnum, setup, bill, susp, expire, and cancel may be changed.
174 Changing pkgpart may have disasterous effects. See the order subroutine.
176 setup and bill are normally updated by calling the bill method of a customer
177 object (see L<FS::cust_main>).
179 suspend is normally updated by the suspend and unsuspend methods.
181 cancel is normally updated by the cancel method (and also the order subroutine
187 my( $new, $old ) = ( shift, shift );
189 #return "Can't (yet?) change pkgpart!" if $old->pkgpart != $new->pkgpart;
190 return "Can't change otaker!" if $old->otaker ne $new->otaker;
193 #return "Can't change setup once it exists!"
194 # if $old->getfield('setup') &&
195 # $old->getfield('setup') != $new->getfield('setup');
197 #some logic for bill, susp, cancel?
199 $new->SUPER::replace($old);
204 Checks all fields to make sure this is a valid billing item. If there is an
205 error, returns the error, otherwise returns false. Called by the insert and
214 $self->ut_numbern('pkgnum')
215 || $self->ut_numbern('custnum')
216 || $self->ut_number('pkgpart')
217 || $self->ut_numbern('setup')
218 || $self->ut_numbern('bill')
219 || $self->ut_numbern('susp')
220 || $self->ut_numbern('cancel')
222 return $error if $error;
224 if ( $self->custnum ) {
225 return "Unknown customer ". $self->custnum unless $self->cust_main;
228 return "Unknown pkgpart: ". $self->pkgpart
229 unless qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
231 $self->otaker(getotaker) unless $self->otaker;
232 $self->otaker =~ /^([\w\.\-]{0,16})$/ or return "Illegal otaker";
235 if ( $self->dbdef_table->column('manual_flag') ) {
236 $self->manual_flag =~ /^([01]?)$/ or return "Illegal manual_flag";
237 $self->manual_flag($1);
245 Cancels and removes all services (see L<FS::cust_svc> and L<FS::part_svc>)
246 in this package, then cancels the package itself (sets the cancel field to
249 If there is an error, returns the error, otherwise returns false.
257 local $SIG{HUP} = 'IGNORE';
258 local $SIG{INT} = 'IGNORE';
259 local $SIG{QUIT} = 'IGNORE';
260 local $SIG{TERM} = 'IGNORE';
261 local $SIG{TSTP} = 'IGNORE';
262 local $SIG{PIPE} = 'IGNORE';
264 my $oldAutoCommit = $FS::UID::AutoCommit;
265 local $FS::UID::AutoCommit = 0;
268 foreach my $cust_svc (
269 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
271 my $error = $cust_svc->cancel;
274 $dbh->rollback if $oldAutoCommit;
275 return "Error cancelling cust_svc: $error";
280 unless ( $self->getfield('cancel') ) {
281 my %hash = $self->hash;
282 $hash{'cancel'} = time;
283 my $new = new FS::cust_pkg ( \%hash );
284 $error = $new->replace($self);
286 $dbh->rollback if $oldAutoCommit;
291 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
298 Suspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
299 package, then suspends the package itself (sets the susp field to now).
301 If there is an error, returns the error, otherwise returns false.
309 local $SIG{HUP} = 'IGNORE';
310 local $SIG{INT} = 'IGNORE';
311 local $SIG{QUIT} = 'IGNORE';
312 local $SIG{TERM} = 'IGNORE';
313 local $SIG{TSTP} = 'IGNORE';
314 local $SIG{PIPE} = 'IGNORE';
316 my $oldAutoCommit = $FS::UID::AutoCommit;
317 local $FS::UID::AutoCommit = 0;
320 foreach my $cust_svc (
321 qsearch( 'cust_svc', { 'pkgnum' => $self->pkgnum } )
323 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
325 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
326 $dbh->rollback if $oldAutoCommit;
327 return "Illegal svcdb value in part_svc!";
330 require "FS/$svcdb.pm";
332 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
334 $error = $svc->suspend;
336 $dbh->rollback if $oldAutoCommit;
343 unless ( $self->getfield('susp') ) {
344 my %hash = $self->hash;
345 $hash{'susp'} = time;
346 my $new = new FS::cust_pkg ( \%hash );
347 $error = $new->replace($self);
349 $dbh->rollback if $oldAutoCommit;
354 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
361 Unsuspends all services (see L<FS::cust_svc> and L<FS::part_svc>) in this
362 package, then unsuspends the package itself (clears the susp field).
364 If there is an error, returns the error, otherwise returns false.
372 local $SIG{HUP} = 'IGNORE';
373 local $SIG{INT} = 'IGNORE';
374 local $SIG{QUIT} = 'IGNORE';
375 local $SIG{TERM} = 'IGNORE';
376 local $SIG{TSTP} = 'IGNORE';
377 local $SIG{PIPE} = 'IGNORE';
379 my $oldAutoCommit = $FS::UID::AutoCommit;
380 local $FS::UID::AutoCommit = 0;
383 foreach my $cust_svc (
384 qsearch('cust_svc',{'pkgnum'=> $self->pkgnum } )
386 my $part_svc = qsearchs( 'part_svc', { 'svcpart' => $cust_svc->svcpart } );
388 $part_svc->svcdb =~ /^([\w\-]+)$/ or do {
389 $dbh->rollback if $oldAutoCommit;
390 return "Illegal svcdb value in part_svc!";
393 require "FS/$svcdb.pm";
395 my $svc = qsearchs( $svcdb, { 'svcnum' => $cust_svc->svcnum } );
397 $error = $svc->unsuspend;
399 $dbh->rollback if $oldAutoCommit;
406 unless ( ! $self->getfield('susp') ) {
407 my %hash = $self->hash;
409 my $new = new FS::cust_pkg ( \%hash );
410 $error = $new->replace($self);
412 $dbh->rollback if $oldAutoCommit;
417 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
424 Returns the definition for this billing item, as an FS::part_pkg object (see
431 #exists( $self->{'_pkgpart'} )
433 ? $self->{'_pkgpart'}
434 : qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
439 Returns the services for this package, as FS::cust_svc objects (see
446 if ( $self->{'_svcnum'} ) {
447 values %{ $self->{'_svcnum'}->cache };
449 qsearch ( 'cust_svc', { 'pkgnum' => $self->pkgnum } );
455 Returns a list of lists, calling the label method for all services
456 (see L<FS::cust_svc>) of this billing item.
462 map { [ $_->label ] } $self->cust_svc;
467 Returns the parent customer object (see L<FS::cust_main>).
473 qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
476 =item seconds_since TIMESTAMP
478 Returns the number of seconds all accounts (see L<FS::svc_acct>) in this
479 package have been online since TIMESTAMP.
481 TIMESTAMP is specified as a UNIX timestamp; see L<perlfunc/"time">. Also see
482 L<Time::Local> and L<Date::Parse> for conversion functions.
487 my($self, $since) = @_;
490 foreach my $cust_svc (
491 grep { $_->part_svc->svcdb eq 'svc_acct' } $self->cust_svc
493 $seconds += $cust_svc->seconds_since($since);
506 =item order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ] ]
508 CUSTNUM is a customer (see L<FS::cust_main>)
510 PKGPARTS is a list of pkgparts specifying the the billing item definitions (see
511 L<FS::part_pkg>) to order for this customer. Duplicates are of course
514 REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to
515 remove for this customer. The services (see L<FS::cust_svc>) are moved to the
516 new billing items. An error is returned if this is not possible (see
517 L<FS::pkg_svc>). An empty arrayref is equivalent to not specifying this
520 RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the
521 newly-created cust_pkg objects.
526 my($custnum, $pkgparts, $remove_pkgnums, $return_cust_pkg) = @_;
527 $remove_pkgnums = [] unless defined($remove_pkgnums);
529 my $oldAutoCommit = $FS::UID::AutoCommit;
530 local $FS::UID::AutoCommit = 0;
534 # $part_pkg{$pkgpart} is true iff $custnum may purchase $pkgpart
536 my($cust_main)=qsearchs('cust_main',{'custnum'=>$custnum});
537 my($agent)=qsearchs('agent',{'agentnum'=> $cust_main->agentnum });
538 my %part_pkg = %{ $agent->pkgpart_hashref };
542 # for those packages being removed:
543 #@{ $svcnum{$svcpart} } goes from a svcpart to a list of FS::cust_svc objects
545 foreach $pkgnum ( @{$remove_pkgnums} ) {
546 foreach my $cust_svc (qsearch('cust_svc',{'pkgnum'=>$pkgnum})) {
547 push @{ $svcnum{$cust_svc->getfield('svcpart')} }, $cust_svc;
553 # for those packages the customer is purchasing:
554 # @{$pkgparts} is a list of said packages, by pkgpart
555 # @cust_svc is a corresponding list of lists of FS::Record objects
556 foreach my $pkgpart ( @{$pkgparts} ) {
557 unless ( $part_pkg{$pkgpart} ) {
558 $dbh->rollback if $oldAutoCommit;
559 return "Customer not permitted to purchase pkgpart $pkgpart!";
563 ( $svcnum{$_} && @{ $svcnum{$_} } ) ? shift @{ $svcnum{$_} } : ();
564 } map { $_->svcpart }
565 qsearch('pkg_svc', { pkgpart => $pkgpart,
566 quantity => { op=>'>', value=>'0', } } )
570 #special-case until this can be handled better
571 # move services to new svcparts - even if the svcparts don't match (svcdb
573 # looks like they're moved in no particular order, ewwwwwwww
574 # and looks like just one of each svcpart can be moved... o well
576 #start with still-leftover services
577 #foreach my $svcpart ( grep { scalar(@{ $svcnum{$_} }) } keys %svcnum ) {
578 foreach my $svcpart ( keys %svcnum ) {
579 next unless @{ $svcnum{$svcpart} };
581 my $svcdb = $svcnum{$svcpart}->[0]->part_svc->svcdb;
583 #find an empty place to put one
585 foreach my $pkgpart ( @{$pkgparts} ) {
587 qsearch('pkg_svc', { pkgpart => $pkgpart,
588 quantity => { op=>'>', value=>'0', } } );
590 # grep { $_->quantity > 0 } qsearch('pkg_svc', { pkgpart=>$pkgpart } );
591 if ( ! @{$cust_svc[$i]} #find an empty place to put them with
592 && grep { $svcdb eq $_->part_svc->svcdb } #with appropriate svcdb
596 ( grep { $svcdb eq $_->part_svc->svcdb } @pkg_svc )[0]->svcpart;
597 my $cust_svc = shift @{$svcnum{$svcpart}};
598 $cust_svc->svcpart($new_svcpart);
599 #warn "changing from $svcpart to $new_svcpart!!!\n";
600 $cust_svc[$i] = [ $cust_svc ];
607 #check for leftover services
608 foreach (keys %svcnum) {
609 next unless @{ $svcnum{$_} };
610 $dbh->rollback if $oldAutoCommit;
611 return "Leftover services, svcpart $_: svcnum ".
612 join(', ', map { $_->svcnum } @{ $svcnum{$_} } );
615 #no leftover services, let's make changes.
617 local $SIG{HUP} = 'IGNORE';
618 local $SIG{INT} = 'IGNORE';
619 local $SIG{QUIT} = 'IGNORE';
620 local $SIG{TERM} = 'IGNORE';
621 local $SIG{TSTP} = 'IGNORE';
622 local $SIG{PIPE} = 'IGNORE';
624 #first cancel old packages
625 foreach my $pkgnum ( @{$remove_pkgnums} ) {
626 my($old) = qsearchs('cust_pkg',{'pkgnum'=>$pkgnum});
628 $dbh->rollback if $oldAutoCommit;
629 return "Package $pkgnum not found to remove!";
631 my(%hash) = $old->hash;
632 $hash{'cancel'}=time;
633 my($new) = new FS::cust_pkg ( \%hash );
634 my($error)=$new->replace($old);
636 $dbh->rollback if $oldAutoCommit;
637 return "Couldn't update package $pkgnum: $error";
641 #now add new packages, changing cust_svc records if necessary
643 while ($pkgpart=shift @{$pkgparts} ) {
645 my $new = new FS::cust_pkg {
646 'custnum' => $custnum,
647 'pkgpart' => $pkgpart,
649 my $error = $new->insert;
651 $dbh->rollback if $oldAutoCommit;
652 return "Couldn't insert new cust_pkg record: $error";
654 push @{$return_cust_pkg}, $new if $return_cust_pkg;
655 my $pkgnum = $new->pkgnum;
657 foreach my $cust_svc ( @{ shift @cust_svc } ) {
658 my(%hash) = $cust_svc->hash;
659 $hash{'pkgnum'}=$pkgnum;
660 my $new = new FS::cust_svc ( \%hash );
662 #avoid Record diffing missing changed svcpart field from above.
663 my $old = qsearchs('cust_svc', { 'svcnum' => $cust_svc->svcnum } );
665 my $error = $new->replace($old);
667 $dbh->rollback if $oldAutoCommit;
668 return "Couldn't link old service to new package: $error";
673 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
682 $Id: cust_pkg.pm,v 1.23 2002-08-26 20:40:55 ivan Exp $
686 sub order is not OO. Perhaps it should be moved to FS::cust_main and made so?
688 In sub order, the @pkgparts array (passed by reference) is clobbered.
690 Also in sub order, no money is adjusted. Once FS::part_pkg defines a standard
691 method to pass dates to the recur_prog expression, it should do so.
693 FS::svc_acct, FS::svc_acct_sm, and FS::svc_domain are loaded via 'use' at
694 compile time, rather than via 'require' in sub { setup, suspend, unsuspend,
695 cancel } because they use %FS::UID::callback to load configuration values.
696 Probably need a subroutine which decides what to do based on whether or not
697 we've fetched the user yet, rather than a hash. See FS::UID and the TODO.
699 Now that things are transactional should the check in the insert method be
704 L<FS::Record>, L<FS::cust_main>, L<FS::part_pkg>, L<FS::cust_svc>,
705 L<FS::pkg_svc>, schema.html from the base documentation