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