[BACK]Return to lonexttool.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / interface

Diff for /loncom/interface/lonexttool.pm between versions 1.7 and 1.14

version 1.7, 2017/11/30 14:41:20 version 1.14, 2017/12/30 14:03:53
Line 43  package Apache::lonexttool; Line 43  package Apache::lonexttool;
   
 use strict;  use strict;
 use Apache::Constants qw(:common :http);  use Apache::Constants qw(:common :http);
 use Net::OAuth;  
 use Encode;  use Encode;
 use Digest::SHA;  use Digest::SHA;
 use UUID::Tiny ':std';  
 use HTML::Entities;  use HTML::Entities;
 use Apache::lonlocal;  use Apache::lonlocal;
 use Apache::lonnet;  use Apache::lonnet;
 use Apache::loncommon;  use Apache::loncommon;
   use Apache::londatecheck;
   use Apache::lonipcheck;
   use Apache::lonhomework;
   use Apache::structuretags;
   use LONCAPA::ltiutils;
   
 sub handler {  sub handler {
     my $r=shift;      my $r=shift;
Line 63  sub handler { Line 66  sub handler {
 # ------------------------------------------------------------ Print the screen  # ------------------------------------------------------------ Print the screen
     if ($target eq 'tex') {      if ($target eq 'tex') {
         $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));          $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
       } else {
           $target = 'web';
     }      }
   
 # Is this even in a course?  # Is this even in a course?
     unless ($env{'request.course.id'}) {      unless ($env{'request.course.id'}) {
         if ($target ne 'tex') {          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 {          } else {
             $r->print('\textbf{Not in a course}\end{document}');              $r->print('\textbf{Not in a course}\end{document}');
         }          }
Line 90  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 $is_tool;      my ($idx,$is_tool,%toolhash,%toolsettings);
   
     if ($r->uri eq "/adm/$cdom/$cnum/$marker/$exttool") {      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'}) {          if ($toolsettings{'id'}) {
             my $idx = $toolsettings{'id'};              $idx = $toolsettings{'id'};
             my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');              my %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
             if (ref($ltitools{$idx}) eq 'HASH') {              if (ref($ltitools{$idx}) eq 'HASH') {
                 my %toolhash = %{$ltitools{$idx}};                   %toolhash = %{$ltitools{$idx}};
                 $toolhash{'display'} = {                  $toolhash{'display'} = {
                                            target => $toolsettings{'target'},                                             target => $toolsettings{'target'},
                                            width  => $toolsettings{'width'},                                             width  => $toolsettings{'width'},
Line 107  sub handler { Line 113  sub handler {
                 $toolhash{'crslabel'} = $toolsettings{'crslabel'};                  $toolhash{'crslabel'} = $toolsettings{'crslabel'};
                 $toolhash{'crstitle'} = $toolsettings{'crstitle'};                  $toolhash{'crstitle'} = $toolsettings{'crstitle'};
                 $toolhash{'crsappend'} = $toolsettings{'crsappend'};                  $toolhash{'crsappend'} = $toolsettings{'crsappend'};
                   $toolhash{'gradable'} = $toolsettings{'gradable'};
                 $is_tool = 1;                  $is_tool = 1;
                 my $launchok = 1;  
                 if ($target eq 'tex') {  
                     $r->print(&mt('External Tool'));  
                 } else {  
                     my $now = time;  
                     if ($toolhash{'passback'}) {  
                         unless (&set_callback_secret($cdom,$cnum,$marker,'grade',$now,  
                                                      \%toolsettings,\%toolhash) eq 'ok') {  
                             undef($launchok);  
                         }  
                     }  
                     if ($toolhash{'roster'}) {  
                         &set_callback_secret($cdom,$cnum,$marker,'roster',$now,  
                                              \%toolsettings,\%toolhash);  
                     }  
                     my $submittext = &mt('Launch [_1]',$toolhash{'title'});  
                     if (($toolhash{'key'} ne '') && ($toolhash{'secret'} ne '') &&   
                         ($toolhash{'url'} ne '') && ($launchok)) {  
                         my %lti = &lti_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'},  
                                                $submittext,\%lti));  
                     } else {  
                         $r->print('<div>'.&mt('External Tool Unavailable').'</div>');  
                     }  
                 }  
             }              }
         }          }
     }      }
Line 146  sub handler { Line 124  sub handler {
         } else {          } else {
             $r->print('\textbf{'.&mt(Invalid Call).'}\end{document}');              $r->print('\textbf{'.&mt(Invalid Call).'}\end{document}');
         }          }
           return OK;
     }      }
     return OK;  
 }  
   
 sub set_callback_secret {      my ($status,$open,$close,$msg,$donebuttonresult,$donemsg);
     my ($cdom,$cnum,$marker,$name,$now,$toolsettings,$toolhash) = @_;      if ($toolhash{'gradable'}) {
     return unless ((ref($toolsettings) eq 'HASH') && (ref($toolhash) eq 'HASH'));          $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri);
     my $warning;          my ($symb) = &Apache::lonnet::whichuser();
     my ($needsnew,$oldsecret,$lifetime);          if ($env{'form.markaccess'}) {
     if ($name eq 'grade') {                my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb);
         $lifetime = $toolhash->{'passbackvalid'}              my ($timelimit) = split(/_/,$interval[0]);
     } elsif ($name eq 'roster') {              &Apache::lonnet::set_first_access($interval[1],$timelimit);
         $lifetime = $toolhash->{'rostervalid'};          } elsif ($symb && $env{'form.LC_interval_done'} eq 'true') {
     }                # Set the event timer to zero if the "done button" was clicked.  The button is
     if ($toolsettings->{$name} eq '') {              # part of the doneButton form created in lonmenu.pm
         $needsnew = 1;              ($donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb);
     } elsif (($toolsettings->{$name.'date'} + $lifetime) < $now) {              undef($env{'form.LC_interval_done'});
         $oldsecret = $toolsettings->{$name.'secret'};              undef($env{'form.LC_interval_done_proctorpass'});
         $needsnew = 1;          }
     }          ($status,$msg) = &gradabletool_access_check();
     if ($needsnew) {          undef($Apache::lonhomework::browse);
         if (&get_tool_lock($cdom,$cnum,$marker,$now) eq 'ok') {          if ($status eq 'SHOW_ANSWER') {
             my $secret = UUID::Tiny::create_uuid_as_string(UUID_V4);              $r->print(&display_score());
             $toolhash->{$name.'secret'} = $secret;              return OK;
             my %secrethash = (          } elsif ($status ne 'CAN_ANSWER') {
                            $name.'secret' => $secret,              $r->print($msg);
                            $name.'secretdate' => $now,              return OK;
                           );          }
             if ($oldsecret ne '') {      } else {
                 $secrethash{'old'.$name.'secret'} = $oldsecret;          my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check();
             }          if ($status ne 'OPEN') {
             my $putres = &Apache::lonnet::put('exttool_'.$marker,              if ($target eq 'tex') {
                                               \%secrethash,$cdom,$cnum);                  $r->print(&mt('Not open to be viewed'));
             my $delresult = &release_tool_lock($cdom,$cnum,$marker);              } else {
             if ($delresult ne 'ok') {                  $r->print($msg);
                 $warning = $delresult ;  
             }  
             if ($putres eq 'ok') {  
                 return 'ok';  
             }              }
               return OK;
         } else {          } else {
             $warning = '<span class="LC_error">'.              ($status,$msg)=&Apache::lonipcheck::ip_access_check();
                        &mt('Could not obtain exclusive lock').              if ($status ne 'OPEN') {
                        '</span>';                  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'));
     } else {      } else {
         $toolhash->{$name.'secret'} = $toolsettings->{$name.'secret'};          my $now = time;
         return 'ok';          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 = &lti_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('<div>'.&mt('External Tool Unavailable').'</div>');
           }
     }      }
     return;      return OK;
 }  }
   
 sub lti_params {  sub lti_params {
Line 316  sub lti_params { Line 326  sub lti_params {
         }          }
         if (($passback) || ($roster)) {          if (($passback) || ($roster)) {
             if ($passback) {              if ($passback) {
                 $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'//'.$crshostname.'/adm/service/passback';                  $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/passback';
                 $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'};                  $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'};
                 if ($gradesecret) {                  if ($gradesecret) {
                     my $result_sig =                       my $uniqid = $digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'};
                         Digest::SHA::sha1_hex($gradesecret.':::'.$digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'});                      $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_service_id($gradesecret,$uniqid); 
                     $ltiparams{'lis_result_sourcedid'} =  
                         $result_sig.':::'.$digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'};  
                 }                  }
             }              }
             if ($roster) {              if ($roster) {
                 if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {                  if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
                     $ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'//'.$crshostname.'/adm/service/roster';                      $ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/roster';
                     if ($rostersecret) {                      if ($rostersecret) {
                         my $roster_sig = Digest::SHA::sha1_hex($gradesecret.':::'.$digest_symb.':::'.$env{'request.course.id'});                          my $uniqid = $digest_symb.':::'.$env{'request.course.id'};
                         $ltiparams{'ext_ims_lis_memberships_id'} = $roster_sig.':::'.$digest_symb.':::'.$env{'request.course.id'};                          $ltiparams{'ext_ims_lis_memberships_id'} = &LONCAPA::ltiutils::get_service_id($rostersecret,$uniqid);
                     }                      }
                 }                  }
             }              }
Line 404  sub lti_params { Line 412  sub lti_params {
 }  }
   
 sub launch_html {  sub launch_html {
     my ($url,$key,$secret,$submittext,$paramsref) = @_;      my ($url,$key,$secret,$sigmethod,$submittext,$paramsref) = @_;
     my $hashref = &sign_params($url,$key,$secret,$paramsref);      my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$sigmethod,$paramsref);
     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 439  ENDJS Line 447  ENDJS
     return $form;      return $form;
 }  }
   
 sub sign_params {  sub gradabletool_access_check {
     my ($url,$key,$secret,$paramsref) = @_;      my ($result,$resource_due);
     my $nonce = Digest::SHA::sha1_hex(sprintf("%06x%06x",rand(0xfffff0),rand(0xfffff0)));      my $status;
       my ($symb,$courseid,$udom,$uname) = &Apache::lonnet::whichuser();
     my $request = Net::OAuth->request("request token")->new(      my @targets;
             consumer_key => $key,      if (defined($env{'form.submitted'}) && defined($env{'form.validate'})) {
             consumer_secret => $secret,          @targets = ('grade','web');
             request_url => $url,      } else {
             request_method => 'POST',          @targets = ('web');
             signature_method => 'HMAC-SHA1',      }
             timestamp => time,      foreach my $target (@targets) {
             nonce => $nonce,          undef(%Apache::lonhomework::results);
             callback => 'about:blank',          undef(%Apache::lonhomework::history);
             extra_params => $paramsref,          %Apache::lonhomework::history =
             version      => '1.0',              &Apache::lonnet::restore($symb,$courseid,$udom,$uname);
             );          &Apache::lonhomework::set_show_problem_status(&Apache::lonnet::EXT('resource.0.problemstatus'));
     $request->sign;          my ($accessmsg,$slot_name,$slot,$ipused);
     return $request->to_hash();          ($status,$accessmsg,$slot_name,$slot,$ipused) =
 }              &Apache::lonhomework::check_slot_access('0','tool',$symb);
           if (( $status eq 'CLOSED' ) ||
 sub get_tool_lock {              ( $status eq 'UNCHECKEDOUT') ||
     my ($cdom,$cnum,$marker,$now) = @_;              ( $status eq 'NOT_YET_VIEWED') ||
     # get lock for tool for which gradesecret is being set              ( $status eq 'BANNED') ||
     my $lockhash = {              ( $status eq 'UNAVAILABLE') ||
                   $marker."\0".'lock' => $now.':'.$env{'user.name'}.              ( $status eq 'NOT_IN_A_SLOT') ||
                                          ':'.$env{'user.domain'},              ( $status eq 'NOTRESERVABLE') ||
                    };              ( $status eq 'RESERVABLE') ||
     my $tries = 0;              ( $status eq 'RESERVABLE_LATER') ||
     my $gotlock = &Apache::lonnet::newput('exttools',$lockhash,$cdom,$cnum);              ( $status eq 'INVALID_ACCESS') ||
               ( $status eq 'NEED_DIFFERENT_IP') ||
     while (($gotlock ne 'ok') && $tries <3) {              ( $status eq 'WAITING_FOR_GRADE')) {
         $tries ++;              $result = &Apache::structuretags::access_status_msg('tool',$status,$symb,
         sleep(1);                                                                  $target,$ipused,$accessmsg);
         $gotlock = &Apache::lonnet::newput('exttools',$lockhash,$cdom,$cnum);          } 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 $gotlock;      return ($status,$result,$resource_due);
 }  }
   
 sub release_tool_lock {  sub display_score {
     my ($cdom,$cnum,$marker) = @_;      my $weight = &Apache::lonnet::EXT('resource.0.weight');
     #  remove lock      if ((!defined($weight)) || ($weight eq '')) { $weight=1; }
     my @del_lock = ($marker."\0".'lock');      my $awarded = $Apache::lonhomework::history{'resource.0.awarded'};
     my $dellockoutcome=&Apache::lonnet::del('exttools',\@del_lock,$cdom,$cnum);      if (!defined($awarded)) { $awarded=0; }
     if ($dellockoutcome ne 'ok') {      my $display='';
         return ('<div class="LC_error">'      if (!defined($awarded)) {
                .&mt('Warning: failed to release lock for exttool: [_1].','<tt>'.$marker.'</tt>')          $display = &mt('[_1] possible points.',$weight);
                .'</div>'      } 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='<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 {      } else {
         return 'ok';          $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.7  
changed lines
  Added in v.1.14

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