sipwise
/
ngcp-panel
mirror of https://github.com/sipwise/ngcp-panel.git
1
0
Fork 0
Code Issues Releases Wiki Activity

MT#8613 Add basic CRUD for LI X-1 provisioning

Browse Source
agranig/webphone
Andreas Granig 11 years ago
parent d0181b97f3
commit 8e0157b78b
4 changed files with 732 additions and 0 deletions
Show Stats Download Patch File Download Diff File

232
lib/NGCP/Panel/Controller/API/Interceptions.pm
Unescape View File

@ -0,0 +1,232 @@
package NGCP::Panel::Controller::API::Interceptions;
use Sipwise::Base;
use namespace::sweep;
use boolean qw(true);
use Data::HAL qw();
use Data::HAL::Link qw();
use HTTP::Headers qw();
use HTTP::Status qw(:constants);
use MooseX::ClassAttribute qw(class_has);
use NGCP::Panel::Utils::DateTime;
use Path::Tiny qw(path);
use Safe::Isa qw($_isa);
use UUID qw/generate unparse/;
use NGCP::Panel::Utils::DateTime;
BEGIN { extends 'Catalyst::Controller::ActionRole'; }
require Catalyst::ActionRole::ACL;
require Catalyst::ActionRole::CheckTrailingSlash;
require Catalyst::ActionRole::HTTPMethods;
require Catalyst::ActionRole::RequireSSL;
class_has 'api_description' => (
is => 'ro',
isa => 'Str',
default =>
'Defines lawful interceptions of subscribers.',
);
class_has 'query_params' => (
is => 'ro',
isa => 'ArrayRef',
default => sub {[
{
param => 'liid',
description => 'Filter for interceptions of a specific interception id',
query => {
first => sub {
my $q = shift;
return { 'me.LIID' => $q };
},
second => sub { },
},
},
{
param => 'number',
description => 'Filter for interceptions of a specific number (in E.164 format)',
query => {
first => sub {
my $q = shift;
return { 'me.number' => $q };
},
second => sub { },
},
},
]},
);
with 'NGCP::Panel::Role::API::Interceptions';
class_has('resource_name', is => 'ro', default => 'interceptions');
class_has('dispatch_path', is => 'ro', default => '/api/interceptions/');
class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-interceptions');
__PACKAGE__->config(
action => {
map { $_ => {
ACLDetachTo => '/api/root/invalid_user',
AllowedRole => [qw/admin/],
Args => 0,
Does => [qw(ACL CheckTrailingSlash RequireSSL)],
Method => $_,
Path => __PACKAGE__->dispatch_path,
} } @{ __PACKAGE__->allowed_methods }
},
action_roles => [qw(HTTPMethods)],
);
sub auto :Private {
my ($self, $c) = @_;
$self->set_body($c);
#$self->log_request($c);
unless($c->user->lawful_intercept) {
$self->error($c, HTTP_FORBIDDEN, "Accessing user has no LI privileges.");
return;
}
}
sub GET :Allow {
my ($self, $c) = @_;
my $page = $c->request->params->{page} // 1;
my $rows = $c->request->params->{rows} // 10;
{
my $items = $self->item_rs($c);
(my $total_count, $items) = $self->paginate_order_collection($c, $items);
my (@embedded, @links);
my $form = $self->get_form($c);
for my $item ($items->all) {
push @embedded, $self->hal_from_item($c, $item, $form);
push @links, Data::HAL::Link->new(
relation => 'ngcp:'.$self->resource_name,
href => sprintf('/%s%d', $c->request->path, $item->id),
);
}
push @links,
Data::HAL::Link->new(
relation => 'curies',
href => 'http://purl.org/sipwise/ngcp-api/#rel-{rel}',
name => 'ngcp',
templated => true,
),
Data::HAL::Link->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'),
Data::HAL::Link->new(relation => 'self', href => sprintf('/%s?page=%s&rows=%s', $c->request->path, $page, $rows));
if(($total_count / $rows) > $page ) {
push @links, Data::HAL::Link->new(relation => 'next', href => sprintf('/%s?page=%d&rows=%d', $c->request->path, $page + 1, $rows));
}
if($page > 1) {
push @links, Data::HAL::Link->new(relation => 'prev', href => sprintf('/%s?page=%d&rows=%d', $c->request->path, $page - 1, $rows));
}
my $hal = Data::HAL->new(
embedded => [@embedded],
links => [@links],
);
$hal->resource({
total_count => $total_count,
});
my $response = HTTP::Response->new(HTTP_OK, undef,
HTTP::Headers->new($hal->http_headers(skip_links => 1)), $hal->as_json);
$c->response->headers($response->headers);
$c->response->body($response->content);
return;
}
return;
}
sub HEAD :Allow {
my ($self, $c) = @_;
$c->forward(qw(GET));
$c->response->body(q());
return;
}
sub OPTIONS :Allow {
my ($self, $c) = @_;
my $allowed_methods = $self->allowed_methods_filtered($c);
$c->response->headers(HTTP::Headers->new(
Allow => $allowed_methods->join(', '),
Accept_Post => 'application/hal+json; profile=http://purl.org/sipwise/ngcp-api/#rel-'.$self->resource_name,
));
$c->response->content_type('application/json');
$c->response->body(JSON::to_json({ methods => $allowed_methods })."\n");
return;
}
sub POST :Allow {
my ($self, $c) = @_;
my $guard = $c->model('DB')->txn_scope_guard;
{
my $resource = $self->get_valid_post_data(
c => $c,
media_type => 'application/json',
);
last unless $resource;
my $form = $self->get_form($c);
last unless $self->validate_form(
c => $c,
resource => $resource,
form => $form,
);
my $num_rs = $c->model('DB')->resultset('voip_numbers')->search(
\[ 'concat(cc,ac,sn) = ?', $resource->{number}]
);
unless($num_rs->first) {
$c->log->error("invalid number '$$resource{number}'");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Number does not exist");
last;
}
$resource->{reseller_id} = $num_rs->first->reseller_id;
my $sub = $num_rs->first->subscriber;
unless($sub) {
$c->log->error("invalid number '$$resource{number}', not assigned to any subscriber");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Number is not active");
last;
}
$resource->{sip_username} = $sub->username;
$resource->{sip_domain} = $sub->domain->domain;
if($resource->{x3_required} && (!defined $resource->{x3_host} || !defined $resource->{x3_port})) {
$c->log->error("Missing parameter 'x3_host' or 'x3_port' with 'x3_required' activated");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Missing parameter 'x3_host' or 'x3_port' with 'x3_required' activated");
last;
}
my ($uuid_bin, $uuid_string);
UUID::generate($uuid_bin);
UUID::unparse($uuid_bin, $uuid_string);
$resource->{uuid} = $uuid_string;
$resource->{deleted} = 0;
$resource->{create_timestamp} = $resource->{modify_timestamp} = NGCP::Panel::Utils::DateTime::current_local;
my $item;
$resource = $self->resnames_to_dbnames($resource);
try {
$item = $c->model('DB')->resultset('voip_intercept')->create($resource);
} catch($e) {
$c->log->error("failed to create interception: $e"); # TODO: user, message, trace, ...
$self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Failed to create interception.");
last;
}
$guard->commit;
$c->response->status(HTTP_CREATED);
$c->response->header(Location => sprintf('/%s%d', $c->request->path, $item->id));
$c->response->body(q());
}
return;
}
sub end : Private {
my ($self, $c) = @_;
$self->log_response($c);
}
# vim: set tabstop=4 expandtab:

206
lib/NGCP/Panel/Controller/API/InterceptionsItem.pm
Unescape View File

@ -0,0 +1,206 @@
package NGCP::Panel::Controller::API::InterceptionsItem;
use Sipwise::Base;
use namespace::sweep;
use HTTP::Headers qw();
use HTTP::Status qw(:constants);
use MooseX::ClassAttribute qw(class_has);
use NGCP::Panel::Utils::DateTime;
use NGCP::Panel::Utils::ValidateJSON qw();
use Path::Tiny qw(path);
use Safe::Isa qw($_isa);
BEGIN { extends 'Catalyst::Controller::ActionRole'; }
require Catalyst::ActionRole::ACL;
require Catalyst::ActionRole::HTTPMethods;
require Catalyst::ActionRole::RequireSSL;
with 'NGCP::Panel::Role::API::Interceptions';
class_has('resource_name', is => 'ro', default => 'interceptions');
class_has('dispatch_path', is => 'ro', default => '/api/interceptions/');
class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-interceptions');
__PACKAGE__->config(
action => {
map { $_ => {
ACLDetachTo => '/api/root/invalid_user',
AllowedRole => [qw/admin reseller/],
Args => 1,
Does => [qw(ACL RequireSSL)],
Method => $_,
Path => __PACKAGE__->dispatch_path,
} } @{ __PACKAGE__->allowed_methods }
},
action_roles => [qw(HTTPMethods)],
);
sub auto :Private {
my ($self, $c) = @_;
$self->set_body($c);
$self->log_request($c);
}
sub GET :Allow {
my ($self, $c, $id) = @_;
{
last unless $self->valid_id($c, $id);
my $item = $self->item_by_id($c, $id);
last unless $self->resource_exists($c, interception => $item);
my $hal = $self->hal_from_item($c, $item);
my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
(map { # XXX Data::HAL must be able to generate links with multiple relations
s|rel="(http://purl.org/sipwise/ngcp-api/#rel-resellers)"|rel="item $1"|;
s/rel=self/rel="item self"/;
$_
} $hal->http_headers),
), $hal->as_json);
$c->response->headers($response->headers);
$c->response->body($response->content);
return;
}
return;
}
sub HEAD :Allow {
my ($self, $c, $id) = @_;
$c->forward(qw(GET));
$c->response->body(q());
return;
}
sub OPTIONS :Allow {
my ($self, $c, $id) = @_;
my $allowed_methods = $self->allowed_methods_filtered($c);
$c->response->headers(HTTP::Headers->new(
Allow => $allowed_methods->join(', '),
Accept_Patch => 'application/json-patch+json',
));
$c->response->content_type('application/json');
$c->response->body(JSON::to_json({ methods => $allowed_methods })."\n");
return;
}
sub PATCH :Allow {
my ($self, $c, $id) = @_;
my $guard = $c->model('DB')->txn_scope_guard;
{
my $preference = $self->require_preference($c);
last unless $preference;
my $json = $self->get_valid_patch_data(
c => $c,
id => $id,
media_type => 'application/json-patch+json',
);
last unless $json;
my $item = $self->item_by_id($c, $id);
last unless $self->resource_exists($c, interception => $item);
my $form = $self->get_form($c);
my $old_resource = $self->resource_from_item($c, $item, $form);
my $resource = $self->apply_patch($c, $old_resource, $json);
last unless $resource;
$item = $self->update_item($c, $item, $old_resource, $resource, $form);
last unless $item;
$guard->commit;
if ('minimal' eq $preference) {
$c->response->status(HTTP_NO_CONTENT);
$c->response->header(Preference_Applied => 'return=minimal');
$c->response->body(q());
} else {
my $hal = $self->hal_from_item($c, $item, $form);
my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
$hal->http_headers,
), $hal->as_json);
$c->response->headers($response->headers);
$c->response->header(Preference_Applied => 'return=representation');
$c->response->body($response->content);
}
}
return;
}
sub PUT :Allow {
my ($self, $c, $id) = @_;
my $guard = $c->model('DB')->txn_scope_guard;
{
my $preference = $self->require_preference($c);
last unless $preference;
my $item = $self->item_by_id($c, $id);
last unless $self->resource_exists($c, interception => $item);
my $resource = $self->get_valid_put_data(
c => $c,
id => $id,
media_type => 'application/json',
);
last unless $resource;
my $form = $self->get_form($c);
my $old_resource = $self->resource_from_item($c, $item, $form);
$item = $self->update_item($c, $item, $old_resource, $resource, $form);
last unless $item;
$guard->commit;
if ('minimal' eq $preference) {
$c->response->status(HTTP_NO_CONTENT);
$c->response->header(Preference_Applied => 'return=minimal');
$c->response->body(q());
} else {
my $hal = $self->hal_from_item($c, $item, $form);
my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new(
$hal->http_headers,
), $hal->as_json);
$c->response->headers($response->headers);
$c->response->header(Preference_Applied => 'return=representation');
$c->response->body($response->content);
}
}
return;
}
sub DELETE :Allow {
my ($self, $c, $id) = @_;
my $guard = $c->model('DB')->txn_scope_guard;
{
my $item = $self->item_by_id($c, $id);
last unless $self->resource_exists($c, interception => $item);
$item->update({
deleted => 1,
reseller_id => undef,
LIID => undef,
number => undef,
cc_required => 0,
delivery_host => undef,
delivery_port => undef,
delivery_user => undef,
delivery_pass => undef,
cc_delivery_host => undef,
cc_delivery_port => undef,
sip_username => undef,
sip_domain => undef,
uuid => undef,
});
$guard->commit;
$c->response->status(HTTP_NO_CONTENT);
$c->response->body(q());
}
return;
}
sub end : Private {
my ($self, $c) = @_;
$self->log_response($c);
}
# vim: set tabstop=4 expandtab:

128
lib/NGCP/Panel/Form/InterceptionAPI.pm
Unescape View File

@ -0,0 +1,128 @@
package NGCP::Panel::Form::InterceptionAPI;
use Sipwise::Base;
use HTML::FormHandler::Moose;
extends 'HTML::FormHandler';
use Moose::Util::TypeConstraints;
use HTML::FormHandler::Widget::Block::Bootstrap;
use Data::Validate::IP qw/is_ipv4 is_ipv6/;
has '+widget_wrapper' => ( default => 'Bootstrap' );
has_field 'submitid' => ( type => 'Hidden' );
sub build_render_list {[qw/submitid fields actions/]}
sub build_form_element_class { [qw/form-horizontal/] }
has_field 'liid' => (
type => 'PosInteger',
required => 1,
element_attr => {
rel => ['tooltip'],
title => ['The LI ID for this interception.']
},
);
has_field 'number' => (
type => 'Text',
required => 1,
element_attr => {
rel => ['tooltip'],
title => ['The number to intercept.']
},
);
has_field 'x2_host' => (
type => 'Text',
required => 1,
validate_method => \&validate_ip,
element_attr => {
rel => ['tooltip'],
title => ['The IP address of the X-2 interface.']
},
);
has_field 'x2_port' => (
type => 'PosInteger',
required => 1,
range_start => 1,
range_end => 65535,
element_attr => {
rel => ['tooltip'],
title => ['The port of the X-2 interface.']
},
);
has_field 'x2_user' => (
type => 'Text',
required => 0,
element_attr => {
rel => ['tooltip'],
title => ['The username for authenticating on the X-2 interface.']
},
);
has_field 'x2_password' => (
type => 'Text',
required => 0,
element_attr => {
rel => ['tooltip'],
title => ['The password for authenticating on the X-2 interface.']
},
);
has_field 'x3_required' => (
type => 'Boolean',
required => 0,
element_attr => {
rel => ['tooltip'],
title => ['Whether to also intercept call content via X-3 interface (false by default).']
},
);
has_field 'x3_host' => (
type => 'Text',
required => 0,
validate_method => \&validate_ip,
element_attr => {
rel => ['tooltip'],
title => ['The IP address of the X-3 interface.']
},
);
has_field 'x3_port' => (
type => 'PosInteger',
required => 0,
range_start => 1,
range_end => 65535,
element_attr => {
rel => ['tooltip'],
title => ['The port of the X-3 interface.']
},
);
has_block 'fields' => (
tag => 'div',
class => [qw/modal-body/],
render_list => [qw/liid number x2_host x2_port x2_user x2_password x3_required x3_host x3_port/],
);
has_block 'actions' => (
tag => 'div',
class => [qw/modal-footer/],
render_list => [qw/save/],
);
sub validate_ip {
my ($self, $field) = @_;
my $ip = $field->value;
unless(is_ipv4($ip) || is_ipv6($ip)) {
$field->add_error("Invalid IPv4 or IPv6 address.");
}
return 1;
}
1;
# vim: set tabstop=4 expandtab:

166
lib/NGCP/Panel/Role/API/Interceptions.pm
Unescape View File

@ -0,0 +1,166 @@
package NGCP::Panel::Role::API::Interceptions;
use Moose::Role;
use Sipwise::Base;
with 'NGCP::Panel::Role::API' => {
-alias =>{ item_rs => '_item_rs', },
-excludes => [ 'item_rs' ],
};
use boolean qw(true);
use TryCatch;
use Data::HAL qw();
use Data::HAL::Link qw();
use HTTP::Status qw(:constants);
use NGCP::Panel::Form::InterceptionAPI;
sub item_rs {
my ($self, $c) = @_;
my $item_rs = $c->model('DB')->resultset('voip_intercept')->search({
deleted => 0,
});
return $item_rs;
}
sub get_form {
my ($self, $c) = @_;
return NGCP::Panel::Form::InterceptionAPI->new;
}
sub hal_from_item {
my ($self, $c, $item, $form) = @_;
$form //= $self->get_form($c);
my $resource = $self->resource_from_item($c, $item, $form);
my $hal = Data::HAL->new(
links => [
Data::HAL::Link->new(
relation => 'curies',
href => 'http://purl.org/sipwise/ngcp-api/#rel-{rel}',
name => 'ngcp',
templated => true,
),
Data::HAL::Link->new(relation => 'collection', href => sprintf("/api/%s/", $self->resource_name)),
Data::HAL::Link->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'),
Data::HAL::Link->new(relation => 'self', href => sprintf("%s%d", $self->dispatch_path, $item->id)),
],
relation => 'ngcp:'.$self->resource_name,
);
$self->validate_form(
c => $c,
resource => $resource,
form => $form,
run => 0,
);
$resource->{id} = int($item->id);
$hal->resource($resource);
return $hal;
}
sub resnames_to_dbnames {
my ($self, $resource) = @_;
my %fmap = (
liid => "LIID",
x2_host => "delivery_host",
x2_port => "delivery_port",
x2_user => "delivery_user",
x2_password => "delivery_pass",
x3_required => "cc_required",
x3_host => "cc_delivery_host",
x3_port => "cc_delivery_port",
);
foreach my $k(keys %fmap) {
next unless exists($resource->{$k});
$resource->{$fmap{$k}} = delete $resource->{$k};
}
return $resource;
}
sub dbnames_to_resnames {
my ($self, $resource) = @_;
my %fmap = (
LIID => "liid",
delivery_host => "x2_host",
delivery_port => "x2_port",
delivery_user => "x2_user",
delivery_pass => "x2_password",
cc_required => "x3_required",
cc_delivery_host => "x3_host",
cc_delivery_port => "x3_port",
);
foreach my $k(keys %fmap) {
next unless exists($resource->{$k});
$resource->{$fmap{$k}} = delete $resource->{$k};
}
return $resource;
}
sub resource_from_item {
my ($self, $c, $item, $form) = @_;
my $resource = { $item->get_inflated_columns };
$resource = $self->dbnames_to_resnames($resource);
return $resource;
}
sub item_by_id {
my ($self, $c, $id) = @_;
my $item_rs = $self->item_rs($c);
return $item_rs->find($id);
}
sub update_item {
my ($self, $c, $item, $old_resource, $resource, $form) = @_;
$form //= $self->get_form($c);
return unless $self->validate_form(
c => $c,
form => $form,
resource => $resource,
);
my $num_rs = $c->model('DB')->resultset('voip_numbers')->search(
\[ 'concat(cc,ac,sn) = ?', $resource->{number}]
);
unless($num_rs->first) {
$c->log->error("invalid number '$$resource{number}'");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Number does not exist");
last;
}
$resource->{reseller_id} = $num_rs->first->reseller_id;
my $sub = $num_rs->first->subscriber;
unless($sub) {
$c->log->error("invalid number '$$resource{number}', not assigned to any subscriber");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Number is not active");
last;
}
$resource->{sip_username} = $sub->username;
$resource->{sip_domain} = $sub->domain->domain;
if($resource->{x3_required} && (!defined $resource->{x3_host} || !defined $resource->{x3_port})) {
$c->log->error("Missing parameter 'x3_host' or 'x3_port' with 'x3_required' activated");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Missing parameter 'x3_host' or 'x3_port' with 'x3_required' activated");
last;
}
$resource->{x3_host} = $resource->{x3_port} = undef unless($resource->{x3_required});
$resource->{modify_timestamp} = NGCP::Panel::Utils::DateTime::current_local;
$resource = $self->resnames_to_dbnames($resource);
$item->update($resource);
return $item;
}
1;
# vim: set tabstop=4 expandtab:
Write Preview
Loading…
Cancel
Save