File:
[LON-CAPA] /
loncom /
enrollment /
Autoupdate.pl
Revision
1.16:
download - view:
text,
annotated -
select for diffs
Sun Mar 21 21:06:00 2010 UTC (14 years, 5 months ago) by
raeburn
Branches:
MAIN
CVS tags:
HEAD
- Bug 5805.
- Allow existing non-empty entries for user information (lastname, middlename, firstname, generation, id and permanentemail) to be overwritten with empty entries, if field is included in $candelete array ref (new arg for lonnet::modifyuser().
- Overwriting with empty entries allowed when:
(a) Updating user information for a single user from "Modify User" (domain, author or course context) - subject to domain config for user modification.
(b) Autoupdate.pl updates from institutional directory data,
subject to domain config for Autoupdate.
1: #!/usr/bin/perl
2: #
3: # Automated Userinfo update script
4: # $Id: Autoupdate.pl,v 1.16 2010/03/21 21:06:00 raeburn Exp $
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: #
28: use strict;
29: use lib '/home/httpd/lib/perl';
30: use localenroll;
31: use Apache::lonnet;
32: use Apache::loncommon;
33: use Apache::lonlocal;
34: use Apache::lonuserutils();
35: use LONCAPA::Configuration;
36: use LONCAPA;
37:
38: my $perlvarref = LONCAPA::Configuration::read_conf('loncapa.conf');
39: my $logfile = $$perlvarref{'lonDaemons'}.'/logs/autoupdate.log';
40: my $hostid = $perlvarref->{'lonHostID'};
41: if (!&Apache::lonnet::is_library($hostid)) {
42: exit;
43: }
44: my @info = ('inststatus','lockedname','internalname','lastname',
45: 'firstname','middlename','generation','id','permanentemail');
46: # Initialize language handler
47: &Apache::lonlocal::get_language_handle();
48: # find out which users we need to examine
49: my @domains = sort(&Apache::lonnet::current_machine_domains());
50: foreach my $dom (@domains) {
51: my %domconfig = &Apache::lonnet::get_dom('configuration',['autoupdate'],
52: $dom);
53: #only run if configured to
54: my $run_update = 0;
55: my $settings;
56: if (ref($domconfig{'autoupdate'}) eq 'HASH') {
57: $settings = $domconfig{'autoupdate'};
58: if ($settings->{'run'} eq '1') {
59: $run_update = 1;
60: }
61: }
62: next if (!$run_update);
63: open(my $fh,">>$logfile");
64: print $fh ("********************\n".localtime(time).' '.&mt('Autoupdate messages start for domain: [_1]',$dom).' --'."\n");
65: # get courseIDs for domain
66: my %courses=&Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',1,[$hostid],'.');
67: # get user information
68: my (%instusers,%instids);
69: next if (&localenroll::allusers_info($dom,\%instusers,\%instids) ne 'ok');
70: my (%users,%unamechg,%possnames);
71: my @types = ('active','future');
72: my @roles = ('st');
73: my @cdoms = ($dom);
74: my $dir = $Apache::lonnet::perlvar{lonUsersDir}.'/'.$dom;
75: &descend_tree($dir,0,\%users);
76: foreach my $uname (keys(%users)) {
77: next if ($courses{$dom.'_'.$uname});
78: my %userhash = &Apache::lonnet::userenvironment($dom,$uname,@info);
79: my (@inststatuses);
80: if (!$userhash{'internalname'}) {
81: if (defined($instusers{$uname})) {
82: (my $insttypechg,@inststatuses) =
83: &affiliations_check(\%userhash,$instusers{$uname});
84: if ($insttypechg) {
85: my $inststatusstr = join(':',map { &escape($_) } (@inststatuses));
86: my %statushash = ( inststatus => $inststatusstr );
87: my $statusres = &Apache::lonnet::put('environment',\%statushash,$dom,$uname);
88: }
89: }
90: }
91: if (!$userhash{'lockedname'} && !$userhash{'internalname'}) {
92: if (defined($instusers{$uname})) {
93: my (@fields,%changes,$changed);
94: if (@inststatuses > 0) {
95: foreach my $type (@inststatuses) {
96: if (ref($settings->{fields}{$type}) eq 'ARRAY') {
97: foreach my $field (@{$settings->{fields}{$type}}) {
98: if (!grep(/^\Q$field\E$/,@fields)) {
99: push(@fields,$field);
100: }
101: }
102: }
103: }
104: } else {
105: if (ref($settings->{fields}{'default'}) eq 'ARRAY') {
106: @fields = @{$settings->{fields}{'default'}};
107: }
108: }
109: foreach my $field (@fields) {
110: if ($userhash{$field} ne $instusers{$uname}{$field}) {
111: $changed = 1;
112: if ($settings->{'classlists'} == 1) {
113: if ($field eq 'id') {
114: $changes{'id'} = 1;
115: } elsif ($field eq 'lastname' || $field eq 'firstname' || $field eq 'middlename' || $field eq 'generation') {
116: $changes{'fullname'} = 1;
117: }
118: }
119: }
120: }
121: # Make the change
122: if ($changed) {
123: my %userupdate;
124: foreach my $item ('lastname','firstname','middlename','generation','id',
125: 'permanentemail') {
126: $userupdate{$item} = $userhash{$item};
127: }
128: foreach my $field (@fields) {
129: $userupdate{$field} = $instusers{$uname}{$field};
130: }
131: my $modresult = &Apache::lonnet::modifyuser($dom,$uname,$userupdate{'id'},undef,undef,$userupdate{'firstname'},$userupdate{'middlename'},$userupdate{'lastname'},$userupdate{'generation'},1,$hostid,$userupdate{'permanentemail'},undef,\@fields);
132: if ($modresult eq 'ok') {
133: print $fh "User change: $uname:$dom; New values: 1.Name: $userupdate{'firstname'} $userupdate{'middlename'} $userupdate{'lastname'} $userupdate{'generation'}; 2. StuID: $userupdate{'id'}; 3. Email: $userupdate{'permanentemail'}.\n";
134: if ($settings->{'classlists'} == 1) {
135: if ($changes{'id'} || $changes{'fullname'}) {
136: my %roleshash =
137: &Apache::lonnet::get_my_roles($uname,
138: $dom,'userroles',\@types,\@roles,\@cdoms);
139: foreach my $item (keys(%roleshash)) {
140: my ($cnum,$cdom,$role) = split(/:/,$item);
141: my ($start,$end) = split(/:/,$roleshash{$item});
142: if (&Apache::lonnet::is_course($cdom,$cnum)) {
143: my $result =
144: &Apache::lonuserutils::update_classlist($cdom,$cnum,$dom,$uname,\%userupdate);
145: if ($result eq 'ok') {
146: print $fh "Classlist change: $uname:$dom - class -> $cnum:$cdom\n";
147: } else {
148: print $fh "Error - $result -during classlist update for $uname:$dom in $cnum:$cdom\n";
149: }
150: }
151: }
152: }
153: }
154: } else {
155: print $fh "User change detected for $uname:$dom. Error during update: $modresult\n";
156: }
157: }
158: } else {
159: # check if the username has changed
160: if (defined($instids{$userhash{'id'}})) {
161: if (ref($instids{$userhash{'id'}}) eq 'ARRAY') {
162: foreach my $name (@{$instids{$userhash{'id'}}}) {
163: if (!exists($users{$name})) {
164: push(@{$possnames{$uname}},$name);
165: }
166: }
167: } else {
168: if (!exists($users{$instids{$userhash{'id'}}})) {
169: $unamechg{$uname} = $instids{$userhash{'id'}};
170: print $fh (&mt('Username change to [_1] detected for [_2] in domain [_3].',$unamechg{$uname},$uname,$dom)."\n");
171: }
172: }
173: }
174: }
175: }
176: }
177: if (keys(%possnames) > 0) {
178: foreach my $uname (keys(%possnames)) {
179: my $altnames = join(' or ',@{$possnames{$uname}});
180: print $fh (&mt('Possible username change to [_1] detected for [_2] in domain [_3].',$altnames,$uname,$dom)."\n");
181: }
182: }
183: print $fh ("-- \n".&Apache::lonlocal::locallocaltime(time).' '.&mt('Autoupdate messages end')."\n*******************\n\n");
184: close($fh);
185: }
186:
187: sub descend_tree {
188: my ($dir,$depth,$alldomusers) = @_;
189: if (-d $dir) {
190: opendir(DIR,$dir);
191: my @contents = grep(!/^\./,readdir(DIR));
192: closedir(DIR);
193: $depth ++;
194: foreach my $item (@contents) {
195: if ($depth < 4) {
196: &descend_tree($dir.'/'.$item,$depth,$alldomusers);
197: } else {
198: $$alldomusers{$item} = '';
199: }
200: }
201: }
202: }
203:
204: sub affiliations_check {
205: my ($userhash,$insthashref) = @_;
206: my (@inststatuses,$insttypechg);;
207: if (ref($insthashref) eq 'HASH') {
208: if (ref($insthashref->{'inststatus'}) eq 'ARRAY') {
209: @inststatuses = @{$insthashref->{'inststatus'}};
210: }
211: }
212: my @currstatuses = map { &unescape($_); } (split(/:/,$userhash->{'inststatus'}));
213: foreach my $status (@inststatuses) {
214: if (!grep/^\Q$status\E/,@currstatuses) {
215: $insttypechg = 1;
216: }
217: }
218: if (!$insttypechg) {
219: foreach my $status (@currstatuses) {
220: if (!grep/^\Q$status\E/,@inststatuses) {
221: $insttypechg = 1;
222: }
223: }
224: }
225: return ($insttypechg,@inststatuses);
226: }
227:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>