Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity

Bug 36098: Add Koha::Session module to ease session handling

Browse source 
This patch adds a Koha::Session module that makes it easier
to work with Koha sessions without needing the full C4::Auth module.

Test plan:
0. Apply the patch
1. Run the following unit tests:
prove ./t/db_dependent/Auth.t
prove ./t/db_dependent/Auth_with_cas.t
prove ./t/db_dependent/Koha/Session.t
2. Observe that they all pass

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
(cherry picked from commit 0e6537d199)
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
(cherry picked from commit f927343a88)
Signed-off-by: Lucas Gass <lucas@bywatersolutions.com>
(cherry picked from commit e19e066b4a)
Signed-off-by: Frédéric Demians <f.demians@tamil.fr>
This commit is contained in:
David Cook 2024-02-15 02:49:18 +00:00 committed by Frédéric Demians
parent 82f1e3906c
commit d917e2fc75
3 changed files with 98 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
C4/Auth.pm
View file

@ -53,6 +53,7 @@ use C4::Log qw( logaction );
use Koha::CookieManager;
use Koha::Auth::Permissions;
use Koha::Token;
use Koha::Session;
# use utf8;
@ -1860,39 +1861,15 @@ will be created.
=cut
#NOTE: We're keeping this for backwards compatibility
sub _get_session_params {
my $storage_method = C4::Context->preference('SessionStorage');
if ( $storage_method eq 'mysql' ) {
my $dbh = C4::Context->dbh;
return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
}
elsif ( $storage_method eq 'Pg' ) {
my $dbh = C4::Context->dbh;
return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
}
elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
my $memcached = Koha::Caches->get_instance()->memcached_cache;
return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
}
else {
# catch all defaults to tmp should work on all systems
my $dir = C4::Context::temporary_directory;
my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
}
return Koha::Session->_get_session_params();
}
#NOTE: We're keeping this for backwards compatibility
sub get_session {
my $sessionID = shift;
my $params = _get_session_params();
my $session;
if( $sessionID ) { # find existing
CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
$session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
} else {
$session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
# no need to flush here
}
my $sessionID = shift;
my $session = Koha::Session->get_session( { sessionID => $sessionID } );
return $session;
}

63
Koha/Session.pm Normal file
View file

@ -0,0 +1,63 @@
package Koha::Session;
# 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 CGI::Session;
use C4::Context;
use Koha::Caches;
sub _get_session_params {
my $class = shift;
my $storage_method = C4::Context->preference('SessionStorage');
if ( $storage_method eq 'mysql' ) {
my $dbh = C4::Context->dbh;
return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
} elsif ( $storage_method eq 'Pg' ) {
my $dbh = C4::Context->dbh;
return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
} elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
my $memcached = Koha::Caches->get_instance()->memcached_cache;
return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
} else {
# catch all defaults to tmp should work on all systems
my $dir = C4::Context::temporary_directory;
my $instance = C4::Context->config('database')
; #actually for packages not exactly the instance name, but generally safer to leave it as it is
return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
}
return;
}
sub get_session {
my ( $class, $args ) = @_;
my $sessionID = $args->{sessionID};
my $params = $class->_get_session_params();
my $session;
if ($sessionID) { # find existing
CGI::Session::ErrorHandler->set_error(q{}); # clear error, cpan issue #111463
$session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
} else {
$session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
# no need to flush here
}
return $session;
}
1;

29
t/db_dependent/Koha/Session.t Executable file
View file

@ -0,0 +1,29 @@
#!/usr/bin/perl
use Modern::Perl;
use Test::More tests => 1;
use t::lib::TestBuilder;
use C4::Auth;
use Koha::Session;
my $schema = Koha::Database->schema;
my $builder = t::lib::TestBuilder->new;
subtest 'basic session fetch' => sub {
plan tests => 2;
$schema->storage->txn_begin;
my $patron =
$builder->build_object( { class => 'Koha::Patrons', value => { userid => 'superman' } } );
my $basic_session = C4::Auth::create_basic_session( { patron => $patron, interface => 'staff' } );
is( $basic_session->param('id'), 'superman', 'basic session created as expected' );
$basic_session->flush;
my $session = Koha::Session->get_session( { sessionID => $basic_session->id } );
is( $session->param('id'), 'superman', 'basic session fetched as expected' );
$schema->storage->txn_rollback;
};