Annotation of loncom/enrollment/Autoupdate.pl, revision 1.28
1.1 raeburn 1: #!/usr/bin/perl
2: #
3: # Automated Userinfo update script
1.28 ! raeburn 4: # $Id: Autoupdate.pl,v 1.27 2023/12/06 23:46:16 raeburn Exp $
1.1 raeburn 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;
1.24 raeburn 31: use GDBM_File;
1.1 raeburn 32: use Apache::lonnet;
33: use Apache::loncommon;
1.4 raeburn 34: use Apache::lonlocal;
1.11 raeburn 35: use Apache::lonuserutils();
1.5 raeburn 36: use LONCAPA::Configuration;
1.2 raeburn 37: use LONCAPA;
1.1 raeburn 38:
1.5 raeburn 39: my $perlvarref = LONCAPA::Configuration::read_conf('loncapa.conf');
1.19 raeburn 40: exit if (ref($perlvarref) ne 'HASH');
41: my $logfile = $perlvarref->{'lonDaemons'}.'/logs/autoupdate.log';
42: exit if ($perlvarref->{'lonRole'} ne 'library');
1.10 raeburn 43: my $hostid = $perlvarref->{'lonHostID'};
1.19 raeburn 44:
1.6 raeburn 45: my @info = ('inststatus','lockedname','internalname','lastname',
1.14 raeburn 46: 'firstname','middlename','generation','id','permanentemail');
1.6 raeburn 47: # Initialize language handler
48: &Apache::lonlocal::get_language_handle();
1.1 raeburn 49: # find out which users we need to examine
50: my @domains = sort(&Apache::lonnet::current_machine_domains());
51: foreach my $dom (@domains) {
1.27 raeburn 52: my %domconfig = &Apache::lonnet::get_dom('configuration',['autoupdate','usercreation'],
1.1 raeburn 53: $dom);
54: #only run if configured to
55: my $run_update = 0;
56: my $settings;
1.24 raeburn 57: my $allowed_inactivity;
58: my $check_unexpired;
1.1 raeburn 59: if (ref($domconfig{'autoupdate'}) eq 'HASH') {
60: $settings = $domconfig{'autoupdate'};
1.2 raeburn 61: if ($settings->{'run'} eq '1') {
1.1 raeburn 62: $run_update = 1;
63: }
1.24 raeburn 64: if ($settings->{'lastactive'} =~/^\d+$/) {
65: $allowed_inactivity = 86400 * $settings->{'lastactive'};
66: }
67: if ($settings->{'unexpired'}) {
68: $check_unexpired = 1;
69: }
1.1 raeburn 70: }
71: next if (!$run_update);
1.7 albertel 72: open(my $fh,">>$logfile");
1.17 raeburn 73: print $fh ("********************\n".&Apache::lonlocal::locallocaltime(time).' '.&mt('Autoupdate messages start for domain: [_1]',$dom).' --'."\n");
1.9 raeburn 74: # get courseIDs for domain
1.10 raeburn 75: my %courses=&Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',1,[$hostid],'.');
1.2 raeburn 76: # get user information
1.27 raeburn 77: my (%users,%instusers,%instids,%counts,@idrules);
1.20 raeburn 78: my $dir = $Apache::lonnet::perlvar{lonUsersDir}.'/'.$dom;
1.24 raeburn 79: &descend_tree($dom,$dir,0,\%users,\%courses,$allowed_inactivity,$check_unexpired);
1.25 raeburn 80: my $resp = &localenroll::allusers_info($dom,\%instusers,\%instids,\%users,\%counts);
1.22 raeburn 81: if ($resp ne 'ok') {
82: print $fh &mt('Problem retrieving institutional data for users in domain: [_1].',$dom)."\n".
83: &mt('Error: [_1].',$resp)."\n".
84: "-- \n".&Apache::lonlocal::locallocaltime(time).' '.
85: &mt('Autoupdate messages end')."\n*******************\n\n";
1.25 raeburn 86: close($fh);
1.22 raeburn 87: next;
1.25 raeburn 88: } else {
89: if (keys(%counts)) {
90: foreach my $key (sort(keys(%counts))) {
91: if ($counts{$key} ne '') {
92: print $fh "Count for $key = $counts{$key}\n";
93: }
94: }
95: }
1.22 raeburn 96: }
1.20 raeburn 97: my (%unamechg,%possnames);
1.1 raeburn 98: my @types = ('active','future');
99: my @roles = ('st');
100: my @cdoms = ($dom);
1.27 raeburn 101: if (ref($domconfig{'usercreation'}) eq 'HASH') {
102: if (ref($domconfig{'usercreation'}{'id_rule'}) eq 'ARRAY') {
103: @idrules = @{$domconfig{'usercreation'}{'id_rule'}};
104: }
105: }
1.18 raeburn 106: foreach my $uname (sort(keys(%users))) {
1.1 raeburn 107: my %userhash = &Apache::lonnet::userenvironment($dom,$uname,@info);
1.2 raeburn 108: my (@inststatuses);
109: if (!$userhash{'internalname'}) {
110: if (defined($instusers{$uname})) {
1.26 raeburn 111: (my $insttypechg,@inststatuses) =
1.2 raeburn 112: &affiliations_check(\%userhash,$instusers{$uname});
113: if ($insttypechg) {
1.13 raeburn 114: my $inststatusstr = join(':',map { &escape($_) } (@inststatuses));
1.2 raeburn 115: my %statushash = ( inststatus => $inststatusstr );
116: my $statusres = &Apache::lonnet::put('environment',\%statushash,$dom,$uname);
117: }
118: }
119: }
1.1 raeburn 120: if (!$userhash{'lockedname'} && !$userhash{'internalname'}) {
1.2 raeburn 121: if (defined($instusers{$uname})) {
122: my (@fields,%changes,$changed);
123: if (@inststatuses > 0) {
124: foreach my $type (@inststatuses) {
125: if (ref($settings->{fields}{$type}) eq 'ARRAY') {
126: foreach my $field (@{$settings->{fields}{$type}}) {
127: if (!grep(/^\Q$field\E$/,@fields)) {
128: push(@fields,$field);
129: }
130: }
1.26 raeburn 131: }
1.2 raeburn 132: }
133: } else {
134: if (ref($settings->{fields}{'default'}) eq 'ARRAY') {
135: @fields = @{$settings->{fields}{'default'}};
1.1 raeburn 136: }
137: }
1.26 raeburn 138: foreach my $field (@fields) {
1.2 raeburn 139: if ($userhash{$field} ne $instusers{$uname}{$field}) {
1.27 raeburn 140: # Do not change student/employee ID when field is modifiable
141: # but institutional data is absent or does not match rules
142: # defined for IDs for institutional users in domain
143: if ($field eq 'id') {
144: if ($instusers{$uname}{$field} eq '') {
145: $instusers{$uname}{$field} = $userhash{$field};
146: next;
147: } elsif (@idrules > 0) {
148: my %idchecks;
1.28 ! raeburn 149: if (&localenroll::id_check($dom,$instusers{$uname}{$field},
! 150: \@idrules,\%idchecks) eq 'ok') {
1.27 raeburn 151: my $matches;
152: foreach my $result (values(%idchecks)) {
153: if ($result) {
154: $matches = 1;
155: last;
156: }
157: }
158: if ($matches) {
159: $changed = 1;
160: } else {
161: $instusers{$uname}{$field} = $userhash{$field};
162: next;
163: }
164: }
165: }
166: } else {
167: $changed = 1;
168: }
169: if ($field eq 'id') {
170: $changes{'id'} = 1;
171: } elsif ($field eq 'lastname' || $field eq 'firstname' || $field eq 'middlename' || $field eq 'generation') {
172: $changes{'fullname'} = 1;
173: }
174: }
175: }
176: # Do not change name information when lastname and firstname are modifiable
177: # but institutional data is absent for both components of a user's name.
178: if ($changed) {
179: if ($changes{'fullname'}) {
180: my %modifiable;
181: map { $modifiable{$_} = 1; } @fields;
182: if (($modifiable{'lastname'}) && ($modifiable{'firstname'}) &&
183: ($instusers{$uname}{'lastname'} eq '') && ($instusers{$uname}{'firstname'} eq '')) {
184: if ($changes{'fullname'}) {
185: undef($changes{'fullname'});
186: }
187: if ($changes{'id'}) {
188: foreach my $field ('lastname','firstname','middlename','generation') {
189: $instusers{$uname}{$field} = $userhash{$field};
190: }
191: } else {
192: undef($changed);
1.1 raeburn 193: }
194: }
1.9 raeburn 195: }
1.1 raeburn 196: }
197: # Make the change
198: if ($changed) {
199: my %userupdate;
1.14 raeburn 200: foreach my $item ('lastname','firstname','middlename','generation','id',
201: 'permanentemail') {
202: $userupdate{$item} = $userhash{$item};
203: }
1.1 raeburn 204: foreach my $field (@fields) {
1.2 raeburn 205: $userupdate{$field} = $instusers{$uname}{$field};
1.1 raeburn 206: }
1.16 raeburn 207: 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);
1.2 raeburn 208: if ($modresult eq 'ok') {
1.9 raeburn 209: 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";
210: if ($settings->{'classlists'} == 1) {
1.1 raeburn 211: if ($changes{'id'} || $changes{'fullname'}) {
1.26 raeburn 212: my %roleshash =
1.1 raeburn 213: &Apache::lonnet::get_my_roles($uname,
1.4 raeburn 214: $dom,'userroles',\@types,\@roles,\@cdoms);
1.10 raeburn 215: foreach my $item (keys(%roleshash)) {
1.1 raeburn 216: my ($cnum,$cdom,$role) = split(/:/,$item);
217: my ($start,$end) = split(/:/,$roleshash{$item});
1.9 raeburn 218: if (&Apache::lonnet::is_course($cdom,$cnum)) {
1.26 raeburn 219: my $result =
1.11 raeburn 220: &Apache::lonuserutils::update_classlist($cdom,$cnum,$dom,$uname,\%userupdate);
1.9 raeburn 221: if ($result eq 'ok') {
222: print $fh "Classlist change: $uname:$dom - class -> $cnum:$cdom\n";
223: } else {
224: print $fh "Error - $result -during classlist update for $uname:$dom in $cnum:$cdom\n";
225: }
1.1 raeburn 226: }
227: }
228: }
229: }
1.9 raeburn 230: } else {
231: print $fh "User change detected for $uname:$dom. Error during update: $modresult\n";
1.1 raeburn 232: }
233: }
1.2 raeburn 234: } else {
235: # check if the username has changed
236: if (defined($instids{$userhash{'id'}})) {
237: if (ref($instids{$userhash{'id'}}) eq 'ARRAY') {
238: foreach my $name (@{$instids{$userhash{'id'}}}) {
239: if (!exists($users{$name})) {
240: push(@{$possnames{$uname}},$name);
241: }
242: }
243: } else {
244: if (!exists($users{$instids{$userhash{'id'}}})) {
245: $unamechg{$uname} = $instids{$userhash{'id'}};
1.7 albertel 246: print $fh (&mt('Username change to [_1] detected for [_2] in domain [_3].',$unamechg{$uname},$uname,$dom)."\n");
1.2 raeburn 247: }
248: }
249: }
1.1 raeburn 250: }
251: }
252: }
1.4 raeburn 253: if (keys(%possnames) > 0) {
254: foreach my $uname (keys(%possnames)) {
255: my $altnames = join(' or ',@{$possnames{$uname}});
1.7 albertel 256: print $fh (&mt('Possible username change to [_1] detected for [_2] in domain [_3].',$altnames,$uname,$dom)."\n");
1.4 raeburn 257: }
258: }
1.9 raeburn 259: print $fh ("-- \n".&Apache::lonlocal::locallocaltime(time).' '.&mt('Autoupdate messages end')."\n*******************\n\n");
1.6 raeburn 260: close($fh);
1.1 raeburn 261: }
262:
263: sub descend_tree {
1.24 raeburn 264: my ($dom,$dir,$depth,$alldomusers,$coursesref,$allowed_inactivity,$check_unexpired) = @_;
1.1 raeburn 265: if (-d $dir) {
266: opendir(DIR,$dir);
267: my @contents = grep(!/^\./,readdir(DIR));
268: closedir(DIR);
269: $depth ++;
270: foreach my $item (@contents) {
1.23 raeburn 271: if (($depth < 4) && (length($item) == 1)) {
1.24 raeburn 272: &descend_tree($dom,$dir.'/'.$item,$depth,$alldomusers,$coursesref,
273: $allowed_inactivity,$check_unexpired);
1.19 raeburn 274: } elsif (-e $dir.'/'.$item.'/passwd') {
1.20 raeburn 275: if (ref($coursesref) eq 'HASH') {
1.21 raeburn 276: next if (exists($coursesref->{$dom.'_'.$item}));
1.20 raeburn 277: }
1.24 raeburn 278: if ($allowed_inactivity) {
279: my $now = time;
280: my $aclog = $dir.'/'.$item.'/activity.log';
281: my $roledb = $dir.'/'.$item.'/roles.db';
282: if (-e $aclog) {
283: my $lastac=(stat($aclog))[9];
284: if (($now - $lastac) > $allowed_inactivity) {
285: if (-e $roledb) {
286: my $lastrolechg=(stat($roledb))[9];
287: next if (($now - $lastrolechg) > $allowed_inactivity);
288: } else {
289: next;
290: }
291: }
292: } elsif (-e $roledb) {
293: my $lastrolechg=(stat($roledb))[9];
294: next if (($now - $lastrolechg) > $allowed_inactivity);
295: } else {
296: next;
297: }
298: }
299: if ($check_unexpired) {
300: my $roledb = $dir.'/'.$item.'/roles.db';
301: my $unexpired = 0;
302: my $now = time;
303: if (-e $roledb) {
304: my $roleshash = &LONCAPA::tie_user_hash($dom,$item,'roles',&GDBM_READER()) or next;
305: if (ref($roleshash)) {
306: while (my ($key,$value) = each(%$roleshash)) {
307: next if ($key =~ /^rolesdef/);
308: my ($role,$roleend,$rolestart) = split(/\_/,$value);
309: next if ($role =~ /^gr\//);
310: if (!$roleend || $roleend > $now) {
311: $unexpired = 1;
312: last;
313: }
314: }
315: &LONCAPA::untie_user_hash($roleshash);
316: next unless ($unexpired);
317: } else {
318: next;
319: }
320: } else {
321: next;
322: }
323: }
1.9 raeburn 324: $$alldomusers{$item} = '';
1.1 raeburn 325: }
326: }
327: }
328: }
329:
1.2 raeburn 330: sub affiliations_check {
331: my ($userhash,$insthashref) = @_;
332: my (@inststatuses,$insttypechg);;
333: if (ref($insthashref) eq 'HASH') {
1.8 raeburn 334: if (ref($insthashref->{'inststatus'}) eq 'ARRAY') {
335: @inststatuses = @{$insthashref->{'inststatus'}};
1.2 raeburn 336: }
337: }
1.12 raeburn 338: my @currstatuses = map { &unescape($_); } (split(/:/,$userhash->{'inststatus'}));
1.2 raeburn 339: foreach my $status (@inststatuses) {
340: if (!grep/^\Q$status\E/,@currstatuses) {
341: $insttypechg = 1;
342: }
343: }
344: if (!$insttypechg) {
345: foreach my $status (@currstatuses) {
346: if (!grep/^\Q$status\E/,@inststatuses) {
347: $insttypechg = 1;
348: }
349: }
350: }
351: return ($insttypechg,@inststatuses);
352: }
353:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to Autoupdate.pl CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / enrollment