loncom/lonnet/perl/lonnet.pm - diff

Return to lonnet.pm CVS log

Up to [LON-CAPA] / loncom / lonnet / perl

Diff for /loncom/lonnet/perl/lonnet.pm between versions 1.1197 and 1.1198

-version 1.1197, 2012/11/11 01:48:33
+version 1.1198, 2012/11/11 17:33:26
  Line 2694  sub can_edit_resource {
              my $allowed = 0;
              if ($resurl =~ m{^/?adm/$cdom/$cnum/$group/smppg$}) {
                  if ((&allowed('mdg',$env{'request.course.id'}.
-                             ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
+                               ($env{'request.course.sec'}?'/'.$env{'request.course.sec'}:''))) ||
                          (&allowed('mgh',$env{'request.course.id'}.'/'.$group)) || $crsedit) {
                      $allowed = 1;
                  }
  Line 5691  sub tmpdel {
      return &reply("tmpdel:$token",$server);
  }
+ # ------------------------------------------------------------ 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 '')) {
+         return ('','ok','invalid call to get suffix');
+     }
+ # set defaults for any optional args for which values were not supplied
+     if ($who eq '') {
+         $who = $env{'user.name'}.':'.$env{'user.domain'};
+     }
+     if (!$locktries) {
+         $locktries = 3;
+     }
+     if (!$maxtries) {
+         $maxtries = 10;
+     }
+     if (($cdom eq '') || ($cnum eq '')) {
+         if ($env{'request.course.id'}) {
+             $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+             $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+         }
+         if (($cdom eq '') || ($cnum eq '')) {
+             return ('','ok','call to get suffix not in course context');
+         }
+     }
+ # construct locking item
+     my $lockhash = {
+                       $prefix."\0".'locked_'.$keyid => $who,
+                    };
+     my $tries = 0;
+ # attempt to get lock on nohist_$namespace file
+     my $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
+     while (($gotlock ne 'ok') && $tries <$locktries) {
+         $tries ++;
+         sleep 1;
+         $gotlock = &Apache::lonnet::newput('nohist_'.$namespace,$lockhash,$cdom,$cnum);
+     }
+ # attempt to get unique identifier, based on current timestamp
+     if ($gotlock eq 'ok') {
+         my %inuse = &Apache::lonnet::dump('nohist_'.$namespace,$cdom,$cnum,$prefix);
+         my $id = time;
+         $newid = $id;
+         my $idtries = 0;
+         while (exists($inuse{$prefix."\0".$newid}) && $idtries < $maxtries) {
+             if ($idtype eq 'concat') {
+                 $newid = $id.$idtries;
+             } else {
+                 $newid ++;
+             }
+             $idtries ++;
+         }
+         if (!exists($inuse{$prefix."\0".$newid})) {
+             my %new_item =  (
+                               $prefix."\0".$newid => $who,
+                             );
+             my $putresult = &Apache::lonnet::put('nohist_'.$namespace,\%new_item,
+                                                  $cdom,$cnum);
+             if ($putresult ne 'ok') {
+                 undef($newid);
+                 $error = 'error saving new item: '.$putresult;
+             }
+         } else {
+              $error = ('error: no unique suffix available for the new item ');
+         }
+ #  remove lock
+         my @del_lock = ($prefix."\0".'locked_'.$keyid);
+         $dellock = &Apache::lonnet::del('nohist_'.$namespace,\@del_lock,$cdom,$cnum);
+     } else {
+         $error = "error: could not obtain lockfile\n";
+         $dellock = 'ok';
+     }
+     return ($newid,$dellock,$error);
+ }
  # -------------------------------------------------- portfolio access checking
  sub portfolio_access {
- Line 13216  Internal notes:
+ Line 13298  Internal notes:
   Locks on files (resulting from submission of portfolio file to a homework problem stored in array of arrays.
+ =item *
  modify_access_controls():
  Modifies access controls for a portfolio file
- Line 13233  Returns:
+ Line 13317  Returns:
 . reference to hash of any new or updated access controls.
 . reference to hash used to map incoming IDs to uniqueIDs assigned to control.
     key = integer (inbound ID)
     value = uniqueID
+ =item *
+ 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,
+ group bulletin boards).
+ Args: (first three required; six others optional)
+. prefix (alphanumeric): of keys in hash, e.g., suppsequence, docspage,
+    docssequence, or name of group
+. keyid (alphanumeric): name of temporary locking key in hash,
+    e.g., num, boardids
+. namespace: name of gdbm file used to store suffixes already assigned;
+    file will be named nohist_namespace.db
+. cdom: domain of course; default is current course domain from %env
+. cnum: course number; default is current course number from %env
+. 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
+    timestamp by 1 until a unique key is obtained.
+. who: holder of locking key; defaults to user:domain for user.
+. locktries: number of attempts to obtain a lock (sleep of 1s before
+    retrying); default is 3.
+. maxtries: number of attempts to obtain a unique suffix; default is 20.
+ Returns:
+. suffix obtained (numeric)
+. result of deleting locking key (ok if deleted, or lock never obtained)
+. error: contains (localized) error message if an error occurred.
  =back

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

Removed from v.1.1197
changed lines
	Added in v.1.1198