Annotation of loncom/enrollment/Autoenroll.pl, revision 1.13
1.2 raeburn 1: #!/usr/bin/perl
1.5 albertel 2: #
3: #Automated Enrollment script
1.13 ! albertel 4: # $Id: Autoenroll.pl,v 1.12 2004/11/27 17:23:09 raeburn Exp $
1.5 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.2 raeburn 28: use strict;
29: use lib '/home/httpd/lib/perl';
30: use localenroll;
31: use LONCAPA::Configuration;
32: use LONCAPA::Enrollment;
33: use Apache::lonnet;
34: use Apache::loncoursedata;
35: use Apache::lonmsg;
36: use HTML::Entities;
1.6 albertel 37:
1.9 raeburn 38: # Determine the library server's domain and hostID
1.2 raeburn 39: my $perlvarref = LONCAPA::Configuration::read_conf('loncapa.conf');
1.4 raeburn 40: my $logfile = $$perlvarref{'lonDaemons'}.'/logs/autoenroll.log';
1.11 raeburn 41: my @domains = &Apache::lonnet::current_machine_domains();
42: my @hostids = &Apache::lonnet::current_machine_ids();
1.1 raeburn 43:
44: # Determine the present time;
1.2 raeburn 45: my $timenow = time();
1.1 raeburn 46:
1.11 raeburn 47: # For each domain ......
48: foreach my $dom (@domains) {
49: #only run if configured to
50: if (! &localenroll::run($dom)) { next; }
1.13 ! albertel 51: $env{'user.domain'} = $dom;
1.11 raeburn 52: # Determine the courses
1.12 raeburn 53: my %courses = &Apache::lonnet::courseiddump($dom,'.',1,'.','.',1,\@hostids);
1.11 raeburn 54: my %affiliates = ();
55: my %enrollvar = ();
56: my %reply = ();
57: my %LC_code = ();
58: foreach my $key (sort keys %courses) {
59: my $crs;
60: if ($key =~ m/^($dom)_(\w+)$/) {
61: $crs = $2;
62: }
1.1 raeburn 63:
64: # Get course settings
1.11 raeburn 65: my %settings = &Apache::lonnet::dump('environment',$dom,$crs);
66: %{$enrollvar{$crs}} = ();
67: @{$affiliates{$crs}} = ();
68: %{$LC_code{$crs}} = ();
69: foreach my $item (keys %settings) {
70: if ($item =~ m/^internal\.(.+)$/) {
71: $enrollvar{$crs}{$1} = $settings{$item};
72: } elsif ($item eq 'description') {
73: $enrollvar{$crs}{$item} = &HTML::Entities::decode($settings{$item});
74: } elsif ($item eq 'default_enrollment_start_date') {
75: $enrollvar{$crs}{startdate} = $settings{$item};
76: } elsif ($item eq 'default_enrollment_end_date') {
77: $enrollvar{$crs}{enddate} = $settings{$item};
78: }
1.2 raeburn 79: }
1.11 raeburn 80: if (($enrollvar{$crs}{autostart} <= $timenow) && ( ($enrollvar{$crs}{autoend} > $timenow) || ($enrollvar{$crs}{autoend} == 0) ) ) {
81: if ( ($enrollvar{$crs}{autoadds} == 1) || ($enrollvar{$crs}{autodrops} == 1) ) {
1.1 raeburn 82: # Add to list of classes for retrieval
1.11 raeburn 83: $enrollvar{$crs}{sectionnums} =~ s/ //g;
84: $enrollvar{$crs}{crosslistings} =~ s/ //g;
85: my @sections = ();
86: my @crosslistings = ();
87: if ($enrollvar{$crs}{sectionnums} =~ m/,/) {
88: @sections = split/,/,$enrollvar{$crs}{sectionnums};
89: } else {
90: $sections[0] = $enrollvar{$crs}{sectionnums};
91: }
92: if ($enrollvar{$crs}{crosslistings} =~ m/,/) {
93: @crosslistings = split/,/,$enrollvar{$crs}{crosslistings}
94: } else {
95: @crosslistings = $enrollvar{$crs}{crosslistings};
96: }
97: foreach my $sec (@sections) {
98: if ($sec =~ m/^(\w+):(\w*)$/ ) {
99: my $course_id = $enrollvar{$crs}{coursecode}.$1;
100: my $gp = $2;
101: if (!grep/^$course_id$/,@{$affiliates{$crs}}) {
102: push @{$affiliates{$crs}}, $course_id;
103: $LC_code{$crs}{$course_id} = $gp;
104: }
1.2 raeburn 105: }
106: }
1.11 raeburn 107: foreach my $xlist (@crosslistings) {
108: if ($xlist =~ m/^(\w+):(\w*)$/) {
109: my $course_id = $1;
110: my $gp = $2;
111: if (!grep/^$course_id$/,@{$affiliates{$crs}}) {
112: push @{$affiliates{$crs}}, $course_id;
113: $LC_code{$crs}{$course_id} = $gp;
114: }
1.2 raeburn 115: }
116: }
117: }
118: }
119: }
1.11 raeburn 120: my $outcome = &Apache::lonnet::fetch_enrollment_query('automated',\%affiliates,\%reply,$dom);
1.1 raeburn 121:
122: # Now go through classes and perform required enrollment changes.
1.11 raeburn 123: open (my $fh,">>$logfile");
124: print $fh "********************\n".localtime(time)." Enrollment messages start --\n";
1.12 raeburn 125: print $fh "Response from fetch_enrollment_query was $outcome\n";
1.11 raeburn 126: foreach my $crs (sort keys %enrollvar) {
127: my $logmsg = '';
128: my $newusermsg = '';
129: if ($reply{$crs} > 0) {
130: if ( ($enrollvar{$crs}{autostart} < $timenow) && ( ($enrollvar{$crs}{autoend} > $timenow) || ($enrollvar{$crs}{autoend} == 0) ) ) {
131: if (($enrollvar{$crs}{autoadds} == 1) || ($enrollvar{$crs}{autodrops} == 1)) {
132: my ($changecount,$response) = &LONCAPA::Enrollment::update_LC($dom,$crs,$enrollvar{$crs}{autoadds},$enrollvar{$crs}{autodrops},$enrollvar{$crs}{startdate},$enrollvar{$crs}{enddate},$enrollvar{$crs}{authtype},$enrollvar{$crs}{autharg},\@{$affiliates{$crs}},\%{$LC_code{$crs}},\$logmsg,\$newusermsg,'automated');
133: print $fh "Messages start for $crs\n";
134: print $fh "$logmsg\n";
135: print $fh "Messages end for $crs\n";
136: if ($changecount > 0) {
137: unless ($enrollvar{$crs}{notifylist} eq '') {
1.2 raeburn 138: # Send message about enrollment changes to notifylist.
1.13 ! albertel 139: # Set $env{'user.name'}, $env{'user.home'} for use by logging in lonmsg
1.11 raeburn 140: unless ( ($enrollvar{$crs}{'courseowner'} eq '') || (!defined($enrollvar{$crs}{'courseowner'}) ) ) {
1.13 ! albertel 141: $env{'user.name'} = $enrollvar{$crs}{'courseowner'};
! 142: $env{'user.home'} = &Apache::lonnet::homeserver($env{'user.name'},$dom);
1.11 raeburn 143:
144: my $subject = "Student enrollment changes in $enrollvar{$crs}{coursecode}";
145: my $message = "The following $changecount change(s) occurred in $enrollvar{$crs}{description} - $enrollvar{$crs}{coursecode} as a result of the automated classlist update:\n\n".$response;
146: unless ($newusermsg eq '') {
147: $message .= "\n".$newusermsg;
148: }
149: my @to_notify = ();
150: if ($enrollvar{$crs}{notifylist} =~ m/,/) {
151: @to_notify = split/,/,$enrollvar{$crs}{notifylist};
152: } else {
153: $to_notify[0] = $enrollvar{$crs}{notifylist};
154: }
155: foreach my $cc (@to_notify) {
156: my ($ccname,$ccdom) = split/@/,$cc;
157: my $status = &Apache::lonmsg::user_normal_msg($ccname,$ccdom,$subject,$message);
158: }
159: if ( ($enrollvar{$crs}{notifylist} eq '') && ($newusermsg ne '') ) {
160: my $subject = "New user accounts in $enrollvar{$crs}{'coursecode'}";
1.13 ! albertel 161: my $status = &Apache::lonmsg::user_normal_msg($env{'user.name'},$dom,$subject,$newusermsg);
1.11 raeburn 162: }
1.13 ! albertel 163: delete($env{'user.name'});
! 164: delete($env{'user.home'});
1.2 raeburn 165: }
166: }
167: }
168: }
169: }
1.11 raeburn 170: } else {
171: if ( ($enrollvar{$crs}{autoadds} == 1) || ($enrollvar{$crs}{autodrops} == 1) ) {
172: if ( ($enrollvar{$crs}{autostart} < $timenow) && ( ($enrollvar{$crs}{autoend} > $timenow) || ($enrollvar{$crs}{autoend} == 0) ) ) {
173: print $fh "No institutional classlist data could be retrieved for $crs\n";
174: } else {
175: print $fh "Not within time window for auto-enrollment in $crs\n";
176: }
1.8 raeburn 177: } else {
1.11 raeburn 178: print $fh "Auto-enrollment not currently enabled for $crs\n";
1.8 raeburn 179: }
180: }
1.2 raeburn 181: }
1.11 raeburn 182: print $fh "-- ".localtime(time)." Enrollment messages end\n*******************\n\n";
183: close($fh);
1.13 ! albertel 184: delete($env{'user.domain'});
1.11 raeburn 185: # Check for photos
1.2 raeburn 186: }
1.1 raeburn 187:
188: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>