File:  [LON-CAPA] / loncom / lonsql
Revision 1.98: download - view: text, annotated - select for diffs
Wed Apr 24 01:44:38 2019 UTC (4 years, 11 months ago) by raeburn
Branches: MAIN
CVS tags: version_2_12_X, version_2_11_X, version_2_11_4_uiuc, version_2_11_4_msu, version_2_11_4, version_2_11_3_uiuc, version_2_11_3_msu, version_2_11_3, HEAD
- Forgot Password utility
  - Support configurable: link lifetime, case sensitivity (for username and
    e-mail address), information required, e-mail types, and custom text.
  - Bug 6648: captcha can be enabled for public-facing web form.

    1: #!/usr/bin/perl
    2: 
    3: # The LearningOnline Network
    4: # lonsql - LON TCP-MySQL-Server Daemon for handling database requests.
    5: #
    6: # $Id: lonsql,v 1.98 2019/04/24 01:44:38 raeburn Exp $
    7: #
    8: # Copyright Michigan State University Board of Trustees
    9: #
   10: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
   11: #
   12: # LON-CAPA is free software; you can redistribute it and/or modify
   13: # it under the terms of the GNU General Public License as published by
   14: # the Free Software Foundation; either version 2 of the License, or
   15: # (at your option) any later version.
   16: #
   17: # LON-CAPA is distributed in the hope that it will be useful,
   18: # but WITHOUT ANY WARRANTY; without even the implied warranty of
   19: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   20: # GNU General Public License for more details.
   21: #
   22: # You should have received a copy of the GNU General Public License
   23: # along with LON-CAPA; if not, write to the Free Software
   24: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   25: #
   26: # /home/httpd/html/adm/gpl.txt
   27: #
   28: # http://www.lon-capa.org/
   29: #
   30: 
   31: =pod
   32: 
   33: =head1 NAME
   34: 
   35: lonsql - LON TCP-MySQL-Server Daemon for handling database requests.
   36: 
   37: =head1 SYNOPSIS
   38: 
   39: This script should be run as user=www.  
   40: Note that a lonsql.pid file contains the pid of the parent process.
   41: 
   42: =head1 OVERVIEW
   43: 
   44: =head2 Purpose within LON-CAPA
   45: 
   46: LON-CAPA is meant to distribute A LOT of educational content to A LOT
   47: of people. It is ineffective to directly rely on contents within the
   48: ext2 filesystem to be speedily scanned for on-the-fly searches of
   49: content descriptions. (Simply put, it takes a cumbersome amount of
   50: time to open, read, analyze, and close thousands of files.)
   51: 
   52: The solution is to index various data fields that are descriptive of
   53: the educational resources on a LON-CAPA server machine in a
   54: database. Descriptive data fields are referred to as "metadata". The
   55: question then arises as to how this metadata is handled in terms of
   56: the rest of the LON-CAPA network without burdening client and daemon
   57: processes.
   58: 
   59: The obvious solution, using lonc to send a query to a lond process,
   60: doesn't work so well in general as you can see in the following
   61: example:
   62: 
   63:     lonc= loncapa client process    A-lonc= a lonc process on Server A
   64:     lond= loncapa daemon process
   65: 
   66:                  database command
   67:     A-lonc  --------TCP/IP----------------> B-lond
   68: 
   69: The problem emerges that A-lonc and B-lond are kept waiting for the
   70: MySQL server to "do its stuff", or in other words, perform the
   71: conceivably sophisticated, data-intensive, time-sucking database
   72: transaction.  By tying up a lonc and lond process, this significantly
   73: cripples the capabilities of LON-CAPA servers.
   74: 
   75: The solution is to offload the work onto another process, and use
   76: lonc and lond just for requests and notifications of completed
   77: processing:
   78: 
   79:                 database command
   80: 
   81:   A-lonc  ---------TCP/IP-----------------> B-lond =====> B-lonsql
   82:          <---------------------------------/                |
   83:            "ok, I'll get back to you..."                    |
   84:                                                             |
   85:                                                             /
   86:   A-lond  <-------------------------------  B-lonc   <======
   87:            "Guess what? I have the result!"
   88: 
   89: Of course, depending on success or failure, the messages may vary, but
   90: the principle remains the same where a separate pool of children
   91: processes (lonsql's) handle the MySQL database manipulations.
   92: 
   93: Thus, lonc and lond spend effectively no time waiting on results from
   94: the database.
   95: 
   96: =head1 Internals
   97: 
   98: =cut
   99: 
  100: use strict;
  101: 
  102: use lib '/home/httpd/lib/perl/';
  103: use LONCAPA;
  104: use LONCAPA::Configuration;
  105: use LONCAPA::lonmetadata();
  106: use Apache::lonnet;
  107: 
  108: use IO::Socket;
  109: use Symbol;
  110: use POSIX;
  111: use IO::Select;
  112: use DBI;
  113: use File::Find;
  114: use localenroll;
  115: use GDBM_File;
  116: 
  117: ########################################################
  118: ########################################################
  119: 
  120: =pod
  121: 
  122: =over 4
  123: 
  124: =item Global Variables
  125: 
  126: =over 4
  127: 
  128: =item dbh
  129: 
  130: =back
  131: 
  132: =cut
  133: 
  134: ########################################################
  135: ########################################################
  136: my $dbh;
  137: 
  138: ########################################################
  139: ########################################################
  140: 
  141: =pod 
  142: 
  143: =item Variables required for forking
  144: 
  145: =over 4
  146: 
  147: =item $MAX_CLIENTS_PER_CHILD
  148: 
  149: The number of clients each child should process.
  150: 
  151: =item %children 
  152: 
  153: The keys to %children  are the current child process IDs
  154: 
  155: =item $children
  156: 
  157: The current number of children
  158: 
  159: =back
  160: 
  161: =cut 
  162: 
  163: ########################################################
  164: ########################################################
  165: my $MAX_CLIENTS_PER_CHILD  = 5;   # number of clients each child should process
  166: my %children               = ();  # keys are current child process IDs
  167: my $children               = 0;   # current number of children
  168:                                
  169: ###################################################################
  170: ###################################################################
  171: 
  172: =pod
  173: 
  174: =item Main body of code.
  175: 
  176: =over 4
  177: 
  178: =item Read data from loncapa_apache.conf and loncapa.conf.
  179: 
  180: =item Ensure we can access the database.
  181: 
  182: =item Determine if there are other instances of lonsql running.
  183: 
  184: =item Read the hosts file.
  185: 
  186: =item Create a socket for lonsql.
  187: 
  188: =item Fork once and dissociate from parent.
  189: 
  190: =item Write PID to disk.
  191: 
  192: =item Prefork children and maintain the population of children.
  193: 
  194: =back
  195: 
  196: =cut
  197: 
  198: ###################################################################
  199: ###################################################################
  200: my $childmaxattempts=10;
  201: my $run =0;              # running counter to generate the query-id
  202: #
  203: # Read loncapa_apache.conf and loncapa.conf
  204: #
  205: my %perlvar=%{&LONCAPA::Configuration::read_conf('loncapa.conf')};
  206: #
  207: # Write the /home/www/.my.cnf file 
  208: my $conf_file = '/home/www/.my.cnf';
  209: if (! -e $conf_file) {
  210:     if (open MYCNF, ">$conf_file") {
  211:         print MYCNF <<"ENDMYCNF";
  212: [client]
  213: user=www
  214: password=$perlvar{'lonSqlAccess'}
  215: ENDMYCNF
  216:         close MYCNF;
  217:     } else {
  218:         warn "Unable to write $conf_file, continuing";
  219:     }
  220: }
  221: 
  222: 
  223: #
  224: # Make sure that database can be accessed
  225: #
  226: my $dbh;
  227: unless ($dbh = DBI->connect("DBI:mysql:loncapa","www",
  228:                             $perlvar{'lonSqlAccess'},
  229:                             { RaiseError =>0,PrintError=>0})) { 
  230:     print "Cannot connect to database!\n";
  231:     my $emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
  232:     my $subj="LON: $perlvar{'lonHostID'} Cannot connect to database!";
  233:     system("echo 'Cannot connect to MySQL database!' |".
  234:            " mail -s '$subj' $emailto > /dev/null");
  235: 
  236:     open(SMP,">$perlvar{'lonDocRoot'}/lon-status/mysql.txt");
  237:     print SMP 'time='.time.'&mysql=defunct'."\n";
  238:     close(SMP);
  239: 
  240:     exit 1;
  241: } else {
  242:     unlink("$perlvar{'lonDocRoot'}/lon-status/mysql.txt");
  243:     $dbh->disconnect;
  244: }
  245: 
  246: #
  247: # Check if other instance running
  248: #
  249: my $pidfile="$perlvar{'lonDaemons'}/logs/lonsql.pid";
  250: if (-e $pidfile) {
  251:    open(my $lfh,"$pidfile");
  252:    my $pide=<$lfh>;
  253:    chomp($pide);
  254:    if (kill 0 => $pide) { die "already running"; }
  255: }
  256: 
  257: my $PREFORK=4; # number of children to maintain, at least four spare
  258: #
  259: #$PREFORK=int($PREFORK/4);
  260: 
  261: #
  262: # Create a socket to talk to lond
  263: #
  264: my $unixsock = "mysqlsock";
  265: my $localfile="$perlvar{'lonSockDir'}/$unixsock";
  266: my $server;
  267: unlink ($localfile);
  268: unless ($server=IO::Socket::UNIX->new(Local    =>"$localfile",
  269:                                       Type    => SOCK_STREAM,
  270:                                       Listen => 10)) {
  271:     print "in socket error:$@\n";
  272: }
  273: 
  274: #
  275: # Fork once and dissociate
  276: #
  277: my $fpid=fork;
  278: exit if $fpid;
  279: die "Couldn't fork: $!" unless defined ($fpid);
  280: POSIX::setsid() or die "Can't start new session: $!";
  281: 
  282: #
  283: # Write our PID on disk
  284: my $execdir=$perlvar{'lonDaemons'};
  285: open (PIDSAVE,">$execdir/logs/lonsql.pid");
  286: print PIDSAVE "$$\n";
  287: close(PIDSAVE);
  288: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
  289: 
  290: #
  291: # Ignore signals generated during initial startup
  292: $SIG{HUP}=$SIG{USR1}='IGNORE';
  293: # Now we are on our own    
  294: #    Fork off our children.
  295: for (1 .. $PREFORK) {
  296:     make_new_child();
  297: }
  298: 
  299: #
  300: # Install signal handlers.
  301: $SIG{CHLD} = \&REAPER;
  302: $SIG{INT}  = $SIG{TERM} = \&HUNTSMAN;
  303: $SIG{HUP}  = \&HUPSMAN;
  304: 
  305: #
  306: # And maintain the population.
  307: while (1) {
  308:     sleep;                          # wait for a signal (i.e., child's death)
  309:     for (my $i = $children; $i < $PREFORK; $i++) {
  310:         make_new_child();           # top up the child pool
  311:     }
  312: }
  313: 
  314: ########################################################
  315: ########################################################
  316: 
  317: =pod
  318: 
  319: =item &make_new_child
  320: 
  321: Inputs: None
  322: 
  323: Returns: None
  324: 
  325: =cut
  326: 
  327: ########################################################
  328: ########################################################
  329: sub make_new_child {
  330:     my $pid;
  331:     my $sigset;
  332:     #
  333:     # block signal for fork
  334:     $sigset = POSIX::SigSet->new(SIGINT);
  335:     sigprocmask(SIG_BLOCK, $sigset)
  336:         or die "Can't block SIGINT for fork: $!\n";
  337:     #
  338:     die "fork: $!" unless defined ($pid = fork);
  339:     #
  340:     if ($pid) {
  341:         # Parent records the child's birth and returns.
  342:         sigprocmask(SIG_UNBLOCK, $sigset)
  343:             or die "Can't unblock SIGINT for fork: $!\n";
  344:         $children{$pid} = 1;
  345:         $children++;
  346:         return;
  347:     } else {
  348:         # Child can *not* return from this subroutine.
  349:         $SIG{INT} = 'DEFAULT';      # make SIGINT kill us as it did before
  350:         # unblock signals
  351:         sigprocmask(SIG_UNBLOCK, $sigset)
  352:             or die "Can't unblock SIGINT for fork: $!\n";
  353:         #open database handle
  354: 	# making dbh global to avoid garbage collector
  355: 	unless ($dbh = DBI->connect("DBI:mysql:loncapa","www",
  356:                                     $perlvar{'lonSqlAccess'},
  357:                                     { RaiseError =>0,PrintError=>0})) { 
  358:             sleep(10+int(rand(20)));
  359:             &logthis("<font color='blue'>WARNING: Couldn't connect to database".
  360:                      ": $@</font>");
  361:                      #  "($st secs): $@</font>");
  362:             print "database handle error\n";
  363:             exit;
  364:         }
  365: 	# make sure that a database disconnection occurs with 
  366:         # ending kill signals
  367: 	$SIG{TERM}=$SIG{INT}=$SIG{QUIT}=$SIG{__DIE__}=\&DISCONNECT;
  368:         # handle connections until we've reached $MAX_CLIENTS_PER_CHILD
  369:         for (my $i=0; $i < $MAX_CLIENTS_PER_CHILD; $i++) {
  370:             my $client = $server->accept() or last;
  371:             # do something with the connection
  372: 	    $run = $run+1;
  373: 	    my $userinput = <$client>;
  374: 	    chomp($userinput);
  375:             $userinput=~s/\:($LONCAPA::domain_re)$//;
  376:             my $searchdomain=$1;
  377:             #
  378: 	    my ($conserver,$query,
  379: 		$arg1,$arg2,$arg3)=split(/&/,$userinput);
  380: 	    my $query=unescape($query);
  381:             #
  382:             #send query id which is pid_unixdatetime_runningcounter
  383: 	    my $queryid = &Apache::lonnet::hostname($perlvar{'lonHostID'});
  384: 	    $queryid .="_".($$)."_";
  385: 	    $queryid .= time."_";
  386: 	    $queryid .= $run;
  387: 	    print $client "$queryid\n";
  388: 	    #
  389: 	    # &logthis("QUERY: $query - $arg1 - $arg2 - $arg3 - $queryid");
  390: 	    # sleep 1;
  391:             #
  392:             my $result='';
  393:             #
  394:             # At this point, query is received, query-ID assigned and sent 
  395:             # back, $query eq 'logquery' will mean that this is a query 
  396:             # against log-files
  397:             if (($query eq 'userlog') || ($query eq 'courselog')) {
  398:                 # beginning of log query
  399:                 my $udom    = &unescape($arg1);
  400:                 my $uname   = &unescape($arg2);
  401:                 my $command = &unescape($arg3);
  402:                 my $path    = &propath($udom,$uname);
  403:                 if (-e "$path/activity.log") {
  404:                     if ($query eq 'userlog') {
  405:                         $result=&userlog($path,$command);
  406:                     } else {
  407:                         $result=&courselog($path,$command);
  408:                     }
  409:                     $result = &escape($result);
  410:                 } else {
  411:                     &logthis('Unable to do log query: '.$uname.'@'.$udom);
  412:                     $result='no_such_file';
  413:                 }
  414:                 # end of log query
  415:             } elsif (($query eq 'fetchenrollment') || 
  416: 		     ($query eq 'institutionalphotos')) {
  417:                 # retrieve institutional class lists
  418:                 my $dom = &unescape($arg1);
  419:                 my %affiliates = ();
  420:                 my %replies = ();
  421:                 my $locresult = '';
  422:                 my $querystr = &unescape($arg3);
  423:                 foreach (split/%%/,$querystr) {
  424:                     if (/^([^=]+)=([^=]+)$/) {
  425:                         @{$affiliates{$1}} = split/,/,$2;
  426:                     }
  427:                 }
  428:                 if ($query eq 'fetchenrollment') { 
  429:                     $locresult = &localenroll::fetch_enrollment($dom,\%affiliates,\%replies);
  430:                 } elsif ($query eq 'institutionalphotos') {
  431:                     my $crs = &unescape($arg2);
  432: 		    eval {
  433: 			local($SIG{__DIE__})='DEFAULT';
  434: 			$locresult = &localenroll::institutional_photos($dom,$crs,\%affiliates,\%replies,'update');
  435: 		    };
  436: 		    if ($@) {
  437: 			$locresult = 'error';
  438: 		    }
  439:                 }
  440:                 $result = &escape($locresult.':');
  441:                 if ($locresult) {
  442:                     $result .= &escape(join(':',map{$_.'='.$replies{$_}} keys %replies));
  443:                 }
  444:             } elsif ($query eq 'usersearch') {
  445:                 my ($srchby,$srchtype,$srchterm);
  446:                 if ((&unescape($arg1) eq $searchdomain) &&
  447:                     ($arg2 =~ /\%\%/)) {
  448:                     ($srchby,$srchtype) =
  449:                         map {&unescape($_);} (split(/\%\%/,$arg2));
  450:                     $srchterm = &unescape($arg3);
  451:                 } else {
  452:                     ($srchby,$srchtype,$srchterm) =
  453:                         map {&unescape($_);} ($arg1,$arg2,$arg3);
  454:                 }
  455:                 $result = &do_user_search($searchdomain,$srchby,
  456:                                           $srchtype,$srchterm);
  457: 	    } elsif ($query eq 'instdirsearch') {
  458: 		$result = &do_inst_dir_search($searchdomain,$arg1,$arg2,$arg3);
  459:             } elsif ($query eq 'getinstuser') {
  460:                 $result = &get_inst_user($searchdomain,$arg1,$arg2);
  461:             } elsif ($query eq 'getmultinstusers') {
  462:                 $result = &get_multiple_instusers($searchdomain,$arg3);
  463:             } elsif ($query eq 'prepare activity log') {
  464:                 my ($cid,$domain) = map {&unescape($_);} ($arg1,$arg2);
  465:                 &logthis('preparing activity log tables for '.$cid);
  466:                 my $command = 
  467:                     qq{$perlvar{'lonDaemons'}/parse_activity_log.pl -course=$cid -domain=$domain};
  468:                 system($command);
  469:                 &logthis($command);
  470:                 my $returnvalue = $?>>8;
  471:                 if ($returnvalue) {
  472:                     $result = 'error: parse_activity_log.pl returned '.
  473:                         $returnvalue;
  474:                 } else {
  475:                     $result = 'success';
  476:                 }
  477:             } elsif (($query eq 'portfolio_metadata') || 
  478:                     ($query eq 'portfolio_access')) {
  479:                 $result = &portfolio_table_update($query,$arg1,$arg2,
  480:                                                   $arg3);
  481:             } elsif ($query eq 'allusers') {
  482:                 my ($uname,$udom) = map {&unescape($_);} ($arg1,$arg2);
  483:                 my %userdata;
  484:                 my (@data) = split(/\%\%/,$arg3);
  485:                 foreach my $item (@data) {
  486:                     my ($key,$value) = split(/=/,$item);
  487:                     $userdata{$key} = &unescape($value);
  488:                 }
  489:                 $userdata{'username'} = $uname;
  490:                 $userdata{'domain'} = $udom;
  491:                 $result = &allusers_table_update($query,$uname,$udom,\%userdata);
  492:             } else {
  493:                 # Sanity checking of $query needed.
  494:                 # Do an sql query
  495:                 $result = &do_sql_query($query,$arg1,$arg2,$arg3,$searchdomain);
  496:             }
  497:             # result does not need to be escaped because it has already been
  498:             # escaped.
  499:             #$result=&escape($result);
  500:             &Apache::lonnet::reply("queryreply:$queryid:$result",$conserver);
  501:         }
  502:         # tidy up gracefully and finish
  503:         #
  504:         # close the database handle
  505: 	$dbh->disconnect
  506:             or &logthis("<font color='blue'>WARNING: Couldn't disconnect".
  507:                         " from database  $DBI::errstr : $@</font>");
  508:         # this exit is VERY important, otherwise the child will become
  509:         # a producer of more and more children, forking yourself into
  510:         # process death.
  511:         exit;
  512:     }
  513: }
  514: 
  515: sub do_user_search {
  516:     my ($domain,$srchby,$srchtype,$srchterm) = @_;
  517:     my $result;
  518:     my $quoted_dom = $dbh->quote( $domain );
  519:     my ($query,$quoted_srchterm,@fields);
  520:     my ($table_columns,$table_indices) =
  521:         &LONCAPA::lonmetadata::describe_metadata_storage('allusers');
  522:     foreach my $coldata (@{$table_columns}) {
  523:         push(@fields,$coldata->{'name'});
  524:     }
  525:     my $fieldlist = join(',',@fields);
  526:     $query = "SELECT $fieldlist FROM allusers WHERE (domain = $quoted_dom AND ";
  527:     if ($srchby eq 'lastfirst') {
  528:         my ($fraglast,$fragfirst) = split(/,/,$srchterm);
  529:         $fragfirst =~ s/^\s+//;
  530:         $fraglast =~ s/\s+$//;
  531:         if ($srchtype eq 'exact') {
  532:             $query .= 'lastname = '.$dbh->quote($fraglast).
  533:                       ' AND firstname = '.$dbh->quote($fragfirst);
  534:         } elsif ($srchtype eq 'begins') {
  535:             $query .= 'lastname LIKE '.$dbh->quote($fraglast.'%').
  536:                       ' AND firstname LIKE '.$dbh->quote($fragfirst.'%');
  537:         } else {
  538:             $query .= 'lastname LIKE '.$dbh->quote('%'.$fraglast.'%').
  539:                       ' AND firstname LIKE '.$dbh->quote('%'.$fragfirst.'%');
  540:         }
  541:     } else {
  542:         my %srchfield = (
  543:                           uname_ci => 'username collate latin1_general_ci',
  544:                           uname    => 'username',
  545:                           lastname => 'lastname',
  546:                           email    => 'permanentemail',
  547:                         );
  548:         if (exists($srchfield{$srchby})) {
  549:             if ($srchtype eq 'exact') {
  550:                 $query .= $srchfield{$srchby}.' = '.$dbh->quote($srchterm);
  551:             } elsif ($srchtype eq 'begins') {
  552:                 $query .= $srchfield{$srchby}.' LIKE '.$dbh->quote($srchterm.'%');
  553:             } else {
  554:                 $query .= $srchfield{$srchby}.' LIKE '.$dbh->quote('%'.$srchterm.'%');
  555:             }
  556:         } else {
  557:             &logthis('<font color="blue">'.
  558:                      'WARNING: Invalid srchby: '.$srchby.'</font>');  
  559:             return $result;
  560:         }
  561:     }
  562:     $query .= ") ORDER BY username ";
  563:     my $sth = $dbh->prepare($query);
  564:     if ($sth->execute()) {
  565:         my @results;
  566:         while (my @row = $sth->fetchrow_array) {
  567:             my @items;
  568:             for (my $i=0; $i<@row; $i++) {
  569:                 push(@items,&escape($fields[$i]).'='.&escape($row[$i]));
  570:             }
  571:             my $userstr = join(':', @items);
  572:             push(@results,&escape($userstr));
  573:         }
  574:         $sth->finish;
  575:         $result = join('&',@results);
  576:     } else {
  577:         &logthis('<font color="blue">'.
  578:                 'WARNING: Could not retrieve from database:'.
  579:         $sth->errstr().'</font>');
  580:     }
  581:     return $result;
  582: }
  583: 
  584: sub do_inst_dir_search {
  585:     my ($domain,$srchby,$srchterm,$srchtype) = @_;
  586:     $srchby   = &unescape($srchby);
  587:     $srchterm = &unescape($srchterm);
  588:     $srchtype = &unescape($srchtype);
  589:     my (%instusers,%instids,$result,$response);
  590:     eval {
  591:         local($SIG{__DIE__})='DEFAULT';
  592:         $result=&localenroll::get_userinfo($domain,undef,undef,\%instusers,
  593: 					   \%instids,undef,$srchby,$srchterm,
  594: 					   $srchtype);
  595:     };
  596:     if ($result eq 'ok') {
  597:         if (%instusers) {
  598:             foreach my $key (keys(%instusers)) {
  599:                 my $usrstr = &Apache::lonnet::freeze_escape($instusers{$key});
  600:                 $response .=&escape(&escape($key).'='.$usrstr).'&';
  601:             }
  602:         }
  603:         $response=~s/\&$//;
  604:     } else {
  605:         $response = 'unavailable';
  606:     }
  607:     return $response;
  608: }
  609: 
  610: sub get_inst_user {
  611:     my ($domain,$uname,$id) = @_;
  612:     $uname = &unescape($uname);
  613:     $id = &unescape($id);
  614:     my (%instusers,%instids,$result,$response);
  615:     eval {
  616:         local($SIG{__DIE__})='DEFAULT';
  617:         $result=&localenroll::get_userinfo($domain,$uname,$id,\%instusers,
  618:                                            \%instids);
  619:     };
  620:     if ($result eq 'ok') {
  621:         if (keys(%instusers) > 0) {
  622:             foreach my $key (keys(%instusers)) {
  623:                 my $usrstr = &Apache::lonnet::freeze_escape($instusers{$key});
  624:                 $response .= &escape(&escape($key).'='.$usrstr).'&';
  625:             }
  626:         }
  627:         $response=~s/\&$//;
  628:     } else {
  629:         $response = 'unavailable';
  630:     }
  631:     return $response;
  632: }
  633: 
  634: sub get_multiple_instusers {
  635:     my ($domain,$data) = @_;
  636:     my ($type,$users) = split(/=/,$data,2);
  637:     my $requested = &Apache::lonnet::thaw_unescape($users);
  638:     my $response;
  639:     if (ref($requested) eq 'HASH') {
  640:         my (%instusers,%instids,$result);
  641:         eval {
  642:             local($SIG{__DIE__})='DEFAULT';
  643:             $result=&localenroll::get_multusersinfo($domain,$type,$requested,\%instusers,
  644:                                                     \%instids);
  645:         };
  646:         if ($@) {
  647:             $response = 'error';
  648:         } elsif ($result eq 'ok') {
  649:             $response = $result;
  650:             if (keys(%instusers)) {
  651:                 $response .= '='.&Apache::lonnet::freeze_escape(\%instusers);
  652:             }
  653:         } elsif ($result eq 'unavailable') {
  654:             $response = $result;
  655:         }
  656:     } else {
  657:         $response = 'invalid';
  658:     }
  659:     return $response;
  660: }
  661: 
  662: ########################################################
  663: ########################################################
  664: 
  665: =pod
  666: 
  667: =item &do_sql_query
  668: 
  669: Runs an sql metadata table query.
  670: 
  671: Inputs: $query, $custom, $customshow
  672: 
  673: Returns: A string containing escaped results.
  674: 
  675: =cut
  676: 
  677: ########################################################
  678: ########################################################
  679: {
  680:     my @metalist;
  681: 
  682: sub process_file {
  683:     if ( -e $_ &&  # file exists
  684:          -f $_ &&  # and is a normal file
  685:          /\.meta$/ &&  # ends in meta
  686:          ! /^.+\.\d+\.[^\.]+\.meta$/  # is not a previous version
  687:          ) {
  688:         push(@metalist,$File::Find::name);
  689:     }
  690: }
  691: 
  692: sub do_sql_query {
  693:     my ($query,$custom,$customshow,$domainstr,$searchdomain) = @_;
  694: 
  695: #
  696: # limit to searchdomain if given and table is metadata
  697: #
  698:     if ($domainstr && ($query=~/FROM metadata/)) {
  699:         my $havingstr;
  700:         $domainstr = &unescape($domainstr); 
  701:         if ($domainstr =~ /,/) {
  702:             foreach my $dom (split(/,/,$domainstr)) {
  703:                 if ($dom =~ /^$LONCAPA::domain_re$/) {
  704:                     $havingstr .= 'domain="'.$dom.'" OR ';
  705:                 }
  706:             }
  707:             $havingstr =~ s/ OR $//;
  708:         } else {
  709:             if ($domainstr =~ /^$LONCAPA::domain_re$/) {
  710:                 $havingstr = 'domain="'.$domainstr.'"';
  711:             }
  712:         }
  713:         if ($havingstr) {
  714:             $query.=' HAVING ('.$havingstr.')';
  715:         }
  716:     } elsif (($searchdomain) && ($query=~/FROM metadata/)) {
  717: 	$query.=' HAVING (domain="'.$searchdomain.'")';
  718:     }
  719: #    &logthis('doing query ('.$searchdomain.')'.$query);
  720: 
  721: 
  722: 
  723:     $custom     = &unescape($custom);
  724:     $customshow = &unescape($customshow);
  725:     #
  726:     @metalist = ();
  727:     #
  728:     my $result = '';
  729:     my @results = ();
  730:     my @files;
  731:     my $subsetflag=0;
  732:     #
  733:     if ($query) {
  734:         #prepare and execute the query
  735:         my $sth = $dbh->prepare($query);
  736:         unless ($sth->execute()) {
  737:             &logthis('<font color="blue">'.
  738:                      'WARNING: Could not retrieve from database:'.
  739:                      $sth->errstr().'</font>');
  740:         } else {
  741:             my $aref=$sth->fetchall_arrayref;
  742:             foreach my $row (@$aref) {
  743:                 push @files,@{$row}[3] if ($custom or $customshow);
  744:                 my @b=map { &escape($_); } @$row;
  745:                 push @results,join(",", @b);
  746:                 # Build up the @files array with the LON-CAPA urls 
  747:                 # of the resources.
  748:             }
  749:         }
  750:     }
  751:     # do custom metadata searching here and build into result
  752:     return join("&",@results) if (! ($custom or $customshow));
  753:     # Only get here if there is a custom query or custom show request
  754:     &logthis("Doing custom query for $custom");
  755:     if ($query) {
  756:         @metalist=map {
  757:             $perlvar{'lonDocRoot'}.$_.'.meta';
  758:         } @files;
  759:     } else {
  760:         my $dir = "$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}";
  761:         @metalist=(); 
  762:         opendir(RESOURCES,$dir);
  763:         my @homeusers=grep {
  764:             &ishome($dir.'/'.$_);
  765:         } grep {!/^\.\.?$/} readdir(RESOURCES);
  766:         closedir RESOURCES;
  767:         # Define the
  768:         foreach my $user (@homeusers) {
  769:             find (\&process_file,$dir.'/'.$user);
  770:         }
  771:     } 
  772:     # if file is indicated in sql database and
  773:     #     not part of sql-relevant query, do not pattern match.
  774:     #
  775:     # if file is not in sql database, output error.
  776:     #
  777:     # if file is indicated in sql database and is
  778:     #     part of query result list, then do the pattern match.
  779:     my $customresult='';
  780:     my @results;
  781:     foreach my $metafile (@metalist) {
  782:         open(my $fh,$metafile);
  783:         my @lines=<$fh>;
  784:         my $stuff=join('',@lines);
  785:         if ($stuff=~/$custom/s) {
  786:             foreach my $f ('abstract','author','copyright',
  787:                            'creationdate','keywords','language',
  788:                            'lastrevisiondate','mime','notes',
  789:                            'owner','subject','title') {
  790:                 $stuff=~s/\n?\<$f[^\>]*\>.*?<\/$f[^\>]*\>\n?//s;
  791:             }
  792:             my $mfile=$metafile; 
  793:             my $docroot=$perlvar{'lonDocRoot'};
  794:             $mfile=~s/^$docroot//;
  795:             $mfile=~s/\.meta$//;
  796:             unless ($query) {
  797:                 my $q2="SELECT * FROM metadata WHERE url ".
  798:                     " LIKE BINARY '?'";
  799:                 my $sth = $dbh->prepare($q2);
  800:                 $sth->execute($mfile);
  801:                 my $aref=$sth->fetchall_arrayref;
  802:                 foreach my $a (@$aref) {
  803:                     my @b=map { &escape($_)} @$a;
  804:                     push @results,join(",", @b);
  805:                 }
  806:             }
  807:             # &logthis("found: $stuff");
  808:             $customresult.='&custom='.&escape($mfile).','.
  809:                 escape($stuff);
  810:         }
  811:     }
  812:     $result=join("&",@results) unless $query;
  813:     $result.=$customresult;
  814:     #
  815:     return $result;
  816: } # End of &do_sql_query
  817: 
  818: } # End of scoping curly braces for &process_file and &do_sql_query
  819: 
  820: sub portfolio_table_update { 
  821:     my ($query,$arg1,$arg2,$arg3) = @_;
  822:     my %tablenames = (
  823:                        'portfolio'   => 'portfolio_metadata',
  824:                        'access'      => 'portfolio_access',
  825:                        'addedfields' => 'portfolio_addedfields',
  826:                      );
  827:     my $result = 'ok';
  828:     my $tablechk = &check_table($query);
  829:     if ($tablechk == 0) {
  830:         my $request =
  831:    &LONCAPA::lonmetadata::create_metadata_storage($query,$query);
  832:         $dbh->do($request);
  833:         if ($dbh->err) {
  834:             &logthis("create $query".
  835:                      " ERROR: ".$dbh->errstr);
  836:                      $result = 'error';
  837:         }
  838:     }
  839:     if ($result eq 'ok') {
  840:         my ($uname,$udom,$group) = split(/:/,&unescape($arg1));
  841:         my $file_name = &unescape($arg2);
  842:         my $action = $arg3;
  843:         my $is_course = 0;
  844:         if ($group ne '') {
  845:             $is_course = 1;
  846:         }
  847:         my $urlstart = '/uploaded/'.$udom.'/'.$uname;
  848:         my $pathstart = &propath($udom,$uname).'/userfiles';
  849:         my ($fullpath,$url);
  850:         if ($is_course) {
  851:             $fullpath = $pathstart.'/groups/'.$group.'/portfolio'.
  852:                         $file_name;
  853:             $url = $urlstart.'/groups/'.$group.'/portfolio'.$file_name;
  854:         } else {
  855:             $fullpath = $pathstart.'/portfolio'.$file_name;
  856:             $url = $urlstart.'/portfolio'.$file_name;
  857:         }
  858:         if ($query eq 'portfolio_metadata') {
  859:             if ($action eq 'delete') {
  860:                 my %loghash = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,\%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group,'update');
  861:             } elsif (-e $fullpath.'.meta') {
  862:                 my %loghash = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,\%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group,'update');
  863:                 if (keys(%loghash) > 0) {
  864:                     &portfolio_logging(%loghash);
  865:                 }
  866:             }
  867:         } elsif ($query eq 'portfolio_access') {
  868:             my %access = &get_access_hash($uname,$udom,$group.$file_name);
  869:             my %loghash =
  870:      &LONCAPA::lonmetadata::process_portfolio_access_data($dbh,undef,
  871:          \%tablenames,$url,$fullpath,\%access,'update');
  872:             if (keys(%loghash) > 0) {
  873:                 &portfolio_logging(%loghash);
  874:             } else {
  875:                 my $available = 0;
  876:                 foreach my $key (keys(%access)) {
  877:                     my ($num,$scope,$end,$start) =
  878:                         ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
  879:                     if ($scope eq 'public' || $scope eq 'guest') {
  880:                         $available = 1;
  881:                         last;
  882:                     }
  883:                 }
  884:                 if ($available) {
  885:                     # Retrieve current values
  886:                     my $condition = 'url='.$dbh->quote("$url");
  887:                     my ($error,$row) =
  888:     &LONCAPA::lonmetadata::lookup_metadata($dbh,$condition,undef,
  889:                                            'portfolio_metadata');
  890:                     if (!$error) {
  891:                         if (!(ref($row->[0]) eq 'ARRAY')) {  
  892:                             my %loghash =
  893:      &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,
  894:          \%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group);
  895:                             if (keys(%loghash) > 0) {
  896:                                 &portfolio_logging(%loghash);
  897:                             }
  898:                         } 
  899:                     }
  900:                 }
  901:             }
  902:         }
  903:     }
  904:     return $result;
  905: }
  906: 
  907: sub get_access_hash {
  908:     my ($uname,$udom,$file) = @_;
  909:     my $hashref = &tie_user_hash($udom,$uname,'file_permissions',
  910:                                  &GDBM_READER());
  911:     my %curr_perms;
  912:     my %access; 
  913:     if ($hashref) {
  914:         while (my ($key,$value) = each(%$hashref)) {
  915:             $key = &unescape($key);
  916:             next if ($key =~ /^error: 2 /);
  917:             $curr_perms{$key}=&Apache::lonnet::thaw_unescape($value);
  918:         }
  919:         if (!&untie_user_hash($hashref)) {
  920:             &logthis("error: ".($!+0)." untie (GDBM) Failed");
  921:         }
  922:     } else {
  923:         &logthis("error: ".($!+0)." tie (GDBM) Failed");
  924:     }
  925:     if (keys(%curr_perms) > 0) {
  926:         if (ref($curr_perms{$file."\0".'accesscontrol'}) eq 'HASH') {
  927:             foreach my $acl (keys(%{$curr_perms{$file."\0".'accesscontrol'}})) {
  928:                 $access{$acl} = $curr_perms{$file."\0".$acl};
  929:             }
  930:         }
  931:     }
  932:     return %access;
  933: }
  934: 
  935: sub allusers_table_update {
  936:     my ($query,$uname,$udom,$userdata) = @_;
  937:     my %tablenames = (
  938:                        'allusers'   => 'allusers',
  939:                      );
  940:     my $result = 'ok';
  941:     my $tablechk = &check_table($query);
  942:     if ($tablechk == 0) {
  943:         my $request =
  944:    &LONCAPA::lonmetadata::create_metadata_storage($query,$query);
  945:         $dbh->do($request);
  946:         if ($dbh->err) {
  947:             &logthis("create $query".
  948:                      " ERROR: ".$dbh->errstr);
  949:                      $result = 'error';
  950:         }
  951:     }
  952:     if ($result eq 'ok') {
  953:         my %loghash = 
  954:             &LONCAPA::lonmetadata::process_allusers_data($dbh,undef,
  955:                 \%tablenames,$uname,$udom,$userdata,'update');
  956:         foreach my $key (keys(%loghash)) {
  957:             &logthis($loghash{$key});
  958:         }
  959:     }
  960:     return $result;
  961: }
  962: 
  963: ###########################################
  964: sub check_table {
  965:     my ($table_id) = @_;
  966:     my $sth=$dbh->prepare('SHOW TABLES');
  967:     $sth->execute();
  968:     my $aref = $sth->fetchall_arrayref;
  969:     $sth->finish();
  970:     if ($sth->err()) {
  971:         &logthis("fetchall_arrayref after SHOW TABLES".
  972:             " ERROR: ".$sth->errstr);
  973:         return undef;
  974:     }
  975:     my $result = 0;
  976:     foreach my $table (@{$aref}) {
  977:         if ($table->[0] eq $table_id) { 
  978:             $result = 1;
  979:             last;
  980:         }
  981:     }
  982:     return $result;
  983: }
  984: 
  985: ###########################################
  986: 
  987: sub portfolio_logging {
  988:     my (%portlog) = @_;
  989:     foreach my $key (keys(%portlog)) {
  990:         if (ref($portlog{$key}) eq 'HASH') {
  991:             foreach my $item (keys(%{$portlog{$key}})) {
  992:                 &logthis($portlog{$key}{$item});
  993:             }
  994:         }
  995:     }
  996: }
  997: 
  998: 
  999: ########################################################
 1000: ########################################################
 1001: 
 1002: =pod
 1003: 
 1004: =item &logthis
 1005: 
 1006: Inputs: $message, the message to log
 1007: 
 1008: Returns: nothing
 1009: 
 1010: Writes $message to the logfile.
 1011: 
 1012: =cut
 1013: 
 1014: ########################################################
 1015: ########################################################
 1016: sub logthis {
 1017:     my $message=shift;
 1018:     my $execdir=$perlvar{'lonDaemons'};
 1019:     open(my $fh,">>$execdir/logs/lonsql.log");
 1020:     my $now=time;
 1021:     my $local=localtime($now);
 1022:     print $fh "$local ($$): $message\n";
 1023: }
 1024: 
 1025: ########################################################
 1026: ########################################################
 1027: 
 1028: =pod
 1029: 
 1030: =item &ishome
 1031: 
 1032: Determine if the current machine is the home server for a user.
 1033: The determination is made by checking the filesystem for the users information.
 1034: 
 1035: Inputs: $author
 1036: 
 1037: Returns: 0 - this is not the authors home server, 1 - this is.
 1038: 
 1039: =cut
 1040: 
 1041: ########################################################
 1042: ########################################################
 1043: sub ishome {
 1044:     my $author=shift;
 1045:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
 1046:     my ($udom,$uname)=split(/\//,$author);
 1047:     my $proname=propath($udom,$uname);
 1048:     if (-e $proname) {
 1049: 	return 1;
 1050:     } else {
 1051:         return 0;
 1052:     }
 1053: }
 1054: 
 1055: ########################################################
 1056: ########################################################
 1057: 
 1058: =pod
 1059: 
 1060: =item &courselog
 1061: 
 1062: Inputs: $path, $command
 1063: 
 1064: Returns: unescaped string of values.
 1065: 
 1066: =cut
 1067: 
 1068: ########################################################
 1069: ########################################################
 1070: sub courselog {
 1071:     my ($path,$command)=@_;
 1072:     my %filters=();
 1073:     foreach (split(/\:/,&unescape($command))) {
 1074: 	my ($name,$value)=split(/\=/,$_);
 1075:         $filters{$name}=$value;
 1076:     }
 1077:     my @results=();
 1078:     open(IN,$path.'/activity.log') or return ('file_error');
 1079:     while (my $line=<IN>) {
 1080:         chomp($line);
 1081:         my ($timestamp,$host,$log)=split(/\:/,$line);
 1082: #
 1083: # $log has the actual log entries; currently still escaped, and
 1084: # %26(timestamp)%3a(url)%3a(user)%3a(domain)
 1085: # then additionally
 1086: # %3aPOST%3a(name)%3d(value)%3a(name)%3d(value)
 1087: # or
 1088: # %3aCSTORE%3a(name)%3d(value)%26(name)%3d(value)
 1089: #
 1090: # get delimiter between timestamped entries to be &&&
 1091:         $log=~s/\%26(\d+)\%3a/\&\&\&$1\%3a/g;
 1092: # now go over all log entries 
 1093:         foreach (split(/\&\&\&/,&unescape($log))) {
 1094: 	    my ($time,$res,$uname,$udom,$action,@values)=split(/\:/,$_);
 1095:             my $values=&unescape(join(':',@values));
 1096:             $values=~s/\&/\:/g;
 1097:             $res=&unescape($res);
 1098:             my $include=1;
 1099:             if (($filters{'username'}) && ($uname ne $filters{'username'})) 
 1100:                                                                { $include=0; }
 1101:             if (($filters{'domain'}) && ($udom ne $filters{'domain'})) 
 1102:                                                                { $include=0; }
 1103:             if (($filters{'url'}) && ($res!~/$filters{'url'}/)) 
 1104:                                                                { $include=0; }
 1105:             if (($filters{'start'}) && ($time<$filters{'start'})) 
 1106:                                                                { $include=0; }
 1107:             if (($filters{'end'}) && ($time>$filters{'end'})) 
 1108:                                                                { $include=0; }
 1109:             if (($filters{'action'} eq 'view') && ($action)) 
 1110:                                                                { $include=0; }
 1111:             if (($filters{'action'} eq 'submit') && ($action ne 'POST')) 
 1112:                                                                { $include=0; }
 1113:             if (($filters{'action'} eq 'grade') && ($action ne 'CSTORE')) 
 1114:                                                                { $include=0; }
 1115:             if ($include) {
 1116: 	       push(@results,($time<1000000000?'0':'').$time.':'.$res.':'.
 1117:                                             $uname.':'.$udom.':'.
 1118:                                             $action.':'.$values);
 1119:             }
 1120:        }
 1121:     }
 1122:     close IN;
 1123:     return join('&',sort(@results));
 1124: }
 1125: 
 1126: ########################################################
 1127: ########################################################
 1128: 
 1129: =pod
 1130: 
 1131: =item &userlog
 1132: 
 1133: Inputs: $path, $command
 1134: 
 1135: Returns: unescaped string of values.
 1136: 
 1137: =cut
 1138: 
 1139: ########################################################
 1140: ########################################################
 1141: sub userlog {
 1142:     my ($path,$command)=@_;
 1143:     my %filters=();
 1144:     foreach (split(/\:/,&unescape($command))) {
 1145: 	my ($name,$value)=split(/\=/,$_);
 1146:         $filters{$name}=$value;
 1147:     }
 1148:     my @results=();
 1149:     open(IN,$path.'/activity.log') or return ('file_error');
 1150:     while (my $line=<IN>) {
 1151:         chomp($line);
 1152:         my ($timestamp,$host,$log)=split(/\:/,$line);
 1153:         $log=&unescape($log);
 1154:         my $include=1;
 1155:         if (($filters{'start'}) && ($timestamp<$filters{'start'})) 
 1156:                                                              { $include=0; }
 1157:         if (($filters{'end'}) && ($timestamp>$filters{'end'})) 
 1158:                                                              { $include=0; }
 1159:         if (($filters{'action'} eq 'Role') && ($log !~/^Role/))
 1160:                                                              { $include=0; }
 1161:         if (($filters{'action'} eq 'log') && ($log!~/^Log/)) { $include=0; }
 1162:         if (($filters{'action'} eq 'check') && ($log!~/^Check/)) 
 1163:                                                              { $include=0; }
 1164:         if ($include) {
 1165: 	   push(@results,$timestamp.':'.$host.':'.&escape($log));
 1166:         }
 1167:     }
 1168:     close IN;
 1169:     return join('&',sort(@results));
 1170: }
 1171: 
 1172: ########################################################
 1173: ########################################################
 1174: 
 1175: =pod
 1176: 
 1177: =item Functions required for forking
 1178: 
 1179: =over 4
 1180: 
 1181: =item REAPER
 1182: 
 1183: REAPER takes care of dead children.
 1184: 
 1185: =item HUNTSMAN
 1186: 
 1187: Signal handler for SIGINT.
 1188: 
 1189: =item HUPSMAN
 1190: 
 1191: Signal handler for SIGHUP
 1192: 
 1193: =item DISCONNECT
 1194: 
 1195: Disconnects from database.
 1196: 
 1197: =back
 1198: 
 1199: =cut
 1200: 
 1201: ########################################################
 1202: ########################################################
 1203: sub REAPER {                   # takes care of dead children
 1204:     $SIG{CHLD} = \&REAPER;
 1205:     my $pid = wait;
 1206:     $children --;
 1207:     &logthis("Child $pid died");
 1208:     delete $children{$pid};
 1209: }
 1210: 
 1211: sub HUNTSMAN {                      # signal handler for SIGINT
 1212:     local($SIG{CHLD}) = 'IGNORE';   # we're going to kill our children
 1213:     kill 'INT' => keys %children;
 1214:     my $execdir=$perlvar{'lonDaemons'};
 1215:     unlink("$execdir/logs/lonsql.pid");
 1216:     &logthis("<font color='red'>CRITICAL: Shutting down</font>");
 1217:     $unixsock = "mysqlsock";
 1218:     my $port="$perlvar{'lonSockDir'}/$unixsock";
 1219:     unlink($port);
 1220:     exit;                           # clean up with dignity
 1221: }
 1222: 
 1223: sub HUPSMAN {                      # signal handler for SIGHUP
 1224:     local($SIG{CHLD}) = 'IGNORE';  # we're going to kill our children
 1225:     kill 'INT' => keys %children;
 1226:     close($server);                # free up socket
 1227:     &logthis("<font color='red'>CRITICAL: Restarting</font>");
 1228:     my $execdir=$perlvar{'lonDaemons'};
 1229:     $unixsock = "mysqlsock";
 1230:     my $port="$perlvar{'lonSockDir'}/$unixsock";
 1231:     unlink($port);
 1232:     exec("$execdir/lonsql");         # here we go again
 1233: }
 1234: 
 1235: sub DISCONNECT {
 1236:     $dbh->disconnect or 
 1237:     &logthis("<font color='blue'>WARNING: Couldn't disconnect from database ".
 1238:              " $DBI::errstr : $@</font>");
 1239:     exit;
 1240: }
 1241: 
 1242: 
 1243: =pod
 1244: 
 1245: =back
 1246: 
 1247: =cut

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