#!perl
use 5.010;
use strict;
use warnings;
use Log::Any qw($log);
use File::HomeDir;
use Module::List qw(list_modules);
use Module::Load;
use Perinci::Access::Simple::Server::Socket;
use Perinci::CmdLine::Any;
use Perinci::Gen::ForModule qw(gen_meta_for_module);
our $VERSION = '0.20'; # VERSION
our %SPEC;
$SPEC{serve} = {
v => 1.1,
summary => 'Serve Perl modules using Riap::Simple protocol over sockets',
description => <<'_',
This is a simple command-line front-end for
Perinci::Acces::Simple::Server::Socket, for making Perl modules accessible over
TCP or Unix socket, using the Riap::Simple protocol. First the specified Perl
modules will be loaded. Modules which do not contain Rinci metadata will be
equipped with metadata using Perinci::Sub::Gen::ForModule. Perl modules not
specified in the command-line arguments will not be accessible, since
Perinci::Access::Perl is used with load=>0.
Modules can be accessed with Riap clients such as Perinci::Access using URL:
riap+tcp://HOST:PORT/MODULE/SUBMOD/FUNCTION
riap+unix:UNIX_SOCKET_PATH//MODULE/SUBMOD/FUNCTION
_
args => {
modules => {
schema => ['array*' => {of => 'str*', min_len => 1}],
req => 1,
pos => 0,
greedy => 1,
summary => 'List of modules to load',
description => <<'_',
Either specify exact module name or one using wildcard (e.g. 'Foo::Bar::*', in
which Module::List will be used to load all modules under 'Foo::Bar::').
_
},
access_log_path => {
schema => 'str',
summary => 'Path for access log file',
description => <<'_',
Default is ~/peri-sockserve-access.log
_
},
ports => {
schema => 'str*',
summary =>
'Will be passed to Perinci::Access::Simple::Server::Socket',
cmdline_aliases => {p=>{}},
},
unix_sockets => {
schema => 'str*',
summary =>
'Will be passed to Perinci::Access::Simple::Server::Socket',
cmdline_aliases => {s=>{}},
},
daemonize => {
schema => ['bool' => {default=>0}],
summary => 'If true, will daemonize into background',
cmdline_aliases => {D=>{}},
},
fork => {
schema => ['bool' => {default=>1}],
summary => 'Set to false to disable forking',
},
library => {
schema => ['array' => {
of => 'str*',
}],
summary => 'Add directory to library search path, a la Perl\'s -I',
cmdline_aliases => {I=>{}},
},
},
};
sub serve {
$log->infof("Starting server ...");
my %args = @_;
return [400, "Please specify at least 1 module"]
unless $args{modules} && @{$args{modules}};
return [400, "Please specify at least port or Unix socket"]
unless $args{ports} || $args{unix_sockets};
my $access_log_path = $args{access_log_path} //
File::HomeDir->my_home . "/peri-sockserve-access.log";
for my $dir (@{ $args{library} // [] }) {
require lib;
lib->import($dir);
}
my @modules;
for my $m (@{$args{modules}}) {
if ($m =~ /(.+::)\*$/) {
my $res = list_modules($1, {list_modules=>1});
push @modules, keys %$res;
} else {
push @modules, $m;
}
}
$log->debugf("Modules to load: %s", \@modules);
for my $m (@modules) {
$log->infof("Loading module %s ...", $m);
eval { load $m };
return [500, "Failed to load module $m: $@"] if $@;
gen_meta_for_module(module=>$m, load=>0);
}
my $server = Perinci::Access::Simple::Server::Socket->new(
ports => $args{ports},
unix_sockets => $args{unix_sockets},
daemonize => $args{daemonize} // 0,
scoreboard_path => 0,
access_log_path => $access_log_path,
start_servers => ($args{fork} // 1) ? undef : 0,
);
$server->run;
[200, "OK"];
}
Perinci::CmdLine::Any->new(url => '/main/serve')->run;
1;
#ABSTRACT: Serve Perl modules using the Riap::Simple protocol over sockets
#PODNAME: peri-sockserve
__END__
=pod
=encoding UTF-8
=head1 NAME
peri-sockserve - Serve Perl modules using the Riap::Simple protocol over sockets
=head1 VERSION
This document describes version 0.20 of peri-sockserve (from Perl distribution Perinci-Access-Simple-Server), released on 2014-12-11.
=head1 SYNOPSIS
# serve modules
% peri-sockserve -p 127.0.0.1:5678 -s /path/to/unix/sock Foo::Bar Baz::*
# access the server
% perl -MPerinci::Access -e'
my $pa = Perinci::Access->new;
my $res = $pa->request(call=>"riap+tcp://localhost:5678/Foo/Bar/func1",
{args=>{a1=>1, a2=>2}});'
my $res = $pa->request(meta=>"riap+tcp:path/to/unix/sock//Baz/Qux/func2");'
# see more options
% peri-sockserve --help
=head1 SEE ALSO
L<Riap::Simple>, L<Riap>, L<Rinci>
L<Perinci::Access::Simple::Client>, L<Perinci::Access>
=head1 COMPLETION
This script has shell tab completion capability with support for several shells.
=head2 bash
To activate bash completion for this script, put:
complete -C peri-sockserve peri-sockserve
in your bash startup (e.g. C<~/.bashrc>). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
You can also install L<App::BashCompletionProg> which makes it easy to add completion for Getopt::Long::Complete-based scripts. After you install the module and put C<. ~/.bash-complete-prog> (or C<. /etc/bash-complete-prog>), you can just run C<bash-completion-prog> and the C<complete> command will be added to your C<~/.bash-completion-prog>. Your next shell session will then recognize tab completion for the command.
=head2 fish
To activate fish completion for this script, execute:
begin; set -lx COMP_SHELL fish; set -lx COMP_MODE gen_command; peri-sockserve; end > $HOME/.config/fish/completions/peri-sockserve.fish
Or if you want to install globally, you can instead write the generated script to C</etc/fish/completions/peri-sockserve.fish> or C</usr/share/fish/completions/peri-sockserve.fish>. The exact path might be different on your system. Please check your C<fish_complete_path> variable.
=head2 tcsh
To activate tcsh completion for this script, put:
complete peri-sockserve 'p/*/`peri-sockserve`/'
in your tcsh startup (e.g. C<~/.tcshrc>). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
=head2 zsh
To activate zsh completion for this script, put:
_peri_sockserve() { read -l; local cl="$REPLY"; read -ln; local cp="$REPLY"; reply=(`COMP_SHELL=zsh COMP_LINE="$cl" COMP_POINT="$cp" peri-sockserve`) }
compctl -K _peri_sockserve peri-sockserve
in your zsh startup (e.g. C<~/.zshrc>). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Perinci-Access-Simple-Server>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Perinci-Access-Simple-Server>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Access-Simple-Server>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2014 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut