bug4966 - follow up to 4966 changes language from 'end' to 'finish'
[koha_gimpoz] / C4 / Auth_with_cas.pm
index 694cbbb..f9a03a3 100644 (file)
@@ -13,11 +13,12 @@ package C4::Auth_with_cas;
 # 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., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# 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.
 
 use strict;
+use warnings;
 
 use C4::Debug;
 use C4::Context;
@@ -31,68 +32,79 @@ use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
 BEGIN {
        require Exporter;
        $VERSION = 3.03;        # set the version for version checking
+       $debug = $ENV{DEBUG};
        @ISA    = qw(Exporter);
-       @EXPORT = qw( checkpw_cas login_cas logout_cas );
+       @EXPORT = qw(checkpw_cas login_cas logout_cas login_cas_url);
 }
 
 
 my $context = C4::Context->new()       or die 'C4::Context->new failed';
-my $casserver = C4::Context->config("usecasserver") or die 'No "usecasserver" in KOHA_CONF: ' . $ENV{KOHA_CONF};
+my $casserver = C4::Context->preference('casServerUrl');
 
+# Logout from CAS
 sub logout_cas {
     my ($query) = @_;
     my $cas = Authen::CAS::Client->new($casserver);
-    warn $cas->logout_url();
-    print $query->redirect($cas->logout_url());
-
+    print $query->redirect($cas->logout_url(url => $ENV{'SCRIPT_URI'}));
 }
 
+# Login to CAS
 sub login_cas {
     my ($query) = @_;
     my $cas = Authen::CAS::Client->new($casserver);
-    warn $cas->login_url(%ENV->{'SCRIPT_URI'});
-    print $query->redirect($cas->login_url(%ENV->{'SCRIPT_URI'})); 
+    print $query->redirect($cas->login_url($ENV{'SCRIPT_URI'})); 
+}
+
+# Returns CAS login URL with callback to the requesting URL
+sub login_cas_url {
+    my $cas = Authen::CAS::Client->new($casserver);
+    return $cas->login_url($ENV{'SCRIPT_URI'});
 }
 
+# Checks for password correctness
+# In our case : is there a ticket, is it valid and does it match one of our users ?
 sub checkpw_cas {
-    warn "checkpw_cas";
+    $debug and warn "checkpw_cas";
     my ($dbh, $ticket, $query) = @_;
     my $retnumber;
     my $cas = Authen::CAS::Client->new($casserver);
 
+    # If we got a ticket
     if ($ticket) {
-       warn "Got ticket : $ticket";
-       my $val = $cas->service_validate(%ENV->{'SCRIPT_URI'}, $ticket);
+       $debug and warn "Got ticket : $ticket";
+       
+       # We try to validate it
+       my $val = $cas->service_validate($ENV{'SCRIPT_URI'}, $ticket);
+       
+       # If it's valid
        if( $val->is_success() ) {
 
            my $userid = $val->user();
-           warn "User authenticated as: $userid";
+           $debug and warn "User CAS authenticated as: $userid";
 
+           # Does it match one of our users ?
            my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
            $sth->execute($userid);
            if ( $sth->rows ) {
                $retnumber = $sth->fetchrow;
+               return (1, $retnumber, $userid);
            }
-           my $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
+           $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
            $sth->execute($userid);
            if ( $sth->rows ) {
                $retnumber = $sth->fetchrow;
+               return (1, $retnumber, $userid);
            }
-           return (1, $retnumber, $userid);
+           
+           # If we reach this point, then the user is a valid CAS user, but not a Koha user
+           $debug and warn "User $userid is not a valid Koha user";
+
        } else {
-           warn "Invalid session ticket";
+           $debug and warn "Invalid session ticket : $ticket";
            return 0;
        }
-
-    } else {
-       warn ("Don't have any ticket, let's go get one from the CAS server!");
-       my $url = $cas->login_url(%ENV->{'SCRIPT_URI'});
-       print $query->redirect($url);           
     }
-
-    warn "We should not reach this point";
     return 0;
-    #return(1, $retnumber);
 }
 
 1;
@@ -108,8 +120,6 @@ C4::Auth - Authenticates Koha users
 
 =cut
 
-=head1 KOHA_CONF <usecasserver>http://mycasserver/loginurl</usecasserver>
-
 =head1 SEE ALSO
 
 CGI(3)