freeside/FS/FS part_pkg_option.pm,NONE,1.1 part_pkg.pm,1.25,1.26 Record.pm,1.89,1.90 cust_main.pm,1.162,1.163 part_export.pm,1.96,1.97 cust_pkg.pm,1.47,1.48 CGI.pm,1.26,1.27 Conf.pm,1.107,1.108

ivan ivan at pouncequick.420.am
Tue Oct 26 04:26:36 PDT 2004


Update of /home/cvs/cvsroot/freeside/FS/FS
In directory pouncequick:/tmp/cvs-serv3074/FS/FS

Modified Files:
	part_pkg.pm Record.pm cust_main.pm part_export.pm cust_pkg.pm 
	CGI.pm Conf.pm 
Added Files:
	part_pkg_option.pm 
Log Message:
modular price plans!

--- NEW FILE: part_pkg_option.pm ---
package FS::part_pkg_option;

use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs );
use FS::part_pkg;

@ISA = qw(FS::Record);

=head1 NAME

FS::part_pkg_option - Object methods for part_pkg_option records

=head1 SYNOPSIS

  use FS::part_pkg_option;

  $record = new FS::part_pkg_option \%hash;
  $record = new FS::part_pkg_option { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_pkg_option object represents an package definition option.
FS::part_pkg_option inherits from FS::Record.  The following fields are
currently supported:

=over 4

=item optionnum - primary key

=item pkgpart - package definition (see L<FS::part_pkg>)

=item optionname - option name

=item optionvalue - option value

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new package definition option.  To add the package definition option
to the database, see L<"insert">.

Note that this stores the hash reference, not a distinct copy of the hash it
points to.  You can ask the object for a copy with the I<hash> method.

=cut

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'part_pkg_option'; }

=item insert

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=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

# the replace method can be inherited from FS::Record

=item check

Checks all fields to make sure this is a valid package definition option.  If
there is an error, returns the error, otherwise returns false.  Called by the
insert and replace methods.

=cut

# the check method should currently be supplied - FS::Record contains some
# data checking routines

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('optionnum')
    || $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart')
    || $self->ut_alpha('optionname')
    || $self->ut_anything('optionvalue')
  ;
  return $error if $error;

  #check options & values?

  $self->SUPER::check;
}

=back

=head1 BUGS

Possibly.

=head1 SEE ALSO

L<FS::part_pkg>, L<FS::Record>, schema.html from the base documentation.

=cut

1;


Index: cust_pkg.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/cust_pkg.pm,v
retrieving revision 1.47
retrieving revision 1.48
diff -u -d -r1.47 -r1.48
--- cust_pkg.pm	15 Jul 2004 22:40:00 -0000	1.47
+++ cust_pkg.pm	26 Oct 2004 11:26:33 -0000	1.48
@@ -502,6 +502,30 @@
     : qsearchs( 'part_pkg', { 'pkgpart' => $self->pkgpart } );
 }
 
+=item calc_setup
+
+Calls the I<calc_setup> of the FS::part_pkg object associated with this billing
+item.
+
+=cut
+
+sub calc_setup {
+  my $self = shift;
+  $self->part_pkg->calc_setup($self, @_);
+}
+
+=item calc_recur
+
+Calls the I<calc_recur> of the FS::part_pkg object associated with this billing
+item.
+
+=cut
+
+sub calc_recur {
+  my $self = shift;
+  $self->part_pkg->calc_recur($self, @_);
+}
+
 =item cust_svc [ SVCPART ]
 
 Returns the services for this package, as FS::cust_svc objects (see

Index: part_pkg.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/part_pkg.pm,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -d -r1.25 -r1.26
--- part_pkg.pm	10 Jul 2004 14:30:59 -0000	1.25
+++ part_pkg.pm	26 Oct 2004 11:26:33 -0000	1.26
@@ -1,15 +1,20 @@
 package FS::part_pkg;
 
 use strict;
-use vars qw( @ISA );
-use FS::Record qw( qsearch dbh dbdef );
+use vars qw( @ISA %freq %plans $DEBUG );
+use Carp;
+use Tie::IxHash;
+use FS::Conf;
+use FS::Record qw( qsearch qsearchs dbh dbdef );
 use FS::pkg_svc;
 use FS::agent_type;
 use FS::type_pkgs;
-use FS::Conf;
+use FS::part_pkg_option;
 
 @ISA = qw( FS::Record );
 
+$DEBUG = 0;
+
 =head1 NAME
 
 FS::part_pkg - Object methods for part_pkg objects
@@ -38,47 +43,44 @@
 
 =head1 DESCRIPTION
 
-An FS::part_pkg object represents a billing item definition.  FS::part_pkg
+An FS::part_pkg object represents a package definition.  FS::part_pkg
 inherits from FS::Record.  The following fields are currently supported:
 
 =over 4
 
-=item pkgpart - primary key (assigned automatically for new billing item definitions)
+=item pkgpart - primary key (assigned automatically for new package definitions)
 
-=item pkg - Text name of this billing item definition (customer-viewable)
+=item pkg - Text name of this package definition (customer-viewable)
 
-=item comment - Text name of this billing item definition (non-customer-viewable)
+=item comment - Text name of this package definition (non-customer-viewable)
 
-=item setup - Setup fee expression
+=item setup - Setup fee expression (deprecated)
 
 =item freq - Frequency of recurring fee
 
-=item recur - Recurring fee expression
+=item recur - Recurring fee expression (deprecated)
 
 =item setuptax - Setup fee tax exempt flag, empty or `Y'
 
 =item recurtax - Recurring fee tax exempt flag, empty or `Y'
 
-=item taxclass - Tax class flag
+=item taxclass - Tax class 
 
 =item plan - Price plan
 
-=item plandata - Price plan data
+=item plandata - Price plan data (deprecated - see L<FS::part_pkg_option> instead)
 
 =item disabled - Disabled flag, empty or `Y'
 
 =back
 
-setup and recur are evaluated as Safe perl expressions.  You can use numbers
-just as you would normally.  More advanced semantics are not yet defined.
-
 =head1 METHODS
 
 =over 4 
 
 =item new HASHREF
 
-Creates a new billing item definition.  To add the billing item definition to
+Creates a new package definition.  To add the package definition to
 the database, see L<"insert">.
 
 =cut
@@ -87,9 +89,9 @@
 
 =item clone
 
-An alternate constructor.  Creates a new billing item definition by duplicating
+An alternate constructor.  Creates a new package definition by duplicating
 an existing definition.  A new pkgpart is assigned and `(CUSTOM) ' is prepended
-to the comment field.  To add the billing item definition to the database, see
+to the comment field.  To add the package definition to the database, see
 L<"insert">.
 
 =cut
@@ -107,13 +109,14 @@
 
 =item insert
 
-Adds this billing item definition to the database.  If there is an error,
+Adds this package definition to the database.  If there is an error,
 returns the error, otherwise returns false.
 
 =cut
 
 sub insert {
   my $self = shift;
+  warn "FS::part_pkg::insert called on $self" if $DEBUG;
 
   local $SIG{HUP} = 'IGNORE';
   local $SIG{INT} = 'IGNORE';
@@ -126,15 +129,43 @@
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
+  warn "  saving legacy plandata" if $DEBUG;
+  my $plandata = $self->get('plandata');
+  $self->set('plandata', '');
+
+  warn "  inserting part_pkg record" if $DEBUG;
   my $error = $self->SUPER::insert;
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;
   }
 
-  my $conf = new FS::Conf;
+  if ( $plandata ) {
+  warn "  inserting part_pkg_option records for plandata" if $DEBUG;
+    foreach my $part_pkg_option ( 
+      map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
+                                   return "illegal plandata: $plandata";
+                                 };
+            new FS::part_pkg_option {
+              'pkgpart'     => $self->pkgpart,
+              'optionname'  => $1,
+              'optionvalue' => $2,
+            };
+          }
+      split("\n", $plandata)
+    ) {
+      my $error = $part_pkg_option->insert;
+      if ( $error ) {
+        $dbh->rollback if $oldAutoCommit;
+        return $error;
+      }
+    }
+  }
 
+  my $conf = new FS::Conf;
   if ( $conf->exists('agent_defaultpkg') ) {
+    warn "  agent_defaultpkg set; allowing all agents to purchase package"
+      if $DEBUG;
     foreach my $agent_type ( qsearch('agent_type', {} ) ) {
       my $type_pkgs = new FS::type_pkgs({
         'typenum' => $agent_type->typenum,
@@ -148,6 +179,7 @@
     }
   }
 
+  warn "  commiting transaction" if $DEBUG;
   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 
   '';
@@ -169,64 +201,79 @@
 Replaces OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
 
-=item check
-
-Checks all fields to make sure this is a valid billing item definition.  If
-there is an error, returns the error, otherwise returns false.  Called by the
-insert and replace methods.
-
 =cut
 
-sub check {
-  my $self = shift;
-
-  for (qw(setup recur)) { $self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
-
-  my $conf = new FS::Conf;
-  if ( $conf->exists('safe-part_pkg') ) {
-
-    my $error = $self->ut_anything('setup')
-                || $self->ut_anything('recur');
-    return $error if $error;
-
-    my $s = $self->setup;
-
-    $s =~ /^\s*\d*\.?\d*\s*$/
-
-      or $s =~ /^my \$d = \$cust_pkg->bill || \$time; \$d += 86400 \* \s*\d+\s*; \$cust_pkg->bill\(\$d\); \$cust_pkg_mod_flag=1; \s*\d*\.?\d*\s*$/
-
-      or do {
-        #log!
-        return "illegal setup: $s";
-      };
-
-    my $r = $self->recur;
+sub replace {
+  my( $new, $old ) = ( shift, shift );
 
-    $r =~ /^\s*\d*\.?\d*\s*$/
+  local $SIG{HUP} = 'IGNORE';
+  local $SIG{INT} = 'IGNORE';
+  local $SIG{QUIT} = 'IGNORE';
+  local $SIG{TERM} = 'IGNORE';
+  local $SIG{TSTP} = 'IGNORE';
+  local $SIG{PIPE} = 'IGNORE';
 
-      #or $r =~ /^\$sdate += 86400 \* \s*\d+\s*; \s*\d*\.?\d*\s*$/
+  my $oldAutoCommit = $FS::UID::AutoCommit;
+  local $FS::UID::AutoCommit = 0;
+  my $dbh = dbh;
 
-      or $r =~ /^my \$mnow = \$sdate; my \(\$sec,\$min,\$hour,\$mday,\$mon,\$year\) = \(localtime\(\$sdate\) \)\[0,1,2,3,4,5\]; my \$mstart = timelocal\(0,0,0,1,\$mon,\$year\); my \$mend = timelocal\(0,0,0,1, \$mon == 11 \? 0 : \$mon\+1, \$year\+\(\$mon==11\)\); \$sdate = \$mstart; \( \$part_pkg->freq \- 1 \) \* \d*\.?\d* \/ \$part_pkg\-\>freq \+ \d*\.?\d* \/ \$part_pkg\-\>freq \* \(\$mend\-\$mnow\) \/ \(\$mend\-\$mstart\) ;\s*$/
+  my $plandata = $new->get('plandata');
+  $new->set('plandata', '');
 
-      or $r =~ /^my \$mnow = \$sdate; my \(\$sec,\$min,\$hour,\$mday,\$mon,\$year\) = \(localtime\(\$sdate\) \)\[0,1,2,3,4,5\]; \$sdate = timelocal\(0,0,0,1,\$mon,\$year\); \s*\d*\.?\d*\s*;\s*$/
+  foreach my $part_pkg_option ( $old->part_pkg_option ) {
+    my $error = $part_pkg_option->delete;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
 
-      or $r =~ /^my \$error = \$cust_pkg\->cust_main\->credit\( \s*\d*\.?\d*\s* \* scalar\(\$cust_pkg\->cust_main\->referral_cust_main_ncancelled\(\s*\d+\s*\)\), "commission" \); die \$error if \$error; \s*\d*\.?\d*\s*;\s*$/
+  my $error = $new->SUPER::replace($old);
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
 
-      or $r =~ /^my \$error = \$cust_pkg\->cust_main\->credit\( \s*\d*\.?\d*\s* \* scalar\(\$cust_pkg\->cust_main->referral_cust_pkg\(\s*\d+\s*\)\), "commission" \); die \$error if \$error; \s*\d*\.?\d*\s*;\s*$/
+  foreach my $part_pkg_option ( 
+    map { /^(\w+)=(.*)$/ or do { $dbh->rollback if $oldAutoCommit;
+                                 return "illegal plandata: $plandata";
+                               };
+          new FS::part_pkg_option {
+            'pkgpart'     => $new->pkgpart,
+            'optionname'  => $1,
+            'optionvalue' => $2,
+          };
+        }
+    split("\n", $plandata)
+  ) {
+    my $error = $part_pkg_option->insert;
+    if ( $error ) {
+      $dbh->rollback if $oldAutoCommit;
+      return $error;
+    }
+  }
 
-      or $r =~ /^my \$error = \$cust_pkg\->cust_main\->credit\( \s*\d*\.?\d*\s* \* scalar\( grep \{ my \$pkgpart = \$_\->pkgpart; grep \{ \$_ == \$pkgpart \} \(\s*(\s*\d+,\s*)*\s*\) \} \$cust_pkg\->cust_main->referral_cust_pkg\(\s*\d+\s*\)\), "commission" \); die \$error if \$error; \s*\d*\.?\d*\s*;\s*$/
+  $dbh->commit or die $dbh->errstr if $oldAutoCommit;
+  '';
+}
 
-      or $r =~ /^my \$hours = \$cust_pkg\->seconds_since\(\$cust_pkg\->bill \|\| 0\) \/ 3600 \- \s*\d*\.?\d*\s*; \$hours = 0 if \$hours < 0; \s*\d*\.?\d*\s* \+ \s*\d*\.?\d*\s* \* \$hours;\s*$/
+=item check
 
-      or $r =~ /^my \$min = \$cust_pkg\->seconds_since\(\$cust_pkg\->bill \|\| 0\) \/ 60 \- \s*\d*\.?\d*\s*; \$min = 0 if \$min < 0; \s*\d*\.?\d*\s* \+ \s*\d*\.?\d*\s* \* \$min;\s*$/
+Checks all fields to make sure this is a valid package definition.  If
+there is an error, returns the error, otherwise returns false.  Called by the
+insert and replace methods.
 
-      or $r =~ /^my \$last_bill = \$cust_pkg\->last_bill; my \$hours = \$cust_pkg\->seconds_since_sqlradacct\(\$last_bill, \$sdate \) \/ 3600 - \s*\d\.?\d*\s*; \$hours = 0 if \$hours < 0; my \$input = \$cust_pkg\->attribute_since_sqlradacct\(\$last_bill, \$sdate, "AcctInputOctets" \) \/ 1048576; my \$output = \$cust_pkg\->attribute_since_sqlradacct\(\$last_bill, \$sdate, "AcctOutputOctets" \) \/ 1048576; my \$total = \$input \+ \$output \- \s*\d\.?\d*\s*; \$total = 0 if \$total < 0; my \$input = \$input - \s*\d\.?\d*\s*; \$input = 0 if \$input < 0; my \$output = \$output - \s*\d\.?\d*\s*; \$output = 0 if \$output < 0; \s*\d\.?\d*\s* \+ \s*\d\.?\d*\s* \* \$hours \+ \s*\d\.?\d*\s* \* \$input \+ \s*\d\.?\d*\s* \* \$output \+ \s*\d\.?\d*\s* \* \$total *;\s*$/
+=cut
 
-      or do {
-        #log!
-        return "illegal recur: $r";
-      };
+sub check {
+  my $self = shift;
+  warn "FS::part_pkg::check called on $self" if $DEBUG;
 
+  for (qw(setup recur plandata)) {
+    #$self->set($_=>0) if $self->get($_) =~ /^\s*$/; }
+    return "Use of $_ field is deprecated; set a plan and options"
+      if length($self->get($_));
+    $self->set($_, '');
   }
 
   if ( $self->dbdef_table->column('freq')->type =~ /(int)/i ) {
@@ -238,19 +285,22 @@
     $self->freq($1);
   }
 
-    $self->ut_numbern('pkgpart')
-      || $self->ut_text('pkg')
-      || $self->ut_text('comment')
-      || $self->ut_anything('setup')
-      || $self->ut_anything('recur')
-      || $self->ut_alphan('plan')
-      || $self->ut_anything('plandata')
-      || $self->ut_enum('setuptax', [ '', 'Y' ] )
-      || $self->ut_enum('recurtax', [ '', 'Y' ] )
-      || $self->ut_textn('taxclass')
-      || $self->ut_enum('disabled', [ '', 'Y' ] )
-      || $self->SUPER::check
-    ;
+  my $error = $self->ut_numbern('pkgpart')
+    || $self->ut_text('pkg')
+    || $self->ut_text('comment')
+    || $self->ut_alphan('plan')
+    || $self->ut_enum('setuptax', [ '', 'Y' ] )
+    || $self->ut_enum('recurtax', [ '', 'Y' ] )
+    || $self->ut_textn('taxclass')
+    || $self->ut_enum('disabled', [ '', 'Y' ] )
+    || $self->SUPER::check
+  ;
+  return $error if $error;
+
+  return 'Unknown plan '. $self->plan
+    unless exists($plans{$self->plan});
+
+  '';
 }
 
 =item pkg_svc
@@ -270,7 +320,7 @@
 =item svcpart [ SVCDB ]
 
 Returns the svcpart of the primary service definition (see L<FS::part_svc>)
-associated with this billing item definition (see L<FS::pkg_svc>).  Returns
+associated with this package definition (see L<FS::pkg_svc>).  Returns
 false if there not a primary service definition or exactly one service
 definition with quantity 1, or if SVCDB is specified and does not match the
 svcdb of the service definition, 
@@ -315,7 +365,206 @@
   }
 }
 
+=item freq_pretty
+
+Returns an english representation of the I<freq> field, such as "monthly",
+"weekly", "semi-annually", etc.
+
+=cut
+
+tie %freq, 'Tie::IxHash', 
+  '0'  => '(no recurring fee)',
+  '1d' => 'daily',
+  '1w' => 'weekly',
+  '2w' => 'biweekly (every 2 weeks)',
+  '1'  => 'monthly',
+  '2'  => 'bimonthly (every 2 months)',
+  '3'  => 'quarterly (every 3 months)',
+  '6'  => 'semiannually (every 6 months)',
+  '12' => 'annually',
+  '24' => 'biannually (every 2 years)',
+;
+
+sub freq_pretty {
+  my $self = shift;
+  my $freq = $self->freq;
+  if ( exists($freq{$freq}) ) {
+    $freq{$freq};
+  } else {
+    my $interval = 'month';
+    if ( $freq =~ /^(\d+)([dw])$/ ) {
+      my %interval = ( 'd'=>'day', 'w'=>'week' );
+      $interval = $interval{$2};
+    }
+    if ( $1 == 1 ) {
+      "every $interval";
+    } else {
+      "every $freq ${interval}s";
+    }
+  }
+}
+
+=item plandata
+
+For backwards compatibility, returns the plandata field as well as all options
+from FS::part_pkg_option.
+
+=cut
+
+sub plandata {
+  my $self = shift;
+  carp "plandata is deprecated";
+  if ( @_ ) {
+    $self->SUPER::plandata(@_);
+  } else {
+    my $plandata = $self->get('plandata');
+    my %options = $self->options;
+    $plandata .= join('', map { "$_=$options{$_}\n" } keys %options );
+    $plandata;
+  }
+}
+
+=item part_pkg_option
+
+Returns all options as FS::part_pkg_option objects (see
+L<FS::part_pkg_option>).
+
+=cut
+
+sub part_pkg_option {
+  my $self = shift;
+  qsearch('part_pkg_option', { 'pkgpart' => $self->pkgpart } );
+}
+
+=item options 
+
+Returns a list of option names and values suitable for assigning to a hash.
+
+=cut
+
+sub options {
+  my $self = shift;
+  map { $_->optionname => $_->optionvalue } $self->part_pkg_option;
+}
+
+=item option OPTIONNAME
+
+Returns the option value for the given name, or the empty string.
+
+=cut
+
+sub option {
+  my $self = shift;
+  my $part_pkg_option =
+    qsearchs('part_pkg_option', {
+      pkgpart    => $self->pkgpart,
+      optionname => shift,
+  } );
+  $part_pkg_option ? $part_pkg_option->optionvalue : '';
+}
+
+=item _rebless
+
+Reblesses the object into the FS::part_pkg::PLAN class (if available), where
+PLAN is the object's I<plan> field.  There should be better docs
+on how to create new price plans, but until then, see L</NEW PLAN CLASSES>.
+
+=cut
+
+sub _rebless {
+  my $self = shift;
+  my $plan = $self->plan;
+  my $class = ref($self). "::$plan";
+  eval "use $class;";
+  #die $@ if $@;
+  bless($self, $class) unless $@;
+  $self;
+}
+
+#fallbacks that eval the setup and recur fields, for backwards compat
+
+sub calc_setup {
+  my $self = shift;
+  warn 'no price plan class for '. $self->plan. ", eval-ing setup\n";
+  $self->_calc_eval('setup', @_);
+}
+
+sub calc_recur {
+  my $self = shift;
+  warn 'no price plan class for '. $self->plan. ", eval-ing recur\n";
+  $self->_calc_eval('recur', @_);
+}
+
+use vars qw( $sdate @details );
+sub _calc_eval {
+  #my( $self, $field, $cust_pkg ) = @_;
+  my( $self, $field, $cust_pkg, $sdateref, $detailsref ) = @_;
+  *sdate = $sdateref;
+  *details = $detailsref;
+  $self->$field() =~ /^(.*)$/
+    or die "Illegal $field (pkgpart ". $self->pkgpart. '): '.
+            $self->$field(). "\n";
+  my $prog = $1;
+  return 0 if $prog =~ /^\s*$/;
+  my $value = eval $prog;
+  die $@ if $@;
+  $value;
+}
+
+=back
+
+=head1 SUBROUTINES
+
+=over 4
+
+=item plan_info
+
+=cut
+
+my %info;
+foreach my $INC ( @INC ) {
+  foreach my $file ( glob("$INC/FS/part_pkg/*.pm") ) {
+    warn "attempting to load plan info from $file\n" if $DEBUG;
+    $file =~ /\/(\w+)\.pm$/ or do {
+      warn "unrecognized file in $INC/FS/part_pkg/: $file\n";
+      next;
+    };
+    my $mod = $1;
+    my $info = eval "use FS::part_pkg::$mod; ".
+                    "\\%FS::part_pkg::$mod\::info;";
+    if ( $@ ) {
+      die "error using FS::part_pkg::$mod (skipping): $@\n" if $@;
+      next;
+    }
+    unless ( keys %$info ) {
+      warn "no %info hash found in FS::part_pkg::$mod, skipping\n"
+        unless $mod =~ /^(passwdfile|null)$/; #hack but what the heck
+      next;
+    }
+    warn "got plan info from FS::part_pkg::$mod: $info\n" if $DEBUG;
+    if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
+      warn "skipping disabled plan FS::part_pkg::$mod" if $DEBUG;
+      next;
+    }
+    $info{$mod} = $info;
+  }
+}
+
+tie %plans, 'Tie::IxHash',
+  map { $_ => $info{$_} }
+  sort { $info{$a}->{'weight'} <=> $info{$b}->{'weight'} }
+  keys %info;
+
+sub plan_info {
+  \%plans;
+}
+
 =back
+
+=head1 NEW PLAN CLASSES
+
+A module should be added in FS/FS/part_pkg/ (an example may be found in
+eg/plan_template.pm)
 
 =head1 BUGS
 

Index: part_export.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/part_export.pm,v
retrieving revision 1.96
retrieving revision 1.97
diff -u -d -r1.96 -r1.97
--- part_export.pm	7 Apr 2004 08:34:08 -0000	1.96
+++ part_export.pm	26 Oct 2004 11:26:33 -0000	1.97
@@ -377,16 +377,15 @@
   $part_export_option ? $part_export_option->optionvalue : '';
 }
 
-=item rebless
+=item _rebless
 
 Reblesses the object into the FS::part_export::EXPORTTYPE class, where
 EXPORTTYPE is the object's I<exporttype> field.  There should be better docs
-on how to create new exports (and they should live in their own files and be
-autoloaded-on-demand), but until then, see L</NEW EXPORT CLASSES>.
+on how to create new exports, but until then, see L</NEW EXPORT CLASSES>.
 
 =cut
 
-sub rebless {
+sub _rebless {
   my $self = shift;
   my $exporttype = $self->exporttype;
   my $class = ref($self). "::$exporttype";
@@ -395,13 +394,15 @@
   bless($self, $class);
 }
 
+#these should probably all go away, just let the subclasses define em
+
 =item export_insert SVC_OBJECT
 
 =cut
 
 sub export_insert {
   my $self = shift;
-  $self->rebless;
+  #$self->rebless;
   $self->_export_insert(@_);
 }
 
@@ -420,7 +421,7 @@
 
 sub export_replace {
   my $self = shift;
-  $self->rebless;
+  #$self->rebless;
   $self->_export_replace(@_);
 }
 
@@ -430,7 +431,7 @@
 
 sub export_delete {
   my $self = shift;
-  $self->rebless;
+  #$self->rebless;
   $self->_export_delete(@_);
 }
 
@@ -440,7 +441,7 @@
 
 sub export_suspend {
   my $self = shift;
-  $self->rebless;
+  #$self->rebless;
   $self->_export_suspend(@_);
 }
 
@@ -450,7 +451,7 @@
 
 sub export_unsuspend {
   my $self = shift;
-  $self->rebless;
+  #$self->rebless;
   $self->_export_unsuspend(@_);
 }
 

Index: Record.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Record.pm,v
retrieving revision 1.89
retrieving revision 1.90
diff -u -d -r1.89 -r1.90
--- Record.pm	10 Jul 2004 13:21:51 -0000	1.89
+++ Record.pm	26 Oct 2004 11:26:33 -0000	1.90
@@ -131,14 +131,18 @@
     $self->{'Table'} = shift;
     carp "warning: FS::Record::new called with table name ". $self->{'Table'};
   }
+  
+  $self->{'Hash'} = shift;
 
-  my $hashref = $self->{'Hash'} = shift;
-
-  foreach my $field ( grep !defined($hashref->{$_}), $self->fields ) { 
-    $hashref->{$field}='';
+  foreach my $field ( grep !defined($self->{'Hash'}{$_}), $self->fields ) { 
+    $self->{'Hash'}{$field}='';
   }
 
-  $self->_cache($hashref, shift) if $self->can('_cache') && @_;
+  $self->_rebless if $self->can('_rebless');
+
+  $self->{'modified'} = 0;
+
+  $self->_cache($self->{'Hash'}, shift) if $self->can('_cache') && @_;
 
   $self;
 }
@@ -498,6 +502,7 @@
 
 sub set { 
   my($self,$field,$value) = @_;
+  $self->{'modified'} = 1;
   $self->{'Hash'}->{$field} = $value;
 }
 sub setfield {
@@ -559,7 +564,9 @@
 
 =item hashref
 
-Returns a reference to the column/value hash.
+Returns a reference to the column/value hash.  This may be deprecated in the
+future; if there's a reason you can't just use the autoloaded or get/set
+methods, speak up.
 
 =cut
 
@@ -568,6 +575,19 @@
   $self->{'Hash'};
 }
 
+=item modified
+
+Returns true if any of this object's values have been modified with set (or via
+an autoloaded method).  Doesn't yet recognize when you retreive a hashref and
+modify that.
+
+=cut
+
+sub modified {
+  my $self = shift;
+  $self->{'modified'};
+}
+
 =item insert
 
 Inserts this record to the database.  If there is an error, returns the error,
@@ -1680,6 +1700,8 @@
 L<DBIx::DBSchema>, L<FS::UID>, L<DBI>
 
 Adapter::DBI from Ch. 11 of Advanced Perl Programming by Sriram Srinivasan.
+
+http://poop.sf.net/
 
 =cut
 

Index: cust_main.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/cust_main.pm,v
retrieving revision 1.162
retrieving revision 1.163
diff -u -d -r1.162 -r1.163
--- cust_main.pm	16 Sep 2004 07:19:51 -0000	1.162
+++ cust_main.pm	26 Oct 2004 11:26:33 -0000	1.163
@@ -9,7 +9,8 @@
   eval "use Time::Local;";
   die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
     if $] < 5.006 && !defined($Time::Local::VERSION);
-  eval "use Time::Local qw(timelocal timelocal_nocheck);";
+  #eval "use Time::Local qw(timelocal timelocal_nocheck);";
+  eval "use Time::Local qw(timelocal_nocheck);";
 }
 use Date::Format;
 #use Date::Manip;
@@ -1116,6 +1117,8 @@
 
 sub bill {
   my( $self, %options ) = @_;
+  warn "bill customer ". $self->custnum if $DEBUG;
+
   my $time = $options{'time'} || time;
 
   my $error;
@@ -1153,14 +1156,14 @@
     #NO!! next if $cust_pkg->cancel;  
     next if $cust_pkg->getfield('cancel');  
 
+    warn "  bill package ". $cust_pkg->pkgnum if $DEBUG;
+
     #? to avoid use of uninitialized value errors... ?
     $cust_pkg->setfield('bill', '')
       unless defined($cust_pkg->bill);
  
     my $part_pkg = $cust_pkg->part_pkg;
 
-    #so we don't modify cust_pkg record unnecessarily
-    my $cust_pkg_mod_flag = 0;
     my %hash = $cust_pkg->hash;
     my $old_cust_pkg = new FS::cust_pkg \%hash;
 
@@ -1169,27 +1172,16 @@
     # bill setup
     my $setup = 0;
     if ( !$cust_pkg->setup || $options{'resetup'} ) {
-      my $setup_prog = $part_pkg->getfield('setup');
-      $setup_prog =~ /^(.*)$/ or do {
-        $dbh->rollback if $oldAutoCommit;
-        return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
-               ": $setup_prog";
-      };
-      $setup_prog = $1;
-      $setup_prog = '0' if $setup_prog =~ /^\s*$/;
+    
+      warn "    bill setup" if $DEBUG;
 
-        #my $cpt = new Safe;
-        ##$cpt->permit(); #what is necessary?
-        #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
-        #$setup = $cpt->reval($setup_prog);
-      $setup = eval $setup_prog;
-      unless ( defined($setup) ) {
+      $setup = eval { $cust_pkg->calc_setup( $time ) };
+      if ( $@ ) {
         $dbh->rollback if $oldAutoCommit;
-        return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
-               "(expression $setup_prog): $@";
+        return $@;
       }
+
       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
-      $cust_pkg_mod_flag=1; 
     }
 
     #bill recurring fee
@@ -1199,28 +1191,18 @@
          ! $cust_pkg->getfield('susp') &&
          ( $cust_pkg->getfield('bill') || 0 ) <= $time
     ) {
-      my $recur_prog = $part_pkg->getfield('recur');
-      $recur_prog =~ /^(.*)$/ or do {
-        $dbh->rollback if $oldAutoCommit;
-        return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
-               ": $recur_prog";
-      };
-      $recur_prog = $1;
-      $recur_prog = '0' if $recur_prog =~ /^\s*$/;
 
-      # shared with $recur_prog
+      warn "    bill recur" if $DEBUG;
+
+      # XXX shared with $recur_prog
       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 
-        #my $cpt = new Safe;
-        ##$cpt->permit(); #what is necessary?
-        #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
-        #$recur = $cpt->reval($recur_prog);
-      $recur = eval $recur_prog;
-      unless ( defined($recur) ) {
+      $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details ) };
+      if ( $@ ) {
         $dbh->rollback if $oldAutoCommit;
-        return "Error eval-ing part_pkg->recur pkgpart ".  $part_pkg->pkgpart.
-               "(expression $recur_prog): $@";
+        return $@;
       }
+
       #change this bit to use Date::Manip? CAREFUL with timezones (see
       # mailing list archive)
       my ($sec,$min,$hour,$mday,$mon,$year) =
@@ -1248,19 +1230,22 @@
       }
       $cust_pkg->setfield('bill',
         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
-      $cust_pkg_mod_flag = 1; 
     }
 
     warn "\$setup is undefined" unless defined($setup);
     warn "\$recur is undefined" unless defined($recur);
     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
 
-    if ( $cust_pkg_mod_flag ) {
+    if ( $cust_pkg->modified ) {
+
+      warn "  package ". $cust_pkg->pkgnum. " modified; updating\n" if $DEBUG;
+
       $error=$cust_pkg->replace($old_cust_pkg);
       if ( $error ) { #just in case
         $dbh->rollback if $oldAutoCommit;
         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
       }
+
       $setup = sprintf( "%.2f", $setup );
       $recur = sprintf( "%.2f", $recur );
       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
@@ -1272,6 +1257,8 @@
         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
       }
       if ( $setup != 0 || $recur != 0 ) {
+        warn "    charges (setup=$setup, recur=$recur); queueing line items\n"
+          if $DEBUG;
         my $cust_bill_pkg = new FS::cust_bill_pkg ({
           'pkgnum'  => $cust_pkg->pkgnum,
           'setup'   => $setup,
@@ -1391,7 +1378,7 @@
 
       } #if $setup != 0 || $recur != 0
       
-    } #if $cust_pkg_mod_flag
+    } #if $cust_pkg->modified
 
   } #foreach my $cust_pkg
 
@@ -1538,7 +1525,7 @@
   $self->select_for_update; #mutex
 
   my $balance = $self->balance;
-  warn "collect customer". $self->custnum. ": balance $balance" if $DEBUG;
+  warn "collect customer ". $self->custnum. ": balance $balance" if $DEBUG;
   unless ( $balance > 0 ) { #redundant?????
     $dbh->rollback if $oldAutoCommit; #hmm
     return '';
@@ -2690,9 +2677,11 @@
   my $part_pkg = new FS::part_pkg ( {
     'pkg'      => $pkg,
     'comment'  => $comment,
-    'setup'    => $amount,
+    #'setup'    => $amount,
+    #'recur'    => '0',
+    'plan'     => 'flat',
+    'plandata' => "setup_fee=$amount",
     'freq'     => 0,
-    'recur'    => '0',
     'disabled' => 'Y',
     'taxclass' => $taxclass,
   } );

Index: CGI.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/CGI.pm,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -d -r1.26 -r1.27
--- CGI.pm	10 Jun 2004 12:31:31 -0000	1.26
+++ CGI.pm	26 Oct 2004 11:26:33 -0000	1.27
@@ -252,10 +252,11 @@
 sub itable {
   my $col = shift;
   my $cellspacing = shift || 0;
+  my $width = ( scalar(@_) && shift ) ? '' : 'WIDTH="100%"';  #bah
   if ( $col ) {
-    qq!<TABLE BGCOLOR="$col" BORDER=0 CELLSPACING=$cellspacing WIDTH="100%">!;
+    qq!<TABLE BGCOLOR="$col" BORDER=0 CELLSPACING=$cellspacing $width>!;
   } else {
-    qq!<TABLE BORDER=0 CELLSPACING=$cellspacing WIDTH="100%">!;
+    qq!<TABLE BORDER=0 CELLSPACING=$cellspacing $width>!;
   }
 }
 

Index: Conf.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Conf.pm,v
retrieving revision 1.107
retrieving revision 1.108
diff -u -d -r1.107 -r1.108
--- Conf.pm	17 Oct 2004 09:19:22 -0000	1.107
+++ Conf.pm	26 Oct 2004 11:26:33 -0000	1.108
@@ -935,8 +935,8 @@
 
   {
     'key'         => 'safe-part_pkg',
-    'section'     => 'UI',
-    'description' => 'Validates package definition setup and recur expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
+    'section'     => 'deprecated',
+    'description' => '<b>DEPRECATED</b>, obsolete.  Used to validate package definition setup and recur expressions against a preset list.  Useful for webdemos, annoying to powerusers.',
     'type'        => 'checkbox',
   },
 




More information about the freeside-commits mailing list