File:  [LON-CAPA] / loncom / lonsql
Revision 1.88: download - view: text, annotated - select for diffs
Wed Sep 12 03:40:29 2007 UTC (16 years, 7 months ago) by raeburn
Branches: MAIN
CVS tags: HEAD
lonnet.pm
- usersearch() made more similar to other routines which use lonsql
   (records split on \n not &).
  - srchby, srchtype, and srchterm passed as separate arguments
  - backwards compatibility maintained with older lonsql
lonsql
- usersearch() query processing moved to subroutine.
- searchdomain implicitly from lonsql, isntead of arg in query
- backwards compatibility maintained with older lonnet:usersearch()
- escaping of result more consistent with other lonsql queries (replacement of & with \n in lond::reply_query_handler() now possible).

    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.88 2007/09/12 03:40:29 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: =over 4
   99: 
  100: =cut
  101: 
  102: use strict;
  103: 
  104: use lib '/home/httpd/lib/perl/';
  105: use LONCAPA;
  106: use LONCAPA::Configuration;
  107: use LONCAPA::lonmetadata();
  108: use Apache::lonnet;
  109: 
  110: use IO::Socket;
  111: use Symbol;
  112: use POSIX;
  113: use IO::Select;
  114: use DBI;
  115: use File::Find;
  116: use localenroll;
  117: use GDBM_File;
  118: 
  119: ########################################################
  120: ########################################################
  121: 
  122: =pod
  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:            " mailto $emailto -s '$subj' > /dev/null");
  235: 
  236:     open(SMP,'>/home/httpd/html/lon-status/mysql.txt');
  237:     print SMP 'time='.time.'&mysql=defunct'."\n";
  238:     close(SMP);
  239: 
  240:     exit 1;
  241: } else {
  242:     unlink('/home/httpd/html/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:                     my $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 'prepare activity log') {
  460:                 my ($cid,$domain) = map {&unescape($_);} ($arg1,$arg2);
  461:                 &logthis('preparing activity log tables for '.$cid);
  462:                 my $command = 
  463:                     qq{$perlvar{'lonDaemons'}/parse_activity_log.pl -course=$cid -domain=$domain};
  464:                 system($command);
  465:                 &logthis($command);
  466:                 my $returnvalue = $?>>8;
  467:                 if ($returnvalue) {
  468:                     $result = 'error: parse_activity_log.pl returned '.
  469:                         $returnvalue;
  470:                 } else {
  471:                     $result = 'success';
  472:                 }
  473:             } elsif (($query eq 'portfolio_metadata') || 
  474:                     ($query eq 'portfolio_access')) {
  475:                 $result = &portfolio_table_update($query,$arg1,$arg2,
  476:                                                   $arg3);
  477:             } elsif ($query eq 'allusers') {
  478:                 my ($uname,$udom) = map {&unescape($_);} ($arg1,$arg2);
  479:                 my %userdata;
  480:                 my (@data) = split(/\%\%/,$arg3);
  481:                 foreach my $item (@data) {
  482:                     my ($key,$value) = split(/=/,$item);
  483:                     $userdata{$key} = &unescape($value);
  484:                 }
  485:                 $userdata{'username'} = $uname;
  486:                 $userdata{'domain'} = $udom;
  487:                 $result = &allusers_table_update($query,$uname,$udom,\%userdata);
  488:             } else {
  489:                 # Do an sql query
  490:                 $result = &do_sql_query($query,$arg1,$arg2,$searchdomain);
  491:             }
  492:             # result does not need to be escaped because it has already been
  493:             # escaped.
  494:             #$result=&escape($result);
  495:             &Apache::lonnet::reply("queryreply:$queryid:$result",$conserver);
  496:         }
  497:         # tidy up gracefully and finish
  498:         #
  499:         # close the database handle
  500: 	$dbh->disconnect
  501:             or &logthis("<font color='blue'>WARNING: Couldn't disconnect".
  502:                         " from database  $DBI::errstr : $@</font>");
  503:         # this exit is VERY important, otherwise the child will become
  504:         # a producer of more and more children, forking yourself into
  505:         # process death.
  506:         exit;
  507:     }
  508: }
  509: 
  510: sub do_user_search {
  511:     my ($domain,$srchby,$srchtype,$srchterm) = @_;
  512:     my $result;
  513:     my $quoted_dom = $dbh->quote( $domain );
  514:     my ($query,$quoted_srchterm,@fields);
  515:     my ($table_columns,$table_indices) =
  516:         &LONCAPA::lonmetadata::describe_metadata_storage('allusers');
  517:     foreach my $coldata (@{$table_columns}) {
  518:         push(@fields,$coldata->{'name'});
  519:     }
  520:     my $fieldlist = join(',',@fields);
  521:     $query = "SELECT $fieldlist FROM allusers WHERE (domain = $quoted_dom AND ";
  522:     if ($srchby eq 'lastfirst') {
  523:         my ($fraglast,$fragfirst) = split(/,/,$srchterm);
  524:         $fragfirst =~ s/^\s+//;
  525:         $fraglast =~ s/\s+$//;
  526:         if ($srchtype eq 'exact') {
  527:             $query .= 'lastname = '.$dbh->quote($fraglast).
  528:                       ' AND firstname = '.$dbh->quote($fragfirst);
  529:         } elsif ($srchtype eq 'begins') {
  530:             $query .= 'lastname LIKE '.$dbh->quote($fraglast.'%').
  531:                       ' AND firstname LIKE '.$dbh->quote($fragfirst.'%');
  532:         } else {
  533:             $query .= 'lastname LIKE '.$dbh->quote('%'.$fraglast.'%').
  534:                       ' AND firstname LIKE '.$dbh->quote('%'.$fragfirst.'%');
  535:         }
  536:     } else {
  537:         my %srchfield = (
  538:                           uname    => 'username',
  539:                           lastname => 'lastname',
  540:                         );
  541:         if ($srchtype eq 'exact') {
  542:             $query .= $srchfield{$srchby}.' = '.$dbh->quote($srchterm);
  543:         } elsif ($srchtype eq 'begins') {
  544:              $query .= $srchfield{$srchby}.' LIKE '.$dbh->quote($srchterm.'%');
  545:         } else {
  546:              $query .= $srchfield{$srchby}.' LIKE '.$dbh->quote('%'.$srchterm.'%');
  547:         }
  548:     }
  549:     $query .= ") ORDER BY username ";
  550:     my $sth = $dbh->prepare($query);
  551:     if ($sth->execute()) {
  552:         my @results;
  553:         while (my @row = $sth->fetchrow_array) {
  554:             my @items;
  555:             for (my $i=0; $i<@row; $i++) {
  556:                 push(@items,&escape($fields[$i]).'='.&escape($row[$i]));
  557:             }
  558:             my $userstr = join(':', @items);
  559:             push(@results,&escape($userstr));
  560:         }
  561:         $sth->finish;
  562:         $result = join('&',@results);
  563:     } else {
  564:         &logthis('<font color="blue">'.
  565:                 'WARNING: Could not retrieve from database:'.
  566:         $sth->errstr().'</font>');
  567:     }
  568:     return $result;
  569: }
  570: 
  571: sub do_inst_dir_search {
  572:     my ($domain,$srchby,$srchterm,$srchtype) = @_;
  573:     $srchby   = &unescape($srchby);
  574:     $srchterm = &unescape($srchterm);
  575:     $srchtype = &unescape($srchtype);
  576:     my (%instusers,%instids,$result,$response);
  577:     eval {
  578:         local($SIG{__DIE__})='DEFAULT';
  579:         $result=&localenroll::get_userinfo($domain,undef,undef,\%instusers,
  580: 					   \%instids,undef,$srchby,$srchterm,
  581: 					   $srchtype);
  582:     };
  583:     if ($result eq 'ok') {
  584:         if (%instusers) {
  585:             foreach my $key (keys(%instusers)) {
  586:                 my $usrstr = &Apache::lonnet::freeze_escape($instusers{$key});
  587:                 $response .=&escape(&escape($key).'='.$usrstr).'&';
  588:             }
  589:         }
  590:         $response=~s/\&$//;
  591:     } else {
  592:         $response = 'unavailable';
  593:     }
  594:     return $response;
  595: }
  596: 
  597: ########################################################
  598: ########################################################
  599: 
  600: =pod
  601: 
  602: =item &do_sql_query
  603: 
  604: Runs an sql metadata table query.
  605: 
  606: Inputs: $query, $custom, $customshow
  607: 
  608: Returns: A string containing escaped results.
  609: 
  610: =cut
  611: 
  612: ########################################################
  613: ########################################################
  614: {
  615:     my @metalist;
  616: 
  617: sub process_file {
  618:     if ( -e $_ &&  # file exists
  619:          -f $_ &&  # and is a normal file
  620:          /\.meta$/ &&  # ends in meta
  621:          ! /^.+\.\d+\.[^\.]+\.meta$/  # is not a previous version
  622:          ) {
  623:         push(@metalist,$File::Find::name);
  624:     }
  625: }
  626: 
  627: sub do_sql_query {
  628:     my ($query,$custom,$customshow,$searchdomain) = @_;
  629: 
  630: #
  631: # limit to searchdomain if given and table is metadata
  632: #
  633:     if (($searchdomain) && ($query=~/FROM metadata/)) {
  634: 	$query.=' HAVING (domain="'.$searchdomain.'")';
  635:     }
  636: #    &logthis('doing query ('.$searchdomain.')'.$query);
  637: 
  638: 
  639: 
  640:     $custom     = &unescape($custom);
  641:     $customshow = &unescape($customshow);
  642:     #
  643:     @metalist = ();
  644:     #
  645:     my $result = '';
  646:     my @results = ();
  647:     my @files;
  648:     my $subsetflag=0;
  649:     #
  650:     if ($query) {
  651:         #prepare and execute the query
  652:         my $sth = $dbh->prepare($query);
  653:         unless ($sth->execute()) {
  654:             &logthis('<font color="blue">'.
  655:                      'WARNING: Could not retrieve from database:'.
  656:                      $sth->errstr().'</font>');
  657:         } else {
  658:             my $aref=$sth->fetchall_arrayref;
  659:             foreach my $row (@$aref) {
  660:                 push @files,@{$row}[3] if ($custom or $customshow);
  661:                 my @b=map { &escape($_); } @$row;
  662:                 push @results,join(",", @b);
  663:                 # Build up the @files array with the LON-CAPA urls 
  664:                 # of the resources.
  665:             }
  666:         }
  667:     }
  668:     # do custom metadata searching here and build into result
  669:     return join("&",@results) if (! ($custom or $customshow));
  670:     # Only get here if there is a custom query or custom show request
  671:     &logthis("Doing custom query for $custom");
  672:     if ($query) {
  673:         @metalist=map {
  674:             $perlvar{'lonDocRoot'}.$_.'.meta';
  675:         } @files;
  676:     } else {
  677:         my $dir = "$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}";
  678:         @metalist=(); 
  679:         opendir(RESOURCES,$dir);
  680:         my @homeusers=grep {
  681:             &ishome($dir.'/'.$_);
  682:         } grep {!/^\.\.?$/} readdir(RESOURCES);
  683:         closedir RESOURCES;
  684:         # Define the
  685:         foreach my $user (@homeusers) {
  686:             find (\&process_file,$dir.'/'.$user);
  687:         }
  688:     } 
  689:     # if file is indicated in sql database and
  690:     #     not part of sql-relevant query, do not pattern match.
  691:     #
  692:     # if file is not in sql database, output error.
  693:     #
  694:     # if file is indicated in sql database and is
  695:     #     part of query result list, then do the pattern match.
  696:     my $customresult='';
  697:     my @results;
  698:     foreach my $metafile (@metalist) {
  699:         open(my $fh,$metafile);
  700:         my @lines=<$fh>;
  701:         my $stuff=join('',@lines);
  702:         if ($stuff=~/$custom/s) {
  703:             foreach my $f ('abstract','author','copyright',
  704:                            'creationdate','keywords','language',
  705:                            'lastrevisiondate','mime','notes',
  706:                            'owner','subject','title') {
  707:                 $stuff=~s/\n?\<$f[^\>]*\>.*?<\/$f[^\>]*\>\n?//s;
  708:             }
  709:             my $mfile=$metafile; 
  710:             my $docroot=$perlvar{'lonDocRoot'};
  711:             $mfile=~s/^$docroot//;
  712:             $mfile=~s/\.meta$//;
  713:             unless ($query) {
  714:                 my $q2="SELECT * FROM metadata WHERE url ".
  715:                     " LIKE BINARY '?'";
  716:                 my $sth = $dbh->prepare($q2);
  717:                 $sth->execute($mfile);
  718:                 my $aref=$sth->fetchall_arrayref;
  719:                 foreach my $a (@$aref) {
  720:                     my @b=map { &escape($_)} @$a;
  721:                     push @results,join(",", @b);
  722:                 }
  723:             }
  724:             # &logthis("found: $stuff");
  725:             $customresult.='&custom='.&escape($mfile).','.
  726:                 escape($stuff);
  727:         }
  728:     }
  729:     $result=join("&",@results) unless $query;
  730:     $result.=$customresult;
  731:     #
  732:     return $result;
  733: } # End of &do_sql_query
  734: 
  735: } # End of scoping curly braces for &process_file and &do_sql_query
  736: 
  737: sub portfolio_table_update { 
  738:     my ($query,$arg1,$arg2,$arg3) = @_;
  739:     my %tablenames = (
  740:                        'portfolio'   => 'portfolio_metadata',
  741:                        'access'      => 'portfolio_access',
  742:                        'addedfields' => 'portfolio_addedfields',
  743:                      );
  744:     my $result = 'ok';
  745:     my $tablechk = &check_table($query);
  746:     if ($tablechk == 0) {
  747:         my $request =
  748:    &LONCAPA::lonmetadata::create_metadata_storage($query,$query);
  749:         $dbh->do($request);
  750:         if ($dbh->err) {
  751:             &logthis("create $query".
  752:                      " ERROR: ".$dbh->errstr);
  753:                      $result = 'error';
  754:         }
  755:     }
  756:     if ($result eq 'ok') {
  757:         my ($uname,$udom,$group) = split(/:/,&unescape($arg1));
  758:         my $file_name = &unescape($arg2);
  759:         my $action = $arg3;
  760:         my $is_course = 0;
  761:         if ($group ne '') {
  762:             $is_course = 1;
  763:         }
  764:         my $urlstart = '/uploaded/'.$udom.'/'.$uname;
  765:         my $pathstart = &propath($udom,$uname).'/userfiles';
  766:         my ($fullpath,$url);
  767:         if ($is_course) {
  768:             $fullpath = $pathstart.'/groups/'.$group.'/portfolio'.
  769:                         $file_name;
  770:             $url = $urlstart.'/groups/'.$group.'/portfolio'.$file_name;
  771:         } else {
  772:             $fullpath = $pathstart.'/portfolio'.$file_name;
  773:             $url = $urlstart.'/portfolio'.$file_name;
  774:         }
  775:         if ($query eq 'portfolio_metadata') {
  776:             if ($action eq 'delete') {
  777:                 my %loghash = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,\%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group,'update');
  778:             } elsif (-e $fullpath.'.meta') {
  779:                 my %loghash = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,\%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group,'update');
  780:                 if (keys(%loghash) > 0) {
  781:                     &portfolio_logging(%loghash);
  782:                 }
  783:             }
  784:         } elsif ($query eq 'portfolio_access') {
  785:             my %access = &get_access_hash($uname,$udom,$group.$file_name);
  786:             my %loghash =
  787:      &LONCAPA::lonmetadata::process_portfolio_access_data($dbh,undef,
  788:          \%tablenames,$url,$fullpath,\%access,'update');
  789:             if (keys(%loghash) > 0) {
  790:                 &portfolio_logging(%loghash);
  791:             } else {
  792:                 my $available = 0;
  793:                 foreach my $key (keys(%access)) {
  794:                     my ($num,$scope,$end,$start) =
  795:                         ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
  796:                     if ($scope eq 'public' || $scope eq 'guest') {
  797:                         $available = 1;
  798:                         last;
  799:                     }
  800:                 }
  801:                 if ($available) {
  802:                     # Retrieve current values
  803:                     my $condition = 'url='.$dbh->quote("$url");
  804:                     my ($error,$row) =
  805:     &LONCAPA::lonmetadata::lookup_metadata($dbh,$condition,undef,
  806:                                            'portfolio_metadata');
  807:                     if (!$error) {
  808:                         if (!(ref($row->[0]) eq 'ARRAY')) {  
  809:                             my %loghash =
  810:      &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,
  811:          \%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group);
  812:                             if (keys(%loghash) > 0) {
  813:                                 &portfolio_logging(%loghash);
  814:                             }
  815:                         } 
  816:                     }
  817:                 }
  818:             }
  819:         }
  820:     }
  821:     return $result;
  822: }
  823: 
  824: sub get_access_hash {
  825:     my ($uname,$udom,$file) = @_;
  826:     my $hashref = &tie_user_hash($udom,$uname,'file_permissions',
  827:                                  &GDBM_READER());
  828:     my %curr_perms;
  829:     my %access; 
  830:     if ($hashref) {
  831:         while (my ($key,$value) = each(%$hashref)) {
  832:             $key = &unescape($key);
  833:             next if ($key =~ /^error: 2 /);
  834:             $curr_perms{$key}=&Apache::lonnet::thaw_unescape($value);
  835:         }
  836:         if (!&untie_user_hash($hashref)) {
  837:             &logthis("error: ".($!+0)." untie (GDBM) Failed");
  838:         }
  839:     } else {
  840:         &logthis("error: ".($!+0)." tie (GDBM) Failed");
  841:     }
  842:     if (keys(%curr_perms) > 0) {
  843:         if (ref($curr_perms{$file."\0".'accesscontrol'}) eq 'HASH') {
  844:             foreach my $acl (keys(%{$curr_perms{$file."\0".'accesscontrol'}})) {
  845:                 $access{$acl} = $curr_perms{$file."\0".$acl};
  846:             }
  847:         }
  848:     }
  849:     return %access;
  850: }
  851: 
  852: sub allusers_table_update {
  853:     my ($query,$uname,$udom,$userdata) = @_;
  854:     my %tablenames = (
  855:                        'allusers'   => 'allusers',
  856:                      );
  857:     my $result = 'ok';
  858:     my $tablechk = &check_table($query);
  859:     if ($tablechk == 0) {
  860:         my $request =
  861:    &LONCAPA::lonmetadata::create_metadata_storage($query,$query);
  862:         $dbh->do($request);
  863:         if ($dbh->err) {
  864:             &logthis("create $query".
  865:                      " ERROR: ".$dbh->errstr);
  866:                      $result = 'error';
  867:         }
  868:     }
  869:     if ($result eq 'ok') {
  870:         my %loghash = 
  871:             &LONCAPA::lonmetadata::process_allusers_data($dbh,undef,
  872:                 \%tablenames,$uname,$udom,$userdata,'update');
  873:         foreach my $key (keys(%loghash)) {
  874:             &logthis($loghash{$key});
  875:         }
  876:     }
  877:     return $result;
  878: }
  879: 
  880: ###########################################
  881: sub check_table {
  882:     my ($table_id) = @_;
  883:     my $sth=$dbh->prepare('SHOW TABLES');
  884:     $sth->execute();
  885:     my $aref = $sth->fetchall_arrayref;
  886:     $sth->finish();
  887:     if ($sth->err()) {
  888:         &logthis("fetchall_arrayref after SHOW TABLES".
  889:             " ERROR: ".$sth->errstr);
  890:         return undef;
  891:     }
  892:     my $result = 0;
  893:     foreach my $table (@{$aref}) {
  894:         if ($table->[0] eq $table_id) { 
  895:             $result = 1;
  896:             last;
  897:         }
  898:     }
  899:     return $result;
  900: }
  901: 
  902: ###########################################
  903: 
  904: sub portfolio_logging {
  905:     my (%portlog) = @_;
  906:     foreach my $key (keys(%portlog)) {
  907:         if (ref($portlog{$key}) eq 'HASH') {
  908:             foreach my $item (keys(%{$portlog{$key}})) {
  909:                 &logthis($portlog{$key}{$item});
  910:             }
  911:         }
  912:     }
  913: }
  914: 
  915: 
  916: ########################################################
  917: ########################################################
  918: 
  919: =pod
  920: 
  921: =item &logthis
  922: 
  923: Inputs: $message, the message to log
  924: 
  925: Returns: nothing
  926: 
  927: Writes $message to the logfile.
  928: 
  929: =cut
  930: 
  931: ########################################################
  932: ########################################################
  933: sub logthis {
  934:     my $message=shift;
  935:     my $execdir=$perlvar{'lonDaemons'};
  936:     open(my $fh,">>$execdir/logs/lonsql.log");
  937:     my $now=time;
  938:     my $local=localtime($now);
  939:     print $fh "$local ($$): $message\n";
  940: }
  941: 
  942: ########################################################
  943: ########################################################
  944: 
  945: =pod
  946: 
  947: =item &ishome
  948: 
  949: Determine if the current machine is the home server for a user.
  950: The determination is made by checking the filesystem for the users information.
  951: 
  952: Inputs: $author
  953: 
  954: Returns: 0 - this is not the authors home server, 1 - this is.
  955: 
  956: =cut
  957: 
  958: ########################################################
  959: ########################################################
  960: sub ishome {
  961:     my $author=shift;
  962:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
  963:     my ($udom,$uname)=split(/\//,$author);
  964:     my $proname=propath($udom,$uname);
  965:     if (-e $proname) {
  966: 	return 1;
  967:     } else {
  968:         return 0;
  969:     }
  970: }
  971: 
  972: ########################################################
  973: ########################################################
  974: 
  975: =pod
  976: 
  977: =item &courselog
  978: 
  979: Inputs: $path, $command
  980: 
  981: Returns: unescaped string of values.
  982: 
  983: =cut
  984: 
  985: ########################################################
  986: ########################################################
  987: sub courselog {
  988:     my ($path,$command)=@_;
  989:     my %filters=();
  990:     foreach (split(/\:/,&unescape($command))) {
  991: 	my ($name,$value)=split(/\=/,$_);
  992:         $filters{$name}=$value;
  993:     }
  994:     my @results=();
  995:     open(IN,$path.'/activity.log') or return ('file_error');
  996:     while (my $line=<IN>) {
  997:         chomp($line);
  998:         my ($timestamp,$host,$log)=split(/\:/,$line);
  999: #
 1000: # $log has the actual log entries; currently still escaped, and
 1001: # %26(timestamp)%3a(url)%3a(user)%3a(domain)
 1002: # then additionally
 1003: # %3aPOST%3a(name)%3d(value)%3a(name)%3d(value)
 1004: # or
 1005: # %3aCSTORE%3a(name)%3d(value)%26(name)%3d(value)
 1006: #
 1007: # get delimiter between timestamped entries to be &&&
 1008:         $log=~s/\%26(\d+)\%3a/\&\&\&$1\%3a/g;
 1009: # now go over all log entries 
 1010:         foreach (split(/\&\&\&/,&unescape($log))) {
 1011: 	    my ($time,$res,$uname,$udom,$action,@values)=split(/\:/,$_);
 1012:             my $values=&unescape(join(':',@values));
 1013:             $values=~s/\&/\:/g;
 1014:             $res=&unescape($res);
 1015:             my $include=1;
 1016:             if (($filters{'username'}) && ($uname ne $filters{'username'})) 
 1017:                                                                { $include=0; }
 1018:             if (($filters{'domain'}) && ($udom ne $filters{'domain'})) 
 1019:                                                                { $include=0; }
 1020:             if (($filters{'url'}) && ($res!~/$filters{'url'}/)) 
 1021:                                                                { $include=0; }
 1022:             if (($filters{'start'}) && ($time<$filters{'start'})) 
 1023:                                                                { $include=0; }
 1024:             if (($filters{'end'}) && ($time>$filters{'end'})) 
 1025:                                                                { $include=0; }
 1026:             if (($filters{'action'} eq 'view') && ($action)) 
 1027:                                                                { $include=0; }
 1028:             if (($filters{'action'} eq 'submit') && ($action ne 'POST')) 
 1029:                                                                { $include=0; }
 1030:             if (($filters{'action'} eq 'grade') && ($action ne 'CSTORE')) 
 1031:                                                                { $include=0; }
 1032:             if ($include) {
 1033: 	       push(@results,($time<1000000000?'0':'').$time.':'.$res.':'.
 1034:                                             $uname.':'.$udom.':'.
 1035:                                             $action.':'.$values);
 1036:             }
 1037:        }
 1038:     }
 1039:     close IN;
 1040:     return join('&',sort(@results));
 1041: }
 1042: 
 1043: ########################################################
 1044: ########################################################
 1045: 
 1046: =pod
 1047: 
 1048: =item &userlog
 1049: 
 1050: Inputs: $path, $command
 1051: 
 1052: Returns: unescaped string of values.
 1053: 
 1054: =cut
 1055: 
 1056: ########################################################
 1057: ########################################################
 1058: sub userlog {
 1059:     my ($path,$command)=@_;
 1060:     my %filters=();
 1061:     foreach (split(/\:/,&unescape($command))) {
 1062: 	my ($name,$value)=split(/\=/,$_);
 1063:         $filters{$name}=$value;
 1064:     }
 1065:     my @results=();
 1066:     open(IN,$path.'/activity.log') or return ('file_error');
 1067:     while (my $line=<IN>) {
 1068:         chomp($line);
 1069:         my ($timestamp,$host,$log)=split(/\:/,$line);
 1070:         $log=&unescape($log);
 1071:         my $include=1;
 1072:         if (($filters{'start'}) && ($timestamp<$filters{'start'})) 
 1073:                                                              { $include=0; }
 1074:         if (($filters{'end'}) && ($timestamp>$filters{'end'})) 
 1075:                                                              { $include=0; }
 1076:         if (($filters{'action'} eq 'Role') && ($log !~/^Role/))
 1077:                                                              { $include=0; }
 1078:         if (($filters{'action'} eq 'log') && ($log!~/^Log/)) { $include=0; }
 1079:         if (($filters{'action'} eq 'check') && ($log!~/^Check/)) 
 1080:                                                              { $include=0; }
 1081:         if ($include) {
 1082: 	   push(@results,$timestamp.':'.$host.':'.&escape($log));
 1083:         }
 1084:     }
 1085:     close IN;
 1086:     return join('&',sort(@results));
 1087: }
 1088: 
 1089: ########################################################
 1090: ########################################################
 1091: 
 1092: =pod
 1093: 
 1094: =item Functions required for forking
 1095: 
 1096: =over 4
 1097: 
 1098: =item REAPER
 1099: 
 1100: REAPER takes care of dead children.
 1101: 
 1102: =item HUNTSMAN
 1103: 
 1104: Signal handler for SIGINT.
 1105: 
 1106: =item HUPSMAN
 1107: 
 1108: Signal handler for SIGHUP
 1109: 
 1110: =item DISCONNECT
 1111: 
 1112: Disconnects from database.
 1113: 
 1114: =back
 1115: 
 1116: =cut
 1117: 
 1118: ########################################################
 1119: ########################################################
 1120: sub REAPER {                   # takes care of dead children
 1121:     $SIG{CHLD} = \&REAPER;
 1122:     my $pid = wait;
 1123:     $children --;
 1124:     &logthis("Child $pid died");
 1125:     delete $children{$pid};
 1126: }
 1127: 
 1128: sub HUNTSMAN {                      # signal handler for SIGINT
 1129:     local($SIG{CHLD}) = 'IGNORE';   # we're going to kill our children
 1130:     kill 'INT' => keys %children;
 1131:     my $execdir=$perlvar{'lonDaemons'};
 1132:     unlink("$execdir/logs/lonsql.pid");
 1133:     &logthis("<font color='red'>CRITICAL: Shutting down</font>");
 1134:     $unixsock = "mysqlsock";
 1135:     my $port="$perlvar{'lonSockDir'}/$unixsock";
 1136:     unlink($port);
 1137:     exit;                           # clean up with dignity
 1138: }
 1139: 
 1140: sub HUPSMAN {                      # signal handler for SIGHUP
 1141:     local($SIG{CHLD}) = 'IGNORE';  # we're going to kill our children
 1142:     kill 'INT' => keys %children;
 1143:     close($server);                # free up socket
 1144:     &logthis("<font color='red'>CRITICAL: Restarting</font>");
 1145:     my $execdir=$perlvar{'lonDaemons'};
 1146:     $unixsock = "mysqlsock";
 1147:     my $port="$perlvar{'lonSockDir'}/$unixsock";
 1148:     unlink($port);
 1149:     exec("$execdir/lonsql");         # here we go again
 1150: }
 1151: 
 1152: sub DISCONNECT {
 1153:     $dbh->disconnect or 
 1154:     &logthis("<font color='blue'>WARNING: Couldn't disconnect from database ".
 1155:              " $DBI::errstr : $@</font>");
 1156:     exit;
 1157: }
 1158: 
 1159: 
 1160: =pod
 1161: 
 1162: =back
 1163: 
 1164: =cut

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