From da79426c00705fb2475926e12320121006fa61d9 Mon Sep 17 00:00:00 2001 From: Andreas Granig Date: Wed, 12 Feb 2014 16:13:37 +0100 Subject: [PATCH] MT#3933 API: Implement subscriber preferences. While at it, combine preference handling for subscribers, domains and peers into a single role. --- .../Panel/Controller/API/DomainPreferences.pm | 6 +- .../Controller/API/DomainPreferencesItem.pm | 22 +- .../API/SubscriberPreferenceDefs.pm | 130 +++++++++ .../Controller/API/SubscriberPreferences.pm | 131 +++++++++ .../API/SubscriberPreferencesItem.pm | 181 +++++++++++++ .../{DomainPreferences.pm => Preferences.pm} | 252 +++++++++++------- lib/NGCP/Panel/Utils/Preferences.pm | 20 +- 7 files changed, 634 insertions(+), 108 deletions(-) create mode 100644 lib/NGCP/Panel/Controller/API/SubscriberPreferenceDefs.pm create mode 100644 lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm create mode 100644 lib/NGCP/Panel/Controller/API/SubscriberPreferencesItem.pm rename lib/NGCP/Panel/Role/API/{DomainPreferences.pm => Preferences.pm} (70%) diff --git a/lib/NGCP/Panel/Controller/API/DomainPreferences.pm b/lib/NGCP/Panel/Controller/API/DomainPreferences.pm index 3098006664..bfbaf3d67d 100644 --- a/lib/NGCP/Panel/Controller/API/DomainPreferences.pm +++ b/lib/NGCP/Panel/Controller/API/DomainPreferences.pm @@ -24,7 +24,7 @@ class_has 'api_description' => ( ); with 'NGCP::Panel::Role::API'; -with 'NGCP::Panel::Role::API::DomainPreferences'; +with 'NGCP::Panel::Role::API::Preferences'; class_has('resource_name', is => 'ro', default => 'domainpreferences'); class_has('dispatch_path', is => 'ro', default => '/api/domainpreferences/'); @@ -56,7 +56,7 @@ sub GET :Allow { my $page = $c->request->params->{page} // 1; my $rows = $c->request->params->{rows} // 10; { - my $domains = $self->item_rs($c); + my $domains = $self->item_rs($c, "domains"); my $total_count = int($domains->count); $domains = $domains->search(undef, { page => $page, @@ -64,7 +64,7 @@ sub GET :Allow { }); my (@embedded, @links); for my $domain ($domains->search({}, {order_by => {-asc => 'me.id'}})->all) { - push @embedded, $self->hal_from_item($c, $domain); + push @embedded, $self->hal_from_item($c, $domain, "domains"); push @links, Data::HAL::Link->new( relation => 'ngcp:'.$self->resource_name, href => sprintf('%s%d', $self->dispatch_path, $domain->id), diff --git a/lib/NGCP/Panel/Controller/API/DomainPreferencesItem.pm b/lib/NGCP/Panel/Controller/API/DomainPreferencesItem.pm index b6323ff0b7..47665ec107 100644 --- a/lib/NGCP/Panel/Controller/API/DomainPreferencesItem.pm +++ b/lib/NGCP/Panel/Controller/API/DomainPreferencesItem.pm @@ -17,7 +17,7 @@ require Catalyst::ActionRole::HTTPMethods; require Catalyst::ActionRole::RequireSSL; with 'NGCP::Panel::Role::API'; -with 'NGCP::Panel::Role::API::DomainPreferences'; +with 'NGCP::Panel::Role::API::Preferences'; class_has('resource_name', is => 'ro', default => 'domainpreferences'); class_has('dispatch_path', is => 'ro', default => '/api/domainpreferences/'); @@ -48,10 +48,10 @@ sub GET :Allow { my ($self, $c, $id) = @_; { last unless $self->valid_id($c, $id); - my $domain = $self->item_by_id($c, $id); + my $domain = $self->item_by_id($c, $id, "domains"); last unless $self->resource_exists($c, domainpreference => $domain); - my $hal = $self->hal_from_item($c, $domain); + my $hal = $self->hal_from_item($c, $domain, "domains"); my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new( (map { # XXX Data::HAL must be able to generate links with multiple relations @@ -101,15 +101,15 @@ sub PATCH :Allow { ); last unless $json; - my $domain = $self->item_by_id($c, $id); + my $domain = $self->item_by_id($c, $id, "domains"); last unless $self->resource_exists($c, domainpreferences => $domain); - my $old_resource = $self->get_resource($c, $domain); + my $old_resource = $self->get_resource($c, $domain, "domains"); my $resource = $self->apply_patch($c, $old_resource, $json); last unless $resource; # last param is "no replace" to NOT delete existing prefs # for proper PATCH behavior - $domain = $self->update_item($c, $domain, $old_resource, $resource, 0); + $domain = $self->update_item($c, $domain, $old_resource, $resource, 0, "domains"); last unless $domain; $guard->commit; @@ -119,7 +119,7 @@ sub PATCH :Allow { $c->response->header(Preference_Applied => 'return=minimal'); $c->response->body(q()); } else { - my $hal = $self->hal_from_item($c, $domain); + my $hal = $self->hal_from_item($c, $domain, "domains"); my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new( $hal->http_headers, ), $hal->as_json); @@ -138,7 +138,7 @@ sub PUT :Allow { my $preference = $self->require_preference($c); last unless $preference; - my $domain = $self->item_by_id($c, $id); + my $domain = $self->item_by_id($c, $id, "domains"); last unless $self->resource_exists($c, systemcontact => $domain); my $resource = $self->get_valid_put_data( c => $c, @@ -146,11 +146,11 @@ sub PUT :Allow { media_type => 'application/json', ); last unless $resource; - my $old_resource = $self->get_resource($c, $domain); + my $old_resource = $self->get_resource($c, $domain, "domains"); # last param is "replace" to delete all existing prefs # for proper PUT behavior - $domain = $self->update_item($c, $domain, $old_resource, $resource, 1); + $domain = $self->update_item($c, $domain, $old_resource, $resource, 1, "domains"); last unless $domain; $guard->commit; @@ -160,7 +160,7 @@ sub PUT :Allow { $c->response->header(Preference_Applied => 'return=minimal'); $c->response->body(q()); } else { - my $hal = $self->hal_from_item($c, $domain); + my $hal = $self->hal_from_item($c, $domain, "domains"); my $response = HTTP::Response->new(HTTP_OK, undef, HTTP::Headers->new( $hal->http_headers, ), $hal->as_json); diff --git a/lib/NGCP/Panel/Controller/API/SubscriberPreferenceDefs.pm b/lib/NGCP/Panel/Controller/API/SubscriberPreferenceDefs.pm new file mode 100644 index 0000000000..a047ad03e6 --- /dev/null +++ b/lib/NGCP/Panel/Controller/API/SubscriberPreferenceDefs.pm @@ -0,0 +1,130 @@ +package NGCP::Panel::Controller::API::SubscriberPreferenceDefs; +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 JSON::Types qw(); +BEGIN { extends 'Catalyst::Controller::ActionRole'; } +require Catalyst::ActionRole::ACL; +require Catalyst::ActionRole::CheckTrailingSlash; +require Catalyst::ActionRole::HTTPMethods; +require Catalyst::ActionRole::RequireSSL; + +with 'NGCP::Panel::Role::API'; + +class_has('resource_name', is => 'ro', default => 'subscriberpreferencedefs'); +class_has('dispatch_path', is => 'ro', default => '/api/subscriberpreferencedefs/'); +class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-subscriberpreferencedefs'); + +__PACKAGE__->config( + action => { + map { $_ => { + ACLDetachTo => '/api/root/invalid_user', + AllowedRole => '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 @links; + 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', $self->dispatch_path)); + + my $hal = Data::HAL->new( + links => [@links], + ); + + my $preferences = $c->model('DB')->resultset('voip_preferences')->search({ + internal => 0, + usr_pref => 1, + }); + my $resource = {}; + for my $pref($preferences->all) { + my $fields = { $pref->get_inflated_columns }; + # remove internal fields + for my $del(qw/type attribute expose_to_customer internal peer_pref usr_pref dom_pref voip_preference_groups_id id modify_timestamp/) { + delete $fields->{$del}; + } + $fields->{max_occur} = int($fields->{max_occur}); + $fields->{read_only} = JSON::Types::bool($fields->{read_only}); + if($fields->{data_type} eq "enum") { + my @enums = $pref->voip_preferences_enums->search({ + dom_pref => 1, + })->all; + $fields->{enum_values} = []; + foreach my $enum(@enums) { + my $efields = { $enum->get_inflated_columns }; + for my $del(qw/id preference_id usr_pref dom_pref peer_pref/) { + delete $efields->{$del}; + } + $efields->{default_val} = JSON::Types::bool($efields->{default_val}); + push @{ $fields->{enum_values} }, $efields; + } + } + $resource->{$pref->attribute} = $fields; + } + $hal->resource($resource); + + 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; + $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 end : Private { + my ($self, $c) = @_; + + $self->log_response($c); +} + +# vim: set tabstop=4 expandtab: diff --git a/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm b/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm new file mode 100644 index 0000000000..c510e5ad57 --- /dev/null +++ b/lib/NGCP/Panel/Controller/API/SubscriberPreferences.pm @@ -0,0 +1,131 @@ +package NGCP::Panel::Controller::API::SubscriberPreferences; +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); +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 => + 'Specifies certain properties (preferences) for a Subscriber. The full list of properties can be obtained via SubscriberPreferenceDefs.' +); + +with 'NGCP::Panel::Role::API'; +with 'NGCP::Panel::Role::API::Preferences'; + +class_has('resource_name', is => 'ro', default => 'subscriberpreferences'); +class_has('dispatch_path', is => 'ro', default => '/api/subscriberpreferences/'); +class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-subscriberpreferences'); + +__PACKAGE__->config( + action => { + map { $_ => { + ACLDetachTo => '/api/root/invalid_user', + AllowedRole => '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 $subscribers = $self->item_rs($c, "subscribers"); + my $total_count = int($subscribers->count); + $subscribers = $subscribers->search(undef, { + page => $page, + rows => $rows, + }); + my (@embedded, @links); + for my $subscriber ($subscribers->search({}, {order_by => {-asc => 'me.id'}})->all) { + next unless($subscriber->provisioning_voip_subscriber); + push @embedded, $self->hal_from_item($c, $subscriber, "subscribers"); + push @links, Data::HAL::Link->new( + relation => 'ngcp:'.$self->resource_name, + href => sprintf('%s%d', $self->dispatch_path, $subscriber->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', $self->dispatch_path, $page, $rows)); + if(($total_count / $rows) > $page ) { + push @links, Data::HAL::Link->new(relation => 'next', href => sprintf('%s?page=%d&rows=%d', $self->dispatch_path, $page + 1, $rows)); + } + if($page > 1) { + push @links, Data::HAL::Link->new(relation => 'prev', href => sprintf('%s?page=%d&rows=%d', $self->dispatch_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; + $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 end : Private { + my ($self, $c) = @_; + + $self->log_response($c); +} + +# vim: set tabstop=4 expandtab: diff --git a/lib/NGCP/Panel/Controller/API/SubscriberPreferencesItem.pm b/lib/NGCP/Panel/Controller/API/SubscriberPreferencesItem.pm new file mode 100644 index 0000000000..114d9020b2 --- /dev/null +++ b/lib/NGCP/Panel/Controller/API/SubscriberPreferencesItem.pm @@ -0,0 +1,181 @@ +package NGCP::Panel::Controller::API::SubscriberPreferencesItem; +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::ValidateJSON qw(); +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::HTTPMethods; +require Catalyst::ActionRole::RequireSSL; + +with 'NGCP::Panel::Role::API'; +with 'NGCP::Panel::Role::API::Preferences'; + +class_has('resource_name', is => 'ro', default => 'subscriberpreferences'); +class_has('dispatch_path', is => 'ro', default => '/api/subscriberpreferences/'); +class_has('relation', is => 'ro', default => 'http://purl.org/sipwise/ngcp-api/#rel-subscriberpreferences'); + +__PACKAGE__->config( + action => { + map { $_ => { + ACLDetachTo => '/api/root/invalid_user', + AllowedRole => 'admin', + 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 $subscriber = $self->item_by_id($c, $id, "subscribers"); + last unless $self->resource_exists($c, subscriberpreference => $subscriber); + + my $hal = $self->hal_from_item($c, $subscriber, "subscribers"); + + 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; + $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', + ops => [qw/add replace remove copy/], + ); + last unless $json; + + my $subscriber = $self->item_by_id($c, $id, "subscribers"); + last unless $self->resource_exists($c, subscriberpreferences => $subscriber); + my $old_resource = $self->get_resource($c, $subscriber, "subscribers"); + my $resource = $self->apply_patch($c, $old_resource, $json); + last unless $resource; + + # last param is "no replace" to NOT delete existing prefs + # for proper PATCH behavior + $subscriber = $self->update_item($c, $subscriber, $old_resource, $resource, 0, "subscribers"); + last unless $subscriber; + + $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, $subscriber, "subscribers"); + 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 $subscriber = $self->item_by_id($c, $id, "subscribers"); + last unless $self->resource_exists($c, systemcontact => $subscriber); + my $resource = $self->get_valid_put_data( + c => $c, + id => $id, + media_type => 'application/json', + ); + last unless $resource; + my $old_resource = $self->get_resource($c, $subscriber, "subscribers"); + + # last param is "replace" to delete all existing prefs + # for proper PUT behavior + $subscriber = $self->update_item($c, $subscriber, $old_resource, $resource, 1, "subscribers"); + last unless $subscriber; + + $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, $subscriber, "subscribers"); + 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 end : Private { + my ($self, $c) = @_; + + $self->log_response($c); +} + +# vim: set tabstop=4 expandtab: diff --git a/lib/NGCP/Panel/Role/API/DomainPreferences.pm b/lib/NGCP/Panel/Role/API/Preferences.pm similarity index 70% rename from lib/NGCP/Panel/Role/API/DomainPreferences.pm rename to lib/NGCP/Panel/Role/API/Preferences.pm index 782ce3c220..6f7b8b48ca 100644 --- a/lib/NGCP/Panel/Role/API/DomainPreferences.pm +++ b/lib/NGCP/Panel/Role/API/Preferences.pm @@ -1,4 +1,4 @@ -package NGCP::Panel::Role::API::DomainPreferences; +package NGCP::Panel::Role::API::Preferences; use Moose::Role; use Sipwise::Base; @@ -17,7 +17,7 @@ sub get_form { } sub hal_from_item { - my ($self, $c, $item) = @_; + my ($self, $c, $item, $type) = @_; my $hal = Data::HAL->new( links => [ @@ -30,20 +30,30 @@ sub hal_from_item { 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:domains', href => sprintf("/api/domains/%d", $item->id)), + Data::HAL::Link->new(relation => "ngcp:$type", href => sprintf("/api/%s/%d", $type, $item->id)), ], relation => 'ngcp:'.$self->resource_name, ); - my $resource = $self->get_resource($c, $item); + my $resource = $self->get_resource($c, $item, $type); + use Data::Printer; p $resource; $hal->resource($resource); return $hal; } sub get_resource { - my ($self, $c, $item) = @_; - - my $prefs = $item->provisioning_voip_domain->voip_dom_preferences->search({ + my ($self, $c, $item, $type) = @_; + + my $prefs; + if($type eq "subscribers") { + $prefs = $item->provisioning_voip_subscriber->voip_usr_preferences; + } elsif($type eq "domains") { + $prefs = $item->provisioning_voip_domain->voip_dom_preferences; + } elsif($type eq "peerings") { + $prefs = $item->voip_peer_preferences; + return; + } + $prefs = $prefs->search({ }, { join => 'attribute', order_by => { '-asc' => 'id' }, @@ -123,8 +133,6 @@ sub get_resource { } - - given($pref->attribute->data_type) { when("int") { $value = int($pref->value) if($pref->value->is_int) } when("boolean") { $value = JSON::Types::bool($pref->value) if(defined $pref->value) } @@ -139,49 +147,145 @@ sub get_resource { } } - $resource->{domain_id} = int($item->id); - $resource->{domainpreferences_id} = int($item->id); + + if($type eq "domains") { + $resource->{domain_id} = int($item->id); + $resource->{id} = int($item->id); + } elsif($type eq "subscribers") { + $resource->{subscriber_id} = int($item->id); + $resource->{id} = int($item->id); + } elsif($type eq "peerings") { + $resource->{peering_id} = int($item->id); + $resource->{id} = int($item->id); + } return $resource; } sub item_rs { - my ($self, $c) = @_; - - # we actually return the domain rs here, as we can easily - # go to dom_preferences from there + my ($self, $c, $type) = @_; my $item_rs; - if($c->user->roles eq "admin") { - $item_rs = $c->model('DB')->resultset('domains'); - } elsif($c->user->roles eq "reseller") { - $item_rs = $c->model('DB')->resultset('admins')->find( - { id => $c->user->id, } ) - ->reseller - ->domain_resellers - ->search_related('domain'); + + if($type eq "domains") { + # we actually return the domain rs here, as we can easily + # go to dom_preferences from there + if($c->user->roles eq "admin") { + $item_rs = $c->model('DB')->resultset('domains'); + } elsif($c->user->roles eq "reseller") { + $item_rs = $c->model('DB')->resultset('admins')->find( + { id => $c->user->id, } ) + ->reseller + ->domain_resellers + ->search_related('domain'); + } + } elsif($type eq "subscribers") { + if($c->user->roles eq "admin") { + $item_rs = $c->model('DB')->resultset('voip_subscribers'); + } elsif($c->user->roles eq "reseller") { + $item_rs = $c->model('DB')->resultset('voip_subscribers')->search({ + 'contact.reseller_id' => $c->user->reseller_id, + 'status' => { '!=' => 'terminated' }, + }, { + join => { 'contract' => 'contact' }, + }); + } + } elsif($type eq "peerings") { + if($c->user->roles eq "admin") { + $item_rs = $c->model('DB')->resultset('voip_peer_hosts'); + } else { + return; + } } return $item_rs; } sub item_by_id { - my ($self, $c, $id) = @_; + my ($self, $c, $id, $type) = @_; - my $item_rs = $self->item_rs($c); + my $item_rs = $self->item_rs($c, $type); return $item_rs->find($id); } +sub get_preference_rs { + my ($self, $c, $type, $elem, $attr) = @_; + my $rs; + if($type eq "domains") { + $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( + c => $c, + attribute => $attr, + prov_domain => $elem, + ); + } elsif($type eq "subscribers") { + $rs = NGCP::Panel::Utils::Preferences::get_usr_preference_rs( + c => $c, + attribute => $attr, + prov_subscriber => $elem, + ); + } elsif($type eq "peerings") { + $rs = NGCP::Panel::Utils::Preferences::get_peer_preference_rs( + c => $c, + attribute => $attr, + peer_host => $elem, + ); + } + return $rs; +} + sub update_item { - my ($self, $c, $item, $old_resource, $resource, $replace) = @_; + my ($self, $c, $item, $old_resource, $resource, $replace, $type) = @_; delete $resource->{id}; - delete $resource->{domain_id}; - delete $resource->{domainpreferences_id}; + my $accessor; + my $elem; + my $pref_type; + my $reseller_id; + my $full_rs; + + print ">>>>>>>>>> before cleanup\n"; + use Data::Printer; p $resource; + + if($type eq "domains") { + delete $resource->{domain_id}; + delete $resource->{domainpreferences_id}; + delete $old_resource->{domain_id}; + delete $old_resource->{domainpreferences_id}; + $accessor = $item->domain; + $elem = $item->provisioning_voip_domain; + $full_rs = $elem->voip_dom_preferences; + $pref_type = 'dom_pref'; + $reseller_id = $item->domain_resellers->first->reseller_id; + } elsif($type eq "subscribers") { + delete $resource->{subscriber_id}; + delete $resource->{subscriberpreferences_id}; + delete $old_resource->{subscriber_id}; + delete $old_resource->{subscriberpreferences_id}; + $accessor = $item->username . '@' . $item->domain->domain; + $elem = $item->provisioning_voip_subscriber; + $full_rs = $elem->voip_usr_preferences; + $pref_type = 'usr_pref'; + $reseller_id = $item->contract->contact->reseller_id; + } elsif($type eq "peerings") { + delete $resource->{peer_id}; + delete $resource->{peerpreferences_id}; + delete $old_resource->{peer_id}; + delete $old_resource->{peerpreferences_id}; + $accessor = $item->name; + $elem = $item; + $full_rs = $elem->voip_peer_preferences; + $pref_type = 'peer_pref'; + $reseller_id = 1; + } else { + return; + } + + print ">>>>>>>>>> after cleanup\n"; + use Data::Printer; p $resource; if($replace) { # in case of PUT, we remove all old entries try { - $item->provisioning_voip_domain->voip_dom_preferences->delete_all; + $full_rs->delete_all; } catch($e) { - $c->log->error("failed to clear preferences for domain '".$item->domain."': $e"); + $c->log->error("failed to clear preferences for '$accessor': $e"); $self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Internal Server Error."); return; }; @@ -192,17 +296,14 @@ sub update_item { given($k) { # no special treatment for *_sound_set deletion, as id is stored in right name + $c->log->debug("+++++++++++++ check $k for deletion"); when(/^rewrite_rule_set$/) { $c->log->debug("+++++++++++++ check $k for deletion"); unless(exists $resource->{$k}) { $c->log->debug("+++++++++++++ $k marked for deletion"); foreach my $p(qw/caller_in_dpid callee_in_dpid caller_out_dpid callee_out_dpid/) { - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => 'rewrite_' . $p, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, 'rewrite_' . $p); next unless $rs; # unknown resource, just ignore $rs->delete_all; } @@ -210,22 +311,14 @@ sub update_item { } when(/^(adm_)?ncos$/) { unless(exists $resource->{$k}) { - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $k . '_id', - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $k . '_id'); next unless $rs; # unknown resource, just ignore $rs->delete_all; } } when(/^(man_)?allowed_ips$/) { unless(exists $resource->{$k}) { - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $k . '_grp', - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $k . '_grp'); next unless $rs; # unknown resource, just ignore if($rs->first) { $c->model('DB')->resultset('voip_allowed_ip_groups')->search({ @@ -237,22 +330,15 @@ sub update_item { } default { unless(exists $resource->{$k}) { - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $k, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $k); next unless $rs; # unknown resource, just ignore $rs->delete_all; } } } } - - # TODO: also go over special cases (rewrite_rule_set) and delete them - # if not available in $resource } catch($e) { - $c->log->error("failed to clear preference for domain '".$item->domain."': $e"); + $c->log->error("failed to clear preference for '$accessor': $e"); $self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Internal Server Error."); return; }; @@ -260,13 +346,9 @@ sub update_item { foreach my $pref(keys %{ $resource }) { next unless(defined $resource->{$pref}); - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $pref, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $pref); unless($rs) { - $c->log->debug("removing unknown dom_preference '$pref' from update"); + $c->log->debug("removing unknown preference '$pref' from update"); next; } $rs = $rs->search(undef, { @@ -275,7 +357,7 @@ sub update_item { # TODO: can't we get this via $rs->search_related or $rs->related_resultset? my $meta = $c->model('DB')->resultset('voip_preferences')->find({ - attribute => $pref, 'dom_pref' => 1, + attribute => $pref, $pref_type => 1, }); unless($meta) { $c->log->error("failed to get voip_preference entry for '$pref'"); @@ -301,21 +383,17 @@ sub update_item { my $rwr_set = $c->model('DB')->resultset('voip_rewrite_rule_sets')->find({ name => $resource->{$pref}, - reseller_id => $item->domain_resellers->first->reseller_id, + reseller_id => $reseller_id, }); unless($rwr_set) { - $c->log->error("no rewrite rule set '".$resource->{$pref}."' for reseller id ".$item->domain_resellers->first->reseller_id." found"); + $c->log->error("no rewrite rule set '".$resource->{$pref}."' for reseller id $reseller_id found"); $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Unknown rewrite_rule_set '".$resource->{$pref}."'"); return; } foreach my $k(qw/caller_in_dpid callee_in_dpid caller_out_dpid callee_out_dpid/) { - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => 'rewrite_'.$k, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, 'rewrite_'.$k); if($rs->first) { $rs->first->update({ value => $rwr_set->$k }); } else { @@ -328,18 +406,14 @@ sub update_item { my $pref_name = $pref . "_id"; my $ncos = $c->model('DB')->resultset('ncos_levels')->find({ level => $resource->{$pref}, - reseller_id => $item->domain_resellers->first->reseller_id, + reseller_id => $reseller_id, }); unless($ncos) { - $c->log->error("no ncos level '".$resource->{$pref}."' for reseller id ".$item->domain_resellers->first->reseller_id." found"); + $c->log->error("no ncos level '".$resource->{$pref}."' for reseller id $reseller_id found"); $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Unknown ncos_level '".$resource->{$pref}."'"); return; } - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $pref_name, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $pref_name); if($rs->first) { $rs->first->update({ value => $ncos->id }); } else { @@ -351,18 +425,14 @@ sub update_item { # TODO: not applicable for domains, but for subs, check for contract_id! my $set = $c->model('DB')->resultset('voip_sound_sets')->find({ name => $resource->{$pref}, - reseller_id => $item->domain_resellers->first->reseller_id, + reseller_id => $reseller_id, }); unless($set) { - $c->log->error("no $pref '".$resource->{$pref}."' for reseller id ".$item->domain_resellers->first->reseller_id." found"); + $c->log->error("no $pref '".$resource->{$pref}."' for reseller id $reseller_id found"); $self->error($c, HTTP_UNPROCESSABLE_ENTITY, "Unknown $pref'".$resource->{$pref}."'"); return; } - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $pref, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $pref); if($rs->first) { $rs->first->update({ value => $set->id }); } else { @@ -374,11 +444,7 @@ sub update_item { my $pref_name = $pref . "_grp"; my $aig_rs; my $seq; - my $rs = NGCP::Panel::Utils::Preferences::get_dom_preference_rs( - c => $c, - attribute => $pref_name, - prov_domain => $item->provisioning_voip_domain, - ); + my $rs = $self->get_preference_rs($c, $type, $elem, $pref_name); if($rs->first) { $aig_rs = $c->model('DB')->resultset('voip_allowed_ip_groups')->search({ group_id => $rs->first->value @@ -415,20 +481,20 @@ sub update_item { if($meta->max_occur != 1) { $rs->delete_all; foreach my $v(@{ $resource->{$pref} }) { - return unless $self->check_pref_value($c, $meta, $v); + return unless $self->check_pref_value($c, $meta, $v, $pref_type); $rs->create({ value => $v }); } } elsif($rs->first) { - return unless $self->check_pref_value($c, $meta, $resource->{$pref}); + return unless $self->check_pref_value($c, $meta, $resource->{$pref}, $pref_type); $rs->first->update({ value => $resource->{$pref} }); } else { - return unless $self->check_pref_value($c, $meta, $resource->{$pref}); + return unless $self->check_pref_value($c, $meta, $resource->{$pref}, $pref_type); $rs->create({ value => $resource->{$pref} }); } } } } catch($e) { - $c->log->error("failed to update preference for domain '".$item->domain."': $e"); + $c->log->error("failed to update preference for '$accessor': $e"); $self->error($c, HTTP_INTERNAL_SERVER_ERROR, "Internal Server Error."); return; } @@ -438,7 +504,7 @@ sub update_item { } sub check_pref_value { - my ($self, $c, $meta, $value) = @_; + my ($self, $c, $meta, $value, $pref_type) = @_; my $err; my $vtype = ref $value; @@ -461,7 +527,7 @@ sub check_pref_value { if($meta->data_type eq "enum") { my $enum = $c->model('DB')->resultset('voip_preferences_enum')->find({ preference_id => $meta->id, - dom_pref => 1, + $pref_type => 1, value => $value, }); unless($enum) { diff --git a/lib/NGCP/Panel/Utils/Preferences.pm b/lib/NGCP/Panel/Utils/Preferences.pm index dc6fea6416..edbd612088 100644 --- a/lib/NGCP/Panel/Utils/Preferences.pm +++ b/lib/NGCP/Panel/Utils/Preferences.pm @@ -434,7 +434,9 @@ sub get_usr_preference_rs { my $pref_rs = $c->model('DB')->resultset('voip_preferences')->find({ attribute => $attribute, 'usr_pref' => 1, - })->voip_usr_preferences; + }); + return unless($pref_rs); + $pref_rs = $pref_rs->voip_usr_preferences; if($prov_subscriber) { $pref_rs = $pref_rs->search({ subscriber_id => $prov_subscriber->id, @@ -459,6 +461,22 @@ sub get_dom_preference_rs { }); } +sub get_peer_preference_rs { + my %params = @_; + + my $c = $params{c}; + my $attribute = $params{attribute}; + my $host = $params{peer_host}; + + my $preference = $c->model('DB')->resultset('voip_preferences')->find({ + attribute => $attribute, 'peer_pref' => 1, + }); + return unless($preference); + return $preference->voip_peer_preferences->search_rs({ + peer_host_id => $host->id, + }); +} + sub get_peer_auth_params { my ($c, $prov_subscriber, $prefs) = @_;