--- loncom/interface/lonexttool.pm 2017/12/30 14:03:53 1.14 +++ loncom/interface/lonexttool.pm 2023/01/23 18:38:26 1.22.2.2 @@ -1,7 +1,7 @@ # The LearningOnline Network with CAPA # Launch External Tool Provider (LTI) # -# $Id: lonexttool.pm,v 1.14 2017/12/30 14:03:53 raeburn Exp $ +# $Id: lonexttool.pm,v 1.22.2.2 2023/01/23 18:38:26 raeburn Exp $ # # Copyright Michigan State University Board of Trustees # @@ -51,8 +51,6 @@ use Apache::lonnet; use Apache::loncommon; use Apache::londatecheck; use Apache::lonipcheck; -use Apache::lonhomework; -use Apache::structuretags; use LONCAPA::ltiutils; sub handler { @@ -110,10 +108,9 @@ sub handler { width => $toolsettings{'width'}, height => $toolsettings{'height'}, }; - $toolhash{'crslabel'} = $toolsettings{'crslabel'}; - $toolhash{'crstitle'} = $toolsettings{'crstitle'}; - $toolhash{'crsappend'} = $toolsettings{'crsappend'}; - $toolhash{'gradable'} = $toolsettings{'gradable'}; + foreach my $item (qw(crslabel crstitle crsappend)) { + $toolhash{$item} = $toolsettings{$item}; + } $is_tool = 1; } } @@ -127,70 +124,38 @@ sub handler { return OK; } - my ($status,$open,$close,$msg,$donebuttonresult,$donemsg); - if ($toolhash{'gradable'}) { - $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri); - my ($symb) = &Apache::lonnet::whichuser(); - 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(); - undef($Apache::lonhomework::browse); - if ($status eq 'SHOW_ANSWER') { - $r->print(&display_score()); - return OK; - } elsif ($status ne 'CAN_ANSWER') { + 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; } + return OK; } else { - my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check(); + ($status,$msg)=&Apache::lonipcheck::ip_access_check(); if ($status ne 'OPEN') { if ($target eq 'tex') { - $r->print(&mt('Not open to be viewed')); + $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')); - } else { - $r->print($msg); - } - return OK; - } } } my $launchok = 1; if ($target eq 'tex') { - $r->print(&mt('External Tool')); + $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)) { @@ -211,16 +176,12 @@ sub handler { sub lti_params { my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_; my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale, - $crslabel,$crstitle,$gradesecret,$rostersecret,%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'}; - $gradesecret = $toolsref->{'gradesecret'}; - $roster = $toolsref->{'roster'}; - $rostersecret = $toolsref->{'rostersecret'}; $msgtype = $toolsref->{'messagetype'}; + $incdom = $toolsref->{'incdom'}; if (ref($toolsref->{'fields'}) eq 'HASH') { %fields = %{$toolsref->{'fields'}}; } @@ -246,10 +207,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'); @@ -261,8 +222,10 @@ sub lti_params { unless (grep(/^\Q$ltirole\E$/,@possroles)) { $ltirole = 'Learner'; } - my $digest_user = &Encode::decode_utf8($uname.':'.$udom); + my @possdigest; + 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 '') { @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/, $env{'course.'.$env{'request.course.id'}.'.languages'})); @@ -283,8 +246,9 @@ sub lti_params { my ($title,$digest_symb); my ($symb) = &Apache::lonnet::whichuser(); if ($symb) { - $digest_symb = &Encode::decode_utf8($symb); + $digest_symb = &Encode::decode('UTF-8',$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); @@ -296,7 +260,7 @@ 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 $portal_url = &Apache::lonnet::course_portal_url($cnum,$cdom,$r); my %ltiparams = ( lti_version => $version, @@ -306,7 +270,7 @@ sub lti_params { 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, @@ -324,41 +288,6 @@ sub lti_params { unless ($crsprotocol eq 'https') { $crsprotocol = 'http'; } - if (($passback) || ($roster)) { - if ($passback) { - $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/passback'; - $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); - } - } - 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); - } - } - } - my %digesthash; - if ($ltiparams{'lis_result_sourcedid'}) { - $digesthash{$ltiparams{'lis_result_sourcedid'}} = "$idx\0".time; - } - if ($ltiparams{'ext_ims_lis_memberships_id'}) { - $digesthash{$ltiparams{'ext_ims_lis_memberships_id'}} = "$idx\0".time; - } - if (($digest_symb) && ($gradesecret || $rostersecret)) { - $digesthash{$digest_symb} = $symb; - } - if (($passback) && ($gradesecret)) { - $digesthash{$digest_user} = $uname.':'.$udom; - } - if (keys(%digesthash)) { - &Apache::lonnet::put('exttools',\%digesthash,$cdom,$cnum); - } - } } if ($display{'target'}) { $ltiparams{'launch_presentation_document_target'} = $display{'target'}; @@ -390,7 +319,11 @@ sub lti_params { $ltiparams{'lis_person_contact_email_primary'} = $contact_email; } if ($fields{'user'}) { - $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom; + if ($incdom) { + $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom; + } else { + $ltiparams{'lis_person_sourcedid'} = $uname; + } } if (keys(%custom)) { foreach my $key (keys(%custom)) { @@ -405,7 +338,7 @@ 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; return %ltiparams; @@ -413,7 +346,7 @@ sub lti_params { sub launch_html { my ($url,$key,$secret,$sigmethod,$submittext,$paramsref) = @_; - my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$sigmethod,$paramsref); + my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$paramsref,$sigmethod); my $action = &HTML::Entities::encode($url,'<>&"'); my $form = <<"END"; @@ -447,82 +380,4 @@ ENDJS return $form; } -sub gradabletool_access_check { - my ($result,$resource_due); - my $status; - my ($symb,$courseid,$udom,$uname) = &Apache::lonnet::whichuser(); - my @targets; - if (defined($env{'form.submitted'}) && defined($env{'form.validate'})) { - @targets = ('grade','web'); - } else { - @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::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'}); - } - } - } - } - return ($status,$result,$resource_due); -} - -sub display_score { - 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 (!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 { - $comment='
'.$comment.'
'; - } - my $gradeinfo = $Apache::lonhomework::history{'resource.0.gradeinfo'}; - if (!defined($gradeinfo) || $gradeinfo!~/\w/) { - $gradeinfo=''; - } else { - $gradeinfo='
'.$gradeinfo.'
'; - } - return $display.$comment.$gradeinfo; -} - 1;