--- loncom/lonnet/perl/lonnet.pm 2011/08/09 01:35:24 1.1129
+++ loncom/lonnet/perl/lonnet.pm 2012/04/24 20:31:59 1.1165
@@ -1,7 +1,7 @@
# The LearningOnline Network
# TCP networking package
#
-# $Id: lonnet.pm,v 1.1129 2011/08/09 01:35:24 raeburn Exp $
+# $Id: lonnet.pm,v 1.1165 2012/04/24 20:31:59 droeschl Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -76,7 +76,8 @@ use HTTP::Date;
use Image::Magick;
use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
- $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease);
+ $_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
+ %managerstab);
my (%badServerCache, $memcache, %courselogs, %accesshash, %domainrolehash,
%userrolehash, $processmarker, $dumpcount, %coursedombuf,
@@ -95,6 +96,7 @@ use Math::Random;
use File::MMagic;
use LONCAPA qw(:DEFAULT :match);
use LONCAPA::Configuration;
+use LONCAPA::lonmetadata;
use File::Copy;
@@ -348,7 +350,7 @@ sub get_remote_globals {
sub remote_devalidate_cache {
my ($lonhost,$name,$id) = @_;
- my $response = &reply('devalidatecache',&escape($name).':'.&escape($id),$lonhost);
+ my $response = &reply('devalidatecache:'.&escape($name).':'.&escape($id),$lonhost);
return $response;
}
@@ -594,13 +596,21 @@ sub transfer_profile_to_env {
# ---------------------------------------------------- Check for valid session
sub check_for_valid_session {
- my ($r) = @_;
+ my ($r,$name) = @_;
my %cookies=CGI::Cookie->parse($r->header_in('Cookie'));
- my $lonid=$cookies{'lonID'};
+ if ($name eq '') {
+ $name = 'lonID';
+ }
+ my $lonid=$cookies{$name};
return undef if (!$lonid);
my $handle=&LONCAPA::clean_handle($lonid->value);
- my $lonidsdir=$r->dir_config('lonIDsDir');
+ my $lonidsdir;
+ if ($name eq 'lonDAV') {
+ $lonidsdir=$r->dir_config('lonDAVsessDir');
+ } else {
+ $lonidsdir=$r->dir_config('lonIDsDir');
+ }
return undef if (!-e "$lonidsdir/$handle.id");
my $opened = open(my $idf,'+<',"$lonidsdir/$handle.id");
@@ -929,7 +939,7 @@ sub choose_server {
my %domconfhash = &Apache::loncommon::get_domainconf($udom);
my %servers = &get_servers($udom);
my $lowest_load = 30000;
- my ($login_host,$hostname,$portal_path);
+ my ($login_host,$hostname,$portal_path,$isredirect);
foreach my $lonhost (keys(%servers)) {
my $loginvia;
if ($checkloginvia) {
@@ -940,12 +950,14 @@ sub choose_server {
&compare_server_load($server, $login_host, $lowest_load);
if ($login_host eq $server) {
$portal_path = $path;
+ $isredirect = 1;
}
} else {
($login_host, $lowest_load) =
&compare_server_load($lonhost, $login_host, $lowest_load);
if ($login_host eq $lonhost) {
$portal_path = '';
+ $isredirect = '';
}
}
} else {
@@ -956,7 +968,7 @@ sub choose_server {
if ($login_host ne '') {
$hostname = &hostname($login_host);
}
- return ($login_host,$hostname,$portal_path);
+ return ($login_host,$hostname,$portal_path,$isredirect);
}
# --------------------------------------------- Try to change a user's password
@@ -1242,7 +1254,7 @@ sub check_loadbalancing {
my %domconfig =
&Apache::lonnet::get_dom('configuration',['loadbalancing'],$dom_in_use);
if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
- $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'usersessions'}{'loadbalancing'},$cachetime);
+ $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
}
}
if (ref($result) eq 'HASH') {
@@ -1308,7 +1320,7 @@ sub check_loadbalancing {
my %domconfig =
&Apache::lonnet::get_dom('configuration',['loadbalancing'],$serverhomedom);
if (ref($domconfig{'loadbalancing'}) eq 'HASH') {
- $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'usersessions'}{'loadbalancing'},$cachetime);
+ $result = &do_cache_new('loadbalancing',$dom_in_use,$domconfig{'loadbalancing'},$cachetime);
}
}
if (ref($result) eq 'HASH') {
@@ -1523,16 +1535,13 @@ sub idput {
# ------------------------------dump from db file owned by domainconfig user
sub dump_dom {
- my ($namespace,$udom,$regexp,$range)=@_;
- if (!$udom) {
- $udom=$env{'user.domain'};
- }
- my %returnhash;
- if ($udom) {
- my $uname = &get_domainconfiguser($udom);
- %returnhash = &dump($namespace,$udom,$uname,$regexp,$range);
- }
- return %returnhash;
+ my ($namespace, $udom, $regexp) = @_;
+
+ $udom ||= $env{'user.domain'};
+
+ return () unless $udom;
+
+ return &dump($namespace, $udom, &get_domainconfiguser($udom), $regexp);
}
# ------------------------------------------ get items from domain db files
@@ -1919,6 +1928,7 @@ sub get_domain_defaults {
$domdefaults{'auth_arg_def'} = $domconfig{'defaults'}{'auth_arg_def'};
$domdefaults{'timezone_def'} = $domconfig{'defaults'}{'timezone_def'};
$domdefaults{'datelocale_def'} = $domconfig{'defaults'}{'datelocale_def'};
+ $domdefaults{'portal_def'} = $domconfig{'defaults'}{'portal_def'};
} else {
$domdefaults{'lang_def'} = &domain($domain,'lang_def');
$domdefaults{'auth_def'} = &domain($domain,'auth_def');
@@ -2212,7 +2222,7 @@ sub is_cached_new {
my ($name,$id,$debug) = @_;
$id=&make_key($name,$id);
if (exists($remembered{$id})) {
- if ($debug) { &Apache::lonnet::logthis("Earyl return $id of $remembered{$id} "); }
+ if ($debug) { &Apache::lonnet::logthis("Early return $id of $remembered{$id} "); }
$accessed{$id}=[&gettimeofday()];
$hits++;
return ($remembered{$id},1);
@@ -2428,10 +2438,11 @@ sub subscribe {
sub repcopy {
my $filename=shift;
$filename=~s/\/+/\//g;
- if ($filename=~m|^/home/httpd/html/adm/|) { return 'ok'; }
- if ($filename=~m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
- if ($filename=~m|^/home/httpd/html/userfiles/| or
- $filename=~m -^/*(uploaded|editupload)/-) {
+ my $londocroot = $perlvar{'lonDocRoot'};
+ if ($filename=~m{^\Q$londocroot/adm/\E}) { return 'ok'; }
+ if ($filename=~m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
+ if ($filename=~m{^\Q$londocroot/userfiles/\E} or
+ $filename=~m{^/*(uploaded|editupload)/}) {
return &repcopy_userfile($filename);
}
$filename=~s/[\n\r]//g;
@@ -2458,7 +2469,7 @@ sub repcopy {
unless ($home eq $perlvar{'lonHostID'}) {
my @parts=split(/\//,$filename);
my $path="/$parts[1]/$parts[2]/$parts[3]/$parts[4]";
- if ($path ne "$perlvar{'lonDocRoot'}/res") {
+ if ($path ne "$londocroot/res") {
&logthis("Malconfiguration for replication: $filename");
return 'bad_request';
}
@@ -2796,7 +2807,7 @@ sub resizeImage {
# $resizewidth - width (pixels) to which to resize uploaded image
# $resizeheight - height (pixels) to which to resize uploaded image
# $mimetype - reference to scalar to accommodate mime type determined
-# from File::MMagic if $parser = parse.
+# from File::MMagic.
#
# output: url of file in userspace, or error: <message>
# or /adm/notfound.html if failure to upload occurse
@@ -2965,10 +2976,17 @@ sub finishuserfileupload {
}
}
}
+ if (($context eq 'coursedoc') || ($parser eq 'parse')) {
+ if (ref($mimetype)) {
+ if ($$mimetype eq '') {
+ my $mm = new File::MMagic;
+ my $type = $mm->checktype_filename($filepath.'/'.$file);
+ $$mimetype = $type;
+ }
+ }
+ }
if ($parser eq 'parse') {
- my $mm = new File::MMagic;
- my $type = $mm->checktype_filename($filepath.'/'.$file);
- if ($type eq 'text/html') {
+ if ((ref($mimetype)) && ($$mimetype eq 'text/html')) {
my $parse_result = &extract_embedded_items($filepath.'/'.$file,
$allfiles,$codebase);
unless ($parse_result eq 'ok') {
@@ -2976,9 +2994,6 @@ sub finishuserfileupload {
' for embedded media: '.$parse_result);
}
}
- if (ref($mimetype)) {
- $$mimetype = $type;
- }
}
if (($thumbwidth =~ /^\d+$/) && ($thumbheight =~ /^\d+$/)) {
my $input = $filepath.'/'.$file;
@@ -3015,6 +3030,7 @@ sub finishuserfileupload {
sub extract_embedded_items {
my ($fullpath,$allfiles,$codebase,$content) = @_;
my @state = ();
+ my (%lastids,%related,%shockwave,%flashvars);
my %javafiles = (
codebase => '',
code => '',
@@ -3044,10 +3060,30 @@ sub extract_embedded_items {
&add_filetype($allfiles,$attr->{'href'},'href');
}
if (lc($tagname) eq 'script') {
+ my $src;
if ($attr->{'archive'} =~ /\.jar$/i) {
&add_filetype($allfiles,$attr->{'archive'},'archive');
} else {
- &add_filetype($allfiles,$attr->{'src'},'src');
+ if ($attr->{'src'} ne '') {
+ $src = $attr->{'src'};
+ &add_filetype($allfiles,$src,'src');
+ }
+ }
+ my $text = $p->get_trimmed_text();
+ if ($text =~ /\Qswfobject.registerObject(\E([^\)]+)\)/) {
+ my @swfargs = split(/,/,$1);
+ foreach my $item (@swfargs) {
+ $item =~ s/["']//g;
+ $item =~ s/^\s+//;
+ $item =~ s/\s+$//;
+ }
+ if (($swfargs[0] ne'') && ($swfargs[2] ne '')) {
+ if (ref($related{$swfargs[0]}) eq 'ARRAY') {
+ push(@{$related{$swfargs[0]}},$swfargs[2]);
+ } else {
+ $related{$swfargs[0]} = [$swfargs[2]];
+ }
+ }
}
}
if (lc($tagname) eq 'link') {
@@ -3060,6 +3096,9 @@ sub extract_embedded_items {
foreach my $item (keys(%javafiles)) {
$javafiles{$item} = '';
}
+ if ((lc($tagname) eq 'object') && (lc($state[-2]) ne 'object')) {
+ $lastids{lc($tagname)} = $attr->{'id'};
+ }
}
if (lc($state[-2]) eq 'object' && lc($tagname) eq 'param') {
my $name = lc($attr->{'name'});
@@ -3069,12 +3108,22 @@ sub extract_embedded_items {
last;
}
}
+ my $pathfrom;
foreach my $item (keys(%mediafiles)) {
if ($name eq $item) {
- &add_filetype($allfiles, $attr->{'value'}, 'value');
+ $pathfrom = $attr->{'value'};
+ $shockwave{$lastids{lc($state[-2])}} = $pathfrom;
+ &add_filetype($allfiles,$pathfrom,$name);
last;
}
}
+ if ($name eq 'flashvars') {
+ $flashvars{$lastids{lc($state[-2])}} = $attr->{'value'};
+ }
+ if ($pathfrom ne '') {
+ &embedded_dependency($allfiles,\%related,$lastids{lc($state[-2])},
+ $pathfrom);
+ }
}
if (lc($tagname) eq 'embed' || lc($tagname) eq 'applet') {
foreach my $item (keys(%javafiles)) {
@@ -3089,7 +3138,16 @@ sub extract_embedded_items {
last;
}
}
+ if (lc($tagname) eq 'embed') {
+ if (($attr->{'name'} ne '') && ($attr->{'src'} ne '')) {
+ &embedded_dependency($allfiles,\%related,$attr->{'name'},
+ $attr->{'src'});
+ }
+ }
}
+ if ($t->[4] =~ m{/>$}) {
+ pop(@state);
+ }
} elsif ($t->[0] eq 'E') {
my ($tagname) = ($t->[1]);
if ($javafiles{'codebase'} ne '') {
@@ -3109,6 +3167,23 @@ sub extract_embedded_items {
pop @state;
}
}
+ foreach my $id (sort(keys(%flashvars))) {
+ if ($shockwave{$id} ne '') {
+ my @pairs = split(/\&/,$flashvars{$id});
+ foreach my $pair (@pairs) {
+ my ($key,$value) = split(/\=/,$pair);
+ if ($key eq 'thumb') {
+ &add_filetype($allfiles,$value,$key);
+ } elsif ($key eq 'content') {
+ my ($path) = ($shockwave{$id} =~ m{^(.+/)[^/]+$});
+ my ($ext) = ($value =~ /\.([^.]+)$/);
+ if ($ext ne '') {
+ &add_filetype($allfiles,$path.$value,$ext);
+ }
+ }
+ }
+ }
+ }
return 'ok';
}
@@ -3123,6 +3198,21 @@ sub add_filetype {
}
}
+sub embedded_dependency {
+ my ($allfiles,$related,$identifier,$pathfrom) = @_;
+ if ((ref($allfiles) eq 'HASH') && (ref($related) eq 'HASH')) {
+ if (($identifier ne '') &&
+ (ref($related->{$identifier}) eq 'ARRAY') &&
+ ($pathfrom ne '')) {
+ my ($path) = ($pathfrom =~ m{^(.+/)[^/]+$});
+ foreach my $dep (@{$related->{$identifier}}) {
+ &add_filetype($allfiles,$path.$dep,'object');
+ }
+ }
+ }
+ return;
+}
+
sub removeuploadedurl {
my ($url)=@_;
my (undef,undef,$udom,$uname,$fname)=split('/',$url,5);
@@ -3249,15 +3339,10 @@ sub flushcourselogs {
my $result = &inc('nohist_accesscount',\%temphash,$dom,$name);
if ($result eq 'ok') {
delete $accesshash{$entry};
- } elsif ($result eq 'unknown_cmd') {
- # Target server has old code running on it.
- my %temphash=($entry => $value);
- if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
- delete $accesshash{$entry};
- }
}
} else {
my ($dom,$name) = ($entry=~m{___($match_domain)/($match_name)/(.*)___(\w+)$});
+ if (($dom eq 'uploaded') || ($dom eq 'adm')) { next; }
my %temphash=($entry => $accesshash{$entry});
if (&put('nohist_resevaldata',\%temphash,$dom,$name) eq 'ok') {
delete $accesshash{$entry};
@@ -3336,7 +3421,7 @@ sub courseacclog {
my $fnsymb=shift;
unless ($env{'request.course.id'}) { return ''; }
my $what=$fnsymb.':'.$env{'user.name'}.':'.$env{'user.domain'};
- if ($fnsymb=~/(problem|exam|quiz|assess|survey|form|task|page)$/) {
+ if ($fnsymb=~/$LONCAPA::assess_re/) {
$what.=':POST';
# FIXME: Probably ought to escape things....
foreach my $key (keys(%env)) {
@@ -3368,7 +3453,13 @@ sub countacc {
my $url=&declutter(shift);
return if (! defined($url) || $url eq '');
unless ($env{'request.course.id'}) { return ''; }
+#
+# Mark that this url was used in this course
+#
$accesshash{$env{'request.course.id'}.'___'.$url.'___course'}=1;
+#
+# Increase the access count for this resource in this child process
+#
my $key=$$.$processmarker.'_'.$dumpcount.'___'.$url.'___count';
$accesshash{$key}++;
}
@@ -3380,6 +3471,22 @@ sub linklog {
$accesshash{$from.'___'.$to.'___comefrom'}=1;
$accesshash{$to.'___'.$from.'___goto'}=1;
}
+
+sub statslog {
+ my ($symb,$part,$users,$av_attempts,$degdiff)=@_;
+ if ($users<2) { return; }
+ my %dynstore=&LONCAPA::lonmetadata::dynamic_metadata_storage({
+ 'course' => $env{'request.course.id'},
+ 'sections' => '"all"',
+ 'num_students' => $users,
+ 'part' => $part,
+ 'symb' => $symb,
+ 'mean_tries' => $av_attempts,
+ 'deg_of_diff' => $degdiff});
+ foreach my $key (keys(%dynstore)) {
+ $accesshash{$key}=$dynstore{$key};
+ }
+}
sub userrolelog {
my ($trole,$username,$domain,$area,$tstart,$tend)=@_;
@@ -3535,6 +3642,7 @@ sub get_my_roles {
foreach my $entry (keys(%dumphash)) {
my ($role,$tend,$tstart);
if ($context eq 'userroles') {
+ next if ($entry =~ /^rolesdef/);
($role,$tend,$tstart)=split(/_/,$dumphash{$entry});
} else {
($tend,$tstart)=split(/\:/,$dumphash{$entry});
@@ -3848,11 +3956,34 @@ sub get_domain_roles {
# ----------------------------------------------------------- Interval timing
+{
+# Caches needed for speedup of navmaps
+# We don't want to cache this for very long at all (5 seconds at most)
+#
+# The user for whom we cache
+my $cachedkey='';
+# The cached times for this user
+my %cachedtimes=();
+# When this was last done
+my $cachedtime=();
+
+sub load_all_first_access {
+ my ($uname,$udom)=@_;
+ if (($cachedkey eq $uname.':'.$udom) &&
+ (abs($cachedtime-time)<5)) {
+ return;
+ }
+ $cachedtime=time;
+ $cachedkey=$uname.':'.$udom;
+ %cachedtimes=&dump('firstaccesstimes',$udom,$uname);
+}
+
sub get_first_access {
- my ($type,$argsymb)=@_;
+ my ($type,$argsymb,$argmap)=@_;
my ($symb,$courseid,$udom,$uname)=&whichuser();
if ($argsymb) { $symb=$argsymb; }
my ($map,$id,$res)=&decode_symb($symb);
+ if ($argmap) { $map = $argmap; }
if ($type eq 'course') {
$res='course';
} elsif ($type eq 'map') {
@@ -3860,12 +3991,12 @@ sub get_first_access {
} else {
$res=$symb;
}
- my %times=&get('firstaccesstimes',["$courseid\0$res"],$udom,$uname);
- return $times{"$courseid\0$res"};
+ &load_all_first_access($uname,$udom);
+ return $cachedtimes{"$courseid\0$res"};
}
sub set_first_access {
- my ($type)=@_;
+ my ($type,$interval)=@_;
my ($symb,$courseid,$udom,$uname)=&whichuser();
my ($map,$id,$res)=&decode_symb($symb);
if ($type eq 'course') {
@@ -3875,13 +4006,27 @@ sub set_first_access {
} else {
$res=$symb;
}
- my $firstaccess=&get_first_access($type,$symb);
+ $cachedkey='';
+ my $firstaccess=&get_first_access($type,$symb,$map);
if (!$firstaccess) {
- return &put('firstaccesstimes',{"$courseid\0$res"=>time},$udom,$uname);
+ my $start = time;
+ my $putres = &put('firstaccesstimes',{"$courseid\0$res"=>$start},
+ $udom,$uname);
+ if ($putres eq 'ok') {
+ &put('timerinterval',{"$courseid\0$res"=>$interval},
+ $udom,$uname);
+ &appenv(
+ {
+ 'course.'.$courseid.'.firstaccess.'.$res => $start,
+ 'course.'.$courseid.'.timerinterval.'.$res => $interval,
+ }
+ );
+ }
+ return $putres;
}
return 'already_set';
}
-
+}
# --------------------------------------------- Set Expire Date for Spreadsheet
sub expirespread {
@@ -3986,7 +4131,7 @@ sub hashref2str {
$result.='=';
#print("Got a ref of ".(ref($key))." skipping.");
} else {
- if ($key) {$result.=&escape($key).'=';} else { last; }
+ if (defined($key)) {$result.=&escape($key).'=';} else { last; }
}
if(ref($hashref->{$key}) eq 'ARRAY') {
@@ -4510,8 +4655,20 @@ sub rolesinit {
($rolesdump =~ /^error:/)) {
return \%userroles;
}
+ my %firstaccess = &dump('firstaccesstimes',$domain,$username);
+ my %timerinterval = &dump('timerinterval',$domain,$username);
+ my (%coursetimerstarts,%firstaccchk,%firstaccenv,
+ %coursetimerintervals,%timerintchk,%timerintenv);
+ foreach my $key (keys(%firstaccess)) {
+ my ($cid,$rest) = split(/\0/,$key);
+ $coursetimerstarts{$cid}{$rest} = $firstaccess{$key};
+ }
+ foreach my $key (keys(%timerinterval)) {
+ my ($cid,$rest) = split(/\0/,$key);
+ $coursetimerintervals{$cid}{$rest} = $timerinterval{$key};
+ }
my %allroles=();
- my %allgroups=();
+ my %allgroups=();
if ($rolesdump ne '') {
foreach my $entry (split(/&/,$rolesdump)) {
@@ -4549,6 +4706,27 @@ sub rolesinit {
} else {
&standard_roleprivs(\%allroles,$trole,$tdomain,$spec,$trest,$area);
}
+ if ($trole ne 'gr') {
+ my $cid = $tdomain.'_'.$trest;
+ unless ($firstaccchk{$cid}) {
+ if (ref($coursetimerstarts{$cid}) eq 'HASH') {
+ foreach my $item (keys(%{$coursetimerstarts{$cid}})) {
+ $firstaccenv{'course.'.$cid.'.firstaccess.'.$item} =
+ $coursetimerstarts{$cid}{$item};
+ }
+ }
+ $firstaccchk{$cid} = 1;
+ }
+ unless ($timerintchk{$cid}) {
+ if (ref($coursetimerintervals{$cid}) eq 'HASH') {
+ foreach my $item (keys(%{$coursetimerintervals{$cid}})) {
+ $timerintenv{'course.'.$cid.'.timerinterval.'.$item} =
+ $coursetimerintervals{$cid}{$item};
+ }
+ }
+ $timerintchk{$cid} = 1;
+ }
+ }
}
}
}
@@ -4557,7 +4735,7 @@ sub rolesinit {
$userroles{'user.author'} = $author;
$env{'user.adv'}=$adv;
}
- return \%userroles;
+ return (\%userroles,\%firstaccenv,\%timerintenv);
}
sub set_arearole {
@@ -5909,6 +6087,15 @@ sub allowed {
}
}
+# User who is not author or co-author might still be able to edit
+# resource of an author in the domain (e.g., if Domain Coordinator).
+ if (($priv eq 'eco') && ($thisallowed eq '') && ($env{'request.course.id'}) &&
+ (&allowed('mdc',$env{'request.course.id'}))) {
+ if ($env{"user.priv.cm./$uri/"}=~/\Q$priv\E\&([^\:]*)/) {
+ $thisallowed.=$1;
+ }
+ }
+
# Course: uri itself is a course
my $courseuri=$uri;
$courseuri=~s/\_(\d)/\/$1/;
@@ -5929,7 +6116,12 @@ sub allowed {
if ($match) {
if ($env{'user.priv.'.$env{'request.role'}.'./'}
=~/\Q$priv\E\&([^\:]*)/) {
- $thisallowed.=$1;
+ my @blockers = &has_comm_blocking($priv,$symb,$uri);
+ if (@blockers > 0) {
+ $thisallowed = 'B';
+ } else {
+ $thisallowed.=$1;
+ }
}
} else {
my $refuri = $env{'httpref.'.$orguri} || $env{'httpref.'.$ver_orguri};
@@ -5940,7 +6132,12 @@ sub allowed {
$refuri=&declutter($refuri);
my ($match) = &is_on_map($refuri);
if ($match) {
- $thisallowed='F';
+ my @blockers = &has_comm_blocking($priv,$symb,$refuri);
+ if (@blockers > 0) {
+ $thisallowed = 'B';
+ } else {
+ $thisallowed='F';
+ }
}
}
}
@@ -5992,7 +6189,17 @@ sub allowed {
$statecond=$cond;
if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
=~/\Q$priv\E\&([^\:]*)/) {
- $thisallowed.=$1;
+ my $value = $1;
+ if ($priv eq 'bre') {
+ my @blockers = &has_comm_blocking($priv,$symb,$uri);
+ if (@blockers > 0) {
+ $thisallowed = 'B';
+ } else {
+ $thisallowed.=$value;
+ }
+ } else {
+ $thisallowed.=$value;
+ }
$checkreferer=0;
}
}
@@ -6020,7 +6227,17 @@ sub allowed {
my $refstatecond=$cond;
if ($env{'user.priv.'.$env{'request.role'}.'./'.$courseprivid}
=~/\Q$priv\E\&([^\:]*)/) {
- $thisallowed.=$1;
+ my $value = $1;
+ if ($priv eq 'bre') {
+ my @blockers = &has_comm_blocking($priv,$symb,$refuri);
+ if (@blockers > 0) {
+ $thisallowed = 'B';
+ } else {
+ $thisallowed.=$value;
+ }
+ } else {
+ $thisallowed.=$value;
+ }
$uri=$refuri;
$statecond=$refstatecond;
}
@@ -6180,6 +6397,184 @@ sub allowed {
return 'F';
}
+sub get_comm_blocks {
+ 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 %commblocks;
+ my $hashid=$cdom.'_'.$cnum;
+ my ($blocksref,$cached)=&is_cached_new('comm_block',$hashid);
+ if ((defined($cached)) && (ref($blocksref) eq 'HASH')) {
+ %commblocks = %{$blocksref};
+ } else {
+ %commblocks = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
+ my $cachetime = 600;
+ &do_cache_new('comm_block',$hashid,\%commblocks,$cachetime);
+ }
+ return %commblocks;
+}
+
+sub has_comm_blocking {
+ my ($priv,$symb,$uri,$blocks) = @_;
+ return unless ($env{'request.course.id'});
+ return unless ($priv eq 'bre');
+ return if ($env{'user.priv.'.$env{'request.role'}} =~/evb\&([^\:]*)/);
+ my %commblocks;
+ if (ref($blocks) eq 'HASH') {
+ %commblocks = %{$blocks};
+ } else {
+ %commblocks = &get_comm_blocks();
+ }
+ return unless (keys(%commblocks) > 0);
+ if (!$symb) { $symb=&symbread($uri,1); }
+ my ($map,$resid,undef)=&decode_symb($symb);
+ my %tocheck = (
+ maps => $map,
+ resources => $symb,
+ );
+ my @blockers;
+ my $now = time;
+ my $navmap = Apache::lonnavmaps::navmap->new();
+ foreach my $block (keys(%commblocks)) {
+ if ($block =~ /^(\d+)____(\d+)$/) {
+ my ($start,$end) = ($1,$2);
+ if ($start <= $now && $end >= $now) {
+ if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
+ if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
+ if (ref($commblocks{$block}{'blocks'}{'docs'}{'maps'}) eq 'HASH') {
+ if ($commblocks{$block}{'blocks'}{'docs'}{'maps'}{$map}) {
+ unless (grep(/^\Q$block\E$/,@blockers)) {
+ push(@blockers,$block);
+ }
+ }
+ }
+ if (ref($commblocks{$block}{'blocks'}{'docs'}{'resources'}) eq 'HASH') {
+ if ($commblocks{$block}{'blocks'}{'docs'}{'resources'}{$symb}) {
+ unless (grep(/^\Q$block\E$/,@blockers)) {
+ push(@blockers,$block);
+ }
+ }
+ }
+ }
+ }
+ }
+ } elsif ($block =~ /^firstaccess____(.+)$/) {
+ my $item = $1;
+ my @to_test;
+ if (ref($commblocks{$block}{'blocks'}) eq 'HASH') {
+ if (ref($commblocks{$block}{'blocks'}{'docs'}) eq 'HASH') {
+ my $check_interval;
+ if (&check_docs_block($commblocks{$block}{'blocks'}{'docs'},\%tocheck)) {
+ my @interval;
+ my $type = 'map';
+ if ($item eq 'course') {
+ $type = 'course';
+ @interval=&EXT("resource.0.interval");
+ } else {
+ if ($item =~ /___\d+___/) {
+ $type = 'resource';
+ @interval=&EXT("resource.0.interval",$item);
+ if (ref($navmap)) {
+ my $res = $navmap->getBySymb($item);
+ push(@to_test,$res);
+ }
+ } else {
+ my $mapsymb = &symbread($item,1);
+ if ($mapsymb) {
+ if (ref($navmap)) {
+ my $mapres = $navmap->getBySymb($mapsymb);
+ @to_test = $mapres->retrieveResources($mapres,undef,0,1);
+ foreach my $res (@to_test) {
+ my $symb = $res->symb();
+ next if ($symb eq $mapsymb);
+ if ($symb ne '') {
+ @interval=&EXT("resource.0.interval",$symb);
+ last;
+ }
+ }
+ }
+ }
+ }
+ }
+ if ($interval[0] =~ /\d+/) {
+ my $first_access;
+ if ($type eq 'resource') {
+ $first_access=&get_first_access($interval[1],$item);
+ } elsif ($type eq 'map') {
+ $first_access=&get_first_access($interval[1],undef,$item);
+ } else {
+ $first_access=&get_first_access($interval[1]);
+ }
+ if ($first_access) {
+ my $timesup = $first_access+$interval[0];
+ if ($timesup > $now) {
+ foreach my $res (@to_test) {
+ if ($res->is_problem()) {
+ if ($res->completable()) {
+ unless (grep(/^\Q$block\E$/,@blockers)) {
+ push(@blockers,$block);
+ }
+ last;
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ return @blockers;
+}
+
+sub check_docs_block {
+ my ($docsblock,$tocheck) =@_;
+ if ((ref($docsblock) ne 'HASH') || (ref($tocheck) ne 'HASH')) {
+ return;
+ }
+ if (ref($docsblock->{'maps'}) eq 'HASH') {
+ if ($tocheck->{'maps'}) {
+ if ($docsblock->{'maps'}{$tocheck->{'maps'}}) {
+ return 1;
+ }
+ }
+ }
+ if (ref($docsblock->{'resources'}) eq 'HASH') {
+ if ($tocheck->{'resources'}) {
+ if ($docsblock->{'resources'}{$tocheck->{'resources'}}) {
+ return 1;
+ }
+ }
+ }
+ return;
+}
+
+#
+# Removes the versino from a URI and
+# splits it in to its filename and path to the filename.
+# Seems like File::Basename could have done this more clearly.
+# Parameters:
+# $uri - input URI
+# Returns:
+# Two element list consisting of
+# $pathname - the URI up to and excluding the trailing /
+# $filename - The part of the URI following the last /
+# NOTE:
+# Another realization of this is simply:
+# use File::Basename;
+# ...
+# $uri = shift;
+# $filename = basename($uri);
+# $path = dirname($uri);
+# return ($filename, $path);
+#
+# The implementation below is probably faster however.
+#
sub split_uri_for_cond {
my $uri=&deversion(&declutter(shift));
my @uriparts=split(/\//,$uri);
@@ -7075,6 +7470,13 @@ sub assignrole {
return 'refused';
}
}
+ } elsif ($role eq 'au') {
+ if ($url ne '/'.$udom.'/') {
+ &logthis('Attempt by '.$env{'user.name'}.':'.$env{'user.domain'}.
+ ' to assign author role for '.$uname.':'.$udom.
+ ' in domain: '.$url.' refused (wrong domain).');
+ return 'refused';
+ }
}
$mrole=$role;
}
@@ -7476,14 +7878,16 @@ sub modify_student_enrollment {
$uid = $tmp{'id'} if (!defined($uid) || $uid eq '');
}
my $fullname = &format_name($first,$middle,$last,$gene,'lastname');
+ my $user = "$uname:$udom";
+ my %old_entry = &Apache::lonnet::get('classlist',[$user],$cdom,$cnum);
my $reply=cput('classlist',
- {"$uname:$udom" =>
+ {$user =>
join(':',$end,$start,$uid,$usec,$fullname,$type,$locktype) },
$cdom,$cnum);
- unless (($reply eq 'ok') || ($reply eq 'delayed')) {
+ if (($reply eq 'ok') || ($reply eq 'delayed')) {
+ &devalidate_getsection_cache($udom,$uname,$cid);
+ } else {
return 'error: '.$reply;
- } else {
- &devalidate_getsection_cache($udom,$uname,$cid);
}
# Add student role to user
my $uurl='/'.$cid;
@@ -7491,7 +7895,16 @@ sub modify_student_enrollment {
if ($usec) {
$uurl.='/'.$usec;
}
- return &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,$selfenroll,$context);
+ my $result = &assignrole($udom,$uname,$uurl,'st',$end,$start,undef,
+ $selfenroll,$context);
+ if ($result ne 'ok') {
+ if ($old_entry{$user} ne '') {
+ $reply = &cput('classlist',\%old_entry,$cdom,$cnum);
+ } else {
+ $reply = &del('classlist',[$user],$cdom,$cnum);
+ }
+ }
+ return $result;
}
sub format_name {
@@ -8222,26 +8635,33 @@ sub dirlist {
if($udom) {
if($uname) {
+ my $uhome = &homeserver($uname,$udom);
+ if ($uhome eq 'no_host') {
+ return ([],'no_host');
+ }
$listing = &reply('ls3:'.&escape('/'.$uri).':'.$getpropath.':'
.$getuserdir.':'.&escape($dirRoot)
- .':'.&escape($uname).':'.&escape($udom),
- &homeserver($uname,$udom));
+ .':'.&escape($uname).':'.&escape($udom),$uhome);
if ($listing eq 'unknown_cmd') {
- $listing = &reply('ls2:'.$dirRoot.'/'.$uri,
- &homeserver($uname,$udom));
+ $listing = &reply('ls2:'.$dirRoot.'/'.$uri,$uhome);
} else {
@listing_results = map { &unescape($_); } split(/:/,$listing);
}
if ($listing eq 'unknown_cmd') {
- $listing = &reply('ls:'.$dirRoot.'/'.$uri,
- &homeserver($uname,$udom));
+ $listing = &reply('ls:'.$dirRoot.'/'.$uri,$uhome);
@listing_results = split(/:/,$listing);
} else {
@listing_results = map { &unescape($_); } split(/:/,$listing);
}
- return @listing_results;
+ if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
+ ($listing eq 'rejected') || ($listing eq 'refused') ||
+ ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
+ return ([],$listing);
+ } else {
+ return (\@listing_results);
+ }
} elsif(!$alternateRoot) {
- my %allusers;
+ my (%allusers,%listerror);
my %servers = &get_servers($udom,'library');
foreach my $tryserver (keys(%servers)) {
$listing = &reply('ls3:'.&escape("/res/$udom").':::::'.
@@ -8260,32 +8680,31 @@ sub dirlist {
@listing_results =
map { &unescape($_); } split(/:/,$listing);
}
- if ($listing_results[0] ne 'no_such_dir' &&
- $listing_results[0] ne 'empty' &&
- $listing_results[0] ne 'con_lost') {
+ if (($listing eq 'no_such_host') || ($listing eq 'con_lost') ||
+ ($listing eq 'rejected') || ($listing eq 'refused') ||
+ ($listing eq 'no_such_dir') || ($listing eq 'empty')) {
+ $listerror{$tryserver} = $listing;
+ } else {
foreach my $line (@listing_results) {
my ($entry) = split(/&/,$line,2);
$allusers{$entry} = 1;
}
}
}
- my $alluserstr='';
+ my @alluserslist=();
foreach my $user (sort(keys(%allusers))) {
- $alluserstr.=$user.'&user:';
+ push(@alluserslist,$user.'&user');
}
- $alluserstr=~s/:$//;
- return split(/:/,$alluserstr);
+ return (\@alluserslist);
} else {
- return ('missing user name');
+ return ([],'missing username');
}
} elsif(!defined($getpropath)) {
- my @all_domains = sort(&all_domains());
- foreach my $domain (@all_domains) {
- $domain = $perlvar{'lonDocRoot'}.'/res/'.$domain.'/&domain';
- }
- return @all_domains;
+ my $path = $perlvar{'lonDocRoot'}.'/res/';
+ my @all_domains = map { $path.$_.'/&domain'; } (sort(&all_domains()));
+ return (\@all_domains);
} else {
- return ('missing domain');
+ return ([],'missing domain');
}
}
@@ -8298,11 +8717,13 @@ sub GetFileTimestamp {
my ($studentDomain,$studentName,$filename,$getuserdir)=@_;
$studentDomain = &LONCAPA::clean_domain($studentDomain);
$studentName = &LONCAPA::clean_username($studentName);
- my ($fileStat) =
- &Apache::lonnet::dirlist($filename,$studentDomain,$studentName,
- undef,$getuserdir);
- my @stats = split('&', $fileStat);
- if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
+ my ($fileref,$error) = &dirlist($filename,$studentDomain,$studentName,
+ undef,$getuserdir);
+ if (($error eq 'empty') || ($error eq 'no_such_dir')) {
+ return -1;
+ }
+ if (ref($fileref) eq 'ARRAY') {
+ my @stats = split('&',$fileref->[0]);
# @stats contains first the filename, then the stat output
return $stats[10]; # so this is 10 instead of 9.
} else {
@@ -8334,12 +8755,15 @@ sub stat_file {
if ($file =~ /^userfiles\//) {
$getpropath = 1;
}
- my ($result) = &dirlist($file,$udom,$uname,$getpropath);
- my @stats = split('&', $result);
-
- if($stats[0] ne 'empty' && $stats[0] ne 'no_such_dir') {
- shift(@stats); #filename is first
- return @stats;
+ my ($listref,$error) = &dirlist($file,$udom,$uname,$getpropath);
+ if (($error eq 'empty') || ($error eq 'no_such_dir')) {
+ return ();
+ } else {
+ if (ref($listref) eq 'ARRAY') {
+ my @stats = split('&',$listref->[0]);
+ shift(@stats); #filename is first
+ return @stats;
+ }
}
return ();
}
@@ -8660,15 +9084,7 @@ sub EXT {
} elsif ($realm eq 'request') {
# ------------------------------------------------------------- request.browser
if ($space eq 'browser') {
- if ($qualifier eq 'textremote') {
- if (&Apache::lonlocal::mt('textual_remote_display') eq 'on') {
- return 1;
- } else {
- return 0;
- }
- } else {
- return $env{'browser.'.$qualifier};
- }
+ return $env{'browser.'.$qualifier};
# ------------------------------------------------------------ request.filename
} else {
return $env{'request.'.$spacequalifierrest};
@@ -8952,7 +9368,7 @@ sub metadata {
($uri =~ m|/$|) || ($uri =~ m|/.meta$|) || ($uri =~ m{^/*uploaded/.+\.sequence$})) {
return undef;
}
- if (($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/})
+ if (($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/)
&& &Apache::lonxml::get_state('target') =~ /^(|meta)$/) {
return undef;
}
@@ -8989,7 +9405,7 @@ sub metadata {
my %metathesekeys=();
unless ($filename=~/\.meta$/) { $filename.='.meta'; }
my $metastring;
- if ($uri =~ /^~/ || $uri =~ m{home/$match_username/public_html/}) {
+ if ($uri =~ /^priv/ || $uri=~/home\/httpd\/html\/priv/) {
my $which = &hreflocation('','/'.($liburi || $uri));
$metastring =
&Apache::lonnet::ssi_body($which,
@@ -9313,6 +9729,10 @@ sub gettitle {
}
$title=~s/\&colon\;/\:/gs;
if ($title) {
+# Remember both $symb and $title for dynamic metadata
+ $accesshash{$symb.'___crstitle'}=$title;
+ $accesshash{&declutter($map).'___'.&declutter($url).'___usage'}=time;
+# Cache this title and then return it
return &do_cache_new('title',$key,$title,600);
}
$urlsymb=$url;
@@ -9345,6 +9765,49 @@ sub get_slot {
}
return $slotinfo{$which};
}
+
+sub get_reservable_slots {
+ my ($cnum,$cdom,$uname,$udom) = @_;
+ my $now = time;
+ my $reservable_info;
+ my $key=join("\0",'reservableslots',$cdom,$cnum,$uname,$udom);
+ if (exists($remembered{$key})) {
+ $reservable_info = $remembered{$key};
+ } else {
+ my %resv;
+ ($resv{'now_order'},$resv{'now'},$resv{'future_order'},$resv{'future'}) =
+ &Apache::loncommon::get_future_slots($cnum,$cdom,$now);
+ $reservable_info = \%resv;
+ $remembered{$key} = $reservable_info;
+ }
+ return $reservable_info;
+}
+
+sub get_course_slots {
+ my ($cnum,$cdom) = @_;
+ my $hashid=$cnum.':'.$cdom;
+ my ($result,$cached) = &Apache::lonnet::is_cached_new('allslots',$hashid);
+ if (defined($cached)) {
+ if (ref($result) eq 'HASH') {
+ return %{$result};
+ }
+ } else {
+ my %slots=&Apache::lonnet::dump('slots',$cdom,$cnum);
+ my ($tmp) = keys(%slots);
+ if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
+ &Apache::lonnet::do_cache_new('allslots',$hashid,\%slots,600);
+ return %slots;
+ }
+ }
+ return;
+}
+
+sub devalidate_slots_cache {
+ my ($cnum,$cdom)=@_;
+ my $hashid=$cnum.':'.$cdom;
+ &devalidate_cache_new('allslots',$hashid);
+}
+
# ------------------------------------------------- Update symbolic store links
sub symblist {
@@ -9686,19 +10149,44 @@ sub getCODE {
}
return undef;
}
-
+#
+# Determines the random seed for a specific context:
+#
+# parameters:
+# symb - in course context the symb for the seed.
+# course_id - The course id of the form domain_coursenum.
+# domain - Domain for the user.
+# course - Course for the user.
+# cenv - environment of the course.
+#
+# NOTE:
+# All parameters are picked out of the environment if missing
+# or not defined.
+# If a symb cannot be determined the current time is used instead.
+#
+# For a given well defined symb, courside, domain, username,
+# and course environment, the seed is reproducible.
+#
sub rndseed {
- my ($symb,$courseid,$domain,$username)=@_;
+ my ($symb,$courseid,$domain,$username, $cenv)=@_;
my ($wsymb,$wcourseid,$wdomain,$wusername)=&whichuser();
if (!defined($symb)) {
unless ($symb=$wsymb) { return time; }
}
- if (!$courseid) { $courseid=$wcourseid; }
- if (!$domain) { $domain=$wdomain; }
- if (!$username) { $username=$wusername }
- my $which=&get_rand_alg();
+ if (!defined $courseid) {
+ $courseid=$wcourseid;
+ }
+ if (!defined $domain) { $domain=$wdomain; }
+ if (!defined $username) { $username=$wusername }
+ my $which;
+ if (defined($cenv->{'rndseed'})) {
+ $which = $cenv->{'rndseed'};
+ } else {
+ $which =&get_rand_alg($courseid);
+ }
if (defined(&getCODE())) {
+
if ($which eq '64bit5') {
return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
} elsif ($which eq '64bit4') {
@@ -10022,8 +10510,9 @@ sub getfile {
sub repcopy_userfile {
my ($file)=@_;
- if ($file =~ m -^/*(uploaded|editupload)/-) { $file=&filelocation("",$file); }
- if ($file =~ m|^/home/httpd/html/lonUsers/|) { return 'ok'; }
+ my $londocroot = $perlvar{'lonDocRoot'};
+ if ($file =~ m{^/*(uploaded|editupload)/}) { $file=&filelocation("",$file); }
+ if ($file =~ m{^\Q/home/httpd/lonUsers/\E}) { return 'ok'; }
my ($cdom,$cnum,$filename) =
($file=~m|^\Q$perlvar{'lonDocRoot'}\E/+userfiles/+($match_domain)/+($match_name)/+(.*)|);
my $uri="/uploaded/$cdom/$cnum/$filename";
@@ -10152,13 +10641,7 @@ sub filelocation {
$file=~s-^/adm/coursedocs/showdoc/-/-;
}
- if ($file=~m:^/~:) { # is a contruction space reference
- $location = $file;
- $location =~ s:/~(.*?)/(.*):/home/$1/public_html/$2:;
- } elsif ($file=~m{^/home/$match_username/public_html/}) {
- # is a correct contruction space reference
- $location = $file;
- } elsif ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
+ if ($file =~ m-^\Q$Apache::lonnet::perlvar{'lonTabDir'}\E/-) {
$location = $file;
} elsif ($file=~/^\/*(uploaded|editupload)/) { # is an uploaded file
my ($udom,$uname,$filename)=
@@ -10177,11 +10660,12 @@ sub filelocation {
$location = $perlvar{'lonDocRoot'}.'/'.$file;
} else {
$file=~s/^\Q$perlvar{'lonDocRoot'}\E//;
- $file=~s:^/res/:/:;
+ $file=~s:^/(res|priv)/:/:;
+ my $space=$1;
if ( !( $file =~ m:^/:) ) {
$location = $dir. '/'.$file;
} else {
- $location = '/home/httpd/html/res'.$file;
+ $location = $perlvar{'lonDocRoot'}.'/'.$space.$file;
}
}
$location=~s://+:/:g; # remove duplicate /
@@ -10206,11 +10690,9 @@ sub hreflocation {
}
if ($file=~m-^\Q$perlvar{'lonDocRoot'}\E-) {
$file=~s-^\Q$perlvar{'lonDocRoot'}\E--;
- } elsif ($file=~m-/home/($match_username)/public_html/-) {
- $file=~s-^/home/($match_username)/public_html/-/~$1/-;
} elsif ($file=~m-^\Q$perlvar{'lonUsersDir'}\E-) {
- $file=~s-^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/
- -/uploaded/$1/$2/-x;
+ $file=~s{^/home/httpd/lonUsers/($match_domain)/./././($match_name)/userfiles/}
+ {/uploaded/$1/$2/}x;
}
if ($file=~ m{^/userfiles/}) {
$file =~ s{^/userfiles/}{/uploaded/};
@@ -10218,6 +10700,10 @@ sub hreflocation {
return $file;
}
+
+
+
+
sub current_machine_domains {
return &machine_domains(&hostname($perlvar{'lonHostID'}));
}
@@ -10406,6 +10892,7 @@ sub get_dns {
while (%alldns) {
my ($dns) = keys(%alldns);
my $ua=new LWP::UserAgent;
+ $ua->timeout(30);
my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
my $response=$ua->request($request);
delete($alldns{$dns});
@@ -10921,6 +11408,22 @@ BEGIN {
}
}
+# ---------------------------------------------------------- Read managers table
+{
+ if (-e "$perlvar{'lonTabDir'}/managers.tab") {
+ if (open(my $config,"<$perlvar{'lonTabDir'}/managers.tab")) {
+ while (my $configline=<$config>) {
+ chomp($configline);
+ next if ($configline =~ /^\#/);
+ if (($configline =~ /^[\w\-]+$/) || ($configline =~ /^[\w\-]+\:[\w\-]+$/)) {
+ $managerstab{$configline} = 1;
+ }
+ }
+ close($config);
+ }
+ }
+}
+
# ------------- set up temporary directory
{
$tmpdir = LONCAPA::tempdir();
@@ -11773,7 +12276,82 @@ or lonTabs/domain.tab.
=item *
-dirlist($uri) : return directory list based on URI
+dirlist() : return directory list based on URI (first arg).
+
+Inputs: 1 required, 5 optional.
+
+=over
+
+=item
+$uri - path to file in filesystem (starts: /res or /userfiles/). Required.
+
+=item
+$userdomain - domain of user/course to be listed. Extracted from $uri if absent.
+
+=item
+$username - username of user/course to be listed. Extracted from $uri if absent.
+
+=item
+$getpropath - boolean: 1 if prepend path using &propath().
+
+=item
+$getuserdir - boolean: 1 if prepend path for "userfiles".
+
+=item
+$alternateRoot - path to prepend in place of path from $uri.
+
+=back
+
+Returns: Array of up to two items.
+
+=over
+
+a reference to an array of files/subdirectories
+
+=over
+
+Each element in the array of files/subdirectories is a & separated list of
+item name and the result of running stat on the item. If dirlist was requested
+for a file instead of a directory, the item name will be ''. For a directory
+listing, if the item is a metadata file, the element will end &N&M
+(where N amd M are either 0 or 1, corresponding to obsolete set (1), or
+default copyright set (1).
+
+=back
+
+a scalar containing error condition (if encountered).
+
+=over
+
+=item
+no_host (no homeserver identified for $username:$domain).
+
+=item
+no_such_host (server contacted for listing not identified as valid host).
+
+=item
+con_lost (connection to remote server failed).
+
+=item
+refused (invalid $username:$domain received on lond side).
+
+=item
+no_such_dir (directory at specified path on lond side does not exist).
+
+=item
+empty (directory at specified path on lond side is empty).
+
+=over
+
+This is currently not encountered because the &ls3, &ls2,
+&ls (_handler) routines on the lond side do not filter out
+. and .. from a directory listing.
+
+=back
+
+=back
+
+=back
=item *