Return to Autoupdate.pl CVS log

Up to [LON-CAPA] / loncom / enrollment

- Include permanentemail in fields to retrieve from user's environment.db
- Get all courseIDs for domain - exclude these from users to check
- classlists toggle in domain configuration is 1 or 0 (not yes/no)
- is_course() was moved from loncommon to lonnet
- include permenentemail in fields sent to modifyuser
- write outcomes to log file

    1: #!/usr/bin/perl
    2: #
    3: # Automated Userinfo update script
    4: # $Id: Autoupdate.pl,v 1.9 2007/06/04 14:13:08 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 LONCAPA::Configuration;
   35:     use LONCAPA;
   36: 
   37:     my $perlvarref = LONCAPA::Configuration::read_conf('loncapa.conf');
   38:     my $logfile = $$perlvarref{'lonDaemons'}.'/logs/autoupdate.log';
   39:     my $hostid = $perlvarref->{'lonHostID'}; 
   40:     my @info = ('inststatus','lockedname','internalname','lastname',
   41:                 'firstname','id','permanentemail');
   42:     # Initialize language handler
   43:     &Apache::lonlocal::get_language_handle();
   44:     # find out which users we need to examine
   45:     my @domains = sort(&Apache::lonnet::current_machine_domains());
   46:     foreach my $dom (@domains) {
   47:         my $primaryhost_id = &Apache::lonnet::domain($dom,'primary');
   48:         if ($primaryhost_id ne $hostid) {
   49:             next;
   50:         } 
   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,'.','.','',undef,undef,'.');
   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(':',&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 'gen') {
  116:                                     $changes{'fullname'} = 1;
  117:                                 }
  118:                             }
  119:                         }
  120:                     }
  121:                     # Make the change
  122:                     if ($changed) {
  123:                         my %userupdate;
  124:                         foreach my $field (@fields) {
  125:                             $userupdate{$field} = $instusers{$uname}{$field};
  126:                         }
  127:                         my $modresult = &Apache::lonnet::modifyuser($dom,$uname,$userupdate{'id'},undef,undef,$userupdate{'firstname'},$userupdate{'middlename'},$userupdate{'lastname'},$userupdate{'generation'},1,$hostid,$userupdate{'permanentemail'});
  128:                         if ($modresult eq 'ok') {
  129:                             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";
  130:                             if ($settings->{'classlists'} == 1) {
  131:                                 if ($changes{'id'} || $changes{'fullname'}) {
  132:                                     my %roleshash = 
  133:                                         &Apache::lonnet::get_my_roles($uname,
  134:                                                   $dom,'userroles',\@types,\@roles,\@cdoms);
  135:                                     foreach my $item (%roleshash) {
  136:                                         my ($cnum,$cdom,$role) = split(/:/,$item);
  137:                                         my ($start,$end) = split(/:/,$roleshash{$item});
  138:                                         if (&Apache::lonnet::is_course($cdom,$cnum)) {
  139:                                             my $result = &update_classlist($cdom,$cnum,$dom,$uname,\%userupdate);
  140:                                             if ($result eq 'ok') {
  141:                                                 print $fh "Classlist change: $uname:$dom - class -> $cnum:$cdom\n";
  142:                                             } else {
  143:                                                 print $fh "Error - $result -during classlist update for $uname:$dom in $cnum:$cdom\n";
  144:                                             }
  145:                                         }
  146:                                     }
  147:                                 }
  148:                             }
  149:                         } else {
  150:                             print $fh "User change detected for $uname:$dom. Error during update: $modresult\n";
  151:                         }
  152:                     }
  153:                 } else {
  154:                     # check if the username has changed
  155:                     if (defined($instids{$userhash{'id'}})) {
  156:                         if (ref($instids{$userhash{'id'}}) eq 'ARRAY') {
  157:                             foreach my $name (@{$instids{$userhash{'id'}}}) {
  158:                                 if (!exists($users{$name})) {
  159:                                     push(@{$possnames{$uname}},$name);
  160:                                 }
  161:                             }
  162:                         } else {
  163:                             if (!exists($users{$instids{$userhash{'id'}}})) {
  164:                                 $unamechg{$uname} = $instids{$userhash{'id'}};
  165:                                 print $fh (&mt('Username change to [_1] detected for [_2] in domain [_3].',$unamechg{$uname},$uname,$dom)."\n");
  166:                             }
  167:                         }
  168:                     }
  169:                 }
  170:             }
  171:         }
  172:         if (keys(%possnames) > 0) {
  173:             foreach my $uname (keys(%possnames)) {
  174:                 my $altnames = join(' or ',@{$possnames{$uname}});
  175:                 print $fh (&mt('Possible username change to [_1] detected for [_2] in domain [_3].',$altnames,$uname,$dom)."\n");
  176:             }
  177:         }
  178:         print $fh ("-- \n".&Apache::lonlocal::locallocaltime(time).' '.&mt('Autoupdate messages end')."\n*******************\n\n");
  179:         close($fh);
  180:     }
  181: 
  182: sub descend_tree {
  183:     my ($dir,$depth,$alldomusers) = @_;
  184:     if (-d $dir) {
  185:         opendir(DIR,$dir);
  186:         my @contents = grep(!/^\./,readdir(DIR));
  187:         closedir(DIR);
  188:         $depth ++;
  189:         foreach my $item (@contents) {
  190:             if ($depth < 4) {
  191:                 &descend_tree($dir.'/'.$item,$depth,$alldomusers);
  192:             } else {
  193:                 $$alldomusers{$item} = '';
  194:             }
  195:         }
  196:     }
  197: }
  198: 
  199: sub update_classlist {
  200:     my ($cdom,$cnum,$udom,$uname,$user) = @_;
  201:     my ($uid,$fullname,$classlistentry);
  202:     my $fullname = 
  203:         &Apache::lonnet::format_name($user->{'first'},$user->{'middle'},
  204:                                      $user->{'last'},$user->{'gene'},'lastname');
  205:     my %classhash = &Apache::lonnet::get('classlist',[$uname.':'.$udom],
  206:                                          $cdom,$cnum);
  207:     my @classinfo = split(/:/,$classhash{$uname.':'.$udom});
  208:     my $ididx=&Apache::loncoursedata::CL_ID() - 2;
  209:     my $nameidx=&Apache::loncoursedata::CL_FULLNAME() - 2;
  210:     for (my $i=0; $i<@classinfo; $i++) {
  211:         if ($i == $ididx) {
  212:             if (defined($user->{'id'})) {
  213:                 $classlistentry .= $user->{'id'}.':';
  214:             } else {
  215:                 $classlistentry .= $classinfo[$i].':';
  216:             }
  217:         } elsif ($i == $nameidx) {
  218:             $classlistentry .= $fullname.':';
  219:         } else {
  220:             $classlistentry .= $classinfo[$i].':';
  221:         }
  222:     }
  223:     $classlistentry =~ s/:$//;
  224:     my $reply=&Apache::lonnet::cput('classlist',
  225:                                     {"$uname:$udom" => $classlistentry},
  226:                                     $cdom,$cnum);
  227:     if (($reply eq 'ok') || ($reply eq 'delayed')) {
  228:         return 'ok';
  229:     } else { 
  230:         return 'error: '.$reply;
  231:     }
  232: }
  233: 
  234: sub affiliations_check {
  235:     my ($userhash,$insthashref) = @_;
  236:     my (@inststatuses,$insttypechg);;
  237:     if (ref($insthashref) eq 'HASH') {
  238:         if (ref($insthashref->{'inststatus'}) eq 'ARRAY') {
  239:             @inststatuses = @{$insthashref->{'inststatus'}};
  240:         }
  241:     }
  242:     my @currstatuses = &unescape(split(/:/,$userhash->{'inststatus'}));
  243:     foreach my $status (@inststatuses) {
  244:         if (!grep/^\Q$status\E/,@currstatuses) {
  245:             $insttypechg = 1;
  246:         }
  247:     }
  248:     if (!$insttypechg) {
  249:         foreach my $status (@currstatuses) {
  250:             if (!grep/^\Q$status\E/,@inststatuses) {
  251:                 $insttypechg = 1;
  252:             }
  253:         }
  254:     }
  255:     return ($insttypechg,@inststatuses);
  256: }
  257: