Annotation of loncom/interface/lonexttool.pm, revision 1.26

1.1       raeburn     1: # The LearningOnline Network with CAPA
                      2: # Launch External Tool Provider (LTI)
                      3: #
1.26    ! raeburn     4: # $Id: lonexttool.pm,v 1.25 2023/06/02 01:20:26 raeburn Exp $
1.1       raeburn     5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
                     28: 
                     29: =pod
                     30: 
                     31: =head1 NAME
                     32: 
                     33: Apache::lonexttool - Tool Provider launcher
                     34: 
                     35: =head1 SYNOPSIS
                     36: 
                     37: 
                     38: =head1 OVERVIEW
                     39: 
                     40: =cut
                     41: 
                     42: package Apache::lonexttool;
                     43: 
                     44: use strict;
                     45: use Apache::Constants qw(:common :http);
                     46: use Encode;
                     47: use Digest::SHA;
                     48: use HTML::Entities;
                     49: use Apache::lonlocal;
                     50: use Apache::lonnet;
                     51: use Apache::loncommon;
1.12      raeburn    52: use Apache::londatecheck;
                     53: use Apache::lonipcheck;
                     54: use Apache::lonhomework;
                     55: use Apache::structuretags;
1.9       raeburn    56: use LONCAPA::ltiutils;
1.1       raeburn    57: 
                     58: sub handler {
                     59:     my $r=shift;
                     60:     &Apache::loncommon::content_type($r,'text/html');
                     61:     $r->send_http_header;
                     62: 
                     63:     return OK if $r->header_only;
                     64: 
                     65:     my $target=$env{'form.grade_target'};
                     66: # ------------------------------------------------------------ Print the screen
                     67:     if ($target eq 'tex') {
                     68:         $r->print(&Apache::lonprintout::print_latex_header($env{'form.latex_type'}));
1.12      raeburn    69:     } else {
                     70:         $target = 'web';
1.1       raeburn    71:     }
                     72: 
                     73: # Is this even in a course?
                     74:     unless ($env{'request.course.id'}) {
                     75:         if ($target ne 'tex') {
1.11      raeburn    76:             &Apache::loncommon::simple_error_page($r,'','Not in a course',
                     77:                                                   {'only_body' => 1});
1.1       raeburn    78:         } else {
                     79:             $r->print('\textbf{Not in a course}\end{document}');
                     80:         }
                     81:         return OK;
                     82:     }
                     83: 
1.3       raeburn    84:     my ($marker,$exttool) = (split(m{/},$r->uri))[4,5];
1.1       raeburn    85:     $marker=~s/\D//g;
                     86: 
                     87:     if (!$marker) {
                     88:         if ($target ne 'tex') {
1.3       raeburn    89:             $r->print(&mt('Invalid Call'));
1.1       raeburn    90:         } else {
1.3       raeburn    91:             $r->print('\textbf{'&mt('Invalid Call').'}\end{document}');
1.1       raeburn    92:         }
                     93:         return OK;
                     94:     }
                     95: 
                     96:     my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                     97:     my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                     98:     my $chome = $env{'course.'.$env{'request.course.id'}.'.home'};
1.24      raeburn    99:     my ($idx,$crstool,$is_tool,%toolhash,%toolsettings);
1.1       raeburn   100: 
1.3       raeburn   101:     if ($r->uri eq "/adm/$cdom/$cnum/$marker/$exttool") {
1.12      raeburn   102:         %toolsettings=&Apache::lonnet::dump('exttool_'.$marker,$cdom,$cnum);
1.3       raeburn   103:         if ($toolsettings{'id'}) {
1.24      raeburn   104:             my %ltitools;
                    105:             if ($toolsettings{'id'} =~ /^c(\d+)$/) {
                    106:                 $idx = $1;
                    107:                 $crstool = 1;
                    108:                 %ltitools = &Apache::lonnet::get_course_lti($cnum,$cdom,'consumer');
                    109:             } else {
                    110:                 $idx = $toolsettings{'id'};
                    111:                 %ltitools = &Apache::lonnet::get_domain_lti($cdom,'consumer');
                    112:             }
1.6       raeburn   113:             if (ref($ltitools{$idx}) eq 'HASH') {
1.12      raeburn   114:                 %toolhash = %{$ltitools{$idx}};
1.3       raeburn   115:                 $toolhash{'display'} = {
                    116:                                            target => $toolsettings{'target'},
                    117:                                            width  => $toolsettings{'width'},
                    118:                                            height => $toolsettings{'height'},
                    119:                                        };
1.19      raeburn   120:                 foreach my $item (qw(crslabel crstitle crsappend gradable)) {
1.16      raeburn   121:                     $toolhash{$item} = $toolsettings{$item};
                    122:                 }
1.26    ! raeburn   123:                 if ($toolhash{'returnurl'}) {
        !           124:                     my $gotreturnurl;
        !           125:                     if (ref($toolhash{'crsconf'}) eq 'HASH') {
        !           126:                         if ($toolhash{'crsconf'}{'returnurl'}) {
        !           127:                             foreach my $item (qw(returnurl backtourl)) {
        !           128:                                 $toolhash{$item} = $toolsettings{$item};
        !           129:                             }
        !           130:                             $gotreturnurl = 1;
        !           131:                         }
        !           132:                     }
        !           133:                     unless ($gotreturnurl) {
        !           134:                         $toolhash{'returnurl'} = 'default';
        !           135:                     }
        !           136:                 } else {
        !           137:                     $toolhash{'returnurl'} = 'none';
        !           138:                 }
1.3       raeburn   139:                 $is_tool = 1;
1.1       raeburn   140:             }
                    141:         }
1.3       raeburn   142:     }
                    143:     unless ($is_tool) {
1.1       raeburn   144:         if ($target ne 'tex') {
1.3       raeburn   145:             $r->print('<div>'.&mt('Invalid Call').'</div>');
1.1       raeburn   146:         } else {
1.3       raeburn   147:             $r->print('\textbf{'.&mt(Invalid Call).'}\end{document}');
1.1       raeburn   148:         }
1.12      raeburn   149:         return OK;
                    150:     }
                    151: 
1.15      raeburn   152:     my ($symb,$status,$open,$close,$msg,$donebuttonresult,$donemsg);
                    153:     if (($target eq 'tex') || ($toolhash{'gradable'})) {
                    154:         ($symb) = &Apache::lonnet::whichuser();
                    155:     }
                    156:     if ($target eq 'tex') {
                    157:         my $title = &Apache::lonnet::gettitle($symb);
                    158:         $r->print(&mt('External Tool: [_1]','\textit{'.$title.'}').'\\\\');
                    159:     }
1.12      raeburn   160:     if ($toolhash{'gradable'}) {
                    161:         $Apache::lonhomework::browse = &Apache::lonnet::allowed('bre',$r->uri);
                    162:         if ($env{'form.markaccess'}) {
1.13      raeburn   163:             my @interval=&Apache::lonnet::EXT('resource.0.interval',$symb);
1.12      raeburn   164:             my ($timelimit) = split(/_/,$interval[0]);
                    165:             &Apache::lonnet::set_first_access($interval[1],$timelimit);
1.13      raeburn   166:         } elsif ($symb && $env{'form.LC_interval_done'} eq 'true') {
                    167:             # Set the event timer to zero if the "done button" was clicked.  The button is
                    168:             # part of the doneButton form created in lonmenu.pm
                    169:             ($donebuttonresult,$donemsg) = &Apache::lonhomework::zero_timer($symb);
                    170:             undef($env{'form.LC_interval_done'});
                    171:             undef($env{'form.LC_interval_done_proctorpass'});
1.12      raeburn   172:         }
1.15      raeburn   173:         ($status,$msg) = &gradabletool_access_check($target);
1.12      raeburn   174:         undef($Apache::lonhomework::browse);
                    175:         if ($status eq 'SHOW_ANSWER') {
1.15      raeburn   176:             $r->print(&display_score($target));
                    177:             if ($target eq 'tex') {
                    178:                 $r->print('\end{document}');
                    179:             }
1.12      raeburn   180:             return OK;
                    181:         } elsif ($status ne 'CAN_ANSWER') {
1.15      raeburn   182:             if ($target eq 'tex') {
                    183:                 $r->print('\end{document}');
                    184:             } else {
                    185:                 $r->print($msg);
                    186:             }
1.12      raeburn   187:             return OK;
                    188:         }
                    189:     } else {
                    190:         my ($status,$open,$close,$msg)=&Apache::londatecheck::content_date_check();
                    191:         if ($status ne 'OPEN') {
                    192:             if ($target eq 'tex') {
1.15      raeburn   193:                 $r->print(&mt('Not open to be viewed').'\end{document}');
1.12      raeburn   194:             } else {
                    195:                 $r->print($msg);
                    196:             }
                    197:             return OK;
                    198:         } else {
                    199:             ($status,$msg)=&Apache::lonipcheck::ip_access_check();
                    200:             if ($status ne 'OPEN') {
                    201:                 if ($target eq 'tex') {
1.15      raeburn   202:                     $r->print(&mt('Not open to be viewed').'\end{document}');
1.12      raeburn   203:                 } else {
                    204:                     $r->print($msg);
                    205:                 }
                    206:                 return OK;
                    207:             }
                    208:         }
                    209:     }
                    210:     my $launchok = 1;
                    211:     if ($target eq 'tex') {
1.15      raeburn   212:         $r->print('\end{document}');
1.12      raeburn   213:     } else {
                    214:         my $now = time;
                    215:         if ($toolhash{'passback'}) {
                    216:             if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'grade',$now,
                    217:                                                        \%toolsettings,\%toolhash) eq 'ok') {
                    218:                 $toolhash{'gradesecret'} = $toolsettings{'gradesecret'};
                    219:             } else {
                    220:                 undef($launchok);
                    221:             }
                    222:         }
                    223:         if ($toolhash{'roster'}) {
                    224:             if (&LONCAPA::ltiutils::set_service_secret($cdom,$cnum,$marker,'roster',$now,
                    225:                                                        \%toolsettings,\%toolhash) eq 'ok') {
                    226:                 $toolhash{'rostersecret'} = $toolsettings{'rostersecret'};
                    227:             }
                    228:         }
                    229:         my $submittext = &mt('Launch [_1]',$toolhash{'title'});
1.24      raeburn   230:         if (($toolhash{'url'} ne '') && ($launchok)) {
1.12      raeburn   231:             my %lti = &lti_params($r,$cnum,$cdom,$idx,$submittext,\%toolhash);
                    232:             my $url = $toolhash{'url'};
                    233:             if ($toolhash{'crsappend'} ne '') {
                    234:                 $url .= $toolhash{'crsappend'};
                    235:             }
1.24      raeburn   236:             my %info = (
                    237:                          method => $toolhash{'sigmethod'},
                    238:                        );
                    239:             $r->print(&launch_html($cdom,$cnum,$crstool,$url,$idx,
                    240:                                    $toolhash{'cipher'},$submittext,\%lti,\%info));
1.12      raeburn   241:         } else {
1.24      raeburn   242:             $r->print('<div class="LC_warning">'.&mt('External Tool Unavailable').'</div>');
1.12      raeburn   243:         }
1.1       raeburn   244:     }
                    245:     return OK;
                    246: }
                    247: 
                    248: sub lti_params {
1.6       raeburn   249:     my ($r,$cnum,$cdom,$idx,$submittext,$toolsref) = @_;
1.1       raeburn   250:     my ($version,$context_type,$msgtype,$toolname,$passback,$roster,$locale,
1.6       raeburn   251:         $crslabel,$crstitle,$gradesecret,$rostersecret,%fields,%rolesmap,
1.26    ! raeburn   252:         %display,%custom,@userlangs,$incdom,$returnurl,$backtourl);
1.1       raeburn   253:     if (ref($toolsref) eq 'HASH') {
                    254:         $version = $toolsref->{'version'};
                    255:         $toolname = $toolsref->{'title'};
                    256:         $passback = $toolsref->{'passback'};
1.6       raeburn   257:         $gradesecret = $toolsref->{'gradesecret'};
1.1       raeburn   258:         $roster = $toolsref->{'roster'};
1.6       raeburn   259:         $rostersecret = $toolsref->{'rostersecret'};
1.1       raeburn   260:         $msgtype = $toolsref->{'messagetype'};
1.16      raeburn   261:         $incdom = $toolsref->{'incdom'};
1.1       raeburn   262:         if (ref($toolsref->{'fields'}) eq 'HASH') {
                    263:             %fields = %{$toolsref->{'fields'}};
                    264:         }
                    265:         if (ref($toolsref->{'roles'}) eq 'HASH') {
                    266:             %rolesmap = %{$toolsref->{'roles'}};
                    267:         }
                    268:         if (ref($toolsref->{'display'}) eq 'HASH') {
                    269:             %display = %{$toolsref->{'display'}};
                    270:         }
                    271:         if (ref($toolsref->{'custom'}) eq 'HASH') {
                    272:             %custom = %{$toolsref->{'custom'}};
                    273:         }
1.4       raeburn   274:         $crslabel = $toolsref->{'crslabel'};
                    275:         $crstitle = $toolsref->{'crstitle'};
1.26    ! raeburn   276:         $returnurl = $toolsref->{'returnurl'};
        !           277:         $backtourl = $toolsref->{'backtourl'};
1.1       raeburn   278:     }
                    279:     if ($version eq '') {
                    280:         $version = 'LTI-1p0';
                    281:     }
                    282:     if ($context_type eq '') {
                    283:         $context_type = 'CourseSection';
                    284:     }
                    285:     if ($msgtype eq '') {
                    286:         $msgtype = 'basic-lti-launch-request';
                    287:     }
1.4       raeburn   288:     if ($crslabel eq '') {
1.20      raeburn   289:         $crslabel = $env{'course.'.$env{'request.course.id'}.'.internal.coursecode'};
1.4       raeburn   290:     }
                    291:     if ($crstitle eq '') {
1.20      raeburn   292:         $crstitle = $env{'course.'.$env{'request.course.id'}.'.description'};
1.4       raeburn   293:     }
1.1       raeburn   294:     my $lonhost = $r->dir_config('lonHostID');
                    295:     my $loncaparev = $r->dir_config('lonVersion');
                    296:     my $uname = $env{'user.name'};
                    297:     my $udom = $env{'user.domain'};
                    298:     my @possroles = qw(Instructor ContentDeveloper TeachingAssistant Learner);
1.3       raeburn   299:     my ($roleprefix) = ($env{'request.role'} =~ /^(\w+)\./);
                    300:     my $ltirole = $rolesmap{$roleprefix};
1.1       raeburn   301:     unless (grep(/^\Q$ltirole\E$/,@possroles)) {
                    302:         $ltirole = 'Learner';
                    303:     }
1.17      raeburn   304:     my @possdigest;
1.23      raeburn   305:     my $digest_user = &Encode::decode('UTF-8',$uname.':'.$udom);
1.1       raeburn   306:     $digest_user = &Digest::SHA::sha1_hex($digest_user);
1.17      raeburn   307:     push(@possdigest,$digest_user);
1.1       raeburn   308:     if ($env{'course.'.$env{'request.course.id'}.'.languages'} ne '') {
                    309:         @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
                    310:                     $env{'course.'.$env{'request.course.id'}.'.languages'}));
                    311:     } else {
1.2       raeburn   312:         my %langhash = &Apache::loncommon::getlangs($uname,$udom);
1.1       raeburn   313:         if ($langhash{'languages'} ne '') {
                    314:             @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
                    315:         } else {
                    316:             my %domdefs = &Apache::lonnet::get_domain_defaults($udom);
                    317:             if ($domdefs{'lang_def'} ne '') {
                    318:                 @userlangs = ($domdefs{'lang_def'});
                    319:             }
                    320:         }
                    321:     }
                    322:     if (scalar(@userlangs) == 1) {
                    323:         $locale = $userlangs[0];
                    324:     }
1.26    ! raeburn   325:     my ($title,$digest_symb,$digest_suppurl,$resource_link_id);
1.1       raeburn   326:     my ($symb) = &Apache::lonnet::whichuser();
                    327:     if ($symb) {
1.23      raeburn   328:         $digest_symb = &Encode::decode('UTF-8',$symb);
1.1       raeburn   329:         $digest_symb = &Digest::SHA::sha1_hex($digest_symb);
1.26    ! raeburn   330:         $resource_link_id = $digest_symb;
1.17      raeburn   331:         push(@possdigest,$digest_symb);
1.1       raeburn   332:         my $navmap = Apache::lonnavmaps::navmap->new();
                    333:         if (ref($navmap)) {
                    334:             my $res = $navmap->getBySymb($symb);
                    335:             if (ref($res)) {
                    336:                 $title = $res->compTitle();
                    337:             }
                    338:         }
1.26    ! raeburn   339:     } elsif ($env{'httpref.'.$env{'request.noversionuri'}} eq '/adm/coursedoc') {
        !           340:         $digest_suppurl = &Encode::decode('UTF-8',$env{'request.noversionuri'});
        !           341:         $digest_suppurl = &Digest::SHA::sha1_hex($digest_suppurl);
        !           342:         $resource_link_id = $digest_suppurl;
1.1       raeburn   343:     }
1.4       raeburn   344:     my $domdesc = &Apache::lonnet::domain($cdom);
                    345:     my $primary_id = &Apache::lonnet::domain($cdom,'primary');
                    346:     my $int_dom = &Apache::lonnet::internet_dom($primary_id);
1.21      raeburn   347:     my $portal_url = &Apache::lonnet::course_portal_url($cnum,$cdom,$r);
1.4       raeburn   348: 
1.1       raeburn   349:     my %ltiparams = (
                    350:         lti_version                            => $version,
                    351:         lti_message_type                       => $msgtype,
                    352:         resource_link_title                    => $title,
1.26    ! raeburn   353:         resource_link_id                       => $resource_link_id,
1.1       raeburn   354:         tool_consumer_instance_guid            => $lonhost,
1.4       raeburn   355:         tool_consumer_instance_description     => $domdesc,
1.1       raeburn   356:         tool_consumer_info_product_family_code => 'loncapa',
1.20      raeburn   357:         tool_consumer_instance_name            => $int_dom,
1.4       raeburn   358:         tool_consumer_instance_url             => $portal_url,
1.1       raeburn   359:         tool_consumer_info_version             => $loncaparev,
                    360:         user_id                                => $digest_user,
                    361:         roles                                  => $ltirole,
                    362:         context_id                             => $env{'request.course.id'},
                    363:         context_type                           => $context_type,
1.4       raeburn   364:         context_label                          => $crslabel,
                    365:         context_title                          => $crstitle,
1.1       raeburn   366:         launch_presentation_locale             => $locale,
                    367:     );
1.3       raeburn   368:     my $crshome = $env{'course.'.$env{'request.course.id'}.'.home'};
                    369:     my $crshostname = &Apache::lonnet::hostname($crshome);
1.1       raeburn   370:     if ($crshostname) {
1.3       raeburn   371:         my $crsprotocol = $Apache::lonnet::protocol{$crshome};
1.1       raeburn   372:         unless ($crsprotocol eq 'https') {
                    373:             $crsprotocol = 'http';
1.6       raeburn   374:         }
                    375:         if (($passback) || ($roster)) {
1.17      raeburn   376:             my (%currdigest,%digesthash);
                    377:             if (@possdigest) {
                    378:                 %currdigest = &Apache::lonnet::get('exttools',\@possdigest,
                    379:                                                    $cdom,$cnum);
                    380:             }
1.6       raeburn   381:             if ($passback) {
1.8       raeburn   382:                 $ltiparams{'lis_outcome_service_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/passback';
1.1       raeburn   383:                 $ltiparams{'ext_ims_lis_basic_outcome_url'} = $ltiparams{'lis_outcome_service_url'};
1.6       raeburn   384:                 if ($gradesecret) {
1.9       raeburn   385:                     my $uniqid = $digest_symb.':::'.$digest_user.':::'.$env{'request.course.id'};
1.20      raeburn   386:                     $ltiparams{'lis_result_sourcedid'} = &LONCAPA::ltiutils::get_service_id($gradesecret,$uniqid);
1.6       raeburn   387:                 }
                    388:             }
                    389:             if ($roster) {
                    390:                 if (&Apache::lonnet::allowed('opa',$env{'request.course.id'})) {
1.8       raeburn   391:                     $ltiparams{'ext_ims_lis_memberships_url'} = $crsprotocol.'://'.$crshostname.'/adm/service/roster';
1.6       raeburn   392:                     if ($rostersecret) {
1.9       raeburn   393:                         my $uniqid = $digest_symb.':::'.$env{'request.course.id'};
1.10      raeburn   394:                         $ltiparams{'ext_ims_lis_memberships_id'} = &LONCAPA::ltiutils::get_service_id($rostersecret,$uniqid);
1.6       raeburn   395:                     }
                    396:                 }
                    397:             }
                    398:             if (($digest_symb) && ($gradesecret || $rostersecret)) {
1.17      raeburn   399:                 unless ((exists($currdigest{$digest_symb})) && ($currdigest{$digest_symb} eq $symb)) {
                    400:                     $digesthash{$digest_symb} = $symb;
                    401:                 }
1.6       raeburn   402:             }
                    403:             if (($passback) && ($gradesecret)) {
1.17      raeburn   404:                 unless ((exists($currdigest{$digest_user})) && ($currdigest{$digest_user} eq $uname.':'.$udom)) {
                    405:                     $digesthash{$digest_user} = $uname.':'.$udom;
                    406:                 }
1.6       raeburn   407:             }
                    408:             if (keys(%digesthash)) {
                    409:                 &Apache::lonnet::put('exttools',\%digesthash,$cdom,$cnum);
1.1       raeburn   410:             }
                    411:         }
                    412:     }
                    413:     if ($display{'target'}) {
                    414:         $ltiparams{'launch_presentation_document_target'} = $display{'target'};
                    415:     }
                    416:     if ($display{'width'}) {
                    417:         $ltiparams{'launch_presentation_width'} = $display{'width'};
                    418:     }
                    419:     if ($display{'height'}) {
                    420:         $ltiparams{'launch_presentation_height'} = $display{'height'};
                    421:     }
                    422:     if ($fields{'firstname'}) {
                    423:         $ltiparams{'lis_person_name_given'} = $env{'environment.firstname'};
                    424:     }
                    425:     if ($fields{'lastname'}) {
                    426:         $ltiparams{'lis_person_name_family'} = $env{'environment.lastname'};
                    427:     }
                    428:     if ($fields{'fullname'}) {
                    429:         $ltiparams{'lis_person_name_full'} = &Apache::loncommon::plainname($uname,$udom);
                    430:     }
                    431:     if ($fields{'email'}) {
                    432:         my %emails = &Apache::loncommon::getemails($uname,$udom);
                    433:         my $contact_email;
1.3       raeburn   434:         foreach my $type ('permanentemail','critnotification','notification') {
                    435:             if ($emails{$type} =~ /\@/) {
                    436:                 $contact_email = $emails{$type};
1.1       raeburn   437:                 last;
                    438:             }
                    439:         }
1.2       raeburn   440:         $ltiparams{'lis_person_contact_email_primary'} = $contact_email;
1.1       raeburn   441:     }
1.4       raeburn   442:     if ($fields{'user'}) {
1.16      raeburn   443:         if ($incdom) {
                    444:             $ltiparams{'lis_person_sourcedid'} = $uname.':'.$udom;
                    445:         } else {
                    446:             $ltiparams{'lis_person_sourcedid'} = $uname;
                    447:         }
1.4       raeburn   448:     }
1.1       raeburn   449:     if (keys(%custom)) {
                    450:         foreach my $key (keys(%custom)) {
1.5       raeburn   451:             my $value = $custom{$key};
                    452:             $value =~ s/^\s+|\s+\$//g;
                    453:             if ($value =~ /^\QLONCAPA::env{\E([^\}]+)\}$/) {
                    454:                 if (exists($env{$1})) {
                    455:                     $value = $env{$1};
                    456:                 }
                    457:             }
                    458:             $ltiparams{'custom_'.$key} = $value;
1.1       raeburn   459:         }
                    460:     }
                    461:     foreach my $key (keys(%ltiparams)) {
1.23      raeburn   462:         $ltiparams{$key} = &Encode::decode('UTF-8',$ltiparams{$key});
1.1       raeburn   463:     }
1.3       raeburn   464:     $ltiparams{'basiclti_submit'} = $submittext;
1.26    ! raeburn   465:     if ($returnurl eq 'default') {
        !           466:         my $hostname = &Apache::lonnet::hostname($r->dir_config('lonHostID'));
        !           467:         my $protocol = 'http';
        !           468:         my $port = $r->get_server_port();
        !           469:         if ($port eq '443') {
        !           470:             $protocol = 'https';
        !           471:         }
        !           472:         if (&Apache::lonnet::get_proxy_alias()) {
        !           473:             my $hdrhost = $r->headers_in->get('Host');
        !           474:             if ($hdrhost ne '') {
        !           475:                 $hostname = $r->headers_in->get('Host');
        !           476:             }
        !           477:         }
        !           478:         my $location = $protocol.'://'.$hostname;
        !           479:         if ($display{'target'} eq 'iframe') {
        !           480:             my $return_url;
        !           481:             if ($symb) {
        !           482:                 my ($map,$id,$url)=&Apache::lonnet::decode_symb($symb);
        !           483:                 my $mapurl = &Apache::lonnet::clutter($map);
        !           484:                 my $mapsymb = &Apache::lonnet::symbread($map);
        !           485:                 if ((&Apache::lonnet::EXT('resource.0.encrypturl',$mapsymb) =~ /^yes$/i) &&
        !           486:                     (!$env{'request.role.adv'})) {
        !           487:                     $return_url = &Apache::lonenc::encrypted($mapurl);
        !           488:                 } else {
        !           489:                     $return_url = $mapurl;
        !           490:                 }
        !           491:                 $return_url .= '?navmap=1';
        !           492:             } elsif ($env{'httpref.'.$env{'request.noversionuri'}} eq '/adm/coursedoc') {
        !           493:                 $return_url = '/adm/supplemental';
        !           494:             } else {
        !           495:                 $return_url = '/adm/navmaps';
        !           496:             }
        !           497:             $ltiparams{'launch_presentation_return_url'} = $location.$return_url;
        !           498:         } else {
        !           499:             my $uri = $env{'request.noversionuri'};
        !           500:             if ($env{'request.enc'}) {
        !           501:                 $uri = &Apache::lonenc::encrypted($uri);
        !           502:             }
        !           503:             $ltiparams{'launch_presentation_return_url'} = $location.$uri;
        !           504:         }
        !           505:     } elsif ($returnurl eq 'custom') {
        !           506:         if ($backtourl ne '') {
        !           507:             $ltiparams{'launch_presentation_return_url'} = $backtourl;
        !           508:         }
        !           509:     }
1.1       raeburn   510:     return %ltiparams;
                    511: }
                    512: 
                    513: sub launch_html {
1.24      raeburn   514:     my ($cdom,$cnum,$crstool,$url,$idx,$keynum,$submittext,$paramsref,$inforef) = @_;
                    515:     my ($status,$hashref) =
1.25      raeburn   516:         &Apache::lonnet::sign_lti($cdom,$cnum,$crstool,'tools','launch',$url,$idx,$keynum,
                    517:                                   $paramsref,$inforef);
1.24      raeburn   518:     unless ($status eq 'ok') {
                    519:         return '<div class="LC_warning">'.&mt('External Tool Unavailable').'</div>';
                    520:     }
1.5       raeburn   521:     my $action = &HTML::Entities::encode($url,'<>&"');
1.1       raeburn   522:     my $form = <<"END";
                    523: <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
                    524: <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
                    525: <body>
                    526: <div id="LCltiLaunch">
1.5       raeburn   527: <form name="LCltiLaunchForm" id="LCltiLaunchFormId" action="$action" method="post" encType="application/x-www-form-urlencoded">
1.1       raeburn   528: END
                    529:     if (ref($hashref) eq 'HASH') {
                    530:         foreach my $item (keys(%{$hashref})) {
1.3       raeburn   531:             my $type = 'hidden';
                    532:             if ($item eq 'basiclti_submit') {
                    533:                 $type = 'submit';
                    534:             }
                    535:             $form .= '<input type="'.$type.'" name="'.$item.'" value="'.$hashref->{$item}.'" id="id_'.$item.'" />'."\n";
1.1       raeburn   536:         }
                    537:     }
                    538:     $form .= "</form></div>\n";
                    539:     $form .= <<"ENDJS";
                    540: <script type="text/javascript">
                    541:     document.getElementById("LCltiLaunch").style.display = "none";
                    542:     nei = document.createElement('input');
                    543:     nei.setAttribute('type','hidden');
1.3       raeburn   544:     nei.setAttribute('name','basiclti_submit');
1.1       raeburn   545:     nei.setAttribute('value','$submittext');
1.3       raeburn   546:     document.getElementById("LCltiLaunchFormId").appendChild(nei);
1.1       raeburn   547:     document.LCltiLaunchForm.submit();
                    548:  </script>
                    549: ENDJS
                    550:     $form .= "</body></html>\n";
                    551:     return $form;
                    552: }
                    553: 
1.12      raeburn   554: sub gradabletool_access_check {
1.15      raeburn   555:     my ($target) = @_;
1.12      raeburn   556:     my ($result,$resource_due);
                    557:     my $status;
                    558:     my ($symb,$courseid,$udom,$uname) = &Apache::lonnet::whichuser();
                    559:     my @targets;
1.15      raeburn   560:     if ($target) {
                    561:         @targets = ($target);
                    562:     } elsif (defined($env{'form.submitted'}) && defined($env{'form.validate'})) {
1.12      raeburn   563:         @targets = ('grade','web');
                    564:     } else {
                    565:         @targets = ('web');
                    566:     }
                    567:     foreach my $target (@targets) {
1.18      raeburn   568:         &Apache::structuretags::initialize_storage($symb);
1.12      raeburn   569:         &Apache::lonhomework::set_show_problem_status(&Apache::lonnet::EXT('resource.0.problemstatus'));
                    570:         my ($accessmsg,$slot_name,$slot,$ipused);
                    571:         ($status,$accessmsg,$slot_name,$slot,$ipused) =
                    572:             &Apache::lonhomework::check_slot_access('0','tool',$symb);
                    573:         if (( $status eq 'CLOSED' ) ||
                    574:             ( $status eq 'UNCHECKEDOUT') ||
                    575:             ( $status eq 'NOT_YET_VIEWED') ||
                    576:             ( $status eq 'BANNED') ||
                    577:             ( $status eq 'UNAVAILABLE') ||
                    578:             ( $status eq 'NOT_IN_A_SLOT') ||
                    579:             ( $status eq 'NOTRESERVABLE') ||
                    580:             ( $status eq 'RESERVABLE') ||
                    581:             ( $status eq 'RESERVABLE_LATER') ||
                    582:             ( $status eq 'INVALID_ACCESS') ||
                    583:             ( $status eq 'NEED_DIFFERENT_IP') ||
                    584:             ( $status eq 'WAITING_FOR_GRADE')) {
                    585:             $result = &Apache::structuretags::access_status_msg('tool',$status,$symb,
                    586:                                                                 $target,$ipused,$accessmsg);
                    587:         } elsif ($status eq 'NEEDS_CHECKIN') {
                    588:             $result = &Apache::structuretags::checkin_prompt($target,$slot_name,$slot,'tool');
                    589:         } elsif ($target eq 'web') {
                    590:             if ($status eq 'CAN_ANSWER') {
                    591:                 $resource_due = &Apache::lonhomework::due_date(0, $env{'request.symb'});
                    592:                 if ($slot_name ne '') {
                    593:                     $resource_due = &Apache::structuretags::selfcheckin_resource($resource_due,
                    594:                                                                                  $slot_name,$slot,
                    595:                                                                                  $env{'request.symb'});
                    596:                 }
                    597:             }
                    598:         }
1.18      raeburn   599:         if (keys(%Apache::lonhomework::results)) {
                    600:             &Apache::structuretags::finalize_storage();
                    601:         }
1.12      raeburn   602:     }
                    603:     return ($status,$result,$resource_due);
                    604: }
                    605: 
                    606: sub display_score {
1.15      raeburn   607:     my ($target) = @_;
1.12      raeburn   608:     my $weight = &Apache::lonnet::EXT('resource.0.weight');
                    609:     if ((!defined($weight)) || ($weight eq '')) { $weight=1; }
                    610:     my $awarded = $Apache::lonhomework::history{'resource.0.awarded'};
                    611:     if (!defined($awarded)) { $awarded=0; }
                    612:     my $display='';
1.15      raeburn   613:     if ($target eq 'tex') {
                    614:         $display = '\\\\';
                    615:     }
1.12      raeburn   616:     if (!defined($awarded)) {
1.15      raeburn   617:         $display .= &mt('[_1] possible points.',$weight);
1.12      raeburn   618:     } else {
                    619:         my $points = $awarded*$weight;
                    620:         my $result = sprintf('%.2f',$points);
1.15      raeburn   621:         $display .= &mt('You have [_1] out of [quant,_2,possible point]',
1.12      raeburn   622:                        $result,$weight);
                    623:     }
                    624:     my $comment = $Apache::lonhomework::history{'resource.0.comment'};
                    625:     if (!defined($comment) || $comment!~/\w/) {
                    626:         $comment='';
                    627:     } else {
1.15      raeburn   628:         if ($target eq 'tex') {
                    629:             $comment = '\\\\'.$comment;
                    630:         } else {
                    631:             $comment='<br /><table><tr><td bgcolor="#FFFFDD">'.$comment.'</td></tr></table>';
                    632:         }
1.12      raeburn   633:     }
                    634:     my $gradeinfo = $Apache::lonhomework::history{'resource.0.gradeinfo'};
                    635:     if (!defined($gradeinfo) || $gradeinfo!~/\w/) {
                    636:         $gradeinfo='';
                    637:     } else {
1.15      raeburn   638:         if ($target eq 'tex') {
                    639:             $gradeinfo = '\\\\'.$gradeinfo;
                    640:         } else {
                    641:             $gradeinfo='<br /><table><tr><td bgcolor="#DDDDFF"><font size="+2">'.$gradeinfo.'</font></td></tr></table>';
                    642:         }
1.12      raeburn   643:     }
                    644:     return $display.$comment.$gradeinfo;
                    645: }
                    646: 
1.1       raeburn   647: 1;

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