--- loncom/enrollment/localenroll.pm	2016/04/02 04:31:26	1.54
+++ loncom/enrollment/localenroll.pm	2018/06/14 04:11:49	1.59
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.54 2016/04/02 04:31:26 raeburn Exp $
+# $Id: localenroll.pm,v 1.59 2018/06/14 04:11:49 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -39,8 +39,6 @@ described at http://www.lon-capa.org.
 
 =head1 NOTABLE SUBROUTINES
 
-=over
-
 =cut
 
 package localenroll;
@@ -48,6 +46,8 @@ package localenroll;
 use strict;
 
 =pod
+
+=over
  
 =item run()
  set this to return 1 if you want the auto enrollment to run
@@ -258,9 +258,11 @@ sub get_sections {
  username:domain
  (c) the LON-CAPA domain that contains the course
 
- new_course also takes a fourth (optional) argument -
+ new_course also takes optional fourth and fifth arguments -
  (d) the course co-owners, as a comma-separated list of username:domain for
- any co-owners. 
+ any co-owners.
+ (e) database handle (might be set when new_course() is called by check_section
+ routine within localenroll.pm).
 
 =cut
 
@@ -542,6 +544,94 @@ sub crsreq_updates {
 
 =pod
 
+=item export_grades()
+ 
+This routine can be customized to push grade information to some other gradebook,
+LCMS, or administrative system external to LON-CAPA.
+
+export_grades() takes five arguments -
+(a) the LON-CAPA course ID
+(b) the LON-CAPA course domain
+(c) a hash reference containing the following: 
+    scope    => scope of the grades (e.g., course, map or resource).
+    instcode => institutional course code (if an official course)
+    crstype  => course type -- Course, Community or Placement
+    context  => calling context, e.g., "completion" when a student completes a placement test.
+(d) a perl data structure (hash of a hash) containing the grade data.
+    in the outer hash, the keys are student's username:domain
+    in the inner hash, keys are:  
+    id        => student/employee ID
+    lastname  => student's last name
+    firstname => student's first name
+    email     => student's "permannent" e-mail address
+    section   => student's LON-CAPA course section
+    total     => total points earned
+    bytitle   => reference to a hash (keys are question titles, values are points
+    bysymb    => reference to a hash (keys are symbs, i.e., unique resource identifiers).
+(e) reference to a hash which will contain information to return.
+    keys will be the student's username:domain. Value of 1 to show grades pushed 
+    successfully. 
+
+=cut
+
+sub export_grades {
+    my ($cnum,$cdom,$hashref,$dataref,$outgoing) = @_;
+    my %info;
+    if (ref($hashref) eq 'HASH') {
+        %info = %{$hashref};
+    }
+    if ((ref($dataref) eq 'HASH') && (ref($outgoing) eq 'HASH')) {
+        foreach my $key (keys(%{$dataref})) {
+            $outgoing->{$key} = 1;
+        }
+        return 'ok';
+    } else {
+        return 'error';
+    }
+}
+
+=pod
+
+=item check_instclasses()
+
+ This is used to supply information about which instituional course sections
+ and cross-listings are available to supply enrollment data, given the current
+ list of owner and co-owners. The data are used to populate the column titled:
+ "Auto-enrollment of registered students" when showing full detailed for a course
+ in the course catalog.
+
+ This subroutine takes four arguments -
+
+ (a) $owners - comma-separated list of username:domain for course owner 
+     and co-owners.
+ (b) $dom - domain of course.
+ (c) $classes - reference to hash of institutional course sections and
+     crosslistings for which access to enrollment data is being checked.
+ (d) $validated - reference to hash which will be populated with all
+     keys from incoming $classes hashref, for which one or more of the
+     owner/co-owners has rights to access enrollment data. For each
+     key included in $validated hashref, corresponding value will be set to 1.
+  
+ The subroutine returns 'ok' if there is no processing error.
+
+=cut
+
+
+sub check_instclasses {
+    my ($owners,$dom,$classes,$validated) = @_;
+    if ((ref($classes) eq 'HASH') && (ref($validated) eq 'HASH')) {
+        foreach my $class (keys(%{$classes})){
+            if (&check_section($class,$owners,$dom) eq 'ok') {
+                $validated->{$class} = 1;
+            }
+        }
+    }
+    return 'ok';
+}
+
+
+=pod
+
 =item create_password()
 
  This is called when the authentication method set for the automated 
@@ -907,8 +997,8 @@ sub allusers_info {
               institutional types to check.
  (g) $srchby - optional if $uname or $id defined, otherwise required.
                Allowed values include: 1. lastfirst, 2. last, 3. uname
-               corresponding to searches by 1. lastname,firstname;
-               2. lastname; 3. username
+               4. email, corresponding to searches by 1. lastname,firstname;
+               2. lastname; 3. username; 4. e-mail address
  (h) $srchterm - optional if $uname or $id defined, otherwise required
                 String to search for.
  (i) $srchtype - optional. Allowed values: contains, begins (defaults