--- loncom/lonnet/perl/lonnet.pm 2022/02/27 03:08:04 1.1172.2.146.2.5
+++ loncom/lonnet/perl/lonnet.pm 2023/09/04 18:59:17 1.1172.2.146.2.14
@@ -1,7 +1,7 @@
# The LearningOnline Network
# TCP networking package
#
-# $Id: lonnet.pm,v 1.1172.2.146.2.5 2022/02/27 03:08:04 raeburn Exp $
+# $Id: lonnet.pm,v 1.1172.2.146.2.14 2023/09/04 18:59:17 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -365,6 +365,63 @@ sub remote_devalidate_cache {
return &reply('devalidatecache:'.&escape($cachestr),$lonhost);
}
+sub sign_lti {
+ my ($cdom,$cnum,$crsdef,$type,$context,$url,$ltinum,$keynum,$paramsref,$inforef) = @_;
+ my $chome;
+ if (&domain($cdom) ne '') {
+ if ($crsdef) {
+ $chome = &homeserver($cnum,$cdom);
+ } else {
+ $chome = &domain($cdom,'primary');
+ }
+ }
+ if ($cdom && $chome && ($chome ne 'no_host')) {
+ if ((ref($paramsref) eq 'HASH') &&
+ (ref($inforef) eq 'HASH')) {
+ my $rep;
+ if (grep { $_ eq $chome } ¤t_machine_ids()) {
+ # domain information is hosted on this machine
+ $rep =
+ &LONCAPA::Lond::sign_lti_payload($cdom,$cnum,$crsdef,$type,
+ $context,$url,$ltinum,$keynum,
+ $perlvar{'lonVersion'},
+ $paramsref,$inforef);
+ if (ref($rep) eq 'HASH') {
+ return ('ok',$rep);
+ }
+ } else {
+ my ($escurl,$params,$info);
+ $escurl = &escape($url);
+ if (ref($paramsref) eq 'HASH') {
+ $params = &freeze_escape($paramsref);
+ }
+ if (ref($inforef) eq 'HASH') {
+ $info = &freeze_escape($inforef);
+ }
+ $rep=&reply("encrypt:signlti:$cdom:$cnum:$crsdef:$type:$context:$escurl:$ltinum:$keynum:$params:$info",$chome);
+ }
+ if (($rep eq '') || ($rep =~ /^con_lost|error|no_such_host|unknown_cmd/i)) {
+ return ();
+ } elsif (($inforef->{'respfmt'} eq 'to_post_body') ||
+ ($inforef->{'respfmt'} eq 'to_authorization_header')) {
+ return ('ok',$rep);
+ } else {
+ my %returnhash;
+ foreach my $item (split(/\&/,$rep)) {
+ my ($name,$value)=split(/\=/,$item);
+ $returnhash{&unescape($name)}=&thaw_unescape($value);
+ }
+ return('ok',\%returnhash);
+ }
+ } else {
+ return ();
+ }
+ } else {
+ return ();
+ &logthis("sign_lti failed - no homeserver and/or domain ($cdom) ($chome)");
+ }
+}
+
# -------------------------------------------------- Non-critical communication
sub subreply {
my ($cmd,$server)=@_;
@@ -418,14 +475,15 @@ sub reply {
my $subcmd = $1;
if (($subcmd eq 'auth') || ($subcmd eq 'passwd') ||
($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
- ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades')) {
+ ($subcmd eq 'putdom') || ($subcmd eq 'autoexportgrades') ||
+ ($subcmd eq 'put')) {
(undef,undef,my @rest) = split(/:/,$cmd);
if (($subcmd eq 'auth') || ($subcmd eq 'putdom')) {
splice(@rest,2,1,'Hidden');
} elsif ($subcmd eq 'passwd') {
splice(@rest,2,2,('Hidden','Hidden'));
} elsif (($subcmd eq 'changeuserauth') || ($subcmd eq 'makeuser') ||
- ($subcmd eq 'autoexportgrades')) {
+ ($subcmd eq 'autoexportgrades') || ($subcmd eq 'put')) {
splice(@rest,3,1,'Hidden');
}
$logged = join(':',('encrypt:'.$subcmd,@rest));
@@ -694,6 +752,11 @@ sub check_for_valid_session {
if ($disk_env{'request.role'}) {
$userhashref->{'role'} = $disk_env{'request.role'};
}
+ $userhashref->{'lti'} = $disk_env{'request.lti.login'};
+ if ($userhashref->{'lti'}) {
+ $userhashref->{'ltitarget'} = $disk_env{'request.lti.target'};
+ $userhashref->{'ltiuri'} = $disk_env{'request.lti.uri'};
+ }
}
untie(%disk_env);
@@ -1035,6 +1098,20 @@ sub find_existing_session {
return;
}
+sub delusersession {
+ my ($lonid,$udom,$uname) = @_;
+ my $uprimary_id = &domain($udom,'primary');
+ my $uintdom = &internet_dom($uprimary_id);
+ my $intdom = &internet_dom($lonid);
+ my $serverhomedom = &host_domain($lonid);
+ if (($uintdom ne '') && ($uintdom eq $intdom)) {
+ return &reply(join(':','delusersession',
+ map {&escape($_)} ($udom,$uname)),$lonid);
+ }
+ return;
+}
+
+
# check if user's browser sent load balancer cookie and server still has session
# and is not overloaded.
sub check_for_balancer_cookie {
@@ -1309,6 +1386,29 @@ sub authenticate {
return 'no_host';
}
+sub can_switchserver {
+ my ($udom,$home) = @_;
+ my ($canswitch,@intdoms);
+ my $internet_names = &get_internet_names($home);
+ if (ref($internet_names) eq 'ARRAY') {
+ @intdoms = @{$internet_names};
+ }
+ my $uint_dom = &internet_dom(&domain($udom,'primary'));
+ if ($uint_dom ne '' && grep(/^\Q$uint_dom\E$/,@intdoms)) {
+ $canswitch = 1;
+ } else {
+ my $serverhomeID = &get_server_homeID(&hostname($home));
+ my $serverhomedom = &host_domain($serverhomeID);
+ my %defdomdefaults = &get_domain_defaults($serverhomedom);
+ my %udomdefaults = &get_domain_defaults($udom);
+ my $remoterev = &get_server_loncaparev('',$home);
+ $canswitch = &can_host_session($udom,$home,$remoterev,
+ $udomdefaults{'remotesessions'},
+ $defdomdefaults{'hostedsessions'});
+ }
+ return $canswitch;
+}
+
sub can_host_session {
my ($udom,$lonhost,$remoterev,$remotesessions,$hostedsessions) = @_;
my $canhost = 1;
@@ -2412,7 +2512,9 @@ sub get_domain_defaults {
'coursedefaults','usersessions',
'requestauthor','selfenrollment',
'coursecategories','autoenroll',
- 'helpsettings','wafproxy','ltisec'],$domain);
+ 'helpsettings','wafproxy','ltisec',
+ 'toolsec','domexttool','exttool'],
+ $domain);
my @coursetypes = ('official','unofficial','community','textbook');
if (ref($domconfig{'defaults'}) eq 'HASH') {
$domdefaults{'lang_def'} = $domconfig{'defaults'}{'lang_def'};
@@ -2421,6 +2523,8 @@ sub get_domain_defaults {
$domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
$domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
$domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
+ $domdefaults{'portal_def_email'} = $domconfig{'defaults'}{'portal_def_email'};
+ $domdefaults{'portal_def_web'} = $domconfig{'defaults'}{'portal_def_web'};
$domdefaults{'intauth_cost'} = $domconfig{'defaults'}{'intauth_cost'};
$domdefaults{'intauth_switch'} = $domconfig{'defaults'}{'intauth_switch'};
$domdefaults{'intauth_check'} = $domconfig{'defaults'}{'intauth_check'};
@@ -2475,12 +2579,25 @@ sub get_domain_defaults {
if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
$domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$type};
}
+ if (ref($domconfig{'coursedefaults'}{'coursequota'}) eq 'HASH') {
+ $domdefaults{$type.'coursequota'} = $domconfig{'coursedefaults'}{'coursequota'}{$type};
+ }
if ($domdefaults{'postsubmit'} eq 'on') {
if (ref($domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}) eq 'HASH') {
$domdefaults{$type.'postsubtimeout'} =
$domconfig{'coursedefaults'}{'postsubmit'}{'timeout'}{$type};
}
}
+ if (ref($domconfig{'coursedefaults'}{'domexttool'}) eq 'HASH') {
+ $domdefaults{$type.'domexttool'} = $domconfig{'coursedefaults'}{'domexttool'}{$type};
+ } else {
+ $domdefaults{$type.'domexttool'} = 1;
+ }
+ if (ref($domconfig{'coursedefaults'}{'exttool'}) eq 'HASH') {
+ $domdefaults{$type.'exttool'} = $domconfig{'coursedefaults'}{'exttool'}{$type};
+ } else {
+ $domdefaults{$type.'exttool'} = 0;
+ }
}
if (ref($domconfig{'coursedefaults'}{'canclone'}) eq 'HASH') {
if (ref($domconfig{'coursedefaults'}{'canclone'}{'instcode'}) eq 'ARRAY') {
@@ -2576,7 +2693,18 @@ sub get_domain_defaults {
}
if (ref($domconfig{'ltisec'}{'private'}) eq 'HASH') {
if (ref($domconfig{'ltisec'}{'private'}{'keys'}) eq 'ARRAY') {
- $domdefaults{'privhosts'} = $domconfig{'ltisec'}{'private'}{'keys'};
+ $domdefaults{'ltiprivhosts'} = $domconfig{'ltisec'}{'private'}{'keys'};
+ }
+ }
+ }
+ if (ref($domconfig{'toolsec'}) eq 'HASH') {
+ if (ref($domconfig{'toolsec'}{'encrypt'}) eq 'HASH') {
+ $domdefaults{'toolenc_crs'} = $domconfig{'toolsec'}{'encrypt'}{'crs'};
+ $domdefaults{'toolenc_dom'} = $domconfig{'toolsec'}{'encrypt'}{'dom'};
+ }
+ if (ref($domconfig{'toolsec'}{'private'}) eq 'HASH') {
+ if (ref($domconfig{'toolsec'}{'private'}{'keys'}) eq 'ARRAY') {
+ $domdefaults{'toolprivhosts'} = $domconfig{'toolsec'}{'private'}{'keys'};
}
}
}
@@ -2616,6 +2744,7 @@ sub get_dom_instcats {
if (&auto_instcode_format($caller,$dom,\%coursecodes,\%codes,
\@codetitles,\%cat_titles,\%cat_order) eq 'ok') {
$instcats = {
+ totcodes => $totcodes,
codes => \%codes,
codetitles => \@codetitles,
cat_titles => \%cat_titles,
@@ -2684,6 +2813,26 @@ sub course_portal_url {
return $firsturl;
}
+sub url_prefix {
+ my ($r,$dom,$home,$context) = @_;
+ my $prefix;
+ my %domdefs = &get_domain_defaults($dom);
+ if ($domdefs{'portal_def'} && $domdefs{'portal_def_'.$context}) {
+ if ($domdefs{'portal_def'} =~ m{^(https?://[^/]+)}) {
+ $prefix = $1;
+ }
+ }
+ if ($prefix eq '') {
+ my $hostname = &hostname($home);
+ my $protocol = $protocol{$home};
+ $protocol = 'http' if ($protocol{$home} ne 'https');
+ my $alias = &use_proxy_alias($r,$home);
+ $hostname = $alias if ($alias ne '');
+ $prefix = $protocol.'://'.$hostname;
+ }
+ return $prefix;
+}
+
# --------------------------------------------------- Assign a key to a student
sub assign_access_key {
@@ -3941,7 +4090,7 @@ sub resizeImage {
# input: $formname - the contents of the file are in $env{"form.$formname"}
# the desired filename is in $env{"form.$formname.filename"}
# $context - possible values: coursedoc, existingfile, overwrite,
-# canceloverwrite, scantron or ''.
+# canceloverwrite, scantron, toollogo or ''.
# if 'coursedoc': upload to the current course
# if 'existingfile': write file to tmp/overwrites directory
# if 'canceloverwrite': delete file written to tmp/overwrites directory
@@ -3953,8 +4102,8 @@ sub resizeImage {
# Section => 4, CODE => 5, FirstQuestion => 9 }).
# $allfiles - reference to hash for embedded objects
# $codebase - reference to hash for codebase of java objects
-# $desuname - username for permanent storage of uploaded file
-# $dsetudom - domain for permanaent storage of uploaded file
+# $destuname - username for permanent storage of uploaded file
+# $destudom - domain for permanaent storage of uploaded file
# $thumbwidth - width (pixels) of thumbnail to make for uploaded image
# $thumbheight - height (pixels) of thumbnail to make for uploaded image
# $resizewidth - width (pixels) to which to resize uploaded image
@@ -4164,11 +4313,24 @@ sub finishuserfileupload {
if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
my $input = $filepath.'/'.$file;
my $output = $filepath.'/'.'tn-'.$file;
+ my $makethumb;
my $thumbsize = $thumbwidth.'x'.$thumbheight;
- my @args = ('convert','-sample',$thumbsize,$input,$output);
- system({$args[0]} @args);
- if (-e $filepath.'/'.'tn-'.$file) {
- $fetchthumb = 1;
+ if ($context eq 'toollogo') {
+ my ($fullwidth,$fullheight) = &check_dimensions($input);
+ if ($fullwidth ne '' && $fullheight ne '') {
+ if ($fullwidth > $thumbwidth && $fullheight > $thumbheight) {
+ $makethumb = 1;
+ }
+ }
+ } else {
+ $makethumb = 1;
+ }
+ if ($makethumb) {
+ my @args = ('convert','-sample',$thumbsize,$input,$output);
+ system({$args[0]} @args);
+ if (-e $filepath.'/'.'tn-'.$file) {
+ $fetchthumb = 1;
+ }
}
}
@@ -4400,6 +4562,30 @@ sub embedded_dependency {
return;
}
+sub check_dimensions {
+ my ($inputfile) = @_;
+ my ($fullwidth,$fullheight);
+ if (($inputfile =~ m|^[/\w.\-]+$|) && (-e $inputfile)) {
+ my $mm = new File::MMagic;
+ my $mime_type = $mm->checktype_filename($inputfile);
+ if ($mime_type =~ m{^image/}) {
+ if (open(PIPE,"identify $inputfile 2>&1 |")) {
+ my $imageinfo = <PIPE>;
+ if (!close(PIPE)) {
+ &Apache::lonnet::logthis("Failed to close PIPE opened to retrieve image information for $inputfile");
+ }
+ chomp($imageinfo);
+ my ($fullsize) =
+ ($imageinfo =~ /^\Q$inputfile\E\s+\w+\s+(\d+x\d+)/);
+ if ($fullsize) {
+ ($fullwidth,$fullheight) = split(/x/,$fullsize);
+ }
+ }
+ }
+ }
+ return ($fullwidth,$fullheight);
+}
+
sub bubblesheet_converter {
my ($cdom,$fullpath,$config,$format) = @_;
if ((&domain($cdom) ne '') &&
@@ -4636,6 +4822,7 @@ sub get_scantronformat_file {
close($fh);
}
}
+ chomp(@lines);
}
return @lines;
}
@@ -4762,7 +4949,7 @@ sub flushcourselogs {
# Typo in rev. 1.458 (2003/12/09)??
# These should likely by $env{'course.'.$cid.'.domain'} and $env{'course.'.$cid.'.num'}
#
-# While these ramain as $env{'request.'.$cid.'.domain'} and $env{'request.'.$cid.'.num'}
+# While these remain as $env{'request.'.$cid.'.domain'} and $env{'request.'.$cid.'.num'}
# $dom and $name will always be null, so the &inc() call will default to storing this data
# in a nohist_accesscount.db file for the user rather than the course.
#
@@ -6653,31 +6840,31 @@ sub course_adhocrole_privs {
$full{$priv} = $restrict;
}
foreach my $item (split(/,/,$overrides{"internal.adhocpriv.$rolename"})) {
- next if ($item eq '');
- my ($rule,$rest) = split(/=/,$item);
- next unless (($rule eq 'off') || ($rule eq 'on'));
- foreach my $priv (split(/:/,$rest)) {
- if ($priv ne '') {
- if ($rule eq 'off') {
- $possremove{$priv} = 1;
- } else {
- $possadd{$priv} = 1;
- }
- }
- }
- }
- foreach my $priv (sort(keys(%full))) {
- if (exists($currprivs{$priv})) {
- unless (exists($possremove{$priv})) {
- $storeprivs{$priv} = $currprivs{$priv};
- }
- } elsif (exists($possadd{$priv})) {
- $storeprivs{$priv} = $full{$priv};
- }
- }
- $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
- }
- return $coursepriv;
+ next if ($item eq '');
+ my ($rule,$rest) = split(/=/,$item);
+ next unless (($rule eq 'off') || ($rule eq 'on'));
+ foreach my $priv (split(/:/,$rest)) {
+ if ($priv ne '') {
+ if ($rule eq 'off') {
+ $possremove{$priv} = 1;
+ } else {
+ $possadd{$priv} = 1;
+ }
+ }
+ }
+ }
+ foreach my $priv (sort(keys(%full))) {
+ if (exists($currprivs{$priv})) {
+ unless (exists($possremove{$priv})) {
+ $storeprivs{$priv} = $currprivs{$priv};
+ }
+ } elsif (exists($possadd{$priv})) {
+ $storeprivs{$priv} = $full{$priv};
+ }
+ }
+ $coursepriv = ':'.join(':',map { $_.'&'.$storeprivs{$_}; } sort(keys(%storeprivs)));
+ }
+ return $coursepriv;
}
sub group_roleprivs {
@@ -7711,6 +7898,17 @@ sub is_portfolio_file {
return;
}
+sub is_coursetool_logo {
+ my ($uri) = @_;
+ if ($env{'request.course.id'}) {
+ my $courseurl = &courseid_to_courseurl($env{'request.course.id'});
+ if ($uri =~ m{^/*uploaded\Q$courseurl\E/toollogo/\d+/[^/]+$}) {
+ return 1;
+ }
+ }
+ return;
+}
+
sub usertools_access {
my ($uname,$udom,$tool,$action,$context,$userenvref,$domdefref,$is_advref)=@_;
my ($access,%tools);
@@ -7723,6 +7921,7 @@ sub usertools_access {
unofficial => 1,
community => 1,
textbook => 1,
+ lti => 1,
);
} elsif ($context eq 'requestauthor') {
%tools = (
@@ -7734,6 +7933,7 @@ sub usertools_access {
blog => 1,
webdav => 1,
portfolio => 1,
+ timezone => 1,
);
}
return if (!defined($tools{$tool}));
@@ -7919,25 +8119,29 @@ sub is_advanced_user {
}
sub check_can_request {
- my ($dom,$can_request,$request_domains) = @_;
+ my ($dom,$can_request,$request_domains,$uname,$udom) = @_;
my $canreq = 0;
+ if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '')) {
+ $uname = $env{'user.name'};
+ $udom = $env{'user.domain'};
+ }
my ($types,$typename) = &Apache::loncommon::course_types();
my @options = ('approval','validate','autolimit');
my $optregex = join('|',@options);
if ((ref($can_request) eq 'HASH') && (ref($types) eq 'ARRAY')) {
foreach my $type (@{$types}) {
- if (&usertools_access($env{'user.name'},
- $env{'user.domain'},
- $type,undef,'requestcourses')) {
+ if (&usertools_access($uname,$udom,$type,undef,
+ 'requestcourses')) {
$canreq ++;
if (ref($request_domains) eq 'HASH') {
- push(@{$request_domains->{$type}},$env{'user.domain'});
+ push(@{$request_domains->{$type}},$udom);
}
- if ($dom eq $env{'user.domain'}) {
+ if ($dom eq $udom) {
$can_request->{$type} = 1;
}
}
- if ($env{'environment.reqcrsotherdom.'.$type} ne '') {
+ if (($env{'user.name'} ne '') && ($env{'user.domain'} ne '') &&
+ ($env{'environment.reqcrsotherdom.'.$type} ne '')) {
my @curr = split(',',$env{'environment.reqcrsotherdom.'.$type});
if (@curr > 0) {
foreach my $item (@curr) {
@@ -7954,7 +8158,7 @@ sub check_can_request {
}
}
}
- unless($dom eq $env{'user.domain'}) {
+ unless ($dom eq $env{'user.domain'}) {
$canreq ++;
if (grep(/^\Q$dom\E:($optregex)(=?\d*)$/,@curr)) {
$can_request->{$type} = 1;
@@ -8326,6 +8530,12 @@ sub allowed {
if ($env{'request.course.id'}) {
+ if ($priv eq 'bre') {
+ if (&is_coursetool_logo($uri)) {
+ return 'F';
+ }
+ }
+
# If this is modifying password (internal auth) domains must match for user and user's role.
if ($priv eq 'mip') {
@@ -10134,8 +10344,12 @@ sub assignrole {
}
}
}
- } elsif (($selfenroll == 1) && ($role eq 'st') && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
- $refused = '';
+ } elsif (($selfenroll == 1) && ($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'})) {
+ if ($role eq 'st') {
+ $refused = '';
+ } elsif (($context eq 'ltienroll') && ($env{'request.lti.login'})) {
+ $refused = '';
+ }
} elsif ($context eq 'requestcourses') {
my @possroles = ('st','ta','ep','in','cc','co');
if ((grep(/^\Q$role\E$/,@possroles)) && ($env{'user.name'} ne '' && $env{'user.domain'} ne '')) {
@@ -10427,10 +10641,14 @@ sub modifyuser {
my $newuser;
if ($uhome eq 'no_host') {
$newuser = 1;
+ unless (($umode && ($upass ne '')) || ($umode eq 'localauth') ||
+ ($umode eq 'lti')) {
+ return 'error: more information needed to create new user';
+ }
}
# ----------------------------------------------------------------- Create User
if (($uhome eq 'no_host') &&
- (($umode && $upass) || ($umode eq 'localauth'))) {
+ (($umode && $upass) || ($umode eq 'localauth') || ($umode eq 'lti'))) {
my $unhome='';
if (defined($desiredhome) && &host_domain($desiredhome) eq $udom) {
$unhome = $desiredhome;
@@ -11777,13 +11995,11 @@ sub get_domain_lti {
} else {
return %lti;
}
-
if ($context eq 'linkprot') {
$cachename = $context;
} else {
$cachename = $name;
}
-
my ($result,$cached)=&is_cached_new($cachename,$cdom);
if (defined($cached)) {
if (ref($result) eq 'HASH') {
@@ -11799,18 +12015,6 @@ sub get_domain_lti {
} else {
%lti = %{$domconfig{$name}};
}
- if (($context eq 'consumer') && (keys(%lti))) {
- my %encdomconfig = &get_dom('encconfig',[$name],$cdom,undef,1);
- if (ref($encdomconfig{$name}) eq 'HASH') {
- foreach my $id (keys(%lti)) {
- if (ref($encdomconfig{$name}{$id}) eq 'HASH') {
- foreach my $item ('key','secret') {
- $lti{$id}{$item} = $encdomconfig{$name}{$id}{$item};
- }
- }
- }
- }
- }
}
my $cachetime = 24*60*60;
&do_cache_new($cachename,$cdom,\%lti,$cachetime);
@@ -11819,20 +12023,29 @@ sub get_domain_lti {
}
sub get_course_lti {
- my ($cnum,$cdom) = @_;
+ my ($cnum,$cdom,$context) = @_;
+ my ($name,$cachename,%lti);
+ if ($context eq 'consumer') {
+ $name = 'ltitools';
+ $cachename = 'courseltitools';
+ } elsif ($context eq 'provider') {
+ $name = 'lti';
+ $cachename = 'courselti';
+ } else {
+ return %lti;
+ }
my $hashid=$cdom.'_'.$cnum;
- my %courselti;
- my ($result,$cached)=&is_cached_new('courselti',$hashid);
+ my ($result,$cached)=&is_cached_new($cachename,$hashid);
if (defined($cached)) {
if (ref($result) eq 'HASH') {
- %courselti = %{$result};
+ %lti = %{$result};
}
} else {
- %courselti = &dump('lti',$cdom,$cnum,undef,undef,undef,1);
+ %lti = &dump($name,$cdom,$cnum,undef,undef,undef,1);
my $cachetime = 24*60*60;
- &do_cache_new('courselti',$hashid,\%courselti,$cachetime);
+ &do_cache_new($cachename,$hashid,\%lti,$cachetime);
}
- return %courselti;
+ return %lti;
}
sub courselti_itemid {
@@ -11841,7 +12054,6 @@ sub courselti_itemid {
$chome = &homeserver($cnum,$cdom);
return if ($chome eq 'no_host');
if (ref($params) eq 'HASH') {
- my $items = &freeze_escape($params);
my $rep;
if (grep { $_ eq $chome } current_machine_ids()) {
$rep = LONCAPA::Lond::crslti_itemid($cdom,$cnum,$url,$method,$params,$perlvar{'lonVersion'});
@@ -11865,7 +12077,6 @@ sub domainlti_itemid {
$primary_id = &domain($cdom,'primary');
return if ($primary_id eq '');
if (ref($params) eq 'HASH') {
- my $items = &freeze_escape($params);
my $rep;
if (grep { $_ eq $primary_id } current_machine_ids()) {
$rep = LONCAPA::Lond::domlti_itemid($cdom,$context,$url,$method,$params,$perlvar{'lonVersion'});
@@ -11884,24 +12095,64 @@ sub domainlti_itemid {
return $itemid;
}
-sub get_numsuppfiles {
- my ($cnum,$cdom,$ignorecache)=@_;
+sub count_supptools {
+ my ($cnum,$cdom,$ignorecache,$reload)=@_;
+ my $hashid=$cnum.':'.$cdom;
+ my ($numexttools,$cached);
+ unless ($ignorecache) {
+ ($numexttools,$cached) = &is_cached_new('supptools',$hashid);
+ }
+ unless (defined($cached)) {
+ my $chome=&homeserver($cnum,$cdom);
+ $numexttools = 0;
+ unless ($chome eq 'no_host') {
+ my ($supplemental) = &Apache::loncommon::get_supplemental($cnum,$cdom,$reload);
+ if (ref($supplemental) eq 'HASH') {
+ if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
+ foreach my $key (keys(%{$supplemental->{'ids'}})) {
+ if ($key =~ m{^/adm/$cdom/$cnum/\d+/ext\.tool$}) {
+ $numexttools ++;
+ }
+ }
+ }
+ }
+ }
+ &do_cache_new('supptools',$hashid,$numexttools,600);
+ }
+ return $numexttools;
+}
+
+sub has_unhidden_suppfiles {
+ my ($cnum,$cdom,$ignorecache,$possdel)=@_;
my $hashid=$cnum.':'.$cdom;
- my ($suppcount,$cached);
+ my ($showsupp,$cached);
unless ($ignorecache) {
- ($suppcount,$cached) = &is_cached_new('suppcount',$hashid);
+ ($showsupp,$cached) = &is_cached_new('showsupp',$hashid);
}
unless (defined($cached)) {
my $chome=&homeserver($cnum,$cdom);
unless ($chome eq 'no_host') {
- ($suppcount,my $errors) = (0,0);
- my $suppmap = 'supplemental.sequence';
- ($suppcount,$errors) =
- &Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
+ my ($supplemental) = &Apache::loncommon::get_supplemental($cnum,$cdom,$ignorecache,$possdel);
+ if (ref($supplemental) eq 'HASH') {
+ if ((ref($supplemental->{'ids'}) eq 'HASH') && (ref($supplemental->{'hidden'}) eq 'HASH')) {
+ foreach my $key (keys(%{$supplemental->{'ids'}})) {
+ next if ($key =~ /\.sequence$/);
+ if (ref($supplemental->{'ids'}->{$key}) eq 'ARRAY') {
+ foreach my $id (@{$supplemental->{'ids'}->{$key}}) {
+ unless ($supplemental->{'hidden'}->{$id}) {
+ $showsupp = 1;
+ last;
+ }
+ }
+ }
+ last if ($showsupp);
+ }
+ }
+ }
}
- &do_cache_new('suppcount',$hashid,$suppcount,600);
+ &do_cache_new('showsupp',$hashid,$showsupp,600);
}
- return $suppcount;
+ return $showsupp;
}
#
@@ -12172,20 +12423,25 @@ sub EXT {
}
# ------------------------------------------ fourth, look in resource metadata
- $spacequalifierrest=~s/\./\_/;
- my $filename;
+ my $what = $spacequalifierrest;
+ $what=~s/\./\_/;
+ my $filename;
if (!$symbparm) { $symbparm=&symbread(); }
if ($symbparm) {
$filename=(&decode_symb($symbparm))[2];
} else {
$filename=$env{'request.filename'};
}
- my $metadata=&metadata($filename,$spacequalifierrest);
+ my $toolsymb;
+ if (($filename =~ /ext\.tool$/) && ($what ne '0_gradable')) {
+ $toolsymb = $symbparm;
+ }
+ my $metadata=&metadata($filename,$what,$toolsymb);
if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
- $metadata=&metadata($filename,'parameter_'.$spacequalifierrest);
+ $metadata=&metadata($filename,'parameter_'.$what,$toolsymb);
if (defined($metadata)) { return &get_reply([$metadata,'resource']); }
-# ---------------------------------------------- fourth, look in rest of course
+# ----------------------------------------------- fifth, look in rest of course
if ($symbparm && defined($courseid) &&
$courseid eq $env{'request.course.id'}) {
my $coursereply=&resdata($env{'course.'.$courseid.'.num'},
@@ -12206,7 +12462,7 @@ sub EXT {
if (defined($partgeneral[0])) { return &get_reply(\@partgeneral); }
}
if ($recurse) { return undef; }
- my $pack_def=&packages_tab_default($filename,$varname);
+ my $pack_def=&packages_tab_default($filename,$varname,$toolsymb);
if (defined($pack_def)) { return &get_reply([$pack_def,'resource']); }
# ---------------------------------------------------- Any other user namespace
} elsif ($realm eq 'environment') {
@@ -12299,11 +12555,11 @@ sub sort_course_groups { # Sort groups b
}
sub packages_tab_default {
- my ($uri,$varname)=@_;
+ my ($uri,$varname,$toolsymb)=@_;
my (undef,$part,$name)=split(/\./,$varname);
my (@extension,@specifics,$do_default);
- foreach my $package (split(/,/,&metadata($uri,'packages'))) {
+ foreach my $package (split(/,/,&metadata($uri,'packages',$toolsymb))) {
my ($pack_type,$pack_part)=split(/_/,$package,2);
if ($pack_type eq 'default') {
$do_default=1;
@@ -12372,7 +12628,7 @@ my %metaentry;
my %importedpartids;
my %importedrespids;
sub metadata {
- my ($uri,$what,$liburi,$prefix,$depthcount)=@_;
+ my ($uri,$what,$toolsymb,$liburi,$prefix,$depthcount)=@_;
$uri=&declutter($uri);
# if it is a non metadata possible uri return quickly
if (($uri eq '') ||
@@ -12396,6 +12652,65 @@ sub metadata {
my ($result,$cached)=&is_cached_new('meta',$uri);
if (defined($cached)) { return $result->{':'.$what}; }
}
+
+#
+# If the uri is for an external tool the file from
+# which metadata should be retrieved depends on whether
+# the tool had been configured to be gradable (set in the Course
+# Editor or Resource Editor).
+#
+# If a valid symb has been included as the third arg in the call
+# to &metadata() that can be used to retrieve the value of
+# parameter_0_gradable set for the resource, and included in the
+# uploaded map containing the tool. The value is retrieved via
+# &EXT(), if a valid symb is available. Otherwise the value of
+# gradable in the exttool_$marker.db file for the tool instance
+# is retrieved via &get().
+#
+# When lonuserstate::traceroute() calls lonnet::EXT() for
+# hiddenresource and encrypturl (during course initialization)
+# the map-level parameter for resource.0.gradable included in the
+# uploaded map containing the tool will not yet have been stored
+# in the user_course_parms.db file for the user's session, so in
+# this case fall back to retrieving gradable status from the
+# exttool_$marker.db file.
+#
+# In order to avoid an infinite loop, &metadata() will return
+# before a call to &EXT(), if the uri is for an external tool
+# and the $what for which metadata is being requested is
+# parameter_0_gradable or 0_gradable.
+#
+
+ if ($uri =~ /ext\.tool$/) {
+ if (($what eq 'parameter_0_gradable') || ($what eq '0_gradable')) {
+ return;
+ } else {
+ my ($checked,$use_passback);
+ if ($toolsymb ne '') {
+ (undef,undef,my $tooluri) = &decode_symb($toolsymb);
+ if (($tooluri eq $uri) && (&EXT('resource.0.gradable',$toolsymb))) {
+ $checked = 1;
+ if (&EXT('resource.0.gradable',$toolsymb) =~ /^yes$/i) {
+ $use_passback = 1;
+ }
+ }
+ }
+ unless ($checked) {
+ my ($ignore,$cdom,$cnum,$marker) = split(m{/},$uri);
+ $marker=~s/\D//g;
+ if ($marker) {
+ my %toolsettings=&get('exttool_'.$marker,['gradable'],$cdom,$cnum);
+ $use_passback = $toolsettings{'gradable'};
+ }
+ }
+ if ($use_passback) {
+ $filename = '/home/httpd/html/res/lib/templates/LTIpassback.tool';
+ } else {
+ $filename = '/home/httpd/html/res/lib/templates/LTIstandard.tool';
+ }
+ }
+ }
+
{
# Imported parts would go here
my @origfiletagids=();
@@ -12569,7 +12884,7 @@ sub metadata {
if ($depthcount<20) {
my $metadata =
- &metadata($uri,'keys', $location,$unikey,
+ &metadata($uri,'keys',$toolsymb,$location,$unikey,
$depthcount+1);
foreach my $meta (split(',',$metadata)) {
$metaentry{':'.$meta}=$metaentry{':'.$meta};
@@ -12644,7 +12959,7 @@ sub metadata {
$dir=~s|[^/]*$||;
$location=&filelocation($dir,$location);
my $rights_metadata =
- &metadata($uri,'keys',$location,'_rights',
+ &metadata($uri,'keys',$toolsymb,$location,'_rights',
$depthcount+1);
foreach my $rights (split(',',$rights_metadata)) {
#$metaentry{':'.$rights}=$metacache{$uri}->{':'.$rights};
@@ -12913,11 +13228,68 @@ sub get_coursechange {
}
sub devalidate_coursechange_cache {
- my ($cnum,$cdom)=@_;
- my $hashid=$cnum.':'.$cdom;
+ my ($cdom,$cnum)=@_;
+ my $hashid=$cdom.'_'.$cnum;
&devalidate_cache_new('crschange',$hashid);
}
+sub get_suppchange {
+ my ($cdom,$cnum) = @_;
+ if ($cdom eq '' || $cnum eq '') {
+ return unless ($env{'request.course.id'});
+ $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+ $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+ }
+ my $hashid=$cdom.'_'.$cnum;
+ my ($change,$cached)=&is_cached_new('suppchange',$hashid);
+ if ((defined($cached)) && ($change ne '')) {
+ return $change;
+ } else {
+ my %crshash = &get('environment',['internal.supplementalchange'],$cdom,$cnum);
+ if ($crshash{'internal.supplementalchange'} eq '') {
+ $change = $env{'course.'.$cdom.'_'.$cnum.'.internal.created'};
+ if ($change eq '') {
+ %crshash = &get('environment',['internal.created'],$cdom,$cnum);
+ $change = $crshash{'internal.created'};
+ }
+ } else {
+ $change = $crshash{'internal.supplementalchange'};
+ }
+ my $cachetime = 600;
+ &do_cache_new('suppchange',$hashid,$change,$cachetime);
+ }
+ return $change;
+}
+
+sub devalidate_suppchange_cache {
+ my ($cdom,$cnum)=@_;
+ my $hashid=$cdom.'_'.$cnum;
+ &devalidate_cache_new('suppchange',$hashid);
+}
+
+sub update_supp_caches {
+ my ($cdom,$cnum) = @_;
+ my %servers = &internet_dom_servers($cdom);
+ my @ids=¤t_machine_ids();
+ foreach my $server (keys(%servers)) {
+ next if (grep(/^\Q$server\E$/,@ids));
+ my $hashid=$cnum.':'.$cdom;
+ my $cachekey = &escape('showsupp').':'.&escape($hashid);
+ &remote_devalidate_cache($server,[$cachekey]);
+ }
+ &has_unhidden_suppfiles($cnum,$cdom,1,1);
+ &count_supptools($cnum,$cdom,1);
+ my $now = time;
+ if ($env{'request.course.id'} eq $cdom.'_'.$cnum) {
+ &Apache::lonnet::appenv({'request.course.suppupdated' => $now});
+ }
+ &put('environment',{'internal.supplementalchange' => $now},
+ $cdom,$cnum);
+ &Apache::lonnet::appenv(
+ {'course.'.$cdom.'_'.$cnum.'.internal.supplementalchange' => $now});
+ &do_cache_new('suppchange',$cdom.'_'.$cnum,$now,600);
+}
+
# ------------------------------------------------- Update symbolic store links
sub symblist {
@@ -13104,17 +13476,10 @@ sub symbread {
my %bighash;
my $syval='';
if (($env{'request.course.fn'}) && ($thisfn)) {
- my $targetfn = $thisfn;
- if ( ($thisfn =~ m/^(uploaded|editupload)\//) && ($thisfn !~ m/\.(page|sequence)$/) ) {
- $targetfn = 'adm/wrapper/'.$thisfn;
- }
- if ($targetfn =~ m|^adm/wrapper/(ext/.*)|) {
- $targetfn=$1;
- }
unless ($ignoresymbdb) {
if (tie(%hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
&GDBM_READER(),0640)) {
- $syval=$hash{$targetfn};
+ $syval=$hash{$thisfn};
untie(%hash);
}
if ($syval && $checkforblock) {
@@ -15652,10 +16017,6 @@ data base, returning a hash that is keye
values that are the resource value. I believe that the timestamps and
versions are also returned.
-get_numsuppfiles($cnum,$cdom) : retrieve number of files in a course's
-supplemental content area. This routine caches the number of files for
-10 minutes.
-
=back
=head2 Course Modification
@@ -15823,10 +16184,14 @@ condval($condidx) : value of condition i
=item *
-metadata($uri,$what,$liburi,$prefix,$depthcount) : request a
+metadata($uri,$what,$toolsymb,$liburi,$prefix,$depthcount) : request a
resource's metadata, $what should be either a specific key, or either
'keys' (to get a list of possible keys) or 'packages' to get a list of
-packages that this resource currently uses, the last 3 arguments are only used internally for recursive metadata.
+packages that this resource currently uses, the last 3 arguments are
+only used internally for recursive metadata.
+
+the toolsymb is only used where the uri is for an external tool (for which
+the uri as well as the symb are guaranteed to be unique).
this function automatically caches all requests