4 use vars qw( @ISA $DEBUG );
6 use FS::Record qw( qsearch qsearchs fields dbh );
7 use FS::Schema qw( dbdef );
8 use FS::part_svc_column;
13 @ISA = qw(FS::Record);
19 FS::part_svc - Object methods for part_svc objects
25 $record = new FS::part_svc \%hash
26 $record = new FS::part_svc { 'column' => 'value' };
28 $error = $record->insert;
29 $error = $record->insert( [ 'pseudofield' ] );
30 $error = $record->insert( [ 'pseudofield' ], \%exportnums );
32 $error = $new_record->replace($old_record);
33 $error = $new_record->replace($old_record, '1.3-COMPAT', [ 'pseudofield' ] );
34 $error = $new_record->replace($old_record, '1.3-COMPAT', [ 'pseudofield' ], \%exportnums );
36 $error = $record->delete;
38 $error = $record->check;
42 An FS::part_svc represents a service definition. FS::part_svc inherits from
43 FS::Record. The following fields are currently supported:
47 =item svcpart - primary key (assigned automatically for new service definitions)
49 =item svc - text name of this service definition
51 =item svcdb - table used for this service. See L<FS::svc_acct>,
52 L<FS::svc_domain>, and L<FS::svc_forward>, among others.
54 =item disabled - Disabled flag, empty or `Y'
56 =item preserve - Preserve after cancellation, empty or 'Y'
66 Creates a new service definition. To add the service definition to the
67 database, see L<"insert">.
71 sub table { 'part_svc'; }
73 =item insert [ EXTRA_FIELDS_ARRAYREF [ , EXPORTNUMS_HASHREF [ , JOB ] ] ]
75 Adds this service definition to the database. If there is an error, returns
76 the error, otherwise returns false.
78 The following pseudo-fields may be defined, and will be maintained in
79 the part_svc_column table appropriately (see L<FS::part_svc_column>).
83 =item I<svcdb>__I<field> - Default or fixed value for I<field> in I<svcdb>.
85 =item I<svcdb>__I<field>_flag - defines I<svcdb>__I<field> action: null or empty (no default), `D' for default, `F' for fixed (unchangeable), `M' for manual selection from inventory, or `A' for automatic selection from inventory. For virtual fields, can also be 'X' for excluded.
89 If you want to add part_svc_column records for fields that do not exist as
90 (real or virtual) fields in the I<svcdb> table, make sure to list then in
91 EXTRA_FIELDS_ARRAYREF also.
93 If EXPORTNUMS_HASHREF is specified (keys are exportnums and values are
94 boolean), the appopriate export_svc records will be inserted.
104 @fields = @{shift(@_)} if @_;
106 my $exportnums = shift;
107 @exportnums = grep $exportnums->{$_}, keys %$exportnums;
112 local $SIG{HUP} = 'IGNORE';
113 local $SIG{INT} = 'IGNORE';
114 local $SIG{QUIT} = 'IGNORE';
115 local $SIG{TERM} = 'IGNORE';
116 local $SIG{TSTP} = 'IGNORE';
117 local $SIG{PIPE} = 'IGNORE';
119 my $oldAutoCommit = $FS::UID::AutoCommit;
120 local $FS::UID::AutoCommit = 0;
123 my $error = $self->SUPER::insert;
125 $dbh->rollback if $oldAutoCommit;
129 # add part_svc_column records
131 my $svcdb = $self->svcdb;
132 # my @rows = map { /^${svcdb}__(.*)$/; $1 }
134 # grep /^${svcdb}__/,
135 # fields('part_svc');
137 grep { $_ ne 'svcnum'
138 && ( defined( $self->getfield($svcdb.'__'.$_.'_flag') )
139 || $self->getfield($svcdb.'__'.$_.'_label') !~ /^\s*$/ )
140 } (fields($svcdb), @fields)
142 my $part_svc_column = $self->part_svc_column($field);
143 my $previous = qsearchs('part_svc_column', {
144 'svcpart' => $self->svcpart,
145 'columnname' => $field,
148 my $flag = $self->getfield($svcdb.'__'.$field.'_flag');
149 my $label = $self->getfield($svcdb.'__'.$field.'_label');
150 if ( uc($flag) =~ /^([A-Z])$/ || $label !~ /^\s*$/ ) {
152 if ( uc($flag) =~ /^([A-Z])$/ ) {
153 my $parser = FS::part_svc->svc_table_fields($svcdb)->{$field}->{parse}
155 $part_svc_column->setfield('columnflag', $1);
156 $part_svc_column->setfield('columnvalue',
157 &$parser($self->getfield($svcdb.'__'.$field))
161 $part_svc_column->setfield('columnlabel', $label)
162 if $label !~ /^\s*$/;
165 $error = $part_svc_column->replace($previous);
167 $error = $part_svc_column->insert;
171 $error = $previous ? $previous->delete : '';
174 $dbh->rollback if $oldAutoCommit;
180 # add export_svc records
181 my $slice = 100/scalar(@exportnums) if @exportnums;
183 foreach my $exportnum ( @exportnums ) {
184 my $export_svc = new FS::export_svc ( {
185 'exportnum' => $exportnum,
186 'svcpart' => $self->svcpart,
188 $error = $export_svc->insert($job, $slice*$done++, $slice);
190 $dbh->rollback if $oldAutoCommit;
195 # XXX shouldn't this update fixed values?
197 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
204 Currently unimplemented. Set the "disabled" field instead.
209 return "Can't (yet?) delete service definitions.";
210 # check & make sure the svcpart isn't in cust_svc or pkg_svc (in any packages)?
213 =item replace OLD_RECORD [ '1.3-COMPAT' [ , EXTRA_FIELDS_ARRAYREF [ , EXPORTNUMS_HASHREF [ , JOB ] ] ] ]
215 Replaces OLD_RECORD with this one in the database. If there is an error,
216 returns the error, otherwise returns false.
220 TODOC: EXTRA_FIELDS_ARRAYREF (same as insert method)
227 my ( $new, $old ) = ( shift, shift );
232 if ( @_ && $_[0] eq '1.3-COMPAT' ) {
235 @fields = @{shift(@_)} if @_;
236 $exportnums = @_ ? shift : '';
239 return 'non-1.3-COMPAT interface not yet written';
243 return "Can't change svcdb for an existing service definition!"
244 unless $old->svcdb eq $new->svcdb;
246 local $SIG{HUP} = 'IGNORE';
247 local $SIG{INT} = 'IGNORE';
248 local $SIG{QUIT} = 'IGNORE';
249 local $SIG{TERM} = 'IGNORE';
250 local $SIG{TSTP} = 'IGNORE';
251 local $SIG{PIPE} = 'IGNORE';
253 my $oldAutoCommit = $FS::UID::AutoCommit;
254 local $FS::UID::AutoCommit = 0;
257 my $error = $new->SUPER::replace( $old );
259 $dbh->rollback if $oldAutoCommit;
263 if ( $compat eq '1.3' ) {
265 # maintain part_svc_column records
267 my $svcdb = $new->svcdb;
269 grep { $_ ne 'svcnum'
270 && ( defined( $new->getfield($svcdb.'__'.$_.'_flag') )
271 || $new->getfield($svcdb.'__'.$_.'_label') !~ /^\s*$/ )
272 } (fields($svcdb),@fields)
275 my $part_svc_column = $new->part_svc_column($field);
276 my $previous = qsearchs('part_svc_column', {
277 'svcpart' => $new->svcpart,
278 'columnname' => $field,
281 my $flag = $new->getfield($svcdb.'__'.$field.'_flag');
282 my $label = $new->getfield($svcdb.'__'.$field.'_label');
284 if ( uc($flag) =~ /^([A-Z])$/ || $label !~ /^\s*$/ ) {
286 if ( uc($flag) =~ /^([A-Z])$/ ) {
287 $part_svc_column->setfield('columnflag', $1);
288 my $parser = FS::part_svc->svc_table_fields($svcdb)->{$field}->{parse}
290 $part_svc_column->setfield('columnvalue',
291 &$parser($new->getfield($svcdb.'__'.$field))
294 $part_svc_column->setfield('columnflag', '');
295 $part_svc_column->setfield('columnvalue', '');
298 $part_svc_column->setfield('columnlabel', $label)
299 if $label !~ /^\s*$/;
302 $error = $part_svc_column->replace($previous);
304 $error = $part_svc_column->insert;
307 $error = $previous ? $previous->delete : '';
310 $dbh->rollback if $oldAutoCommit;
315 # maintain export_svc records
319 #false laziness w/ edit/process/agent_type.cgi
320 my @new_export_svc = ();
321 foreach my $part_export ( qsearch('part_export', {}) ) {
322 my $exportnum = $part_export->exportnum;
324 'exportnum' => $exportnum,
325 'svcpart' => $new->svcpart,
327 my $export_svc = qsearchs('export_svc', $hashref);
329 if ( $export_svc && ! $exportnums->{$exportnum} ) {
330 $error = $export_svc->delete;
332 $dbh->rollback if $oldAutoCommit;
335 } elsif ( ! $export_svc && $exportnums->{$exportnum} ) {
336 push @new_export_svc, new FS::export_svc ( $hashref );
341 my $slice = 100/scalar(@new_export_svc) if @new_export_svc;
343 foreach my $export_svc (@new_export_svc) {
344 $error = $export_svc->insert($job, $slice*$done++, $slice);
346 $dbh->rollback if $oldAutoCommit;
350 $error = $job->update_statustext( int( $slice * $done ) );
352 $dbh->rollback if $oldAutoCommit;
361 $dbh->rollback if $oldAutoCommit;
362 return 'non-1.3-COMPAT interface not yet written';
366 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
373 Checks all fields to make sure this is a valid service definition. If there is
374 an error, returns the error, otherwise returns false. Called by the insert
384 $self->ut_numbern('svcpart')
385 || $self->ut_text('svc')
386 || $self->ut_alpha('svcdb')
387 || $self->ut_enum('disabled', [ '', 'Y' ] )
388 || $self->ut_enum('preserve', [ '', 'Y' ] )
390 return $error if $error;
392 my @fields = eval { fields( $self->svcdb ) }; #might die
393 return "Unknown svcdb: ". $self->svcdb. " (Error: $@)"
399 =item part_svc_column COLUMNNAME
401 Returns the part_svc_column object (see L<FS::part_svc_column>) for the given
402 COLUMNNAME, or a new part_svc_column object if none exists.
406 sub part_svc_column {
407 my( $self, $columnname) = @_;
409 qsearchs('part_svc_column', {
410 'svcpart' => $self->svcpart,
411 'columnname' => $columnname,
413 ) or new FS::part_svc_column {
414 'svcpart' => $self->svcpart,
415 'columnname' => $columnname,
419 =item all_part_svc_column
423 sub all_part_svc_column {
425 qsearch('part_svc_column', { 'svcpart' => $self->svcpart } );
428 =item part_export [ EXPORTTYPE ]
430 Returns a list of all exports (see L<FS::part_export>) for this service, or,
431 if an export type is specified, only returns exports of the given type.
438 $search{'exporttype'} = shift if @_;
439 sort { $a->weight <=> $b->weight }
440 map { qsearchs('part_export', { 'exportnum' => $_->exportnum, %search } ) }
441 qsearch('export_svc', { 'svcpart' => $self->svcpart } );
444 =item part_export_usage
446 Returns a list of any exports (see L<FS::part_export>) for this service that
447 are capable of reporting usage information.
451 sub part_export_usage {
453 grep $_->can('usage_sessions'), $self->part_export;
456 =item part_export_did
458 Returns a list of any exports (see L<FS::part_export>) for this service that
459 are capable of returing available DID (phone number) information.
463 sub part_export_did {
465 grep $_->can('get_dids'), $self->part_export;
468 =item part_export_dsl_pull
470 Returns a list of any exports (see L<FS::part_export>) for this service that
471 are capable of pulling/pushing DSL orders.
475 sub part_export_dsl_pull {
477 grep $_->can('dsl_pull'), $self->part_export;
480 =item cust_svc [ PKGPART ]
482 Returns a list of associated customer services (FS::cust_svc records).
484 If a PKGPART is specified, returns the customer services which are contained
485 within packages of that type (see L<FS::part_pkg>). If PKGPARTis specified as
486 B<0>, returns unlinked customer services.
493 my $hashref = { 'svcpart' => $self->svcpart };
495 my( $addl_from, $extra_sql ) = ( '', '' );
498 if ( $pkgpart =~ /^(\d+)$/ ) {
499 $addl_from = 'LEFT JOIN cust_pkg USING ( pkgnum )';
500 $extra_sql = "AND pkgpart = $1";
501 } elsif ( $pkgpart eq '0' ) {
502 $hashref->{'pkgnum'} = '';
507 'table' => 'cust_svc',
508 'addl_from' => $addl_from,
509 'hashref' => $hashref,
510 'extra_sql' => $extra_sql,
514 =item num_cust_svc [ PKGPART ]
516 Returns the number of associated customer services (FS::cust_svc records).
518 If a PKGPART is specified, returns the number of customer services which are
519 contained within packages of that type (see L<FS::part_pkg>). If PKGPART
520 is specified as B<0>, returns the number of unlinked customer services.
527 my @param = ( $self->svcpart );
529 my( $join, $and ) = ( '', '' );
533 $join = 'LEFT JOIN cust_pkg USING ( pkgnum )';
534 $and = 'AND pkgpart = ?';
535 push @param, $pkgpart;
536 } elsif ( $pkgpart eq '0' ) {
537 $and = 'AND pkgnum IS NULL';
541 my $sth = dbh->prepare(
542 "SELECT COUNT(*) FROM cust_svc $join WHERE svcpart = ? $and"
543 ) or die dbh->errstr;
544 $sth->execute(@param)
546 $sth->fetchrow_arrayref->[0];
551 Returns a list of associated FS::svc_* records.
557 map { $_->svc_x } $self->cust_svc;
571 return $svc_defs if $svc_defs; #cache
573 my $conf = new FS::Conf;
575 #false laziness w/part_pkg.pm::plan_info
578 foreach my $INC ( @INC ) {
579 warn "globbing $INC/FS/svc_*.pm\n" if $DEBUG;
580 foreach my $file ( glob("$INC/FS/svc_*.pm") ) {
582 warn "attempting to load service table info from $file\n" if $DEBUG;
583 $file =~ /\/(\w+)\.pm$/ or do {
584 warn "unrecognized file in $INC/FS/: $file\n";
589 if ( $mod =~ /^svc_[A-Z]/ or $mod =~ /^svc_acct_pop$/ ) {
590 warn "skipping FS::$mod" if $DEBUG;
594 eval "use FS::$mod;";
596 die "error using FS::$mod (skipping): $@\n" if $@;
599 unless ( UNIVERSAL::can("FS::$mod", 'table_info') ) {
600 warn "FS::$mod has no table_info method; skipping";
604 my $info = "FS::$mod"->table_info;
605 unless ( keys %$info ) {
606 warn "FS::$mod->table_info doesn't return info, skipping\n";
609 warn "got info from FS::$mod: $info\n" if $DEBUG;
610 if ( exists($info->{'disabled'}) && $info->{'disabled'} ) {
611 warn "skipping disabled service FS::$mod" if $DEBUG;
618 tie my %svc_defs, 'Tie::IxHash',
619 map { $_ => $info{$_}->{'fields'} }
620 sort { $info{$a}->{'display_weight'} <=> $info{$b}->{'display_weight'} }
624 # yuck. maybe this won't be so bad when virtual fields become real fields
626 foreach my $svcdb (grep dbdef->table($_), keys %svc_defs ) {
627 eval "use FS::$svcdb;";
628 my $self = "FS::$svcdb"->new;
629 $vfields{$svcdb} = {};
630 foreach my $field ($self->virtual_fields) { # svc_Common::virtual_fields with a null svcpart returns all of them
631 my $pvf = $self->pvf($field);
632 my @list = $pvf->list;
634 $svc_defs{$svcdb}->{$field} = { desc => $pvf->label,
636 select_list => \@list };
638 $svc_defs{$svcdb}->{$field} = $pvf->label;
640 $vfields{$svcdb}->{$field} = $pvf;
641 warn "\$vfields{$svcdb}->{$field} = $pvf"
646 $svc_defs = \%svc_defs; #cache
652 Returns a list of all svc_ tables.
658 my $svc_defs = $class->_svc_defs;
659 grep { defined( dbdef->table($_) ) } keys %$svc_defs;
662 =item svc_table_fields TABLE
664 Given a table name, returns a hashref of field names. The field names
665 returned are those with additional (service-definition related) information,
666 not necessarily all database fields of the table. Pseudo-fields may also
667 be returned (i.e. svc_acct.usergroup).
669 Each value of the hashref is another hashref, which can have one or more of
674 =item label - Description of the field
676 =item def_label - Optional description of the field in the context of service definitions
678 =item type - Currently "text", "select", "checkbox", "textarea", "disabled",
679 some components specified by "select-.*.html", and a bunch more...
681 =item disable_default - This field should not allow a default value in service definitions
683 =item disable_fixed - This field should not allow a fixed value in service definitions
685 =item disable_inventory - This field should not allow inventory values in service definitions
687 =item select_list - If type is "text", this can be a listref of possible values.
689 =item select_table - An alternative to select_list, this defines a database table with the possible choices.
691 =item select_key - Used with select_table, this is the field name of keys
693 =item select_label - Used with select_table, this is the field name of labels
699 #maybe this should move and be a class method in svc_Common.pm
700 sub svc_table_fields {
701 my($class, $table) = @_;
702 my $svc_defs = $class->_svc_defs;
703 my $def = $svc_defs->{$table};
705 foreach ( grep !ref($def->{$_}), keys %$def ) {
707 #normalize the shortcut in %info hash
708 $def->{$_} = { 'label' => $def->{$_} };
710 $def->{$_}{'type'} ||= 'text';
725 Job-queue processor for web interface adds/edits
729 use Storable qw(thaw);
735 my $param = thaw(decode_base64(shift));
736 warn Dumper($param) if $DEBUG;
738 my $old = qsearchs('part_svc', { 'svcpart' => $param->{'svcpart'} })
739 if $param->{'svcpart'};
741 #unmunge cgp_accessmodes (falze laziness-ish w/edit/process/svc_acct.cgi)
742 $param->{'svc_acct__cgp_accessmodes'} ||=
744 grep { $_ !~ /^(flag|label)$/ }
745 map { /^svc_acct__cgp_accessmodes_([\w\/]+)$/ or die "no way"; $1; }
747 grep /^svc_acct__cgp_accessmodes_([\w\/]+)$/,
752 my $new = new FS::part_svc ( {
755 # } qw(svcpart svc svcdb)
756 } ( fields('part_svc'),
757 map { my $svcdb = $_;
758 my @fields = fields($svcdb);
759 push @fields, 'usergroup' if $svcdb eq 'svc_acct'
760 or $svcdb eq 'svc_broadband'; #kludge
763 my $f = $svcdb.'__'.$_;
764 my $flag = $param->{ $f.'_flag' } || ''; #silence warnings
765 if ( $flag =~ /^[MAH]$/ ) {
766 $param->{ $f } = delete( $param->{ $f.'_classnum' } );
769 or $_ eq 'usergroup' ) {
770 $param->{ $f } = ref($param->{ $f })
771 ? join(',', @{$param->{ $f }} )
774 ( $f, $f.'_flag', $f.'_label' );
778 } FS::part_svc->svc_tables()
783 map { $_->exportnum => ( $param->{'exportnum'.$_->exportnum} || '') }
784 qsearch('part_export', {} );
787 if ( $param->{'svcpart'} ) {
788 $error = $new->replace( $old,
789 '1.3-COMPAT', #totally bunk, as jeff noted
795 $error = $new->insert( [ 'usergroup' ],
799 $param->{'svcpart'} = $new->getfield('svcpart');
802 die "$error\n" if $error;
805 =item process_bulk_cust_svc
807 Job-queue processor for web interface bulk customer service changes
811 use Storable qw(thaw);
814 sub process_bulk_cust_svc {
817 my $param = thaw(decode_base64(shift));
818 warn Dumper($param) if $DEBUG;
820 local($FS::svc_Common::noexport_hack) = 1
821 if $param->{'noexport'};
824 qsearchs('part_svc', { 'svcpart' => $param->{'old_svcpart'} } );
826 die "Must select a new service definition\n" unless $param->{'new_svcpart'};
828 #the rest should be abstracted out to to its own subroutine?
830 local $SIG{HUP} = 'IGNORE';
831 local $SIG{INT} = 'IGNORE';
832 local $SIG{QUIT} = 'IGNORE';
833 local $SIG{TERM} = 'IGNORE';
834 local $SIG{TSTP} = 'IGNORE';
835 local $SIG{PIPE} = 'IGNORE';
837 my $oldAutoCommit = $FS::UID::AutoCommit;
838 local $FS::UID::AutoCommit = 0;
841 local( $FS::cust_svc::ignore_quantity ) = 1;
843 my $total = $old_part_svc->num_cust_svc( $param->{'pkgpart'} );
846 foreach my $old_cust_svc ( $old_part_svc->cust_svc( $param->{'pkgpart'} ) ) {
848 my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
850 $new_cust_svc->svcpart( $param->{'new_svcpart'} );
851 my $error = $new_cust_svc->replace($old_cust_svc);
853 $dbh->rollback if $oldAutoCommit;
854 die "$error\n" if $error;
857 $error = $job->update_statustext( int( 100 * ++$n / $total ) );
859 $dbh->rollback if $oldAutoCommit;
860 die $error if $error;
865 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
871 sub _upgrade_data { #class method
872 my ($class, %opts) = @_;
874 my @part_svc_column = qsearch('part_svc_column', { 'columnname' => 'usergroup' });
875 foreach my $col ( @part_svc_column ) {
876 next if $col->columnvalue =~ /^[\d,]+$/ || !$col->columnvalue;
877 my @groupnames = split(',',$col->columnvalue);
880 foreach my $groupname ( @groupnames ) {
881 my $g = qsearchs('radius_group', { 'groupname' => $groupname } );
883 $g = new FS::radius_group {
884 'groupname' => $groupname,
885 'description' => $groupname,
888 die $error if $error;
890 push @groupnums, $g->groupnum;
892 $col->columnvalue(join(',',@groupnums));
893 $error = $col->replace;
894 die $error if $error;
897 my @badlabels = qsearch({
898 'table' => 'part_svc_column',
900 'extra_sql' => 'WHERE columnlabel IN ('.
901 "'Descriptive label for this particular device.',".
902 "'IP address. Leave blank for automatic assignment.',".
903 "'Maximum upload speed for this service in Kbps. 0 denotes unlimited.',".
904 "'Maximum download speed for this service in Kbps. 0 denotes unlimited.')"
906 foreach my $col ( @badlabels ) {
907 $col->columnlabel('');
908 my $error = $col->replace;
909 die $error if $error;
916 Delete is unimplemented.
918 The list of svc_* tables is no longer hardcoded, but svc_acct_pop is skipped
919 as a special case until it is renamed.
921 all_part_svc_column methods should be documented
925 L<FS::Record>, L<FS::part_svc_column>, L<FS::part_pkg>, L<FS::pkg_svc>,
926 L<FS::cust_svc>, L<FS::svc_acct>, L<FS::svc_forward>, L<FS::svc_domain>,
927 schema.html from the base documentation.