--- loncom/interface/loncoursedata.pm	2002/09/14 18:57:59	1.31
+++ loncom/interface/loncoursedata.pm	2002/10/17 19:36:30	1.38
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # (Publication Handler
 #
-# $Id: loncoursedata.pm,v 1.31 2002/09/14 18:57:59 www Exp $
+# $Id: loncoursedata.pm,v 1.38 2002/10/17 19:36:30 matthew Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -139,7 +139,7 @@ sub DownloadClasslist {
     %classlist=&Apache::lonnet::dump('classlist',$courseDomain, $courseNumber);
     foreach(keys (%classlist)) {
         if(/^(con_lost|error|no_such_host)/i) {
-            return \%classlist;
+	    return;
         }
     }
 
@@ -586,7 +586,24 @@ browser
 Output: @names
 
 @names:  An array of students whose information has been processed, and are to 
-be considered in an arbitrary order.
+be considered in an arbitrary order.  The entries in @names are of the form
+username:domain.
+
+The values in $cache are as follows:
+
+ *NOTE: for the following $name implies username:domain
+ $name.':error'                  only defined if an error occured.  Value
+                                 contains the error message
+ $name.':lastDownloadTime'       unconverted time of the last update of a
+                                 student\'s course data
+ $name.'updateTime'              coverted time of the last update of a 
+                                 student\'s course data
+ $name.':username'               username of a student
+ $name.':domain'                 domain of a student
+ $name.':fullname'               full name of a student
+ $name.':id'                     PID of a student
+ $name.':Status'                 active/expired status of a student
+ $name.':section'                section of a student
 
 =back
 
@@ -609,9 +626,8 @@ sub ProcessClasslist {
         if($c->aborted()) {
             return ();
         }
-        my $studentInformation = $classlist->{$name.':studentInformation'},
-        my $sectionData = $classlist->{$name.':sections'},
-        my $date = $classlist->{$name},
+        my $studentInformation = $classlist->{$name.':studentInformation'};
+        my $date = $classlist->{$name};
         my ($studentName,$studentDomain) = split(/\:/,$name);
 
         $cache->{$name.':username'}=$studentName;
@@ -646,6 +662,7 @@ sub ProcessClasslist {
         $courseID=~s/^(\w)/\/$1/;
 
         my $sec='';
+        my $sectionData = $classlist->{$name.':sections'};
         foreach my $key (keys (%$sectionData)) {
             my $value = $sectionData->{$key};
             if ($key=~/^$courseID(?:\/)*(\w+)*\_st$/) {
@@ -653,7 +670,7 @@ sub ProcessClasslist {
                 if($key eq $courseID.'_st') {
                     $tempsection='';
                 }
-                my ($dummy,$roleend,$rolestart)=split(/\_/,$value);
+                my (undef,$roleend,$rolestart)=split(/\_/,$value);
                 if($roleend eq $end && $rolestart eq $start) {
                     $sec = $tempsection;
                     last;
@@ -1067,37 +1084,22 @@ sub ProcessFullName {
     my ($lastname, $generation, $firstname, $middlename)=@_;
     my $Str = '';
 
+    # Strip whitespace preceeding & following name components.
+    $lastname   =~ s/(\s+$|^\s+)//g;
+    $generation =~ s/(\s+$|^\s+)//g;
+    $firstname  =~ s/(\s+$|^\s+)//g;
+    $middlename =~ s/(\s+$|^\s+)//g;
+
     if($lastname ne '') {
-	$Str .= $lastname.' ';
-	if($generation ne '') {
-	    $Str .= $generation;
-	} else {
-	    chop($Str);
-	}
-	$Str .= ', ';
-	if($firstname ne '') {
-	    $Str .= $firstname.' ';
-	}
-	if($middlename ne '') {
-	    $Str .= $middlename;
-	} else {
-	    chop($Str);
-	    if($firstname eq '') {
-		chop($Str);
-	    }
-	}
+	$Str .= $lastname;
+	$Str .= ' '.$generation if ($generation ne '');
+	$Str .= ',';
+        $Str .= ' '.$firstname  if ($firstname ne '');
+        $Str .= ' '.$middlename if ($middlename ne '');
     } else {
-	if($firstname ne '') {
-	    $Str .= $firstname.' ';
-	}
-	if($middlename ne '') {
-	    $Str .= $middlename.' ';
-	}
-	if($generation ne '') {
-	    $Str .= $generation;
-	} else {
-	    chop($Str);
-	}
+        $Str .= $firstname      if ($firstname ne '');
+        $Str .= ' '.$middlename if ($middlename ne '');
+        $Str .= ' '.$generation if ($generation ne '');
     }
 
     return $Str;
@@ -1385,7 +1387,95 @@ sub CheckForResidualDownload {
     return 'OK';
 }
 
+################################################
+################################################
+
+=pod
+
+=item &get_classlist();
+
+Retrieve the classist of a given class or of the current class.  Student
+information is returned from the classlist.db file and, if needed,
+from the students environment.
+
+Optional arguments are $cid, $cdom, and $cnum (course id, course domain,
+and course number, respectively).  Any omitted arguments will be taken 
+from the current environment ($ENV{'request.course.id'},
+$ENV{'course.'.$cid.'.domain'}, and $ENV{'course.'.$cid.'.num'}).
+
+Returns a reference to a hash which contains:
+ keys    '$sname:$sdom'
+ values  [$end,$start,$id,$section,$fullname]
+
+=cut
+
+################################################
+################################################
+
+sub get_classlist {
+    my ($cid,$cdom,$cnum) = @_;
+    $cid = $cid || $ENV{'request.course.id'};
+    $cdom = $cdom || $ENV{'course.'.$cid.'.domain'};
+    $cnum = $cnum || $ENV{'course.'.$cid.'.num'};
+   my $now = time;
+    #
+    my %classlist=&Apache::lonnet::dump('classlist',$cdom,$cnum);
+    while (my ($student,$info) = each(%classlist)) {
+        return undef if ($student =~ /^(con_lost|error|no_such_host)/i);
+        my ($sname,$sdom) = split(/:/,$student);
+        my @Values = split(/:/,$info);
+        my ($end,$start,$id,$section,$fullname);
+        if (@Values > 2) {
+            ($end,$start,$id,$section,$fullname) = @Values;
+        } else { # We have to get the data ourselves
+            ($end,$start) = @Values;
+            $section = &Apache::lonnet::getsection($sdom,$sname,$cid);
+            my %info=&Apache::lonnet::get('environment',
+                                          ['firstname','middlename',
+                                           'lastname','generation','id'],
+                                          $sdom, $sname);
+            my ($tmp) = keys(%info);
+            if ($tmp =~/^(con_lost|error|no_such_host)/i) {
+                $fullname = 'not available';
+                $id = 'not available';
+                &Apache::lonnet::logthis('unable to retrieve environment '.
+                                         'for '.$sname.':'.$sdom);
+            } else {
+                $fullname = &ProcessFullName(@info{qw/lastname generation 
+                                                       firstname middlename/});
+                $id = $info{'id'};
+            }
+            # Update the classlist with this students information
+            if ($fullname ne 'not available') {
+                my $enrolldata = join(':',$end,$start,$id,$section,$fullname);
+                my $reply=&Apache::lonnet::cput('classlist',
+                                                {$student => $enrolldata},
+                                                $cdom,$cnum);
+                if ($reply !~ /^(ok|delayed)/) {
+                    &Apache::lonnet::logthis('Unable to update classlist for '.
+                                             'student '.$sname.':'.$sdom.
+                                             ' error:'.$reply);
+                }
+            }
+        }
+        my $status='Expired';
+        if(((!$end) || $now < $end) && ((!$start) || ($now > $start))) {
+            $status='Active';
+        }
+        $classlist{$student} = 
+            [$sdom,$sname,$end,$start,$id,$section,$fullname,$status];
+    }
+    if (wantarray()) {
+        return (\%classlist,['domain','username','end','start','id',
+                             'section','fullname','status']);
+    } else {
+        return \%classlist;
+    }
+}
+
 # ----- END HELPER FUNCTIONS --------------------------------------------
 
 1;
 __END__
+
+