Annotation of loncom/auth/lonlogout.pm, revision 1.53
1.1 www 1: # The LearningOnline Network
2: # Logout Handler
1.3 www 3: #
1.53 ! raeburn 4: # $Id: lonlogout.pm,v 1.52 2017/11/30 03:35:08 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.17 albertel 74: unlink("$lonidsdir/$handle.id");
1.50 raeburn 75: if ($env{'user.linkedenv'} ne '') {
76: my $lonhost = $r->dir_config('lonHostID');
77: if ((-l $env{'user.linkedenv'}) &&
78: (readlink($env{'user.linkedenv'}) eq "$lonidsdir/$handle.id")) {
79: unlink($env{'user.linkedenv'});
80: }
81: }
1.46 raeburn 82: if (!$Apache::lonlocal::lh) {
83: &Apache::lonlocal::get_language_handle($r);
84: }
1.17 albertel 85: my %temp=('logout' => time);
86: &Apache::lonnet::put('email_status',\%temp);
1.21 albertel 87: &Apache::lonnet::log($env{'user.domain'},
88: $env{'user.name'},
89: $env{'user.home'},
1.17 albertel 90: "Logout $ENV{'REMOTE_ADDR'}");
1.25 albertel 91:
1.17 albertel 92: &Apache::loncommon::content_type($r,'text/html');
1.25 albertel 93:
94: #expire the cookie
1.50 raeburn 95: my $name = 'lonID';
96: if (($env{'user.name'} eq 'public') && ($env{'user.domain'} eq 'public')) {
97: $name = 'lonPubID';
98: }
99: my $c = new CGI::Cookie(-name => $name,
1.25 albertel 100: -value => '',
101: -expires => '-10y',);
1.50 raeburn 102: $r->headers_out->add('Set-cookie' => $c);
1.52 raeburn 103: if (($name eq 'lonID') && ($env{'user.linkedenv'})) {
1.50 raeburn 104: my $other = new CGI::Cookie(-name => 'lonLinkID',
105: -value => '',
106: -expires => '-10y',);
107: $r->headers_out->add('Set-cookie' => $other);
108: }
1.17 albertel 109: $r->send_http_header;
110: return OK if $r->header_only;
1.2 www 111: # -------------------------------------------------------- Menu script and info
112:
1.6 www 113: # ---------------------------------------------------------------- Get handover
114: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['handover']);
115: my $switch='';
1.18 albertel 116: my $start_page='';
1.7 www 117: my $relogmessage='';
1.14 albertel 118: if ($env{'form.handover'}) {
1.17 albertel 119: $switch='<meta HTTP-EQUIV="Refresh" CONTENT="0.5; url='.
1.37 bisitz 120: $env{'form.handover'}.'" />';
1.17 albertel 121: $start_page=&Apache::loncommon::start_page('Switching Server ...',
122: $switch);
123: } else {
1.47 raeburn 124: my $domain = $env{'user.domain'};
1.51 raeburn 125: my ($headextra,$ssofile);
126: if ($env{'request.sso.login'}) {
127: my $londocroot = $r->dir_config('lonDocRoot');
128: if ($domain =~ /^$match_domain$/) {
129: if (defined($r->dir_config("lonSSOUserLogoutHeadFile_$domain"))) {
130: $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config("lonSSOUserLogoutHeadFile_$domain"));
131: if ($ssofile eq $r->dir_config("lonSSOUserLogoutHeadFile_$domain")) {
132: if ($ssofile =~ /^\Q$londocroot\E/) {
1.53 ! raeburn 133: if (open(my $fh,'<',$ssofile)) {
1.51 raeburn 134: $headextra = join('',<$fh>);
135: close($fh);
136: }
137: }
138: }
139: }
140: }
141: if (defined($r->dir_config('lonSSOUserLogoutHeadFile'))) {
142: $ssofile = '/'.&Apache::loncommon::clean_path($r->dir_config('lonSSOUserLogoutHeadFile'));
143: if ($ssofile eq $r->dir_config('lonSSOUserLogoutHeadFile')) {
144: if ($ssofile =~ /^\Q$londocroot\E/) {
1.53 ! raeburn 145: if (open(my $fh,'<',$ssofile)) {
1.51 raeburn 146: $headextra.= join('',<$fh>);
147: close($fh);
148: }
149: }
150: }
1.47 raeburn 151: }
152: }
153: $start_page=&Apache::loncommon::start_page('Logged Out',$headextra,
1.41 droeschl 154: {'no_nav_bar' => 1,});
1.26 albertel 155:
1.32 bisitz 156: $relogmessage.='<h1>'.&mt('Goodbye').'</h1>'
157: .'<p>'.&mt('Thank you for using LON-CAPA.').'</p>';
1.26 albertel 158:
159: if (!$env{'request.sso.norelogin'}) {
1.42 raeburn 160: my ($relogin_server,$login_url);
1.26 albertel 161: if ($env{'request.sso.reloginserver'}) {
162: $relogin_server = $env{'request.sso.reloginserver'};
1.42 raeburn 163: } else {
164: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
165: if ($domdefaults{'portal_def'}) {
166: $login_url = $domdefaults{'portal_def'};
167: } else {
168: my $checkloginvia = 1;
1.44 raeburn 169: my ($lonhost,$server,$path,$isredirect) =
1.42 raeburn 170: &Apache::lonnet::choose_server($domain,$checkloginvia);
171: if ($server && $lonhost) {
172: $login_url = $Apache::lonnet::protocol{$lonhost}.
173: '://'.$server.$path;
1.44 raeburn 174: if (($path eq '') && (!$isredirect)) {
175: my $serverhomeID =
1.45 raeburn 176: &Apache::lonnet::get_server_homeID($server);
1.44 raeburn 177: my $serverhomedom =
178: &Apache::lonnet::host_domain($serverhomeID);
179: if ($serverhomedom ne $domain) {
180: $path = '/adm/login';
181: $login_url .= $path;
182: }
183: }
1.43 raeburn 184: if ($path eq '/adm/login' && $domain ne '') {
185: $login_url .= '?domain='.$domain;
186: }
1.42 raeburn 187: }
188: }
189: }
190: if ($login_url eq '') {
191: $login_url = $relogin_server.'/adm/'.
192: ($env{'request.sso.login'} ? 'roles': 'login?domain='.$domain);
193: }
1.32 bisitz 194: $relogmessage.='<p>'.&mt('You have been successfully logged out.').' '
195: .&mt('You can [_1]close this window[_2] now.'
1.34 bisitz 196: ,'','') # ,'<a href="javascript:self.close();">','</a>')
197: .'</p>';
1.33 jms 198: =pod
199:
200: =head1 NOTES:
201:
1.34 bisitz 202: '<a href="javascript:self.close();">','</a>'
1.33 jms 203:
1.49 raeburn 204: 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 205:
206: =cut
1.34 bisitz 207: $relogmessage.='<p>'.&mt('[_1]Log in again[_2]'
1.42 raeburn 208: ,'<a href="'.$login_url.'">','</a>')
1.32 bisitz 209: .'</p>';
1.26 albertel 210: }
1.20 albertel 211: if ($env{'request.sso.login'}
1.26 albertel 212: && defined($r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.53 ! raeburn 213: if (open(my $fh,'<',$r->dir_config("lonSSOUserLogoutMessageFile_$domain"))) {
1.47 raeburn 214: $relogmessage.= join('',<$fh>);
215: close($fh);
216: }
1.26 albertel 217: }
218: if ($env{'request.sso.login'}
1.27 albertel 219: && defined($r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.53 ! raeburn 220: if (open(my $fh,'<',$r->dir_config('lonSSOUserLogoutMessageFile'))) {
1.47 raeburn 221: $relogmessage.= join('',<$fh>);
222: close($fh);
223: }
1.20 albertel 224: }
1.17 albertel 225: }
1.18 albertel 226: my $end_page=&Apache::loncommon::end_page();
1.2 www 227: # --------------------------------------------------------------- Screen Output
1.17 albertel 228: $r->print(<<ENDDOCUMENT);
1.16 albertel 229: $start_page
1.7 www 230: $relogmessage
1.16 albertel 231: $end_page
1.1 www 232: ENDDOCUMENT
1.28 albertel 233: $r->register_cleanup(\&flush_course_logs);
234: return OK;
235: }
236:
237: sub flush_course_logs {
1.17 albertel 238: &Apache::lonnet::flushcourselogs();
1.28 albertel 239: return OK;
1.1 www 240: }
241:
242: 1;
243: __END__
244:
245:
246:
247:
248:
249:
250:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>