--- loncom/interface/lonexttool.pm 2018/01/04 12:37:49 1.17 +++ loncom/interface/lonexttool.pm 2025/03/15 17:28:14 1.27 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Launch External Tool Provider (LTI) # -# $Id: lonexttool.pm,v 1.17 2018/01/04 12:37:49 raeburn Exp $ +# $Id: lonexttool.pm,v 1.27 2025/03/15 17:28:14 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -96,13 +96,20 @@ sub handler { my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'}; my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'}; my $chome = $env{'course.'.$env{'request.course.id'}.'.home'}; - my ($idx,$is_tool,%toolhash,%toolsettings); + my ($idx,$crstool,$is_tool,%toolhash,%toolsettings); if ($r->uri eq "/adm/$cdom/$cnum/$marker/$exttool") { %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum); if ($toolsettings{'id'}) { - $idx = $toolsettings{'id'}; - my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer'); + my %ltitools; + if ($toolsettings{'id'} =~ /^c(\d+)$/) { + $idx = $1; + $crstool = 1; + %ltitools = &Apache::lonnet::get_course_lti($cnum,$cdom,'consumer'); + } else { + $idx = $toolsettings{'id'}; + %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer'); + } if (ref($ltitools{$idx}) eq 'HASH') { %toolhash = %{$ltitools{$idx}}; $toolhash{'display'} = { @@ -110,9 +117,25 @@ sub handler { width => $toolsettings{'width'}, height => $toolsettings{'height'}, }; - foreach my $item (qw(crslabel crstitle crsappend gradable incdom)) { + foreach my $item (qw(crslabel crstitle crsappend gradable)) { $toolhash{$item} = $toolsettings{$item}; } + if ($toolhash{'returnurl'}) { + my $gotreturnurl; + if (ref($toolhash{'crsconf'}) eq 'HASH') { + if ($toolhash{'crsconf'}{'returnurl'}) { + foreach my $item (qw(returnurl backtourl)) { + $toolhash{$item} = $toolsettings{$item}; + } + $gotreturnurl = 1; + } + } + unless ($gotreturnurl) { + $toolhash{'returnurl'} = 'default'; + } + } else { + $toolhash{'returnurl'} = 'none'; + } $is_tool = 1; } } @@ -204,27 +227,29 @@ sub handler { } } my $submittext = &mt('Launch [_1]',$toolhash{'title'}); - if (($toolhash{'key'} ne '') && ($toolhash{'secret'} ne '') && - ($toolhash{'url'} ne '') && ($launchok)) { - my %lti = <i_params($r,$cnum,$cdom,$idx,$submittext,\%toolhash); + if (($toolhash{'url'} ne '') && ($launchok)) { + my %lti = <i_params($r,$cnum,$cdom,$marker,$exttool,$idx,$submittext,\%toolhash); my $url = $toolhash{'url'}; if ($toolhash{'crsappend'} ne '') { $url .= $toolhash{'crsappend'}; } - $r->print(&launch_html($url,$toolhash{'key'},$toolhash{'secret'}, - $toolhash{'sigmethod'},$submittext,\%lti)); + my %info = ( + method => $toolhash{'sigmethod'}, + ); + $r->print(&launch_html($cdom,$cnum,$crstool,$url,$idx, + $toolhash{'cipher'},$submittext,\%lti,\%info)); } else { - $r->print('
'.&mt('External Tool Unavailable').'
'); + $r->print('
'.&mt('External Tool Unavailable').'
'); } } return OK; } sub lti_params { - my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_; + my ($r,$cnum,$cdom,$marker,$exttool,$idx,$submittext,$toolsref) = @_; my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale, $crslabel,$crstitle,$gradesecret,$rostersecret,%fields,%rolesmap, - %display,%custom,@userlangs,$incdom); + %display,%custom,@userlangs,$incdom,$returnurl,$backtourl); if (ref($toolsref) eq 'HASH') { $version = $toolsref->{'version'}; $toolname = $toolsref->{'title'}; @@ -248,6 +273,8 @@ sub lti_params { } $crslabel = $toolsref->{'crslabel'}; $crstitle = $toolsref->{'crstitle'}; + $returnurl = $toolsref->{'returnurl'}; + $backtourl = $toolsref->{'backtourl'}; } if ($version eq '') { $version = 'LTI-1p0'; @@ -259,10 +286,10 @@ sub lti_params { $msgtype = 'basic-lti-launch-request'; } if ($crslabel eq '') { - $crslabel = $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}, + $crslabel = $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}; } if ($crstitle eq '') { - $crstitle = $env{'course.'.$env{'request.course.id'}.'.description'},; + $crstitle = $env{'course.'.$env{'request.course.id'}.'.description'}; } my $lonhost = $r->dir_config('lonHostID'); my $loncaparev = $r->dir_config('lonVersion'); @@ -275,7 +302,7 @@ sub lti_params { $ltirole = 'Learner'; } my @possdigest; - my $digest_user = &Encode::decode_utf8($uname.':'.$udom); + my $digest_user = &Encode::decode('UTF-8',$uname.':'.$udom); $digest_user = &Digest::SHA::sha1_hex($digest_user); push(@possdigest,$digest_user); if ($env{'course.'.$env{'request.course.id'}.'.languages'} ne '') { @@ -295,11 +322,13 @@ sub lti_params { if (scalar(@userlangs) == 1) { $locale = $userlangs[0]; } - my ($title,$digest_symb); + my ($title,$digest_symb,$digest_suppurl,$resource_link_id); my ($symb) = &Apache::lonnet::whichuser(); + my $uri = "/adm/$cdom/$cnum/$marker/$exttool"; if ($symb) { - $digest_symb = &Encode::decode_utf8($symb); + $digest_symb = &Encode::decode('UTF-8',$symb); $digest_symb = &Digest::SHA::sha1_hex($digest_symb); + $resource_link_id = $digest_symb; push(@possdigest,$digest_symb); my $navmap = Apache::lonnavmaps::navmap->new(); if (ref($navmap)) { @@ -308,21 +337,25 @@ sub lti_params { $title = $res->compTitle(); } } + } elsif ($env{'httpref.'.$uri} eq '/adm/coursedoc') { + $digest_suppurl = &Encode::decode('UTF-8',$uri); + $digest_suppurl = &Digest::SHA::sha1_hex($digest_suppurl); + $resource_link_id = $digest_suppurl; } my $domdesc = &Apache::lonnet::domain($cdom); my $primary_id = &Apache::lonnet::domain($cdom,'primary'); my $int_dom = &Apache::lonnet::internet_dom($primary_id); - my $portal_url = &Apache::lonnet::course_portal_url($cnum,$cdom); + my $portal_url = &Apache::lonnet::course_portal_url($cnum,$cdom,$r); my %ltiparams = ( lti_version => $version, lti_message_type => $msgtype, resource_link_title => $title, - resource_link_id => $digest_symb, + resource_link_id => $resource_link_id, tool_consumer_instance_guid => $lonhost, tool_consumer_instance_description => $domdesc, tool_consumer_info_product_family_code => 'loncapa', - tool_consumer_instance_name => $int_dom, + tool_consumer_instance_name => $int_dom, tool_consumer_instance_url => $portal_url, tool_consumer_info_version => $loncaparev, user_id => $digest_user, @@ -351,7 +384,7 @@ sub lti_params { $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'}; if ($gradesecret) { my $uniqid = $digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'}; - $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_service_id($gradesecret,$uniqid); + $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_service_id($gradesecret,$uniqid); } } if ($roster) { @@ -427,15 +460,65 @@ sub lti_params { } } foreach my $key (keys(%ltiparams)) { - $ltiparams{$key} = &Encode::decode_utf8($ltiparams{$key}); + $ltiparams{$key} = &Encode::decode('UTF-8',$ltiparams{$key}); } $ltiparams{'basiclti_submit'} = $submittext; + if ($returnurl eq 'default') { + my $hostname = &Apache::lonnet::hostname($r->dir_config('lonHostID')); + my $protocol = 'http'; + my $port = $r->get_server_port(); + if ($port eq '443') { + $protocol = 'https'; + } + if (&Apache::lonnet::get_proxy_alias()) { + my $hdrhost = $r->headers_in->get('Host'); + if ($hdrhost ne '') { + $hostname = $r->headers_in->get('Host'); + } + } + my $location = $protocol.'://'.$hostname; + if ($display{'target'} eq 'iframe') { + my $return_url; + if ($symb) { + my ($map,$id,$url)=&Apache::lonnet::decode_symb($symb); + my $mapurl = &Apache::lonnet::clutter($map); + my $mapsymb = &Apache::lonnet::symbread($map); + if ((&Apache::lonnet::EXT('resource.0.encrypturl',$mapsymb) =~ /^yes$/i) && + (!$env{'request.role.adv'})) { + $return_url = &Apache::lonenc::encrypted($mapurl); + } else { + $return_url = $mapurl; + } + $return_url .= '?navmap=1'; + } elsif ($env{'httpref.'.$uri} eq '/adm/coursedoc') { + $return_url = '/adm/supplemental'; + } else { + $return_url = '/adm/navmaps'; + } + $ltiparams{'launch_presentation_return_url'} = $location.$return_url; + } else { + $uri = '/adm/wrapper'.$uri; + if ($env{'request.enc'}) { + $uri = &Apache::lonenc::encrypted($uri); + } + $ltiparams{'launch_presentation_return_url'} = $location.$uri; + } + } elsif ($returnurl eq 'custom') { + if ($backtourl ne '') { + $ltiparams{'launch_presentation_return_url'} = $backtourl; + } + } return %ltiparams; } sub launch_html { - my ($url,$key,$secret,$sigmethod,$submittext,$paramsref) = @_; - my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$sigmethod,$paramsref); + my ($cdom,$cnum,$crstool,$url,$idx,$keynum,$submittext,$paramsref,$inforef) = @_; + my ($status,$hashref) = + &Apache::lonnet::sign_lti($cdom,$cnum,$crstool,'tools','launch',$url,$idx,$keynum, + $paramsref,$inforef); + unless ($status eq 'ok') { + return '
'.&mt('External Tool Unavailable').'
'; + } my $action = &HTML::Entities::encode($url,'<>&"'); my $form = <<"END"; @@ -483,10 +566,7 @@ sub gradabletool_access_check { @targets = ('web'); } foreach my $target (@targets) { - undef(%Apache::lonhomework::results); - undef(%Apache::lonhomework::history); - %Apache::lonhomework::history = - &Apache::lonnet::restore($symb,$courseid,$udom,$uname); + &Apache::structuretags::initialize_storage($symb); &Apache::lonhomework::set_show_problem_status(&Apache::lonnet::EXT('resource.0.problemstatus')); my ($accessmsg,$slot_name,$slot,$ipused); ($status,$accessmsg,$slot_name,$slot,$ipused) = @@ -517,6 +597,9 @@ sub gradabletool_access_check { } } } + if (keys(%Apache::lonhomework::results)) { + &Apache::structuretags::finalize_storage(); + } } return ($status,$result,$resource_due); }