--- loncom/interface/lonexttool.pm 2016/01/11 16:42:37 1.1 +++ loncom/interface/lonexttool.pm 2020/04/09 21:11:36 1.20.2.1 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Launch External Tool Provider (LTI) # -# $Id: lonexttool.pm,v 1.1 2016/01/11 16:42:37 raeburn Exp $ +# $Id: lonexttool.pm,v 1.20.2.1 2020/04/09 21:11:36 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -43,13 +43,13 @@ package Apache::lonexttool; use strict; use Apache::Constants qw(:common :http); -use Net::OAuth; use Encode; use Digest::SHA; use HTML::Entities; use Apache::lonlocal; use Apache::lonnet; use Apache::loncommon; +use LONCAPA::ltiutils; sub handler { my $r=shift; @@ -62,27 +62,29 @@ sub handler { # ------------------------------------------------------------ Print the screen if ($target eq 'tex') { $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'})); + } else { + $target = 'web'; } # Is this even in a course? unless ($env{'request.course.id'}) { if ($target ne 'tex') { - &Apache::loncommon::simple_error_page($r,'','Not in a course'); + &Apache::loncommon::simple_error_page($r,'','Not in a course', + {'only_body' => 1}); } else { $r->print('\textbf{Not in a course}\end{document}'); } return OK; } - my $marker = (split(m{/},$r->uri))[4]; + my ($marker,$exttool) = (split(m{/},$r->uri))[4,5]; $marker=~s/\D//g; if (!$marker) { if ($target ne 'tex') { - &Apache::loncommon::simple_error_page($r,'Invalid Call', - 'Invalid Call'); + $r->print(&mt('Invalid Call')); } else { - $r->print('\textbf{Invalid call}\end{document}'); + $r->print('\textbf{'&mt('Invalid Call').'}\end{document}'); } return OK; } @@ -90,54 +92,94 @@ 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); - if ($r->uri eq "/adm/$cdom/$cnum/$marker/exttool") { - my %toolhash=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum); - if ($target eq 'tex') { - $r->print(&mt('External Tool')); - } else { - if (($toolhash{'key'} ne '') && ($toolhash{'secret'} ne '') && ($toolhash{'url'} ne '')) { - my %lti = <i_params($r,\%toolhash); - $r->print(&launch_html($toolhash{'url'},$toolhash{'key'}, - $toolhash{'secret'},$toolhash{'title'},\%lti)); - } else { - &Apache::loncommon::simple_error_page($r,'External Tool Unavailable', - 'External Tool Unavailable'); + 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'); + if (ref($ltitools{$idx}) eq 'HASH') { + %toolhash = %{$ltitools{$idx}}; + $toolhash{'display'} = { + target => $toolsettings{'target'}, + width => $toolsettings{'width'}, + height => $toolsettings{'height'}, + }; + foreach my $item (qw(crslabel crstitle crsappend)) { + $toolhash{$item} = $toolsettings{$item}; + } + $is_tool = 1; } } - } else { + } + unless ($is_tool) { if ($target ne 'tex') { - &Apache::loncommon::simple_error_page($r,'Invalid Call', - 'Invalid Call'); + $r->print('
'.&mt('Invalid Call').'
'); } else { - $r->print('\textbf{Invalid call}\end{document}'); + $r->print('\textbf{'.&mt(Invalid Call).'}\end{document}'); } return OK; } - &print_end_page($r,$target); - return OK; -} - -sub print_end_page { - my ($r,$target) = @_; - if ($target ne 'tex') { - $r->print(&Apache::loncommon::end_page()); + my ($symb,$status,$open,$close,$msg,$donebuttonresult,$donemsg); + if (($target eq 'tex') || ($toolhash{'gradable'})) { + ($symb) = &Apache::lonnet::whichuser(); + } + if ($target eq 'tex') { + my $title = &Apache::lonnet::gettitle($symb); + $r->print(&mt('External Tool: [_1]','\textit{'.$title.'}').'\\\\'); + } + my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check(); + if ($status ne 'OPEN') { + if ($target eq 'tex') { + $r->print(&mt('Not open to be viewed').'\end{document}'); + } else { + $r->print($msg); + } + return OK; } else { + ($status,$msg)=&Apache::lonipcheck::ip_access_check(); + if ($status ne 'OPEN') { + if ($target eq 'tex') { + $r->print(&mt('Not open to be viewed').'\end{document}'); + } else { + $r->print($msg); + } + return OK; + } + } + my $launchok = 1; + if ($target eq 'tex') { $r->print('\end{document}'); + } else { + my $now = time; + 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); + my $url = $toolhash{'url'}; + if ($toolhash{'crsappend'} ne '') { + $url .= $toolhash{'crsappend'}; + } + $r->print(&launch_html($url,$toolhash{'key'},$toolhash{'secret'}, + $toolhash{'sigmethod'},$submittext,\%lti)); + } else { + $r->print('
'.&mt('External Tool Unavailable').'
'); + } } + return OK; } sub lti_params { - my ($r,$toolsref) = @_; + my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_; my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale, - %fields,%rolesmap,%display,%custom,@userlangs); + $crslabel,$crstitle,%fields,%rolesmap,%display,%custom,@userlangs,$incdom); if (ref($toolsref) eq 'HASH') { $version = $toolsref->{'version'}; $toolname = $toolsref->{'title'}; - $passback = $toolsref->{'passback'}; - $roster = $toolsref->{'roster'}; $msgtype = $toolsref->{'messagetype'}; + $incdom = $toolsref->{'incdom'}; if (ref($toolsref->{'fields'}) eq 'HASH') { %fields = %{$toolsref->{'fields'}}; } @@ -150,6 +192,8 @@ sub lti_params { if (ref($toolsref->{'custom'}) eq 'HASH') { %custom = %{$toolsref->{'custom'}}; } + $crslabel = $toolsref->{'crslabel'}; + $crstitle = $toolsref->{'crstitle'}; } if ($version eq '') { $version = 'LTI-1p0'; @@ -160,22 +204,31 @@ sub lti_params { if ($msgtype eq '') { $msgtype = 'basic-lti-launch-request'; } + if ($crslabel eq '') { + $crslabel = $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}; + } + if ($crstitle eq '') { + $crstitle = $env{'course.'.$env{'request.course.id'}.'.description'}; + } my $lonhost = $r->dir_config('lonHostID'); my $loncaparev = $r->dir_config('lonVersion'); my $uname = $env{'user.name'}; my $udom = $env{'user.domain'}; my @possroles = qw(Instructor ContentDeveloper TeachingAssistant Learner); - my $ltirole = $rolesmap{$env{'request.role'}}; + my ($roleprefix) = ($env{'request.role'} =~ /^(\w+)\./); + my $ltirole = $rolesmap{$roleprefix}; unless (grep(/^\Q$ltirole\E$/,@possroles)) { $ltirole = 'Learner'; } + my @possdigest; my $digest_user = &Encode::decode_utf8($uname.':'.$udom); $digest_user = &Digest::SHA::sha1_hex($digest_user); + push(@possdigest,$digest_user); if ($env{'course.'.$env{'request.course.id'}.'.languages'} ne '') { @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/, $env{'course.'.$env{'request.course.id'}.'.languages'})); } else { - my %langhash = &getlangs($uname,$udom); + my %langhash = &Apache::loncommon::getlangs($uname,$udom); if ($langhash{'languages'} ne '') { @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'}); } else { @@ -193,6 +246,7 @@ sub lti_params { if ($symb) { $digest_symb = &Encode::decode_utf8($symb); $digest_symb = &Digest::SHA::sha1_hex($digest_symb); + push(@possdigest,$digest_symb); my $navmap = Apache::lonnavmaps::navmap->new(); if (ref($navmap)) { my $res = $navmap->getBySymb($symb); @@ -201,42 +255,36 @@ sub lti_params { } } } + 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 %ltiparams = ( lti_version => $version, lti_message_type => $msgtype, resource_link_title => $title, resource_link_id => $digest_symb, 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_url => $portal_url, tool_consumer_info_version => $loncaparev, user_id => $digest_user, - lis_person_sourcedid => $uname.':'.$udom, roles => $ltirole, context_id => $env{'request.course.id'}, context_type => $context_type, - context_label => $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'}, - context_title => $env{'course.'.$env{'request.course.id'}.'.description'}, + context_label => $crslabel, + context_title => $crstitle, launch_presentation_locale => $locale, ); - my $crshostname = $env{'course.'.$env{'request.course.id'}.'.home'}; - my $crsprotocol = $Apache::lonnet::protocol{$crshostname}; + my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'}; + my $crshostname = &Apache::lonnet::hostname($crshome); if ($crshostname) { - my $crsprotocol = $Apache::lonnet::protocol{$crshostname}; + my $crsprotocol = $Apache::lonnet::protocol{$crshome}; unless ($crsprotocol eq 'https') { $crsprotocol = 'http'; - } - if ($passback) { - if ($ltirole eq 'Learner') { - $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'//'.$crshostname.'/adm/ltipassback'; - $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'}; - $ltiparams{'lis_result_sourcedid'} = ''; #FIXME - } - } - if ($roster) { - if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) { - $ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'//'.$crshostname.'/adm/ltiroster'; - $ltiparams{'ext_ims_lis_memberships_id'} = ''; #FIXME - } } } if ($display{'target'}) { @@ -260,40 +308,58 @@ sub lti_params { if ($fields{'email'}) { my %emails = &Apache::loncommon::getemails($uname,$udom); my $contact_email; - foreach my $email ('permanentemail','critnotification','notification') { - if ($email =~ /\@/) { - $contact_email = $email; + foreach my $type ('permanentemail','critnotification','notification') { + if ($emails{$type} =~ /\@/) { + $contact_email = $emails{$type}; last; } } - $ltiparams{'lis_person_contact_email_primary'} = &contact_email; + $ltiparams{'lis_person_contact_email_primary'} = $contact_email; + } + if ($fields{'user'}) { + if ($incdom) { + $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom; + } else { + $ltiparams{'lis_person_sourcedid'} = $uname; + } } if (keys(%custom)) { foreach my $key (keys(%custom)) { - $ltiparams{'custom_'.$key} = $custom{$key}; + my $value = $custom{$key}; + $value =~ s/^\s+|\s+\$//g; + if ($value =~ /^\QLONCAPA::env{\E([^\}]+)\}$/) { + if (exists($env{$1})) { + $value = $env{$1}; + } + } + $ltiparams{'custom_'.$key} = $value; } } foreach my $key (keys(%ltiparams)) { $ltiparams{$key} = &Encode::decode_utf8($ltiparams{$key}); } + $ltiparams{'basiclti_submit'} = $submittext; return %ltiparams; } sub launch_html { - my ($url,$key,$secret,$toolname,$paramsref) = @_; - my $hashref = &sign_params($url,$key,$secret,$paramsref); - my $submittext = &mt('Launch [_1]',$toolname); + my ($url,$key,$secret,$sigmethod,$submittext,$paramsref) = @_; + my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$sigmethod,$paramsref); + my $action = &HTML::Entities::encode($url,'<>&"'); my $form = <<"END";
-
- + END if (ref($hashref) eq 'HASH') { foreach my $item (keys(%{$hashref})) { - $form .= ''."\n"; + my $type = 'hidden'; + if ($item eq 'basiclti_submit') { + $type = 'submit'; + } + $form .= ''."\n"; } } $form .= "
\n"; @@ -302,9 +368,9 @@ END document.getElementById("LCltiLaunch").style.display = "none"; nei = document.createElement('input'); nei.setAttribute('type','hidden'); - nei.setAttribute('name','LCbasicltiSubmit'); + nei.setAttribute('name','basiclti_submit'); nei.setAttribute('value','$submittext'); - document.getElementById("LCltiLaunchForm").appendChild(nei); + document.getElementById("LCltiLaunchFormId").appendChild(nei); document.LCltiLaunchForm.submit(); ENDJS @@ -312,23 +378,4 @@ ENDJS return $form; } -sub sign_params { - my ($url,$key,$secret,$paramsref) = @_; - my $nonce = Digest::SHA::sha1_hex(sprintf("%06x%06x",rand(0xfffff0),rand(0xfffff0))); - my $request = Net::OAuth->request("request token")->new( - consumer_key => $key, - consumer_secret => $secret, - request_url => $url, - request_method => 'POST', - signature_method => 'HMAC-SHA1', - timestamp => time, - nonce => $nonce, - callback => 'about:blank', - extra_params => $paramsref, - version => '1.0', - ); - $request->sign; - return $request->to_hash(); -} - 1;