Annotation of loncom/auth/lonlogout.pm, revision 1.55
1.1 www 1: # The LearningOnline Network
2: # Logout Handler
1.3 www 3: #
1.55 ! raeburn 4: # $Id: lonlogout.pm,v 1.54 2018/05/08 15:37:41 raeburn Exp $
1.3 www 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 www 28:
1.36 jms 29: =head1 NAME
30:
31: Apache::lonlogout
32:
33: =head1 SYNOPSIS
34:
35:
36: This is part of the LearningOnline Network with CAPA project
37: described at http://www.lon-capa.org.
38:
39:
40: =cut
41:
1.1 www 42: package Apache::lonlogout;
43:
44: use strict;
45: use Apache::Constants qw(:common);
46: use Apache::File;
47: use Apache::lonnet;
1.51 raeburn 48: use Apache::loncommon;
1.2 www 49: use Apache::lonmenu;
1.1 www 50: use CGI::Cookie();
1.11 www 51: use Apache::lonlocal;
1.52 raeburn 52: use LONCAPA qw(:DEFAULT :match);
1.1 www 53:
54: sub handler {
55: my $r = shift;
56:
1.17 albertel 57: #Check for cookie
1.1 www 58: my $requrl=$r->uri;
1.29 albertel 59: my $handle = &Apache::lonnet::check_for_valid_session($r);
1.17 albertel 60: #check if cookie still valid
1.29 albertel 61: if ($handle eq '') {
1.17 albertel 62: $r->log_reason("Cookie $handle not valid", $r->filename);
63: return FORBIDDEN;
64: }
65:
66: #we've got a valid user
1.31 www 67: #any locks in place?
68: my $locknum=&Apache::lonnet::get_locks();
69: if ($locknum) { return 409; }
70: #nope, go ahead
1.17 albertel 71: my @profile;
1.29 albertel 72: my $lonidsdir=$r->dir_config('lonIDsDir');
1.21 albertel 73: &Apache::lonnet::transfer_profile_to_env($lonidsdir,$handle);
1.55 ! raeburn 74: if (unlink("$lonidsdir/$handle.id")) {
! 75: if (($env{'user.linkedenv'} =~ /^[a-f0-9]+_linked$/) &&
! 76: (-l "$lonidsdir/$env{'user.linkedenv'}.id") &&
! 77: (readlink("$lonidsdir/$env{'user.linkedenv'}.id") eq "$lonidsdir/$handle.id")) {
! 78: unlink("$lonidsdir/$env{'user.linkedenv'}.id");
1.50 raeburn 79: }
80: }
1.46 raeburn 81: if (!$Apache::lonlocal::lh) {
82: &Apache::lonlocal::get_language_handle($r);
83: }
1.17 albertel 84: my %temp=('logout' => time);
85: &Apache::lonnet::put('email_status',\%temp);
1.21 albertel 86: &Apache::lonnet::log($env{'user.domain'},
87: $env{'user.name'},
88: $env{'user.home'},
1.17 albertel 89: "Logout $ENV{'REMOTE_ADDR'}");
1.25 albertel 90:
1.17 albertel 91: &Apache::loncommon::content_type($r,'text/html');
1.25 albertel 92:
1.55 ! raeburn 93: #expire the cookies
! 94: my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
! 95: foreach my $name (keys(%cookies)) {
! 96: next unless ($name =~ /^lon(|S|Link|Pub)ID$/);
! 97: my $c = new CGI::Cookie(-name => $name,
! 98: -value => '',
! 99: -expires => '-10y',);
! 100: $r->headers_out->add('Set-cookie' => $c);
1.50 raeburn 101: }
1.17 albertel 102: $r->send_http_header;
103: return OK if $r->header_only;
1.2 www 104: # -------------------------------------------------------- Menu script and info
105:
1.6 www 106: # ---------------------------------------------------------------- Get handover
107: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
108: my $switch='';
1.18 albertel 109: my $start_page='';
1.7 www 110: my $relogmessage='';
1.14 albertel 111: if ($env{'form.handover'}) {
1.17 albertel 112: $switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37 bisitz 113: $env{'form.handover'}.'" />';
1.17 albertel 114: $start_page=&Apache::loncommon::start_page('Switching Server ...',
115: $switch);
116: } else {
1.47 raeburn 117: my $domain = $env{'user.domain'};
1.51 raeburn 118: my ($headextra,$ssofile);
119: if ($env{'request.sso.login'}) {
120: my $londocroot = $r->dir_config('lonDocRoot');
121: if ($domain =~ /^$match_domain$/) {
122: if (defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
123: $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config("lonSSOUserLogoutHeadFile_$domain"));
124: if ($ssofile eq $r->dir_config("lonSSOUserLogoutHeadFile_$domain")) {
125: if ($ssofile =~ /^\Q$londocroot\E/) {
1.53 raeburn 126: if (open(my $fh,'<',$ssofile)) {
1.51 raeburn 127: $headextra = join('',<$fh>);
128: close($fh);
129: }
130: }
131: }
132: }
133: }
134: if (defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
135: $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config('lonSSOUserLogoutHeadFile'));
136: if ($ssofile eq $r->dir_config('lonSSOUserLogoutHeadFile')) {
137: if ($ssofile =~ /^\Q$londocroot\E/) {
1.53 raeburn 138: if (open(my $fh,'<',$ssofile)) {
1.51 raeburn 139: $headextra.= join('',<$fh>);
140: close($fh);
141: }
142: }
143: }
1.47 raeburn 144: }
145: }
146: $start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.41 droeschl 147: {'no_nav_bar' => 1,});
1.26 albertel 148:
1.32 bisitz 149: $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
150: .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26 albertel 151:
152: if (!$env{'request.sso.norelogin'}) {
1.42 raeburn 153: my ($relogin_server,$login_url);
1.26 albertel 154: if ($env{'request.sso.reloginserver'}) {
155: $relogin_server = $env{'request.sso.reloginserver'};
1.42 raeburn 156: } else {
157: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
158: if ($domdefaults{'portal_def'}) {
159: $login_url = $domdefaults{'portal_def'};
160: } else {
161: my $checkloginvia = 1;
1.44 raeburn 162: my ($lonhost,$server,$path,$isredirect) =
1.42 raeburn 163: &Apache::lonnet::choose_server($domain,$checkloginvia);
164: if ($server && $lonhost) {
165: $login_url = $Apache::lonnet::protocol{$lonhost}.
166: '://'.$server.$path;
1.44 raeburn 167: if (($path eq '') && (!$isredirect)) {
168: my $serverhomeID =
1.45 raeburn 169: &Apache::lonnet::get_server_homeID($server);
1.44 raeburn 170: my $serverhomedom =
171: &Apache::lonnet::host_domain($serverhomeID);
172: if ($serverhomedom ne $domain) {
173: $path = '/adm/login';
174: $login_url .= $path;
175: }
176: }
1.43 raeburn 177: if ($path eq '/adm/login' && $domain ne '') {
178: $login_url .= '?domain='.$domain;
179: }
1.42 raeburn 180: }
181: }
182: }
183: if ($login_url eq '') {
184: $login_url = $relogin_server.'/adm/'.
185: ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
186: }
1.54 raeburn 187: $relogmessage.='<p>'.&mt('You have been successfully logged out.');
188: unless (($env{'request.lti.login'}) && ($env{'request.lti.target'} eq 'iframe')) {
189: $relogmessage.=' '.&mt('You can [_1]close this window[_2] now.',
190: '',''); # ,'<a href="javascript:self.close();">','</a>');
191: }
192: $relogmessage.='</p>';
1.33 jms 193: =pod
194:
195: =head1 NOTES:
196:
1.34 bisitz 197: '<a href="javascript:self.close();">','</a>'
1.33 jms 198:
1.49 raeburn 199: Due to security reasons in new web browsers a window could only be closed with javascript, if this window has also been opened with javascript. This is not done here which means that in most cases the close link will not work. Unless we find another solution, this link should not be offered. (Stefan Bisitz, 2008-08-01)
1.33 jms 200:
201: =cut
1.54 raeburn 202: unless ($env{'request.lti.login'}) {
203: $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
204: ,'<a href="'.$login_url.'">','</a>')
205: .'</p>';
206: }
1.26 albertel 207: }
1.20 albertel 208: if ($env{'request.sso.login'}
1.26 albertel 209: && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.53 raeburn 210: if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.47 raeburn 211: $relogmessage.= join('',<$fh>);
212: close($fh);
213: }
1.26 albertel 214: }
215: if ($env{'request.sso.login'}
1.27 albertel 216: && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.53 raeburn 217: if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.47 raeburn 218: $relogmessage.= join('',<$fh>);
219: close($fh);
220: }
1.20 albertel 221: }
1.17 albertel 222: }
1.18 albertel 223: my $end_page=&Apache::loncommon::end_page();
1.2 www 224: # --------------------------------------------------------------- Screen Output
1.17 albertel 225: $r->print(<<ENDDOCUMENT);
1.16 albertel 226: $start_page
1.7 www 227: $relogmessage
1.16 albertel 228: $end_page
1.1 www 229: ENDDOCUMENT
1.28 albertel 230: $r->register_cleanup(\&flush_course_logs);
231: return OK;
232: }
233:
234: sub flush_course_logs {
1.17 albertel 235: &Apache::lonnet::flushcourselogs();
1.28 albertel 236: return OK;
1.1 www 237: }
238:
239: 1;
240: __END__
241:
242:
243:
244:
245:
246:
247:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>