MT#17641 Add admins resource to api

Currently I only need to fetch a collection and create a new item
within the collection, no need for update/delete an existing one.
Thus, no AdminsItem.pm yet.

Since we're exposing field names now, rename md5pass to password.

Change-Id: I571a340f89560bc456147b0ec27d3ae737e6dbc3
changes/79/4379/3
Andreas Granig 10 years ago
parent d5592b1e12
commit e0f80027b1

@ -0,0 +1,214 @@
package NGCP::Panel::Controller::API::Admins;
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);
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 admins to log into the system via panel or api.',
);
class_has 'query_params' => (
is => 'ro',
isa => 'ArrayRef',
default => sub {[
{
param => 'reseller_id',
description => 'Filter for admins belonging to a specific reseller',
query => {
first => sub {
my $q = shift;
{ reseller_id => $q };
},
second => sub {},
},
},
{
param => 'login',
description => 'Filter for admins with a specific login (wildcards possible)',
query => {
first => sub {
my $q = shift;
{ login => { like => $q } };
},
second => sub {},
},
},
]},
);
with 'NGCP::Panel::Role::API::Admins';
class_has('resource_name', is => 'ro', default => 'admins');
class_has('dispatch_path', is => 'ro', default => '/api/admins/');
class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-admins');
__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,
} } @{ __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 $resource = $self->get_valid_post_data(
c => $c,
media_type => 'application/json',
);
last unless $resource;
my $form = $self->get_form($c);
my $pass = $resource->{password};
last unless $self->validate_form(
c => $c,
resource => $resource,
form => $form,
);
delete $resource->{password};
if(defined $pass) {
$resource->{md5pass} = $pass;
}
if($c->user->roles eq "admin") {
} elsif($c->user->roles eq "reseller") {
$resource->{reseller_id} = $c->user->reseller_id;
}
my $item;
$item = $c->model('DB')->resultset('admins')->find({
login => $resource->{login},
});
if($item) {
$c->log->error("admin with login '$$resource{login}' already exists");
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Admin with this login already exists");
last;
}
try {
$item = $c->model('DB')->resultset('admins')->create($resource);
} catch($e) {
$c->log->error("failed to create admin: $e");
$self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Failed to create admin.");
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:

@ -108,6 +108,7 @@ sub create :Chained('list_admin') :PathPart('create') :Args(0) {
} else {
$form->values->{reseller_id} = $c->user->reseller_id;
}
$form->values->{md5pass} = delete $form->values->{password};
$c->stash->{admins}->create($form->values);
delete $c->session->{created_objects}->{reseller};
NGCP::Panel::Utils::Message::info(
@ -166,7 +167,7 @@ sub edit :Chained('base') :PathPart('edit') :Args(0) {
} else {
$form = NGCP::Panel::Form::Administrator::Reseller->new(ctx => $c);
}
$form->field('md5pass')->{required} = 0;
$form->field('password')->{required} = 0;
$form->process(
posted => $posted,
@ -193,7 +194,10 @@ sub edit :Chained('base') :PathPart('edit') :Args(0) {
$form->values->{reseller_id} = $form->values->{reseller}{id};
delete $form->values->{reseller};
}
delete $form->values->{md5pass} unless length $form->values->{md5pass};
delete $form->values->{password} unless length $form->values->{password};
if(exists $form->values->{password}) {
$form->values->{md5pass} = delete $form->values->{password};
}
$c->stash->{administrator}->update($form->values);
delete $c->session->{created_objects}->{reseller};
NGCP::Panel::Utils::Message::info(

@ -16,7 +16,7 @@ has_block 'fields' => (
tag => 'div',
class => [qw(modal-body)],
render_list => [qw(
reseller login md5pass is_superuser is_master is_active read_only show_passwords call_data billing_data lawful_intercept
reseller login password is_superuser is_master is_active read_only show_passwords call_data billing_data lawful_intercept
)],
);

@ -11,7 +11,7 @@ sub build_render_list {[qw/submitid fields actions/]}
sub build_form_element_class {[qw(form-horizontal)]}
has_field 'login' => (type => 'Text', required => 1, minlength => 5);
has_field 'md5pass' => (type => 'Password', required => 1, label => 'Password');
has_field 'password' => (type => 'Password', required => 1, label => 'Password');
for (qw(is_active show_passwords call_data billing_data)) {
has_field $_ => (type => 'Boolean', default => 1);
}
@ -23,12 +23,12 @@ has_block 'fields' => (
tag => 'div',
class => [qw(modal-body)],
render_list => [qw(
login md5pass is_master is_active read_only show_passwords call_data billing_data
login password is_master is_active read_only show_passwords call_data billing_data
)],
);
has_block 'actions' => (tag => 'div', class => [qw(modal-footer)], render_list => [qw(save)],);
sub validate_md5pass {
sub validate_password {
my ($self, $field) = @_;
my $c = $self->form->ctx;
return unless $c;

@ -0,0 +1,126 @@
package NGCP::Panel::Role::API::Admins;
use NGCP::Panel::Utils::Generic qw(:all);
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::Utils::DateTime;
use NGCP::Panel::Form::Administrator::Admin;
use NGCP::Panel::Form::Administrator::Reseller;
sub item_rs {
my ($self, $c) = @_;
my $item_rs = $c->model('DB')->resultset('admins');
if($c->user->roles eq "reseller") {
$item_rs = $item_rs->search({
reseller_id => $c->user->reseller_id
});
}
return $item_rs;
}
sub get_form {
my ($self, $c) = @_;
my $form;
if($c->user->roles eq "admin") {
$form = NGCP::Panel::Form::Administrator::Admin->new(ctx => $c);
} else {
$form = NGCP::Panel::Form::Administrator::Reseller->new(ctx => $c);
}
return $form;
}
sub hal_from_item {
my ($self, $c, $item, $form) = @_;
my %resource = $item->get_inflated_columns;
delete $resource{md5pass};
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('%s', $self->dispatch_path)),
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)),
Data::HAL::Link->new(relation => 'ngcp:resellers', href => sprintf("/api/resellers/%d", $item->reseller_id)),
$self->get_journal_relation_link($item->id),
],
relation => 'ngcp:'.$self->resource_name,
);
$form //= $self->get_form($c);
return unless $self->validate_form(
c => $c,
form => $form,
resource => \%resource,
run => 0,
);
$resource{id} = int($item->id);
$hal->resource({%resource});
return $hal;
}
sub item_by_id {
my ($self, $c, $id) = @_;
my $rs = $self->item_rs($c);
return $rs->find($id);
}
sub update_item {
my ($self, $c, $item, $old_resource, $resource, $form) = @_;
$form //= $self->get_form($c);
$resource->{contract_id} //= undef;
my $pass = $resource->{password};
return unless $self->validate_form(
c => $c,
form => $form,
resource => $resource,
);
delete $resource->{password};
if(defined $pass) {
$resource->{md5pass} = $pass;
}
if($c->user->roles eq "reseller" && $resource->{reseller_id} != $c->user->reseller_id) {
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'reseller_id'");
return;
}
if($old_resource->{reseller_id} != $resource->{reseller_id}) {
unless($c->model('DB')->resultset('resellers')->find($resource->{reseller_id})) {
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'reseller_id'");
return;
}
}
if($old_resource->{login} ne $resource->{login}) {
my $rs = $self->item_rs($c);
if($rs->find({ login => $resource->{login} })) {
$self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Invalid 'login', admin with this login already exists");
return;
}
}
$item->update($resource);
return $item;
}
1;
# vim: set tabstop=4 expandtab:
Loading…
Cancel
Save