package FS::quotation;
-use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record );
+use base qw( FS::Template_Mixin FS::cust_main_Mixin FS::otaker_Mixin FS::Record
+ );
use strict;
-use FS::Record qw( qsearch qsearchs );
+use Tie::RefHash;
use FS::CurrentUser;
+use FS::UID qw( dbh );
+use FS::Maketext qw( emt );
use FS::cust_main;
-use FS::prospect_main;
-use FS::quotation_pkg;
+use FS::cust_pkg;
=head1 NAME
$self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
+ return 'prospectnum or custnum must be specified'
+ if ! $self->prospectnum
+ && ! $self->custnum;
+
$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 prospect_main {
+sub total_setup {
my $self = shift;
- qsearchs('prospect_main', { 'prospectnum' => $self->prospectnum } );
+ $self->_total('setup');
}
-=item cust_main
+=item total_recur [ FREQ ]
=cut
-sub cust_main {
+sub total_recur {
my $self = shift;
- qsearchs('cust_main', { 'custnum' => $self->custnum } );
+#=item total_recur [ FREQ ]
+ #my $freq = @_ ? shift : '';
+ $self->_total('recur');
}
-=item cust_bill_pkg
+sub _total {
+ my( $self, $method ) = @_;
+
+ my $total = 0;
+ $total += $_->$method() for $self->cust_bill_pkg;
+ sprintf('%.2f', $total);
+
+}
+
+sub email {
+ my $self = shift;
+ my $opt = shift || {};
+ if ($opt and !ref($opt)) {
+ die ref($self). '->email called with positional parameters';
+ }
+
+ my $conf = $self->conf;
+
+ my $from = delete $opt->{from};
+
+ # this is where we set the From: address
+ $from ||= $conf->config('quotation_from', $self->cust_or_prospect->agentnum )
+ || $conf->config('invoice_from', $self->cust_or_prospect->agentnum );
+
+ $self->SUPER::email( {
+ 'from' => $from,
+ %$opt,
+ });
+
+}
+
+sub email_subject {
+ my $self = shift;
+
+ my $subject =
+ $self->conf->config('quotation_subject') #, $self->cust_main->agentnum)
+ || 'Quotation';
+
+ #my $cust_main = $self->cust_main;
+ #my $name = $cust_main->name;
+ #my $name_short = $cust_main->name_short;
+ #my $invoice_number = $self->invnum;
+ #my $invoice_date = $self->_date_pretty;
+
+ eval qq("$subject");
+}
+
+=item cust_or_prosect
=cut
-sub cust_bill_pkg {
+sub cust_or_prospect {
my $self = shift;
- #actually quotation_pkg objects
- qsearch('quotation_pkg', { quotationnum=>$self->quotationnum });
+ $self->custnum ? $self->cust_main : $self->prospect_main;
}
-=back
+=item cust_or_prospect_label_link P
+
+HTML links to either the customer or prospect.
+
+Returns a list consisting of two elements. The first is a text label for the
+link, and the second is the URL.
+
+=cut
+
+sub cust_or_prospect_label_link {
+ my( $self, $p ) = @_;
+
+ if ( my $custnum = $self->custnum ) {
+ my $display_custnum = $self->cust_main->display_custnum;
+ my $target = $FS::CurrentUser::CurrentUser->default_customer_view eq 'jumbo'
+ ? '#quotations'
+ : ';show=quotations';
+ (
+ emt("View this customer (#[_1])",$display_custnum) =>
+ "${p}view/cust_main.cgi?custnum=$custnum$target"
+ );
+ } elsif ( my $prospectnum = $self->prospectnum ) {
+ (
+ emt("View this prospect (#[_1])",$prospectnum) =>
+ "${p}view/prospect_main.html?$prospectnum"
+ );
+ } else { #die?
+ ( '', '' );
+ }
+
+}
+
+#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
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 );
+
+}
+
+=item disable
+
+Disables this quotation (sets disabled to Y, which hides the quotation on
+prospects and customers).
+
+If there is an error, returns an error message, otherwise returns false.
+
+=cut
+
+sub disable {
+ my $self = shift;
+ $self->disabled('Y');
+ $self->replace();
+}
+
+=item enable
+
+Enables this quotation.
+
+If there is an error, returns an error message, otherwise returns false.
+
+=cut
+
+sub enable {
+ my $self = shift;
+ $self->disabled('');
+ $self->replace();
+}
+
+=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
projects / freeside.git / blobdiff