Bugzilla – Attachment 140202 Details for
Bug 31389
Calculate user permissions in separate function
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 31389: Calculate user permissions in separate function
Bug-31389-Calculate-user-permissions-in-separate-f.patch (text/plain), 18.65 KB, created by
Joonas Kylmälä
on 2022-09-04 12:24:04 UTC
(
hide
)
Description:
Bug 31389: Calculate user permissions in separate function
Filename:
MIME Type:
Creator:
Joonas Kylmälä
Created:
2022-09-04 12:24:04 UTC
Size:
18.65 KB
patch
obsolete
>From 89497f50b46ceaf309ea59806c3959b69d819a1f Mon Sep 17 00:00:00 2001 >From: David Cook <dcook@prosentient.com.au> >Date: Thu, 18 Aug 2022 03:26:20 +0000 >Subject: [PATCH] Bug 31389: Calculate user permissions in separate function >MIME-Version: 1.0 >Content-Type: text/plain; charset=UTF-8 >Content-Transfer-Encoding: 8bit > >This patch refactors the setting of user permissions for templates into >a new function, which can be easily unit tested and reduces the amount >of code in C4::Auth::get_template_and_user(). It also aids in the >re-usability of permission checking code. > >Test plan: >0) Apply patch and koha-plack --restart kohadev >1) prove t/Koha/Auth/Permissions.t >2) As koha superlibrarian, go to >http://localhost:8081/cgi-bin/koha/tools/tools-home.pl >3) Go to http://localhost:8081/cgi-bin/koha/members/members-home.pl >4) Create new test user with "Staff access..." and "Remaining circulation permissions" >5) Logout of koha superlibrarian >6) Login as test user >7) Note you can only see a limited view of the staff interface >(i.e. no administration, no tools, no reports, etc.) > >Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> > >Signed-off-by: Joonas Kylmälä <joonas.kylmala@iki.fi> >--- > C4/Auth.pm | 62 +-------- > Koha/Auth/Permissions.pm | 69 ++++++++++ > t/Koha/Auth/Permissions.t | 269 ++++++++++++++++++++++++++++++++++++++ > 3 files changed, 342 insertions(+), 58 deletions(-) > create mode 100644 Koha/Auth/Permissions.pm > create mode 100755 t/Koha/Auth/Permissions.t > >diff --git a/C4/Auth.pm b/C4/Auth.pm >index a2b1b84aea..a83748461a 100644 >--- a/C4/Auth.pm >+++ b/C4/Auth.pm >@@ -50,6 +50,7 @@ use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_sh > use Net::CIDR; > use C4::Log qw( logaction ); > use Koha::CookieManager; >+use Koha::Auth::Permissions; > > # use utf8; > >@@ -321,67 +322,12 @@ sub get_template_and_user { > ); > } > >- my $all_perms = get_all_subpermissions(); >- >- my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow >- editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports); >- > # We are going to use the $flags returned by checkauth > # to create the template's parameters that will indicate > # which menus the user can access. >- if ( $flags && $flags->{superlibrarian} == 1 ) { >- $template->param( CAN_user_circulate => 1 ); >- $template->param( CAN_user_catalogue => 1 ); >- $template->param( CAN_user_parameters => 1 ); >- $template->param( CAN_user_borrowers => 1 ); >- $template->param( CAN_user_permissions => 1 ); >- $template->param( CAN_user_reserveforothers => 1 ); >- $template->param( CAN_user_editcatalogue => 1 ); >- $template->param( CAN_user_updatecharges => 1 ); >- $template->param( CAN_user_acquisition => 1 ); >- $template->param( CAN_user_suggestions => 1 ); >- $template->param( CAN_user_tools => 1 ); >- $template->param( CAN_user_editauthorities => 1 ); >- $template->param( CAN_user_serials => 1 ); >- $template->param( CAN_user_reports => 1 ); >- $template->param( CAN_user_staffaccess => 1 ); >- $template->param( CAN_user_coursereserves => 1 ); >- $template->param( CAN_user_plugins => 1 ); >- $template->param( CAN_user_lists => 1 ); >- $template->param( CAN_user_clubs => 1 ); >- $template->param( CAN_user_ill => 1 ); >- $template->param( CAN_user_stockrotation => 1 ); >- $template->param( CAN_user_cash_management => 1 ); >- $template->param( CAN_user_problem_reports => 1 ); >- $template->param( CAN_user_recalls => 1 ); >- >- foreach my $module ( keys %$all_perms ) { >- foreach my $subperm ( keys %{ $all_perms->{$module} } ) { >- $template->param( "CAN_user_${module}_${subperm}" => 1 ); >- } >- } >- } >- >- if ($flags) { >- foreach my $module ( keys %$all_perms ) { >- if ( defined($flags->{$module}) && $flags->{$module} == 1 ) { >- foreach my $subperm ( keys %{ $all_perms->{$module} } ) { >- $template->param( "CAN_user_${module}_${subperm}" => 1 ); >- } >- } elsif ( ref( $flags->{$module} ) ) { >- foreach my $subperm ( keys %{ $flags->{$module} } ) { >- $template->param( "CAN_user_${module}_${subperm}" => 1 ); >- } >- } >- } >- } >- >- if ($flags) { >- foreach my $module ( keys %$flags ) { >- if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) { >- $template->param( "CAN_user_$module" => 1 ); >- } >- } >+ my $authz = Koha::Auth::Permissions->get_authz_from_flags({ flags => $flags }); >+ foreach my $permission ( keys %{ $authz } ){ >+ $template->param( $permission => $authz->{$permission} ); > } > > # Logged-in opac search history >diff --git a/Koha/Auth/Permissions.pm b/Koha/Auth/Permissions.pm >new file mode 100644 >index 0000000000..df9c1a291a >--- /dev/null >+++ b/Koha/Auth/Permissions.pm >@@ -0,0 +1,69 @@ >+package Koha::Auth::Permissions; >+ >+# This file is part of Koha. >+# >+# Koha is free software; you can redistribute it and/or modify it >+# under the terms of the GNU General Public License as published by >+# the Free Software Foundation; either version 3 of the License, or >+# (at your option) any later version. >+# >+# Koha is distributed in the hope that it will be useful, but >+# WITHOUT ANY WARRANTY; without even the implied warranty of >+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the >+# GNU General Public License for more details. >+# >+# You should have received a copy of the GNU General Public License >+# along with Koha; if not, see <http://www.gnu.org/licenses>. >+ >+use Modern::Perl; >+ >+use C4::Auth qw//; >+ >+=head1 NAME >+ >+Koha::Auth::Permissions - Class for setting up CAN_user_* permissions >+ >+=head1 SYNOPSIS >+ >+=head2 METHODS >+ >+=head3 get_authz_from_flags >+ >+=cut >+ >+sub get_authz_from_flags { >+ my ($class,$args) = @_; >+ my $flags = $args->{flags}; >+ my $authz; >+ my $all_perms = C4::Auth::get_all_subpermissions(); >+ if ($flags && $all_perms){ >+ foreach my $module ( keys %$all_perms ) { >+ if ( >+ ( $flags->{superlibrarian} == 1 ) || >+ ( defined($flags->{$module}) && $flags->{$module} == 1 ) >+ ) { >+ foreach my $subperm ( keys %{ $all_perms->{$module} } ) { >+ $authz->{ "CAN_user_${module}_${subperm}" } = 1; >+ } >+ } >+ elsif ( ref( $flags->{$module} ) ){ >+ foreach my $subperm ( keys %{ $flags->{$module} } ) { >+ $authz->{ "CAN_user_${module}_${subperm}" } = 1; >+ } >+ } >+ } >+ foreach my $module ( keys %$flags ) { >+ if ( >+ ( $flags->{superlibrarian} == 1 ) || >+ ( $flags->{$module} == 1 ) || >+ ( ref( $flags->{$module} ) ) >+ ) { >+ $authz->{ "CAN_user_$module" } = 1; >+ } >+ } >+ } >+ return $authz; >+} >+ >+ >+1; >diff --git a/t/Koha/Auth/Permissions.t b/t/Koha/Auth/Permissions.t >new file mode 100755 >index 0000000000..7f053b7ef5 >--- /dev/null >+++ b/t/Koha/Auth/Permissions.t >@@ -0,0 +1,269 @@ >+#!/usr/bin/perl >+ >+# This file is part of Koha. >+# >+# Koha is free software; you can redistribute it and/or modify it >+# under the terms of the GNU General Public License as published by >+# the Free Software Foundation; either version 3 of the License, or >+# (at your option) any later version. >+# >+# Koha is distributed in the hope that it will be useful, but >+# WITHOUT ANY WARRANTY; without even the implied warranty of >+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the >+# GNU General Public License for more details. >+# >+# You should have received a copy of the GNU General Public License >+# along with Koha; if not, see <http://www.gnu.org/licenses>. >+ >+use Modern::Perl; >+ >+use Test::More tests => 3; >+ >+use_ok('Koha::Auth::Permissions'); >+ >+subtest 'normal staff user test' => sub { >+ plan tests => 1; >+ my $flags = { >+ 'permissions' => 0, >+ 'circulate' => { >+ circulate_remaining_permissions => 1, >+ }, >+ 'staffaccess' => 1, >+ 'editcatalogue' => 0, >+ 'cash_management' => 0, >+ 'reserveforothers' => 0, >+ 'serials' => 0, >+ 'borrowers' => 0, >+ 'lists' => 0, >+ 'suggestions' => 0, >+ 'acquisition' => 0, >+ 'tools' => 0, >+ 'stockrotation' => 0, >+ 'clubs' => 0, >+ 'reports' => 0, >+ 'editauthorities' => 0, >+ 'updatecharges' => 0, >+ 'ill' => 0, >+ 'coursereserves' => 0, >+ 'self_check' => 0, >+ 'plugins' => 0, >+ 'superlibrarian' => 0, >+ 'recalls' => 0, >+ 'catalogue' => 0, >+ 'problem_reports' => 0, >+ 'parameters' => 0 >+ }; >+ my $authz = Koha::Auth::Permissions->get_authz_from_flags({ flags => $flags }); >+ my $expected = { >+ 'CAN_user_staffaccess' => 1, >+ 'CAN_user_circulate' => 1, >+ 'CAN_user_circulate_circulate_remaining_permissions' => 1, >+ }; >+ is_deeply($authz,$expected,'Expected permissions generated for superlibrarian'); >+}; >+ >+subtest 'superlibrarian tests' => sub { >+ plan tests => 1; >+ my $flags = { >+ 'permissions' => 0, >+ 'circulate' => 0, >+ 'staffaccess' => 0, >+ 'editcatalogue' => 0, >+ 'cash_management' => 0, >+ 'reserveforothers' => 0, >+ 'serials' => 0, >+ 'borrowers' => 0, >+ 'lists' => 0, >+ 'suggestions' => 0, >+ 'acquisition' => 0, >+ 'tools' => 0, >+ 'stockrotation' => 0, >+ 'clubs' => 0, >+ 'reports' => 0, >+ 'editauthorities' => 0, >+ 'updatecharges' => 0, >+ 'ill' => 0, >+ 'coursereserves' => 0, >+ 'self_check' => 0, >+ 'plugins' => 0, >+ 'superlibrarian' => 1, >+ 'recalls' => 0, >+ 'catalogue' => 0, >+ 'problem_reports' => 0, >+ 'parameters' => 0 >+ }; >+ my $authz = Koha::Auth::Permissions->get_authz_from_flags({ flags => $flags }); >+ my $expected = { >+ 'CAN_user_staffaccess' => 1, >+ 'CAN_user_parameters_manage_curbside_pickups' => 1, >+ 'CAN_user_serials' => 1, >+ 'CAN_user_self_check_self_checkout_module' => 1, >+ 'CAN_user_parameters_manage_audio_alerts' => 1, >+ 'CAN_user_parameters_manage_additional_fields' => 1, >+ 'CAN_user_parameters_manage_accounts' => 1, >+ 'CAN_user_tools_moderate_tags' => 1, >+ 'CAN_user_coursereserves_manage_courses' => 1, >+ 'CAN_user_clubs_enroll' => 1, >+ 'CAN_user_tools_manage_staged_marc' => 1, >+ 'CAN_user_updatecharges_discount' => 1, >+ 'CAN_user_tools_moderate_comments' => 1, >+ 'CAN_user_parameters_manage_search_engine_config' => 1, >+ 'CAN_user_acquisition_planning_manage' => 1, >+ 'CAN_user_updatecharges_refund' => 1, >+ 'CAN_user_self_check_self_checkin_module' => 1, >+ 'CAN_user_acquisition_currencies_manage' => 1, >+ 'CAN_user_acquisition_vendors_manage' => 1, >+ 'CAN_user_updatecharges_writeoff' => 1, >+ 'CAN_user_tools_edit_quotes' => 1, >+ 'CAN_user_acquisition_group_manage' => 1, >+ 'CAN_user_circulate' => 1, >+ 'CAN_user_acquisition_budget_modify' => 1, >+ 'CAN_user_permissions' => 1, >+ 'CAN_user_plugins' => 1, >+ 'CAN_user_superlibrarian' => 1, >+ 'CAN_user_parameters_manage_marc_overlay_rules' => 1, >+ 'CAN_user_circulate_circulate_remaining_permissions' => 1, >+ 'CAN_user_circulate_manage_curbside_pickups' => 1, >+ 'CAN_user_acquisition_budget_manage' => 1, >+ 'CAN_user_tools_manage_patron_lists' => 1, >+ 'CAN_user_reserveforothers_modify_holds_priority' => 1, >+ 'CAN_user_cash_management_anonymous_refund' => 1, >+ 'CAN_user_editcatalogue_edit_items_restricted' => 1, >+ 'CAN_user_tools_delete_anonymize_patrons' => 1, >+ 'CAN_user_editcatalogue' => 1, >+ 'CAN_user_tools_upload_manage' => 1, >+ 'CAN_user_parameters_manage_marc_frameworks' => 1, >+ 'CAN_user_reports_delete_reports' => 1, >+ 'CAN_user_tools_import_patrons' => 1, >+ 'CAN_user_borrowers_delete_borrowers' => 1, >+ 'CAN_user_tools_rotating_collections' => 1, >+ 'CAN_user_acquisition_budget_manage_all' => 1, >+ 'CAN_user_circulate_override_renewals' => 1, >+ 'CAN_user_serials_claim_serials' => 1, >+ 'CAN_user_tools_stage_marc_import' => 1, >+ 'CAN_user_serials_edit_subscription' => 1, >+ 'CAN_user_cash_management_cashup' => 1, >+ 'CAN_user_parameters_manage_cities' => 1, >+ 'CAN_user_parameters_manage_auth_values' => 1, >+ 'CAN_user_parameters_manage_column_config' => 1, >+ 'CAN_user_parameters_manage_didyoumean' => 1, >+ 'CAN_user_problem_reports' => 1, >+ 'CAN_user_acquisition_delete_invoices' => 1, >+ 'CAN_user_cash_management_takepayment' => 1, >+ 'CAN_user_tools_batch_extend_due_dates' => 1, >+ 'CAN_user_circulate_manage_checkout_notes' => 1, >+ 'CAN_user_circulate_overdues_report' => 1, >+ 'CAN_user_reports_execute_reports' => 1, >+ 'CAN_user_tools_marc_modification_templates' => 1, >+ 'CAN_user_tools_manage_csv_profiles' => 1, >+ 'CAN_user_recalls_manage_recalls' => 1, >+ 'CAN_user_reserveforothers_place_holds' => 1, >+ 'CAN_user_plugins_tool' => 1, >+ 'CAN_user_editcatalogue_delete_all_items' => 1, >+ 'CAN_user_editcatalogue_edit_catalogue' => 1, >+ 'CAN_user_coursereserves_delete_reserves' => 1, >+ 'CAN_user_lists_edit_public_lists' => 1, >+ 'CAN_user_parameters_manage_item_search_fields' => 1, >+ 'CAN_user_editcatalogue_manage_item_groups' => 1, >+ 'CAN_user_borrowers_view_borrower_infos_from_any_libraries' => 1, >+ 'CAN_user_stockrotation_manage_rota_items' => 1, >+ 'CAN_user_editauthorities' => 1, >+ 'CAN_user_parameters_manage_usage_stats' => 1, >+ 'CAN_user_parameters_manage_item_circ_alerts' => 1, >+ 'CAN_user_circulate_manage_restrictions' => 1, >+ 'CAN_user_parameters_manage_classifications' => 1, >+ 'CAN_user_clubs' => 1, >+ 'CAN_user_tools_items_batchdel' => 1, >+ 'CAN_user_borrowers_edit_borrowers' => 1, >+ 'CAN_user_parameters_manage_sms_providers' => 1, >+ 'CAN_user_reports_create_reports' => 1, >+ 'CAN_user_parameters_manage_oai_sets' => 1, >+ 'CAN_user_acquisition_order_manage' => 1, >+ 'CAN_user_editcatalogue_advanced_editor' => 1, >+ 'CAN_user_suggestions' => 1, >+ 'CAN_user_clubs_edit_clubs' => 1, >+ 'CAN_user_parameters_manage_patron_attributes' => 1, >+ 'CAN_user_reserveforothers' => 1, >+ 'CAN_user_acquisition_period_manage' => 1, >+ 'CAN_user_editcatalogue_create_shared_macros' => 1, >+ 'CAN_user_plugins_manage' => 1, >+ 'CAN_user_problem_reports_manage_problem_reports' => 1, >+ 'CAN_user_tools_label_creator' => 1, >+ 'CAN_user_parameters_manage_circ_rules_from_any_libraries' => 1, >+ 'CAN_user_serials_create_subscription' => 1, >+ 'CAN_user_tools_inventory' => 1, >+ 'CAN_user_tools_upload_general_files' => 1, >+ 'CAN_user_tools_edit_additional_contents' => 1, >+ 'CAN_user_acquisition_edi_manage' => 1, >+ 'CAN_user_tools_edit_notice_status_triggers' => 1, >+ 'CAN_user_parameters_manage_smtp_servers' => 1, >+ 'CAN_user_parameters_manage_libraries' => 1, >+ 'CAN_user_serials_receive_serials' => 1, >+ 'CAN_user_parameters_manage_patron_categories' => 1, >+ 'CAN_user_tools_items_batchmod' => 1, >+ 'CAN_user_tools_view_system_logs' => 1, >+ 'CAN_user_serials_renew_subscription' => 1, >+ 'CAN_user_parameters_manage_keyboard_shortcuts' => 1, >+ 'CAN_user_recalls' => 1, >+ 'CAN_user_acquisition_contracts_manage' => 1, >+ 'CAN_user_circulate_force_checkout' => 1, >+ 'CAN_user_coursereserves_add_reserves' => 1, >+ 'CAN_user_acquisition_order_receive' => 1, >+ 'CAN_user_stockrotation_manage_rotas' => 1, >+ 'CAN_user_updatecharges_payout' => 1, >+ 'CAN_user_tools_batch_upload_patron_images' => 1, >+ 'CAN_user_catalogue' => 1, >+ 'CAN_user_serials_delete_subscription' => 1, >+ 'CAN_user_stockrotation' => 1, >+ 'CAN_user_self_check' => 1, >+ 'CAN_user_tools_upload_local_cover_images' => 1, >+ 'CAN_user_tools_edit_notices' => 1, >+ 'CAN_user_acquisition_reopen_closed_invoices' => 1, >+ 'CAN_user_parameters_manage_mana' => 1, >+ 'CAN_user_tools_export_catalog' => 1, >+ 'CAN_user_parameters_manage_itemtypes' => 1, >+ 'CAN_user_parameters_manage_matching_rules' => 1, >+ 'CAN_user_suggestions_suggestions_manage' => 1, >+ 'CAN_user_parameters_manage_background_jobs' => 1, >+ 'CAN_user_tools_records_batchmod' => 1, >+ 'CAN_user_tools_items_batchmod_restricted' => 1, >+ 'CAN_user_parameters_manage_sysprefs' => 1, >+ 'CAN_user_tools_edit_calendar' => 1, >+ 'CAN_user_acquisition_merge_invoices' => 1, >+ 'CAN_user_tools_records_batchdel' => 1, >+ 'CAN_user_tools_edit_patrons' => 1, >+ 'CAN_user_borrowers' => 1, >+ 'CAN_user_updatecharges_remaining_permissions' => 1, >+ 'CAN_user_parameters_parameters_remaining_permissions' => 1, >+ 'CAN_user_parameters' => 1, >+ 'CAN_user_cash_management' => 1, >+ 'CAN_user_tools' => 1, >+ 'CAN_user_editcatalogue_edit_items' => 1, >+ 'CAN_user_tools_access_files' => 1, >+ 'CAN_user_parameters_manage_cash_registers' => 1, >+ 'CAN_user_plugins_report' => 1, >+ 'CAN_user_clubs_edit_templates' => 1, >+ 'CAN_user_serials_routing' => 1, >+ 'CAN_user_editcatalogue_delete_shared_macros' => 1, >+ 'CAN_user_parameters_manage_circ_rules' => 1, >+ 'CAN_user_ill' => 1, >+ 'CAN_user_lists_delete_public_lists' => 1, >+ 'CAN_user_parameters_manage_search_targets' => 1, >+ 'CAN_user_editcatalogue_fast_cataloging' => 1, >+ 'CAN_user_acquisition' => 1, >+ 'CAN_user_acquisition_edit_invoices' => 1, >+ 'CAN_user_acquisition_order_manage_all' => 1, >+ 'CAN_user_parameters_manage_transfers' => 1, >+ 'CAN_user_coursereserves' => 1, >+ 'CAN_user_serials_check_expiration' => 1, >+ 'CAN_user_updatecharges' => 1, >+ 'CAN_user_reports' => 1, >+ 'CAN_user_plugins_configure' => 1, >+ 'CAN_user_tools_schedule_tasks' => 1, >+ 'CAN_user_lists' => 1, >+ 'CAN_user_acquisition_delete_baskets' => 1, >+ 'CAN_user_acquisition_budget_add_del' => 1, >+ 'CAN_user_serials_superserials' => 1 >+ }; >+ is_deeply($authz,$expected,'Expected permissions generated for superlibrarian'); >+}; >-- >2.30.2
<b>You cannot view the attachment while viewing its details because your browser does not support IFRAMEs. <a href="attachment.cgi?id=140202">View the attachment on a separate page</a>.</b>
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 31389
:
139311
|
139326
|
139398
|
140202
|
140203
|
140563
|
140564
|
140844