Return to Autoupdate.pl CVS log

Up to [LON-CAPA] / loncom / enrollment

- Log error if localenroll::allusers_info() returns other than 'ok'.

    1: #!/usr/bin/perl
    2: #
    3: # Automated Userinfo update script
    4: # $Id: Autoupdate.pl,v 1.22 2011/12/18 01:23:21 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:     exit if (ref($perlvarref) ne 'HASH');
   40:     my $logfile = $perlvarref->{'lonDaemons'}.'/logs/autoupdate.log';
   41:     exit if ($perlvarref->{'lonRole'} ne 'library');
   42:     my $hostid = $perlvarref->{'lonHostID'};
   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".&Apache::lonlocal::locallocaltime(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 (%users,%instusers,%instids);
   69:         my $dir = $Apache::lonnet::perlvar{lonUsersDir}.'/'.$dom;
   70:         &descend_tree($dom,$dir,0,\%users,\%courses);
   71:         my $resp = &localenroll::allusers_info($dom,\%instusers,\%instids,\%users);
   72:         if ($resp ne 'ok') {
   73:             print $fh &mt('Problem retrieving institutional data for users in domain: [_1].',$dom)."\n".
   74:                       &mt('Error: [_1].',$resp)."\n".
   75:                       "-- \n".&Apache::lonlocal::locallocaltime(time).' '.
   76:                       &mt('Autoupdate messages end')."\n*******************\n\n";
   77:             next;
   78:         }
   79:         my (%unamechg,%possnames);
   80:         my @types = ('active','future');
   81:         my @roles = ('st');
   82:         my @cdoms = ($dom);
   83:         foreach my $uname (sort(keys(%users))) {
   84:             my %userhash = &Apache::lonnet::userenvironment($dom,$uname,@info);
   85:             my (@inststatuses);
   86:             if (!$userhash{'internalname'}) {
   87:                 if (defined($instusers{$uname})) {
   88:                     (my $insttypechg,@inststatuses) = 
   89:                        &affiliations_check(\%userhash,$instusers{$uname});
   90:                     if ($insttypechg) {
   91:                         my $inststatusstr = join(':',map { &escape($_) } (@inststatuses));
   92:                         my %statushash = ( inststatus => $inststatusstr );
   93:                         my $statusres = &Apache::lonnet::put('environment',\%statushash,$dom,$uname);
   94:                     }
   95:                 }
   96:             }
   97:             if (!$userhash{'lockedname'} && !$userhash{'internalname'}) {
   98:                 if (defined($instusers{$uname})) {
   99:                     my (@fields,%changes,$changed);
  100:                     if (@inststatuses > 0) {
  101:                         foreach my $type (@inststatuses) {
  102:                             if (ref($settings->{fields}{$type}) eq 'ARRAY') {
  103:                                 foreach my $field (@{$settings->{fields}{$type}}) {
  104:                                     if (!grep(/^\Q$field\E$/,@fields)) {
  105:                                         push(@fields,$field);
  106:                                     }
  107:                                 }
  108:                             } 
  109:                         }
  110:                     } else {
  111:                         if (ref($settings->{fields}{'default'}) eq 'ARRAY') {
  112:                             @fields = @{$settings->{fields}{'default'}};
  113:                         }
  114:                     }
  115:                     foreach my $field (@fields) { 
  116:                         if ($userhash{$field} ne $instusers{$uname}{$field}) {
  117:                             $changed = 1;
  118:                             if ($settings->{'classlists'} == 1) { 
  119:                                 if ($field eq 'id') {
  120:                                     $changes{'id'} = 1;
  121:                                 } elsif ($field eq 'lastname' || $field eq 'firstname' || $field eq 'middlename' || $field eq 'generation') {
  122:                                     $changes{'fullname'} = 1;
  123:                                 }
  124:                             }
  125:                         }
  126:                     }
  127:                     # Make the change
  128:                     if ($changed) {
  129:                         my %userupdate;
  130:                         foreach my $item ('lastname','firstname','middlename','generation','id',
  131:                                           'permanentemail') {
  132:                             $userupdate{$item} = $userhash{$item};
  133:                         }
  134:                         foreach my $field (@fields) {
  135:                             $userupdate{$field} = $instusers{$uname}{$field};
  136:                         }
  137:                         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);
  138:                         if ($modresult eq 'ok') {
  139:                             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";
  140:                             if ($settings->{'classlists'} == 1) {
  141:                                 if ($changes{'id'} || $changes{'fullname'}) {
  142:                                     my %roleshash = 
  143:                                         &Apache::lonnet::get_my_roles($uname,
  144:                                                   $dom,'userroles',\@types,\@roles,\@cdoms);
  145:                                     foreach my $item (keys(%roleshash)) {
  146:                                         my ($cnum,$cdom,$role) = split(/:/,$item);
  147:                                         my ($start,$end) = split(/:/,$roleshash{$item});
  148:                                         if (&Apache::lonnet::is_course($cdom,$cnum)) {
  149:                                             my $result = 
  150:                                                 &Apache::lonuserutils::update_classlist($cdom,$cnum,$dom,$uname,\%userupdate);
  151:                                             if ($result eq 'ok') {
  152:                                                 print $fh "Classlist change: $uname:$dom - class -> $cnum:$cdom\n";
  153:                                             } else {
  154:                                                 print $fh "Error - $result -during classlist update for $uname:$dom in $cnum:$cdom\n";
  155:                                             }
  156:                                         }
  157:                                     }
  158:                                 }
  159:                             }
  160:                         } else {
  161:                             print $fh "User change detected for $uname:$dom. Error during update: $modresult\n";
  162:                         }
  163:                     }
  164:                 } else {
  165:                     # check if the username has changed
  166:                     if (defined($instids{$userhash{'id'}})) {
  167:                         if (ref($instids{$userhash{'id'}}) eq 'ARRAY') {
  168:                             foreach my $name (@{$instids{$userhash{'id'}}}) {
  169:                                 if (!exists($users{$name})) {
  170:                                     push(@{$possnames{$uname}},$name);
  171:                                 }
  172:                             }
  173:                         } else {
  174:                             if (!exists($users{$instids{$userhash{'id'}}})) {
  175:                                 $unamechg{$uname} = $instids{$userhash{'id'}};
  176:                                 print $fh (&mt('Username change to [_1] detected for [_2] in domain [_3].',$unamechg{$uname},$uname,$dom)."\n");
  177:                             }
  178:                         }
  179:                     }
  180:                 }
  181:             }
  182:         }
  183:         if (keys(%possnames) > 0) {
  184:             foreach my $uname (keys(%possnames)) {
  185:                 my $altnames = join(' or ',@{$possnames{$uname}});
  186:                 print $fh (&mt('Possible username change to [_1] detected for [_2] in domain [_3].',$altnames,$uname,$dom)."\n");
  187:             }
  188:         }
  189:         print $fh ("-- \n".&Apache::lonlocal::locallocaltime(time).' '.&mt('Autoupdate messages end')."\n*******************\n\n");
  190:         close($fh);
  191:     }
  192: 
  193: sub descend_tree {
  194:     my ($dom,$dir,$depth,$alldomusers,$coursesref) = @_;
  195:     if (-d $dir) {
  196:         opendir(DIR,$dir);
  197:         my @contents = grep(!/^\./,readdir(DIR));
  198:         closedir(DIR);
  199:         $depth ++;
  200:         foreach my $item (@contents) {
  201:             if ($depth < 4) {
  202:                 &descend_tree($dom,$dir.'/'.$item,$depth,$alldomusers,$coursesref);
  203:             } elsif (-e $dir.'/'.$item.'/passwd') {
  204:                 if (ref($coursesref) eq 'HASH') {
  205:                     next if (exists($coursesref->{$dom.'_'.$item}));
  206:                 }
  207:                 $$alldomusers{$item} = '';
  208:             }
  209:         }
  210:     }
  211: }
  212: 
  213: sub affiliations_check {
  214:     my ($userhash,$insthashref) = @_;
  215:     my (@inststatuses,$insttypechg);;
  216:     if (ref($insthashref) eq 'HASH') {
  217:         if (ref($insthashref->{'inststatus'}) eq 'ARRAY') {
  218:             @inststatuses = @{$insthashref->{'inststatus'}};
  219:         }
  220:     }
  221:     my @currstatuses = map { &unescape($_); } (split(/:/,$userhash->{'inststatus'}));
  222:     foreach my $status (@inststatuses) {
  223:         if (!grep/^\Q$status\E/,@currstatuses) {
  224:             $insttypechg = 1;
  225:         }
  226:     }
  227:     if (!$insttypechg) {
  228:         foreach my $status (@currstatuses) {
  229:             if (!grep/^\Q$status\E/,@inststatuses) {
  230:                 $insttypechg = 1;
  231:             }
  232:         }
  233:     }
  234:     return ($insttypechg,@inststatuses);
  235: }
  236: