File:  [LON-CAPA] / loncom / lonsql
Revision 1.38: download - view: text, annotated - select for diffs
Wed Nov 28 21:49:27 2001 UTC (22 years, 5 months ago) by harris41
Branches: MAIN
CVS tags: HEAD
email admins if their sql setup is bad -Scott

    1: #!/usr/bin/perl
    2: # lonsql-based on the preforker:harsha jagasia:date:5/10/00
    3: # 7/25 Gerd Kortemeyer
    4: # many different dates Scott Harrison
    5: # 03/22/2001 Scott Harrison
    6: # 8/30 Gerd Kortemeyer
    7: 
    8: use IO::Socket;
    9: use Symbol;
   10: use POSIX;
   11: use IO::Select;
   12: use IO::File;
   13: use Socket;
   14: use Fcntl;
   15: use Tie::RefHash;
   16: use DBI;
   17: 
   18: my @metalist;
   19: # ----------------- Code to enable 'find' subroutine listing of the .meta files
   20: require "find.pl";
   21: sub wanted {
   22:     (($dev,$ino,$mode,$nlink,$uid,$gid) = lstat($_)) &&
   23:     -f _ &&
   24:     /^.*\.meta$/ && !/^.+\.\d+\.[^\.]+\.meta$/ &&
   25:     push(@metalist,"$dir/$_");
   26: }
   27: 
   28: $childmaxattempts=10;
   29: $run =0;#running counter to generate the query-id
   30: 
   31: # ------------------------------------ Read httpd access.conf and get variables
   32: open (CONFIG,"/etc/httpd/conf/access.conf") || die "Can't read access.conf";
   33: 
   34: while ($configline=<CONFIG>) {
   35:     if ($configline =~ /PerlSetVar/) {
   36: 	my ($dummy,$varname,$varvalue)=split(/\s+/,$configline);
   37:         chomp($varvalue);
   38:         $perlvar{$varname}=$varvalue;
   39:     }
   40: }
   41: close(CONFIG);
   42: 
   43: # ------------------------------------- Make sure that database can be accessed
   44: {
   45:     my $dbh;
   46:     unless (
   47: 	    $dbh = DBI->connect("DBI:mysql:loncapa","www",$perlvar{'lonSqlAccess'},{ RaiseError =>0,PrintError=>0})
   48: 	    ) { 
   49: 	print "Cannot connect to database!\n";
   50: 	$emailto="$perlvar{'lonAdmEMail'},$perlvar{'lonSysEMail'}";
   51: 	$subj="LON: $perlvar{'lonHostID'} Cannot connect to database!";
   52: 	system("echo 'Cannot connect to MySQL database!' |\
   53:  mailto $emailto -s '$subj' > /dev/null");
   54: 	exit 1;
   55:     }
   56:     else {
   57: 	$dbh->disconnect;
   58:     }
   59: }
   60: 
   61: # --------------------------------------------- Check if other instance running
   62: 
   63: my $pidfile="$perlvar{'lonDaemons'}/logs/lonsql.pid";
   64: 
   65: if (-e $pidfile) {
   66:    my $lfh=IO::File->new("$pidfile");
   67:    my $pide=<$lfh>;
   68:    chomp($pide);
   69:    if (kill 0 => $pide) { die "already running"; }
   70: }
   71: 
   72: # ------------------------------------------------------------- Read hosts file
   73: $PREFORK=4; # number of children to maintain, at least four spare
   74: 
   75: open (CONFIG,"$perlvar{'lonTabDir'}/hosts.tab") || die "Can't read host file";
   76: 
   77: while ($configline=<CONFIG>) {
   78:     my ($id,$domain,$role,$name,$ip)=split(/:/,$configline);
   79:     chomp($ip);
   80: 
   81:     $hostip{$ip}=$id;
   82:     if ($id eq $perlvar{'lonHostID'}) { $thisserver=$name; }
   83: 
   84:     $PREFORK++;
   85: }
   86: close(CONFIG);
   87: 
   88: $PREFORK=int($PREFORK/4);
   89: 
   90: $unixsock = "mysqlsock";
   91: my $localfile="$perlvar{'lonSockDir'}/$unixsock";
   92: my $server;
   93: unlink ($localfile);
   94: unless ($server=IO::Socket::UNIX->new(Local    =>"$localfile",
   95: 				  Type    => SOCK_STREAM,
   96: 				  Listen => 10))
   97: {
   98:     print "in socket error:$@\n";
   99: }
  100: 
  101: # -------------------------------------------------------- Routines for forking
  102: # global variables
  103: $MAX_CLIENTS_PER_CHILD  = 5;        # number of clients each child should process
  104: %children               = ();       # keys are current child process IDs
  105: $children               = 0;        # current number of children
  106: 
  107: sub REAPER {                        # takes care of dead children
  108:     $SIG{CHLD} = \&REAPER;
  109:     my $pid = wait;
  110:     $children --;
  111:     &logthis("Child $pid died");
  112:     delete $children{$pid};
  113: }
  114: 
  115: sub HUNTSMAN {                      # signal handler for SIGINT
  116:     local($SIG{CHLD}) = 'IGNORE';   # we're going to kill our children
  117:     kill 'INT' => keys %children;
  118:     my $execdir=$perlvar{'lonDaemons'};
  119:     unlink("$execdir/logs/lonsql.pid");
  120:     &logthis("<font color=red>CRITICAL: Shutting down</font>");
  121:     $unixsock = "mysqlsock";
  122:     my $port="$perlvar{'lonSockDir'}/$unixsock";
  123:     unlink(port);
  124:     exit;                           # clean up with dignity
  125: }
  126: 
  127: sub HUPSMAN {                      # signal handler for SIGHUP
  128:     local($SIG{CHLD}) = 'IGNORE';  # we're going to kill our children
  129:     kill 'INT' => keys %children;
  130:     close($server);                # free up socket
  131:     &logthis("<font color=red>CRITICAL: Restarting</font>");
  132:     my $execdir=$perlvar{'lonDaemons'};
  133:     $unixsock = "mysqlsock";
  134:     my $port="$perlvar{'lonSockDir'}/$unixsock";
  135:     unlink(port);
  136:     exec("$execdir/lonsql");         # here we go again
  137: }
  138: 
  139: sub logthis {
  140:     my $message=shift;
  141:     my $execdir=$perlvar{'lonDaemons'};
  142:     my $fh=IO::File->new(">>$execdir/logs/lonsqlfinal.log");
  143:     my $now=time;
  144:     my $local=localtime($now);
  145:     print $fh "$local ($$): $message\n";
  146: }
  147: # ---------------------------------------------------- Fork once and dissociate
  148: $fpid=fork;
  149: exit if $fpid;
  150: die "Couldn't fork: $!" unless defined ($fpid);
  151: 
  152: POSIX::setsid() or die "Can't start new session: $!";
  153: 
  154: # ------------------------------------------------------- Write our PID on disk
  155: 
  156: $execdir=$perlvar{'lonDaemons'};
  157: open (PIDSAVE,">$execdir/logs/lonsql.pid");
  158: print PIDSAVE "$$\n";
  159: close(PIDSAVE);
  160: &logthis("<font color=red>CRITICAL: ---------- Starting ----------</font>");
  161: 
  162: # ----------------------------- Ignore signals generated during initial startup
  163: $SIG{HUP}=$SIG{USR1}='IGNORE';
  164: # ------------------------------------------------------- Now we are on our own    
  165: # Fork off our children.
  166: for (1 .. $PREFORK) {
  167:     make_new_child();
  168: }
  169: 
  170: # Install signal handlers.
  171: $SIG{CHLD} = \&REAPER;
  172: $SIG{INT}  = $SIG{TERM} = \&HUNTSMAN;
  173: $SIG{HUP}  = \&HUPSMAN;
  174: 
  175: # And maintain the population.
  176: while (1) {
  177:     sleep;                          # wait for a signal (i.e., child's death)
  178:     for ($i = $children; $i < $PREFORK; $i++) {
  179:         make_new_child();           # top up the child pool
  180:     }
  181: }
  182: 
  183: 
  184: sub make_new_child {
  185:     my $pid;
  186:     my $sigset;
  187:     
  188:     # block signal for fork
  189:     $sigset = POSIX::SigSet->new(SIGINT);
  190:     sigprocmask(SIG_BLOCK, $sigset)
  191:         or die "Can't block SIGINT for fork: $!\n";
  192:     
  193:     die "fork: $!" unless defined ($pid = fork);
  194:     
  195:     if ($pid) {
  196:         # Parent records the child's birth and returns.
  197:         sigprocmask(SIG_UNBLOCK, $sigset)
  198:             or die "Can't unblock SIGINT for fork: $!\n";
  199:         $children{$pid} = 1;
  200:         $children++;
  201:         return;
  202:     } else {
  203:         # Child can *not* return from this subroutine.
  204:         $SIG{INT} = 'DEFAULT';      # make SIGINT kill us as it did before
  205:     
  206:         # unblock signals
  207:         sigprocmask(SIG_UNBLOCK, $sigset)
  208:             or die "Can't unblock SIGINT for fork: $!\n";
  209: 	
  210: 	
  211:         #open database handle
  212: 	# making dbh global to avoid garbage collector
  213: 	unless (
  214: 		$dbh = DBI->connect("DBI:mysql:loncapa","www",$perlvar{'lonSqlAccess'},{ RaiseError =>0,PrintError=>0})
  215: 		) { 
  216:   	            sleep(10+int(rand(20)));
  217: 		    &logthis("<font color=blue>WARNING: Couldn't connect to database  ($st secs): $@</font>");
  218: 		    print "database handle error\n";
  219: 		    exit;
  220: 
  221: 	  };
  222: 	# make sure that a database disconnection occurs with ending kill signals
  223: 	$SIG{TERM}=$SIG{INT}=$SIG{QUIT}=$SIG{__DIE__}=\&DISCONNECT;
  224: 
  225:         # handle connections until we've reached $MAX_CLIENTS_PER_CHILD
  226:         for ($i=0; $i < $MAX_CLIENTS_PER_CHILD; $i++) {
  227:             $client = $server->accept()     or last;
  228:             
  229:             # do something with the connection
  230: 	    $run = $run+1;
  231: 	    my $userinput = <$client>;
  232: 	    chomp($userinput);
  233: 	    	    
  234: 	    my ($conserver,$querytmp,
  235: 		$customtmp,$customshowtmp)=split(/&/,$userinput);
  236: 	    my $query=unescape($querytmp);
  237: 	    my $custom=unescape($customtmp);
  238: 	    my $customshow=unescape($customshowtmp);
  239: 
  240:             #send query id which is pid_unixdatetime_runningcounter
  241: 	    $queryid = $thisserver;
  242: 	    $queryid .="_".($$)."_";
  243: 	    $queryid .= time."_";
  244: 	    $queryid .= $run;
  245: 	    print $client "$queryid\n";
  246: 	    
  247: 	    &logthis("QUERY: $query");
  248: 	    &logthis("QUERY: $query");
  249: 	    sleep 1;
  250:             #prepare and execute the query
  251: 	    my $sth = $dbh->prepare($query);
  252: 	    my $result;
  253: 	    my @files;
  254: 	    my $subsetflag=0;
  255: 	    if ($query) {
  256: 		unless ($sth->execute())
  257: 		{
  258: 		    &logthis("<font color=blue>WARNING: Could not retrieve from database: $@</font>");
  259: 		    $result="";
  260: 		}
  261: 		else {
  262: 		    my $r1=$sth->fetchall_arrayref;
  263: 		    my @r2;
  264: 		    map {my $a=$_; 
  265: 			 my @b=map {escape($_)} @$a;
  266: 			 push @files,@{$a}[3];
  267: 			 push @r2,join(",", @b)
  268: 			 } (@$r1);
  269: 		    $result=join("&",@r2);
  270: 		}
  271: 	    }
  272: 	    # do custom metadata searching here and build into result
  273: 	    if ($custom or $customshow) {
  274: 		&logthis("am going to do custom query for $custom");
  275: 		if ($query) {
  276: 		    @metalist=map {$perlvar{'lonDocRoot'}.$_.'.meta'} @files;
  277: 		}
  278: 		else {
  279: 		    @metalist=(); pop @metalist;
  280: 		    opendir(RESOURCES,"$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}");
  281: 		    my @homeusers=grep
  282: 		          {&ishome("$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}/$_")}
  283: 		          grep {!/^\.\.?$/} readdir(RESOURCES);
  284: 		    closedir RESOURCES;
  285: 		    foreach my $user (@homeusers) {
  286: 			&find("$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}/$user");
  287: 		    }
  288: 		}
  289: #		&logthis("FILELIST:" . join(":::",@metalist));
  290: 		# if file is indicated in sql database and
  291: 		# not part of sql-relevant query, do not pattern match.
  292: 		# if file is not in sql database, output error.
  293: 		# if file is indicated in sql database and is
  294: 		# part of query result list, then do the pattern match.
  295: 		my $customresult='';
  296: 		my @r2;
  297: 		foreach my $m (@metalist) {
  298: 		    my $fh=IO::File->new($m);
  299: 		    my @lines=<$fh>;
  300: 		    my $stuff=join('',@lines);
  301: 		    if ($stuff=~/$custom/s) {
  302: 			foreach my $f ('abstract','author','copyright',
  303: 				       'creationdate','keywords','language',
  304: 				       'lastrevisiondate','mime','notes',
  305: 				       'owner','subject','title') {
  306: 			    $stuff=~s/\n?\<$f[^\>]*\>.*?<\/$f[^\>]*\>\n?//s;
  307: 			}
  308: 			my $m2=$m; my $docroot=$perlvar{'lonDocRoot'};
  309: 			$m2=~s/^$docroot//;
  310: 			$m2=~s/\.meta$//;
  311: 			unless ($query) {
  312: 			    my $q2="select * from metadata where url like binary '$m2'";
  313: 			    my $sth = $dbh->prepare($q2);
  314: 			    $sth->execute();
  315: 			    my $r1=$sth->fetchall_arrayref;
  316: 			    map {my $a=$_; 
  317: 				 my @b=map {escape($_)} @$a;
  318: 				 push @files,@{$a}[3];
  319: 				 push @r2,join(",", @b)
  320: 				 } (@$r1);
  321: 			}
  322: #			&logthis("found: $stuff");
  323: 			$customresult.='&custom='.escape($m2).','.escape($stuff);
  324: 		    }
  325: 		}
  326: 		$result=join("&",@r2) unless $query;
  327: 		$result.=$customresult;
  328: 	    }
  329: 	    # reply with result
  330: 	    $result.="\n" if $result;
  331:             &reply("queryreply:$queryid:$result",$conserver);
  332: 
  333:         }
  334:     
  335:         # tidy up gracefully and finish
  336: 	
  337:         #close the database handle
  338: 	$dbh->disconnect
  339: 	   or &logthis("<font color=blue>WARNING: Couldn't disconnect from database  $DBI::errstr ($st secs): $@</font>");
  340:     
  341:         # this exit is VERY important, otherwise the child will become
  342:         # a producer of more and more children, forking yourself into
  343:         # process death.
  344:         exit;
  345:     }
  346: }
  347: 
  348: sub DISCONNECT {
  349:     $dbh->disconnect or 
  350:     &logthis("<font color=blue>WARNING: Couldn't disconnect from database  $DBI::errstr ($st secs): $@</font>");
  351:     exit;
  352: }
  353: 
  354: # -------------------------------------------------- Non-critical communication
  355: 
  356: sub subreply {
  357:     my ($cmd,$server)=@_;
  358:     my $peerfile="$perlvar{'lonSockDir'}/$server";
  359:     my $sclient=IO::Socket::UNIX->new(Peer    =>"$peerfile",
  360:                                       Type    => SOCK_STREAM,
  361:                                       Timeout => 10)
  362:        or return "con_lost";
  363:     print $sclient "$cmd\n";
  364:     my $answer=<$sclient>;
  365:     chomp($answer);
  366:     if (!$answer) { $answer="con_lost"; }
  367:     return $answer;
  368: }
  369: 
  370: sub reply {
  371:   my ($cmd,$server)=@_;
  372:   my $answer;
  373:   if ($server ne $perlvar{'lonHostID'}) { 
  374:     $answer=subreply($cmd,$server);
  375:     if ($answer eq 'con_lost') {
  376: 	$answer=subreply("ping",$server);
  377:         $answer=subreply($cmd,$server);
  378:     }
  379:   } else {
  380:     $answer='self_reply';
  381:     $answer=subreply($cmd,$server);
  382:   } 
  383:   return $answer;
  384: }
  385: 
  386: # -------------------------------------------------------- Escape Special Chars
  387: 
  388: sub escape {
  389:     my $str=shift;
  390:     $str =~ s/(\W)/"%".unpack('H2',$1)/eg;
  391:     return $str;
  392: }
  393: 
  394: # ----------------------------------------------------- Un-Escape Special Chars
  395: 
  396: sub unescape {
  397:     my $str=shift;
  398:     $str =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
  399:     return $str;
  400: }
  401: 
  402: # --------------------------------------- Is this the home server of an author?
  403: # (copied from lond, modification of the return value)
  404: sub ishome {
  405:     my $author=shift;
  406:     $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
  407:     my ($udom,$uname)=split(/\//,$author);
  408:     my $proname=propath($udom,$uname);
  409:     if (-e $proname) {
  410: 	return 1;
  411:     } else {
  412:         return 0;
  413:     }
  414: }
  415: 
  416: # -------------------------------------------- Return path to profile directory
  417: # (copied from lond)
  418: sub propath {
  419:     my ($udom,$uname)=@_;
  420:     $udom=~s/\W//g;
  421:     $uname=~s/\W//g;
  422:     my $subdir=$uname.'__';
  423:     $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
  424:     my $proname="$perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
  425:     return $proname;
  426: } 

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