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