You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ngcp-panel/lib/NGCP/Panel/Controller/API/LnpNumbers.pm

276 lines
9.3 KiB

package NGCP::Panel::Controller::API::LnpNumbers;
use NGCP::Panel::Utils::Generic qw(:all);
use Sipwise::Base;
use Moose;
#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 NGCP::Panel::Utils::Lnp;
use NGCP::Panel::Utils::MySQL;
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 LNP number entries ported to a specific <a href="#lnpcarriers">LNP Carrier</a>. You can POST numbers individually one-by-one using json. To bulk-upload numbers, specify the Content-Type as "text/csv" and POST the CSV in the request body to the collection with an optional parameter "purge_existing=true", like "/api/lnpnumbers/?purge_existing=true"',
);
class_has 'query_params' => (
is => 'ro',
isa => 'ArrayRef',
default => sub {[
{
param => 'carrier_id',
description => 'Filter for LNP numbers belonging to a specific LNP carrier',
query => {
first => sub {
my $q = shift;
{ lnp_provider_id => $q };
},
second => sub {},
},
},
{
param => 'number',
description => 'Filter for LNP numbers with a specific number (wildcards possible)',
query => {
first => sub {
my $q = shift;
{ number => { like => $q } };
},
second => sub {},
},
},
]},
);
with 'NGCP::Panel::Role::API::LnpNumbers';
class_has('resource_name', is => 'ro', default => 'lnpnumbers');
class_has('dispatch_path', is => 'ro', default => '/api/lnpnumbers/');
class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-lnpnumbers');
__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);
}
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 => join(', ', @{ $allowed_methods }),
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 $schema = $c->model('DB');
my $resource;
my $data = $self->get_valid_raw_post_data(
c => $c,
media_type => [qw#application/json text/csv#],
);
last unless $data;
if($c->request->header('Content-Type') eq 'text/csv') {
$resource = $c->req->query_params;
} else {
last unless $self->require_wellformed_json($c, 'application/json', $data);
$resource = JSON::from_json($data, { utf8 => 1 });
$data = undef;
}
if ($data) {
my($numbers, $fails, $text_success);
try {
if ($resource->{purge_existing} eq 'true') {
my ($start, $end);
$start = time;
NGCP::Panel::Utils::MySQL::truncate_table(
c => $c,
schema => $schema,
do_transaction => 0,
table => 'billing.lnp_numbers',
);
$schema->resultset('lnp_providers')->delete;
$end = time;
$c->log->debug("API Purging LNP entries took " . ($end - $start) . "s");
}
( $numbers, $fails, $text_success ) = NGCP::Panel::Utils::Lnp::upload_csv(
c => $c,
data => \$data,
schema => $schema,
);
$c->log->info( $$text_success );
$guard->commit;
$c->response->status(HTTP_CREATED);
$c->response->body(q());
} catch($e) {
$c->log->error("failed to upload csv: $e");
$self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Internal Server Error");
last;
};
} else {
delete $resource->{purge_existing};
my $form = $self->get_form($c);
$resource->{lnp_provider_id} = delete $resource->{carrier_id};
last unless $self->validate_form(
c => $c,
resource => $resource,
form => $form,
);
$resource->{start} .= "T00:00:00";
$resource->{end} .= "T23:59:59";
my $carrier = $c->model('DB')->resultset('lnp_providers')->find($resource->{lnp_provider_id});
unless($carrier) {
$c->log->error("invalid carrier_id '$$resource{lnp_provider_id}'"); # TODO: user, message, trace, ...
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "LNP carrier_id does not exist");
last;
}
my $item;
=pod
# for now numbers can be inserted duplicated, so don't check
$item = $c->model('DB')->resultset('lnp_numbers')->find({
lnp_provider_id => $resource->{lnp_provider_id},
number => $resource->{number},
});
if($item) {
$c->log->error("lnp number with number '$$resource{number}' already exists for carrier_id '$$resource{lnp_provider_id}'"); # TODO: user, message, trace, ...
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "LNP number with this number already exists for this LNP carrier");
last;
}
=cut
try {
$item = $c->model('DB')->resultset('lnp_numbers')->create($resource);
} catch($e) {
$c->log->error("failed to create lnp number: $e"); # TODO: user, message, trace, ...
$self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Failed to create lnp number.");
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);
}
no Moose;
1;
# vim: set tabstop=4 expandtab: