Annotation of loncom/lti/ltiauth.pm, revision 1.14
1.1 raeburn 1: # The LearningOnline Network
2: # Basic LTI Authentication Module
3: #
1.14 ! raeburn 4: # $Id: ltiauth.pm,v 1.13 2018/05/28 23:26:04 raeburn Exp $
1.1 raeburn 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: #
28:
29: package Apache::ltiauth;
30:
31: use strict;
32: use LONCAPA qw(:DEFAULT :match);
33: use Apache::Constants qw(:common :http);
34: use Net::OAuth;
35: use Apache::lonlocal;
36: use Apache::lonnet;
37: use Apache::loncommon;
38: use Apache::lonacc;
1.6 raeburn 39: use Apache::lonrequestcourse;
1.2 raeburn 40: use LONCAPA::ltiutils;
1.1 raeburn 41:
42: sub handler {
43: my $r = shift;
44: my $requri = $r->uri;
45: #
1.9 raeburn 46: # Check for existing session, and temporarily delete any form items
47: # in %env, if session exists
48: #
49: my %savedform;
50: my $handle = &Apache::lonnet::check_for_valid_session($r);
51: if ($handle ne '') {
52: foreach my $key (sort(keys(%env))) {
53: if ($key =~ /^form\.(.+)$/) {
54: $savedform{$1} = $env{$key};
55: delete($env{$key});
56: }
57: }
58: }
59: #
1.14 ! raeburn 60: # Retrieve data POSTed by LTI Consumer on launch
1.1 raeburn 61: #
62: &Apache::lonacc::get_posted_cgi($r);
63: my $params = {};
64: foreach my $key (sort(keys(%env))) {
65: if ($key =~ /^form\.(.+)$/) {
66: $params->{$1} = $env{$key};
67: }
68: }
1.9 raeburn 69: #
70: # Check for existing session, and restored temporarily
71: # deleted form items to %env, if session exists.
72: #
73: if ($handle ne '') {
74: if (keys(%savedform)) {
75: foreach my $key (sort(keys(%savedform))) {
76: $env{'form.'.$key} = $savedform{$key};
77: }
78: }
79: }
1.1 raeburn 80:
81: unless (keys(%{$params})) {
82: &invalid_request($r,1);
83: return OK;
84: }
85:
86: unless ($params->{'oauth_consumer_key'} &&
87: $params->{'oauth_nonce'} &&
88: $params->{'oauth_timestamp'} &&
89: $params->{'oauth_version'} &&
90: $params->{'oauth_signature'} &&
91: $params->{'oauth_signature_method'}) {
92: &invalid_request($r,2);
93: return OK;
94: }
95:
96: #
97: # Retrieve "internet domains" for all this institution's LON-CAPA
98: # nodes.
99: #
100: my ($udom,$uname,$uhome,$cdom,$cnum,$symb,$mapurl,@intdoms);
101: my $lonhost = $r->dir_config('lonHostID');
102: my $internet_names = &Apache::lonnet::get_internet_names($lonhost);
103: if (ref($internet_names) eq 'ARRAY') {
104: @intdoms = @{$internet_names};
105: }
106:
107: #
108: # For user who launched LTI in Consumer, determine user's domain in
109: # LON-CAPA.
110: #
111: # Order is:
112: #
113: # (a) from custom_userdomain item in POSTed data
114: # (b) from lis_person_sourcedid in POSTed data
115: # (c) from default "log-in" domain for node
116: # (can support multidomain servers, where specific domain is
117: # first part of hostname).
118: #
119: # Note: "internet domain" for user's domain must be one of the
120: # "internet domain(s)" for the institution's LON-CAPA servers.
121: #
122: if (exists($params->{'custom_userdomain'})) {
123: if ($params->{'custom_userdomain'} =~ /^$match_domain$/) {
124: my $uprimary_id = &Apache::lonnet::domain($params->{'custom_userdomain'},'primary');
125: if ($uprimary_id ne '') {
126: my $uintdom = &Apache::lonnet::internet_dom($uprimary_id);
127: if (($uintdom ne '') && (grep(/^\Q$uintdom\E$/,@intdoms))) {
128: $udom = $params->{'custom_userdomain'};
129: }
130: }
131: }
132: }
133: my $defdom = &Apache::lonnet::default_login_domain();
134: my ($domain,$possuname,$possudom,$possmapuser);
135: if ($env{'form.lis_person_sourcedid'} =~ /^($match_username)\:($match_domain)$/) {
136: ($possuname,$possudom) = ($1,$2);
137: if ($udom eq '') {
138: my $uintdom = &Apache::lonnet::domain($possudom,'primary');
139: if (($uintdom ne '') && (grep(/^\Q$uintdom\E$/,@intdoms))) {
140: $udom = $possudom;
141: $possmapuser = 'lis_person_sourcedid';
142: } else {
143: $udom = $defdom;
144: }
145: } elsif ($udom eq $possudom) {
146: $possmapuser = 'lis_person_sourcedid';
147: }
148: }
149: unless ($possuname) {
150: if ($env{'form.lis_person_sourcedid'} =~ /^$match_username$/) {
151: $possuname = $env{'form.lis_person_sourcedid'};
152: $possmapuser = 'lis_person_sourcedid';
153: } elsif ($env{'form.lis_person_contact_email_primary'} =~ /^$match_username$/) {
154: $possuname = $env{'form.lis_person_contact_email_primary'};
155: $possmapuser = 'lis_person_contact_email_primary';
156: }
157: unless ($udom) {
158: $udom = $defdom;
159: }
160: }
161:
162: #
163: # Determine course's domain in LON-CAPA
164: #
165: # Order is:
166: #
167: # (a) from custom_coursedomain item in POSTed data
1.9 raeburn 168: # (b) from tail of requested URL (after /adm/lti/) if it has format of a symb
1.1 raeburn 169: # (c) from tail of requested URL (after /adm/lti) if it has format of a map
170: # (d) from tail of requested URL (after /adm/lti) if it has format /domain/courseID
1.5 raeburn 171: # (e) from tail of requested URL (after /adm/lti) if it has format /tiny/domain/\w+
172: # i.e., a shortened URL (see bug #6400).
1.1 raeburn 173: # (f) same as user's domain
174: #
175: # Request invalid if custom_coursedomain is defined and is inconsistent with
176: # domain contained in requested URL.
177: #
178: # Note: "internet domain" for course's domain must be one of the
179: # internet domains for the institution's LON-CAPA servers.
180: #
181:
182: if (exists($params->{'custom_coursedomain'})) {
183: if ($params->{'custom_coursedomain'} =~ /^$match_domain$/) {
184: my $cprimary_id = &Apache::lonnet::domain($params->{'custom_coursedomain'},'primary');
185: if ($cprimary_id ne '') {
186: my $cintdom = &Apache::lonnet::internet_dom($cprimary_id);
187: if (($cintdom ne '') && (grep(/^\Q$cintdom\E$/,@intdoms))) {
188: $cdom = $params->{'custom_coursedomain'};
189: }
190: }
191: }
192: }
193:
194: my ($tail) = ($requri =~ m{^/adm/lti(|/.*)$});
195: my $urlcnum;
196: if ($tail ne '') {
197: my $urlcdom;
198: if ($tail =~ m{^/uploaded/($match_domain)/($match_courseid)/(?:default|supplemental)(?:|_\d+)\.(?:sequence|page)(|___\d+___.+)$}) {
199: ($urlcdom,$urlcnum,my $rest) = ($1,$2,$3);
200: if (($cdom ne '') && ($cdom ne $urlcdom)) {
201: &invalid_request($r,3);
202: return OK;
203: }
204: if ($rest eq '') {
205: $mapurl = $tail;
206: } else {
207: $symb = $tail;
208: $symb =~ s{^/+}{};
209: }
1.9 raeburn 210: } elsif ($tail =~ m{^/res/(?:$match_domain)/(?:$match_username)/.+\.(?:sequence|page)(|___\d+___.+)$}) {
211: if ($1 eq '') {
212: $mapurl = $tail;
213: } else {
214: $symb = $tail;
215: $symb =~ s{^/+}{};
216: }
1.1 raeburn 217: } elsif ($tail =~ m{^/($match_domain)/($match_courseid)$}) {
218: ($urlcdom,$urlcnum) = ($1,$2);
219: if (($cdom ne '') && ($cdom ne $urlcdom)) {
220: &invalid_request($r,4);
221: return OK;
222: }
1.5 raeburn 223: } elsif ($tail =~ m{^/tiny/($match_domain)/(\w+)$}) {
224: ($urlcdom,my $key) = ($1,$2);
225: if (($cdom ne '') && ($cdom ne $urlcdom)) {
226: &invalid_request($r,5);
227: return OK;
228: }
229: my $tinyurl;
230: my ($result,$cached)=&Apache::lonnet::is_cached_new('tiny',$urlcdom."\0".$key);
231: if (defined($cached)) {
232: $tinyurl = $result;
233: } else {
234: my $configuname = &Apache::lonnet::get_domainconfiguser($urlcdom);
235: my %currtiny = &Apache::lonnet::get('tiny',[$key],$urlcdom,$configuname);
236: if ($currtiny{$key} ne '') {
237: $tinyurl = $currtiny{$key};
238: &Apache::lonnet::do_cache_new('tiny',$urlcdom."\0".$key,$currtiny{$key},600);
239: }
240: }
241: if ($tinyurl ne '') {
242: $urlcnum = (split(/\&/,$tinyurl))[0];
243: }
1.1 raeburn 244: }
245: if (($cdom eq '') && ($urlcdom ne '')) {
246: my $cprimary_id = &Apache::lonnet::domain($urlcdom,'primary');
247: if ($cprimary_id ne '') {
248: my $cintdom = &Apache::lonnet::internet_dom($cprimary_id);
249: if (($cintdom ne '') && (grep(/^\Q$cintdom\E$/,@intdoms))) {
250: $cdom = $urlcdom;
251: }
252: } else {
253: $urlcnum = '';
254: }
255: }
256: }
257: if ($cdom eq '') {
258: if ($udom ne '') {
259: $cdom = $udom;
260: } else {
261: $cdom = $defdom;
262: }
263: }
264:
265: #
266: # Retrieve information for LTI Consumers in course domain
267: # and populate hash -- %lti_by_key -- for which keys
268: # are those defined in domain configuration for LTI.
269: #
270:
271: my %lti = &Apache::lonnet::get_domain_lti($cdom,'provider');
272: unless (keys(%lti) > 0) {
1.5 raeburn 273: &invalid_request($r,6);
1.1 raeburn 274: return OK;
275: }
276: my %lti_by_key;
277: if (keys(%lti)) {
278: foreach my $id (keys(%lti)) {
279: if (ref($lti{$id}) eq 'HASH') {
280: my $key = $lti{$id}{'key'};
281: push(@{$lti_by_key{$key}},$id);
282: }
283: }
284: }
285:
286: #
287: # Verify the signed request using the secret for those
288: # Consumers for which the key in the POSTed data matches
289: # keys in the domain configuration for LTI.
290: #
291: my $hostname = $r->hostname;
292: my $protocol = 'http';
293: if ($ENV{'SERVER_PORT'} == 443) {
294: $protocol = 'https';
295: }
296:
1.12 raeburn 297: if (exists($params->{'oauth_callback'})) {
298: $Net::OAuth::PROTOCOL_VERSION = Net::OAuth::PROTOCOL_VERSION_1_0A;
299: } else {
300: $Net::OAuth::PROTOCOL_VERSION = Net::OAuth::PROTOCOL_VERSION_1_0;
301: }
302:
1.6 raeburn 303: my ($itemid,$consumer_key,$secret);
1.3 raeburn 304: $consumer_key = $params->{'oauth_consumer_key'};
305: if (ref($lti_by_key{$consumer_key}) eq 'ARRAY') {
306: foreach my $id (@{$lti_by_key{$consumer_key}}) {
1.1 raeburn 307: if (ref($lti{$id}) eq 'HASH') {
1.2 raeburn 308: $secret = $lti{$id}{'secret'};
1.1 raeburn 309: my $request = Net::OAuth->request('request token')->from_hash($params,
310: request_url => $protocol.'://'.$hostname.$requri,
311: request_method => $env{'request.method'},
312: consumer_secret => $secret,);
313: if ($request->verify()) {
314: $itemid = $id;
315: last;
316: }
317: }
318: }
319: }
320:
321: #
322: # Request is invalid if the signed request could not be verified
323: # for the Consumer key and Consumer secret from the domain
324: # configuration in LON-CAPA for that LTI Consumer.
325: #
326: unless (($itemid) && (ref($lti{$itemid}) eq 'HASH')) {
1.5 raeburn 327: &invalid_request($r,7);
1.1 raeburn 328: return OK;
329: }
330:
331: #
332: # Determine if nonce in POSTed data has expired.
333: # If unexpired, confirm it has not already been used.
334: #
1.2 raeburn 335: unless (&LONCAPA::ltiutils::check_nonce($params->{'oauth_nonce'},$params->{'oauth_timestamp'},
336: $lti{$itemid}{'lifetime'},$cdom,$r->dir_config('lonLTIDir'))) {
1.5 raeburn 337: &invalid_request($r,8);
1.1 raeburn 338: return OK;
339: }
340:
341: #
1.6 raeburn 342: # Determine if source of username matches requirement from the
1.1 raeburn 343: # domain configuration for the specific LTI Consumer.
344: #
345:
346: if ($lti{$itemid}{'mapuser'} eq $possmapuser) {
347: $uname = $possuname;
348: } elsif ($lti{$itemid}{'mapuser'} eq 'lis_person_sourcedid') {
349: if ($params->{'lis_person_sourcedid'} =~ /^$match_username$/) {
350: $uname = $possuname;
351: }
352: } elsif ($lti{$itemid}{'mapuser'} eq 'lis_person_contact_email_primary') {
353: if ($params->{'lis_person_contact_email_primary'} =~ /^$match_username$/) {
354: $uname = $params->{'lis_person_contact_email_primary'};
355: }
356: } elsif (exists($params->{$lti{$itemid}{'mapuser'}})) {
357: if ($params->{$lti{$itemid}{'mapuser'}} =~ /^$match_username$/) {
358: $uname = $params->{$lti{$itemid}{'mapuser'}};
359: }
360: }
361:
362: #
363: # Determine the courseID of the LON-CAPA course to which the
364: # launch of LON-CAPA should provide access.
365: #
366: # Order is:
367: #
368: # (a) from course mapping (if the link between Consumer "course" and
369: # Provider "course" has been established previously).
1.9 raeburn 370: # (b) from tail of requested URL (after /adm/lti/) if it has format of a symb
1.1 raeburn 371: # (c) from tail of requested URL (after /adm/lti) if it has format of a map
372: # (d) from tail of requested URL (after /adm/lti) if it has format /domain/courseID
1.5 raeburn 373: # (e) from tail of requested URL (after /adm/lti) if it has format /tiny/domain/\w+
374: # i.e., a shortened URL (see bug #6400).
1.1 raeburn 375: #
376: # If Consumer course included in POSTed data points as a target course which
377: # has a format which matches a LON-CAPA courseID, but the course does not
378: # exist, the request is invalid.
379: #
380:
381: my ($sourcecrs,%consumers);
382: if ($lti{$itemid}{'mapcrs'} eq 'course_offering_sourcedid') {
383: $sourcecrs = $params->{'course_offering_sourcedid'};
384: } elsif ($lti{$itemid}{'mapcrs'} eq 'context_id') {
385: $sourcecrs = $params->{'context_id'};
386: } elsif ($lti{$itemid}{'mapcrs'} ne '') {
387: $sourcecrs = $params->{$lti{$itemid}{'mapcrs'}};
388: }
389:
390: my $posscnum;
391: if ($sourcecrs ne '') {
392: %consumers = &Apache::lonnet::get_dom('lticonsumers',[$sourcecrs],$cdom);
393: if (exists($consumers{$sourcecrs})) {
394: if ($consumers{$sourcecrs} =~ /^$match_courseid$/) {
395: my $crshome = &Apache::lonnet::homeserver($consumers{$sourcecrs},$cdom);
396: if ($crshome =~ /(con_lost|no_host|no_such_host)/) {
1.5 raeburn 397: &invalid_request($r,9);
1.1 raeburn 398: return OK;
399: } else {
400: $posscnum = $consumers{$sourcecrs};
401: }
402: }
403: }
404: }
405:
406: if ($urlcnum ne '') {
407: if ($posscnum ne '') {
408: if ($posscnum ne $urlcnum) {
1.5 raeburn 409: &invalid_request($r,10);
1.1 raeburn 410: return OK;
411: } else {
412: $cnum = $posscnum;
413: }
414: } else {
415: my $crshome = &Apache::lonnet::homeserver($urlcnum,$cdom);
416: if ($crshome =~ /(con_lost|no_host|no_such_host)/) {
1.5 raeburn 417: &invalid_request($r,11);
1.1 raeburn 418: return OK;
419: } else {
420: $cnum = $urlcnum;
421: }
422: }
423: } elsif ($posscnum ne '') {
424: $cnum = $posscnum;
425: }
426:
427: #
1.6 raeburn 428: # Get LON-CAPA role(s) to use from role-mapping of Consumer roles
1.1 raeburn 429: # defined in domain configuration for the appropriate LTI
430: # Consumer.
431: #
1.6 raeburn 432: # If multiple LON-CAPA roles are indicated for the current user,
433: # ordering (from first to last) is: cc/co, in, ta, ep, st.
1.1 raeburn 434: #
435:
1.6 raeburn 436: my (@ltiroles,@lcroles);
437: my @lcroleorder = ('cc','in','ta','ep','st');
1.13 raeburn 438: my ($lcrolesref,$ltirolesref) = &LONCAPA::ltiutils::get_lc_roles($params->{'roles'},
1.14 ! raeburn 439: \@lcroleorder,
! 440: $lti{$itemid}{maproles});
1.13 raeburn 441: if (ref($lcrolesref) eq 'ARRAY') {
442: @lcroles = @{$lcrolesref};
1.1 raeburn 443: }
1.13 raeburn 444: if (ref($ltirolesref) eq 'ARRAY') {
445: @ltiroles = @{$ltirolesref};
1.1 raeburn 446: }
447:
448: #
449: # If no LON-CAPA username -- is user allowed to create one?
450: #
451:
452: my $selfcreate;
453: if (($uname ne '') && ($udom ne '')) {
454: $uhome = &Apache::lonnet::homeserver($uname,$udom);
455: if ($uhome =~ /(con_lost|no_host|no_such_host)/) {
456: &Apache::lonnet::logthis(" LTI authorized unknown user $uname:$udom ");
457: if (ref($lti{$itemid}{'makeuser'}) eq 'ARRAY') {
458: if (@{$lti{$itemid}{'makeuser'}} > 0) {
459: foreach my $ltirole (@ltiroles) {
460: if (grep(/^\Q$ltirole\E$/,@{$lti{$itemid}{'makeuser'}})) {
461: $selfcreate = 1;
1.6 raeburn 462: last;
1.1 raeburn 463: }
464: }
465: }
466: }
467: if ($selfcreate) {
1.13 raeburn 468: my (%rulematch,%inst_results,%curr_rules,%got_rules,%alerts);
469: my $domdesc = &Apache::lonnet::domain($udom,'description');
470: my %data = (
471: 'permanentemail' => $env{'form.lis_person_contact_email_primary'},
472: 'firstname' => $env{'form.lis_person_name_given'},
473: 'lastname' => $env{'form.lis_person_name_family'},
474: 'fullname' => $env{'form.lis_person_name_full'},
475: );
476: my $result =
477: &LONCAPA::ltiutils::create_user($lti{$itemid},$uname,$udom,
478: $domdesc,\%data,\%alerts,\%rulematch,
479: \%inst_results,\%curr_rules,%got_rules);
480: if ($result eq 'notallowed') {
1.6 raeburn 481: &invalid_request($r,12);
1.13 raeburn 482: } elsif ($result eq 'ok') {
1.6 raeburn 483: if (($ltiroles[0] eq 'Instructor') && ($lcroles[0] eq 'cc') && ($lti{$itemid}{'mapcrs'}) &&
484: ($lti{$itemid}{'makecrs'})) {
485: unless (&Apache::lonnet::usertools_access($uname,$udom,'lti','reload','requestcourses')) {
1.10 raeburn 486: &Apache::lonnet::put('environment',{ 'requestcourses.lti' => 'autolimit=', },$udom,$uname);
1.6 raeburn 487: }
488: }
489: } else {
490: &invalid_request($r,13);
491: return OK;
492: }
1.1 raeburn 493: } else {
1.6 raeburn 494: &invalid_request($r,14);
1.1 raeburn 495: return OK;
1.6 raeburn 496: }
497: }
1.1 raeburn 498: } else {
1.6 raeburn 499: &invalid_request($r,15);
1.1 raeburn 500: return OK;
501: }
502:
503: #
504: # If no LON-CAPA course available, check if domain's configuration
505: # for the specific LTI Consumer allows a new course to be created
1.6 raeburn 506: # (requires role in Consumer to be: Instructor and Instructor to map to CC)
1.1 raeburn 507: #
508:
1.6 raeburn 509: my $reqcrs;
1.1 raeburn 510: if ($cnum eq '') {
1.6 raeburn 511: if ((@ltiroles) && ($lti{$itemid}{'mapcrs'}) &&
512: ($ltiroles[0] eq 'Instructor') && ($lcroles[0] eq 'cc') && ($lti{$itemid}{'makecrs'})) {
513: my (%can_request,%request_domains);
514: &Apache::lonnet::check_can_request($cdom,\%can_request,\%request_domains,$uname,$udom);
515: if ($can_request{'lti'}) {
516: $reqcrs = 1;
517: <i_session($r,$itemid,$uname,$udom,$uhome,$lonhost,undef,$mapurl,$tail,
518: $symb,$cdom,$cnum,$params,\@ltiroles,$lti{$itemid},\@lcroles,
519: $reqcrs,$sourcecrs);
520: } else {
521: &invalid_request($r,16);
522: }
1.1 raeburn 523: } else {
1.6 raeburn 524: &invalid_request($r,17);
1.1 raeburn 525: }
1.6 raeburn 526: return OK;
1.1 raeburn 527: }
528:
529: #
530: # If LON-CAPA course is a Community, and LON-CAPA role
531: # indicated is cc, change role indicated to co.
532: #
533:
1.6 raeburn 534: my %crsenv;
535: if ($lcroles[0] eq 'cc') {
1.1 raeburn 536: if (($cdom ne '') && ($cnum ne '')) {
1.6 raeburn 537: %crsenv = &Apache::lonnet::coursedescription($cdom.'_'.$cnum,{ 'one_time' => 1,});
1.1 raeburn 538: if ($crsenv{'type'} eq 'Community') {
1.6 raeburn 539: $lcroles[0] = 'co';
540: }
541: }
542: }
543:
544: #
545: # Determine if user has a LON-CAPA role in the mapped LON-CAPA course.
546: # If multiple LON-CAPA roles are available for the user's assigned LTI roles,
547: # choose the first available LON-CAPA role in the order: cc/co, in, ta, ep, st
548: #
549:
550: my ($role,$usec,$withsec);
551: unless ((($lcroles[0] eq 'cc') || ($lcroles[0] eq 'co')) && (@lcroles == 1)) {
552: if ($lti{$itemid}{'section'} ne '') {
553: if ($lti{$itemid}{'section'} eq 'course_section_sourcedid') {
554: if ($env{'form.course_section_sourcedid'} !~ /\W/) {
555: $usec = $env{'form.course_section_sourcedid'};
556: }
557: } elsif ($env{'form.'.$lti{$itemid}{'section'}} !~ /\W/) {
558: $usec = $env{'form.'.$lti{$itemid}{'section'}};
559: }
560: }
561: if ($usec ne '') {
562: $withsec = 1;
563: }
564: }
565:
566: if (@lcroles) {
567: my %crsroles = &Apache::lonnet::get_my_roles($uname,$udom,'userroles',undef,\@lcroles,
568: [$cdom],$withsec);
569: foreach my $reqrole (@lcroles) {
570: if ($withsec) {
571: my $incsec;
572: if (($reqrole eq 'cc') || ($reqrole eq 'co')) {
573: $incsec = '';
574: } else {
575: $incsec = $usec;
576: }
577: if (exists($crsroles{$cnum.':'.$cdom.':'.$reqrole.':'.$incsec})) {
578: $role = $reqrole.'./'.$cdom.'/'.$cnum;
579: if ($incsec ne '') {
580: $role .= '/'.$usec;
581: }
582: last;
583: }
584: } else {
585: if (exists($crsroles{$cnum.':'.$cdom.':'.$reqrole})) {
586: $role = $reqrole.'./'.$cdom.'/'.$cnum;
587: last;
588: }
1.1 raeburn 589: }
590: }
591: }
592:
593: #
1.6 raeburn 594: # Determine if user can selfenroll
1.1 raeburn 595: #
596:
1.6 raeburn 597: my ($reqrole,$selfenrollrole);
598: if ($role eq '') {
599: if ((@ltiroles) && (ref($lti{$itemid}{'selfenroll'}) eq 'ARRAY')) {
600: foreach my $ltirole (@ltiroles) {
601: if (grep(/^\Q$ltirole\E$/,@{$lti{$itemid}{'selfenroll'}})) {
602: if (ref($lti{$itemid}{maproles}) eq 'HASH') {
603: $reqrole = $lti{$itemid}{maproles}{$ltirole};
604: last;
605: }
606: }
607: }
608: }
609: if ($reqrole eq '') {
610: &invalid_request($r,18);
1.1 raeburn 611: return OK;
612: } else {
1.6 raeburn 613: unless (%crsenv) {
614: %crsenv = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);
615: }
616: my $default_enrollment_start_date = $crsenv{'default_enrollment_start_date'};
617: my $default_enrollment_end_date = $crsenv{'default_enrollment_end_date'};
618: my $now = time;
619: if ($default_enrollment_end_date && $default_enrollment_end_date <= $now) {
620: &invalid_request($r,19);
621: return OK;
622: } elsif ($default_enrollment_start_date && $default_enrollment_start_date >$now) {
623: &invalid_request($r,20);
624: return OK;
625: } else {
626: $selfenrollrole = $reqrole.'./'.$cdom.'/'.$cnum;
627: if (($withsec) && ($reqrole ne 'cc') && ($reqrole ne 'co')) {
628: if ($usec ne '') {
629: $selfenrollrole .= '/'.$usec;
630: }
631: }
632: }
1.1 raeburn 633: }
634: }
635:
636: #
637: # Store consumer-to-LON-CAPA course mapping
638: #
1.6 raeburn 639:
1.1 raeburn 640: if (($sourcecrs ne '') && ($consumers{$sourcecrs} eq '') && ($cnum ne '')) {
641: &Apache::lonnet::put_dom('lticonsumers',{ $sourcecrs => $cnum },$cdom);
642: }
643:
644: #
1.6 raeburn 645: # Start user session
646: #
647:
648: <i_session($r,$itemid,$uname,$udom,$uhome,$lonhost,$role,$mapurl,$tail,$symb,
649: $cdom,$cnum,$params,\@ltiroles,$lti{$itemid},\@lcroles,undef,$sourcecrs,
650: $selfenrollrole);
651: return OK;
652: }
653:
654: sub lti_enroll {
655: my ($uname,$udom,$selfenrollrole) = @_;
656: my $enrollresult;
657: my ($role,$cdom,$cnum,$sec) =
658: ($selfenrollrole =~ m{^(\w+)\./($match_domain)/($match_courseid)(?:|/(\w*))$});
659: if (($cnum ne '') && ($cdom ne '')) {
660: my $chome = &Apache::lonnet::homeserver($cnum,$cdom);
661: if ($chome ne 'no_host') {
662: my %coursehash = &Apache::lonnet::coursedescription($cdom.'_'.$cnum);
663: my $start = $coursehash{'default_enrollment_start_date'};
664: my $end = $coursehash{'default_enrollment_end_date'};
1.14 ! raeburn 665: $enrollresult = &LONCAPA::ltiutils::enrolluser($udom,$uname,$role,$cdom,$cnum,$sec,
! 666: $start,$end,1);
1.6 raeburn 667: }
668: }
669: return $enrollresult;
670: }
671:
672: sub lti_reqcrs {
673: my ($r,$cdom,$form,$uname,$udom) = @_;
674: my (%can_request,%request_domains);
675: &Apache::lonnet::check_can_request($cdom,\%can_request,\%request_domains,$uname,$udom);
676: if ($can_request{'lti'}) {
677: my %domconfig = &Apache::lonnet::get_dom('configuration',['requestcourses'],$cdom);
678: my %domdefs = &Apache::lonnet::get_domain_defaults($cdom);
679: &Apache::lonrequestcourse::print_textbook_form($r,$cdom,[$cdom],\%domdefs,
680: $domconfig{'requestcourses'},
681: \%can_request,'lti',$form);
682: } else {
683: $r->print(
684: &Apache::loncommon::start_page('Invalid LTI call',undef,{'only_body' => 1}).
685: &mt('Invalid LTI call').
686: &Apache::loncommon::end_page()
687: );
688: }
689: }
690:
691: sub lti_session {
692: my ($r,$itemid,$uname,$udom,$uhome,$lonhost,$role,$mapurl,$tail,$symb,$cdom,$cnum,
693: $params,$ltiroles,$ltihash,$lcroles,$reqcrs,$sourcecrs,$selfenrollrole) = @_;
694: return unless ((ref($params) eq 'HASH') && (ref($ltiroles) eq 'ARRAY') &&
695: (ref($ltihash) eq 'HASH') && (ref($lcroles) eq 'ARRAY'));
696: #
1.1 raeburn 697: # Check if user should be hosted here or switched to another server.
698: #
699: $r->user($uname);
1.6 raeburn 700: if ($cnum) {
701: if ($role) {
702: &Apache::lonnet::logthis(" LTI authorized user ($itemid): $uname:$udom, role: $role, course: $cdom\_$cnum");
703: } elsif ($selfenrollrole =~ m{^(\w+)\./$cdom/$cnum}) {
704: &Apache::lonnet::logthis(" LTI authorized user ($itemid): $uname:$udom, desired role: $1 course: $cdom\_$cnum");
705: }
706: } else {
707: &Apache::lonnet::logthis(" LTI authorized user ($itemid): $uname:$udom, course dom: $cdom");
708: }
1.1 raeburn 709: my ($is_balancer,$otherserver,$hosthere);
710: ($is_balancer,$otherserver) =
711: &Apache::lonnet::check_loadbalancing($uname,$udom,'login');
712: if ($is_balancer) {
713: if ($otherserver eq '') {
714: my $lowest_load;
715: ($otherserver,undef,undef,undef,$lowest_load) = &Apache::lonnet::choose_server($udom);
716: if ($lowest_load > 100) {
717: $otherserver = &Apache::lonnet::spareserver($lowest_load,$lowest_load,1,$udom);
718: }
719: }
720: if ($otherserver ne '') {
721: my @hosts = &Apache::lonnet::current_machine_ids();
722: if (grep(/^\Q$otherserver\E$/,@hosts)) {
723: $hosthere = $otherserver;
724: }
725: }
726: }
727: if (($is_balancer) && (!$hosthere)) {
728: # login but immediately go to switch server.
729: &Apache::lonauth::success($r,$uname,$udom,$uhome,'noredirect');
730: if ($symb) {
731: $env{'form.symb'} = $symb;
1.8 raeburn 732: $env{'request.lti.uri'} = $symb;
1.6 raeburn 733: } else {
734: if ($mapurl) {
735: $env{'form.origurl'} = $mapurl;
1.8 raeburn 736: $env{'request.lti.uri'} = $mapurl;
1.6 raeburn 737: } elsif ($tail =~ m{^\Q/tiny/$cdom/\E\w+$}) {
738: $env{'form.origurl'} = $tail;
1.8 raeburn 739: $env{'request.lti.uri'} = $tail;
1.9 raeburn 740: } elsif ($tail eq "/$cdom/$cnum") {
741: $env{'form.origurl'} = '/adm/navmaps';
742: $env{'request.lti.uri'} = $tail;
1.6 raeburn 743: } else {
744: unless ($tail eq '/adm/roles') {
745: $env{'form.origurl'} = '/adm/navmaps';
746: }
747: }
1.1 raeburn 748: }
749: if ($role) {
750: $env{'form.role'} = $role;
751: }
1.6 raeburn 752: if (($lcroles->[0] eq 'cc') && ($reqcrs)) {
753: $env{'request.lti.reqcrs'} = 1;
754: $env{'request.lti.reqrole'} = 'cc';
755: $env{'request.lti.sourcecrs'} = $sourcecrs;
756: }
757: if ($selfenrollrole) {
758: $env{'request.lti.selfenroll'} = $selfenrollrole;
759: $env{'request.lti.sourcecrs'} = $sourcecrs;
760: }
761: if ($ltihash->{'passback'}) {
1.1 raeburn 762: if ($params->{'lis_result_sourcedid'}) {
763: $env{'request.lti.passbackid'} = $params->{'lis_result_sourcedid'};
764: }
765: if ($params->{'lis_outcome_service_url'}) {
766: $env{'request.lti.passbackurl'} = $params->{'lis_outcome_service_url'};
767: }
768: }
1.6 raeburn 769: if (($ltihash->{'roster'}) && (grep(/^Instructor$/,@{$ltiroles}))) {
1.1 raeburn 770: if ($params->{'ext_ims_lis_memberships_id'}) {
1.6 raeburn 771: $env{'request.lti.rosterid'} = $params->{'ext_ims_lis_memberships_id'};
1.1 raeburn 772: }
773: if ($params->{'ext_ims_lis_memberships_url'}) {
774: $env{'request.lti.rosterurl'} = $params->{'ext_ims_lis_memberships_url'};
775: }
776: }
1.10 raeburn 777: $env{'request.lti.login'} = $itemid;
1.8 raeburn 778: if ($params->{'launch_presentation_document_target'}) {
779: $env{'request.lti.target'} = $params->{'launch_presentation_document_target'};
780: }
1.1 raeburn 781: foreach my $key (%{$params}) {
782: delete($env{'form.'.$key});
783: }
784: my $redirecturl = '/adm/switchserver';
785: if ($otherserver ne '') {
786: $redirecturl .= '?otherserver='.$otherserver;
787: }
788: $r->internal_redirect($redirecturl);
789: $r->set_handlers('PerlHandler'=> undef);
790: } else {
791: # need to login them in, so generate the need data that
792: # migrate expects to do login
793: foreach my $key (%{$params}) {
794: delete($env{'form.'.$key});
795: }
796: my $ip = $r->get_remote_host();
797: my %info=('ip' => $ip,
798: 'domain' => $udom,
799: 'username' => $uname,
800: 'server' => $lonhost,
1.10 raeburn 801: 'lti.login' => $itemid,
1.8 raeburn 802: 'lti.uri' => $tail,
1.1 raeburn 803: );
804: if ($role) {
805: $info{'role'} = $role;
806: }
807: if ($symb) {
1.6 raeburn 808: $info{'symb'} = $symb;
809: }
810: if (($lcroles->[0] eq 'cc') && ($reqcrs)) {
811: $info{'lti.reqcrs'} = 1;
812: $info{'lti.reqrole'} = 'cc';
813: $info{'lti.sourcecrs'} = $sourcecrs;
814: }
815: if ($selfenrollrole) {
816: $info{'lti.selfenrollrole'} = $selfenrollrole;
1.1 raeburn 817: }
1.6 raeburn 818: if ($ltihash->{'passback'}) {
1.1 raeburn 819: if ($params->{'lis_result_sourcedid'}) {
820: $info{'lti.passbackid'} = $params->{'lis_result_sourcedid'}
821: }
822: if ($params->{'lis_outcome_service_url'}) {
823: $info{'lti.passbackurl'} = $params->{'lis_outcome_service_url'}
824: }
825: }
1.6 raeburn 826: if (($ltihash->{'roster'}) && (grep(/^Instructor$/,@{$ltiroles}))) {
1.1 raeburn 827: if ($params->{'ext_ims_lis_memberships_id'}) {
828: $info{'lti.rosterid'} = $params->{'ext_ims_lis_memberships_id'};
829: }
830: if ($params->{'ext_ims_lis_memberships_url'}) {
831: $info{'lti.rosterurl'} = $params->{'ext_ims_lis_memberships_url'};
832: }
833: }
1.8 raeburn 834: if ($params->{'launch_presentation_document_target'}) {
835: $info{'lti.target'} = $params->{'launch_presentation_document_target'};
836: }
837:
1.1 raeburn 838: unless ($info{'symb'}) {
839: if ($mapurl) {
840: $info{'origurl'} = $mapurl;
1.6 raeburn 841: } elsif ($tail =~ m{^\Q/tiny/$cdom/\E\w+$}) {
842: $info{'origurl'} = $tail;
1.1 raeburn 843: } else {
844: unless ($tail eq '/adm/roles') {
845: $info{'origurl'} = '/adm/navmaps';
846: }
847: }
848: }
849: if (($is_balancer) && ($hosthere)) {
850: $info{'noloadbalance'} = $hosthere;
851: }
852: my $token = &Apache::lonnet::tmpput(\%info,$lonhost);
853: $env{'form.token'} = $token;
854: $r->internal_redirect('/adm/migrateuser');
855: $r->set_handlers('PerlHandler'=> undef);
856: }
1.6 raeburn 857: return;
1.1 raeburn 858: }
859:
860: sub invalid_request {
861: my ($r,$num) = @_;
862: &Apache::loncommon::content_type($r,'text/html');
863: $r->send_http_header;
864: if ($r->header_only) {
865: return;
866: }
867: &Apache::lonlocal::get_language_handle($r);
868: $r->print(
1.10 raeburn 869: &Apache::loncommon::start_page('Invalid LTI call','',{ 'only_body' => 1,}).
1.1 raeburn 870: &mt('Invalid LTI call [_1]',$num).
871: &Apache::loncommon::end_page());
872: return;
873: }
874:
875: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to ltiauth.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / lti