Annotation of loncom/interface/lonexttool.pm, revision 1.27
1.1 raeburn 1: # The LearningOnline Network with CAPA
2: # Launch External Tool Provider (LTI)
3: #
1.27 ! raeburn 4: # $Id: lonexttool.pm,v 1.26 2025/03/15 01:03:33 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: =pod
30:
31: =head1 NAME
32:
33: Apache::lonexttool - Tool Provider launcher
34:
35: =head1 SYNOPSIS
36:
37:
38: =head1 OVERVIEW
39:
40: =cut
41:
42: package Apache::lonexttool;
43:
44: use strict;
45: use Apache::Constants qw(:common :http);
46: use Encode;
47: use Digest::SHA;
48: use HTML::Entities;
49: use Apache::lonlocal;
50: use Apache::lonnet;
51: use Apache::loncommon;
1.12 raeburn 52: use Apache::londatecheck;
53: use Apache::lonipcheck;
54: use Apache::lonhomework;
55: use Apache::structuretags;
1.9 raeburn 56: use LONCAPA::ltiutils;
1.1 raeburn 57:
58: sub handler {
59: my $r=shift;
60: &Apache::loncommon::content_type($r,'text/html');
61: $r->send_http_header;
62:
63: return OK if $r->header_only;
64:
65: my $target=$env{'form.grade_target'};
66: # ------------------------------------------------------------ Print the screen
67: if ($target eq 'tex') {
68: $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
1.12 raeburn 69: } else {
70: $target = 'web';
1.1 raeburn 71: }
72:
73: # Is this even in a course?
74: unless ($env{'request.course.id'}) {
75: if ($target ne 'tex') {
1.11 raeburn 76: &Apache::loncommon::simple_error_page($r,'','Not in a course',
77: {'only_body' => 1});
1.1 raeburn 78: } else {
79: $r->print('\textbf{Not in a course}\end{document}');
80: }
81: return OK;
82: }
83:
1.3 raeburn 84: my ($marker,$exttool) = (split(m{/},$r->uri))[4,5];
1.1 raeburn 85: $marker=~s/\D//g;
86:
87: if (!$marker) {
88: if ($target ne 'tex') {
1.3 raeburn 89: $r->print(&mt('Invalid Call'));
1.1 raeburn 90: } else {
1.3 raeburn 91: $r->print('\textbf{'&mt('Invalid Call').'}\end{document}');
1.1 raeburn 92: }
93: return OK;
94: }
95:
96: my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
97: my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
98: my $chome = $env{'course.'.$env{'request.course.id'}.'.home'};
1.24 raeburn 99: my ($idx,$crstool,$is_tool,%toolhash,%toolsettings);
1.1 raeburn 100:
1.3 raeburn 101: if ($r->uri eq "/adm/$cdom/$cnum/$marker/$exttool") {
1.12 raeburn 102: %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum);
1.3 raeburn 103: if ($toolsettings{'id'}) {
1.24 raeburn 104: my %ltitools;
105: if ($toolsettings{'id'} =~ /^c(\d+)$/) {
106: $idx = $1;
107: $crstool = 1;
108: %ltitools = &Apache::lonnet::get_course_lti($cnum,$cdom,'consumer');
109: } else {
110: $idx = $toolsettings{'id'};
111: %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
112: }
1.6 raeburn 113: if (ref($ltitools{$idx}) eq 'HASH') {
1.12 raeburn 114: %toolhash = %{$ltitools{$idx}};
1.3 raeburn 115: $toolhash{'display'} = {
116: target => $toolsettings{'target'},
117: width => $toolsettings{'width'},
118: height => $toolsettings{'height'},
119: };
1.19 raeburn 120: foreach my $item (qw(crslabel crstitle crsappend gradable)) {
1.16 raeburn 121: $toolhash{$item} = $toolsettings{$item};
122: }
1.26 raeburn 123: if ($toolhash{'returnurl'}) {
124: my $gotreturnurl;
125: if (ref($toolhash{'crsconf'}) eq 'HASH') {
126: if ($toolhash{'crsconf'}{'returnurl'}) {
127: foreach my $item (qw(returnurl backtourl)) {
128: $toolhash{$item} = $toolsettings{$item};
129: }
130: $gotreturnurl = 1;
131: }
132: }
133: unless ($gotreturnurl) {
134: $toolhash{'returnurl'} = 'default';
135: }
136: } else {
137: $toolhash{'returnurl'} = 'none';
138: }
1.3 raeburn 139: $is_tool = 1;
1.1 raeburn 140: }
141: }
1.3 raeburn 142: }
143: unless ($is_tool) {
1.1 raeburn 144: if ($target ne 'tex') {
1.3 raeburn 145: $r->print('<div>'.&mt('Invalid Call').'</div>');
1.1 raeburn 146: } else {
1.3 raeburn 147: $r->print('\textbf{'.&mt(Invalid Call).'}\end{document}');
1.1 raeburn 148: }
1.12 raeburn 149: return OK;
150: }
151:
1.15 raeburn 152: my ($symb,$status,$open,$close,$msg,$donebuttonresult,$donemsg);
153: if (($target eq 'tex') || ($toolhash{'gradable'})) {
154: ($symb) = &Apache::lonnet::whichuser();
155: }
156: if ($target eq 'tex') {
157: my $title = &Apache::lonnet::gettitle($symb);
158: $r->print(&mt('External Tool: [_1]','\textit{'.$title.'}').'\\\\');
159: }
1.12 raeburn 160: if ($toolhash{'gradable'}) {
161: $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri);
162: if ($env{'form.markaccess'}) {
1.13 raeburn 163: my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb);
1.12 raeburn 164: my ($timelimit) = split(/_/,$interval[0]);
165: &Apache::lonnet::set_first_access($interval[1],$timelimit);
1.13 raeburn 166: } elsif ($symb && $env{'form.LC_interval_done'} eq 'true') {
167: # Set the event timer to zero if the "done button" was clicked. The button is
168: # part of the doneButton form created in lonmenu.pm
169: ($donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb);
170: undef($env{'form.LC_interval_done'});
171: undef($env{'form.LC_interval_done_proctorpass'});
1.12 raeburn 172: }
1.15 raeburn 173: ($status,$msg) = &gradabletool_access_check($target);
1.12 raeburn 174: undef($Apache::lonhomework::browse);
175: if ($status eq 'SHOW_ANSWER') {
1.15 raeburn 176: $r->print(&display_score($target));
177: if ($target eq 'tex') {
178: $r->print('\end{document}');
179: }
1.12 raeburn 180: return OK;
181: } elsif ($status ne 'CAN_ANSWER') {
1.15 raeburn 182: if ($target eq 'tex') {
183: $r->print('\end{document}');
184: } else {
185: $r->print($msg);
186: }
1.12 raeburn 187: return OK;
188: }
189: } else {
190: my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check();
191: if ($status ne 'OPEN') {
192: if ($target eq 'tex') {
1.15 raeburn 193: $r->print(&mt('Not open to be viewed').'\end{document}');
1.12 raeburn 194: } else {
195: $r->print($msg);
196: }
197: return OK;
198: } else {
199: ($status,$msg)=&Apache::lonipcheck::ip_access_check();
200: if ($status ne 'OPEN') {
201: if ($target eq 'tex') {
1.15 raeburn 202: $r->print(&mt('Not open to be viewed').'\end{document}');
1.12 raeburn 203: } else {
204: $r->print($msg);
205: }
206: return OK;
207: }
208: }
209: }
210: my $launchok = 1;
211: if ($target eq 'tex') {
1.15 raeburn 212: $r->print('\end{document}');
1.12 raeburn 213: } else {
214: my $now = time;
215: if ($toolhash{'passback'}) {
216: if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'grade',$now,
217: \%toolsettings,\%toolhash) eq 'ok') {
218: $toolhash{'gradesecret'} = $toolsettings{'gradesecret'};
219: } else {
220: undef($launchok);
221: }
222: }
223: if ($toolhash{'roster'}) {
224: if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'roster',$now,
225: \%toolsettings,\%toolhash) eq 'ok') {
226: $toolhash{'rostersecret'} = $toolsettings{'rostersecret'};
227: }
228: }
229: my $submittext = &mt('Launch [_1]',$toolhash{'title'});
1.24 raeburn 230: if (($toolhash{'url'} ne '') && ($launchok)) {
1.27 ! raeburn 231: my %lti = <i_params($r,$cnum,$cdom,$marker,$exttool,$idx,$submittext,\%toolhash);
1.12 raeburn 232: my $url = $toolhash{'url'};
233: if ($toolhash{'crsappend'} ne '') {
234: $url .= $toolhash{'crsappend'};
235: }
1.24 raeburn 236: my %info = (
237: method => $toolhash{'sigmethod'},
238: );
239: $r->print(&launch_html($cdom,$cnum,$crstool,$url,$idx,
240: $toolhash{'cipher'},$submittext,\%lti,\%info));
1.12 raeburn 241: } else {
1.24 raeburn 242: $r->print('<div class="LC_warning">'.&mt('External Tool Unavailable').'</div>');
1.12 raeburn 243: }
1.1 raeburn 244: }
245: return OK;
246: }
247:
248: sub lti_params {
1.27 ! raeburn 249: my ($r,$cnum,$cdom,$marker,$exttool,$idx,$submittext,$toolsref) = @_;
1.1 raeburn 250: my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale,
1.6 raeburn 251: $crslabel,$crstitle,$gradesecret,$rostersecret,%fields,%rolesmap,
1.26 raeburn 252: %display,%custom,@userlangs,$incdom,$returnurl,$backtourl);
1.1 raeburn 253: if (ref($toolsref) eq 'HASH') {
254: $version = $toolsref->{'version'};
255: $toolname = $toolsref->{'title'};
256: $passback = $toolsref->{'passback'};
1.6 raeburn 257: $gradesecret = $toolsref->{'gradesecret'};
1.1 raeburn 258: $roster = $toolsref->{'roster'};
1.6 raeburn 259: $rostersecret = $toolsref->{'rostersecret'};
1.1 raeburn 260: $msgtype = $toolsref->{'messagetype'};
1.16 raeburn 261: $incdom = $toolsref->{'incdom'};
1.1 raeburn 262: if (ref($toolsref->{'fields'}) eq 'HASH') {
263: %fields = %{$toolsref->{'fields'}};
264: }
265: if (ref($toolsref->{'roles'}) eq 'HASH') {
266: %rolesmap = %{$toolsref->{'roles'}};
267: }
268: if (ref($toolsref->{'display'}) eq 'HASH') {
269: %display = %{$toolsref->{'display'}};
270: }
271: if (ref($toolsref->{'custom'}) eq 'HASH') {
272: %custom = %{$toolsref->{'custom'}};
273: }
1.4 raeburn 274: $crslabel = $toolsref->{'crslabel'};
275: $crstitle = $toolsref->{'crstitle'};
1.26 raeburn 276: $returnurl = $toolsref->{'returnurl'};
277: $backtourl = $toolsref->{'backtourl'};
1.1 raeburn 278: }
279: if ($version eq '') {
280: $version = 'LTI-1p0';
281: }
282: if ($context_type eq '') {
283: $context_type = 'CourseSection';
284: }
285: if ($msgtype eq '') {
286: $msgtype = 'basic-lti-launch-request';
287: }
1.4 raeburn 288: if ($crslabel eq '') {
1.20 raeburn 289: $crslabel = $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1.4 raeburn 290: }
291: if ($crstitle eq '') {
1.20 raeburn 292: $crstitle = $env{'course.'.$env{'request.course.id'}.'.description'};
1.4 raeburn 293: }
1.1 raeburn 294: my $lonhost = $r->dir_config('lonHostID');
295: my $loncaparev = $r->dir_config('lonVersion');
296: my $uname = $env{'user.name'};
297: my $udom = $env{'user.domain'};
298: my @possroles = qw(Instructor ContentDeveloper TeachingAssistant Learner);
1.3 raeburn 299: my ($roleprefix) = ($env{'request.role'} =~ /^(\w+)\./);
300: my $ltirole = $rolesmap{$roleprefix};
1.1 raeburn 301: unless (grep(/^\Q$ltirole\E$/,@possroles)) {
302: $ltirole = 'Learner';
303: }
1.17 raeburn 304: my @possdigest;
1.23 raeburn 305: my $digest_user = &Encode::decode('UTF-8',$uname.':'.$udom);
1.1 raeburn 306: $digest_user = &Digest::SHA::sha1_hex($digest_user);
1.17 raeburn 307: push(@possdigest,$digest_user);
1.1 raeburn 308: if ($env{'course.'.$env{'request.course.id'}.'.languages'} ne '') {
309: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
310: $env{'course.'.$env{'request.course.id'}.'.languages'}));
311: } else {
1.2 raeburn 312: my %langhash = &Apache::loncommon::getlangs($uname,$udom);
1.1 raeburn 313: if ($langhash{'languages'} ne '') {
314: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
315: } else {
316: my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
317: if ($domdefs{'lang_def'} ne '') {
318: @userlangs = ($domdefs{'lang_def'});
319: }
320: }
321: }
322: if (scalar(@userlangs) == 1) {
323: $locale = $userlangs[0];
324: }
1.26 raeburn 325: my ($title,$digest_symb,$digest_suppurl,$resource_link_id);
1.1 raeburn 326: my ($symb) = &Apache::lonnet::whichuser();
1.27 ! raeburn 327: my $uri = "/adm/$cdom/$cnum/$marker/$exttool";
1.1 raeburn 328: if ($symb) {
1.23 raeburn 329: $digest_symb = &Encode::decode('UTF-8',$symb);
1.1 raeburn 330: $digest_symb = &Digest::SHA::sha1_hex($digest_symb);
1.26 raeburn 331: $resource_link_id = $digest_symb;
1.17 raeburn 332: push(@possdigest,$digest_symb);
1.1 raeburn 333: my $navmap = Apache::lonnavmaps::navmap->new();
334: if (ref($navmap)) {
335: my $res = $navmap->getBySymb($symb);
336: if (ref($res)) {
337: $title = $res->compTitle();
338: }
339: }
1.27 ! raeburn 340: } elsif ($env{'httpref.'.$uri} eq '/adm/coursedoc') {
! 341: $digest_suppurl = &Encode::decode('UTF-8',$uri);
1.26 raeburn 342: $digest_suppurl = &Digest::SHA::sha1_hex($digest_suppurl);
343: $resource_link_id = $digest_suppurl;
1.1 raeburn 344: }
1.4 raeburn 345: my $domdesc = &Apache::lonnet::domain($cdom);
346: my $primary_id = &Apache::lonnet::domain($cdom,'primary');
347: my $int_dom = &Apache::lonnet::internet_dom($primary_id);
1.21 raeburn 348: my $portal_url = &Apache::lonnet::course_portal_url($cnum,$cdom,$r);
1.4 raeburn 349:
1.1 raeburn 350: my %ltiparams = (
351: lti_version => $version,
352: lti_message_type => $msgtype,
353: resource_link_title => $title,
1.26 raeburn 354: resource_link_id => $resource_link_id,
1.1 raeburn 355: tool_consumer_instance_guid => $lonhost,
1.4 raeburn 356: tool_consumer_instance_description => $domdesc,
1.1 raeburn 357: tool_consumer_info_product_family_code => 'loncapa',
1.20 raeburn 358: tool_consumer_instance_name => $int_dom,
1.4 raeburn 359: tool_consumer_instance_url => $portal_url,
1.1 raeburn 360: tool_consumer_info_version => $loncaparev,
361: user_id => $digest_user,
362: roles => $ltirole,
363: context_id => $env{'request.course.id'},
364: context_type => $context_type,
1.4 raeburn 365: context_label => $crslabel,
366: context_title => $crstitle,
1.1 raeburn 367: launch_presentation_locale => $locale,
368: );
1.3 raeburn 369: my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
370: my $crshostname = &Apache::lonnet::hostname($crshome);
1.1 raeburn 371: if ($crshostname) {
1.3 raeburn 372: my $crsprotocol = $Apache::lonnet::protocol{$crshome};
1.1 raeburn 373: unless ($crsprotocol eq 'https') {
374: $crsprotocol = 'http';
1.6 raeburn 375: }
376: if (($passback) || ($roster)) {
1.17 raeburn 377: my (%currdigest,%digesthash);
378: if (@possdigest) {
379: %currdigest = &Apache::lonnet::get('exttools',\@possdigest,
380: $cdom,$cnum);
381: }
1.6 raeburn 382: if ($passback) {
1.8 raeburn 383: $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/passback';
1.1 raeburn 384: $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'};
1.6 raeburn 385: if ($gradesecret) {
1.9 raeburn 386: my $uniqid = $digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'};
1.20 raeburn 387: $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_service_id($gradesecret,$uniqid);
1.6 raeburn 388: }
389: }
390: if ($roster) {
391: if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
1.8 raeburn 392: $ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/roster';
1.6 raeburn 393: if ($rostersecret) {
1.9 raeburn 394: my $uniqid = $digest_symb.':::'.$env{'request.course.id'};
1.10 raeburn 395: $ltiparams{'ext_ims_lis_memberships_id'} = &LONCAPA::ltiutils::get_service_id($rostersecret,$uniqid);
1.6 raeburn 396: }
397: }
398: }
399: if (($digest_symb) && ($gradesecret || $rostersecret)) {
1.17 raeburn 400: unless ((exists($currdigest{$digest_symb})) && ($currdigest{$digest_symb} eq $symb)) {
401: $digesthash{$digest_symb} = $symb;
402: }
1.6 raeburn 403: }
404: if (($passback) && ($gradesecret)) {
1.17 raeburn 405: unless ((exists($currdigest{$digest_user})) && ($currdigest{$digest_user} eq $uname.':'.$udom)) {
406: $digesthash{$digest_user} = $uname.':'.$udom;
407: }
1.6 raeburn 408: }
409: if (keys(%digesthash)) {
410: &Apache::lonnet::put('exttools',\%digesthash,$cdom,$cnum);
1.1 raeburn 411: }
412: }
413: }
414: if ($display{'target'}) {
415: $ltiparams{'launch_presentation_document_target'} = $display{'target'};
416: }
417: if ($display{'width'}) {
418: $ltiparams{'launch_presentation_width'} = $display{'width'};
419: }
420: if ($display{'height'}) {
421: $ltiparams{'launch_presentation_height'} = $display{'height'};
422: }
423: if ($fields{'firstname'}) {
424: $ltiparams{'lis_person_name_given'} = $env{'environment.firstname'};
425: }
426: if ($fields{'lastname'}) {
427: $ltiparams{'lis_person_name_family'} = $env{'environment.lastname'};
428: }
429: if ($fields{'fullname'}) {
430: $ltiparams{'lis_person_name_full'} = &Apache::loncommon::plainname($uname,$udom);
431: }
432: if ($fields{'email'}) {
433: my %emails = &Apache::loncommon::getemails($uname,$udom);
434: my $contact_email;
1.3 raeburn 435: foreach my $type ('permanentemail','critnotification','notification') {
436: if ($emails{$type} =~ /\@/) {
437: $contact_email = $emails{$type};
1.1 raeburn 438: last;
439: }
440: }
1.2 raeburn 441: $ltiparams{'lis_person_contact_email_primary'} = $contact_email;
1.1 raeburn 442: }
1.4 raeburn 443: if ($fields{'user'}) {
1.16 raeburn 444: if ($incdom) {
445: $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom;
446: } else {
447: $ltiparams{'lis_person_sourcedid'} = $uname;
448: }
1.4 raeburn 449: }
1.1 raeburn 450: if (keys(%custom)) {
451: foreach my $key (keys(%custom)) {
1.5 raeburn 452: my $value = $custom{$key};
453: $value =~ s/^\s+|\s+\$//g;
454: if ($value =~ /^\QLONCAPA::env{\E([^\}]+)\}$/) {
455: if (exists($env{$1})) {
456: $value = $env{$1};
457: }
458: }
459: $ltiparams{'custom_'.$key} = $value;
1.1 raeburn 460: }
461: }
462: foreach my $key (keys(%ltiparams)) {
1.23 raeburn 463: $ltiparams{$key} = &Encode::decode('UTF-8',$ltiparams{$key});
1.1 raeburn 464: }
1.3 raeburn 465: $ltiparams{'basiclti_submit'} = $submittext;
1.26 raeburn 466: if ($returnurl eq 'default') {
467: my $hostname = &Apache::lonnet::hostname($r->dir_config('lonHostID'));
468: my $protocol = 'http';
469: my $port = $r->get_server_port();
470: if ($port eq '443') {
471: $protocol = 'https';
472: }
473: if (&Apache::lonnet::get_proxy_alias()) {
474: my $hdrhost = $r->headers_in->get('Host');
475: if ($hdrhost ne '') {
476: $hostname = $r->headers_in->get('Host');
477: }
478: }
479: my $location = $protocol.'://'.$hostname;
480: if ($display{'target'} eq 'iframe') {
481: my $return_url;
482: if ($symb) {
483: my ($map,$id,$url)=&Apache::lonnet::decode_symb($symb);
484: my $mapurl = &Apache::lonnet::clutter($map);
485: my $mapsymb = &Apache::lonnet::symbread($map);
486: if ((&Apache::lonnet::EXT('resource.0.encrypturl',$mapsymb) =~ /^yes$/i) &&
487: (!$env{'request.role.adv'})) {
488: $return_url = &Apache::lonenc::encrypted($mapurl);
489: } else {
490: $return_url = $mapurl;
491: }
492: $return_url .= '?navmap=1';
1.27 ! raeburn 493: } elsif ($env{'httpref.'.$uri} eq '/adm/coursedoc') {
1.26 raeburn 494: $return_url = '/adm/supplemental';
495: } else {
496: $return_url = '/adm/navmaps';
497: }
498: $ltiparams{'launch_presentation_return_url'} = $location.$return_url;
499: } else {
1.27 ! raeburn 500: $uri = '/adm/wrapper'.$uri;
1.26 raeburn 501: if ($env{'request.enc'}) {
502: $uri = &Apache::lonenc::encrypted($uri);
503: }
504: $ltiparams{'launch_presentation_return_url'} = $location.$uri;
505: }
506: } elsif ($returnurl eq 'custom') {
507: if ($backtourl ne '') {
508: $ltiparams{'launch_presentation_return_url'} = $backtourl;
509: }
510: }
1.1 raeburn 511: return %ltiparams;
512: }
513:
514: sub launch_html {
1.24 raeburn 515: my ($cdom,$cnum,$crstool,$url,$idx,$keynum,$submittext,$paramsref,$inforef) = @_;
516: my ($status,$hashref) =
1.25 raeburn 517: &Apache::lonnet::sign_lti($cdom,$cnum,$crstool,'tools','launch',$url,$idx,$keynum,
518: $paramsref,$inforef);
1.24 raeburn 519: unless ($status eq 'ok') {
520: return '<div class="LC_warning">'.&mt('External Tool Unavailable').'</div>';
521: }
1.5 raeburn 522: my $action = &HTML::Entities::encode($url,'<>&"');
1.1 raeburn 523: my $form = <<"END";
524: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
525: <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
526: <body>
527: <div id="LCltiLaunch">
1.5 raeburn 528: <form name="LCltiLaunchForm" id="LCltiLaunchFormId" action="$action" method="post" encType="application/x-www-form-urlencoded">
1.1 raeburn 529: END
530: if (ref($hashref) eq 'HASH') {
531: foreach my $item (keys(%{$hashref})) {
1.3 raeburn 532: my $type = 'hidden';
533: if ($item eq 'basiclti_submit') {
534: $type = 'submit';
535: }
536: $form .= '<input type="'.$type.'" name="'.$item.'" value="'.$hashref->{$item}.'" id="id_'.$item.'" />'."\n";
1.1 raeburn 537: }
538: }
539: $form .= "</form></div>\n";
540: $form .= <<"ENDJS";
541: <script type="text/javascript">
542: document.getElementById("LCltiLaunch").style.display = "none";
543: nei = document.createElement('input');
544: nei.setAttribute('type','hidden');
1.3 raeburn 545: nei.setAttribute('name','basiclti_submit');
1.1 raeburn 546: nei.setAttribute('value','$submittext');
1.3 raeburn 547: document.getElementById("LCltiLaunchFormId").appendChild(nei);
1.1 raeburn 548: document.LCltiLaunchForm.submit();
549: </script>
550: ENDJS
551: $form .= "</body></html>\n";
552: return $form;
553: }
554:
1.12 raeburn 555: sub gradabletool_access_check {
1.15 raeburn 556: my ($target) = @_;
1.12 raeburn 557: my ($result,$resource_due);
558: my $status;
559: my ($symb,$courseid,$udom,$uname) = &Apache::lonnet::whichuser();
560: my @targets;
1.15 raeburn 561: if ($target) {
562: @targets = ($target);
563: } elsif (defined($env{'form.submitted'}) && defined($env{'form.validate'})) {
1.12 raeburn 564: @targets = ('grade','web');
565: } else {
566: @targets = ('web');
567: }
568: foreach my $target (@targets) {
1.18 raeburn 569: &Apache::structuretags::initialize_storage($symb);
1.12 raeburn 570: &Apache::lonhomework::set_show_problem_status(&Apache::lonnet::EXT('resource.0.problemstatus'));
571: my ($accessmsg,$slot_name,$slot,$ipused);
572: ($status,$accessmsg,$slot_name,$slot,$ipused) =
573: &Apache::lonhomework::check_slot_access('0','tool',$symb);
574: if (( $status eq 'CLOSED' ) ||
575: ( $status eq 'UNCHECKEDOUT') ||
576: ( $status eq 'NOT_YET_VIEWED') ||
577: ( $status eq 'BANNED') ||
578: ( $status eq 'UNAVAILABLE') ||
579: ( $status eq 'NOT_IN_A_SLOT') ||
580: ( $status eq 'NOTRESERVABLE') ||
581: ( $status eq 'RESERVABLE') ||
582: ( $status eq 'RESERVABLE_LATER') ||
583: ( $status eq 'INVALID_ACCESS') ||
584: ( $status eq 'NEED_DIFFERENT_IP') ||
585: ( $status eq 'WAITING_FOR_GRADE')) {
586: $result = &Apache::structuretags::access_status_msg('tool',$status,$symb,
587: $target,$ipused,$accessmsg);
588: } elsif ($status eq 'NEEDS_CHECKIN') {
589: $result = &Apache::structuretags::checkin_prompt($target,$slot_name,$slot,'tool');
590: } elsif ($target eq 'web') {
591: if ($status eq 'CAN_ANSWER') {
592: $resource_due = &Apache::lonhomework::due_date(0, $env{'request.symb'});
593: if ($slot_name ne '') {
594: $resource_due = &Apache::structuretags::selfcheckin_resource($resource_due,
595: $slot_name,$slot,
596: $env{'request.symb'});
597: }
598: }
599: }
1.18 raeburn 600: if (keys(%Apache::lonhomework::results)) {
601: &Apache::structuretags::finalize_storage();
602: }
1.12 raeburn 603: }
604: return ($status,$result,$resource_due);
605: }
606:
607: sub display_score {
1.15 raeburn 608: my ($target) = @_;
1.12 raeburn 609: my $weight = &Apache::lonnet::EXT('resource.0.weight');
610: if ((!defined($weight)) || ($weight eq '')) { $weight=1; }
611: my $awarded = $Apache::lonhomework::history{'resource.0.awarded'};
612: if (!defined($awarded)) { $awarded=0; }
613: my $display='';
1.15 raeburn 614: if ($target eq 'tex') {
615: $display = '\\\\';
616: }
1.12 raeburn 617: if (!defined($awarded)) {
1.15 raeburn 618: $display .= &mt('[_1] possible points.',$weight);
1.12 raeburn 619: } else {
620: my $points = $awarded*$weight;
621: my $result = sprintf('%.2f',$points);
1.15 raeburn 622: $display .= &mt('You have [_1] out of [quant,_2,possible point]',
1.12 raeburn 623: $result,$weight);
624: }
625: my $comment = $Apache::lonhomework::history{'resource.0.comment'};
626: if (!defined($comment) || $comment!~/\w/) {
627: $comment='';
628: } else {
1.15 raeburn 629: if ($target eq 'tex') {
630: $comment = '\\\\'.$comment;
631: } else {
632: $comment='<br /><table><tr><td bgcolor="#FFFFDD">'.$comment.'</td></tr></table>';
633: }
1.12 raeburn 634: }
635: my $gradeinfo = $Apache::lonhomework::history{'resource.0.gradeinfo'};
636: if (!defined($gradeinfo) || $gradeinfo!~/\w/) {
637: $gradeinfo='';
638: } else {
1.15 raeburn 639: if ($target eq 'tex') {
640: $gradeinfo = '\\\\'.$gradeinfo;
641: } else {
642: $gradeinfo='<br /><table><tr><td bgcolor="#DDDDFF"><font size="+2">'.$gradeinfo.'</font></td></tr></table>';
643: }
1.12 raeburn 644: }
645: return $display.$comment.$gradeinfo;
646: }
647:
1.1 raeburn 648: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonexttool.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface