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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
package FS::part_pkg_usageprice;
use base qw( FS::Record );
use strict;
use Tie::IxHash;
#use FS::Record qw( qsearch qsearchs );
=head1 NAME
FS::part_pkg_usageprice - Object methods for part_pkg_usageprice records
=head1 SYNOPSIS
use FS::part_pkg_usageprice;
$record = new FS::part_pkg_usageprice \%hash;
$record = new FS::part_pkg_usageprice { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::part_pkg_usageprice object represents a usage pricing add-on.
FS::part_pkg_usageprice inherits from FS::Record. The following fields are
currently supported:
=over 4
=item usagepricepart
primary key
=item pkgpart
pkgpart
=item price
price
=item currency
currency
=item action
action
=item target
target
=item amount
amount
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new record. To add the record 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
sub table { 'part_pkg_usageprice'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Delete this record from the database.
=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.
=item check
Checks all fields to make sure this is a valid record. 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('usagepricepart')
|| $self->ut_number('pkgpart')
|| $self->ut_money('price')
|| $self->ut_currencyn('currency')
|| $self->ut_enum('action', [ 'increment', 'set' ])
|| $self->ut_enum('target', [ 'svc_acct.totalbytes', 'svc_acct.seconds',
'svc_conferencing.participants',
# 'svc_conferencing.confqualitynum',
'sqlradacct_hour.recur_included_total'
]
)
|| $self->ut_text('amount')
;
return $error if $error;
#Check target against package
#UI doesn't currently prevent these from happing,
#so keep error messages informative
my $part_pkg = $self->part_pkg;
my $target = $self->target;
my $label = $self->target_info->{'label'};
my ($needs_svcdb, $needs_plan);
if ( $target =~ /^svc_acct.(\w+)$/ ) {
$needs_svcdb = 'svc_acct';
} elsif ( $target eq 'svc_conferencing.participants' ) {
$needs_svcdb = 'svc_conferencing';
} elsif ( $target =~ /^sqlradacct_hour.(\w+)$/ ) {
$needs_plan = 'sqlradacct_hour';
}
if ($needs_svcdb) {
my $has_svcdb = 0;
foreach my $pkg_svc ($part_pkg->pkg_svc) {
next unless $pkg_svc->quantity;
my $svcdb = $pkg_svc->part_svc->svcdb;
$has_svcdb = 1
if $svcdb eq $needs_svcdb;
last if $has_svcdb;
}
return "Usage pricing add-on \'$label\' can only be used on packages with at least one $needs_svcdb service.\n"
unless $has_svcdb;
}
if ($needs_plan) {
return "Usage pricing add-on \'$label\' can only be used on packages with pricing plan \'" .
FS::part_pkg->plan_info->{$needs_plan}->{'shortname'} . "\'\n"
unless ref($part_pkg) eq 'FS::part_pkg::' . $needs_plan;
}
$self->SUPER::check;
}
=item target_info
Returns a hash reference of information about the target of this object.
Keys are "label" and "multiplier".
=cut
sub target_info {
my $self = shift;
$self->targets->{$self->target};
}
=item targets
(Class method)
Returns a hash reference. Keys are possible values for the "target" field.
Values are hash references with "label" and "multiplier" keys.
=cut
sub targets {
tie my %targets, 'Tie::IxHash', # once?
#'svc_acct.totalbytes' => { label => 'Megabytes',
# multiplier => 1048576,
# },
'svc_acct.totalbytes' => { label => 'Total Gigabytes',
multiplier => 1073741824,
},
'svc_acct.seconds' => { label => 'Total Hours',
multiplier => 3600,
},
'svc_conferencing.participants' => { label => 'Conference Participants',
multiplier=> 1,
},
#this will take more work: set action, not increment..
# and then value comes from a select, not a text field
# 'svc_conferencing.confqualitynum' => { label => 'Conference Quality',
# },
# this bypasses usual apply methods, handled entirely in sqlradacct_hour
'sqlradacct_hour.recur_included_total' => { label => 'Included Gigabytes',
multiplier => 1 }, #recur_included_total is stored in GB
;
\%targets;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::part_pkg>, L<FS::Record>
=cut
1;
|
