Annotation of loncom/enrollment/Autoupdate.pl, revision 1.11

1.1       raeburn     1: #!/usr/bin/perl
                      2: #
                      3: # Automated Userinfo update script
1.11    ! raeburn     4: # $Id: Autoupdate.pl,v 1.10 2007/06/05 23:23:01 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;
                     31:     use Apache::lonnet;
                     32:     use Apache::loncommon;
1.4       raeburn    33:     use Apache::lonlocal;
1.11    ! raeburn    34:     use Apache::lonuserutils();
1.5       raeburn    35:     use LONCAPA::Configuration;
1.2       raeburn    36:     use LONCAPA;
1.1       raeburn    37: 
1.5       raeburn    38:     my $perlvarref = LONCAPA::Configuration::read_conf('loncapa.conf');
1.6       raeburn    39:     my $logfile = $$perlvarref{'lonDaemons'}.'/logs/autoupdate.log';
1.10      raeburn    40:     my $hostid = $perlvarref->{'lonHostID'};
                     41:     if (!&Apache::lonnet::is_library($hostid)) {
                     42:         exit;
                     43:     }
1.6       raeburn    44:     my @info = ('inststatus','lockedname','internalname','lastname',
1.9       raeburn    45:                 'firstname','id','permanentemail');
1.6       raeburn    46:     # Initialize language handler
                     47:     &Apache::lonlocal::get_language_handle();
1.1       raeburn    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'};
1.2       raeburn    58:             if ($settings->{'run'} eq '1') {
1.1       raeburn    59:                 $run_update = 1;
                     60:             }
                     61:         }
                     62:         next if (!$run_update);
1.7       albertel   63:         open(my $fh,">>$logfile");
                     64:         print $fh ("********************\n".localtime(time).' '.&mt('Autoupdate messages start for domain: [_1]',$dom).' --'."\n");
1.9       raeburn    65:         # get courseIDs for domain
1.10      raeburn    66:         my %courses=&Apache::lonnet::courseiddump($dom,'.',1,'.','.','.',1,[$hostid],'.');
1.2       raeburn    67:         # get user information
                     68:         my (%instusers,%instids);
                     69:         next if (&localenroll::allusers_info($dom,\%instusers,\%instids) ne 'ok');
                     70:         my (%users,%unamechg,%possnames);
1.1       raeburn    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)) {
1.9       raeburn    77:             next if ($courses{$dom.'_'.$uname});
1.1       raeburn    78:             my %userhash = &Apache::lonnet::userenvironment($dom,$uname,@info);
1.2       raeburn    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:             }
1.1       raeburn    91:             if (!$userhash{'lockedname'} && !$userhash{'internalname'}) {
1.2       raeburn    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'}};
1.1       raeburn   107:                         }
                    108:                     }
                    109:                     foreach my $field (@fields) { 
1.2       raeburn   110:                         if ($userhash{$field} ne $instusers{$uname}{$field}) {
1.1       raeburn   111:                             $changed = 1;
1.9       raeburn   112:                             if ($settings->{'classlists'} == 1) { 
1.1       raeburn   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:                             }
1.9       raeburn   119:                         }
1.1       raeburn   120:                     }
                    121:                     # Make the change
                    122:                     if ($changed) {
                    123:                         my %userupdate;
                    124:                         foreach my $field (@fields) {
1.2       raeburn   125:                             $userupdate{$field} = $instusers{$uname}{$field};
1.1       raeburn   126:                         }
1.9       raeburn   127:                         my $modresult = &Apache::lonnet::modifyuser($dom,$uname,$userupdate{'id'},undef,undef,$userupdate{'firstname'},$userupdate{'middlename'},$userupdate{'lastname'},$userupdate{'generation'},1,$hostid,$userupdate{'permanentemail'});
1.2       raeburn   128:                         if ($modresult eq 'ok') {
1.9       raeburn   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) {
1.1       raeburn   131:                                 if ($changes{'id'} || $changes{'fullname'}) {
                    132:                                     my %roleshash = 
                    133:                                         &Apache::lonnet::get_my_roles($uname,
1.4       raeburn   134:                                                   $dom,'userroles',\@types,\@roles,\@cdoms);
1.10      raeburn   135:                                     foreach my $item (keys(%roleshash)) {
1.1       raeburn   136:                                         my ($cnum,$cdom,$role) = split(/:/,$item);
                    137:                                         my ($start,$end) = split(/:/,$roleshash{$item});
1.9       raeburn   138:                                         if (&Apache::lonnet::is_course($cdom,$cnum)) {
1.11    ! raeburn   139:                                             my $result = 
        !           140:                                                 &Apache::lonuserutils::update_classlist($cdom,$cnum,$dom,$uname,\%userupdate);
1.9       raeburn   141:                                             if ($result eq 'ok') {
                    142:                                                 print $fh "Classlist change: $uname:$dom - class -> $cnum:$cdom\n";
                    143:                                             } else {
                    144:                                                 print $fh "Error - $result -during classlist update for $uname:$dom in $cnum:$cdom\n";
                    145:                                             }
1.1       raeburn   146:                                         }
                    147:                                     }
                    148:                                 }
                    149:                             }
1.9       raeburn   150:                         } else {
                    151:                             print $fh "User change detected for $uname:$dom. Error during update: $modresult\n";
1.1       raeburn   152:                         }
                    153:                     }
1.2       raeburn   154:                 } else {
                    155:                     # check if the username has changed
                    156:                     if (defined($instids{$userhash{'id'}})) {
                    157:                         if (ref($instids{$userhash{'id'}}) eq 'ARRAY') {
                    158:                             foreach my $name (@{$instids{$userhash{'id'}}}) {
                    159:                                 if (!exists($users{$name})) {
                    160:                                     push(@{$possnames{$uname}},$name);
                    161:                                 }
                    162:                             }
                    163:                         } else {
                    164:                             if (!exists($users{$instids{$userhash{'id'}}})) {
                    165:                                 $unamechg{$uname} = $instids{$userhash{'id'}};
1.7       albertel  166:                                 print $fh (&mt('Username change to [_1] detected for [_2] in domain [_3].',$unamechg{$uname},$uname,$dom)."\n");
1.2       raeburn   167:                             }
                    168:                         }
                    169:                     }
1.1       raeburn   170:                 }
                    171:             }
                    172:         }
1.4       raeburn   173:         if (keys(%possnames) > 0) {
                    174:             foreach my $uname (keys(%possnames)) {
                    175:                 my $altnames = join(' or ',@{$possnames{$uname}});
1.7       albertel  176:                 print $fh (&mt('Possible username change to [_1] detected for [_2] in domain [_3].',$altnames,$uname,$dom)."\n");
1.4       raeburn   177:             }
                    178:         }
1.9       raeburn   179:         print $fh ("-- \n".&Apache::lonlocal::locallocaltime(time).' '.&mt('Autoupdate messages end')."\n*******************\n\n");
1.6       raeburn   180:         close($fh);
1.1       raeburn   181:     }
                    182: 
                    183: sub descend_tree {
                    184:     my ($dir,$depth,$alldomusers) = @_;
                    185:     if (-d $dir) {
                    186:         opendir(DIR,$dir);
                    187:         my @contents = grep(!/^\./,readdir(DIR));
                    188:         closedir(DIR);
                    189:         $depth ++;
                    190:         foreach my $item (@contents) {
                    191:             if ($depth < 4) {
                    192:                 &descend_tree($dir.'/'.$item,$depth,$alldomusers);
                    193:             } else {
1.9       raeburn   194:                 $$alldomusers{$item} = '';
1.1       raeburn   195:             }
                    196:         }
                    197:     }
                    198: }
                    199: 
1.2       raeburn   200: sub affiliations_check {
                    201:     my ($userhash,$insthashref) = @_;
                    202:     my (@inststatuses,$insttypechg);;
                    203:     if (ref($insthashref) eq 'HASH') {
1.8       raeburn   204:         if (ref($insthashref->{'inststatus'}) eq 'ARRAY') {
                    205:             @inststatuses = @{$insthashref->{'inststatus'}};
1.2       raeburn   206:         }
                    207:     }
                    208:     my @currstatuses = &unescape(split(/:/,$userhash->{'inststatus'}));
                    209:     foreach my $status (@inststatuses) {
                    210:         if (!grep/^\Q$status\E/,@currstatuses) {
                    211:             $insttypechg = 1;
                    212:         }
                    213:     }
                    214:     if (!$insttypechg) {
                    215:         foreach my $status (@currstatuses) {
                    216:             if (!grep/^\Q$status\E/,@inststatuses) {
                    217:                 $insttypechg = 1;
                    218:             }
                    219:         }
                    220:     }
                    221:     return ($insttypechg,@inststatuses);
                    222: }
                    223: 

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>