--- loncom/lonnet/perl/lonnet.pm 2015/04/09 18:24:44 1.1172.2.64
+++ loncom/lonnet/perl/lonnet.pm 2014/06/13 03:33:55 1.1262
@@ -1,7 +1,7 @@
# The LearningOnline Network
# TCP networking package
#
-# $Id: lonnet.pm,v 1.1172.2.64 2015/04/09 18:24:44 raeburn Exp $
+# $Id: lonnet.pm,v 1.1262 2014/06/13 03:33:55 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -75,6 +75,9 @@ use LWP::UserAgent();
use HTTP::Date;
use Image::Magick;
+
+use Encode;
+
use vars qw(%perlvar %spareid %pr %prp $memcache %packagetab $tmpdir
$_64bit %env %protocol %loncaparevs %serverhomeIDs %needsrelease
%managerstab);
@@ -109,6 +112,7 @@ require Exporter;
our @ISA = qw (Exporter);
our @EXPORT = qw(%env);
+
# ------------------------------------ Logging (parameters, docs, slots, roles)
{
my $logid;
@@ -123,19 +127,19 @@ our @EXPORT = qw(%env);
$logid ++;
my $now = time();
my $id=$now.'00000'.$$.'00000'.$logid;
- my $logentry = {
- $id => {
- 'exe_uname' => $env{'user.name'},
- 'exe_udom' => $env{'user.domain'},
- 'exe_time' => $now,
- 'exe_ip' => $ENV{'REMOTE_ADDR'},
- 'delflag' => $delflag,
- 'logentry' => $storehash,
- 'uname' => $uname,
- 'udom' => $udom,
- }
+ my $logentry = {
+ $id => {
+ 'exe_uname' => $env{'user.name'},
+ 'exe_udom' => $env{'user.domain'},
+ 'exe_time' => $now,
+ 'exe_ip' => $ENV{'REMOTE_ADDR'},
+ 'delflag' => $delflag,
+ 'logentry' => $storehash,
+ 'uname' => $uname,
+ 'udom' => $udom,
+ }
};
- return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
+ return &put('nohist_'.$hash_name,$logentry,$cdom,$cnum);
}
}
@@ -356,7 +360,8 @@ sub remote_devalidate_cache {
my $items;
return unless (ref($cachekeys) eq 'ARRAY');
my $cachestr = join('&',@{$cachekeys});
- return &reply('devalidatecache:'.&escape($cachestr),$lonhost);
+ my $response = &reply('devalidatecache:'.&escape($cachestr),$lonhost);
+ return $response;
}
# -------------------------------------------------- Non-critical communication
@@ -844,8 +849,10 @@ sub spareserver {
if (ref($spareshash) eq 'HASH') {
if (ref($spareshash->{'primary'}) eq 'ARRAY') {
foreach my $try_server (@{ $spareshash->{'primary'} }) {
- next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
- $try_server));
+ if ($uint_dom) {
+ next unless (&spare_can_host($udom,$uint_dom,$remotesessions,
+ $try_server));
+ }
($spare_server, $lowest_load) =
&compare_server_load($try_server, $spare_server, $lowest_load);
}
@@ -856,8 +863,10 @@ sub spareserver {
if (!$found_server) {
if (ref($spareshash->{'default'}) eq 'ARRAY') {
foreach my $try_server (@{ $spareshash->{'default'} }) {
- next unless (&spare_can_host($udom,$uint_dom,
- $remotesessions,$try_server));
+ if ($uint_dom) {
+ next unless (&spare_can_host($udom,$uint_dom,
+ $remotesessions,$try_server));
+ }
($spare_server, $lowest_load) =
&compare_server_load($try_server, $spare_server, $lowest_load);
}
@@ -970,12 +979,12 @@ sub choose_server {
}
}
foreach my $lonhost (keys(%servers)) {
- my $loginvia;
if ($skiploadbal) {
if (ref($balancers) eq 'HASH') {
next if (exists($balancers->{$lonhost}));
}
- }
+ }
+ my $loginvia;
if ($checkloginvia) {
$loginvia = $domconfhash{$udom.'.login.loginvia_'.$lonhost};
if ($loginvia) {
@@ -1169,27 +1178,19 @@ sub can_host_session {
sub spare_can_host {
my ($udom,$uint_dom,$remotesessions,$try_server)=@_;
my $canhost=1;
- my $try_server_hostname = &hostname($try_server);
- my $serverhomeID = &get_server_homeID($try_server_hostname);
- my $serverhomedom = &host_domain($serverhomeID);
- my %defdomdefaults = &get_domain_defaults($serverhomedom);
- if (ref($defdomdefaults{'offloadnow'}) eq 'HASH') {
- if ($defdomdefaults{'offloadnow'}{$try_server}) {
- $canhost = 0;
- }
- }
- if (($canhost) && ($uint_dom)) {
- my @intdoms;
- my $internet_names = &get_internet_names($try_server);
- if (ref($internet_names) eq 'ARRAY') {
- @intdoms = @{$internet_names};
- }
- unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
- my $remoterev = &get_server_loncaparev(undef,$try_server);
- $canhost = &can_host_session($udom,$try_server,$remoterev,
- $remotesessions,
- $defdomdefaults{'hostedsessions'});
- }
+ my @intdoms;
+ my $internet_names = &Apache::lonnet::get_internet_names($try_server);
+ if (ref($internet_names) eq 'ARRAY') {
+ @intdoms = @{$internet_names};
+ }
+ unless (grep(/^\Q$uint_dom\E$/,@intdoms)) {
+ my $serverhomeID = &Apache::lonnet::get_server_homeID($try_server);
+ my $serverhomedom = &Apache::lonnet::host_domain($serverhomeID);
+ my %defdomdefaults = &Apache::lonnet::get_domain_defaults($serverhomedom);
+ my $remoterev = &Apache::lonnet::get_server_loncaparev(undef,$try_server);
+ $canhost = &can_host_session($udom,$try_server,$remoterev,
+ $remotesessions,
+ $defdomdefaults{'hostedsessions'});
}
return $canhost;
}
@@ -1301,7 +1302,7 @@ sub check_loadbalancing {
}
}
if (ref($result) eq 'HASH') {
- ($is_balancer,$currtargets,$currrules) =
+ ($is_balancer,$currtargets,$currrules) =
&check_balancer_result($result,@hosts);
if ($is_balancer) {
if (ref($currrules) eq 'HASH') {
@@ -1360,7 +1361,7 @@ sub check_loadbalancing {
}
}
if (ref($result) eq 'HASH') {
- ($is_balancer,$currtargets,$currrules) =
+ ($is_balancer,$currtargets,$currrules) =
&check_balancer_result($result,@hosts);
if ($is_balancer) {
if (ref($currrules) eq 'HASH') {
@@ -1416,8 +1417,8 @@ sub check_loadbalancing {
$is_balancer = 0;
if ($uname ne '' && $udom ne '') {
if (($env{'user.name'} eq $uname) && ($env{'user.domain'} eq $udom)) {
-
- &appenv({'user.loadbalexempt' => $lonhost,
+
+ &appenv({'user.loadbalexempt' => $lonhost,
'user.loadbalcheck.time' => time});
}
}
@@ -1606,7 +1607,7 @@ sub idput {
}
}
-# ---------------------------------------- Delete unwanted IDs from ids.db file
+# ---------------------------------------- Delete unwanted IDs from ids.db file
sub iddel {
my ($udom,$idshashref,$uhome)=@_;
@@ -1651,7 +1652,6 @@ sub dump_dom {
sub get_dom {
my ($namespace,$storearr,$udom,$uhome)=@_;
- return if ($udom eq 'public');
my $items='';
foreach my $item (@$storearr) {
$items.=&escape($item).'&';
@@ -1659,7 +1659,6 @@ sub get_dom {
$items=~s/\&$//;
if (!$udom) {
$udom=$env{'user.domain'};
- return if ($udom eq 'public');
if (defined(&domain($udom,'primary'))) {
$uhome=&domain($udom,'primary');
} else {
@@ -2074,11 +2073,7 @@ sub get_domain_defaults {
}
}
if (ref($domconfig{'coursedefaults'}) eq 'HASH') {
- $domdefaults{'usejsme'} = $domconfig{'coursedefaults'}{'usejsme'};
- $domdefaults{'uselcmath'} = $domconfig{'coursedefaults'}{'uselcmath'};
- if (ref($domconfig{'coursedefaults'}{'postsubmit'}) eq 'HASH') {
- $domdefaults{'postsubmit'} = $domconfig{'coursedefaults'}{'postsubmit'}{'client'};
- }
+ $domdefaults{'canuse_pdfforms'} = $domconfig{'coursedefaults'}{'canuse_pdfforms'};
foreach my $type (@coursetypes) {
if (ref($domconfig{'coursedefaults'}{'coursecredits'}) eq 'HASH') {
unless ($type eq 'community') {
@@ -2088,12 +2083,6 @@ sub get_domain_defaults {
if (ref($domconfig{'coursedefaults'}{'uploadquota'}) eq 'HASH') {
$domdefaults{$type.'quota'} = $domconfig{'coursedefaults'}{'uploadquota'}{$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{'usersessions'}) eq 'HASH') {
@@ -2103,9 +2092,6 @@ sub get_domain_defaults {
if (ref($domconfig{'usersessions'}{'hosted'}) eq 'HASH') {
$domdefaults{'hostedsessions'} = $domconfig{'usersessions'}{'hosted'};
}
- if (ref($domconfig{'usersessions'}{'offloadnow'}) eq 'HASH') {
- $domdefaults{'offloadnow'} = $domconfig{'usersessions'}{'offloadnow'};
- }
}
if (ref($domconfig{'selfenrollment'}) eq 'HASH') {
if (ref($domconfig{'selfenrollment'}{'admin'}) eq 'HASH') {
@@ -2138,7 +2124,7 @@ sub get_domain_defaults {
if (ref($domconfig{'coursecategories'}) eq 'HASH') {
$domdefaults{'catauth'} = 'std';
$domdefaults{'catunauth'} = 'std';
- if ($domconfig{'coursecategories'}{'auth'}) {
+ if ($domconfig{'coursecategories'}{'auth'}) {
$domdefaults{'catauth'} = $domconfig{'coursecategories'}{'auth'};
}
if ($domconfig{'coursecategories'}{'unauth'}) {
@@ -2735,22 +2721,20 @@ sub ssi {
&Apache::lonenc::check_encrypt(\$fn);
if (%form) {
$request=new HTTP::Request('POST',&absolute_url().$fn);
- $request->content(join('&',map {
- my $name = escape($_);
- "$name=" . ( ref($form{$_}) eq 'ARRAY'
- ? join("&$name=", map {escape($_) } @{$form{$_}})
- : &escape($form{$_}) );
- } keys(%form)));
+ $request->content(join('&',map { &escape($_).'='.&escape($form{$_}) } keys(%form)));
} else {
$request=new HTTP::Request('GET',&absolute_url().$fn);
}
$request->header(Cookie => $ENV{'HTTP_COOKIE'});
my $response= $ua->request($request);
+ my $content = $response->content;
+
+
if (wantarray) {
- return ($response->content, $response);
+ return ($content, $response);
} else {
- return $response->content;
+ return $content;
}
}
@@ -2782,7 +2766,7 @@ sub allowuploaded {
#
# Determine if the current user should be able to edit a particular resource,
# when viewing in course context.
-# (a) When viewing resource used to determine if "Edit" item is included in
+# (a) When viewing resource used to determine if "Edit" item is included in
# Functions.
# (b) When displaying folder contents in course editor, used to determine if
# "Edit" link will be displayed alongside resource.
@@ -2790,12 +2774,12 @@ sub allowuploaded {
# input: six args -- filename (decluttered), course number, course domain,
# url, symb (if registered) and group (if this is a group
# item -- e.g., bulletin board, group page etc.).
-# output: array of five scalars --
+# output: array of five scalars --
# $cfile -- url for file editing if editable on current server
# $home -- homeserver of resource (i.e., for author if published,
# or course if uploaded.).
# $switchserver -- 1 if server switch will be needed.
-# $forceedit -- 1 if icon/link should be to go to edit mode
+# $forceedit -- 1 if icon/link should be to go to edit mode
# $forceview -- 1 if icon/link should be to go to view mode
#
@@ -2884,7 +2868,7 @@ sub can_edit_resource {
$forceedit = 1;
}
$cfile = $resurl;
- } elsif (($resurl ne '') && (&is_on_map($resurl))) {
+ } elsif (($resurl ne '') && (&is_on_map($resurl))) {
if ($resurl =~ m{^/adm/$match_domain/$match_username/\d+/smppg|bulletinboard$}) {
$incourse = 1;
if ($env{'form.forceedit'}) {
@@ -2915,7 +2899,7 @@ sub can_edit_resource {
}
} elsif ($resurl eq '/res/lib/templates/simpleproblem.problem/smpedit') {
my $template = '/res/lib/templates/simpleproblem.problem';
- if (&is_on_map($template)) {
+ if (&is_on_map($template)) {
$incourse = 1;
$forceview = 1;
$cfile = $template;
@@ -2962,7 +2946,7 @@ sub can_edit_resource {
$cfile=$file;
}
}
- if (($cfile ne '') && (!$incourse || $uploaded) &&
+ if (($cfile ne '') && (!$incourse || $uploaded) &&
(($home ne '') && ($home ne 'no_host'))) {
my @ids=¤t_machine_ids();
unless (grep(/^\Q$home\E$/,@ids)) {
@@ -2989,9 +2973,9 @@ sub in_course {
if ($hideprivileged) {
my $skipuser;
my %coursehash = &coursedescription($cdom.'_'.$cnum);
- my @possdoms = ($cdom);
- if ($coursehash{'checkforpriv'}) {
- push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
+ my @possdoms = ($cdom);
+ if ($coursehash{'checkforpriv'}) {
+ push(@possdoms,split(/,/,$coursehash{'checkforpriv'}));
}
if (&privileged($uname,$udom,\@possdoms)) {
$skipuser = 1;
@@ -3495,7 +3479,7 @@ sub extract_embedded_items {
}
if (lc($tagname) eq 'a') {
unless (($attr->{'href'} =~ /^#/) || ($attr->{'href'} eq '')) {
- &add_filetype($allfiles,$attr->{'href'},'href');
+ &add_filetype($allfiles,$attr->{'href'},'href');
}
}
if (lc($tagname) eq 'script') {
@@ -4166,7 +4150,7 @@ sub get_my_roles {
} else {
my $possdoms = [$domain];
if (ref($roledoms) eq 'ARRAY') {
- push(@{$possdoms},@{$roledoms});
+ push(@{$possdoms},@{$roledoms});
}
if (&privileged($username,$domain,$possdoms,\@privroles)) {
if (!$nothide{$username.':'.$domain}) {
@@ -4274,16 +4258,16 @@ sub courseiddump {
if (($domfilter eq '') ||
(&host_domain($tryserver) eq $domfilter)) {
my $rep;
- if (grep { $_ eq $tryserver } ¤t_machine_ids()) {
- $rep = &LONCAPA::Lond::dump_course_id_handler(
- join(":", (&host_domain($tryserver), $sincefilter,
- &escape($descfilter), &escape($instcodefilter),
+ if (grep { $_ eq $tryserver } current_machine_ids()) {
+ $rep = LONCAPA::Lond::dump_course_id_handler(
+ join(":", (&host_domain($tryserver), $sincefilter,
+ &escape($descfilter), &escape($instcodefilter),
&escape($ownerfilter), &escape($coursefilter),
- &escape($typefilter), &escape($regexp_ok),
- $as_hash, &escape($selfenrollonly),
- &escape($catfilter), $showhidden, $caller,
- &escape($cloner), &escape($cc_clone), $cloneonly,
- &escape($createdbefore), &escape($createdafter),
+ &escape($typefilter), &escape($regexp_ok),
+ $as_hash, &escape($selfenrollonly),
+ &escape($catfilter), $showhidden, $caller,
+ &escape($cloner), &escape($cc_clone), $cloneonly,
+ &escape($createdbefore), &escape($createdafter),
&escape($creationcontext), $domcloner, $hasuniquecode)));
} else {
$rep = &reply('courseiddump:'.&host_domain($tryserver).':'.
@@ -4298,7 +4282,7 @@ sub courseiddump {
&escape($creationcontext).':'.$domcloner.':'.$hasuniquecode,
$tryserver);
}
-
+
my @pairs=split(/\&/,$rep);
foreach my $item (@pairs) {
my ($key,$value)=split(/\=/,$item,2);
@@ -4497,92 +4481,6 @@ sub set_first_access {
return 'already_set';
}
}
-
-sub checkout {
- my ($symb,$tuname,$tudom,$tcrsid)=@_;
- my $now=time;
- my $lonhost=$perlvar{'lonHostID'};
- my $infostr=&escape(
- 'CHECKOUTTOKEN&'.
- $tuname.'&'.
- $tudom.'&'.
- $tcrsid.'&'.
- $symb.'&'.
- $now.'&'.$ENV{'REMOTE_ADDR'});
- my $token=&reply('tmpput:'.$infostr,$lonhost);
- if ($token=~/^error\:/) {
- &logthis("WARNING: ".
- "Checkout tmpput failed ".$tudom.' - '.$tuname.' - '.$symb.
- "");
- return '';
- }
-
- $token=~s/^(\d+)\_.*\_(\d+)$/$1\*$2\*$lonhost/;
- $token=~tr/a-z/A-Z/;
-
- my %infohash=('resource.0.outtoken' => $token,
- 'resource.0.checkouttime' => $now,
- 'resource.0.outremote' => $ENV{'REMOTE_ADDR'});
-
- unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
- return '';
- } else {
- &logthis("WARNING: ".
- "Checkout cstore failed ".$tudom.' - '.$tuname.' - '.$symb.
- "");
- }
-
- if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
- &escape('Checkout '.$infostr.' - '.
- $token)) ne 'ok') {
- return '';
- } else {
- &logthis("WARNING: ".
- "Checkout log failed ".$tudom.' - '.$tuname.' - '.$symb.
- "");
- }
- return $token;
-}
-
-# ------------------------------------------------------------ Check in an item
-
-sub checkin {
- my $token=shift;
- my $now=time;
- my ($ta,$tb,$lonhost)=split(/\*/,$token);
- $lonhost=~tr/A-Z/a-z/;
- my $dtoken=$ta.'_'.&hostname($lonhost).'_'.$tb;
- $dtoken=~s/\W/\_/g;
- my ($dummy,$tuname,$tudom,$tcrsid,$symb,$chtim,$rmaddr)=
- split(/\&/,&unescape(&reply('tmpget:'.$dtoken,$lonhost)));
-
- unless (($tuname) && ($tudom)) {
- &logthis('Check in '.$token.' ('.$dtoken.') failed');
- return '';
- }
-
- unless (&allowed('mgr',$tcrsid)) {
- &logthis('Check in '.$token.' ('.$dtoken.') unauthorized: '.
- $env{'user.name'}.' - '.$env{'user.domain'});
- return '';
- }
-
- my %infohash=('resource.0.intoken' => $token,
- 'resource.0.checkintime' => $now,
- 'resource.0.inremote' => $ENV{'REMOTE_ADDR'});
-
- unless (&cstore(\%infohash,$symb,$tcrsid,$tudom,$tuname) eq 'ok') {
- return '';
- }
-
- if (&log($tudom,$tuname,&homeserver($tuname,$tudom),
- &escape('Checkin - '.$token)) ne 'ok') {
- return '';
- }
-
- return ($symb,$tuname,$tudom,$tcrsid);
-}
-
# --------------------------------------------- Set Expire Date for Spreadsheet
sub expirespread {
@@ -4953,7 +4851,7 @@ sub tmprestore {
# ----------------------------------------------------------------------- Store
sub store {
- my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
+ my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
my $home='';
if ($stuname) { $home=&homeserver($stuname,$domain); }
@@ -4983,13 +4881,13 @@ sub store {
}
$namevalue=~s/\&$//;
&courselog($symb.':'.$stuname.':'.$domain.':STORE:'.$namevalue);
- return reply("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
+ return reply("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
}
# -------------------------------------------------------------- Critical Store
sub cstore {
- my ($storehash,$symb,$namespace,$domain,$stuname,$laststore) = @_;
+ my ($storehash,$symb,$namespace,$domain,$stuname) = @_;
my $home='';
if ($stuname) { $home=&homeserver($stuname,$domain); }
@@ -5020,7 +4918,7 @@ sub cstore {
$namevalue=~s/\&$//;
&courselog($symb.':'.$stuname.':'.$domain.':CSTORE:'.$namevalue);
return critical
- ("store:$domain:$stuname:$namespace:$symb:$namevalue:$laststore","$home");
+ ("store:$domain:$stuname:$namespace:$symb:$namevalue","$home");
}
# --------------------------------------------------------------------- Restore
@@ -5176,7 +5074,7 @@ sub privileged {
my $now = time;
my $roles;
if (ref($possroles) eq 'ARRAY') {
- $roles = $possroles;
+ $roles = $possroles;
} else {
$roles = ['dc','su'];
}
@@ -5200,10 +5098,10 @@ sub privileged {
my %rolesdump = &dump("roles", $domain, $username) or return 0;
my $now = time;
- for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys(%rolesdump)}) {
+ for my $role (@rolesdump{grep { ! /^rolesdef_/ } keys %rolesdump}) {
my ($trole, $tend, $tstart) = split(/_/, $role);
if (grep(/^\Q$trole\E$/,@{$roles})) {
- return 1 unless ($tend && $tend < $now)
+ return 1 unless ($tend && $tend < $now)
or ($tstart && $tstart > $now);
}
}
@@ -5241,7 +5139,7 @@ sub privileged_by_domain {
my ($trole,$uname,$udom,$rest) = split(/:/,$item,4);
my ($end,$start) = split(/:/,$dompersonnel{$server}{$item});
next if ($end && $end < $now);
- $privileged{$dom}{$trole}{$uname.':'.$udom} =
+ $privileged{$dom}{$trole}{$uname.':'.$udom} =
$dompersonnel{$server}{$item};
}
}
@@ -5289,7 +5187,7 @@ sub rolesinit {
my %allroles=();
my %allgroups=();
- for my $area (grep { ! /^rolesdef_/ } keys(%rolesdump)) {
+ for my $area (grep { ! /^rolesdef_/ } keys %rolesdump) {
my $role = $rolesdump{$area};
$area =~ s/\_\w\w$//;
@@ -5712,14 +5610,15 @@ sub unserialize {
return {} if $rep =~ /^error/;
my %returnhash=();
- foreach my $item (split(/\&/,$rep)) {
- my ($key, $value) = split(/=/, $item, 2);
- $key = unescape($key) unless $escapedkeys;
- next if $key =~ /^error: 2 /;
- $returnhash{$key} = &thaw_unescape($value);
- }
+ foreach my $item (split(/\&/,$rep)) {
+ my ($key, $value) = split(/=/, $item, 2);
+ $key = unescape($key) unless $escapedkeys;
+ next if $key =~ /^error: 2 /;
+ $returnhash{$key} = &thaw_unescape($value);
+ }
+ #return %returnhash;
return \%returnhash;
-}
+}
# see Lond::dump_with_regexp
# if $escapedkeys hash keys won't get unescaped.
@@ -5729,16 +5628,17 @@ sub dump {
if (!$uname) { $uname=$env{'user.name'}; }
my $uhome=&homeserver($uname,$udomain);
- if ($regexp) {
- $regexp=&escape($regexp);
- } else {
- $regexp='.';
- }
- if (grep { $_ eq $uhome } ¤t_machine_ids()) {
+ my $reply;
+ if (grep { $_ eq $uhome } current_machine_ids()) {
# user is hosted on this machine
- my $reply = LONCAPA::Lond::dump_with_regexp(join(':', ($udomain,
+ $reply = LONCAPA::Lond::dump_with_regexp(join(":", ($udomain,
$uname, $namespace, $regexp, $range)), $perlvar{'lonVersion'});
- return %{&unserialize($reply, $escapedkeys)};
+ return %{unserialize($reply, $escapedkeys)};
+ }
+ if ($regexp) {
+ $regexp=&escape($regexp);
+ } else {
+ $regexp='.';
}
my $rep=&reply("dump:$udomain:$uname:$namespace:$regexp:$range",$uhome);
my @pairs=split(/\&/,$rep);
@@ -5746,7 +5646,8 @@ sub dump {
if (!($rep =~ /^error/ )) {
foreach my $item (@pairs) {
my ($key,$value)=split(/=/,$item,2);
- $key = &unescape($key) unless ($escapedkeys);
+ $key = unescape($key) unless $escapedkeys;
+ #$key = &unescape($key);
next if ($key =~ /^error: 2 /);
$returnhash{$key}=&thaw_unescape($value);
}
@@ -5790,7 +5691,7 @@ sub currentdump {
my $rep;
if (grep { $_ eq $uhome } current_machine_ids()) {
- $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
+ $rep = LONCAPA::Lond::dump_profile_database(join(":", ($sdom, $sname,
$courseid)));
} else {
$rep = reply('currentdump:'.$sdom.':'.$sname.':'.$courseid,$uhome);
@@ -5916,7 +5817,7 @@ sub newput {
# --------------------------------------------------------- putstore interface
sub putstore {
- my ($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog)=@_;
+ my ($namespace,$symb,$version,$storehash,$udomain,$uname)=@_;
if (!$udomain) { $udomain=$env{'user.domain'}; }
if (!$uname) { $uname=$env{'user.name'}; }
my $uhome=&homeserver($uname,$udomain);
@@ -5930,17 +5831,6 @@ sub putstore {
my $reply =
&reply("putstore:$udomain:$uname:$namespace:$esc_symb:$esc_v:$items",
$uhome);
- if (($tolog) && ($reply eq 'ok')) {
- my $namevalue='';
- foreach my $key (keys(%{$storehash})) {
- $namevalue.=&escape($key).'='.&freeze_escape($storehash->{$key}).'&';
- }
- $namevalue .= 'ip='.&escape($ENV{'REMOTE_ADDR'}).
- '&host='.&escape($perlvar{'lonHostID'}).
- '&version='.$esc_v.
- '&by='.&escape($env{'user.name'}.':'.$env{'user.domain'});
- &Apache::lonnet::courselog($symb.':'.$uname.':'.$udomain.':PUTSTORE:'.$namevalue);
- }
if ($reply eq 'unknown_cmd') {
# gfall back to way things use to be done
return &old_putstore($namespace,$symb,$version,$storehash,$udomain,
@@ -6049,13 +5939,13 @@ sub tmpdel {
return &reply("tmpdel:$token",$server);
}
-# ------------------------------------------------------------ get_timebased_id
+# ------------------------------------------------------------ get_timebased_id
sub get_timebased_id {
my ($prefix,$keyid,$namespace,$cdom,$cnum,$idtype,$who,$locktries,
$maxtries) = @_;
my ($newid,$error,$dellock);
- unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
+ unless (($prefix =~ /^\w+$/) && ($keyid =~ /^\w+$/) && ($namespace ne '')) {
return ('','ok','invalid call to get suffix');
}
@@ -6069,7 +5959,7 @@ sub get_timebased_id {
if (!$maxtries) {
$maxtries = 10;
}
-
+
if (($cdom eq '') || ($cnum eq '')) {
if ($env{'request.course.id'}) {
$cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
@@ -6099,15 +5989,10 @@ sub get_timebased_id {
my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
my $id = time;
$newid = $id;
- if ($idtype eq 'addcode') {
- $newid .= &sixnum_code();
- }
my $idtries = 0;
while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
if ($idtype eq 'concat') {
$newid = $id.$idtries;
- } elsif ($idtype eq 'addcode') {
- $newid = $newid.&sixnum_code();
} else {
$newid ++;
}
@@ -6124,7 +6009,6 @@ sub get_timebased_id {
$error = 'error saving new item: '.$putresult;
}
} else {
- undef($newid);
$error = ('error: no unique suffix available for the new item ');
}
# remove lock
@@ -6133,21 +6017,10 @@ sub get_timebased_id {
} else {
$error = "error: could not obtain lockfile\n";
$dellock = 'ok';
- if (($prefix eq 'paste') && ($namespace eq 'courseeditor') && ($keyid eq 'num')) {
- $dellock = 'nolock';
- }
}
return ($newid,$dellock,$error);
}
-sub sixnum_code {
- my $code;
- for (0..6) {
- $code .= int( rand(9) );
- }
- return $code;
-}
-
# -------------------------------------------------- portfolio access checking
sub portfolio_access {
@@ -6437,7 +6310,7 @@ sub usertools_access {
my ($toolstatus,$inststatus,$envkey);
if ($context eq 'requestauthor') {
- $envkey = $context;
+ $envkey = $context;
} else {
$envkey = $context.'.'.$tool;
}
@@ -6928,7 +6801,7 @@ sub allowed {
&& &is_portfolio_url($uri)) {
$thisallowed = &portfolio_access($uri);
}
-
+
# Full access at system, domain or course-wide level? Exit.
if ($thisallowed=~/F/) {
return 'F';
@@ -7331,15 +7204,13 @@ sub has_comm_blocking {
if ($mapsymb) {
if (ref($navmap)) {
my $mapres = $navmap->getBySymb($mapsymb);
- @to_test = $mapres->retrieveResources($mapres);
+ @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);
- if ($interval[1] eq 'map') {
- last;
- }
+ last;
}
}
}
@@ -7517,9 +7388,9 @@ sub metadata_query {
my @server_list = (defined($server_array) ? @$server_array
: keys(%libserv) );
for my $server (@server_list) {
- my $domains = '';
+ my $domains = '';
if (ref($domains_hash) eq 'HASH') {
- $domains = $domains_hash->{$server};
+ $domains = $domains_hash->{$server};
}
unless ($custom or $customshow) {
my $reply=&reply("querysend:".&escape($query).':::'.&escape($domains),$server);
@@ -8064,7 +7935,8 @@ sub auto_crsreq_update {
':'.&escape($action).':'.&escape($ownername).':'.
&escape($ownerdomain).':'.&escape($fullname).':'.
&escape($title).':'.&escape($code).':'.
- &escape($accessstart).':'.&escape($accessend).':'.$info,$homeserver);
+ &escape($accessstart).':'.&escape($accessend).':'.$info,
+ $homeserver);
unless ($response =~ /(con_lost|error|no_such_host|refused)/) {
my @items = split(/&/,$response);
foreach my $item (@items) {
@@ -8344,7 +8216,7 @@ sub assignrole {
}
}
} elsif ($context eq 'requestauthor') {
- if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
+ if (($udom eq $env{'user.domain'}) && ($uname eq $env{'user.name'}) &&
($url eq '/'.$udom.'/') && ($role eq 'au')) {
if ($env{'environment.requestauthor'} eq 'automatic') {
$refused = '';
@@ -8352,13 +8224,13 @@ sub assignrole {
my %domdefaults = &get_domain_defaults($udom);
if (ref($domdefaults{'requestauthor'}) eq 'HASH') {
my $checkbystatus;
- if ($env{'user.adv'}) {
+ if ($env{'user.adv'}) {
my $disposition = $domdefaults{'requestauthor'}{'_LC_adv'};
if ($disposition eq 'automatic') {
$refused = '';
} elsif ($disposition eq '') {
$checkbystatus = 1;
- }
+ }
} else {
$checkbystatus = 1;
}
@@ -8445,7 +8317,7 @@ sub assignrole {
$context);
} elsif (($role eq 'ca') || ($role eq 'aa')) {
&coauthorrolelog($role,$uname,$udom,$url,$origstart,$origend,$delflag,
- $context);
+ $context);
}
if ($role eq 'cc') {
&autoupdate_coowners($url,$end,$start,$uname,$udom);
@@ -8760,7 +8632,7 @@ sub modifystudent {
# student's environment
$uid = undef if (!$forceid);
$reply = &modify_student_enrollment($udom,$uname,$uid,$first,$middle,$last,
- $gene,$usec,$end,$start,$type,$locktype,
+ $gene,$usec,$end,$start,$type,$locktype,
$cid,$selfenroll,$context,$credits);
return $reply;
}
@@ -9905,7 +9777,7 @@ sub get_numsuppfiles {
unless ($chome eq 'no_host') {
($suppcount,my $errors) = (0,0);
my $suppmap = 'supplemental.sequence';
- ($suppcount,$errors) =
+ ($suppcount,$errors) =
&Apache::loncommon::recurse_supplemental($cnum,$cdom,$suppmap,$suppcount,$errors);
}
&do_cache_new('suppcount',$hashid,$suppcount,600);
@@ -10100,7 +9972,7 @@ sub EXT {
$courseid = $cid;
}
if (($symbparm && $courseid) &&
- (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
+ (($courseid eq $env{'request.course.id'}) || ($courseid eq $cid))) {
#print '
'.$space.' - '.$qualifier.' - '.$spacequalifierrest;
@@ -10612,7 +10484,7 @@ sub metadata {
$metaentry{':keys'} = join(',',keys(%metathesekeys));
&metadata_generate_part0(\%metathesekeys,\%metaentry,$uri);
- $metaentry{':allpossiblekeys'}=join(',',keys(%metathesekeys));
+ $metaentry{':allpossiblekeys'}=join(',',keys %metathesekeys);
&do_cache_new('meta',$uri,\%metaentry,$cachetime);
# this is the end of "was not already recently cached
}
@@ -10888,7 +10760,7 @@ sub symbverify {
$ids=$bighash{'ids_'.&clutter($thisurl)};
}
unless ($ids) {
- my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
+ my $idkey = 'ids_'.($thisurl =~ m{^/}? '' : '/').$thisurl;
$ids=$bighash{$idkey};
}
if ($ids) {
@@ -10904,14 +10776,14 @@ sub symbverify {
if (ref($encstate)) {
$$encstate = $bighash{'encrypted_'.$id};
}
- if (($env{'request.role.adv'}) ||
- ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
+ if (($env{'request.role.adv'}) ||
+ ($bighash{'encrypted_'.$id} eq $env{'request.enc'}) ||
($thisurl eq '/adm/navmaps')) {
- $okay=1;
+ $okay=1;
last;
- }
- }
- }
+ }
+ }
+ }
}
untie(%bighash);
}
@@ -10984,14 +10856,18 @@ sub deversion {
sub symbread {
my ($thisfn,$donotrecurse)=@_;
- my $cache_str='request.symbread.cached.'.$thisfn;
- if (defined($env{$cache_str})) { return $env{$cache_str}; }
+ my $cache_str;
+ if ($thisfn ne '') {
+ $cache_str='request.symbread.cached.'.$thisfn;
+ if ($env{$cache_str} ne '') {
+ return $env{$cache_str};
+ }
+ } else {
# no filename provided? try from environment
- unless ($thisfn) {
if ($env{'request.symb'}) {
- return $env{$cache_str}=&symbclean($env{'request.symb'});
- }
- $thisfn=$env{'request.filename'};
+ return $env{$cache_str}=&symbclean($env{'request.symb'});
+ }
+ $thisfn=$env{'request.filename'};
}
if ($thisfn=~m|^/enc/|) { $thisfn=&Apache::lonenc::unencrypted($thisfn); }
# is that filename actually a symb? Verify, clean, and return
@@ -11219,6 +11095,7 @@ sub rndseed {
$which =&get_rand_alg($courseid);
}
if (defined(&getCODE())) {
+
if ($which eq '64bit5') {
return &rndseed_CODE_64bit5($symb,$courseid,$domain,$username);
} elsif ($which eq '64bit4') {
@@ -11404,7 +11281,7 @@ sub rndseed_CODE_64bit5 {
sub setup_random_from_rndseed {
my ($rndseed)=@_;
if ($rndseed =~/([,:])/) {
- my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
+ my ($num1,$num2) = map { abs($_); } (split(/[,:]/,$rndseed));
if ((!$num1) || (!$num2) || ($num1 > 2147483562) || ($num2 > 2147483398)) {
&Math::Random::random_set_seed_from_phrase($rndseed);
} else {
@@ -11929,7 +11806,7 @@ sub get_dns {
$alldns{$host} = $protocol;
}
while (%alldns) {
- my ($dns) = sort { $b cmp $a } keys(%alldns);
+ my ($dns) = keys(%alldns);
my $ua=new LWP::UserAgent;
$ua->timeout(30);
my $request=new HTTP::Request('GET',"$alldns{$dns}://$dns$url");
@@ -11937,9 +11814,9 @@ sub get_dns {
delete($alldns{$dns});
next if ($response->is_error());
my @content = split("\n",$response->content);
- unless ($nocache) {
+ unless ($nocache) {
&do_cache_new('dns',$url,\@content,30*24*60*60);
- }
+ }
&$func(\@content,$hashref);
return;
}
@@ -11955,35 +11832,16 @@ sub get_dns {
# ------------------------------------------------------Get DNS checksums file
sub parse_dns_checksums_tab {
my ($lines,$hashref) = @_;
- my $lonhost = $perlvar{'lonHostID'};
- my $machine_dom = &Apache::lonnet::host_domain($lonhost);
+ my $machine_dom = &Apache::lonnet::host_domain($perlvar{'lonHostID'});
my $loncaparev = &get_server_loncaparev($machine_dom);
- my $distro = (split(/\:/,&get_server_distarch($lonhost)))[0];
- my $webconfdir = '/etc/httpd/conf';
- if ($distro =~ /^(ubuntu|debian)(\d+)$/) {
- $webconfdir = '/etc/apache2';
- } elsif ($distro =~ /^sles(\d+)$/) {
- if ($1 >= 10) {
- $webconfdir = '/etc/apache2';
- }
- } elsif ($distro =~ /^suse(\d+\.\d+)$/) {
- if ($1 >= 10.0) {
- $webconfdir = '/etc/apache2';
- }
- }
my ($release,$timestamp) = split(/\-/,$loncaparev);
my (%chksum,%revnum);
if (ref($lines) eq 'ARRAY') {
chomp(@{$lines});
my $version = shift(@{$lines});
- if ($version eq $release) {
+ if ($version eq $release) {
foreach my $line (@{$lines}) {
my ($file,$version,$shasum) = split(/,/,$line);
- if ($file =~ m{^/etc/httpd/conf}) {
- if ($webconfdir eq '/etc/apache2') {
- $file =~ s{^\Q/etc/httpd/conf/\E}{$webconfdir/};
- }
- }
$chksum{$file} = $shasum;
$revnum{$file} = $version;
}
@@ -12384,9 +12242,9 @@ sub all_loncaparevs {
return qw(1.1 1.2 1.3 2.0 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11);
}
-# ------------------------------------------------------- Read loncaparev table
+# ---------------------------------------------------------- Read loncaparev table
{
- sub load_loncaparevs {
+ sub load_loncaparevs {
if (-e "$perlvar{'lonTabDir'}/loncaparevs.tab") {
if (open(my $config,"<$perlvar{'lonTabDir'}/loncaparevs.tab")) {
while (my $configline=<$config>) {
@@ -12400,7 +12258,7 @@ sub all_loncaparevs {
}
}
-# ----------------------------------------------------- Read serverhostID table
+# ---------------------------------------------------------- Read serverhostID table
{
sub load_serverhomeIDs {
if (-e "$perlvar{'lonTabDir'}/serverhomeIDs.tab") {
@@ -12492,11 +12350,11 @@ BEGIN {
close($config);
}
-# --------------------------------------------------------- Read loncaparev table
+# ---------------------------------------------------------- Read loncaparev table
&load_loncaparevs();
-# ------------------------------------------------------- Read serverhostID table
+# ---------------------------------------------------------- Read serverhostID table
&load_serverhomeIDs();
@@ -12700,7 +12558,7 @@ were new keys. I.E. 1:foo will become 1:
Calling convention:
my %record=&Apache::lonnet::restore($symb,$courseid,$domain,$uname);
- &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname,$laststore);
+ &Apache::lonnet::cstore(\%newrecord,$symb,$courseid,$domain,$uname);
For more detailed information, see lonnet specific documentation.
@@ -12894,9 +12752,9 @@ provided for types, will default to retu
=item *
in_course($udom,$uname,$cdom,$cnum,$type,$hideprivileged) : determine if
-user: $uname:$udom has a role in the course: $cdom_$cnum.
+user: $uname:$udom has a role in the course: $cdom_$cnum.
-Additional optional arguments are: $type (if role checking is to be restricted
+Additional optional arguments are: $type (if role checking is to be restricted
to certain user status types -- previous (expired roles), active (currently
available roles) or future (roles available in the future), and
$hideprivileged -- if true will not report course roles for users who
@@ -13133,7 +12991,7 @@ values that are the resource value. I b
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
+supplemental content area. This routine caches the number of files for
10 minutes.
=back
@@ -13246,9 +13104,9 @@ and is a possible symb for the URL in $t
resource that the user accessed using /enc/ returns a 1 on success, 0
on failure, user must be in a course, as it assumes the existence of
the course initial hash, and uses $env('request.course.id'}. The third
-arg is an optional reference to a scalar. If this arg is passed in the
+arg is an optional reference to a scalar. If this arg is passed in the
call to symbverify, it will be set to 1 if the symb has been set to be
-encrypted; otherwise it will be null.
+encrypted; otherwise it will be null.
=item *
@@ -13301,13 +13159,13 @@ expirespread($uname,$udom,$stype,$usymb)
devalidate($symb) : devalidate temporary spreadsheet calculations,
forcing spreadsheet to reevaluate the resource scores next time.
-=item *
+=item *
can_edit_resource($file,$cnum,$cdom,$resurl,$symb,$group) : determine if current user can edit a particular resource,
when viewing in course context.
input: six args -- filename (decluttered), course number, course domain,
- url, symb (if registered) and group (if this is a
+ url, symb (if registered) and group (if this is a
group item -- e.g., bulletin board, group page etc.).
output: array of five scalars --
@@ -13315,15 +13173,15 @@ when viewing in course context.
$home -- homeserver of resource (i.e., for author if published,
or course if uploaded.).
$switchserver -- 1 if server switch will be needed.
- $forceedit -- 1 if icon/link should be to go to edit mode
+ $forceedit -- 1 if icon/link should be to go to edit mode
$forceview -- 1 if icon/link should be to go to view mode
=item *
is_course_upload($file,$cnum,$cdom)
-Used in course context to determine if current file was uploaded to
-the course (i.e., would be found in /userfiles/docs on the course's
+Used in course context to determine if current file was uploaded to
+the course (i.e., would be found in /userfiles/docs on the course's
homeserver.
input: 3 args -- filename (decluttered), course number and course domain.
@@ -13337,21 +13195,15 @@ homeserver.
=item *
-store($storehash,$symb,$namespace,$udom,$uname,$laststore) : stores hash
-permanently for this url; hashref needs to be given and should be a \%hashname;
-the remaining args aren't required and if they aren't passed or are '' they will
-be derived from the env (with the exception of $laststore, which is an
-optional arg used when a user's submission is stored in grading).
-$laststore is $version=$timestamp, where $version is the most recent version
-number retrieved for the corresponding $symb in the $namespace db file, and
-$timestamp is the timestamp for that transaction (UNIX time).
-$laststore is currently only passed when cstore() is called by
-structuretags::finalize_storage().
+store($storehash,$symb,$namespace,$udom,$uname) : stores hash permanently
+for this url; hashref needs to be given and should be a \%hashname; the
+remaining args aren't required and if they aren't passed or are '' they will
+be derived from the env
=item *
-cstore($storehash,$symb,$namespace,$udom,$uname,$laststore) : same as store
-but uses critical subroutine
+cstore($storehash,$symb,$namespace,$udom,$uname) : same as store but
+uses critical subroutine
=item *
@@ -13374,11 +13226,10 @@ $range should be either an integer '100'
=item *
-putstore($namespace,$symb,$version,$storehash,$udomain,$uname,$tolog) :
+putstore($namespace,$symb,$version,$storehash,$udomain,$uname) :
replaces a &store() version of data with a replacement set of data
for a particular resource in a namespace passed in the $storehash hash
-reference. If $tolog is true, the transaction is logged in the courselog
-with an action=PUTSTORE.
+reference
=item *
@@ -13488,7 +13339,7 @@ server ($udom and $uhome are optional)
=item *
-get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
+get_domain_defaults($target_domain,$ignore_cache) : returns hash with defaults
for: authentication, language, quotas, timezone, date locale, and portal URL in
the target domain.
@@ -13543,7 +13394,8 @@ for course's uploaded content.
=over
=item
-canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota, communityquota, textbookquota
+canuse_pdfforms, officialcredits, unofficialcredits, textbookcredits, officialquota, unofficialquota,
+communityquota, textbookquota
=back
@@ -13553,7 +13405,7 @@ on your servers.
=over
-=item
+=item
remotesessions, hostedsessions
=back
@@ -13561,10 +13413,10 @@ remotesessions, hostedsessions
=back
In cases where a domain coordinator has never used the "Set Domain Configuration"
-utility to create a configuration.db file on a domain's primary library server
+utility to create a configuration.db file on a domain's primary library server
only the following domain defaults: auth_def, auth_arg_def, lang_def
-- corresponding values are authentication type (internal, krb4, krb5,
-or localauth), initial password or a kerberos realm, language (e.g., en-us) --
+or localauth), initial password or a kerberos realm, language (e.g., en-us) --
will be available. Values are retrieved from cache (if current), unless the
optional $ignore_cache arg is true, or from domain's configuration.db (if available),
or lastly from values in lonTabs/dns_domain,tab, or lonTabs/domain.tab.
@@ -13992,8 +13844,8 @@ Returns:
get_timebased_id():
-Attempts to get a unique timestamp-based suffix for use with items added to a
-course via the Course Editor (e.g., folders, composite pages,
+Attempts to get a unique timestamp-based suffix for use with items added to a
+course via the Course Editor (e.g., folders, composite pages,
group bulletin boards).
Args: (first three required; six others optional)
@@ -14004,24 +13856,24 @@ Args: (first three required; six others
2. keyid (alphanumeric): name of temporary locking key in hash,
e.g., num, boardids
-3. namespace: name of gdbm file used to store suffixes already assigned;
+3. namespace: name of gdbm file used to store suffixes already assigned;
file will be named nohist_namespace.db
4. cdom: domain of course; default is current course domain from %env
5. cnum: course number; default is current course number from %env
-6. idtype: set to concat if an additional digit is to be appended to the
+6. idtype: set to concat if an additional digit is to be appended to the
unix timestamp to form the suffix, if the plain timestamp is already
- in use. Default is to not do this, but simply increment the unix
+ in use. Default is to not do this, but simply increment the unix
timestamp by 1 until a unique key is obtained.
7. who: holder of locking key; defaults to user:domain for user.
-8. locktries: number of attempts to obtain a lock (sleep of 1s before
+8. locktries: number of attempts to obtain a lock (sleep of 1s before
retrying); default is 3.
-9. maxtries: number of attempts to obtain a unique suffix; default is 20.
+9. maxtries: number of attempts to obtain a unique suffix; default is 20.
Returns: