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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
|
package FS::quotation;
use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record
);
use strict;
use Tie::RefHash;
use FS::CurrentUser;
use FS::UID qw( dbh );
use FS::cust_main;
use FS::cust_pkg;
=head1 NAME
FS::quotation - Object methods for quotation records
=head1 SYNOPSIS
use FS::quotation;
$record = new FS::quotation \%hash;
$record = new FS::quotation { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::quotation object represents a quotation. FS::quotation inherits from
FS::Record. The following fields are currently supported:
=over 4
=item quotationnum
primary key
=item prospectnum
prospectnum
=item custnum
custnum
=item _date
_date
=item disabled
disabled
=item usernum
usernum
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new quotation. To add the quotation 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 { 'quotation'; }
sub notice_name { 'Quotation'; }
sub template_conf { 'quotation_'; }
=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 quotation. 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('quotationnum')
|| $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum' )
|| $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum' )
|| $self->ut_numbern('_date')
|| $self->ut_enum('disabled', [ '', 'Y' ])
|| $self->ut_numbern('usernum')
;
return $error if $error;
$self->_date(time) unless $self->_date;
$self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
$self->SUPER::check;
}
=item prospect_main
=item cust_main
=item cust_bill_pkg
=cut
sub cust_bill_pkg { #actually quotation_pkg objects
shift->quotation_pkg(@_);
}
=item total_setup
=cut
sub total_setup {
my $self = shift;
$self->_total('setup');
}
=item total_recur [ FREQ ]
=cut
sub total_recur {
my $self = shift;
#=item total_recur [ FREQ ]
#my $freq = @_ ? shift : '';
$self->_total('recur');
}
sub _total {
my( $self, $method ) = @_;
my $total = 0;
$total += $_->$method() for $self->cust_bill_pkg;
sprintf('%.2f', $total);
}
#prevent things from falsely showing up as taxes, at least until we support
# quoting tax amounts..
sub _items_tax {
return ();
}
sub _items_nontax {
shift->cust_bill_pkg;
}
sub _items_total {
my( $self, $total_items ) = @_;
if ( $self->total_setup > 0 ) {
push @$total_items, {
'total_item' => $self->mt( $self->total_recur > 0 ? 'Total Setup' : 'Total' ),
'total_amount' => $self->total_setup,
};
}
#could/should add up the different recurring frequencies on lines of their own
# but this will cover the 95% cases for now
if ( $self->total_recur > 0 ) {
push @$total_items, {
'total_item' => $self->mt('Total Recurring'),
'total_amount' => $self->total_recur,
};
}
}
=item enable_previous
=cut
sub enable_previous { 0 }
=item convert_cust_main
If this quotation already belongs to a customer, then returns that customer, as
an FS::cust_main object.
Otherwise, creates a new customer (FS::cust_main object and record, and
associated) based on this quotation's prospect, then orders this quotation's
packages as real packages for the customer.
If there is an error, returns an error message, otherwise, returns the
newly-created FS::cust_main object.
=cut
sub convert_cust_main {
my $self = shift;
my $cust_main = $self->cust_main;
return $cust_main if $cust_main; #already converted, don't again
my $oldAutoCommit = $FS::UID::AutoCommit;
local $FS::UID::AutoCommit = 0;
my $dbh = dbh;
$cust_main = $self->prospect_main->convert_cust_main;
unless ( ref($cust_main) ) { # eq 'FS::cust_main' ) {
$dbh->rollback if $oldAutoCommit;
return $cust_main;
}
$self->prospectnum('');
$self->custnum( $cust_main->custnum );
my $error = $self->replace || $self->order;
if ( $error ) {
$dbh->rollback if $oldAutoCommit;
return $error;
}
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
$cust_main;
}
=item order
This method is for use with quotations which are already associated with a customer.
Orders this quotation's packages as real packages for the customer.
If there is an error, returns an error message, otherwise returns false.
=cut
sub order {
my $self = shift;
tie my %cust_pkg, 'Tie::RefHash',
map { FS::cust_pkg->new({ pkgpart => $_->pkgpart,
quantity => $_->quantity,
})
=> [] #services
}
$self->quotation_pkg ;
$self->cust_main->order_pkgs( \%cust_pkg );
}
=back
=head1 CLASS METHODS
=over 4
=item search_sql_where HASHREF
Class method which returns an SQL WHERE fragment to search for parameters
specified in HASHREF. Valid parameters are
=over 4
=item _date
List reference of start date, end date, as UNIX timestamps.
=item invnum_min
=item invnum_max
=item agentnum
=item charged
List reference of charged limits (exclusive).
=item owed
List reference of charged limits (exclusive).
=item open
flag, return open invoices only
=item net
flag, return net invoices only
=item days
=item newest_percust
=back
Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
=cut
sub search_sql_where {
my($class, $param) = @_;
#if ( $DEBUG ) {
# warn "$me search_sql_where called with params: \n".
# join("\n", map { " $_: ". $param->{$_} } keys %$param ). "\n";
#}
my @search = ();
#agentnum
if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
push @search, "( prospect_main.agentnum = $1 OR cust_main.agentnum = $1 )";
}
# #refnum
# if ( $param->{'refnum'} =~ /^(\d+)$/ ) {
# push @search, "cust_main.refnum = $1";
# }
#prospectnum
if ( $param->{'prospectnum'} =~ /^(\d+)$/ ) {
push @search, "quotation.prospectnum = $1";
}
#custnum
if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
push @search, "cust_bill.custnum = $1";
}
#_date
if ( $param->{_date} ) {
my($beginning, $ending) = @{$param->{_date}};
push @search, "quotation._date >= $beginning",
"quotation._date < $ending";
}
#quotationnum
if ( $param->{'quotationnum_min'} =~ /^(\d+)$/ ) {
push @search, "quotation.quotationnum >= $1";
}
if ( $param->{'quotationnum_max'} =~ /^(\d+)$/ ) {
push @search, "quotation.quotationnum <= $1";
}
# #charged
# if ( $param->{charged} ) {
# my @charged = ref($param->{charged})
# ? @{ $param->{charged} }
# : ($param->{charged});
#
# push @search, map { s/^charged/cust_bill.charged/; $_; }
# @charged;
# }
my $owed_sql = FS::cust_bill->owed_sql;
#days
push @search, "quotation._date < ". (time-86400*$param->{'days'})
if $param->{'days'};
#agent virtualization
my $curuser = $FS::CurrentUser::CurrentUser;
#false laziness w/search/quotation.html
push @search,' ( '. $curuser->agentnums_sql( table=>'prospect_main' ).
' OR '. $curuser->agentnums_sql( table=>'cust_main' ).
' ) ';
join(' AND ', @search );
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|