| 1 | package WWW::Suffit::Plugin::API::Admin; | ||
| 2 | use strict; | ||
| 3 | use utf8; | ||
| 4 | |||
| 5 | =encoding utf8 | ||
| 6 | |||
| 7 | =head1 NAME | ||
| 8 | |||
| 9 | WWW::Suffit::Plugin::API::Admin - The Admin API Suffit plugin | ||
| 10 | |||
| 11 | =head1 SYNOPSIS | ||
| 12 | |||
| 13 | use Mojo::Base 'WWW::Suffit::Server'; | ||
| 14 | |||
| 15 | sub startup { | ||
| 16 | my $self = shift->SUPER::startup(); | ||
| 17 | $self->plugin('API::Admin', { | ||
| 18 | prefix_path => "/admin", | ||
| 19 | prefix_name => "admin", | ||
| 20 | }); | ||
| 21 | |||
| 22 | # . . . | ||
| 23 | } | ||
| 24 | |||
| 25 | sub startup { | ||
| 26 | my $self = shift->SUPER::startup( | ||
| 27 | init_admin_routes => 'on', | ||
| 28 | admin_routes_opts => { | ||
| 29 | prefix_path => "/admin", | ||
| 30 | prefix_name => "admin", | ||
| 31 | } | ||
| 32 | ); | ||
| 33 | |||
| 34 | # . . . | ||
| 35 | } | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | The Admin API Suffit plugin | ||
| 40 | |||
| 41 | This plugin requires L<WWW::Suffit::Plugin::API> plugin | ||
| 42 | |||
| 43 | =head1 OPTIONS | ||
| 44 | |||
| 45 | This plugin supports the following options | ||
| 46 | |||
| 47 | =head2 prefix_name | ||
| 48 | |||
| 49 | prefix_name => "admin" | ||
| 50 | |||
| 51 | This option defines prefix of admin api route name | ||
| 52 | |||
| 53 | Default: 'admin' | ||
| 54 | |||
| 55 | =head2 prefix_path | ||
| 56 | |||
| 57 | prefix_path => "/admin" | ||
| 58 | |||
| 59 | This option defines prefix of admin api route | ||
| 60 | |||
| 61 | Default: '/admin' | ||
| 62 | |||
| 63 | =head1 METHODS | ||
| 64 | |||
| 65 | This plugin inherits all methods from L<Mojolicious::Plugin> and implements the following new ones | ||
| 66 | |||
| 67 | =head2 register | ||
| 68 | |||
| 69 | This method register the plugin and helpers in L<Mojolicious> application | ||
| 70 | |||
| 71 | $plugin->register(Mojolicious->new, { | ||
| 72 | prefix_path => "/admin", | ||
| 73 | prefix_name => "admin", | ||
| 74 | }); | ||
| 75 | |||
| 76 | Register plugin in L<Mojolicious> application | ||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | L<Mojolicious>, L<WWW::Suffit::Server>, L<WWW::Suffit::AuthDB>, L<WWW::Suffit::Plugin::API> | ||
| 81 | |||
| 82 | =head1 AUTHOR | ||
| 83 | |||
| 84 | Serż Minus (Sergey Lepenkov) L<https://www.serzik.com> E<lt>abalama@cpan.orgE<gt> | ||
| 85 | |||
| 86 | =head1 COPYRIGHT | ||
| 87 | |||
| 88 | Copyright (C) 1998-2026 D&D Corporation | ||
| 89 | |||
| 90 | =head1 LICENSE | ||
| 91 | |||
| 92 | This program is distributed under the terms of the Artistic License Version 2.0 | ||
| 93 | |||
| 94 | See the C<LICENSE> file or L<https://opensource.org/license/artistic-2-0> for details | ||
| 95 | |||
| 96 | =cut | ||
| 97 | |||
| 98 | use Mojo::Base 'Mojolicious::Plugin'; | ||
| 99 | |||
| 100 | use WWW::Suffit::Const qw/ USERNAME_REGEXP /; | ||
| 101 | |||
| 102 | sub register { | ||
| 103 | my ($plugin, $app, $opts) = @_; # $self = $plugin | ||
| 104 | $app->raise("Can't initialize the API::Admin plugin: the API plugin required") | ||
| 105 | unless exists $app->renderer->helpers->{'api_prefix_name'}; | ||
| 106 | $opts //= {}; | ||
| 107 | my $pathpfx = $opts->{prefix_path} || '/admin'; | ||
| 108 | my $namepfx = $opts->{prefix_name} || 'admin'; | ||
| 109 | $namepfx =~ s/[^a-z0-9_\-]//g; | ||
| 110 | $namepfx ||= 'admin'; | ||
| 111 | $namepfx = sprintf("%s-%s", $app->api_prefix_name, $namepfx) if $app->api_prefix_name; | ||
| 112 | |||
| 113 | # Get base API route with token/cookie authorization | ||
| 114 | my $r = $app->routes; | ||
| 115 | my $api = $r->lookup($app->api_prefix_name // 'api'); | ||
| 116 | $r->{reverse} = undef; # Force flush Mojolicious routes cache | ||
| 117 | |||
| 118 | # Admin routes | ||
| 119 | my $admin = $api->under($pathpfx)->name($namepfx); # /api/admin | ||
| 120 | |||
| 121 | # API::Admin *2 | ||
| 122 | $admin->get('/settings')->to('API::Admin#settings')->name(sprintf('%s-settings', $namepfx)); | ||
| 123 | $admin->post('/settings')->to('API::Admin#settings')->name(sprintf('%s-settings-save', $namepfx)); | ||
| 124 | |||
| 125 | # Users *8 | ||
| 126 | $admin->get('/user')->to('API::Admin#user_get')->name(sprintf('%s-user-all', $namepfx)); | ||
| 127 | $admin->get('/user/:username' => [username => USERNAME_REGEXP])->to('API::Admin#user_get')->name(sprintf('%s-user-get', $namepfx)); | ||
| 128 | $admin->put('/user/:username' => [username => USERNAME_REGEXP])->to('API::Admin#user_set')->name(sprintf('%s-user-set', $namepfx)); | ||
| 129 | $admin->post('/user')->to('API::Admin#user_set')->name(sprintf('%s-user-add', $namepfx)); | ||
| 130 | $admin->delete('/user/:username' => [username => USERNAME_REGEXP])->to('API::Admin#user_del')->name(sprintf('%s-user-del', $namepfx)); | ||
| 131 | $admin->put('/user/:username/passwd' => [username => USERNAME_REGEXP])->to('API::Admin#user_passwd')->name(sprintf('%s-user-passwd', $namepfx)); | ||
| 132 | $admin->get('/search/user')->to('API::Admin#user_search')->name(sprintf('%s-user-search', $namepfx)); | ||
| 133 | $admin->get('/user/:username/groups' => [username => USERNAME_REGEXP])->to('API::Admin#user_groups')->name(sprintf('%s-user-groups', $namepfx)); | ||
| 134 | |||
| 135 | # Groups *7 | ||
| 136 | $admin->get('/group')->to('API::Admin#group_get')->name(sprintf('%s-group-all', $namepfx)); | ||
| 137 | $admin->get('/group/:groupname' => [groupname => USERNAME_REGEXP])->to('API::Admin#group_get')->name(sprintf('%s-group-get', $namepfx)); | ||
| 138 | $admin->put('/group/:groupname' => [groupname => USERNAME_REGEXP])->to('API::Admin#group_set')->name(sprintf('%s-group-set', $namepfx)); | ||
| 139 | $admin->post('/group')->to('API::Admin#group_set')->name(sprintf('%s-group-add', $namepfx)); | ||
| 140 | $admin->delete('/group/:groupname' => [groupname => USERNAME_REGEXP])->to('API::Admin#group_del')->name(sprintf('%s-group-del', $namepfx)); | ||
| 141 | $admin->get('/group/:groupname/members' => [groupname => USERNAME_REGEXP])->to('API::Admin#group_members')->name(sprintf('%s-group-members', $namepfx)); | ||
| 142 | $admin->post('/group/:groupname/enroll' => [groupname => USERNAME_REGEXP])->to('API::Admin#group_enroll')->name(sprintf('%s-group-enroll', $namepfx)); | ||
| 143 | |||
| 144 | # Realms *6 | ||
| 145 | $admin->get('/realm')->to('API::Admin#realm_get')->name(sprintf('%s-realm-all', $namepfx)); | ||
| 146 | $admin->get('/realm/:realmname' => [realmname => USERNAME_REGEXP])->to('API::Admin#realm_get')->name(sprintf('%s-realm-get', $namepfx)); | ||
| 147 | $admin->put('/realm/:realmname' => [realmname => USERNAME_REGEXP])->to('API::Admin#realm_set')->name(sprintf('%s-realm-set', $namepfx)); | ||
| 148 | $admin->post('/realm')->to('API::Admin#realm_set')->name(sprintf('%s-realm-add', $namepfx)); | ||
| 149 | $admin->delete('/realm/:realmname' => [realmname => USERNAME_REGEXP])->to('API::Admin#realm_del')->name(sprintf('%s-realm-del', $namepfx)); | ||
| 150 | $admin->get('/requirement')->to('API::Admin#requirement_get')->name(sprintf('%s-requirement-get', $namepfx)); | ||
| 151 | |||
| 152 | # Routes *8 | ||
| 153 | $admin->get('/route')->to('API::Admin#route_get')->name(sprintf('%s-route-all', $namepfx)); | ||
| 154 | $admin->get('/route/:routename' => [routename => USERNAME_REGEXP])->to('API::Admin#route_get')->name(sprintf('%s-route-get', $namepfx)); | ||
| 155 | $admin->put('/route/:routename' => [routename => USERNAME_REGEXP])->to('API::Admin#route_set')->name(sprintf('%s-route-set', $namepfx)); | ||
| 156 | $admin->post('/route')->to('API::Admin#route_set')->name(sprintf('%s-route-add', $namepfx)); | ||
| 157 | $admin->delete('/route/:routename' => [routename => USERNAME_REGEXP])->to('API::Admin#route_del')->name(sprintf('%s-route-del', $namepfx)); | ||
| 158 | $admin->get('/search/route')->to('API::Admin#route_search')->name(sprintf('%s-route-search', $namepfx)); | ||
| 159 | $admin->get('/sysroute')->to('API::Admin#route_sysget')->name(sprintf('%s-route-sysget', $namepfx)); | ||
| 160 | $admin->post('/sysroute')->to('API::Admin#route_sysadd')->name(sprintf('%s-route-sysadd', $namepfx)); | ||
| 161 | } | ||
| 162 | |||
| 163 | 1; | ||
| 164 | |||
| 165 | __END__ |