--- loncom/interface/lonexttool.pm 2016/01/26 14:30:25 1.3 +++ loncom/interface/lonexttool.pm 2018/01/31 14:17:44 1.18 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Launch External Tool Provider (LTI) # -# $Id: lonexttool.pm,v 1.3 2016/01/26 14:30:25 raeburn Exp $ +# $Id: lonexttool.pm,v 1.18 2018/01/31 14:17:44 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -43,13 +43,17 @@ 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 Apache::londatecheck; +use Apache::lonipcheck; +use Apache::lonhomework; +use Apache::structuretags; +use LONCAPA::ltiutils; sub handler { my $r=shift; @@ -62,12 +66,15 @@ 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}'); } @@ -89,32 +96,24 @@ 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 $is_tool; + my ($idx,$is_tool,%toolhash,%toolsettings); if ($r->uri eq "/adm/$cdom/$cnum/$marker/$exttool") { - my %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum); + %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum); if ($toolsettings{'id'}) { - my %ltitools = &Apache::lonnet::get_domain_ltitools($cdom); - if (ref($ltitools{$toolsettings{'id'}}) eq 'HASH') { - my %toolhash = %{$ltitools{$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'}, }; - $is_tool = 1; - if ($target eq 'tex') { - $r->print(&mt('External Tool')); - } else { - my $submittext = &mt('Launch [_1]',$toolhash{'title'}); - if (($toolhash{'key'} ne '') && ($toolhash{'secret'} ne '') && ($toolhash{'url'} ne '')) { - my %lti = <i_params($r,$submittext,\%toolhash); - $r->print(&launch_html($toolhash{'url'},$toolhash{'key'}, - $toolhash{'secret'},$submittext,\%lti)); - } else { - $r->print('
'.&mt('External Tool Unavailable').'
'); - } + foreach my $item (qw(crslabel crstitle crsappend gradable incdom)) { + $toolhash{$item} = $toolsettings{$item}; } + $is_tool = 1; } } } @@ -124,20 +123,117 @@ sub handler { } else { $r->print('\textbf{'.&mt(Invalid Call).'}\end{document}'); } + return OK; + } + + 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.'}').'\\\\'); + } + if ($toolhash{'gradable'}) { + $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri); + if ($env{'form.markaccess'}) { + my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb); + my ($timelimit) = split(/_/,$interval[0]); + &Apache::lonnet::set_first_access($interval[1],$timelimit); + } elsif ($symb && $env{'form.LC_interval_done'} eq 'true') { + # Set the event timer to zero if the "done button" was clicked. The button is + # part of the doneButton form created in lonmenu.pm + ($donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb); + undef($env{'form.LC_interval_done'}); + undef($env{'form.LC_interval_done_proctorpass'}); + } + ($status,$msg) = &gradabletool_access_check($target); + undef($Apache::lonhomework::browse); + if ($status eq 'SHOW_ANSWER') { + $r->print(&display_score($target)); + if ($target eq 'tex') { + $r->print('\end{document}'); + } + return OK; + } elsif ($status ne 'CAN_ANSWER') { + if ($target eq 'tex') { + $r->print('\end{document}'); + } else { + $r->print($msg); + } + return OK; + } + } else { + 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; + if ($toolhash{'passback'}) { + if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'grade',$now, + \%toolsettings,\%toolhash) eq 'ok') { + $toolhash{'gradesecret'} = $toolsettings{'gradesecret'}; + } else { + undef($launchok); + } + } + if ($toolhash{'roster'}) { + if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'roster',$now, + \%toolsettings,\%toolhash) eq 'ok') { + $toolhash{'rostersecret'} = $toolsettings{'rostersecret'}; + } + } + 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,$submittext,$toolsref) = @_; + my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_; my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale, - %fields,%rolesmap,%display,%custom,@userlangs); + $crslabel,$crstitle,$gradesecret,$rostersecret,%fields,%rolesmap, + %display,%custom,@userlangs,$incdom); if (ref($toolsref) eq 'HASH') { $version = $toolsref->{'version'}; $toolname = $toolsref->{'title'}; $passback = $toolsref->{'passback'}; + $gradesecret = $toolsref->{'gradesecret'}; $roster = $toolsref->{'roster'}; + $rostersecret = $toolsref->{'rostersecret'}; $msgtype = $toolsref->{'messagetype'}; + $incdom = $toolsref->{'incdom'}; if (ref($toolsref->{'fields'}) eq 'HASH') { %fields = %{$toolsref->{'fields'}}; } @@ -150,6 +246,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,6 +258,12 @@ 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'}; @@ -170,8 +274,10 @@ sub lti_params { 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'})); @@ -194,6 +300,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); @@ -202,21 +309,28 @@ 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 $crshome = $env{'course.'.$env{'request.course.id'}.'.home'}; @@ -225,18 +339,42 @@ sub lti_params { 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'; + } + if (($passback) || ($roster)) { + my (%currdigest,%digesthash); + if (@possdigest) { + %currdigest = &Apache::lonnet::get('exttools',\@possdigest, + $cdom,$cnum); + } + if ($passback) { + $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/passback'; $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'}; - $ltiparams{'lis_result_sourcedid'} = ''; #FIXME + if ($gradesecret) { + my $uniqid = $digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'}; + $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_service_id($gradesecret,$uniqid); + } } - } - 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 ($roster) { + if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) { + $ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/roster'; + if ($rostersecret) { + my $uniqid = $digest_symb.':::'.$env{'request.course.id'}; + $ltiparams{'ext_ims_lis_memberships_id'} = &LONCAPA::ltiutils::get_service_id($rostersecret,$uniqid); + } + } + } + if (($digest_symb) && ($gradesecret || $rostersecret)) { + unless ((exists($currdigest{$digest_symb})) && ($currdigest{$digest_symb} eq $symb)) { + $digesthash{$digest_symb} = $symb; + } + } + if (($passback) && ($gradesecret)) { + unless ((exists($currdigest{$digest_user})) && ($currdigest{$digest_user} eq $uname.':'.$udom)) { + $digesthash{$digest_user} = $uname.':'.$udom; + } + } + if (keys(%digesthash)) { + &Apache::lonnet::put('exttools',\%digesthash,$cdom,$cnum); } } } @@ -269,9 +407,23 @@ sub lti_params { } $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)) { @@ -282,14 +434,15 @@ sub lti_params { } sub launch_html { - my ($url,$key,$secret,$submittext,$paramsref) = @_; - my $hashref = &sign_params($url,$key,$secret,$paramsref); + 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})) { @@ -316,23 +469,97 @@ 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(); +sub gradabletool_access_check { + my ($target) = @_; + my ($result,$resource_due); + my $status; + my ($symb,$courseid,$udom,$uname) = &Apache::lonnet::whichuser(); + my @targets; + if ($target) { + @targets = ($target); + } elsif (defined($env{'form.submitted'}) && defined($env{'form.validate'})) { + @targets = ('grade','web'); + } else { + @targets = ('web'); + } + foreach my $target (@targets) { + &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) = + &Apache::lonhomework::check_slot_access('0','tool',$symb); + if (( $status eq 'CLOSED' ) || + ( $status eq 'UNCHECKEDOUT') || + ( $status eq 'NOT_YET_VIEWED') || + ( $status eq 'BANNED') || + ( $status eq 'UNAVAILABLE') || + ( $status eq 'NOT_IN_A_SLOT') || + ( $status eq 'NOTRESERVABLE') || + ( $status eq 'RESERVABLE') || + ( $status eq 'RESERVABLE_LATER') || + ( $status eq 'INVALID_ACCESS') || + ( $status eq 'NEED_DIFFERENT_IP') || + ( $status eq 'WAITING_FOR_GRADE')) { + $result = &Apache::structuretags::access_status_msg('tool',$status,$symb, + $target,$ipused,$accessmsg); + } elsif ($status eq 'NEEDS_CHECKIN') { + $result = &Apache::structuretags::checkin_prompt($target,$slot_name,$slot,'tool'); + } elsif ($target eq 'web') { + if ($status eq 'CAN_ANSWER') { + $resource_due = &Apache::lonhomework::due_date(0, $env{'request.symb'}); + if ($slot_name ne '') { + $resource_due = &Apache::structuretags::selfcheckin_resource($resource_due, + $slot_name,$slot, + $env{'request.symb'}); + } + } + } + if (keys(%Apache::lonhomework::results)) { + &Apache::structuretags::finalize_storage(); + } + } + return ($status,$result,$resource_due); +} + +sub display_score { + my ($target) = @_; + my $weight = &Apache::lonnet::EXT('resource.0.weight'); + if ((!defined($weight)) || ($weight eq '')) { $weight=1; } + my $awarded = $Apache::lonhomework::history{'resource.0.awarded'}; + if (!defined($awarded)) { $awarded=0; } + my $display=''; + if ($target eq 'tex') { + $display = '\\\\'; + } + if (!defined($awarded)) { + $display .= &mt('[_1] possible points.',$weight); + } else { + my $points = $awarded*$weight; + my $result = sprintf('%.2f',$points); + $display .= &mt('You have [_1] out of [quant,_2,possible point]', + $result,$weight); + } + my $comment = $Apache::lonhomework::history{'resource.0.comment'}; + if (!defined($comment) || $comment!~/\w/) { + $comment=''; + } else { + if ($target eq 'tex') { + $comment = '\\\\'.$comment; + } else { + $comment='
'.$comment.'
'; + } + } + my $gradeinfo = $Apache::lonhomework::history{'resource.0.gradeinfo'}; + if (!defined($gradeinfo) || $gradeinfo!~/\w/) { + $gradeinfo=''; + } else { + if ($target eq 'tex') { + $gradeinfo = '\\\\'.$gradeinfo; + } else { + $gradeinfo='
'.$gradeinfo.'
'; + } + } + return $display.$comment.$gradeinfo; } 1;