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