1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
|
package JSONRPC::Transport::HTTP;
use strict;
use base qw(JSONRPC);
use vars qw($VERSION);
use HTTP::Request;
use HTTP::Response;
$VERSION = 1.00;
#
#
#
package JSONRPC::Transport::HTTP::Client;
use base qw(JSONRPC::Client);
sub send { require LWP::UserAgent;
my ($self, $content) = @_;
my ($url, $proxy_url) = @{$self->{_proxy}};
my $ua = LWP::UserAgent->new;
$ua->proxy(['http','https'], $proxy_url) if($proxy_url);
$ua->post($url, Content_Type => 'text/plain', Content => $content);
}
#
#
#
package JSONRPC::Transport::HTTP::Server;
use base qw(JSONRPC);
use constant DEFAULT_CHARSET => 'UTF-8';
sub new {
my $self = shift;
my %opt = @_;
unless (ref $self) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(%opt);
}
$self->charset( $opt{charset} || DEFAULT_CHARSET );
return $self;
}
sub handle {
my $self = shift;
my $jp = $self->jsonParser;
unless(ref $self){ $self = $self->new(@_) }
my $req;
if( $req = $self->request ){
$self->{json_data}
# = eval q| $jp->parse($req->content) | or return $self->invalid_request();
= eval q| $jp->parse($req->content) |
or return $self->send_response( $self->invalid_request() );
if( defined $self->request_id($self->{json_data}->{id}) ){
my $res = $self->handle_method($req) or return $self->invalid_request();
return $self->send_response( $self->response($res) );
}
else{
$self->notification();
$self->send_response( $self->no_response() );
}
}
else{
$self->send_response( $self->invalid_request() );
}
}
sub charset {
$_[0]->{_charset} = $_[1] if(@_ > 1);
$_[0]->{_charset};
}
sub response {
my $self = shift;
my $res = shift;
my $charset = $self->charset;
my $h = HTTP::Headers->new;
$h->header('Content-Type' => "text/plain; charset=$charset");
HTTP::Response->new(200 => undef, $h, $res);
}
sub invalid_request {
my $self = shift;
my $charset = $self->charset;
my $h = HTTP::Headers->new;
$h->header('Content-Type' => "text/plain; charset=$charset");
HTTP::Response->new(500 => undef, $h);
}
sub no_response {
my $self = shift;
my $charset = $self->charset;
my $h = HTTP::Headers->new;
$h->header('Content-Type' => "text/plain; charset=$charset");
HTTP::Response->new(200 => undef, $h);
}
sub send_response { }
#
#
#
package JSONRPC::Transport::HTTP::CGI;
use CGI;
use base qw(JSONRPC::Transport::HTTP::Server);
use constant DEFAULT_CHARSET => 'UTF-8';
use constant MAX_CONTENT_LENGTH => 1024 * 1024 * 5; # 5M
sub new { shift->SUPER::new(@_); }
sub handle {
my $self = shift->new();
my %opt = @_;
for my $name (qw/charset paramName query/){
$self->$name( $opt{$name} ) if(exists $opt{$name});
}
$self->SUPER::handle();
}
sub request {
my $self = shift;
my $q = $self->query || new CGI;
my $len = $ENV{'CONTENT_LENGTH'} || 0;
if(MAX_CONTENT_LENGTH < $len){ return; }
my $req = HTTP::Request->new($q->request_method, $q->url);
return if($req->method ne 'POST');
if(defined $self->paramName){
$req->content( $q->param($self->paramName) );
}
else{
my @name = $q->param;
$req->content(
((@name == 1) ? $q->param($name[0]) : $q->param('POSTDATA'))
);
}
return $self->{_request} = $req;
}
sub send_response {
my ($self, $res) = @_;
print "Status: " . $res->code . "\015\012" . $res->headers_as_string("\015\012")
. "\015\012" . $res->content;
}
sub query {
$_[0]->{_query} = $_[1] if(@_ > 1);
$_[0]->{_query};
}
sub paramName {
$_[0]->{_paramName} = $_[1] if(@_ > 1);
$_[0]->{_paramName};
}
#
#
#
package JSONRPC::Transport::HTTP::Daemon;
use base qw(JSONRPC::Transport::HTTP::Server);
sub new {
my $self = shift;
unless (ref $self) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(@_);
}
my $pkg;
if( grep { $_ =~ /^SSL_/ } @_ ){
$self->{_daemon_pkg} = $pkg = 'HTTP::Daemon::SSL';
}
else{
$self->{_daemon_pkg} = $pkg = 'HTTP::Daemon';
}
eval qq| require $pkg; |;
if($@){ die $@ }
$self->{_daemon} ||= $pkg->new(@_) or die;
return $self;
}
sub handle {
my $self = shift;
my %opt = @_;
my $d = $self->{_daemon} ||= $self->{_daemon_pkg}->new(@_) or die;
$self->charset = $opt{charset} if($opt{charset});
while (my $c = $d->accept) {
$self->{con} = $c;
while (my $r = $c->get_request) {
if ($r->method eq 'POST') {
$self->request($r);
$self->SUPER::handle();
}
else {
$self->invalid_request();
}
last;
}
$c->close;
}
}
sub request {
$_[0]->{_request} = $_[1] if(@_ > 1);
$_[0]->{_request};
}
sub send_response {
my ($self, $res) = @_;
$self->{con}->send_response($res);
}
#
#
#
package JSONRPC::Transport::HTTP::Apache;
use base qw(JSONRPC::Transport::HTTP::Server);
use constant MAX_CONTENT_LENGTH => 1024 * 1024 * 5; # 5M
sub new {
my $self = shift;
require Apache;
require Apache::Constants;
unless (ref $self) {
my $class = ref($self) || $self;
$self = $class->SUPER::new(@_);
}
return $self;
}
sub request {
my $self = shift;
my $r = shift || Apache->request;
my $len = $r->header_in('Content-length');
$self->{apr} = $r;
return if($r->method ne 'POST');
return if(MAX_CONTENT_LENGTH < $len);
my $req = HTTP::Request->new($r->method, $r->uri);
my ($buf, $content);
while( $r->read($buf,$len) ){
$content .= $buf;
}
$req->content($content);
return $self->{_request} = $req;
}
sub send_response {
my ($self, $res) = @_;
my $r = $self->{apr};
$r->send_http_header("text/plain");
$r->print($res->content);
return ($res->code == 200)
? &Apache::Constants::OK : &Apache::Constants::SERVER_ERROR;
}
sub configure {
my $self = shift;
my $config = shift->dir_config;
for my $method (keys %$config) {
my @values = split(/\s*,\s*/, $config->{$method});
$self->$method(@values) if($self->can($method));
}
$self;
}
1;
__END__
=head1 NAME
JSONRPC::Transport::HTTP
=head1 SYNOPSIS
#--------------------------
# In your application class
package MyApp;
sub own_method { # called by clients
my ($server, @params) = @_; # $server is JSONRPC object.
...
# return a scalar value or a hashref or an arryaref.
}
#--------------------------
# In your main cgi script.
use JSONRPC::Transport::HTTP;
use MyApp;
# a la XMLRPC::Lite
JSONRPC::Transport::HTTP::CGI->dispatch_to('MyApp')->handle();
##################
# Daemon version #
##################
use strict;
use lib qw(. ./lib);
use JSONRPC::Transport::HTTP;
my $daemon = JSONRPC::Transport::HTTP::Daemon
->new(LocalPort => 8080)
->dispatch_to('MyApp/Test', 'MyApp/Test2');
$daemon->handle();
##################
# Apache version #
##################
http.conf or .htaccess
SetHandler perl-script
PerlHandler Apache::JSONRPC
PerlModule MyApp::Test
PerlSetVar dispatch_to "MyApp::Test, MyApp/Test2/"
#--------------------------
# Client
#--------------------------
use JSONRPC::Transport::HTTP;
my $uri = 'http://www.example.com/MyApp/Test/';
my $res = JSONRPC::Transport::HTTP
->proxy($uri)
->call('echo',['This is test.'])
->result;
if($res->error){
print $res->error,"\n";
}
else{
print $res->result,"\n";
}
# or
my $client = JSONRPC::Transport::HTTP->proxy($uri);
print $client->echo('This is test.'); # the alias, _echo is same.
=head1 DESCRIPTION
This module is L<JSONRPC> subclass.
Most ideas were borrowed from L<XMLRPC::Lite>.
Currently C<JSONRPC> provides only CGI server function.
=head1 CHARSET
When the module returns response, its charset is UTF-8 by default.
You can change it via passing a key/value pair into handle().
my %charset = (charset => 'EUC-JP');
JSONRPC::Transport::HTTP::CGI->dispatch_to('MyApp')->handle(%charset);
=head1 QUERY OBJECT
If you want to use any other query object instead of C<CGI>
for JSONRPC::Transport::HTTP::CGI, you can pass C<query> option and
C<paramName>.
my %opt = (
query => $session, # CGI::Session object
paramName => 'json',
);
JSONRPC::Transport::HTTP::CGI->dispatch_to('MyApp')->handle(%opt);
=head1 CAUTION
JSONRPC::Transport::HTTP::CGI requires CGI.pm which version is more than 2.9.2.
(the core module in Perl 5.8.1.)
Since verion 1.0, JSONRPC::Transport::HTTP requires L<HTTP::Request>
and L<HTTP::Response>. For using JSONRPC::Transport::HTTP::Client,
you need L<LWP::UserAgent>.
=head1 SEE ALSO
L<JSONRPC>
L<JSON>
L<XMLRPC::Lite>
L<http://json-rpc.org/>
=head1 AUTHOR
Makamaka Hannyaharamitu, E<lt>makamaka[at]cpan.orgE<gt>
=head1 COPYRIGHT AND LICENSE
Copyright 2005 by Makamaka Hannyaharamitu
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
=cut
|