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