FS/FS/ClientAPI_XMLRPC.pm

   1 package FS::ClientAPI_XMLRPC;
   2
   3 =head1 NAME
   4
   5 FS::ClientAPI_XMLRPC - Freeside XMLRPC accessible self-service API, on the backend
   6
   7 =head1 SYNOPSIS
   8
   9 This module implements the self-service API offered by xmlrpc.cgi and friends,
  10 but on a backend machine.
  11
  12 =head1 DESCRIPTION
  13
  14 Use this API to implement your own client "self-service" module vi XMLRPC.
  15
  16 Each routine described in L<FS::SelfService> is available vi XMLRPC as the
  17 method FS.SelfService.XMLRPC.B<method>.  All values are passed to the
  18 selfservice-server in a struct of strings.  The return values are in a
  19 struct as strings, arrays, or structs as appropriate for the values
  20 described in L<FS::SelfService>.
  21
  22 =head1 BUGS
  23
  24 =head1 SEE ALSO
  25
  26 L<FS::SelfService::XMLRPC>, L<FS::SelfService>
  27
  28 =cut
  29
  30 use strict;
  31
  32 use vars qw($DEBUG $AUTOLOAD);
  33 use Encode;
  34 use XMLRPC::Lite; # for XMLRPC::Data
  35 use FS::ClientAPI;
  36
  37 $DEBUG = 0;
  38 $FS::ClientAPI::DEBUG = $DEBUG;
  39
  40 #false laziness w/FS::SelfService/XMLRPC.pm, same problem as below but worse
  41 our %typefix_skin_info = (
  42   'logo'              => 'base64',
  43   'title_left_image'  => 'base64',
  44   'title_right_image' => 'base64',
  45   'menu_top_image'    => 'base64',
  46   'menu_body_image'   => 'base64',
  47   'menu_bottom_image' => 'base64',
  48 );
  49 our %typefix = (
  50   'invoice_pdf'        => { 'invoice_pdf' => 'base64', },
  51   'legacy_invoice_pdf' => { 'invoice_pdf' => 'base64', },
  52   'skin_info'          => \%typefix_skin_info,
  53   'login_info'         => \%typefix_skin_info,
  54   'invoice_logo'       => { 'logo' => 'base64', },
  55   'login_banner_image' => { 'image' => 'base64', },
  56   'quotation_print'    => { 'document' => 'base64' },
  57 );
  58
  59 sub AUTOLOAD {
  60   my $call = $AUTOLOAD;
  61   $call =~ s/^FS::(SelfService::|ClientAPI_)XMLRPC:://;
  62
  63   warn "FS::ClientAPI_XMLRPC::AUTOLOAD $call\n" if $DEBUG;
  64
  65   my $autoload = &ss2clientapi;
  66
  67   if (exists($autoload->{$call})) {
  68
  69     shift; #discard package name;
  70
  71
  72     #$call = "FS::SelfService::$call";
  73     #no strict 'refs';
  74     #&{$call}(@_);
  75     #FS::ClientAPI->dispatch($autoload->{$call}, @_);
  76
  77     my %hash = @_;
  78     #XXX doesn't handle multi-level data structs
  79     $hash{$_} = decode(utf8=>$hash{$_}) foreach keys %hash;
  80
  81     my $return = FS::ClientAPI->dispatch($autoload->{$call}, \%hash );
  82
  83     if ( exists($typefix{$call}) ) {
  84       my $typefix = $typefix{$call};
  85       foreach my $field ( grep exists($return->{$_}), keys %$typefix ) {
  86         my $type = $typefix->{$field};
  87         $return->{$field} = XMLRPC::Data->value($return->{$field})
  88                                         ->type($type);
  89       }
  90     }
  91
  92     $return;
  93
  94   } else {
  95     die "No such procedure: $call";
  96   }
  97 }
  98
  99 #terrible false laziness w/SelfService.pm
 100 # - fix at build time, by including some file in both selfserv and backend libs?
 101 # - or fix at runtime, by having selfservice client ask server for the list?
 102 sub ss2clientapi {
 103   {
 104   'passwd'                    => 'passwd/passwd',
 105   'chfn'                      => 'passwd/passwd',
 106   'chsh'                      => 'passwd/passwd',
 107   'login_info'                => 'MyAccount/login_info',
 108   'login_banner_image'        => 'MyAccount/login_banner_image',
 109   'login'                     => 'MyAccount/login',
 110   'logout'                    => 'MyAccount/logout',
 111   'switch_acct'               => 'MyAccount/switch_acct',
 112   'customer_info'             => 'MyAccount/customer_info',
 113   'customer_info_short'       => 'MyAccount/customer_info_short',
 114
 115   'contact_passwd'            => 'MyAccount/contact/contact_passwd',
 116   'list_contacts'             => 'MyAccount/contact/list_contacts',
 117   'edit_contact'              => 'MyAccount/contact/edit_contact',
 118   'delete_contact'            => 'MyAccount/contact/delete_contact',
 119   'new_contact'               => 'MyAccount/contact/new_contact',
 120
 121   'billing_history'           => 'MyAccount/billing_history',
 122   'edit_info'                 => 'MyAccount/edit_info',     #add to ss cgi!
 123   'invoice'                   => 'MyAccount/invoice',
 124   'invoice_pdf'               => 'MyAccount/invoice_pdf',
 125   'legacy_invoice'            => 'MyAccount/legacy_invoice',
 126   'legacy_invoice_pdf'        => 'MyAccount/legacy_invoice_pdf',
 127   'invoice_logo'              => 'MyAccount/invoice_logo',
 128   'list_invoices'             => 'MyAccount/list_invoices', #?
 129   'cancel'                    => 'MyAccount/cancel',        #add to ss cgi!
 130   'payment_info'              => 'MyAccount/payment_info',
 131   'payment_info_renew_info'   => 'MyAccount/payment_info_renew_info',
 132   'process_payment'           => 'MyAccount/process_payment',
 133   'store_payment'             => 'MyAccount/store_payment',
 134   'process_stored_payment'    => 'MyAccount/process_stored_payment',
 135   'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
 136   'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
 137   'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
 138   'process_prepay'            => 'MyAccount/process_prepay',
 139   'start_thirdparty'          => 'MyAccount/start_thirdparty',
 140   'finish_thirdparty'         => 'MyAccount/finish_thirdparty',
 141   'realtime_collect'          => 'MyAccount/realtime_collect',
 142   'list_pkgs'                 => 'MyAccount/list_pkgs',     #add to ss (added?)
 143   'list_svcs'                 => 'MyAccount/list_svcs',     #add to ss (added?)
 144   'list_svc_usage'            => 'MyAccount/list_svc_usage',
 145   'svc_status_html'           => 'MyAccount/svc_status_html',
 146   'svc_status_hash'           => 'MyAccount/svc_status_hash',
 147   'set_svc_status_hash'       => 'MyAccount/set_svc_status_hash',
 148   'set_svc_status_listadd'    => 'MyAccount/set_svc_status_listadd',
 149   'set_svc_status_listdel'    => 'MyAccount/set_svc_status_listdel',
 150   'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
 151   'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
 152   'acct_forward_info'         => 'MyAccount/acct_forward_info',
 153   'process_acct_forward'      => 'MyAccount/process_acct_forward',
 154   'list_dsl_devices'          => 'MyAccount/list_dsl_devices',
 155   'add_dsl_device'            => 'MyAccount/add_dsl_device',
 156   'delete_dsl_device'         => 'MyAccount/delete_dsl_device',
 157   'port_graph'                => 'MyAccount/port_graph',
 158   'list_cdr_usage'            => 'MyAccount/list_cdr_usage',
 159   'list_support_usage'        => 'MyAccount/list_support_usage',
 160   'order_pkg'                 => 'MyAccount/order_pkg',     #add to ss cgi!
 161   'change_pkg'                => 'MyAccount/change_pkg',
 162   'order_recharge'            => 'MyAccount/order_recharge',
 163   'renew_info'                => 'MyAccount/renew_info',
 164   'order_renew'               => 'MyAccount/order_renew',
 165   'cancel_pkg'                => 'MyAccount/cancel_pkg',    #add to ss cgi!
 166   'suspend_pkg'               => 'MyAccount/suspend_pkg',   #add to ss cgi!
 167   'charge'                    => 'MyAccount/charge',        #?
 168   'part_svc_info'             => 'MyAccount/part_svc_info',
 169   'provision_acct'            => 'MyAccount/provision_acct',
 170   'provision_phone'           => 'MyAccount/provision_phone',
 171   'provision_pbx'             => 'MyAccount/provision_pbx',
 172   'provision_external'        => 'MyAccount/provision_external',
 173   'unprovision_svc'           => 'MyAccount/unprovision_svc',
 174   'myaccount_passwd'          => 'MyAccount/myaccount_passwd',
 175   'reset_passwd'              => 'MyAccount/reset_passwd',
 176   'check_reset_passwd'        => 'MyAccount/check_reset_passwd',
 177   'process_reset_passwd'      => 'MyAccount/process_reset_passwd',
 178   'list_tickets'              => 'MyAccount/list_tickets',
 179   'create_ticket'             => 'MyAccount/create_ticket',
 180   'get_ticket'                => 'MyAccount/get_ticket',
 181   'adjust_ticket_priority'    => 'MyAccount/adjust_ticket_priority',
 182   'did_report'                => 'MyAccount/did_report',
 183   'signup_info'               => 'Signup/signup_info',
 184   'skin_info'                 => 'MyAccount/skin_info',
 185   'access_info'               => 'MyAccount/access_info',
 186   'domain_select_hash'        => 'Signup/domain_select_hash',  # expose?
 187   'new_customer'              => 'Signup/new_customer',
 188   'new_customer_minimal'      => 'Signup/new_customer_minimal',
 189   'capture_payment'           => 'Signup/capture_payment',
 190   'clear_signup_cache'        => 'Signup/clear_cache',
 191   'new_agent'                 => 'Agent/new_agent',
 192   'agent_login'               => 'Agent/agent_login',
 193   'agent_logout'              => 'Agent/agent_logout',
 194   'agent_info'                => 'Agent/agent_info',
 195   'agent_list_customers'      => 'Agent/agent_list_customers',
 196   'check_username'            => 'Agent/check_username',
 197   'suspend_username'          => 'Agent/suspend_username',
 198   'unsuspend_username'        => 'Agent/unsuspend_username',
 199   'mason_comp'                => 'MasonComponent/mason_comp',
 200   'call_time'                 => 'PrepaidPhone/call_time',
 201   'call_time_nanpa'           => 'PrepaidPhone/call_time_nanpa',
 202   'phonenum_balance'          => 'PrepaidPhone/phonenum_balance',
 203
 204   'list_quotations'           => 'MyAccount/quotation/list_quotations',
 205   'quotation_new'             => 'MyAccount/quotation/quotation_new',
 206   'quotation_delete'          => 'MyAccount/quotation/quotation_delete',
 207   'quotation_info'            => 'MyAccount/quotation/quotation_info',
 208   'quotation_print'           => 'MyAccount/quotation/quotation_print',
 209   'quotation_add_pkg'         => 'MyAccount/quotation/quotation_add_pkg',
 210   'quotation_remove_pkg'      => 'MyAccount/quotation/quotation_remove_pkg',
 211   'quotation_order'           => 'MyAccount/quotation/quotation_order',
 212   };
 213 }
 214
 215
 216 #XXX submit patch to SOAP::Lite
 217
 218 use XMLRPC::Transport::HTTP;
 219
 220 package XMLRPC::Transport::HTTP::Server;
 221
 222 @XMLRPC::Transport::HTTP::Server::ISA = qw(SOAP::Transport::HTTP::Server);
 223
 224 sub initialize; *initialize = \&XMLRPC::Server::initialize;
 225 sub make_fault; *make_fault = \&XMLRPC::Transport::HTTP::CGI::make_fault;
 226 sub make_response; *make_response = \&XMLRPC::Transport::HTTP::CGI::make_response;
 227
 228 1;