add list_payments and payment_receipt self-service API calls, RT#75517
[freeside.git] / FS / FS / ClientAPI / MyAccount.pm
1 package FS::ClientAPI::MyAccount;
2
3 use 5.008; #require 5.8+ for Time::Local 1.05+
4 use strict;
5 use vars qw( $cache $DEBUG $me );
6 use subs qw( _cache _provision );
7 use IO::Scalar;
8 use Data::Dumper;
9 use Digest::MD5 qw(md5_hex);
10 use Digest::SHA qw(sha512_hex);
11 use Date::Format;
12 use Time::Duration;
13 use Time::Local qw(timelocal_nocheck);
14 use Business::CreditCard 0.35;
15 use HTML::Entities;
16 use Text::CSV_XS;
17 use Spreadsheet::WriteExcel;
18 use OLE::Storage_Lite;
19 use FS::UI::Web::small_custview qw(small_custview); #less doh
20 use FS::UI::Web;
21 use FS::UI::bytecount qw( display_bytecount );
22 use FS::Conf;
23 #use FS::UID qw(dbh);
24 use FS::Record qw(qsearch qsearchs dbh);
25 use FS::Msgcat qw(gettext);
26 use FS::Misc qw(card_types money_pretty);
27 use FS::Misc::DateTime qw(parse_datetime);
28 use FS::TicketSystem;
29 use FS::ClientAPI_SessionCache;
30 use FS::cust_svc;
31 use FS::svc_acct;
32 use FS::svc_forward;
33 use FS::svc_domain;
34 use FS::svc_phone;
35 use FS::svc_external;
36 use FS::svc_dsl;
37 use FS::dsl_device;
38 use FS::part_svc;
39 use FS::cust_main;
40 use FS::cust_bill;
41 use FS::legacy_cust_bill;
42 use FS::cust_main_county;
43 use FS::part_pkg;
44 use FS::cust_pkg;
45 use FS::payby;
46 use FS::acct_rt_transaction;
47 use FS::msg_template;
48 use FS::contact;
49 use FS::cust_location;
50
51 # for code organization
52 use FS::ClientAPI::MyAccount::contact;
53 use FS::ClientAPI::MyAccount::quotation;
54
55 $DEBUG = 0;
56 $me = '[FS::ClientAPI::MyAccount]';
57
58 use vars qw( @cust_main_editable_fields @location_editable_fields );
59 @cust_main_editable_fields = qw(
60   first last company daytime night fax mobile
61   locale
62   payby payinfo payname paystart_month paystart_year payissue payip
63   ss paytype paystate stateid stateid_state
64 );
65 @location_editable_fields = qw(
66   address1 address2 city county state zip country
67 );
68
69
70 BEGIN { #preload to reduce time customer_info takes
71   if ( $FS::TicketSystem::system ) {
72     warn "$me: initializing ticket system\n" if $DEBUG;
73     FS::TicketSystem->init();
74   }
75 }
76
77 sub _cache {
78   $cache ||= new FS::ClientAPI_SessionCache( {
79                'namespace' => 'FS::ClientAPI::MyAccount',
80              } );
81 }
82
83 sub skin_info {
84   my $p = shift;
85
86   my($context, $session, $custnum) = _custoragent_session_custnum($p);
87   #return { 'error' => $session } if $context eq 'error';
88
89   my $agentnum = '';
90   if ( $context eq 'customer' ) {
91
92     my $sth = dbh->prepare('SELECT agentnum FROM cust_main WHERE custnum = ?')
93       or die dbh->errstr;
94
95     $sth->execute($custnum) or die $sth->errstr;
96
97     $agentnum = $sth->fetchrow_arrayref->[0]
98       or die "no agentnum for custnum $custnum";
99
100   #} elsif ( $context eq 'agent' ) {
101   } elsif ( defined($p->{'agentnum'}) and $p->{'agentnum'} =~ /^(\d+)$/ ) {
102     $agentnum = $1;
103   }
104   $p->{'agentnum'} = $agentnum;
105
106   my $conf = new FS::Conf;
107
108   #false laziness w/Signup.pm
109
110   my $skin_info_cache_agent = _cache->get("skin_info_cache_agent$agentnum");
111
112   if ( $skin_info_cache_agent ) {
113
114     warn "$me loading cached skin info for agentnum $agentnum\n"
115       if $DEBUG > 1;
116
117   } else {
118
119     warn "$me populating skin info cache for agentnum $agentnum\n"
120       if $DEBUG > 1;
121
122     $skin_info_cache_agent = {
123       'agentnum' => $agentnum,
124       ( map { $_ => scalar( $conf->config($_, $agentnum) ) }
125         qw( company_name date_format ) ),
126       ( map { $_ => scalar( $conf->config("selfservice-$_", $agentnum ) ) }
127         qw( body_bgcolor box_bgcolor stripe1_bgcolor stripe2_bgcolor
128             text_color link_color vlink_color hlink_color alink_color
129             font title_color title_align title_size menu_bgcolor menu_fontsize
130           )
131       ),
132       'menu_disable' => [ $conf->config('selfservice-menu_disable',$agentnum) ],
133       ( map { $_ => $conf->exists("selfservice-$_", $agentnum ) }
134         qw( menu_skipblanks menu_skipheadings menu_nounderline no_logo enable_payment_without_balance )
135       ),
136       ( map { $_ => scalar($conf->config_binary("selfservice-$_", $agentnum)) }
137         qw( title_left_image title_right_image
138             menu_top_image menu_body_image menu_bottom_image
139           )
140       ),
141       'logo' => scalar($conf->config_binary('logo.png', $agentnum )),
142       ( map { $_ => join("\n", $conf->config("selfservice-$_", $agentnum ) ) }
143         qw( head body_header body_footer company_address ) ),
144       'money_char' => $conf->config("money_char") || '$',
145       'menu' => join("\n", $conf->config("ng_selfservice-menu", $agentnum ) ) ||
146                 'main.php Home
147
148                  services.php Services
149                  services.php My Services
150                  services_new.php Order a new service
151
152                  personal.php Profile
153                  personal.php Personal Information
154                  password.php Change Password
155
156                  payment.php Payments
157                  payment_cc.php Credit Card Payment
158                  payment_ach.php Electronic Check Payment
159                  payment_paypal.php PayPal Payment
160                  payment_webpay.php Webpay Payments
161
162                  usage.php Usage
163                  usage_data.php Data usage
164                  usage_cdr.php Call usage
165
166                  tickets.php Help Desk
167                  tickets.php Open Tickets
168                  tickets_resolved.php Resolved Tickets
169                  ticket_create.php Create a new ticket
170
171                  docs.php FAQs
172
173                  logout.php Logout
174                 ',
175     };
176
177     _cache->set("skin_info_cache_agent$agentnum", $skin_info_cache_agent);
178
179   }
180
181   #{ %$skin_info_cache_agent };
182   $skin_info_cache_agent;
183
184 }
185
186 sub login_info {
187   my $p = shift;
188
189   my $conf = new FS::Conf;
190
191   my %info = (
192     %{ skin_info($p) },
193     'phone_login'  => $conf->exists('selfservice_server-phone_login'),
194     'single_domain'=> scalar($conf->config('selfservice_server-single_domain')),
195     'banner_url'       => scalar($conf->config('selfservice-login_banner_url')),
196     'banner_image_md5' => 
197       md5_hex($conf->config_binary('selfservice-login_banner_image')),
198   );
199
200   return \%info;
201
202 }
203
204 sub login_banner_image {
205   my $p = shift;
206   my $conf = new FS::Conf;
207   my $image = $conf->config_binary('selfservice-login_banner_image');
208   return { 
209     'md5'   => md5_hex($image),
210     'image' => $image,
211   };
212 }
213
214 #false laziness w/FS::ClientAPI::passwd::passwd
215 sub login {
216   my $p = shift;
217
218   my $conf = new FS::Conf;
219
220   my $svc_x = '';
221   my $session = {};
222   if ( $p->{'domain'} eq 'svc_phone'
223        && $conf->exists('selfservice_server-phone_login') ) { 
224
225     my $svc_phone = qsearchs( 'svc_phone', { 'phonenum' => $p->{'username'} } );
226     return { error => 'Number not found.' } unless $svc_phone;
227
228     #XXX?
229     #my $pkg_svc = $svc_acct->cust_svc->pkg_svc;
230     #return { error => 'Only primary user may log in.' } 
231     #  if $conf->exists('selfservice_server-primary_only')
232     #    && ( ! $pkg_svc || $pkg_svc->primary_svc ne 'Y' );
233
234     return { error => 'Incorrect PIN.' }
235       unless $svc_phone->check_pin($p->{'password'});
236
237     $svc_x = $svc_phone;
238
239   } elsif ( $p->{email}
240               && (my $contact = FS::contact->by_selfservice_email($p->{email}))
241           )
242   {
243     return { error => 'Incorrect contact password.' }
244       unless $contact->authenticate_password($p->{'password'});
245
246     $session->{'contactnum'} = $contact->contactnum;
247
248     $session->{'custnum'} = $contact->custnum;
249
250   } else {
251
252     ( $p->{username}, $p->{domain} ) = split('@', $p->{email}) if $p->{email};
253
254     my $svc_domain = qsearchs('svc_domain', { 'domain' => $p->{'domain'} } )
255       or return { error => 'Domain '. $p->{'domain'}. ' not found' };
256
257     my @svc_acct = qsearch( 'svc_acct', { 'username'  => $p->{'username'},
258                                           'domsvc'    => $svc_domain->svcnum, }
259                           );
260
261     if ( $conf->exists('selfservice_server-login_svcpart') ) {
262       my @svcpart = $conf->config('selfservice_server-login_svcpart');
263       @svc_acct = grep { my $svcpart = $_->cust_svc->svcpart;
264                          scalar( grep( $_ eq $svcpart, @svcpart ) );
265                        }
266                     @svc_acct;
267     }
268
269     if ( $conf->exists('selfservice_server-primary_only') ) {
270         @svc_acct =
271           grep {
272             my $cust_svc = $_->cust_svc;
273             $cust_svc->cust_pkg->part_pkg->svcpart([qw( svc_acct svc_phone )])
274               == $cust_svc->svcpart
275           }
276           @svc_acct;
277     }
278
279     return { error => 'User not found.' } unless @svc_acct;
280
281     #return { error => 'Multiple users.' } if scalar(@svc_acct) > 1;
282
283     my $svc_acct = $svc_acct[0];
284
285     if ( $conf->exists('selfservice_server-login_svcpart') ) {
286       my @svcpart = $conf->config('selfservice_server-login_svcpart');
287       my $svcpart = $svc_acct->cust_svc->svcpart;
288       return { error => 'Invalid user.' } 
289         unless grep($_ eq $svcpart, @svcpart);
290     }
291
292     return { error => 'Incorrect password.' }
293       unless $svc_acct->check_password($p->{'password'});
294
295     $svc_x = $svc_acct;
296
297   }
298
299   if ( $svc_x ) {
300
301     $session->{'svcnum'} = $svc_x->svcnum;
302
303     my $cust_svc = $svc_x->cust_svc;
304     my $cust_pkg = $cust_svc->cust_pkg;
305     if ( $cust_pkg ) {
306       my $cust_main = $cust_pkg->cust_main;
307       $session->{'custnum'} = $cust_main->custnum;
308       if ( $conf->exists('pkg-balances') ) {
309         my @cust_pkg = grep { $_->part_pkg->freq !~ /^(0|$)/ }
310                             $cust_main->ncancelled_pkgs;
311         $session->{'pkgnum'} = $cust_pkg->pkgnum
312           if scalar(@cust_pkg) > 1;
313       }
314     }
315
316     #my $pkg_svc = $svc_acct->cust_svc->pkg_svc;
317     #return { error => 'Only primary user may log in.' } 
318     #  if $conf->exists('selfservice_server-primary_only')
319     #    && ( ! $pkg_svc || $pkg_svc->primary_svc ne 'Y' );
320     my $part_pkg = $cust_pkg->part_pkg;
321     return { error => 'Only primary user may log in.' }
322       if $conf->exists('selfservice_server-primary_only')
323          && $cust_svc->svcpart != $part_pkg->svcpart([qw( svc_acct svc_phone )]);
324
325   }
326
327   my $session_id;
328   do {
329     $session_id = md5_hex(md5_hex(time(). {}. rand(). $$))
330   } until ( ! defined _cache->get($session_id) ); #just in case
331
332   my $timeout = $conf->config('selfservice-session_timeout') || '1 hour';
333   _cache->set( $session_id, $session, $timeout );
334
335   return { 'error'      => '',
336            'session_id' => $session_id,
337          };
338 }
339
340 sub logout {
341   my $p = shift;
342   my $skin_info = skin_info($p);
343   if ( $p->{'session_id'} ) {
344     _cache->remove($p->{'session_id'});
345     return { %$skin_info, 'error' => '' };
346   } else {
347     return { %$skin_info, 'error' => "Can't resume session" }; #better error message
348   }
349 }
350
351 sub switch_acct {
352   my $p = shift;
353
354   my($context, $session, $custnum) = _custoragent_session_custnum($p);
355   return { 'error' => $session } if $context eq 'error';
356
357   my $svc_acct = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct' )
358     or return { 'error' => "Service not found" };
359
360   $session->{'svcnum'} = $svc_acct->svcnum;
361
362   my $conf = new FS::Conf;
363   my $timeout = $conf->config('selfservice-session_timeout') || '1 hour';
364   _cache->set( $p->{'session_id'}, $session, $timeout );
365
366   return { 'error' => '' };
367
368 }
369
370 sub payment_gateway {
371   # internal use only
372   # takes a cust_main and a cust_payby entry, returns the payment_gateway
373   my $conf = new FS::Conf;
374   my $cust_main = shift;
375   my $cust_payby = shift;
376   my $gatewaynum = $conf->config('selfservice-payment_gateway');
377   if ( $gatewaynum ) {
378     my $pg = qsearchs('payment_gateway', { gatewaynum => $gatewaynum });
379     die "configured gatewaynum $gatewaynum not found!" if !$pg;
380     return $pg;
381   }
382   else {
383     return '' if ! FS::payby->realtime($cust_payby);
384     my $pg = $cust_main->agent->payment_gateway(
385       'method'  => FS::payby->payby2bop($cust_payby),
386       'nofatal' => 1
387     );
388     return $pg;
389   }
390 }
391
392 sub access_info {
393   my $p = shift;
394
395   my $conf = new FS::Conf;
396
397   my $info = skin_info($p);
398
399   use vars qw( $cust_paybys ); #cache for performance
400   unless ( $cust_paybys ) {
401
402     my %cust_paybys = map { $_ => 1 }
403                       map { FS::payby->payby2payment($_) }
404                           $conf->config('signup_server-payby');
405
406     $cust_paybys = [ keys %cust_paybys ];
407
408   }
409   $info->{'cust_paybys'} = $cust_paybys;
410
411   my($context, $session, $custnum) = _custoragent_session_custnum($p);
412   return { 'error' => $session } if $context eq 'error';
413
414   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
415     or return { 'error' => "unknown custnum $custnum" };
416
417   $info->{'hide_payment_fields'} = [ 
418     map { 
419       my $pg = payment_gateway($cust_main, $_);
420       $pg && $pg->gateway_namespace eq 'Business::OnlineThirdPartyPayment';
421     } @{ $info->{cust_paybys} }
422   ];
423
424   $info->{'self_suspend_reason'} = 
425       $conf->config('selfservice-self_suspend_reason', $cust_main->agentnum);
426
427   $info->{'edit_ticket_subject'} =
428       $conf->exists('ticket_system-selfservice_edit_subject') && 
429       $cust_main->edit_subject;
430
431   $info->{'timeout'} = $conf->config('selfservice-timeout') || 3600;
432
433   $info->{'hide_usage'} = $conf->exists('selfservice_hide-usage');
434
435   return { %$info,
436            'custnum'       => $custnum,
437            'access_pkgnum' => $session->{'pkgnum'},
438            'access_svcnum' => $session->{'svcnum'},
439          };
440 }
441
442 sub customer_info {
443   my $p = shift;
444
445   my($context, $session, $custnum) = _custoragent_session_custnum($p);
446   return { 'error' => $session } if $context eq 'error';
447
448   my %return;
449
450   my $conf = new FS::Conf;
451   $return{'require_address2'} = $conf->exists('cust_main-require_address2');
452
453 #  if ( $FS::TicketSystem::system ) {
454 #    warn "$me customer_info: initializing ticket system\n" if $DEBUG;
455 #    FS::TicketSystem->init();
456 #  }
457  
458   if ( $custnum ) { #customer record
459
460     %return = ( %return, %{ customer_info_short($p) } );
461
462     #redundant with customer_info_short, but we need it for several things below
463     my $search = { 'custnum' => $custnum };
464     $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
465     my $cust_main = qsearchs('cust_main', $search )
466       or return { 'error' => "unknown custnum $custnum" };
467
468     my $list_tickets = list_tickets($p);
469     $return{'tickets'} = $list_tickets->{'tickets'};
470
471     if ( $session->{'pkgnum'} ) {
472       #XXX open invoices in the pkg-balances case
473     } else {
474       $return{'money_char'} = $conf->config("money_char") || '$';
475       my @open = map {
476                        {
477                          invnum     => $_->invnum,
478                          date       => time2str("%b %o, %Y", $_->_date),
479                          owed       => $_->owed,
480                          charged    => $_->charged,
481                        };
482                      } $cust_main->open_cust_bill;
483       $return{open_invoices} = \@open;
484
485       my $sql = 'SELECT MAX(_date) FROM cust_bill WHERE custnum = ?';
486       my $sth = dbh->prepare($sql) or die  dbh->errstr;
487       $sth->execute($custnum)      or die $sth->errstr;
488       $return{'last_invoice_date'} = $sth->fetchrow_arrayref->[0];
489       $return{'last_invoice_date_pretty'} =
490         time2str('%m/%d/%Y', $return{'last_invoice_date'} );
491     }
492
493     #customer_info_short always has nobalance on..
494     $return{small_custview} =
495       small_custview( $cust_main,
496                       $return{countrydefault},
497                       ( $session->{'pkgnum'} ? 1 : 0 ), #nobalance
498                     );
499
500     $return{has_ship_address} = $cust_main->has_ship_address;
501     $return{status} = $cust_main->status;
502     $return{statuscolor} = $cust_main->statuscolor;
503
504     # compatibility: some places in selfservice use this to determine
505     # if there's a ship address
506     if ( $return{has_ship_address} ) {
507       $return{ship_last}  = $cust_main->last;
508       $return{ship_first} = $cust_main->first;
509     }
510
511     if (scalar($conf->config('support_packages'))) {
512       my @support_services = ();
513       foreach ($cust_main->support_services) {
514         my $seconds = $_->svc_x->seconds || 0;
515         my $time_remaining = (($seconds < 0) ? '-' : '' ).
516                              int(abs($seconds)/3600)."h".
517                              sprintf("%02d",(abs($seconds)%3600)/60)."m";
518         my $cust_pkg = $_->cust_pkg;
519         my $pkgnum = '';
520         my $pkg = '';
521         $pkgnum = $cust_pkg->pkgnum if $cust_pkg;
522         $pkg = $cust_pkg->part_pkg->pkg if $cust_pkg;
523         push @support_services, { svcnum => $_->svcnum,
524                                   time => $time_remaining,
525                                   pkgnum => $pkgnum,
526                                   pkg => $pkg,
527                                 };
528       }
529       $return{support_services} = \@support_services;
530     }
531
532     if ( $conf->config('prepayment_discounts-credit_type') ) {
533       #need to eval?
534       $return{discount_terms_hash} = { $cust_main->discount_terms_hash };
535     }
536
537   } elsif ( $session->{'svcnum'} ) { #no customer record
538
539     my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $session->{'svcnum'} } )
540       or die "unknown svcnum";
541     $return{name} = $svc_acct->email;
542
543   } else {
544
545     return { 'error' => 'Expired session' }; #XXX redirect to login w/this err!
546
547   }
548
549   return { 'error'   => '',
550            'custnum' => $custnum,
551            %return,
552          };
553
554 }
555
556 sub customer_info_short {
557   my $p = shift;
558
559   my($context, $session, $custnum) = _custoragent_session_custnum($p);
560   return { 'error' => $session } if $context eq 'error';
561
562   my %return;
563
564   my $conf = new FS::Conf;
565
566   if ( $custnum ) { #customer record
567
568     my $search = { 'custnum' => $custnum };
569     $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
570     my $cust_main = qsearchs('cust_main', $search )
571       or return { 'error' => "unknown custnum $custnum" };
572
573     $return{display_custnum} = $cust_main->display_custnum;
574
575     if ( $session->{'pkgnum'} ) { 
576       $return{balance} = $cust_main->balance_pkgnum( $session->{'pkgnum'} );
577       #next_bill_date from cust_pkg?
578     } else {
579       $return{balance} = $cust_main->balance;
580       $return{next_bill_date} = $cust_main->next_bill_date;
581       $return{next_bill_date_pretty} =
582         $return{next_bill_date} ? time2str('%m/%d/%Y', $return{next_bill_date} )
583                                 : '(none)';
584     }
585     $return{balance_pretty} = money_pretty($return{balance});
586
587     $return{countrydefault} = scalar($conf->config('countrydefault'));
588
589     $return{small_custview} =
590       small_custview( $cust_main,
591                       $return{countrydefault},
592                       1, ##nobalance
593                     );
594
595     $return{name} = $cust_main->first. ' '. $cust_main->get('last');
596
597     $return{payby} = $cust_main->payby;
598
599     #none of these are terribly expensive if we want 'em...
600     for (@cust_main_editable_fields) {
601       $return{$_} = $cust_main->get($_);
602     }
603     #maybe a little more expensive, but it should be cached by now
604     for (@location_editable_fields) {
605       $return{$_} = $cust_main->bill_location->get($_);
606       $return{'ship_'.$_} = $cust_main->ship_location->get($_);
607     }
608  
609     if ( $cust_main->payby =~ /^(CARD|DCRD)$/ ) {
610       $return{payinfo} = $cust_main->paymask;
611       @return{'month', 'year'} = $cust_main->paydate_monthyear;
612     }
613     
614     my @invoicing_list = $cust_main->invoicing_list;
615     $return{'invoicing_list'} =
616       join(', ', grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list );
617     $return{'postal_invoicing'} =
618       0 < ( grep { $_ eq 'POST' } @invoicing_list );
619
620     if ( $session->{'svcnum'} ) {
621       my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $session->{'svcnum'} });
622       $return{'svc_label'} = ($cust_svc->label)[1] if $cust_svc;
623       $return{'svcnum'} = $session->{'svcnum'};
624     }
625
626   } elsif ( $session->{'svcnum'} ) { #no customer record
627
628     #uuh, not supproted yet... die?
629     return { 'error' => 'customer_info_short not yet supported as agent' };
630
631   } else {
632
633     return { 'error' => 'Expired session' }; #XXX redirect to login w/this err!
634
635   }
636
637   # this is here because this routine is called by both fs_ and ng_ main pages, where it appears
638   # it is not customer-specific, though it is only shown to authenticated customers
639   # it is not currently agent-specific, though at some point it might be
640   $return{'announcement'} = join(' ',$conf->config('selfservice-announcement')) || '';
641
642   return { 'error'          => '',
643            'custnum'        => $custnum,
644            %return,
645          };
646 }
647
648 sub customer_recurring {
649   my $p = shift;
650
651   my($context, $session, $custnum) = _custoragent_session_custnum($p);
652   return { 'error' => $session } if $context eq 'error';
653
654   my %return;
655
656   my $conf = new FS::Conf;
657
658   my $search = { 'custnum' => $custnum };
659   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
660   my $cust_main = qsearchs('cust_main', $search )
661     or return { 'error' => "customer_info_short: unknown custnum $custnum" };
662
663   $return{'display_recurring'} = [ $cust_main->display_recurring ];
664
665   return { 'error'          => '',
666            'custnum'        => $custnum,
667            %return,
668          };
669 }
670
671 sub billing_history {
672   my $p = shift;
673
674   my($context, $session, $custnum) = _custoragent_session_custnum($p);
675   return { 'error' => $session } if $context eq 'error';
676
677   return { 'error' => 'No customer' } unless $custnum;
678
679   my $search = { 'custnum' => $custnum };
680   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
681   my $cust_main = qsearchs('cust_main', $search )
682     or return { 'error' => "unknown custnum $custnum" };
683
684   my %return = ();
685
686   if ( $session->{'pkgnum'} ) { 
687     #$return{balance} = $cust_main->balance_pkgnum( $session->{'pkgnum'} );
688     #next_bill_date from cust_pkg?
689     return { 'error' => 'No history for package' };
690   }
691
692   $return{balance} = $cust_main->balance;
693   $return{balance_pretty} = money_pretty($return{balance});
694   $return{next_bill_date} = $cust_main->next_bill_date;
695   $return{next_bill_date_pretty} =
696     $return{next_bill_date} ? time2str('%m/%d/%Y', $return{next_bill_date} )
697                             : '(none)';
698
699   my $conf = new FS::Conf;
700
701   $return{'history'} = [
702     $cust_main->payment_history(
703       'line_items' => $conf->exists('selfservice-billing_history-line_items'),
704       'reverse_sort' => 1,
705     )
706   ];
707
708   $return{'money_char'} = $conf->config("money_char") || '$',
709
710   return \%return;
711
712 }
713
714 sub edit_info {
715   my $p = shift;
716   my $session = _cache->get($p->{'session_id'})
717     or return { 'error' => "Can't resume session" }; #better error message
718
719   my $custnum = $session->{'custnum'}
720     or return { 'error' => "no customer record" };
721
722   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
723     or return { 'error' => "unknown custnum $custnum" };
724
725   my $new = new FS::cust_main { $cust_main->hash };
726
727   $new->set( $_ => $p->{$_} )
728     foreach grep { exists $p->{$_} } @cust_main_editable_fields;
729
730   if ( exists($p->{address1}) ) {
731     my $bill_location = FS::cust_location->new({
732         map { $_ => $p->{$_} } @location_editable_fields
733     });
734     # if this is unchanged from before, cust_main::replace will ignore it
735     $new->set('bill_location' => $bill_location);
736   }
737
738   if ( exists($p->{ship_address1}) ) {
739     my $ship_location = FS::cust_location->new({
740         map { $_ => $p->{"ship_$_"} } @location_editable_fields
741     });
742     if ( !grep { length($p->{"ship_$_"}) } @location_editable_fields ) {
743       # Selfservice unfortunately tries to indicate "same as billing 
744       # address" by sending all fields empty.  Did this ever work?
745       $ship_location = $cust_main->bill_location;
746     }
747     $new->set('ship_location' => $ship_location);
748   }
749   # but if it hasn't been passed in at all, leave ship_location alone--
750   # DON'T change it to match bill_location.
751
752   my $payby = '';
753   if (exists($p->{'payby'})) {
754     $p->{'payby'} =~ /^([A-Z]{4})$/
755       or return { 'error' => "illegal_payby " . $p->{'payby'} };
756     $payby = $1;
757   }
758
759   my $conf = new FS::Conf;
760
761   if ( $payby =~ /^(CARD|DCRD)$/ ) {
762
763     $new->paydate($p->{'year'}. '-'. $p->{'month'}. '-01');
764
765     if ( $new->payinfo eq $cust_main->paymask ) {
766       $new->payinfo($cust_main->payinfo);
767       $new->paycvv( $p->{'paycvv'} || $cust_main->paycvv );
768     } else {
769       $new->payinfo($p->{'payinfo'});
770       return { 'error' => 'CVV2 is required' }
771         if ! $p->{'paycvv'} && $conf->exists('selfservice-onfile_require_cvv');
772       $new->paycvv( $p->{'paycvv'} )
773     }
774
775     $new->set( 'payby' => $p->{'auto'} ? 'CARD' : 'DCRD' );
776
777   } elsif ( $payby =~ /^(CHEK|DCHK)$/ ) {
778
779     my $payinfo;
780     $p->{'payinfo1'} =~ /^([\dx]+)$/
781       or return { 'error' => "illegal account number ". $p->{'payinfo1'} };
782     my $payinfo1 = $1;
783      $p->{'payinfo2'} =~ /^([\dx\.]+)$/ # . turned on by echeck-country CA ?
784       or return { 'error' => "illegal ABA/routing number ". $p->{'payinfo2'} };
785     my $payinfo2 = $1;
786     $payinfo = $payinfo1. '@'. $payinfo2;
787
788     $new->payinfo( ($payinfo eq $cust_main->paymask)
789                      ? $cust_main->payinfo
790                      : $payinfo
791                  );
792
793     $new->set( 'payby' => $p->{'auto'} ? 'CHEK' : 'DCHK' );
794
795   } elsif ( $payby =~ /^(BILL)$/ ) {
796     #no-op
797   } elsif ( $payby ) {  #notyet ready
798     return { 'error' => "unknown payby $payby" };
799   }
800
801   my @invoicing_list;
802   if ( exists $p->{'invoicing_list'} || exists $p->{'postal_invoicing'} ) {
803     #false laziness with httemplate/edit/process/cust_main.cgi
804     @invoicing_list = split( /\s*\,\s*/, $p->{'invoicing_list'} );
805     push @invoicing_list, 'POST' if $p->{'postal_invoicing'};
806   } else {
807     @invoicing_list = $cust_main->invoicing_list;
808   }
809
810   my $error = $new->replace($cust_main, \@invoicing_list);
811   return { 'error' => $error } if $error;
812   #$cust_main = $new;
813   
814   return { 'error' => '' };
815 }
816
817 sub payment_info {
818   my $p = shift;
819   my $session = _cache->get($p->{'session_id'})
820     or return { 'error' => "Can't resume session" }; #better error message
821
822   ##
823   #generic
824   ##
825
826   my $conf = new FS::Conf;
827   use vars qw($payment_info); #cache for performance
828   unless ( $payment_info ) {
829
830     my %states = map { $_->state => 1 }
831                    qsearch('cust_main_county', {
832                      'country' => $conf->config('countrydefault') || 'US'
833                    } );
834
835     my %cust_paybys = map { $_ => 1 }
836                       map { FS::payby->payby2payment($_) }
837                           $conf->config('signup_server-payby');
838
839     my @cust_paybys = keys %cust_paybys;
840
841     $payment_info = {
842
843       #list all counties/states/countries
844       'cust_main_county' => 
845         [ map { $_->hashref } qsearch('cust_main_county', {}) ],
846
847       #shortcut for one-country folks
848       'states' =>
849         [ sort { $a cmp $b } keys %states ],
850
851       'card_types' => card_types(),
852
853       'withcvv'            => $conf->exists('selfservice-require_cvv'), #or enable optional cvv?
854       'require_cvv'        => $conf->exists('selfservice-require_cvv'),
855       'onfile_require_cvv' => $conf->exists('selfservice-onfile_require_cvv'),
856
857       'paytypes' => [ @FS::cust_main::paytypes ],
858
859       'paybys' => [ $conf->config('signup_server-payby') ],
860       'cust_paybys' => \@cust_paybys,
861
862       'stateid_label' => FS::Msgcat::_gettext('stateid'),
863       'stateid_state_label' => FS::Msgcat::_gettext('stateid_state'),
864
865       'show_ss'  => $conf->exists('show_ss'),
866       'show_stateid' => $conf->exists('show_stateid'),
867       'show_paystate' => $conf->exists('show_bankstate'),
868
869       'save_unchecked' => $conf->exists('selfservice-save_unchecked'),
870
871     };
872
873   }
874
875   ##
876   #customer-specific
877   ##
878
879   my %return = %$payment_info;
880
881   delete $return{'cust_main_county'} if $p->{'omit_cust_main_county'};
882
883   my $custnum = $session->{'custnum'};
884
885   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
886     or return { 'error' => "unknown custnum $custnum" };
887
888   $return{'hide_payment_fields'} = [
889     map { 
890       my $pg = payment_gateway($cust_main, $_);
891       $pg && $pg->gateway_namespace eq 'Business::OnlineThirdPartyPayment';
892     } @{ $return{cust_paybys} }
893   ];
894
895   $return{balance} = $cust_main->balance; #XXX pkg-balances?
896
897   $return{payname} = $cust_main->payname
898                      || ( $cust_main->first. ' '. $cust_main->get('last') );
899
900   $return{$_} = $cust_main->bill_location->get($_) 
901     for qw(address1 address2 city state zip);
902
903   $return{payby} = $cust_main->payby;
904   $return{stateid_state} = $cust_main->stateid_state;
905
906   if ( $cust_main->payby =~ /^(CARD|DCRD)$/ ) {
907     $return{card_type} = cardtype($cust_main->payinfo);
908     $return{payinfo} = $cust_main->paymask;
909
910     @return{'month', 'year'} = $cust_main->paydate_monthyear;
911
912   }
913
914   if ( $cust_main->payby =~ /^(CHEK|DCHK)$/ ) {
915     my ($payinfo1, $payinfo2) = split '@', $cust_main->paymask;
916     $return{payinfo1} = $payinfo1;
917     $return{payinfo2} = $payinfo2;
918     $return{paytype}  = $cust_main->paytype;
919     $return{paystate} = $cust_main->paystate;
920     $return{payname}  = $cust_main->payname;    # override 'first/last name' default from above, if any.  Is instution-name here.  (#15819)
921   }
922
923   if ( $conf->config('prepayment_discounts-credit_type') ) {
924     #need to eval?
925     $return{discount_terms_hash} = { $cust_main->discount_terms_hash };
926   }
927
928   #doubleclick protection
929   my $_date = time;
930   $return{payunique} = "webui-MyAccount-$_date-$$-". rand() * 2**32; #new
931   $return{paybatch} = $return{payunique};  #back compat
932
933   $return{credit_card_surcharge_percentage} = $conf->config('credit-card-surcharge-percentage', $cust_main->agentnum);
934
935   return { 'error' => '',
936            %return,
937          };
938
939 }
940
941 #some false laziness with httemplate/process/payment.cgi - look there for
942 #ACH and CVV support stuff
943
944 sub validate_payment {
945   my $p = shift;
946
947   my $session = _cache->get($p->{'session_id'})
948     or return { 'error' => "Can't resume session" }; #better error message
949
950   my $custnum = $session->{'custnum'};
951
952   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
953     or return { 'error' => "unknown custnum $custnum" };
954
955   $p->{'amount'} =~ /^\s*(\d+(\.\d{2})?)\s*$/
956     or return { 'error' => gettext('illegal_amount') };
957   my $amount = $1;
958   return { error => 'Amount must be greater than 0' } unless $amount > 0;
959
960   #false laziness w/tr-amount_fee.html, but we don't want selfservice users
961   #changing the hidden form values
962   my $conf = new FS::Conf;
963   my $fee_display = $conf->config('selfservice_process-display') || 'add';
964   my $fee_pkgpart = $conf->config('selfservice_process-pkgpart', $cust_main->agentnum);
965   my $fee_skip_first = $conf->exists('selfservice_process-skip_first');
966   if ( $fee_display eq 'add'
967          and $fee_pkgpart
968          and ! $fee_skip_first || scalar($cust_main->cust_pay)
969      )
970   {
971     my $fee_pkg = qsearchs('part_pkg', { pkgpart=>$fee_pkgpart } );
972     $amount = sprintf('%.2f', $amount + $fee_pkg->option('setup_fee') );
973   }
974
975   $p->{'discount_term'} =~ /^\s*(\d*)\s*$/
976     or return { 'error' => gettext('illegal_discount_term'). ': '. $p->{'discount_term'} };
977   my $discount_term = $1;
978
979   $p->{'payname'} =~ /^([\w \,\.\-\']+)$/
980     or return { 'error' => gettext('illegal_name'). " payname: ". $p->{'payname'} };
981   my $payname = $1;
982
983   $p->{'payunique'} =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
984     or return { 'error' => gettext('illegal_text'). " payunique: ". $p->{'payunique'} };
985   my $payunique = $1;
986
987   $p->{'paybatch'} =~ /^([\w \!\@\#\$\%\&\(\)\-\+\;\:\'\"\,\.\?\/\=]*)$/
988     or return { 'error' => gettext('illegal_text'). " paybatch: ". $p->{'paybatch'} };
989   my $paybatch = $1;
990
991   $payunique = $paybatch if ! length($payunique) && length($paybatch);
992
993   $p->{'payby'} ||= 'CARD';
994   $p->{'payby'} =~ /^([A-Z]{4})$/
995     or return { 'error' => "illegal_payby " . $p->{'payby'} };
996   my $payby = $1;
997
998   #false laziness w/process/payment.cgi
999   my $payinfo;
1000   my $paycvv = '';
1001   if ( $payby eq 'CHEK' || $payby eq 'DCHK' ) {
1002   
1003     $p->{'payinfo1'} =~ /^([\dx]+)$/
1004       or return { 'error' => "illegal account number ". $p->{'payinfo1'} };
1005     my $payinfo1 = $1;
1006      $p->{'payinfo2'} =~ /^([\dx]+)$/
1007       or return { 'error' => "illegal ABA/routing number ". $p->{'payinfo2'} };
1008     my $payinfo2 = $1;
1009     $payinfo = $payinfo1. '@'. $payinfo2;
1010
1011     $payinfo = $cust_main->payinfo
1012       if $cust_main->paymask eq $payinfo;
1013    
1014   } elsif ( $payby eq 'CARD' || $payby eq 'DCRD' ) {
1015    
1016     $payinfo = $p->{'payinfo'};
1017
1018     my $onfile = 0;
1019
1020     #more intelligent matching will be needed here if you change
1021     #card_masking_method and don't remove existing paymasks
1022     if ( $cust_main->paymask eq $payinfo ) {
1023       $payinfo = $cust_main->payinfo;
1024       $onfile = 1;
1025     }
1026
1027     $payinfo =~ s/\D//g;
1028     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1029       or return { 'error' => gettext('invalid_card') }; # . ": ". $self->payinfo
1030     $payinfo = $1;
1031
1032     validate($payinfo)
1033       or return { 'error' => gettext('invalid_card') }; # . ": ". $self->payinfo
1034     return { 'error' => gettext('unknown_card_type') }
1035       if $payinfo !~ /^99\d{14}$/ && cardtype($payinfo) eq "Unknown";
1036
1037     if ( length($p->{'paycvv'}) && $p->{'paycvv'} !~ /^\s*$/ ) {
1038       if ( cardtype($payinfo) eq 'American Express card' ) {
1039         $p->{'paycvv'} =~ /^\s*(\d{4})\s*$/
1040           or return { 'error' => "CVV2 (CID) for American Express cards is four digits." };
1041         $paycvv = $1;
1042       } else {
1043         $p->{'paycvv'} =~ /^\s*(\d{3})\s*$/
1044           or return { 'error' => "CVV2 (CVC2/CID) is three digits." };
1045         $paycvv = $1;
1046       }
1047     } elsif ( $conf->exists('selfservice-onfile_require_cvv') ) {
1048       return { 'error' => 'CVV2 is required' };
1049     } elsif ( !$onfile && $conf->exists('selfservice-require_cvv') ) {
1050       return { 'error' => 'CVV2 is required' };
1051     }
1052   
1053   } else {
1054     die "unknown payby $payby";
1055   }
1056
1057   my %payby2fields = (
1058     'CARD' => [ qw( paystart_month paystart_year payissue payip
1059                     address1 address2 city state zip country    ) ],
1060     'CHEK' => [ qw( ss paytype paystate stateid stateid_state payip ) ],
1061   );
1062
1063   my $card_type = '';
1064   $card_type = cardtype($payinfo) if $payby eq 'CARD';
1065
1066   { 
1067     'cust_main'      => $cust_main, #XXX or just custnum??
1068     'amount'         => sprintf('%.2f', $amount),
1069     'payby'          => $payby,
1070     'payinfo'        => $payinfo,
1071     'paymask'        => $cust_main->mask_payinfo( $payby, $payinfo ),
1072     'card_type'      => $card_type,
1073     'paydate'        => $p->{'year'}. '-'. $p->{'month'}. '-01',
1074     'paydate_pretty' => $p->{'month'}. ' / '. $p->{'year'},
1075     'month'          => $p->{'month'},
1076     'year'           => $p->{'year'},
1077     'payname'        => $payname,
1078     'payunique'      => $payunique,
1079     'paybatch'       => $paybatch,
1080     'paycvv'         => $paycvv,
1081     'payname'        => $payname,
1082     'discount_term'  => $discount_term,
1083     'pkgnum'         => $session->{'pkgnum'},
1084     map { $_ => $p->{$_} } ( @{ $payby2fields{$payby} },
1085                              qw( save auto ),
1086                            )
1087   };
1088
1089 }
1090
1091 sub store_payment {
1092   my $p = shift;
1093
1094   my $validate = validate_payment($p);
1095   return $validate if $validate->{'error'};
1096
1097   my $conf = new FS::Conf;
1098   my $timeout = $conf->config('selfservice-session_timeout') || '1 hour'; #?
1099   _cache->set( 'payment_'.$p->{'session_id'}, $validate, $timeout );
1100
1101   +{ map { $_=>$validate->{$_} }
1102       qw( card_type paymask payname paydate_pretty month year amount
1103           address1 address2 city state zip country
1104         )
1105   };
1106
1107 }
1108
1109 sub process_stored_payment {
1110   my $p = shift;
1111
1112   my $session_id = $p->{'session_id'};
1113
1114   my $payment_info = _cache->get( "payment_$session_id" )
1115     or return { 'error' => "Can't resume session" }; #better error message
1116
1117   do_process_payment($payment_info);
1118
1119 }
1120
1121 sub process_payment {
1122   my $p = shift;
1123
1124   my $payment_info = validate_payment($p);
1125   return $payment_info if $payment_info->{'error'};
1126
1127   do_process_payment($payment_info);
1128
1129 }
1130
1131 sub do_process_payment {
1132   my $validate = shift;
1133
1134   my $cust_main = $validate->{'cust_main'};
1135
1136   my $amount = delete $validate->{'amount'};
1137   my $paynum = '';
1138
1139   my $payby = delete $validate->{'payby'};
1140
1141   if ( $validate->{'save'} ) {
1142     my $new = new FS::cust_main { $cust_main->hash };
1143     if ($payby eq 'CARD' || $payby eq 'DCRD') {
1144       $new->set( $_ => $validate->{$_} )
1145         foreach qw( payname paystart_month paystart_year payissue payip );
1146       $new->set( 'payby' => $validate->{'auto'} ? 'CARD' : 'DCRD' );
1147
1148       my $bill_location = FS::cust_location->new({
1149           map { $_ => $validate->{$_} } 
1150           qw(address1 address2 city state country zip)
1151       }); # county?
1152       $new->set('bill_location' => $bill_location);
1153       # but don't allow the service address to change this way.
1154
1155     } elsif ($payby eq 'CHEK' || $payby eq 'DCHK') {
1156       $new->set( $_ => $validate->{$_} )
1157         foreach qw( payname payip paytype paystate
1158                     stateid stateid_state );
1159       $new->set( 'payby' => $validate->{'auto'} ? 'CHEK' : 'DCHK' );
1160     }
1161     $new->payinfo( $validate->{'payinfo'} ); #to properly set paymask
1162     $new->set( 'paydate' => $validate->{'paydate'} );
1163     my $error = $new->replace($cust_main);
1164     if ( $error ) {
1165       #no, this causes customers to process their payments again
1166       #return { 'error' => $error };
1167       #XXX just warn verosely for now so i can figure out how these happen in
1168       # the first place, eventually should redirect them to the "change
1169       #address" page but indicate if the payment processed?
1170       delete($validate->{'payinfo'}); #don't want to log this!
1171       warn "WARNING: error changing customer info when processing payment (not returning to customer as a processing error): $error\n".
1172            "NEW: ". Dumper($new)."\n".
1173            "OLD: ". Dumper($cust_main)."\n".
1174            "PACKET: ". Dumper($validate)."\n";
1175     } else {
1176       $cust_main = $new;
1177     }
1178   }
1179
1180   my $error = $cust_main->realtime_bop( $FS::payby::payby2bop{$payby}, $amount,
1181     'quiet'       => 1,
1182     'manual'      => 1,
1183     'selfservice' => 1,
1184     'paynum_ref'  => \$paynum,
1185     %$validate,
1186   );
1187   return { 'error' => $error } if $error;
1188
1189   #no error, so order the fee package if applicable...
1190   my $conf = new FS::Conf;
1191   my $fee_pkgpart = $conf->config('selfservice_process-pkgpart', $cust_main->agentnum);
1192   my $fee_skip_first = $conf->exists('selfservice_process-skip_first');
1193   
1194   if ( $fee_pkgpart and ! $fee_skip_first || scalar($cust_main->cust_pay) ) {
1195
1196     my $cust_pkg = new FS::cust_pkg { 'pkgpart' => $fee_pkgpart };
1197
1198     $error = $cust_main->order_pkg( 'cust_pkg' => $cust_pkg );
1199     return { 'error' => "payment processed successfully, but error ordering fee: $error" }
1200       if $error;
1201
1202     #and generate an invoice for it now too
1203     $error = $cust_main->bill( 'pkg_list' => [ $cust_pkg ] );
1204     return { 'error' => "payment processed and fee ordered successfully, but error billing fee: $error" }
1205       if $error;
1206
1207   }
1208
1209   $cust_main->apply_payments;
1210
1211   my $cust_pay = '';
1212   my $receipt_html = '';
1213   if ($paynum) {
1214       # currently supported for realtime CC only; send receipt data to SS
1215       $cust_pay = qsearchs('cust_pay', { 'paynum' => $paynum } );
1216       if($cust_pay) {
1217         $receipt_html = qq!
1218 <TABLE BGCOLOR="#cccccc" BORDER=0 CELLSPACING=2>
1219
1220 <TR>
1221   <TD ALIGN="right">Payment#</TD>
1222   <TD BGCOLOR="#FFFFFF"><B>! . $cust_pay->paynum . qq!</B></TD>
1223 </TR>
1224
1225 <TR>
1226   <TD ALIGN="right">Date</TD>
1227
1228   <TD BGCOLOR="#FFFFFF"><B>! . 
1229         time2str("%a&nbsp;%b&nbsp;%o,&nbsp;%Y&nbsp;%r", $cust_pay->_date)
1230                                                             . qq!</B></TD>
1231 </TR>
1232
1233
1234 <TR>
1235   <TD ALIGN="right">Amount</TD>
1236   <TD BGCOLOR="#FFFFFF"><B>! . sprintf('%.2f', $cust_pay->paid) . qq!</B></TD>
1237
1238 </TR>
1239
1240 <TR>
1241   <TD ALIGN="right">Payment method</TD>
1242   <TD BGCOLOR="#FFFFFF"><B>! . $cust_pay->payby_name .' #'. $cust_pay->paymask
1243                                                                 . qq!</B></TD>
1244 </TR>
1245
1246 </TABLE>
1247 !;
1248       }
1249   }
1250
1251   if ( $cust_pay ) {
1252
1253     return {
1254       'error'        => '',
1255       'amount'       => sprintf('%.2f', $cust_pay->paid),
1256       'date'         => $cust_pay->_date,
1257       'date_pretty'  => time2str('%Y-%m-%d', $cust_pay->_date),
1258       'time_pretty'  => time2str('%T', $cust_pay->_date),
1259       'auth_num'     => $cust_pay->auth,
1260       'order_num'    => $cust_pay->order_number,
1261       'receipt_html' => $receipt_html,
1262     };
1263
1264   } else {
1265
1266     return {
1267       'error'        => '',
1268       'receipt_html' => '',
1269     };
1270
1271   }
1272
1273 }
1274
1275 sub realtime_collect {
1276   my $p = shift;
1277
1278   my $session = _cache->get($p->{'session_id'})
1279     or return { 'error' => "Can't resume session" }; #better error message
1280
1281   my $custnum = $session->{'custnum'};
1282
1283   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1284     or return { 'error' => "unknown custnum $custnum" };
1285
1286   my $amount;
1287   if ( $p->{'amount'} ) {
1288     $amount = $p->{'amount'};
1289   }
1290   elsif ( $session->{'pkgnum'} ) {
1291     $amount = $cust_main->balance_pkgnum( $session->{'pkgnum'} );
1292   }
1293   else {
1294     $amount = $cust_main->balance;
1295   }
1296
1297   my $error = $cust_main->realtime_collect(
1298     'method'     => $p->{'method'},
1299     'amount'     => $amount,
1300     'pkgnum'     => $session->{'pkgnum'},
1301     'session_id' => $p->{'session_id'},
1302     'apply'      => 1,
1303     'selfservice'=> 1,
1304   );
1305   return { 'error' => $error } unless ref( $error );
1306
1307   return { 'error' => '', amount => $amount, %$error };
1308 }
1309
1310 sub start_thirdparty {
1311   my $p = shift;
1312   my $session = _cache->get($p->{'session_id'})
1313     or return { 'error' => "Can't resume session" }; #better error message
1314   my $custnum = $session->{'custnum'};
1315   my $cust_main = FS::cust_main->by_key($custnum);
1316   
1317   my $amount = $p->{'amount'}
1318     or return { error => 'no amount' };
1319
1320   my $result = $cust_main->create_payment(
1321     'method'      => $p->{'method'},
1322     'amount'      => $p->{'amount'},
1323     'pkgnum'      => $session->{'pkgnum'},
1324     'session_id'  => $p->{'session_id'},
1325   );
1326   
1327   if ( ref($result) ) { # hashref or error
1328     return $result;
1329   } else {
1330     return { error => $result };
1331   }
1332 }
1333
1334 sub finish_thirdparty {
1335   my $p = shift;
1336   my $session_id = delete $p->{'session_id'};
1337   my $session = _cache->get($session_id)
1338     or return { 'error' => "Can't resume session" };
1339   my $custnum = $session->{'custnum'};
1340   my $cust_main = FS::cust_main->by_key($custnum);
1341
1342   if ( $p->{_cancel} ) {
1343     # customer backed out of making a payment
1344     return $cust_main->cancel_payment( $session_id );
1345   }
1346   my $result = $cust_main->execute_payment( $session_id, %$p );
1347   if ( ref($result) ) {
1348     return $result;
1349   } else {
1350     return { error => $result };
1351   }
1352 }
1353
1354 sub process_payment_order_pkg {
1355   my $p = shift;
1356
1357   my $hr = process_payment($p);
1358   return $hr if $hr->{'error'};
1359
1360   order_pkg($p);
1361 }
1362
1363 sub process_payment_order_renew {
1364   my $p = shift;
1365
1366   my $hr = process_payment($p);
1367   return $hr if $hr->{'error'};
1368
1369   order_renew($p);
1370 }
1371
1372 sub process_prepay {
1373
1374   my $p = shift;
1375
1376   my $session = _cache->get($p->{'session_id'})
1377     or return { 'error' => "Can't resume session" }; #better error message
1378
1379   my %return;
1380
1381   my $custnum = $session->{'custnum'};
1382
1383   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1384     or return { 'error' => "unknown custnum $custnum" };
1385
1386   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = ( 0, 0, 0, 0, 0 );
1387   my $error = $cust_main->recharge_prepay( $p->{'prepaid_cardnum'},
1388                                            \$amount,
1389                                            \$seconds,
1390                                            \$upbytes,
1391                                            \$downbytes,
1392                                            \$totalbytes,
1393                                          );
1394
1395   return { 'error' => $error } if $error;
1396
1397   return { 'error'     => '',
1398            'amount'    => $amount,
1399            'seconds'   => $seconds,
1400            'duration'  => duration_exact($seconds),
1401            'upbytes'   => $upbytes,
1402            'upload'    => FS::UI::bytecount::bytecount_unexact($upbytes),
1403            'downbytes' => $downbytes,
1404            'download'  => FS::UI::bytecount::bytecount_unexact($downbytes),
1405            'totalbytes'=> $totalbytes,
1406            'totalload' => FS::UI::bytecount::bytecount_unexact($totalbytes),
1407          };
1408
1409 }
1410
1411 sub invoice {
1412   my $p = shift;
1413   my $session = _cache->get($p->{'session_id'})
1414     or return { 'error' => "Can't resume session" }; #better error message
1415
1416   my $custnum = $session->{'custnum'};
1417
1418   my $invnum = $p->{'invnum'};
1419
1420   my $cust_bill = qsearchs('cust_bill', { 'invnum'  => $invnum,
1421                                           'custnum' => $custnum } )
1422     or return { 'error' => "Can't find invnum" };
1423
1424   #my %return;
1425
1426   return { 'error'        => '',
1427            'invnum'       => $invnum,
1428            'invoice_text' => join('', $cust_bill->print_text ),
1429            'invoice_html' => $cust_bill->print_html( { unsquelch_cdr => 1 } ),
1430          };
1431
1432 }
1433
1434 sub invoice_pdf {
1435   my $p = shift;
1436   my $session = _cache->get($p->{'session_id'})
1437     or return { 'error' => "Can't resume session" }; #better error message
1438
1439   my $custnum = $session->{'custnum'};
1440
1441   my $invnum = $p->{'invnum'};
1442
1443   my $cust_bill = qsearchs('cust_bill', { 'invnum'  => $invnum,
1444                                           'custnum' => $custnum } )
1445     or return { 'error' => "Can't find invnum" };
1446
1447   #my %return;
1448
1449   return { 'error'       => '',
1450            'invnum'      => $invnum,
1451            'invoice_pdf' => $cust_bill->print_pdf({
1452                               'unsquelch_cdr' => 1,
1453                               'locale'        => $p->{'locale'},
1454                             }),
1455          };
1456
1457 }
1458
1459 sub legacy_invoice {
1460   my $p = shift;
1461   my $session = _cache->get($p->{'session_id'})
1462     or return { 'error' => "Can't resume session" }; #better error message
1463
1464   my $custnum = $session->{'custnum'};
1465
1466   my $legacyinvnum = $p->{'legacyinvnum'};
1467
1468   my %hash = (
1469     'legacyinvnum' => $legacyinvnum,
1470     'custnum'      => $custnum,
1471   );
1472
1473   my $legacy_cust_bill =
1474          qsearchs('legacy_cust_bill', { %hash, 'locale' => $p->{'locale'} } )
1475       || qsearchs('legacy_cust_bill', \%hash )
1476     or return { 'error' => "Can't find legacyinvnum" };
1477
1478   #my %return;
1479
1480   return { 'error'        => '',
1481            'legacyinvnum' => $legacyinvnum,
1482            'legacyid'     => $legacy_cust_bill->legacyid,
1483            'invoice_html' => $legacy_cust_bill->content_html,
1484          };
1485
1486 }
1487
1488 sub legacy_invoice_pdf {
1489   my $p = shift;
1490   my $session = _cache->get($p->{'session_id'})
1491     or return { 'error' => "Can't resume session" }; #better error message
1492
1493   my $custnum = $session->{'custnum'};
1494
1495   my $legacyinvnum = $p->{'legacyinvnum'};
1496
1497   my $legacy_cust_bill = qsearchs('legacy_cust_bill', {
1498     'legacyinvnum' => $legacyinvnum,
1499     'custnum'      => $custnum,
1500   }) or return { 'error' => "Can't find legacyinvnum" };
1501
1502   #my %return;
1503
1504   return { 'error'        => '',
1505            'legacyinvnum' => $legacyinvnum,
1506            'legacyid'     => $legacy_cust_bill->legacyid,
1507            'invoice_pdf'  => $legacy_cust_bill->content_pdf,
1508          };
1509
1510 }
1511
1512 sub invoice_logo {
1513   my $p = shift;
1514
1515   #sessioning for this?  how do we get the session id to the backend invoice
1516   # template so it can add it to the link, blah
1517
1518   my $agentnum = '';
1519   if ( $p->{'invnum'} ) {
1520     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $p->{'invnum'} } )
1521       or return { 'error' => 'unknown invnum' };
1522     $agentnum = $cust_bill->cust_main->agentnum;
1523   }
1524
1525   my $templatename = $p->{'template'} || $p->{'templatename'};
1526
1527   #false laziness-ish w/view/cust_bill-logo.cgi
1528
1529   my $conf = new FS::Conf;
1530   if ( $templatename =~ /^([^\.\/]*)$/ && $conf->exists("logo_$1.png") ) {
1531     $templatename = "_$1";
1532   } else {
1533     $templatename = '';
1534   }
1535
1536   my $filename = "logo$templatename.png";
1537
1538   return { 'error'        => '',
1539            'logo'         => $conf->config_binary($filename, $agentnum),
1540            'content_type' => 'image/png', #should allow gif, jpg too
1541          };
1542 }
1543
1544
1545 sub list_invoices {
1546   my $p = shift;
1547   my $session = _cache->get($p->{'session_id'})
1548     or return { 'error' => "Can't resume session" }; #better error message
1549
1550   my $custnum = $session->{'custnum'};
1551
1552   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1553     or return { 'error' => "unknown custnum $custnum" };
1554
1555   my $conf = new FS::Conf;
1556
1557   my @legacy_cust_bill = $cust_main->legacy_cust_bill;
1558
1559   my @cust_bill = grep ! $_->hide, $cust_main->cust_bill;
1560
1561   my $balance = 0;
1562   my $invoices = [
1563     map {
1564       #not super efficient, we also run cust_bill_pay/cust_credited inside owed
1565       my @payments_and_credits = sort {$b->_date <=> $a->_date} ($_->cust_bill_pay,$_->cust_credited);
1566       my $owed = $_->owed;
1567       $balance += $owed;
1568       +{ 'invnum'       => $_->invnum,
1569          '_date'        => $_->_date,
1570          'date'         => time2str("%b %o, %Y", $_->_date),
1571          'date_short'   => time2str("%m-%d-%Y",  $_->_date),
1572          'previous'     => sprintf('%.2f', ($_->previous)[0]),
1573          'charged'      => sprintf('%.2f', $_->charged),
1574          'owed'         => sprintf('%.2f', $owed),
1575          'balance'      => sprintf('%.2f', $balance),
1576          'lastpay'      => @payments_and_credits 
1577                            ? time2str("%b %o, %Y", $payments_and_credits[0]->_date)
1578                            : '',
1579       }
1580     } @cust_bill
1581   ];
1582
1583   return  { 'error'       => '',
1584             'balance'     => $cust_main->balance,
1585             'money_char'  => $conf->config("money_char") || '$',
1586             'invoices'    => $invoices,
1587             'legacy_invoices' => [
1588               map {
1589                     +{ 'legacyinvnum' => $_->legacyinvnum,
1590                        'legacyid'     => $_->legacyid,
1591                        '_date'        => $_->_date,
1592                        'date'         => time2str("%b %o, %Y", $_->_date),
1593                        'date_short'   => time2str("%m-%d-%Y",  $_->_date),
1594                        'charged'      => sprintf('%.2f', $_->charged),
1595                        'has_content'  => (    length($_->content_pdf)
1596                                            || length($_->content_html) ),
1597                      }
1598                   }
1599                   @legacy_cust_bill
1600             ],
1601           };
1602 }
1603
1604 sub list_payments {
1605   my $p = shift;
1606   my $session = _cache->get($p->{'session_id'})
1607     or return { 'error' => "Can't resume session" }; #better error message
1608
1609   my $custnum = $session->{'custnum'};
1610
1611   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1612     or return { 'error' => "unknown custnum $custnum" };
1613
1614   return  { 'error'       => '',
1615             'balance'     => $cust_main->balance,
1616             'money_char'  => FS::Conf->new->config("money_char") || '$',
1617             'payments'    => [ map $_->SSAPI_getinfo, $cust_main->cust_pay ],
1618           };
1619 }
1620
1621 sub payment_receipt {
1622   my $p = shift;
1623   my $session = _cache->get($p->{'session_id'})
1624     or return { 'error' => "Can't resume session" }; #better error message
1625
1626   my $custnum = $session->{'custnum'};
1627
1628   my $cust_pay = qsearchs('cust_pay', { 'custnum' => $custnum,
1629                                         'paynum'  => $p->{'paynum'},
1630                                       }
1631                          )
1632     or return { 'error' => "unknown payment ". $p->{'paynum'} };
1633
1634   return { 
1635            'error' => '',
1636            %{ $cust_pay->SSAPI_getinfo },
1637          };
1638 }
1639
1640 sub cancel {
1641   my $p = shift;
1642   my $session = _cache->get($p->{'session_id'})
1643     or return { 'error' => "Can't resume session" }; #better error message
1644
1645   my $custnum = $session->{'custnum'};
1646
1647   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
1648     or return { 'error' => "unknown custnum $custnum" };
1649
1650   my @errors = $cust_main->cancel( 'quiet'=>1 );
1651
1652   my $error = scalar(@errors) ? join(' / ', @errors) : '';
1653
1654   return { 'error' => $error };
1655
1656 }
1657
1658 sub list_pkgs {
1659   my $p = shift;
1660
1661   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1662   return { 'error' => $session } if $context eq 'error';
1663
1664   my $search = { 'custnum' => $custnum };
1665   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
1666   my $cust_main = qsearchs('cust_main', $search )
1667     or return { 'error' => "unknown custnum $custnum" };
1668
1669   my $conf = new FS::Conf;
1670   my $immutable = $conf->exists('selfservice_immutable-package');
1671   
1672 # the duplication below is necessary:
1673 # 1. to maintain the current buggy behaviour wrt the cust_pkg and part_pkg
1674 # hashes overwriting each other (setup and no_auto fields). Fixing that is a
1675 # non-backwards-compatible change breaking the software of anyone using the API
1676 # instead of the stock selfservice
1677 # 2. to return cancelled packages as well - for wholesale and non-wholesale
1678   if( $conf->exists('selfservice_server-view-wholesale') ) {
1679     return { 'svcnum'   => $session->{'svcnum'},
1680             'custnum'  => $custnum,
1681             'cust_pkg' => [ map {
1682                           { $_->hash,
1683                             immutable => $immutable,
1684                             part_pkg => [ map $_->hashref, $_->part_pkg ],
1685                             part_svc =>
1686                               [ map $_->hashref, $_->available_part_svc ],
1687                             cust_svc => 
1688                               [ map { my $ref = { $_->hash,
1689                                                   label => [ $_->label ],
1690                                                 };
1691                                       $ref->{_password} = $_->svc_x->_password
1692                                         if $context eq 'agent'
1693                                         && $conf->exists('agent-showpasswords')
1694                                         && $_->part_svc->svcdb eq 'svc_acct';
1695                                       $ref;
1696                                     } $_->cust_svc
1697                               ],
1698                           };
1699                         } $cust_main->cust_pkg
1700                   ],
1701     'small_custview' =>
1702       small_custview( $cust_main, $conf->config('countrydefault') ),
1703     'wholesale_view' => 1,
1704     'login_svcpart' => [ $conf->config('selfservice_server-login_svcpart') ],
1705     'date_format' => $conf->config('date_format') || '%m/%d/%Y',
1706     'lnp' => $conf->exists('svc_phone-lnp'),
1707       };
1708   }
1709
1710   { 'svcnum'   => $session->{'svcnum'},
1711     'custnum'  => $custnum,
1712     'cust_pkg' => [ map {
1713                           my $primary_cust_svc = $_->primary_cust_svc;
1714                           +{ $_->hash,
1715                             $_->part_pkg->hash,
1716                             immutable   => $immutable,
1717                             pkg_label   => $_->pkg_locale,
1718                             status      => $_->status,
1719                             statuscolor => $_->statuscolor,
1720                             part_svc =>
1721                               [ map { $_->hashref }
1722                                   grep { $_->selfservice_access ne 'hidden' }
1723                                     $_->available_part_svc
1724                               ],
1725                             cust_svc => 
1726                               [ map { my $ref = { $_->hash,
1727                                                   label => [ $_->label ],
1728                                                 };
1729                                       $ref->{_password} = $_->svc_x->_password
1730                                         if $context eq 'agent'
1731                                         && $conf->exists('agent-showpasswords')
1732                                         && $_->part_svc->svcdb eq 'svc_acct';
1733                                       $ref->{svchash} = { $_->svc_x->hash } if 
1734                                         $_->part_svc->svcdb eq 'svc_phone';
1735                                       $ref->{svchash}->{svcpart} =  $_->part_svc->svcpart
1736                                         if $_->part_svc->svcdb eq 'svc_phone'; # hack
1737                                       $ref;
1738                                     }
1739                                   grep { $_->part_svc->selfservice_access ne 'hidden' }
1740                                     $_->cust_svc
1741                               ],
1742                             primary_cust_svc =>
1743                               $primary_cust_svc
1744                                 ? { $primary_cust_svc->hash,
1745                                     label => [ $primary_cust_svc->label ],
1746                                     finger => $primary_cust_svc->svc_x->finger, #uuh
1747                                     $primary_cust_svc->part_svc->hash,
1748                                   }
1749                                 : {}, #'' ?
1750                           };
1751                         } $cust_main->ncancelled_pkgs
1752                   ],
1753     'small_custview' =>
1754       small_custview( $cust_main, $conf->config('countrydefault') ),
1755     'date_format' => $conf->config('date_format') || '%m/%d/%Y',
1756   };
1757
1758 }
1759
1760 sub list_svcs {
1761   my $p = shift;
1762
1763   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1764   return { 'error' => $session } if $context eq 'error';
1765
1766   my $conf = new FS::Conf;
1767
1768   my $hide_usage = $conf->exists('selfservice_hide-usage') ? 1 : 0;
1769   my $search = { 'custnum' => $custnum };
1770   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
1771   my $cust_main = qsearchs('cust_main', $search )
1772     or return { 'error' => "unknown custnum $custnum" };
1773
1774   my $pkgnum = $session->{'pkgnum'} || $p->{'pkgnum'} || '';
1775   if ( ! $pkgnum && $p->{'svcnum'} ) {
1776     my $cust_svc = qsearchs('cust_svc', { 'svcnum' => $p->{'svcnum'} } );
1777     $pkgnum = $cust_svc->pkgnum if $cust_svc;
1778   }
1779
1780   my @cust_svc = ();
1781   my @cust_pkg_usage = ();
1782   foreach my $cust_pkg ( $p->{'ncancelled'} 
1783                          ? $cust_main->ncancelled_pkgs
1784                          : $cust_main->unsuspended_pkgs ) {
1785     next if $pkgnum && $cust_pkg->pkgnum != $pkgnum;
1786     push @cust_svc, @{[ $cust_pkg->cust_svc ]}; #@{[ ]} to force array context
1787     push @cust_pkg_usage, $cust_pkg->cust_pkg_usage;
1788   }
1789
1790   @cust_svc = grep { $_->part_svc->selfservice_access ne 'hidden' } @cust_svc;
1791   my %usage_pools;
1792   if (!$hide_usage) {
1793     foreach (@cust_pkg_usage) {
1794       my $part = $_->part_pkg_usage;
1795       my $tag = $part->description . ($part->shared ? 1 : 0);
1796       my $row = $usage_pools{$tag} 
1797             ||= [ $part->description, 0, 0, $part->shared ? 1 : 0 ];
1798       $row->[1] += sprintf('%.1f', $_->minutes); # minutes remaining
1799       $row->[2] += $part->minutes; # minutes total
1800     }
1801   } # otherwise just leave them empty
1802
1803   if ( $p->{'svcdb'} ) {
1804     my $svcdb = ref($p->{'svcdb'}) eq 'HASH'
1805                   ? $p->{'svcdb'}
1806                   : ref($p->{'svcdb'}) eq 'ARRAY'
1807                     ? { map { $_=>1 } @{ $p->{'svcdb'} } }
1808                     : { $p->{'svcdb'} => 1 };
1809     @cust_svc = grep $svcdb->{ $_->part_svc->svcdb }, @cust_svc
1810   }
1811
1812   #@svc_x = sort { $a->domain cmp $b->domain || $a->username cmp $b->username }
1813   #              @svc_x;
1814
1815   my @svcs; # stuff to return to the client
1816   my %bytes_used_total; # for _used columns only
1817   foreach my $cust_svc (@cust_svc) {
1818     my $svc_x = $cust_svc->svc_x;
1819     my($label, $value) = $cust_svc->label;
1820     my $part_svc = $cust_svc->part_svc;
1821     my $svcdb = $part_svc->svcdb;
1822     my $cust_pkg = $cust_svc->cust_pkg;
1823     my $part_pkg = $cust_pkg->part_pkg;
1824
1825     my %hash = (
1826       'svcnum'         => $cust_svc->svcnum,
1827       'display_svcnum' => $cust_svc->display_svcnum,
1828       'svcdb'          => $svcdb,
1829       'label'          => $label,
1830       'value'          => $value,
1831       'pkg_label'      => $cust_pkg->pkg_locale,
1832       'pkg_status'     => $cust_pkg->status,
1833       'readonly'       => ($part_svc->selfservice_access eq 'readonly'),
1834     );
1835
1836     # would it make sense to put this in a svc_* method?
1837
1838     if (!$hide_usage and grep(/^$svcdb$/, qw(svc_acct svc_broadband)) and $part_svc->part_export_usage) {
1839       my $last_bill = $cust_pkg->last_bill || 0;
1840       my $now = time;
1841       my $up_used = $cust_svc->attribute_since_sqlradacct($last_bill,$now,'AcctInputOctets');
1842       my $down_used = $cust_svc->attribute_since_sqlradacct($last_bill,$now,'AcctOutputOctets');
1843       %hash = (
1844         %hash,
1845         'seconds_used'    => $cust_svc->seconds_since_sqlradacct($last_bill,$now),
1846         'upbytes_used'    => display_bytecount($up_used),
1847         'downbytes_used'  => display_bytecount($down_used),
1848         'totalbytes_used' => display_bytecount($up_used + $down_used)
1849       );
1850       $bytes_used_total{'seconds_used'} += $hash{'seconds_used'};
1851       $bytes_used_total{'upbytes_used'} += $up_used;
1852       $bytes_used_total{'downbytes_used'} += $down_used;
1853       $bytes_used_total{'totalbytes_used'} += $up_used + $down_used;
1854     }
1855
1856     if ( $svcdb eq 'svc_acct' ) {
1857       foreach (qw(username email finger seconds)) {
1858         $hash{$_} = $svc_x->$_;
1859       }
1860
1861       if (!$hide_usage) {
1862         %hash = (
1863           %hash,
1864           'upbytes'    => display_bytecount($svc_x->upbytes),
1865           'downbytes'  => display_bytecount($svc_x->downbytes),
1866           'totalbytes' => display_bytecount($svc_x->totalbytes),
1867
1868           'recharge_amount'  => $part_pkg->option('recharge_amount',1),
1869           'recharge_seconds' => $part_pkg->option('recharge_seconds',1),
1870           'recharge_upbytes'    =>
1871             display_bytecount($part_pkg->option('recharge_upbytes',1)),
1872           'recharge_downbytes'  =>
1873             display_bytecount($part_pkg->option('recharge_downbytes',1)),
1874           'recharge_totalbytes' =>
1875             display_bytecount($part_pkg->option('recharge_totalbytes',1)),
1876           # more...
1877         );
1878       }
1879
1880     } elsif ( $svcdb eq 'svc_dsl' ) {
1881
1882       $hash{'phonenum'} = $svc_x->phonenum;
1883       if ( $svc_x->first || $svc_x->get('last') || $svc_x->company ) {
1884         $hash{'name'} = $svc_x->first. ' '. $svc_x->get('last');
1885         $hash{'name'} = $svc_x->company. ' ('. $hash{'name'}. ')'
1886           if $svc_x->company;
1887       } else {
1888         $hash{'name'} = $cust_main->name;
1889       }
1890       # no usage to hide here
1891
1892     } elsif ( $svcdb eq 'svc_phone' or $svcdb eq 'svc_pbx' ) {
1893       if (!$hide_usage) {
1894         # could potentially show lots of things...
1895         $hash{'outbound'} = 1;
1896         $hash{'inbound'}  = 0;
1897         if ( $svcdb eq 'svc_phone' ) {
1898           if ( $part_pkg->plan eq 'voip_inbound' ) {
1899             $hash{'outbound'} = 0;
1900             $hash{'inbound'}  = 1;
1901           } elsif ( $part_pkg->option('selfservice_inbound_format')
1902                 or  $conf->config('selfservice-default_inbound_cdr_format')
1903           ) {
1904             $hash{'inbound'}  = 1;
1905           }
1906         }
1907         foreach (qw(inbound outbound)) {
1908           # hmm...we can't filter by status here, because there might
1909           # not be cdr_terminations at all.  have to go by date.
1910           # find all since the last bill date.
1911           # XXX cdr types?  we are going to need them.
1912           if ( $hash{$_} ) {
1913             my $sum_cdr = $svc_x->sum_cdrs(
1914               'inbound' => ( $_ eq 'inbound' ? 1 : 0 ),
1915               'begin'   => ($cust_pkg->last_bill || 0),
1916               'nonzero' => 1,
1917               'disable_charged_party' => 1,
1918             );
1919             $hash{$_} = $sum_cdr->hashref;
1920           }
1921         }
1922       } # not hiding usage
1923     } # svcdb
1924
1925     push @svcs, \%hash;
1926   } # foreach $cust_svc
1927
1928   foreach my $field (keys %bytes_used_total) {
1929     if ($field =~ /bytes/) {
1930       $bytes_used_total{$field} = display_bytecount($bytes_used_total{$field});
1931     }
1932   }
1933
1934   return { 
1935     'svcnum'   => $session->{'svcnum'},
1936     'custnum'  => $custnum,
1937     'date_format' => $conf->config('date_format') || '%m/%d/%Y',
1938     'view_usage_nodomain' => $conf->exists('selfservice-view_usage_nodomain'),
1939     'svcs'     => \@svcs,
1940     'bytes_used_total' => \%bytes_used_total,
1941     'usage_pools' => [
1942       map { $usage_pools{$_} }
1943       sort { $a cmp $b }
1944       keys %usage_pools
1945     ],
1946     'hide_usage' => $hide_usage,
1947   };
1948
1949 }
1950
1951 sub _customer_svc_x {
1952   my($custnum, $svcnum, $table) = (shift, shift, shift);
1953   my $hashref = ref($svcnum) ? $svcnum : { 'svcnum' => $svcnum };
1954
1955   $custnum =~ /^(\d+)$/ or die "illegal custnum";
1956   my $search = " AND custnum = $1";
1957   #$search .= " AND agentnum = ". $session->{'agentnum'} if $context eq 'agent';
1958
1959   qsearchs( {
1960     'table'     => ($table || 'svc_acct'),
1961     'addl_from' => 'LEFT JOIN cust_svc  USING ( svcnum  ) '.
1962                    'LEFT JOIN cust_pkg  USING ( pkgnum  ) ',#.
1963                    #'LEFT JOIN cust_main USING ( custnum ) ',
1964     'hashref'   => $hashref,
1965     'extra_sql' => $search, #important
1966   } );
1967
1968 }
1969
1970 sub svc_status_html {
1971   my $p = shift;
1972
1973   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1974   return { 'error' => $session } if $context eq 'error';
1975
1976   #XXX only svc_dsl for now
1977   my $svc_x = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl')
1978     or return { 'error' => "Service not found" };
1979
1980   my $html = $svc_x->getstatus_html;
1981
1982   return { 'html' => $html };
1983
1984 }
1985
1986 sub svc_status_hash {
1987   my $p = shift;
1988
1989   my($context, $session, $custnum) = _custoragent_session_custnum($p);
1990   return { 'error' => $session } if $context eq 'error';
1991
1992   #XXX only svc_acct for now
1993   my $svc_x = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct')
1994     or return { 'error' => "Service not found" };
1995
1996   my ( $html, $hashref ) = $svc_x->export_getstatus;
1997   return $hashref;
1998
1999 }
2000
2001 sub set_svc_status_hash    { _svc_method_X(shift, 'export_setstatus') }
2002 sub set_svc_status_listadd { _svc_method_X(shift, 'export_setstatus_listadd') }
2003 sub set_svc_status_listdel { _svc_method_X(shift, 'export_setstatus_listdel') }
2004 sub set_svc_status_vacationadd { _svc_method_X(shift, 'export_setstatus_vacationadd') }
2005 sub set_svc_status_vacationdel { _svc_method_X(shift, 'export_setstatus_vacationdel') }
2006
2007 sub _svc_method_X {
2008   my( $p, $method ) = @_;
2009
2010   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2011   return { 'error' => $session } if $context eq 'error';
2012
2013   #XXX only svc_acct for now
2014   my $svc_x = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct')
2015     or return { 'error' => "Service not found" };
2016
2017   warn "$method ". join(' / ', map "$_=>".$p->{$_}, keys %$p )
2018     if $DEBUG;
2019   my $error = $svc_x->$method($p); #$p? returns error?
2020   return { 'error' => $error } if $error;
2021
2022   return {}; #? { 'error' => '' }
2023
2024 }
2025
2026 sub acct_forward_info {
2027   my $p = shift;
2028
2029   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2030   return { 'error' => $session } if $context eq 'error';
2031
2032   my $svc_forward = _customer_svc_x( $custnum,
2033                                      { 'srcsvc' => $p->{'svcnum'} },
2034                                      'svc_forward',
2035                                    )
2036     or return { 'error' => '',
2037                 'dst'   => '',
2038               };
2039
2040   return { 'error' => '',
2041            'dst'   => $svc_forward->dst || $svc_forward->dstsvc_acct->email,
2042          };
2043
2044 }
2045
2046 sub process_acct_forward {
2047   my $p = shift;
2048   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2049   return { 'error' => $session } if $context eq 'error';
2050
2051   my $old = _customer_svc_x( $custnum,
2052                              { 'srcsvc' => $p->{'svcnum'} },
2053                              'svc_forward',
2054                            );
2055
2056   if ( $p->{'dst'} eq '' ) {
2057     if ( $old ) {
2058       my $error = $old->delete;
2059       return { 'error' => $error };
2060     }
2061     return { 'error' => '' };
2062   }
2063
2064   my $new = new FS::svc_forward { 'srcsvc' => $p->{'svcnum'},
2065                                   'dst'    => $p->{'dst'},
2066                                 };
2067
2068   my $error;
2069   if ( $old ) {
2070     $new->svcnum($old->svcnum);
2071     my $cust_svc = $old->cust_svc;
2072     $new->svcpart($old->svcpart);
2073     $new->pkgnuym($old->pkgnum);
2074     $error = $new->replace($old);
2075   } else {
2076     my $conf = new FS::Conf;
2077     $new->svcpart($conf->config('selfservice-svc_forward_svcpart'));
2078
2079     my $svc_acct = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_acct' )
2080       or return { 'error' => 'No service' }; #how would we even get here?
2081
2082     $new->pkgnum( $svc_acct->cust_svc->pkgnum );
2083
2084     $error = $new->insert;
2085   }
2086
2087   return { 'error' => $error };
2088
2089 }
2090
2091 sub list_dsl_devices {
2092   my $p = shift;
2093
2094   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2095   return { 'error' => $session } if $context eq 'error';
2096
2097   my $svc_dsl = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl' )
2098     or return { 'error' => "Service not found" };
2099
2100   return {
2101     'devices' => [ map {
2102                          +{ 'mac_addr' => $_->mac_addr };
2103                        } $svc_dsl->dsl_device
2104                  ],
2105   };
2106
2107 }
2108
2109 sub add_dsl_device {
2110   my $p = shift;
2111
2112   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2113   return { 'error' => $session } if $context eq 'error';
2114
2115   my $svc_dsl = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl' )
2116     or return { 'error' => "Service not found" };
2117
2118   return { 'error' => 'No MAC address supplied' }
2119     unless length($p->{'mac_addr'});
2120
2121   my $dsl_device = new FS::dsl_device { 'svcnum'   => $svc_dsl->svcnum,
2122                                         'mac_addr' => scalar($p->{'mac_addr'}),
2123                                       };
2124   my $error = $dsl_device->insert;
2125   return { 'error' => $error };
2126
2127 }
2128
2129 sub delete_dsl_device {
2130   my $p = shift;
2131
2132   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2133   return { 'error' => $session } if $context eq 'error';
2134
2135   my $svc_dsl = _customer_svc_x( $custnum, $p->{'svcnum'}, 'svc_dsl' )
2136     or return { 'error' => "Service not found" };
2137
2138   my $dsl_device = qsearchs('dsl_device', { 'svcnum'   => $svc_dsl->svcnum,
2139                                             'mac_addr' => scalar($p->{'mac_addr'}),
2140                                           }
2141                            )
2142     or return { 'error' => 'Unknown MAC address: '. $p->{'mac_addr'} };
2143
2144   my $error = $dsl_device->delete;
2145   return { 'error' => $error };
2146
2147 }
2148
2149 sub port_graph {
2150   my $p = shift;
2151   _usage_details( \&_port_graph, $p,
2152                   'svcdb' => 'svc_port',
2153                 );
2154 }
2155
2156 sub _port_graph {
2157   my($svc_port, $begin, $end) = @_;
2158   my @usage = ();
2159   my $pngOrError = $svc_port->graph_png( start=>$begin, end=> $end );
2160   push @usage, { 'png' => $pngOrError };
2161   (@usage);
2162 }
2163
2164 sub _list_svc_usage {
2165   my($svc_acct, $begin, $end) = @_;
2166   my @usage = ();
2167   foreach my $part_export ( 
2168     map { qsearch ( 'part_export', { 'exporttype' => $_ } ) }
2169     qw( sqlradius sqlradius_withdomain )
2170   ) {
2171     push @usage, @ { $part_export->usage_sessions($begin, $end, $svc_acct) };
2172   }
2173   (@usage);
2174 }
2175
2176 sub list_svc_usage {
2177   _usage_details(\&_list_svc_usage, @_);
2178 }
2179
2180 sub _list_support_usage {
2181   my($svc_acct, $begin, $end) = @_;
2182   my @usage = ();
2183   foreach ( grep { $begin <= $_->_date && $_->_date <= $end }
2184             qsearch('acct_rt_transaction', { 'svcnum' => $svc_acct->svcnum })
2185           ) {
2186     push @usage, { 'seconds'  => $_->seconds,
2187                    'support'  => $_->support,
2188                    '_date'    => $_->_date,
2189                    'id'       => $_->transaction_id,
2190                    'creator'  => $_->creator,
2191                    'subject'  => $_->subject,
2192                    'status'   => $_->status,
2193                    'ticketid' => $_->ticketid,
2194                  };
2195   }
2196   (@usage);
2197 }
2198
2199 sub list_support_usage {
2200   _usage_details(\&_list_support_usage, @_);
2201 }
2202
2203 sub _list_cdr_usage {
2204   # XXX CDR type support...
2205   # XXX any way to do a paged search on this?
2206   # we have to return the results all at once...
2207   my($svc_x, $begin, $end, %opt) = @_;
2208   map [ $_->downstream_csv(%opt, 'keeparray' => 1) ],
2209     $svc_x->get_cdrs(
2210       'begin' => $begin,
2211       'end'   => $end,
2212       'disable_charged_party' => 1,
2213       %opt
2214     );
2215 }
2216
2217 sub list_cdr_usage {
2218   my $p = shift;
2219   _usage_details( \&_list_cdr_usage, $p );
2220 }
2221
2222 sub _usage_details {
2223   my($callback, $p, %opt) = @_;
2224   my $conf = FS::Conf->new;
2225
2226   if ( $conf->exists('selfservice_hide-usage') ) {
2227     return { 'error' => 'Viewing usage is not allowed.' };
2228   }
2229
2230   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2231   return { 'error' => $session } if $context eq 'error';
2232
2233   my $search = { 'svcnum' => $p->{'svcnum'} };
2234   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2235
2236   my $cust_svc = qsearchs( 'cust_svc', $search );
2237   return { 'error' => 'No service selected in list_svc_usage' } 
2238     unless $cust_svc;
2239
2240   my $svc_x = $cust_svc->svc_x;
2241   my $svcdb = $svc_x->table;
2242   my $cust_pkg = $cust_svc->cust_pkg;
2243   my $freq     = $cust_pkg->part_pkg->freq;
2244   my %callback_opt;
2245   my $header = [];
2246   if ( $svcdb eq 'svc_phone' or $svcdb eq 'svc_pbx' ) {
2247     my $format = '';
2248     if ( $p->{inbound} ) {
2249       $format = $cust_pkg->part_pkg->option('selfservice_inbound_format') 
2250                 || $conf->config('selfservice-default_inbound_cdr_format')
2251                 || 'source_default';
2252       $callback_opt{inbound} = 1;
2253     } else {
2254       $format = $cust_pkg->part_pkg->option('selfservice_format')
2255                 || $conf->config('selfservice-default_cdr_format')
2256                 || 'default';
2257     }
2258
2259     $callback_opt{format} = $format;
2260     $callback_opt{use_clid} = 1;
2261     $header = [ split(',', FS::cdr::invoice_header($format) ) ];
2262   }
2263
2264   my $start    = $cust_pkg->setup;
2265   #my $end      = $cust_pkg->bill; # or time?
2266   my $end      = time;
2267
2268   unless ( $p->{beginning} ) {
2269     $p->{beginning} = $cust_pkg->last_bill;
2270     $p->{ending}    = $end;
2271   }
2272
2273   die "illegal beginning" if $p->{beginning} !~ /^\d*$/;
2274   die "illegal ending"    if $p->{ending}    !~ /^\d*$/;
2275
2276   my (@usage) = &$callback($svc_x, $p->{beginning}, $p->{ending}, 
2277     %callback_opt
2278   );
2279
2280   if ( $conf->exists('selfservice-hide_cdr_price') ) {
2281     # ugly kludge, I know
2282     my ($delete_col) = grep { $header->[$_] eq 'Price' } (0..scalar(@$header));
2283     if (defined $delete_col) {
2284       delete($_->[$delete_col]) foreach ($header, @usage);
2285     }
2286   }
2287
2288   #kinda false laziness with FS::cust_main::bill, but perhaps
2289   #we should really change this bit to DateTime and DateTime::Duration
2290   #
2291   #change this bit to use Date::Manip? CAREFUL with timezones (see
2292   # mailing list archive)
2293   my ($nsec,$nmin,$nhour,$nmday,$nmon,$nyear) =
2294     (localtime($p->{ending}) )[0,1,2,3,4,5];
2295   my ($psec,$pmin,$phour,$pmday,$pmon,$pyear) =
2296     (localtime($p->{beginning}) )[0,1,2,3,4,5];
2297
2298   if ( $freq =~ /^\d+$/ ) {
2299     $nmon += $freq;
2300     until ( $nmon < 12 ) { $nmon -= 12; $nyear++; }
2301     $pmon -= $freq;
2302     until ( $pmon >= 0 ) { $pmon += 12; $pyear--; }
2303   } elsif ( $freq =~ /^(\d+)w$/ ) {
2304     my $weeks = $1;
2305     $nmday += $weeks * 7;
2306     $pmday -= $weeks * 7;
2307   } elsif ( $freq =~ /^(\d+)d$/ ) {
2308     my $days = $1;
2309     $nmday += $days;
2310     $pmday -= $days;
2311   } elsif ( $freq =~ /^(\d+)h$/ ) {
2312     my $hours = $1;
2313     $nhour += $hours;
2314     $phour -= $hours;
2315   } else {
2316     return { 'error' => "unparsable frequency: ". $freq };
2317   }
2318   
2319   my $previous  = timelocal_nocheck($psec,$pmin,$phour,$pmday,$pmon,$pyear);
2320   my $next      = timelocal_nocheck($nsec,$nmin,$nhour,$nmday,$nmon,$nyear);
2321
2322   { 
2323     'error'     => '',
2324     'svcnum'    => $p->{svcnum},
2325     'beginning' => $p->{beginning},
2326     'ending'    => $p->{ending},
2327     'inbound'   => $p->{inbound},
2328     'previous'  => ($previous > $start) ? $previous : $start,
2329     'next'      => ($next < $end) ? $next : $end,
2330     'header'    => $header,
2331     'usage'     => \@usage,
2332   };
2333 }
2334
2335 sub order_pkg {
2336   my $p = shift;
2337
2338   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2339   return { 'error' => $session } if $context eq 'error';
2340
2341   my $search = { 'custnum' => $custnum };
2342   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2343   my $cust_main = qsearchs('cust_main', $search )
2344     or return { 'error' => "unknown custnum $custnum" };
2345
2346   my $status = $cust_main->status;
2347
2348   my %order_pkg_options = ();
2349   if ( $p->{locationnum} > 0 ) {
2350     $order_pkg_options{locationnum} = delete($p->{locationnum});
2351   } elsif ( $p->{address1} ) {
2352     $order_pkg_options{'cust_location'} = new FS::cust_location {
2353       map { $_ => $p->{$_} }
2354         qw( address1 address2 city county state zip country )
2355     };
2356   }
2357
2358   #false laziness w/ClientAPI/Signup.pm
2359
2360   my $cust_pkg = new FS::cust_pkg ( {
2361     'custnum'  => $custnum,
2362     'pkgpart'  => $p->{'pkgpart'},
2363     'quantity' => $p->{'quantity'} || 1,
2364   } );
2365   my $error = $cust_pkg->check;
2366   return { 'error' => $error } if $error;
2367
2368   my @svc = ();
2369   unless ( $p->{'svcpart'} eq 'none' ) {
2370
2371     my $svcdb;
2372     my $svcpart = '';
2373     if ( $p->{'svcpart'} =~ /^(\d+)$/ ) {
2374       $svcpart = $1;
2375       my $part_svc = qsearchs('part_svc', { 'svcpart' => $svcpart } );
2376       return { 'error' => "Unknown svcpart $svcpart" } unless $part_svc;
2377       $svcdb = $part_svc->svcdb;
2378     } else {
2379       $svcdb = 'svc_acct';
2380     }
2381     $svcpart ||= $cust_pkg->part_pkg->svcpart($svcdb);
2382
2383     my %fields = (
2384       'svc_acct'     => [ qw( username domsvc _password sec_phrase popnum ) ],
2385       'svc_domain'   => [ qw( domain ) ],
2386       'svc_phone'    => [ qw( phonenum pin sip_password phone_name ) ],
2387       'svc_external' => [ qw( id title ) ],
2388       'svc_pbx'      => [ qw( id title ) ],
2389     );
2390   
2391     my $svc_x = "FS::$svcdb"->new( {
2392       'svcpart'   => $svcpart,
2393       map { $_ => $p->{$_} } @{$fields{$svcdb}}
2394     } );
2395     
2396     if ( $svcdb eq 'svc_acct' && exists($p->{"snarf_machine1"}) ) {
2397       my @acct_snarf;
2398       my $snarfnum = 1;
2399       while ( length($p->{"snarf_machine$snarfnum"}) ) {
2400         my $acct_snarf = new FS::acct_snarf ( {
2401           'machine'   => $p->{"snarf_machine$snarfnum"},
2402           'protocol'  => $p->{"snarf_protocol$snarfnum"},
2403           'username'  => $p->{"snarf_username$snarfnum"},
2404           '_password' => $p->{"snarf_password$snarfnum"},
2405         } );
2406         $snarfnum++;
2407         push @acct_snarf, $acct_snarf;
2408       }
2409       $svc_x->child_objects( \@acct_snarf );
2410     }
2411     
2412     my $y = $svc_x->setdefault; # arguably should be in new method
2413     return { 'error' => $y } if $y && !ref($y);
2414   
2415     $error = $svc_x->check;
2416     return { 'error' => $error } if $error;
2417
2418     push @svc, $svc_x;
2419
2420   }
2421
2422   $error = $cust_main->order_pkg(
2423     'cust_pkg' => $cust_pkg,
2424     'svcs'     => \@svc,
2425     'noexport' => 1,
2426     %order_pkg_options,
2427   );
2428   return { 'error' => $error } if $error;
2429
2430   my $conf = new FS::Conf;
2431   if ( $conf->exists('signup_server-realtime') ) {
2432
2433     my $bill_error = _do_bop_realtime( $cust_main, $status, 'collect'=>$p->{run_bill_events} );
2434
2435     if ($bill_error) {
2436       $cust_pkg->cancel('quiet'=>1);
2437       return $bill_error;
2438     } else {
2439       $cust_pkg->reexport;
2440     }
2441
2442   } else {
2443     $cust_pkg->reexport;
2444   }
2445
2446   my $svcnum = $svc[0] ? $svc[0]->svcnum : '';
2447
2448   return { error=>'', pkgnum=>$cust_pkg->pkgnum, svcnum=>$svcnum };
2449
2450 }
2451
2452 sub change_pkg {
2453   my $p = shift;
2454
2455   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2456   return { 'error' => $session } if $context eq 'error';
2457
2458   my $conf = new FS::Conf;
2459   my $immutable = $conf->exists('selfservice_immutable-package');
2460   return { 'error' => "Package modification disabled" } if $immutable;
2461
2462   my $search = { 'custnum' => $custnum };
2463   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2464   my $cust_main = qsearchs('cust_main', $search )
2465     or return { 'error' => "unknown custnum $custnum" };
2466
2467   my $status = $cust_main->status;
2468   my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $p->{pkgnum} } )
2469     or return { 'error' => "unknown package $p->{pkgnum}" };
2470
2471   #if someone does need self-service package change of suspended packages,
2472   # figure out how to be more discriminating
2473   return { error=>"Can't change a suspended package", pkgnum=>$cust_pkg->pkgnum}
2474     if $cust_pkg->status eq 'suspended';
2475
2476   my $err_or_cust_pkg = $cust_pkg->change( 'pkgpart'  => $p->{'pkgpart'},
2477                                            'quantity' => $p->{'quantity'} || 1,
2478                                          );
2479
2480   return { error=>$err_or_cust_pkg, pkgnum=>$cust_pkg->pkgnum }
2481     unless ref($err_or_cust_pkg);
2482
2483   if ( $conf->exists('signup_server-realtime') ) {
2484
2485     my $bill_error = _do_bop_realtime( $cust_main, $status, 'no_invoice_void'=>1 );
2486
2487     if ($bill_error) {
2488       $err_or_cust_pkg->suspend;
2489       return $bill_error;
2490     } else {
2491       $err_or_cust_pkg->reexport;
2492     }
2493
2494   } else {  
2495     $err_or_cust_pkg->reexport;
2496   }
2497
2498   return { error => '', pkgnum => $cust_pkg->pkgnum };
2499
2500 }
2501
2502 sub order_recharge {
2503   my $p = shift;
2504
2505   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2506   return { 'error' => $session } if $context eq 'error';
2507
2508   my $search = { 'custnum' => $custnum };
2509   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2510   my $cust_main = qsearchs('cust_main', $search )
2511     or return { 'error' => "unknown custnum $custnum" };
2512
2513   my $status = $cust_main->status;
2514   my $cust_svc = qsearchs( 'cust_svc', { 'svcnum' => $p->{'svcnum'} } )
2515     or return { 'error' => "unknown service " . $p->{'svcnum'} };
2516
2517   my $svc_x = $cust_svc->svc_x;
2518   my $part_pkg = $cust_svc->cust_pkg->part_pkg;
2519
2520   my %vhash =
2521     map { $_ =~ /^recharge_(.*)$/; $1, $part_pkg->option($_, 1) } 
2522     qw ( recharge_seconds recharge_upbytes recharge_downbytes
2523          recharge_totalbytes );
2524   my $amount = $part_pkg->option('recharge_amount', 1); 
2525   
2526   my ($l, $v, $d) = $cust_svc->label;  # blah
2527   my $pkg = "Recharge $v"; 
2528
2529   my $bill_error = $cust_main->charge($amount, $pkg,
2530      "time: $vhash{seconds}, up: $vhash{upbytes}," . 
2531      "down: $vhash{downbytes}, total: $vhash{totalbytes}",
2532      $part_pkg->taxclass); #meh
2533
2534   my $conf = new FS::Conf;
2535   if ( $conf->exists('signup_server-realtime') && !$bill_error ) {
2536
2537     $bill_error = _do_bop_realtime( $cust_main, $status );
2538
2539     if ($bill_error) {
2540       return $bill_error;
2541     } else {
2542       my $error = $svc_x->recharge (\%vhash);
2543       return { 'error' => $error } if $error;
2544     }
2545
2546   } else {  
2547     my $error = $bill_error;
2548     $error ||= $svc_x->recharge (\%vhash);
2549     return { 'error' => $error } if $error;
2550   }
2551
2552   return { error => '', svc => $cust_svc->part_svc->svc };
2553
2554 }
2555
2556 sub _do_bop_realtime {
2557   my ($cust_main, $status, %opt) = @_;
2558
2559   my $old_balance = $cust_main->balance;
2560
2561   my @cust_bill;
2562   my $bill_error = $cust_main->bill(
2563     'return_bill'   => \@cust_bill,
2564   );
2565
2566   $bill_error ||= $cust_main->apply_payments_and_credits;
2567
2568   $bill_error ||= $cust_main->realtime_collect('selfservice' => 1)
2569     if $cust_main->payby =~ /^(CARD|CHEK)$/;
2570
2571   if (    $cust_main->balance > $old_balance
2572        && $cust_main->balance > 0
2573        && ( $cust_main->payby !~ /^(BILL|DCRD|DCHK)$/
2574               || $status eq 'suspended'
2575           )
2576      )
2577   {
2578     unless ( $opt{'no_invoice_void'} ) {
2579
2580       #this used to apply a credit, but now we can void invoices...
2581       foreach my $cust_bill (@cust_bill) {
2582         my $voiderror = $cust_bill->void('automatic payment failed');
2583         warn "Error voiding cust bill after decline: $voiderror" if $voiderror;
2584       }
2585
2586     }
2587
2588     return { 'error' => '_decline', 'bill_error' => $bill_error };
2589   }
2590
2591   if ( $opt{'collect'} ) {
2592     my $collect_error = $cust_main->collect();
2593     return { 'error' => '_decline', 'bill_error' => $collect_error }
2594      if $collect_error; #?
2595   }
2596
2597   '';
2598 }
2599
2600 sub renew_info {
2601   my $p = shift;
2602
2603   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2604   return { 'error' => $session } if $context eq 'error';
2605
2606   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2607     or return { 'error' => "unknown custnum $custnum" };
2608
2609   my @cust_pkg = sort { $a->bill <=> $b->bill }
2610                  grep { $_->part_pkg->freq ne '0' }
2611                  $cust_main->ncancelled_pkgs;
2612
2613   #return { 'error' => 'No active packages to renew.' } unless @cust_pkg;
2614
2615   my $total = $cust_main->balance;
2616
2617   my @array = map {
2618                     my $bill = $_->bill;
2619                     $total += $_->part_pkg->base_recur($_, \$bill);
2620                     my $renew_date = $_->part_pkg->add_freq($_->bill);
2621                     {
2622                       'pkgnum'             => $_->pkgnum,
2623                       'amount'             => sprintf('%.2f', $total),
2624                       'bill_date'          => $_->bill,
2625                       'bill_date_pretty'   => time2str('%x', $_->bill),
2626                       'renew_date'         => $renew_date,
2627                       'renew_date_pretty'  => time2str('%x', $renew_date),
2628                       'expire_date'        => $_->expire,
2629                       'expire_date_pretty' => time2str('%x', $_->expire),
2630                     };
2631                   }
2632                   @cust_pkg;
2633
2634   return { 'dates' => \@array };
2635
2636 }
2637
2638 sub payment_info_renew_info {
2639   my $p = shift;
2640   my $renew_info   = renew_info($p);
2641   my $payment_info = payment_info($p);
2642   return { %$renew_info,
2643            %$payment_info,
2644          };
2645 }
2646
2647 sub order_renew {
2648   my $p = shift;
2649
2650   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2651   return { 'error' => $session } if $context eq 'error';
2652
2653   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2654     or return { 'error' => "unknown custnum $custnum" };
2655
2656   my $date = $p->{'date'};
2657
2658   my $now = time;
2659
2660   #freeside-daily -n -d $date fs_daily $custnum
2661   $cust_main->bill_and_collect( 'time'         => $date,
2662                                 'invoice_time' => $now,
2663                                 'actual_time'  => $now,
2664                                 'check_freq'   => '1d',
2665                               );
2666
2667   return { 'error' => '' };
2668
2669 }
2670
2671 sub suspend_pkg {
2672   my $p = shift;
2673   my $session = _cache->get($p->{'session_id'})
2674     or return { 'error' => "Can't resume session" }; #better error message
2675
2676   my $custnum = $session->{'custnum'};
2677
2678   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2679     or return { 'error' => "unknown custnum $custnum" };
2680
2681   my $conf = new FS::Conf;
2682   my $reasonnum = 
2683     $conf->config('selfservice-self_suspend_reason', $cust_main->agentnum)
2684       or return { 'error' => 'Permission denied' };
2685
2686   my $pkgnum = $p->{'pkgnum'};
2687
2688   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2689                                         'pkgnum'  => $pkgnum,   } )
2690     or return { 'error' => "unknown pkgnum $pkgnum" };
2691
2692   my $error = $cust_pkg->suspend(reason => $reasonnum);
2693   return { 'error' => $error };
2694
2695 }
2696
2697 sub cancel_pkg {
2698   my $p = shift;
2699   my $session = _cache->get($p->{'session_id'})
2700     or return { 'error' => "Can't resume session" }; #better error message
2701
2702   my $custnum = $session->{'custnum'};
2703   my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
2704     or return { 'error' => "unknown custnum $custnum" };
2705
2706   my $pkgnum = $p->{'pkgnum'};
2707   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2708                                         'pkgnum'  => $pkgnum,   } )
2709     or return { 'error' => "unknown pkgnum $pkgnum" };
2710
2711   my $error = $cust_pkg->cancel( 'quiet' => 1,
2712                                  'date'  => $p->{'date'},
2713                                );
2714   return { 'error' => $error };
2715 }
2716
2717 sub provision_phone {
2718   my $p = shift;
2719   my @bulkdid;
2720   @bulkdid = @{$p->{'bulkdid'}} if $p->{'bulkdid'};
2721
2722   #editing an existing phone number
2723   if ( $p->{'svcnum'} && $p->{'svcnum'} =~ /^\d+$/ ) {
2724       my($context, $session, $custnum) = _custoragent_session_custnum($p);
2725       return { 'error' => $session } if $context eq 'error';
2726     
2727       my $svc_phone = qsearchs('svc_phone', { svcnum => $p->{'svcnum'} });
2728       return { 'error' => 'service not found' } unless $svc_phone;
2729       return { 'error' => 'invalid svcnum' } 
2730         if $svc_phone && $svc_phone->cust_svc->cust_pkg->custnum != $custnum;
2731
2732       $svc_phone->email($p->{'email'}) 
2733         if $svc_phone->email ne $p->{'email'} && $p->{'email'} =~ /^([\w\.\d@]+|)$/;
2734       $svc_phone->forwarddst($p->{'forwarddst'}) 
2735         if $svc_phone->forwarddst ne $p->{'forwarddst'} 
2736             && $p->{'forwarddst'} =~ /^(\d+|)$/;
2737       return { 'error' => $svc_phone->replace };
2738  }
2739
2740   # single DID LNP
2741   unless ( $p->{'lnp'} ) {
2742     $p->{'lnp_desired_due_date'} = parse_datetime($p->{'lnp_desired_due_date'});
2743     $p->{'lnp_status'} = "portingin";
2744     return _provision( 'FS::svc_phone',
2745                   [qw(lnp_desired_due_date lnp_other_provider 
2746                     lnp_other_provider_account phonenum countrycode lnp_status)],
2747                   [qw(phonenum countrycode)],
2748                   $p,
2749                   @_
2750                 );
2751   }
2752
2753   # single DID order (the usual case)
2754   unless (scalar(@bulkdid)) {
2755     return _provision( 'FS::svc_phone',
2756                   [qw(phonenum countrycode)],
2757                   [qw(phonenum countrycode)],
2758                   $p,
2759                   @_
2760                 );
2761   }
2762
2763   # bulk DID order case
2764   my $error;
2765   foreach my $did ( @bulkdid ) {
2766     $did =~ s/[^0-9]//g;
2767     $error = _provision( 'FS::svc_phone',
2768               [qw(phonenum countrycode)],
2769               [qw(phonenum countrycode)],
2770               {
2771                 'pkgnum' => $p->{'pkgnum'},
2772                 'svcpart' => $p->{'svcpart'},
2773                 'phonenum' => $did,
2774                 'countrycode' => $p->{'countrycode'},
2775                 'session_id' => $p->{'session_id'},
2776               }
2777             );
2778     return $error if ($error->{'error'} && length($error->{'error'}) > 1);
2779   }
2780   { 'bulkdid' => [ @bulkdid ], 'svc' => $error->{'svc'} }
2781 }
2782
2783 sub provision_pbx {
2784   my $p = shift;
2785   warn "provision_pbx called\n"
2786     if $DEBUG;
2787
2788   warn "provision_pbx calling _provision\n"
2789     if $DEBUG;
2790   _provision( 'FS::svc_pbx',
2791               [qw(id title max_extensions max_simultaneous ip_addr)],
2792               [qw(id title max_extensions max_simultaneous ip_addr)],
2793               $p,
2794               @_
2795             );
2796 }
2797
2798 sub provision_acct {
2799   my $p = shift;
2800   warn "provision_acct called\n"
2801     if $DEBUG;
2802
2803   return { 'error' => gettext('passwords_dont_match') }
2804     if $p->{'_password'} ne $p->{'_password2'};
2805   return { 'error' => gettext('empty_password') }
2806     unless length($p->{'_password'});
2807  
2808   if ($p->{'domsvc'}) {
2809     my %domains = domain_select_hash FS::svc_acct(map { $_ => $p->{$_} }
2810                                                   qw ( svcpart pkgnum ) );
2811     return { 'error' => gettext('invalid_domain') }
2812       unless ($domains{$p->{'domsvc'}});
2813   }
2814
2815   warn "provision_acct calling _provision\n"
2816     if $DEBUG;
2817   _provision( 'FS::svc_acct',
2818               [qw(username _password domsvc)],
2819               [qw(username _password domsvc)],
2820               $p,
2821               @_
2822             );
2823 }
2824
2825 sub provision_external {
2826   my $p = shift;
2827   #_provision( 'FS::svc_external', [qw(id title)], [qw(id title)], $p, @_ );
2828   _provision( 'FS::svc_external',
2829               [],
2830               [qw(id title)],
2831               $p,
2832               @_
2833             );
2834 }
2835
2836 sub provision_forward {
2837   my $p = shift;
2838   _provision( 'FS::svc_forward',
2839               ['srcsvc','src','dstsvc','dst'],
2840               [],
2841               $p,
2842             );
2843 }
2844
2845 sub _provision {
2846   my( $class, $fields, $return_fields, $p ) = splice(@_, 0, 4);
2847   warn "_provision called for $class\n"
2848     if $DEBUG;
2849
2850   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2851   return { 'error' => $session } if $context eq 'error';
2852
2853   my $search = { 'custnum' => $custnum };
2854   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2855   my $cust_main = qsearchs('cust_main', $search )
2856     or return { 'error' => "unknown custnum $custnum" };
2857
2858   my $pkgnum = $p->{'pkgnum'};
2859
2860   warn "searching for custnum $custnum pkgnum $pkgnum\n"
2861     if $DEBUG;
2862   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2863                                         'pkgnum'  => $pkgnum,
2864                                                                } )
2865     or return { 'error' => "unknown pkgnum $pkgnum" };
2866
2867   warn "searching for svcpart ". $p->{'svcpart'}. "\n"
2868     if $DEBUG;
2869   my $part_svc = qsearchs('part_svc', { 'svcpart' => $p->{'svcpart'} } )
2870     or return { 'error' => "unknown svcpart $p->{'svcpart'}" };
2871
2872   return { error=> 'svcpart '. $p->{'svcpart'}. " is not a $class definition" }
2873     if $class ne 'FS::'. $part_svc->svcdb;
2874
2875   warn "creating $class record\n"
2876     if $DEBUG;
2877   my $svc_x = $class->new( {
2878     'pkgnum'  => $p->{'pkgnum'},
2879     'svcpart' => $p->{'svcpart'},
2880     map { $_ => $p->{$_} } @$fields
2881   } );
2882
2883   my %insert_args = ();
2884   #i shouldn't be a special case here (pass an option or something)
2885   if ( $class eq 'FS::svc_phone'
2886          && grep length($p->{$_}), @location_editable_fields
2887      )
2888   {
2889     $insert_args{'cust_location'} = new FS::cust_location {
2890       map { $_ => $p->{$_} } @location_editable_fields
2891     };
2892   }
2893
2894   warn "inserting $class record\n"
2895     if $DEBUG;
2896   my $error = $svc_x->insert(%insert_args);
2897
2898   unless ( $error ) {
2899     warn "finding inserted record for svcnum ". $svc_x->svcnum. "\n"
2900       if $DEBUG;
2901     $svc_x = qsearchs($svc_x->table, { 'svcnum' => $svc_x->svcnum })
2902   }
2903
2904   my $return = { 'svc'   => $part_svc->svc,
2905                  'error' => $error,
2906                  map { $_ => $svc_x->get($_) } @$return_fields
2907                };
2908   warn "_provision returning ". Dumper($return). "\n"
2909     if $DEBUG;
2910   return $return;
2911
2912 }
2913
2914 sub part_svc_info {
2915   my $p = shift;
2916
2917   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2918   return { 'error' => $session } if $context eq 'error';
2919
2920   my $search = { 'custnum' => $custnum };
2921   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2922   my $cust_main = qsearchs('cust_main', $search )
2923     or return { 'error' => "unknown custnum $custnum" };
2924
2925   my $pkgnum = $p->{'pkgnum'};
2926
2927   my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
2928                                         'pkgnum'  => $pkgnum,
2929                                                                } )
2930     or return { 'error' => "unknown pkgnum $pkgnum" };
2931
2932   my $svcpart = $p->{'svcpart'};
2933
2934   my $pkg_svc = qsearchs('pkg_svc', { 'pkgpart' => $cust_pkg->pkgpart,
2935                                       'svcpart' => $svcpart,           } )
2936     or return { 'error' => "unknown svcpart $svcpart for pkgnum $pkgnum" };
2937   my $part_svc = $pkg_svc->part_svc;
2938
2939   my $conf = new FS::Conf;
2940
2941   my $ret = {
2942     'svc'     => $part_svc->svc,
2943     'svcdb'   => $part_svc->svcdb,
2944     'pkgnum'  => $pkgnum,
2945     'svcpart' => $svcpart,
2946     'custnum' => $custnum,
2947
2948     'security_phrase' => 0, #XXX !
2949     'svc_acct_pop'    => [], #XXX !
2950     'popnum'          => '',
2951     'init_popstate'   => '',
2952     'popac'           => '',
2953     'acstate'         => '',
2954
2955     'small_custview' =>
2956       small_custview( $cust_main, $conf->config('countrydefault') ),
2957
2958   };
2959
2960   if ($p->{'svcnum'} && $p->{'svcnum'} =~ /^\d+$/ 
2961                      && $ret->{'svcdb'} eq 'svc_phone') {
2962         $ret->{'svcnum'} = $p->{'svcnum'};
2963         my $svc_phone = qsearchs('svc_phone', { svcnum => $p->{'svcnum'} });
2964         if ( $svc_phone && $svc_phone->cust_svc->cust_pkg->custnum == $custnum ) {
2965             $ret->{'email'} = $svc_phone->email;
2966             $ret->{'forwarddst'} = $svc_phone->forwarddst;
2967         }
2968   }
2969
2970   if ($ret->{'svcdb'} eq 'svc_forward') {
2971     $ret->{'forward_emails'} = {$cust_pkg->forward_emails()};
2972   }
2973
2974   $ret;
2975 }
2976
2977 sub unprovision_svc {
2978   my $p = shift;
2979
2980   my($context, $session, $custnum) = _custoragent_session_custnum($p);
2981   return { 'error' => $session } if $context eq 'error';
2982
2983   my $search = { 'custnum' => $custnum };
2984   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
2985   my $cust_main = qsearchs('cust_main', $search )
2986     or return { 'error' => "unknown custnum $custnum" };
2987
2988   my $svcnum = $p->{'svcnum'};
2989
2990   my $cust_svc = qsearchs('cust_svc', { 'svcnum'  => $svcnum, } )
2991     or return { 'error' => "unknown svcnum $svcnum" };
2992
2993   return { 'error' => "Service $svcnum does not belong to customer $custnum" }
2994     unless $cust_svc->cust_pkg->custnum == $custnum;
2995
2996   my $conf = new FS::Conf;
2997
2998   return { 'svc'   => $cust_svc->part_svc->svc,
2999            'error' => $cust_svc->cancel,
3000            'small_custview' =>
3001              small_custview( $cust_main, $conf->config('countrydefault') ),
3002          };
3003
3004 }
3005
3006 sub myaccount_passwd {
3007   my $p = shift;
3008   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3009   return { 'error' => $session } if $context eq 'error';
3010
3011   return { 'error' => "New passwords don't match." }
3012     if $p->{'new_password'} ne $p->{'new_password2'};
3013
3014   return { 'error' => 'Enter new password' }
3015     unless length($p->{'new_password'});
3016
3017   #my $search = { 'custnum' => $custnum };
3018   #$search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
3019   $custnum =~ /^(\d+)$/ or die "illegal custnum";
3020   my $search = " AND custnum = $1";
3021   $search .= " AND agentnum = ". $session->{'agentnum'} if $context eq 'agent';
3022
3023   my $svc_acct = qsearchs( {
3024     'table'     => 'svc_acct',
3025     'addl_from' => 'LEFT JOIN cust_svc  USING ( svcnum  ) '.
3026                    'LEFT JOIN cust_pkg  USING ( pkgnum  ) '.
3027                    'LEFT JOIN cust_main USING ( custnum ) ',
3028     'hashref'   => { 'svcnum' => $p->{'svcnum'}, },
3029     'extra_sql' => $search, #important
3030   } )
3031     or return { 'error' => "Service not found" };
3032
3033   my $error = '';
3034
3035   my $conf = new FS::Conf;
3036
3037   return { 'error' => 'Incorrect current password.' }
3038     if  ( exists($p->{'old_password'})
3039           || $conf->exists('selfservice-password_change_oldpass')
3040         )
3041     && ! $svc_acct->check_password($p->{'old_password'});
3042
3043   $error ||= $svc_acct->is_password_allowed($p->{'new_password'})
3044          ||  $svc_acct->set_password($p->{'new_password'})
3045          ||  $svc_acct->replace();
3046
3047   #regular pw change in self-service should change contact pw too, otherwise its
3048   #way too confusing.  hell its confusing they're separate at all, but alas.
3049   #need to support the "ISP provides email that's used as a contact email" case
3050   #as well as we can.
3051   my $contact = FS::contact->by_selfservice_email($svc_acct->email);
3052   if ( $contact && $contact->custnum == $custnum ) {
3053     #svc_acct was successful but this one returns an error?  "shouldn't happen"
3054     #don't recheck is_password_allowed here; if the svc_acct password was
3055     #legal, that's good enough
3056     $error ||= $contact->change_password($p->{'new_password'});
3057   }
3058
3059   my($label, $value) = $svc_acct->cust_svc->label;
3060
3061   return { 'error' => $error,
3062            'label' => $label,
3063            'value' => $value,
3064          };
3065
3066 }
3067
3068 sub reset_passwd {
3069   my $p = shift;
3070
3071   my $info = skin_info($p);
3072
3073   my $conf = new FS::Conf;
3074   my $verification = $conf->config('selfservice-password_reset_verification')
3075     or return { %$info, 'error' => 'Password resets disabled' };
3076
3077   my $contact = '';
3078   my $svc_acct = '';
3079   my $cust_main = '';
3080   if ( $p->{'email'} ) { #new-style, changes contact and svc_acct
3081   
3082     $contact = FS::contact->by_selfservice_email($p->{'email'});
3083
3084     $cust_main = $contact->cust_main if $contact;
3085
3086     #also look for an svc_acct, otherwise it would be super confusing
3087
3088     my($username, $domain) = split('@', $p->{'email'});
3089     my $svc_domain = qsearchs('svc_domain', { 'domain' => $domain } );
3090     if ( $svc_domain ) {
3091       $svc_acct = qsearchs('svc_acct', { 'username' => $username,
3092                                          'domsvc'   => $svc_domain->svcnum  }
3093                           );
3094       if ( $svc_acct ) {
3095         my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
3096         $cust_main ||= $cust_pkg->cust_main if $cust_pkg;
3097
3098         #precaution: don't change svc_acct password not part of the same
3099         # customer as contact
3100         $svc_acct = '' if ! $cust_pkg
3101                        || $cust_pkg->custnum != $cust_main->custnum;
3102       }
3103       
3104     }
3105
3106     return { %$info, 'error' => 'Email address not found' }
3107       unless $contact || $svc_acct;
3108
3109   } elsif ( $p->{'username'} ) { #old style, looks in svc_acct only
3110
3111     my $svc_domain = qsearchs('svc_domain', { 'domain' => $p->{'domain'} } )
3112       or return { %$info, 'error' => 'Account not found' };
3113
3114     $svc_acct = qsearchs('svc_acct', { 'username' => $p->{'username'},
3115                                        'domsvc'   => $svc_domain->svcnum  }
3116                         )
3117       or return { %$info, 'error' => 'Account not found' };
3118
3119     my $cust_pkg = $svc_acct->cust_svc->cust_pkg
3120       or return { %$info, 'error' => 'Account not found' };
3121
3122     $cust_main = $cust_pkg->cust_main;
3123
3124   }
3125
3126   my %verify = (
3127     'email'   => sub { 1; },
3128     'paymask' => sub { 
3129       my( $p, $cust_main ) = @_;
3130       $cust_main->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/
3131         && $p->{'paymask'} eq substr($cust_main->paymask, -4)
3132     },
3133     'amount'  => sub {
3134       my( $p, $cust_main ) = @_;
3135       my $cust_pay = qsearchs({
3136         'table' => 'cust_pay',
3137         'hashref' => { 'custnum' => $cust_main->custnum },
3138         'order_by' => 'ORDER BY _date DESC LIMIT 1',
3139       })
3140         or return 0;
3141
3142       $p->{'amount'} == $cust_pay->paid;
3143     },
3144     'zip'     => sub {
3145       my( $p, $cust_main ) = @_;
3146       $p->{'zip'} eq $cust_main->zip
3147         || ( $cust_main->ship_zip && $p->{'zip'} eq $cust_main->ship_zip );
3148     },
3149   );
3150
3151   foreach my $verify ( split(',', $verification) ) {
3152
3153     &{ $verify{$verify} }( $p, $cust_main )
3154       or return { %$info, 'error' => 'Account not found' };
3155
3156   }
3157
3158   #okay, we're verified
3159
3160   if ( $contact ) {
3161
3162     my $error = $contact->send_reset_email(
3163                             'svcnum' => ($svc_acct ? $svc_acct->svcnum : ''),
3164                           );
3165
3166     if ( $error ) {
3167       return { %$info, 'error' => $error }; #????
3168     }
3169
3170   } elsif ( $svc_acct ) {
3171
3172     #create a unique session
3173
3174     my $reset_session = {
3175       'svcnum'   => $svc_acct->svcnum,
3176       'agentnum' => $svc_acct->cust_main->agentnum,
3177     };
3178
3179     my $timeout = '1 hour'; #?
3180
3181     my $reset_session_id;
3182     do {
3183       $reset_session_id = sha512_hex(time(). {}. rand(). $$)
3184     } until ( ! defined _cache->get("reset_passwd_$reset_session_id") );
3185       #just in case
3186
3187     _cache->set( "reset_passwd_$reset_session_id", $reset_session, $timeout );
3188
3189     #email it
3190
3191     my $msgnum = $conf->config('selfservice-password_reset_msgnum',
3192                                $cust_main->agentnum);
3193     #die "selfservice-password_reset_msgnum unset" unless $msgnum;
3194     return { %$info, 'error' => "selfservice-password_reset_msgnum unset" }
3195       unless $msgnum;
3196     my $msg_template = qsearchs('msg_template', { msgnum => $msgnum } );
3197     my $error = $msg_template->send( 'cust_main'     => $cust_main,
3198                                      'object'        => $svc_acct,
3199                                      'substitutions' => {
3200                                        'session_id' => $reset_session_id,
3201                                      }
3202                                    );
3203     if ( $error ) {
3204       return { %$info, 'error' => $error }; #????
3205     }
3206
3207   }
3208
3209   return { %$info, 'error' => '' };
3210 }
3211
3212 sub check_reset_passwd {
3213   my $p = shift;
3214
3215   my $conf = new FS::Conf;
3216   my $verification = $conf->config('selfservice-password_reset_verification')
3217     or return { 'error' => 'Password resets disabled' };
3218
3219   my $reset_session = _cache->get('reset_passwd_'. $p->{'session_id'})
3220     or return { 'error' => "Can't resume session" }; #better error message
3221
3222   if ( $reset_session->{'svcnum'} ) {
3223
3224     my $svcnum = $reset_session->{'svcnum'};
3225
3226     my $svc_acct = qsearchs('svc_acct', { 'svcnum' => $svcnum } )
3227       or return { 'error' => "Service not found" };
3228
3229     $p->{'agentnum'} = $svc_acct->cust_svc->cust_pkg->cust_main->agentnum;
3230     my $info = skin_info($p);
3231
3232     return { %$info,
3233              'error'      => '',
3234              'session_id' => $p->{'session_id'},
3235              'username'   => $svc_acct->username,
3236            };
3237
3238   } elsif ( $reset_session->{'contactnum'} ) {
3239
3240     my $contactnum = $reset_session->{'contactnum'};
3241
3242     my $contact = qsearchs('contact', { 'contactnum' => $contactnum } )
3243       or return { 'error' => "Contact not found" };
3244
3245     my @contact_email = $contact->contact_email;
3246     return { 'error' => 'No contact email' } unless @contact_email;
3247
3248     $p->{'agentnum'} = $contact->cust_main->agentnum;
3249     my $info = skin_info($p);
3250
3251     return { %$info,
3252              'error'      => '',
3253              'session_id' => $p->{'session_id'},
3254              'email'      => $contact_email[0]->email, #the first?
3255            };
3256
3257   } else {
3258
3259     return { 'error' => 'No svcnum or contactnum in session' }; #??
3260
3261   }
3262
3263 }
3264
3265 sub process_reset_passwd {
3266   my $p = shift;
3267
3268   my $conf = new FS::Conf;
3269   my $verification = $conf->config('selfservice-password_reset_verification')
3270     or return { 'error' => 'Password resets disabled' };
3271
3272   my $reset_session = _cache->get('reset_passwd_'. $p->{'session_id'})
3273     or return { 'error' => "Can't resume session" }; #better error message
3274
3275   my $info = '';
3276
3277   my $svc_acct = '';
3278   if ( $reset_session->{'svcnum'} ) {
3279
3280     my $svcnum = $reset_session->{'svcnum'};
3281
3282     $svc_acct = qsearchs('svc_acct', { 'svcnum' => $svcnum } )
3283       or return { 'error' => "Service not found" };
3284
3285     $p->{'agentnum'} ||= $svc_acct->cust_svc->cust_pkg->cust_main->agentnum;
3286     $info ||= skin_info($p);
3287
3288   }
3289
3290   my $contact = '';
3291   if ( $reset_session->{'contactnum'} ) {
3292
3293     my $contactnum = $reset_session->{'contactnum'};
3294
3295     $contact = qsearchs('contact', { 'contactnum' => $contactnum } )
3296       or return { 'error' => "Contact not found" };
3297
3298     $p->{'agentnum'} ||= $contact->cust_main->agentnum;
3299     $info ||= skin_info($p);
3300
3301   }
3302
3303   return { %$info, 'error' => "New passwords don't match." }
3304     if $p->{'new_password'} ne $p->{'new_password2'};
3305
3306   return { %$info, 'error' => 'Enter new password' }
3307     unless length($p->{'new_password'});
3308
3309   if ( $svc_acct ) {
3310
3311     my $error ||= $svc_acct->is_password_allowed($p->{'new_password'})
3312               ||  $svc_acct->set_password($p->{'new_password'})
3313               ||  $svc_acct->replace();
3314
3315     return { %$info, 'error' => $error } if $error;
3316
3317     #my($label, $value) = $svc_acct->cust_svc->label;
3318     #return { 'error' => $error,
3319     #         #'label' => $label,
3320     #         #'value' => $value,
3321     #       };
3322
3323   }
3324
3325   if ( $contact ) {
3326
3327     my $error = $contact->is_password_allowed($p->{'new_password'})
3328             ||  $contact->change_password($p->{'new_password'});
3329
3330     return { %$info, 'error' => $error }; # if $error;
3331
3332   }
3333
3334   #password changed ,so remove session, don't want it reused
3335   _cache->remove($p->{'session_id'});
3336
3337   return { %$info, 'error' => '' };
3338
3339 }
3340
3341 sub validate_passwd {
3342   my $p = shift;
3343
3344   my %result;
3345   %result = ( 'fieldid' => $p->{'fieldid'} )
3346     if $p->{'fieldid'} =~ /^\w+$/;
3347
3348   return { %result, 'password_invalid' => 'Enter new password' }
3349     unless length($p->{'check_password'});
3350
3351   my $svc_acct;
3352   if ($p->{'svcnum'}) {
3353     # false laziness with myaccount_passwd
3354     my($context, $session, $custnum) = _custoragent_session_custnum($p);
3355     return { %result, 'error' => $session } if $context eq 'error';
3356
3357     $custnum =~ /^(\d+)$/ or die "illegal custnum";
3358     my $search = " AND custnum = $1";
3359     $search .= " AND agentnum = ". $session->{'agentnum'} if $context eq 'agent';
3360
3361     $svc_acct = qsearchs( {
3362       'table'     => 'svc_acct',
3363       'addl_from' => 'LEFT JOIN cust_svc  USING ( svcnum  ) '.
3364                      'LEFT JOIN cust_pkg  USING ( pkgnum  ) '.
3365                      'LEFT JOIN cust_main USING ( custnum ) ',
3366       'hashref'   => { 'svcnum' => $p->{'svcnum'}, },
3367       'extra_sql' => $search, #important
3368     } )
3369       or return { %result, 'error' => "Service not found" };
3370     # end false laziness
3371   }
3372
3373   unless ($svc_acct) {
3374     my $conf = new FS::Conf;
3375     my $agentnum = $p->{'agentnum'};
3376     return { %result, 'password_valid' => 1 }
3377       if $conf->config_bool('password-insecure', $p->{'agentnum'});
3378   }
3379
3380   $svc_acct ||= new FS::svc_acct {};
3381
3382   my $error = $svc_acct->is_password_allowed($p->{'check_password'});
3383   return { %result, 'password_invalid' => $error } if $error;
3384   return { %result, 'password_valid' => 1 };
3385 }
3386
3387 sub list_tickets {
3388   my $p = shift;
3389   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3390   return { 'error' => $session } if $context eq 'error';
3391
3392   my @tickets = ();
3393   if ( $session->{'pkgnum'} ) { 
3394
3395     #tickets for specific service with pkg-balances on
3396     my $cust_pkg = qsearchs('cust_pkg', { 'custnum' => $custnum,
3397                                           'pkgnum'  => $session->{'pkgnum'} })
3398                      or return { 'error' => 'unknown package' };
3399     foreach my $cust_svc ( $cust_pkg->cust_svc ) {
3400       push @tickets, $cust_svc->tickets( $p->{status} );
3401     }
3402
3403   } else {
3404
3405     my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
3406       or return { 'error' => "unknown custnum $custnum" };
3407
3408     @tickets = $cust_main->tickets( $p->{status} );
3409   }
3410
3411   # unavoidable false laziness w/ httemplate/view/cust_main/tickets.html
3412   if ( $FS::TicketSystem::system && FS::TicketSystem->selfservice_priority ) {
3413     my $conf = new FS::Conf;
3414     my $dir = $conf->exists('ticket_system-priority_reverse') ? -1 : 1;
3415     +{ tickets => [ 
3416          sort { 
3417            (
3418              ($a->{'_selfservice_priority'} eq '') <=>
3419              ($b->{'_selfservice_priority'} eq '')
3420            ) ||
3421            ( $dir * 
3422              ($b->{'_selfservice_priority'} <=> $a->{'_selfservice_priority'})
3423            )
3424          } @tickets
3425        ]
3426     };
3427   } else {
3428     +{ tickets => \@tickets };
3429   }
3430
3431 }
3432
3433 sub create_ticket {
3434   my $p = shift;
3435   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3436   return { 'error' => $session } if $context eq 'error';
3437
3438   warn "$me create_ticket: initializing ticket system\n" if $DEBUG;
3439   FS::TicketSystem->init();
3440
3441   my $conf = new FS::Conf;
3442   my $queue = $p->{'queue'}
3443               || $conf->config('ticket_system-selfservice_queueid')
3444               || $conf->config('ticket_system-default_queueid');
3445
3446   warn "$me create_ticket: creating ticket\n" if $DEBUG;
3447   my $err_or_ticket = FS::TicketSystem->create_ticket(
3448     '', #create RT session based on FS CurrentUser (fs_selfservice)
3449     'queue'   => $queue,
3450     'custnum' => $custnum,
3451     'svcnum'  => $session->{'svcnum'},
3452     map { $_ => $p->{$_} } qw( requestor cc subject message mime_type )
3453   );
3454
3455   if ( ref($err_or_ticket) ) {
3456     warn "$me create_ticket: successful: ". $err_or_ticket->id. "\n"
3457       if $DEBUG;
3458     return { 'error'     => '',
3459              'ticket_id' => $err_or_ticket->id,
3460            };
3461   } else {
3462     warn "$me create_ticket: unsuccessful: $err_or_ticket\n"
3463       if $DEBUG;
3464     return { 'error' => $err_or_ticket };
3465   }
3466
3467
3468 }
3469
3470 sub did_report {
3471   my $p = shift;
3472   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3473   return { 'error' => $session } if $context eq 'error';
3474  
3475   return { error => 'requested format not implemented' } 
3476     unless ($p->{'format'} eq 'csv' || $p->{'format'} eq 'xls');
3477
3478   my $conf = new FS::Conf;
3479   my $age_threshold = 0;
3480   $age_threshold = time() - $conf->config('selfservice-recent-did-age')
3481     if ($p->{'recentonly'} && $conf->exists('selfservice-recent-did-age'));
3482
3483   my $search = { 'custnum' => $custnum };
3484   $search->{'agentnum'} = $session->{'agentnum'} if $context eq 'agent';
3485   my $cust_main = qsearchs('cust_main', $search )
3486     or return { 'error' => "unknown custnum $custnum" };
3487
3488 # does it make more sense to just run one sql query for this instead of all the
3489 # insanity below? would increase performance greately for large data sets?
3490   my @svc_phone = ();
3491   foreach my $cust_pkg ( $cust_main->ncancelled_pkgs ) {
3492         my @part_svc = $cust_pkg->part_svc;
3493         foreach my $part_svc ( @part_svc ) {
3494             if($part_svc->svcdb eq 'svc_phone'){
3495                 my @cust_pkg_svc = @{$part_svc->cust_pkg_svc};
3496                 foreach my $cust_pkg_svc ( @cust_pkg_svc ) {
3497                     push @svc_phone, $cust_pkg_svc->svc_x
3498                         if $cust_pkg_svc->date_inserted >= $age_threshold;
3499                 }
3500             }
3501         }
3502   }
3503
3504   my $csv;
3505   my $xls;
3506   my($xls_r,$xls_c) = (0,0);
3507   my $xls_workbook;
3508   my $content = '';
3509   my @fields = qw( countrycode phonenum pin sip_password phone_name );
3510   if($p->{'format'} eq 'csv') {
3511     $csv = new Text::CSV_XS { 'always_quote' => 1,
3512                                  'eol'          => "\n",
3513                                 };
3514     return { 'error' => 'Unable to create CSV' } unless $csv->combine(@fields);
3515     $content .= $csv->string;
3516   }
3517   elsif($p->{'format'} eq 'xls') {
3518     my $XLS1 = new IO::Scalar \$content;
3519     $xls_workbook = Spreadsheet::WriteExcel->new($XLS1) 
3520         or return { 'error' => "Error opening .xls file: $!" };
3521     $xls = $xls_workbook->add_worksheet('DIDs');
3522     foreach ( @fields ) {
3523         $xls->write(0,$xls_c++,$_);
3524     }
3525     $xls_r++;
3526   }
3527
3528   foreach my $svc_phone ( @svc_phone ) {
3529     my @cols = map { $svc_phone->$_ } @fields;
3530     if($p->{'format'} eq 'csv') {
3531         return { 'error' => 'Unable to create CSV' } 
3532             unless $csv->combine(@cols);
3533         $content .= $csv->string;
3534     }
3535     elsif($p->{'format'} eq 'xls') {
3536         $xls_c = 0;
3537         foreach ( @cols ) {
3538             $xls->write($xls_r,$xls_c++,$_);
3539         }
3540         $xls_r++;
3541     }
3542   }
3543
3544   $xls_workbook->close() if $p->{'format'} eq 'xls';
3545   
3546   { content => $content, format => $p->{'format'}, };
3547 }
3548
3549 sub get_ticket {
3550   my $p = shift;
3551   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3552   return { 'error' => $session } if $context eq 'error';
3553
3554 #  warn "$me get_ticket: initializing ticket system\n" if $DEBUG;
3555 #  FS::TicketSystem->init();
3556 #  return { 'error' => 'get_ticket configuration error' }
3557 #    if $FS::TicketSystem::system ne 'RT_Internal';
3558
3559   # check existence and ownership as part of this
3560   warn "$me get_ticket: fetching ticket\n" if $DEBUG;
3561   my $rt_session = FS::TicketSystem->session('');
3562   my $Ticket = FS::TicketSystem->get_ticket_object(
3563     $rt_session, 
3564     ticket_id => $p->{'ticket_id'},
3565     custnum => $custnum
3566   );
3567   return { 'error' => 'ticket not found' } if !$Ticket;
3568
3569   if ( length( $p->{'subject'} || '' ) ) {
3570     # subject change
3571     if ( $p->{'subject'} ne $Ticket->Subject ) {
3572       my ($val, $msg) = $Ticket->SetSubject($p->{'subject'});
3573       return { 'error' => "unable to set subject: $msg" } if !$val;
3574     }
3575   }
3576
3577   if(length($p->{'reply'})) {
3578     my @err_or_res = FS::TicketSystem->correspond_ticket(
3579       $rt_session,
3580       'ticket_id' => $p->{'ticket_id'},
3581       'content' => $p->{'reply'},
3582     );
3583
3584     return { 'error' => 'unable to reply to ticket' } 
3585     unless ( $err_or_res[0] != 0 && defined $err_or_res[2] );
3586   }
3587
3588   warn "$me get_ticket: getting ticket history\n" if $DEBUG;
3589   my $err_or_ticket = FS::TicketSystem->get_ticket(
3590     $rt_session,
3591     'ticket_id' => $p->{'ticket_id'},
3592   );
3593
3594   if ( !ref($err_or_ticket) ) { # there is no way this should ever happen
3595     warn "$me get_ticket: unsuccessful: $err_or_ticket\n"
3596       if $DEBUG;
3597     return { 'error' => $err_or_ticket };
3598   }
3599
3600   my @custs = @{$err_or_ticket->{'custs'}};
3601   my @txns = @{$err_or_ticket->{'txns'}};
3602   my @filtered_txns;
3603
3604   # superseded by check in get_ticket_object
3605   #return { 'error' => 'invalid ticket requested' } 
3606   #unless grep($_ eq $custnum, @custs);
3607
3608   foreach my $txn ( @txns ) {
3609     push @filtered_txns, $txn 
3610     if ($txn->{'type'} eq 'EmailRecord' 
3611       || $txn->{'type'} eq 'Correspond'
3612       || $txn->{'type'} eq 'Create');
3613   }
3614
3615   warn "$me get_ticket: successful: \n"
3616   if $DEBUG;
3617   return { 'error'     => '',
3618     'transactions' => \@filtered_txns,
3619     'ticket_fields' => $err_or_ticket->{'fields'},
3620     'ticket_id' => $p->{'ticket_id'},
3621   };
3622 }
3623
3624 sub adjust_ticket_priority {
3625   my $p = shift;
3626   my($context, $session, $custnum) = _custoragent_session_custnum($p);
3627   return { 'error' => $session } if $context eq 'error';
3628
3629 #  warn "$me adjust_ticket_priority: initializing ticket system\n" if $DEBUG;
3630 #  FS::TicketSystem->init;
3631   my $ss_priority = FS::TicketSystem->selfservice_priority;
3632
3633   return { 'error' => 'adjust_ticket_priority configuration error' }
3634     if $FS::TicketSystem::system ne 'RT_Internal'
3635       or !$ss_priority;
3636
3637   my $values = $p->{'values'}; #hashref, id => priority value
3638   my %ticket_error;
3639
3640   foreach my $id (keys %$values) {
3641     warn "$me adjust_ticket_priority: fetching ticket $id\n" if $DEBUG;
3642     my $Ticket = FS::TicketSystem->get_ticket_object('',
3643       'ticket_id' => $id,
3644       'custnum'   => $custnum,
3645     );
3646     if ( !$Ticket ) {
3647       $ticket_error{$id} = 'ticket not found';
3648       next;
3649     }
3650     
3651   # RT API stuff--would we gain anything by wrapping this in FS::TicketSystem?
3652   # We're not going to implement it for RT_External.
3653     my $old_value = $Ticket->FirstCustomFieldValue($ss_priority);
3654     my $new_value = $values->{$id};
3655     next if $old_value eq $new_value;
3656
3657     warn "$me adjust_ticket_priority: updating ticket $id\n" if $DEBUG;
3658
3659     # AddCustomFieldValue works fine (replacing any existing value) if it's 
3660     # a single-valued custom field, which it should be.  If it's not, you're 
3661     # doing something wrong.
3662     my ($val, $msg);
3663     if ( length($new_value) ) {
3664       ($val, $msg) = $Ticket->AddCustomFieldValue( 
3665         Field => $ss_priority,
3666         Value => $new_value,
3667       );
3668     }
3669     else {
3670       ($val, $msg) = $Ticket->DeleteCustomFieldValue(
3671         Field => $ss_priority,
3672         Value => $old_value,
3673       );
3674     }
3675
3676     $ticket_error{$id} = $msg if !$val;
3677     warn "$me adjust_ticket_priority: $id: $msg\n" if $DEBUG and !$val;
3678   }
3679   return { 'error' => '',
3680            'ticket_error' => \%ticket_error,
3681            %{ customer_info($p) } # send updated customer info back
3682          }
3683 }
3684
3685 #--
3686
3687 sub _custoragent_session_custnum {
3688   my $p = shift;
3689
3690   my($context, $session, $custnum);
3691   if ( $p->{'session_id'} ) {
3692
3693     $context = 'customer';
3694     $session = _cache->get($p->{'session_id'})
3695       or return ( 'error' => "Can't resume session" ); #better error message
3696     $custnum = $session->{'custnum'};
3697
3698   } elsif ( $p->{'agent_session_id'} ) {
3699
3700     $context = 'agent';
3701     my $agent_cache = new FS::ClientAPI_SessionCache( {
3702       'namespace' => 'FS::ClientAPI::Agent',
3703     } );
3704     $session = $agent_cache->get($p->{'agent_session_id'})
3705       or return ( 'error' => "Can't resume session" ); #better error message
3706     $custnum = $p->{'custnum'};
3707
3708   } else {
3709     $context = 'error';
3710     return ( 'error' => "Can't resume session" ); #better error message
3711   }
3712
3713   ($context, $session, $custnum);
3714
3715 }
3716
3717 1;
3718