Diff for /loncom/interface/lonexttool.pm between versions 1.22.2.2 and 1.22.2.3

version 1.22.2.2, 2023/01/23 18:38:26 version 1.22.2.3, 2023/07/05 18:42:48
Line 51  use Apache::lonnet; Line 51  use Apache::lonnet;
 use Apache::loncommon;  use Apache::loncommon;
 use Apache::londatecheck;  use Apache::londatecheck;
 use Apache::lonipcheck;  use Apache::lonipcheck;
   use Apache::lonhomework;
   use Apache::structuretags;
 use LONCAPA::ltiutils;  use LONCAPA::ltiutils;
   
 sub handler {  sub handler {
Line 94  sub handler { Line 96  sub handler {
     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};      my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};      my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
     my $chome = $env{'course.'.$env{'request.course.id'}.'.home'};      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") {      if ($r->uri eq "/adm/$cdom/$cnum/$marker/$exttool") {
         %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum);          %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum);
         if ($toolsettings{'id'}) {          if ($toolsettings{'id'}) {
             $idx = $toolsettings{'id'};              my %ltitools;
             my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');              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') {              if (ref($ltitools{$idx}) eq 'HASH') {
                 %toolhash = %{$ltitools{$idx}};                  %toolhash = %{$ltitools{$idx}};
                 $toolhash{'display'} = {                  $toolhash{'display'} = {
Line 108  sub handler { Line 117  sub handler {
                                            width  => $toolsettings{'width'},                                             width  => $toolsettings{'width'},
                                            height => $toolsettings{'height'},                                             height => $toolsettings{'height'},
                                        };                                         };
                 foreach my $item (qw(crslabel crstitle crsappend)) {                  foreach my $item (qw(crslabel crstitle crsappend gradable)) {
                     $toolhash{$item} = $toolsettings{$item};                      $toolhash{$item} = $toolsettings{$item};
                 }                  }
                 $is_tool = 1;                  $is_tool = 1;
Line 132  sub handler { Line 141  sub handler {
         my $title = &Apache::lonnet::gettitle($symb);          my $title = &Apache::lonnet::gettitle($symb);
         $r->print(&mt('External Tool: [_1]','\textit{'.$title.'}').'\\\\');          $r->print(&mt('External Tool: [_1]','\textit{'.$title.'}').'\\\\');
     }      }
     my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check();      if ($toolhash{'gradable'}) {
     if ($status ne 'OPEN') {          $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri);
         if ($target eq 'tex') {          if ($env{'form.markaccess'}) {
             $r->print(&mt('Not open to be viewed').'\end{document}');              my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb);
         } else {              my ($timelimit) = split(/_/,$interval[0]);
             $r->print($msg);              &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;
         }          }
         return OK;  
     } else {      } else {
         ($status,$msg)=&Apache::lonipcheck::ip_access_check();          my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check();
         if ($status ne 'OPEN') {          if ($status ne 'OPEN') {
             if ($target eq 'tex') {              if ($target eq 'tex') {
                 $r->print(&mt('Not open to be viewed').'\end{document}');                  $r->print(&mt('Not open to be viewed').'\end{document}');
Line 149  sub handler { Line 179  sub handler {
                 $r->print($msg);                  $r->print($msg);
             }              }
             return OK;              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;      my $launchok = 1;
Line 156  sub handler { Line 196  sub handler {
         $r->print('\end{document}');          $r->print('\end{document}');
     } else {      } else {
         my $now = time;          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'});          my $submittext = &mt('Launch [_1]',$toolhash{'title'});
         if (($toolhash{'key'} ne '') && ($toolhash{'secret'} ne '') &&           if (($toolhash{'url'} ne '') && ($launchok)) {
             ($toolhash{'url'} ne '') && ($launchok)) {  
             my %lti = &lti_params($r,$cnum,$cdom,$idx,$submittext,\%toolhash);              my %lti = &lti_params($r,$cnum,$cdom,$idx,$submittext,\%toolhash);
             my $url = $toolhash{'url'};              my $url = $toolhash{'url'};
             if ($toolhash{'crsappend'} ne '') {              if ($toolhash{'crsappend'} ne '') {
                 $url .= $toolhash{'crsappend'};                  $url .= $toolhash{'crsappend'};
             }              }
             $r->print(&launch_html($url,$toolhash{'key'},$toolhash{'secret'},              my %info = (
                                    $toolhash{'sigmethod'},$submittext,\%lti));                           method => $toolhash{'sigmethod'},
                          );
               $r->print(&launch_html($cdom,$cnum,$crstool,$url,$idx,
                                      $toolhash{'cipher'},$submittext,\%lti,\%info));
         } else {          } else {
             $r->print('<div>'.&mt('External Tool Unavailable').'</div>');              $r->print('<div class="LC_warning">'.&mt('External Tool Unavailable').'</div>');
         }          }
     }      }
     return OK;      return OK;
Line 176  sub handler { Line 232  sub handler {
 sub lti_params {  sub lti_params {
     my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_;      my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_;
     my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale,      my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale,
         $crslabel,$crstitle,%fields,%rolesmap,%display,%custom,@userlangs,$incdom);          $crslabel,$crstitle,$gradesecret,$rostersecret,%fields,%rolesmap,
           %display,%custom,@userlangs,$incdom);
     if (ref($toolsref) eq 'HASH') {      if (ref($toolsref) eq 'HASH') {
         $version = $toolsref->{'version'};          $version = $toolsref->{'version'};
         $toolname = $toolsref->{'title'};          $toolname = $toolsref->{'title'};
           $passback = $toolsref->{'passback'};
           $gradesecret = $toolsref->{'gradesecret'};
           $roster = $toolsref->{'roster'};
           $rostersecret = $toolsref->{'rostersecret'};
         $msgtype = $toolsref->{'messagetype'};          $msgtype = $toolsref->{'messagetype'};
         $incdom = $toolsref->{'incdom'};          $incdom = $toolsref->{'incdom'};
         if (ref($toolsref->{'fields'}) eq 'HASH') {          if (ref($toolsref->{'fields'}) eq 'HASH') {
Line 288  sub lti_params { Line 349  sub lti_params {
         unless ($crsprotocol eq 'https') {          unless ($crsprotocol eq 'https') {
             $crsprotocol = 'http';              $crsprotocol = 'http';
         }          }
           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'};
                   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);
                       }
                   }
               }
               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);
               }
           }
     }      }
     if ($display{'target'}) {      if ($display{'target'}) {
         $ltiparams{'launch_presentation_document_target'} = $display{'target'};          $ltiparams{'launch_presentation_document_target'} = $display{'target'};
Line 345  sub lti_params { Line 443  sub lti_params {
 }  }
   
 sub launch_html {  sub launch_html {
     my ($url,$key,$secret,$sigmethod,$submittext,$paramsref) = @_;      my ($cdom,$cnum,$crstool,$url,$idx,$keynum,$submittext,$paramsref,$inforef) = @_;
     my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$paramsref,$sigmethod);      my ($status,$hashref) =
           &Apache::lonnet::sign_lti($cdom,$cnum,$crstool,'tools','launch',$url,$idx,$keynum,
                                     $paramsref,$inforef);
       unless ($status eq 'ok') {
           return '<div class="LC_warning">'.&mt('External Tool Unavailable').'</div>';
       }
     my $action = &HTML::Entities::encode($url,'<>&"');      my $action = &HTML::Entities::encode($url,'<>&"');
     my $form = <<"END";      my $form = <<"END";
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Line 380  ENDJS Line 483  ENDJS
     return $form;      return $form;
 }  }
   
   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='<br /><table><tr><td bgcolor="#FFFFDD">'.$comment.'</td></tr></table>';
           }
       }
       my $gradeinfo = $Apache::lonhomework::history{'resource.0.gradeinfo'};
       if (!defined($gradeinfo) || $gradeinfo!~/\w/) {
           $gradeinfo='';
       } else {
           if ($target eq 'tex') {
               $gradeinfo = '\\\\'.$gradeinfo;
           } else {
               $gradeinfo='<br /><table><tr><td bgcolor="#DDDDFF"><font size="+2">'.$gradeinfo.'</font></td></tr></table>';
           }
       }
       return $display.$comment.$gradeinfo;
   }
   
 1;  1;

Removed from v.1.22.2.2  
changed lines
  Added in v.1.22.2.3


FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>