summaryrefslogtreecommitdiff
path: root/site_perl/part_svc.pm
blob: 0fd8ee47d85a3782aa9512d298e480bb2c7ea88f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
package FS::part_svc;

use strict;
use vars qw(@ISA @EXPORT_OK);
use Exporter;
use FS::Record qw(fields hfields);

@ISA = qw(FS::Record Exporter);
@EXPORT_OK = qw(hfields fields);

=head1 NAME

FS::part_svc - Object methods for part_svc objects

=head1 SYNOPSIS

  use FS::part_svc;

  $record = create FS::part_referral \%hash
  $record = create FS::part_referral { 'column' => 'value' };

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_svc represents a service definition.  FS::part_svc inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item svcpart - primary key (assigned automatically for new service definitions)

=item svc - text name of this service definition

=item svcdb - table used for this service.  See L<FS::svc_acct>,
L<FS::svc_domain>, and L<FS::svc_acct_sm>, among others.

=item I<svcdb>__I<field> - Default or fixed value for I<field> in I<svcdb>.

=item I<svcdb>__I<field>_flag - defines I<svcdb>__I<field> action: null, `D' for default, or `F' for fixed

=back

=head1 METHODS

=over 4

=item create HASHREF

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

=cut

sub create {
  my($proto,$hashref)=@_;

  #now in FS::Record::new
  #my($field);
  #foreach $field (fields('part_svc')) {
  #  $hashref->{$field}='' unless defined $hashref->{$field};
  #}

  $proto->new('part_svc',$hashref);
}

=item insert

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

=cut

sub insert {
  my($self)=@_;

  $self->check or
  $self->add;
}

=item delete

Currently unimplemented.

=cut

sub delete {
  return "Can't (yet?) delete service definitions.";
# maybe check & make sure the svcpart isn't in cust_svc or (in any packages)?
#  my($self)=@_;
#
#  $self->del;
}

=item replace OLD_RECORD

Replaces OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

=cut

sub replace {
  my($new,$old)=@_;
  return "(Old) Not a part_svc record!" unless $old->table eq "part_svc";
  return "Can't change svcpart!"
    unless $old->getfield('svcpart') eq $new->getfield('svcpart');
  return "Can't change svcdb!"
    unless $old->getfield('svcdb') eq $new->getfield('svcdb');
  $new->check or
  $new->rep($old);
}

=item check

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

=cut

sub check {
  my($self)=@_;
  return "Not a part_svc record!" unless $self->table eq "part_svc";
  my($recref) = $self->hashref;

  my($error);
  return $error if $error=
    $self->ut_numbern('svcpart')
    || $self->ut_text('svc')
    || $self->ut_alpha('svcdb')
  ;

  my(@fields) = eval { fields($recref->{svcdb}) }; #might die
  return "Unknown svcdb!" unless @fields;

  my($svcdb);
  foreach $svcdb ( qw(
    svc_acct svc_acct_sm svc_charge svc_domain svc_wo
  ) ) {
    my(@rows)=map { /^${svcdb}__(.*)$/; $1 }
      grep ! /_flag$/,
        grep /^${svcdb}__/,
          fields('part_svc');
    my($row);
    foreach $row (@rows) {
      unless ( $svcdb eq $recref->{svcdb} ) {
        $recref->{$svcdb.'__'.$row}='';
        $recref->{$svcdb.'__'.$row.'_flag'}='';
        next;
      }
      $recref->{$svcdb.'__'.$row.'_flag'} =~ /^([DF]?)$/
        or return "Illegal flag for $svcdb $row";
      $recref->{$svcdb.'__'.$row.'_flag'} = $1;

#      $recref->{$svcdb.'__'.$row} =~ /^(.*)$/ #not restrictive enough?
#        or return "Illegal value for $svcdb $row";
#      $recref->{$svcdb.'__'.$row} = $1;
      my($error);
      return $error if $error=$self->ut_anything($svcdb.'__'.$row);

    }
  }

  ''; #no error
}

=back

=head1 BUGS

It doesn't properly override FS::Record yet.

Delete is unimplemented.

=head1 SEE ALSO

L<FS::Record>, L<FS::part_pkg>, L<FS::pkg_svc>, L<FS::cust_svc>,
L<FS::svc_acct>, L<FS::svc_acct_sm>, L<FS::svc_domain>, schema.html from the
base documentation.

=head1 HISTORY

ivan@sisd.com 97-nov-14

data checking/untainting calls into FS::Record added
ivan@sisd.com 97-dec-6

pod ivan@sisd.com 98-sep-21

=cut

1;