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.
267 lines
8.7 KiB
267 lines
8.7 KiB
package NGCP::Panel::Controller::API::Faxes;
|
|
use NGCP::Panel::Utils::Generic qw(:all);
|
|
|
|
use Sipwise::Base;
|
|
|
|
|
|
use boolean qw(true);
|
|
use NGCP::Panel::Utils::DataHal qw();
|
|
use NGCP::Panel::Utils::DataHalLink qw();
|
|
use HTTP::Headers qw();
|
|
use HTTP::Status qw(:constants);
|
|
|
|
use NGCP::Panel::Utils::DateTime;
|
|
use NGCP::Panel::Utils::API::Subscribers;
|
|
use NGCP::Panel::Utils::Fax;
|
|
use Encode qw( encode_utf8 );
|
|
require Catalyst::ActionRole::ACL;
|
|
require Catalyst::ActionRole::CheckTrailingSlash;
|
|
require NGCP::Panel::Role::HTTPMethods;
|
|
require Catalyst::ActionRole::RequireSSL;
|
|
|
|
sub allowed_methods{
|
|
return [qw/GET POST OPTIONS HEAD/];
|
|
}
|
|
|
|
sub api_description {
|
|
return 'Defines the meta information like duration, sender etc for fax recordings. The actual recordings can be fetched via the <a href="#faxrecordings">FaxRecordings</a> relation. NOTE: There is no Location header in the POST method response, as creation is asynchronous.';
|
|
};
|
|
|
|
#sub properties {
|
|
# return {
|
|
# asynchronous => 1,
|
|
# };
|
|
#}
|
|
|
|
sub query_params {
|
|
return [
|
|
{
|
|
param => 'subscriber_id',
|
|
description => 'Filter for faxes belonging to a specific subscriber',
|
|
query => {
|
|
first => sub {
|
|
my $q = shift;
|
|
# join is already done in get_item_rs
|
|
{ 'voip_subscriber.id' => $q };
|
|
},
|
|
second => sub { },
|
|
},
|
|
},
|
|
|
|
{
|
|
param => 'time_from',
|
|
description => 'Filter for faxes performed after or at the given time stamp.',
|
|
query => {
|
|
first => sub {
|
|
my $q = shift;
|
|
my $dt = NGCP::Panel::Utils::DateTime::from_string($q);
|
|
return { 'me.time' => { '>=' => $dt->epoch } };
|
|
},
|
|
second => sub { },
|
|
},
|
|
},
|
|
|
|
{
|
|
param => 'time_to',
|
|
description => 'Filter for faxes performed before or at the given time stamp.',
|
|
query => {
|
|
first => sub {
|
|
my $q = shift;
|
|
my $dt = NGCP::Panel::Utils::DateTime::from_string($q);
|
|
return { 'me.time' => { '<=' => $dt->epoch } };
|
|
},
|
|
second => sub { },
|
|
},
|
|
},
|
|
|
|
{
|
|
param => 'sid',
|
|
description => 'Filter for a fax with the specific session id',
|
|
query => {
|
|
first => sub {
|
|
my $q = shift;
|
|
{ 'me.sid' => $q };
|
|
},
|
|
second => sub { },
|
|
},
|
|
},
|
|
|
|
];
|
|
}
|
|
|
|
use parent qw/Catalyst::Controller NGCP::Panel::Role::API::Faxes/;
|
|
|
|
sub resource_name{
|
|
return 'faxes';
|
|
}
|
|
sub dispatch_path{
|
|
return '/api/faxes/';
|
|
}
|
|
sub relation{
|
|
return 'http://purl.org/sipwise/ngcp-api/#rel-faxes';
|
|
}
|
|
|
|
__PACKAGE__->config(
|
|
action => {
|
|
map { $_ => {
|
|
ACLDetachTo => '/api/root/invalid_user',
|
|
AllowedRole => [qw/admin reseller/],
|
|
Args => 0,
|
|
Does => [qw(ACL CheckTrailingSlash RequireSSL)],
|
|
Method => $_,
|
|
Path => __PACKAGE__->dispatch_path,
|
|
('POST' eq $_) ? (ContentType => ['multipart/form-data']) : (),
|
|
} } @{ __PACKAGE__->allowed_methods },
|
|
},
|
|
);
|
|
|
|
sub gather_default_action_roles {
|
|
my ($self, %args) = @_; my @roles = ();
|
|
push @roles, 'NGCP::Panel::Role::HTTPMethods' if $args{attributes}->{Method};
|
|
return @roles;
|
|
}
|
|
|
|
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);
|
|
for my $item ($items->all) {
|
|
push @embedded, $self->hal_from_item($c, $item);
|
|
push @links, NGCP::Panel::Utils::DataHalLink->new(
|
|
relation => 'ngcp:'.$self->resource_name,
|
|
href => sprintf('/%s%d', $c->request->path, $item->id),
|
|
);
|
|
}
|
|
push @links,
|
|
NGCP::Panel::Utils::DataHalLink->new(
|
|
relation => 'curies',
|
|
href => 'http://purl.org/sipwise/ngcp-api/#rel-{rel}',
|
|
name => 'ngcp',
|
|
templated => true,
|
|
),
|
|
NGCP::Panel::Utils::DataHalLink->new(relation => 'profile', href => 'http://purl.org/sipwise/ngcp-api/'),
|
|
NGCP::Panel::Utils::DataHalLink->new(relation => 'self', href => sprintf('/%s?page=%s&rows=%s', $c->request->path, $page, $rows));
|
|
if(($total_count / $rows) > $page ) {
|
|
push @links, NGCP::Panel::Utils::DataHalLink->new(relation => 'next', href => sprintf('/%s?page=%d&rows=%d', $c->request->path, $page + 1, $rows));
|
|
}
|
|
if($page > 1) {
|
|
push @links, NGCP::Panel::Utils::DataHalLink->new(relation => 'prev', href => sprintf('/%s?page=%d&rows=%d', $c->request->path, $page - 1, $rows));
|
|
}
|
|
|
|
my $hal = NGCP::Panel::Utils::DataHal->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) = @_;
|
|
{
|
|
if(!$c->config->{features}->{faxserver}){
|
|
$c->log->error("faxserver feature is not active.");
|
|
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Faxserver feature is not active.");
|
|
return;
|
|
}
|
|
last unless $self->forbid_link_header($c);
|
|
last unless $self->valid_media_type($c, 'multipart/form-data');
|
|
my $json_utf8 = encode_utf8($c->req->param('json'));
|
|
last unless $self->require_wellformed_json($c, 'application/json', $json_utf8 );
|
|
my $resource = JSON::from_json($json_utf8, { utf8 => 0 });
|
|
$resource->{faxfile} = $self->get_upload($c, 'faxfile');
|
|
$c->log->debug("upload received");
|
|
|
|
my $form = $self->get_form($c);
|
|
last unless $self->validate_form(
|
|
c => $c,
|
|
resource => $resource,
|
|
form => $form,
|
|
exceptions => [qw/subscriber_id/],
|
|
);
|
|
$c->log->debug("form validated");
|
|
my $billing_subscriber = NGCP::Panel::Utils::API::Subscribers::get_active_subscriber($self, $c, $resource->{subscriber_id});
|
|
unless($billing_subscriber) {
|
|
$c->log->error("invalid subscriber id $$resource{subscriber_id} for fax send");
|
|
$self->error($c, HTTP_NOT_FOUND, "Fax subscriber not found.");
|
|
last;
|
|
}
|
|
my $prov_subscriber = $billing_subscriber->provisioning_voip_subscriber;
|
|
last unless $prov_subscriber;
|
|
my $faxpref = $prov_subscriber->voip_fax_preference;
|
|
unless ($faxpref && $faxpref->active){
|
|
$c->log->error("invalid subscriber fax preferences");
|
|
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid subscriber fax preferences");
|
|
last;
|
|
}
|
|
try {
|
|
$c->log->debug("contacting fax server");
|
|
my $output = NGCP::Panel::Utils::Fax::send_fax(
|
|
c => $c,
|
|
subscriber => $billing_subscriber,
|
|
destination => $form->values->{destination},
|
|
upload => $form->values->{faxfile},
|
|
data => $form->values->{data},
|
|
);
|
|
$c->log->debug("faxserver output:\n");
|
|
$c->log->debug($output);
|
|
} catch($e) {
|
|
$c->log->error("failed to send fax: $e");
|
|
$self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Internal Server Error");
|
|
return;
|
|
};
|
|
$c->response->status(HTTP_CREATED);
|
|
$c->response->body(q());
|
|
}
|
|
return;
|
|
}
|
|
|
|
|
|
sub end : Private {
|
|
my ($self, $c) = @_;
|
|
|
|
$self->log_response($c);
|
|
}
|
|
|
|
1;
|
|
|
|
# vim: set tabstop=4 expandtab:
|