1 package FS::ClientAPI_XMLRPC;
5 FS::ClientAPI_XMLRPC - Freeside XMLRPC accessible self-service API, on the backend
9 This module implements the self-service API offered by xmlrpc.cgi and friends,
10 but on a backend machine.
14 Use this API to implement your own client "self-service" module vi XMLRPC.
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>.
26 L<FS::SelfService::XMLRPC>, L<FS::SelfService>
32 use vars qw($DEBUG $AUTOLOAD);
33 use XMLRPC::Lite; # for XMLRPC::Data
37 $FS::ClientAPI::DEBUG = $DEBUG;
39 #false laziness w/FS::SelfService/XMLRPC.pm, same problem as below but worse
40 our %typefix_skin_info = (
42 'title_left_image' => 'base64',
43 'title_right_image' => 'base64',
44 'menu_top_image' => 'base64',
45 'menu_body_image' => 'base64',
46 'menu_bottom_image' => 'base64',
49 'invoice_pdf' => { 'invoice_pdf' => 'base64', },
50 'legacy_invoice_pdf' => { 'invoice_pdf' => 'base64', },
51 'skin_info' => \%typefix_skin_info,
52 'login_info' => \%typefix_skin_info,
53 'invoice_logo' => { 'logo' => 'base64', },
54 'login_banner_image' => { 'image' => 'base64', },
59 $call =~ s/^FS::(SelfService::|ClientAPI_)XMLRPC:://;
61 warn "FS::ClientAPI_XMLRPC::AUTOLOAD $call\n" if $DEBUG;
63 my $autoload = &ss2clientapi;
65 if (exists($autoload->{$call})) {
67 shift; #discard package name;
69 #$call = "FS::SelfService::$call";
72 #FS::ClientAPI->dispatch($autoload->{$call}, @_);
74 my $return = FS::ClientAPI->dispatch($autoload->{$call}, { @_ } );
76 if ( exists($typefix{$call}) ) {
77 my $typefix = $typefix{$call};
78 foreach my $field ( grep exists($return->{$_}), keys %$typefix ) {
79 my $type = $typefix->{$field};
80 $return->{$field} = XMLRPC::Data->value($return->{$field})
88 die "No such procedure: $call";
92 #terrible false laziness w/SelfService.pm
93 # - fix at build time, by including some file in both selfserv and backend libs?
94 # - or fix at runtime, by having selfservice client ask server for the list?
97 'passwd' => 'passwd/passwd',
98 'chfn' => 'passwd/passwd',
99 'chsh' => 'passwd/passwd',
100 'login_info' => 'MyAccount/login_info',
101 'login_banner_image' => 'MyAccount/login_banner_image',
102 'login' => 'MyAccount/login',
103 'logout' => 'MyAccount/logout',
104 'switch_acct' => 'MyAccount/switch_acct',
105 'customer_info' => 'MyAccount/customer_info',
106 'customer_info_short' => 'MyAccount/customer_info_short',
107 'billing_history' => 'MyAccount/billing_history',
108 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
109 'invoice' => 'MyAccount/invoice',
110 'invoice_pdf' => 'MyAccount/invoice_pdf',
111 'legacy_invoice' => 'MyAccount/legacy_invoice',
112 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
113 'invoice_logo' => 'MyAccount/invoice_logo',
114 'list_invoices' => 'MyAccount/list_invoices', #?
115 'cancel' => 'MyAccount/cancel', #add to ss cgi!
116 'payment_info' => 'MyAccount/payment_info',
117 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
118 'process_payment' => 'MyAccount/process_payment',
119 'store_payment' => 'MyAccount/store_payment',
120 'process_stored_payment' => 'MyAccount/process_stored_payment',
121 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
122 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
123 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
124 'process_prepay' => 'MyAccount/process_prepay',
125 'realtime_collect' => 'MyAccount/realtime_collect',
126 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
127 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
128 'list_svc_usage' => 'MyAccount/list_svc_usage',
129 'svc_status_html' => 'MyAccount/svc_status_html',
130 'svc_status_hash' => 'MyAccount/svc_status_hash',
131 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
132 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
133 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
134 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
135 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
136 'acct_forward_info' => 'MyAccount/acct_forward_info',
137 'process_acct_forward' => 'MyAccount/process_acct_forward',
138 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
139 'add_dsl_device' => 'MyAccount/add_dsl_device',
140 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
141 'port_graph' => 'MyAccount/port_graph',
142 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
143 'list_support_usage' => 'MyAccount/list_support_usage',
144 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
145 'change_pkg' => 'MyAccount/change_pkg',
146 'order_recharge' => 'MyAccount/order_recharge',
147 'renew_info' => 'MyAccount/renew_info',
148 'order_renew' => 'MyAccount/order_renew',
149 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
150 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
151 'charge' => 'MyAccount/charge', #?
152 'part_svc_info' => 'MyAccount/part_svc_info',
153 'provision_acct' => 'MyAccount/provision_acct',
154 'provision_phone' => 'MyAccount/provision_phone',
155 'provision_external' => 'MyAccount/provision_external',
156 'unprovision_svc' => 'MyAccount/unprovision_svc',
157 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
158 'reset_passwd' => 'MyAccount/reset_passwd',
159 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
160 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
161 'create_ticket' => 'MyAccount/create_ticket',
162 'get_ticket' => 'MyAccount/get_ticket',
163 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
164 'did_report' => 'MyAccount/did_report',
165 'signup_info' => 'Signup/signup_info',
166 'skin_info' => 'MyAccount/skin_info',
167 'access_info' => 'MyAccount/access_info',
168 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
169 'new_customer' => 'Signup/new_customer',
170 'capture_payment' => 'Signup/capture_payment',
171 'clear_signup_cache' => 'Signup/clear_cache',
172 'new_agent' => 'Agent/new_agent',
173 'agent_login' => 'Agent/agent_login',
174 'agent_logout' => 'Agent/agent_logout',
175 'agent_info' => 'Agent/agent_info',
176 'agent_list_customers' => 'Agent/agent_list_customers',
177 'check_username' => 'Agent/check_username',
178 'suspend_username' => 'Agent/suspend_username',
179 'unsuspend_username' => 'Agent/unsuspend_username',
180 'mason_comp' => 'MasonComponent/mason_comp',
181 'call_time' => 'PrepaidPhone/call_time',
182 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
183 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
185 #'bulk_processrow' => 'Bulk/processrow',
186 #conflicts w/Agentone# 'check_username' => 'Bulk/check_username',
188 'ping' => 'SGNG/ping',
189 'decompify_pkgs' => 'SGNG/decompify_pkgs',
190 'previous_payment_info' => 'SGNG/previous_payment_info',
191 'previous_payment_info_renew_info'
192 => 'SGNG/previous_payment_info_renew_info',
193 'previous_process_payment' => 'SGNG/previous_process_payment',
194 'previous_process_payment_order_pkg'
195 => 'SGNG/previous_process_payment_order_pkg',
196 'previous_process_payment_change_pkg'
197 => 'SGNG/previous_process_payment_change_pkg',
198 'previous_process_payment_order_renew'
199 => 'SGNG/previous_process_payment_order_renew',
204 #XXX submit patch to SOAP::Lite
206 use XMLRPC::Transport::HTTP;
208 package XMLRPC::Transport::HTTP::Server;
210 @XMLRPC::Transport::HTTP::Server::ISA = qw(SOAP::Transport::HTTP::Server);
212 sub initialize; *initialize = \&XMLRPC::Server::initialize;
213 sub make_fault; *make_fault = \&XMLRPC::Transport::HTTP::CGI::make_fault;
214 sub make_response; *make_response = \&XMLRPC::Transport::HTTP::CGI::make_response;