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 FS::ClientAPI;
  34
  35 $DEBUG = 0;
  36 $FS::ClientAPI::DEBUG = $DEBUG;
  37
  38 sub AUTOLOAD {
  39   my $call = $AUTOLOAD;
  40   $call =~ s/^FS::(SelfService::|ClientAPI_)XMLRPC:://;
  41
  42   warn "FS::ClientAPI_XMLRPC::AUTOLOAD $call\n" if $DEBUG;
  43
  44   my $autoload = &ss2clientapi;
  45
  46   if (exists($autoload->{$call})) {
  47     shift; #discard package name;
  48     #$call = "FS::SelfService::$call";
  49     #no strict 'refs';
  50     #&{$call}(@_);
  51     #FS::ClientAPI->dispatch($autoload->{$call}, @_);
  52     FS::ClientAPI->dispatch($autoload->{$call}, { @_ } );
  53   }else{
  54     die "No such procedure: $call";
  55   }
  56 }
  57
  58 #terrible false laziness w/SelfService.pm
  59 # - fix at build time, by including some file in both selfserv and backend libs?
  60 # - or fix at runtime, by having selfservice client ask server for the list?
  61 sub ss2clientapi {
  62   {
  63   'passwd'                    => 'passwd/passwd',
  64   'chfn'                      => 'passwd/passwd',
  65   'chsh'                      => 'passwd/passwd',
  66   'login_info'                => 'MyAccount/login_info',
  67   'login'                     => 'MyAccount/login',
  68   'logout'                    => 'MyAccount/logout',
  69   'switch_acct'               => 'MyAccount/switch_acct',
  70   'customer_info'             => 'MyAccount/customer_info',
  71   'customer_info_short'       => 'MyAccount/customer_info_short',
  72   'edit_info'                 => 'MyAccount/edit_info',     #add to ss cgi!
  73   'invoice'                   => 'MyAccount/invoice',
  74   'invoice_pdf'               => 'MyAccount/invoice_pdf',
  75   'invoice_logo'              => 'MyAccount/invoice_logo',
  76   'list_invoices'             => 'MyAccount/list_invoices', #?
  77   'cancel'                    => 'MyAccount/cancel',        #add to ss cgi!
  78   'payment_info'              => 'MyAccount/payment_info',
  79   'payment_info_renew_info'   => 'MyAccount/payment_info_renew_info',
  80   'process_payment'           => 'MyAccount/process_payment',
  81   'store_payment'             => 'MyAccount/store_payment',
  82   'process_stored_payment'    => 'MyAccount/process_stored_payment',
  83   'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
  84   'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
  85   'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
  86   'process_prepay'            => 'MyAccount/process_prepay',
  87   'realtime_collect'          => 'MyAccount/realtime_collect',
  88   'list_pkgs'                 => 'MyAccount/list_pkgs',     #add to ss (added?)
  89   'list_svcs'                 => 'MyAccount/list_svcs',     #add to ss (added?)
  90   'list_svc_usage'            => 'MyAccount/list_svc_usage',
  91   'list_dsl_devices'          => 'MyAccount/list_dsl_devices',
  92   'add_dsl_device'            => 'MyAccount/add_dsl_device',
  93   'delete_dsl_device'         => 'MyAccount/delete_dsl_device',
  94   'port_graph'                => 'MyAccount/port_graph',
  95   'list_cdr_usage'            => 'MyAccount/list_cdr_usage',
  96   'list_support_usage'        => 'MyAccount/list_support_usage',
  97   'order_pkg'                 => 'MyAccount/order_pkg',     #add to ss cgi!
  98   'change_pkg'                => 'MyAccount/change_pkg',
  99   'order_recharge'            => 'MyAccount/order_recharge',
 100   'renew_info'                => 'MyAccount/renew_info',
 101   'order_renew'               => 'MyAccount/order_renew',
 102   'cancel_pkg'                => 'MyAccount/cancel_pkg',    #add to ss cgi!
 103   'suspend_pkg'               => 'MyAccount/suspend_pkg',   #add to ss cgi!
 104   'charge'                    => 'MyAccount/charge',        #?
 105   'part_svc_info'             => 'MyAccount/part_svc_info',
 106   'provision_acct'            => 'MyAccount/provision_acct',
 107   'provision_phone'           => 'MyAccount/provision_phone',
 108   'provision_external'        => 'MyAccount/provision_external',
 109   'unprovision_svc'           => 'MyAccount/unprovision_svc',
 110   'myaccount_passwd'          => 'MyAccount/myaccount_passwd',
 111   'reset_passwd'              => 'MyAccount/reset_passwd',
 112   'create_ticket'             => 'MyAccount/create_ticket',
 113   'get_ticket'                => 'MyAccount/get_ticket',
 114   'adjust_ticket_priority'    => 'MyAccount/adjust_ticket_priority',
 115   'did_report'                => 'MyAccount/did_report',
 116   'signup_info'               => 'Signup/signup_info',
 117   'skin_info'                 => 'MyAccount/skin_info',
 118   'access_info'               => 'MyAccount/access_info',
 119   'domain_select_hash'        => 'Signup/domain_select_hash',  # expose?
 120   'new_customer'              => 'Signup/new_customer',
 121   'capture_payment'           => 'Signup/capture_payment',
 122   'clear_signup_cache'        => 'Signup/clear_cache',
 123   'new_agent'                 => 'Agent/new_agent',
 124   'agent_login'               => 'Agent/agent_login',
 125   'agent_logout'              => 'Agent/agent_logout',
 126   'agent_info'                => 'Agent/agent_info',
 127   'agent_list_customers'      => 'Agent/agent_list_customers',
 128   'check_username'            => 'Agent/check_username',
 129   'suspend_username'          => 'Agent/suspend_username',
 130   'unsuspend_username'        => 'Agent/unsuspend_username',
 131   'mason_comp'                => 'MasonComponent/mason_comp',
 132   'call_time'                 => 'PrepaidPhone/call_time',
 133   'call_time_nanpa'           => 'PrepaidPhone/call_time_nanpa',
 134   'phonenum_balance'          => 'PrepaidPhone/phonenum_balance',
 135   #izoom
 136   #'bulk_processrow'           => 'Bulk/processrow',
 137   #conflicts w/Agentone# 'check_username'            => 'Bulk/check_username',
 138   #sg
 139   'ping'                      => 'SGNG/ping',
 140   'decompify_pkgs'            => 'SGNG/decompify_pkgs',
 141   'previous_payment_info'     => 'SGNG/previous_payment_info',
 142   'previous_payment_info_renew_info'
 143                               => 'SGNG/previous_payment_info_renew_info',
 144   'previous_process_payment'  => 'SGNG/previous_process_payment',
 145   'previous_process_payment_order_pkg'
 146                               => 'SGNG/previous_process_payment_order_pkg',
 147   'previous_process_payment_change_pkg'
 148                               => 'SGNG/previous_process_payment_change_pkg',
 149   'previous_process_payment_order_renew'
 150                               => 'SGNG/previous_process_payment_order_renew',
 151   };
 152 }
 153
 154
 155 #XXX submit patch to SOAP::Lite
 156
 157 use XMLRPC::Transport::HTTP;
 158
 159 package XMLRPC::Transport::HTTP::Server;
 160
 161 @XMLRPC::Transport::HTTP::Server::ISA = qw(SOAP::Transport::HTTP::Server);
 162
 163 sub initialize; *initialize = \&XMLRPC::Server::initialize;
 164 sub make_fault; *make_fault = \&XMLRPC::Transport::HTTP::CGI::make_fault;
 165 sub make_response; *make_response = \&XMLRPC::Transport::HTTP::CGI::make_response;
 166
 167 1;