--- loncom/interface/lonexttool.pm 2017/11/30 01:52:14 1.5
+++ loncom/interface/lonexttool.pm 2017/12/22 02:00:46 1.12
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Launch External Tool Provider (LTI)
#
-# $Id: lonexttool.pm,v 1.5 2017/11/30 01:52:14 raeburn Exp $
+# $Id: lonexttool.pm,v 1.12 2017/12/22 02:00:46 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,14 +96,15 @@ 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'},
@@ -105,23 +113,8 @@ sub handler {
$toolhash{'crslabel'} = $toolsettings{'crslabel'};
$toolhash{'crstitle'} = $toolsettings{'crstitle'};
$toolhash{'crsappend'} = $toolsettings{'crsappend'};
+ $toolhash{'gradable'} = $toolsettings{'gradable'};
$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,$cnum,$cdom,$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('
'.&mt('External Tool Unavailable').'
');
- }
- }
}
}
}
@@ -131,19 +124,95 @@ sub handler {
} else {
$r->print('\textbf{'.&mt(Invalid Call).'}\end{document}');
}
+ return OK;
+ }
+
+ my ($status,$open,$close,$msg);
+ if ($toolhash{'gradable'}) {
+ $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri);
+ if ($env{'form.markaccess'}) {
+ my @interval=&Apache::lonnet::EXT("resource.0.interval");
+ my ($timelimit) = split(/_/,$interval[0]);
+ &Apache::lonnet::set_first_access($interval[1],$timelimit);
+ }
+ ($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') {
+ $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'));
+ } 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'));
+ } 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'},
+ $submittext,\%lti));
+ } else {
+ $r->print(''.&mt('External Tool Unavailable').'
');
+ }
}
return OK;
}
sub lti_params {
- my ($r,$cnum,$cdom,$submittext,$toolsref) = @_;
+ my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_;
my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale,
- $crslabel,$crstitle,%fields,%rolesmap,%display,%custom,@userlangs);
+ $crslabel,$crstitle,$gradesecret,$rostersecret,%fields,%rolesmap,
+ %display,%custom,@userlangs);
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'};
if (ref($toolsref->{'fields'}) eq 'HASH') {
%fields = %{$toolsref->{'fields'}};
@@ -247,18 +316,40 @@ 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/service/passback';
+ }
+ 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'};
- $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/service/roster';
- $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);
+ }
+ }
+ }
+ 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);
}
}
}
@@ -292,7 +383,7 @@ sub lti_params {
$ltiparams{'lis_person_contact_email_primary'} = $contact_email;
}
if ($fields{'user'}) {
- $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom;
+ $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom;
}
if (keys(%custom)) {
foreach my $key (keys(%custom)) {
@@ -315,7 +406,7 @@ sub lti_params {
sub launch_html {
my ($url,$key,$secret,$submittext,$paramsref) = @_;
- my $hashref = &sign_params($url,$key,$secret,$paramsref);
+ my $hashref = &LONCAPA::ltiutils::sign_params($url,$key,$secret,$paramsref);
my $action = &HTML::Entities::encode($url,'<>&"');
my $form = <<"END";
@@ -349,23 +440,82 @@ 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 ($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='
';
+ }
+ my $gradeinfo = $Apache::lonhomework::history{'resource.0.gradeinfo'};
+ if (!defined($gradeinfo) || $gradeinfo!~/\w/) {
+ $gradeinfo='';
+ } else {
+ $gradeinfo='
';
+ }
+ return $display.$comment.$gradeinfo;
}
1;