Bug 16011: $VERSION - remove use vars $VERSION
[koha.git] / C4 / Auth_with_cas.pm
index d8e5040..884a547 100644 (file)
@@ -4,31 +4,31 @@ package C4::Auth_with_cas;
 #
 # 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 2 of the License, or (at your option) any later
-# version.
+# 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.
+# 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, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use strict;
 use warnings;
 
 use C4::Debug;
 use C4::Context;
-use C4::Utils qw( :all );
 use Authen::CAS::Client;
-use CGI;
+use CGI qw ( -utf8 );
 use FindBin;
+use YAML;
 
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
 
 BEGIN {
        require Exporter;
@@ -40,12 +40,12 @@ BEGIN {
 my $context = C4::Context->new() or die 'C4::Context->new failed';
 my $defaultcasserver;
 my $casservers;
-my $yamlauthfile = "../C4/Auth_cas_servers.yaml";
+my $yamlauthfile = C4::Context->config('intranetdir') . "/C4/Auth_cas_servers.yaml";
 
 
 # If there's a configuration for multiple cas servers, then we get it
 if (multipleAuth()) {
-    ($defaultcasserver, $casservers) = YAML::LoadFile(qq($FindBin::Bin/$yamlauthfile));
+    ($defaultcasserver, $casservers) = YAML::LoadFile($yamlauthfile);
     $defaultcasserver = $defaultcasserver->{'default'};
 } else {
 # Else, we fall back to casServerUrl syspref
@@ -55,7 +55,7 @@ if (multipleAuth()) {
 
 # Is there a configuration file for multiple cas servers?
 sub multipleAuth {
-    return (-e qq($FindBin::Bin/$yamlauthfile));
+    return (-e qq($yamlauthfile));
 }
 
 # Returns configured CAS servers' list if multiple authentication is enabled
@@ -65,39 +65,23 @@ sub getMultipleAuth {
 
 # Logout from CAS
 sub logout_cas {
-    my ($query) = @_;
-    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
-    my $casparam = $query->param('cas');
-    # FIXME: This should be more generic and handle whatever parameters there might be
-    $uri .= "?cas=" . $casparam if (defined $casparam);
-    $casparam = $defaultcasserver if (not defined $casparam);
-    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    my ($query, $type) = @_;
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
     print $query->redirect( $cas->logout_url($uri));
+    print $query->redirect( $cas->logout_url(url => $uri));
 }
 
 # Login to CAS
 sub login_cas {
-    my ($query) = @_;
-    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
-    my $casparam = $query->param('cas');
-    # FIXME: This should be more generic and handle whatever parameters there might be
-    $uri .= "?cas=" . $casparam if (defined $casparam);
-    $casparam = $defaultcasserver if (not defined $casparam);
-    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    my ($query, $type) = @_;
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
     print $query->redirect( $cas->login_url($uri));
 }
 
 # Returns CAS login URL with callback to the requesting URL
 sub login_cas_url {
-
-    my ($query, $key) = @_;
-    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
-    my $casparam = $query->param('cas');
-    # FIXME: This should be more generic and handle whatever parameters there might be
-    $uri .= "?cas=" . $casparam if (defined $casparam);
-    $casparam = $defaultcasserver if (not defined $casparam);
-    $casparam = $key if (defined $key);
-    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    my ( $query, $key, $type ) = @_;
+    my ( $cas, $uri ) = _get_cas_and_service( $query, $key, $type );
     return $cas->login_url($uri);
 }
 
@@ -105,14 +89,9 @@ sub login_cas_url {
 # In our case : is there a ticket, is it valid and does it match one of our users ?
 sub checkpw_cas {
     $debug and warn "checkpw_cas";
-    my ($dbh, $ticket, $query) = @_;
+    my ($dbh, $ticket, $query, $type) = @_;
     my $retnumber;
-    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
-    my $casparam = $query->param('cas');
-    # FIXME: This should be more generic and handle whatever parameters there might be
-    $uri .= "?cas=" . $casparam if (defined $casparam);
-    $casparam = $defaultcasserver if (not defined $casparam);
-    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
 
     # If we got a ticket
     if ($ticket) {
@@ -158,17 +137,13 @@ sub checkpw_cas {
 # Proxy CAS auth
 sub check_api_auth_cas {
     $debug and warn "check_api_auth_cas";
-    my ($dbh, $PT, $query) = @_;
+    my ($dbh, $PT, $query, $type) = @_;
     my $retnumber;
-    my $url = C4::Context->preference('OPACBaseURL') . $query->script_name();
-
-    my $casparam = $query->param('cas');
-    $casparam = $defaultcasserver if (not defined $casparam);
-    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
 
     # If we have a Proxy Ticket
     if ($PT) {
-        my $r = $cas->proxy_validate( $url, $PT );
+        my $r = $cas->proxy_validate( $uri, $PT );
 
         # If the PT is valid
         if ( $r->is_success ) {
@@ -206,6 +181,47 @@ sub check_api_auth_cas {
     return 0;
 }
 
+# Get CAS handler and service URI
+sub _get_cas_and_service {
+    my $query = shift;
+    my $key   = shift;    # optional
+    my $type  = shift;
+
+    my $uri = _url_with_get_params($query, $type);
+
+    my $casparam = $defaultcasserver;
+    $casparam = $query->param('cas') if defined $query->param('cas');
+    $casparam = $key if defined $key;
+    my $cas = Authen::CAS::Client->new( $casservers->{$casparam} );
+
+    return ( $cas, $uri );
+}
+
+# Get the current URL with parameters contained directly into URL (GET params)
+# This method replaces $query->url() which will give both GET and POST params
+sub _url_with_get_params {
+    my $query = shift;
+    my $type = shift;
+
+    my $uri_base_part = ($type eq 'opac') ?
+                        C4::Context->preference('OPACBaseURL') . $query->script_name():
+                        C4::Context->preference('staffClientBaseURL');
+
+    my $uri_params_part = '';
+    foreach my $param ( $query->url_param() ) {
+        # url_param() always returns parameters that were deleted by delete()
+        # This additional check ensure that parameter was not deleted.
+        my $uriPiece = $query->param($param);
+        if ($uriPiece) {
+            $uri_params_part .= '&' if $uri_params_part;
+            $uri_params_part .= $param . '=';
+            $uri_params_part .= URI::Escape::uri_escape( $uriPiece );
+        }
+    }
+    $uri_base_part .= '?' if $uri_params_part;
+
+    return $uri_base_part . $uri_params_part;
+}
 
 1;
 __END__