Annotation of loncom/lonsql, revision 1.92
1.1 harris41 1: #!/usr/bin/perl
1.39 harris41 2:
3: # The LearningOnline Network
1.40 harris41 4: # lonsql - LON TCP-MySQL-Server Daemon for handling database requests.
1.39 harris41 5: #
1.92 ! raeburn 6: # $Id: lonsql,v 1.91 2011/11/07 18:13:38 raeburn Exp $
1.41 harris41 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: #
1.51 matthew 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:
1.56 bowersj2 42: =head1 OVERVIEW
1.51 matthew 43:
1.56 bowersj2 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.
1.51 matthew 95:
96: =head1 Internals
97:
98: =over 4
99:
100: =cut
101:
102: use strict;
1.36 www 103:
1.42 harris41 104: use lib '/home/httpd/lib/perl/';
1.77 albertel 105: use LONCAPA;
1.42 harris41 106: use LONCAPA::Configuration;
1.58 matthew 107: use LONCAPA::lonmetadata();
1.81 albertel 108: use Apache::lonnet;
1.42 harris41 109:
1.2 harris41 110: use IO::Socket;
111: use Symbol;
1.1 harris41 112: use POSIX;
113: use IO::Select;
114: use DBI;
1.51 matthew 115: use File::Find;
1.62 raeburn 116: use localenroll;
1.78 raeburn 117: use GDBM_File;
1.51 matthew 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
1.1 harris41 144:
1.51 matthew 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
1.9 harris41 162:
1.51 matthew 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
1.45 www 177:
1.51 matthew 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: #
1.81 albertel 205: my %perlvar=%{&LONCAPA::Configuration::read_conf('loncapa.conf')};
1.51 matthew 206: #
1.63 matthew 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: #
1.51 matthew 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");
1.57 www 235:
1.91 raeburn 236: open(SMP,">$perlvar{'lonDocRoot'}/lon-status/mysql.txt");
1.57 www 237: print SMP 'time='.time.'&mysql=defunct'."\n";
238: close(SMP);
239:
1.51 matthew 240: exit 1;
241: } else {
1.91 raeburn 242: unlink("$perlvar{'lonDocRoot'}/lon-status/mysql.txt");
1.51 matthew 243: $dbh->disconnect;
244: }
1.52 matthew 245:
1.51 matthew 246: #
247: # Check if other instance running
248: #
249: my $pidfile="$perlvar{'lonDaemons'}/logs/lonsql.pid";
250: if (-e $pidfile) {
1.81 albertel 251: open(my $lfh,"$pidfile");
1.51 matthew 252: my $pide=<$lfh>;
253: chomp($pide);
254: if (kill 0 => $pide) { die "already running"; }
255: }
1.52 matthew 256:
1.51 matthew 257: my $PREFORK=4; # number of children to maintain, at least four spare
258: #
1.65 albertel 259: #$PREFORK=int($PREFORK/4);
1.52 matthew 260:
1.51 matthew 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";
1.45 www 272: }
1.52 matthew 273:
1.51 matthew 274: #
275: # Fork once and dissociate
1.52 matthew 276: #
1.51 matthew 277: my $fpid=fork;
1.1 harris41 278: exit if $fpid;
279: die "Couldn't fork: $!" unless defined ($fpid);
280: POSIX::setsid() or die "Can't start new session: $!";
1.52 matthew 281:
1.51 matthew 282: #
283: # Write our PID on disk
284: my $execdir=$perlvar{'lonDaemons'};
1.1 harris41 285: open (PIDSAVE,">$execdir/logs/lonsql.pid");
286: print PIDSAVE "$$\n";
287: close(PIDSAVE);
1.59 albertel 288: &logthis("<font color='red'>CRITICAL: ---------- Starting ----------</font>");
1.52 matthew 289:
1.51 matthew 290: #
291: # Ignore signals generated during initial startup
1.1 harris41 292: $SIG{HUP}=$SIG{USR1}='IGNORE';
1.51 matthew 293: # Now we are on our own
294: # Fork off our children.
1.2 harris41 295: for (1 .. $PREFORK) {
296: make_new_child();
1.1 harris41 297: }
1.52 matthew 298:
1.51 matthew 299: #
1.2 harris41 300: # Install signal handlers.
1.1 harris41 301: $SIG{CHLD} = \&REAPER;
302: $SIG{INT} = $SIG{TERM} = \&HUNTSMAN;
303: $SIG{HUP} = \&HUPSMAN;
1.52 matthew 304:
1.51 matthew 305: #
1.1 harris41 306: # And maintain the population.
307: while (1) {
308: sleep; # wait for a signal (i.e., child's death)
1.51 matthew 309: for (my $i = $children; $i < $PREFORK; $i++) {
1.2 harris41 310: make_new_child(); # top up the child pool
1.1 harris41 311: }
312: }
313:
1.51 matthew 314: ########################################################
315: ########################################################
316:
317: =pod
318:
319: =item &make_new_child
320:
321: Inputs: None
322:
323: Returns: None
324:
325: =cut
1.2 harris41 326:
1.51 matthew 327: ########################################################
328: ########################################################
1.1 harris41 329: sub make_new_child {
330: my $pid;
331: my $sigset;
1.51 matthew 332: #
1.1 harris41 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";
1.51 matthew 337: #
1.2 harris41 338: die "fork: $!" unless defined ($pid = fork);
1.51 matthew 339: #
1.1 harris41 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 {
1.2 harris41 348: # Child can *not* return from this subroutine.
1.1 harris41 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";
1.2 harris41 353: #open database handle
354: # making dbh global to avoid garbage collector
1.51 matthew 355: unless ($dbh = DBI->connect("DBI:mysql:loncapa","www",
356: $perlvar{'lonSqlAccess'},
357: { RaiseError =>0,PrintError=>0})) {
358: sleep(10+int(rand(20)));
1.59 albertel 359: &logthis("<font color='blue'>WARNING: Couldn't connect to database".
1.51 matthew 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
1.2 harris41 367: $SIG{TERM}=$SIG{INT}=$SIG{QUIT}=$SIG{__DIE__}=\&DISCONNECT;
1.1 harris41 368: # handle connections until we've reached $MAX_CLIENTS_PER_CHILD
1.51 matthew 369: for (my $i=0; $i < $MAX_CLIENTS_PER_CHILD; $i++) {
370: my $client = $server->accept() or last;
1.2 harris41 371: # do something with the connection
1.1 harris41 372: $run = $run+1;
1.2 harris41 373: my $userinput = <$client>;
374: chomp($userinput);
1.83 albertel 375: $userinput=~s/\:($LONCAPA::domain_re)$//;
1.73 www 376: my $searchdomain=$1;
1.51 matthew 377: #
1.45 www 378: my ($conserver,$query,
379: $arg1,$arg2,$arg3)=split(/&/,$userinput);
380: my $query=unescape($query);
1.51 matthew 381: #
1.2 harris41 382: #send query id which is pid_unixdatetime_runningcounter
1.81 albertel 383: my $queryid = &Apache::lonnet::hostname($perlvar{'lonHostID'});
1.2 harris41 384: $queryid .="_".($$)."_";
385: $queryid .= time."_";
386: $queryid .= $run;
387: print $client "$queryid\n";
1.51 matthew 388: #
1.81 albertel 389: # &logthis("QUERY: $query - $arg1 - $arg2 - $arg3 - $queryid");
1.84 albertel 390: # sleep 1;
1.51 matthew 391: #
1.45 www 392: my $result='';
1.51 matthew 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: }
1.80 raeburn 409: $result = &escape($result);
1.51 matthew 410: } else {
411: &logthis('Unable to do log query: '.$uname.'@'.$udom);
412: $result='no_such_file';
413: }
414: # end of log query
1.70 raeburn 415: } elsif (($query eq 'fetchenrollment') ||
1.71 albertel 416: ($query eq 'institutionalphotos')) {
1.62 raeburn 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) {
1.68 raeburn 424: if (/^([^=]+)=([^=]+)$/) {
1.62 raeburn 425: @{$affiliates{$1}} = split/,/,$2;
426: }
427: }
1.70 raeburn 428: if ($query eq 'fetchenrollment') {
429: $locresult = &localenroll::fetch_enrollment($dom,\%affiliates,\%replies);
430: } elsif ($query eq 'institutionalphotos') {
431: my $crs = &unescape($arg2);
1.75 albertel 432: eval {
433: local($SIG{__DIE__})='DEFAULT';
434: $locresult = &localenroll::institutional_photos($dom,$crs,\%affiliates,\%replies,'update');
435: };
436: if ($@) {
437: $locresult = 'error';
438: }
1.70 raeburn 439: }
1.62 raeburn 440: $result = &escape($locresult.':');
441: if ($locresult) {
442: $result .= &escape(join(':',map{$_.'='.$replies{$_}} keys %replies));
443: }
1.82 raeburn 444: } elsif ($query eq 'usersearch') {
1.88 raeburn 445: my ($srchby,$srchtype,$srchterm);
446: if ((&unescape($arg1) eq $searchdomain) &&
447: ($arg2 =~ /\%\%/)) {
448: ($srchby,$srchtype) =
449: map {&unescape($_);} (split(/\%\%/,$arg2));
1.90 raeburn 450: $srchterm = &unescape($arg3);
1.82 raeburn 451: } else {
1.88 raeburn 452: ($srchby,$srchtype,$srchterm) =
453: map {&unescape($_);} ($arg1,$arg2,$arg3);
1.82 raeburn 454: }
1.88 raeburn 455: $result = &do_user_search($searchdomain,$srchby,
456: $srchtype,$srchterm);
1.84 albertel 457: } elsif ($query eq 'instdirsearch') {
458: $result = &do_inst_dir_search($searchdomain,$arg1,$arg2,$arg3);
1.89 raeburn 459: } elsif ($query eq 'getinstuser') {
460: $result = &get_inst_user($searchdomain,$arg1,$arg2);
1.63 matthew 461: } elsif ($query eq 'prepare activity log') {
462: my ($cid,$domain) = map {&unescape($_);} ($arg1,$arg2);
1.64 matthew 463: &logthis('preparing activity log tables for '.$cid);
1.63 matthew 464: my $command =
1.64 matthew 465: qq{$perlvar{'lonDaemons'}/parse_activity_log.pl -course=$cid -domain=$domain};
1.63 matthew 466: system($command);
1.64 matthew 467: &logthis($command);
1.63 matthew 468: my $returnvalue = $?>>8;
469: if ($returnvalue) {
470: $result = 'error: parse_activity_log.pl returned '.
471: $returnvalue;
472: } else {
473: $result = 'success';
474: }
1.78 raeburn 475: } elsif (($query eq 'portfolio_metadata') ||
476: ($query eq 'portfolio_access')) {
477: $result = &portfolio_table_update($query,$arg1,$arg2,
478: $arg3);
1.82 raeburn 479: } elsif ($query eq 'allusers') {
480: my ($uname,$udom) = map {&unescape($_);} ($arg1,$arg2);
481: my %userdata;
482: my (@data) = split(/\%\%/,$arg3);
483: foreach my $item (@data) {
484: my ($key,$value) = split(/=/,$item);
485: $userdata{$key} = &unescape($value);
486: }
487: $userdata{'username'} = $uname;
488: $userdata{'domain'} = $udom;
489: $result = &allusers_table_update($query,$uname,$udom,\%userdata);
1.51 matthew 490: } else {
491: # Do an sql query
1.92 ! raeburn 492: $result = &do_sql_query($query,$arg1,$arg2,$arg3,$searchdomain);
1.51 matthew 493: }
1.50 matthew 494: # result does not need to be escaped because it has already been
495: # escaped.
496: #$result=&escape($result);
1.81 albertel 497: &Apache::lonnet::reply("queryreply:$queryid:$result",$conserver);
1.1 harris41 498: }
499: # tidy up gracefully and finish
1.51 matthew 500: #
501: # close the database handle
1.2 harris41 502: $dbh->disconnect
1.59 albertel 503: or &logthis("<font color='blue'>WARNING: Couldn't disconnect".
1.51 matthew 504: " from database $DBI::errstr : $@</font>");
1.1 harris41 505: # this exit is VERY important, otherwise the child will become
506: # a producer of more and more children, forking yourself into
507: # process death.
508: exit;
509: }
1.2 harris41 510: }
1.1 harris41 511:
1.88 raeburn 512: sub do_user_search {
513: my ($domain,$srchby,$srchtype,$srchterm) = @_;
514: my $result;
515: my $quoted_dom = $dbh->quote( $domain );
516: my ($query,$quoted_srchterm,@fields);
517: my ($table_columns,$table_indices) =
518: &LONCAPA::lonmetadata::describe_metadata_storage('allusers');
519: foreach my $coldata (@{$table_columns}) {
520: push(@fields,$coldata->{'name'});
521: }
522: my $fieldlist = join(',',@fields);
523: $query = "SELECT $fieldlist FROM allusers WHERE (domain = $quoted_dom AND ";
524: if ($srchby eq 'lastfirst') {
525: my ($fraglast,$fragfirst) = split(/,/,$srchterm);
526: $fragfirst =~ s/^\s+//;
527: $fraglast =~ s/\s+$//;
528: if ($srchtype eq 'exact') {
529: $query .= 'lastname = '.$dbh->quote($fraglast).
530: ' AND firstname = '.$dbh->quote($fragfirst);
531: } elsif ($srchtype eq 'begins') {
532: $query .= 'lastname LIKE '.$dbh->quote($fraglast.'%').
533: ' AND firstname LIKE '.$dbh->quote($fragfirst.'%');
534: } else {
535: $query .= 'lastname LIKE '.$dbh->quote('%'.$fraglast.'%').
536: ' AND firstname LIKE '.$dbh->quote('%'.$fragfirst.'%');
537: }
538: } else {
539: my %srchfield = (
540: uname => 'username',
541: lastname => 'lastname',
542: );
543: if ($srchtype eq 'exact') {
544: $query .= $srchfield{$srchby}.' = '.$dbh->quote($srchterm);
545: } elsif ($srchtype eq 'begins') {
546: $query .= $srchfield{$srchby}.' LIKE '.$dbh->quote($srchterm.'%');
547: } else {
548: $query .= $srchfield{$srchby}.' LIKE '.$dbh->quote('%'.$srchterm.'%');
549: }
550: }
551: $query .= ") ORDER BY username ";
552: my $sth = $dbh->prepare($query);
553: if ($sth->execute()) {
554: my @results;
555: while (my @row = $sth->fetchrow_array) {
556: my @items;
557: for (my $i=0; $i<@row; $i++) {
558: push(@items,&escape($fields[$i]).'='.&escape($row[$i]));
559: }
560: my $userstr = join(':', @items);
561: push(@results,&escape($userstr));
562: }
563: $sth->finish;
564: $result = join('&',@results);
565: } else {
566: &logthis('<font color="blue">'.
567: 'WARNING: Could not retrieve from database:'.
568: $sth->errstr().'</font>');
569: }
570: return $result;
571: }
572:
1.84 albertel 573: sub do_inst_dir_search {
574: my ($domain,$srchby,$srchterm,$srchtype) = @_;
575: $srchby = &unescape($srchby);
576: $srchterm = &unescape($srchterm);
577: $srchtype = &unescape($srchtype);
578: my (%instusers,%instids,$result,$response);
579: eval {
580: local($SIG{__DIE__})='DEFAULT';
581: $result=&localenroll::get_userinfo($domain,undef,undef,\%instusers,
582: \%instids,undef,$srchby,$srchterm,
583: $srchtype);
584: };
585: if ($result eq 'ok') {
586: if (%instusers) {
587: foreach my $key (keys(%instusers)) {
588: my $usrstr = &Apache::lonnet::freeze_escape($instusers{$key});
589: $response .=&escape(&escape($key).'='.$usrstr).'&';
590: }
591: }
592: $response=~s/\&$//;
1.87 raeburn 593: } else {
594: $response = 'unavailable';
1.84 albertel 595: }
596: return $response;
597: }
598:
1.89 raeburn 599: sub get_inst_user {
600: my ($domain,$uname,$id) = @_;
601: $uname = &unescape($uname);
602: $id = &unescape($id);
603: my (%instusers,%instids,$result,$response);
604: eval {
605: local($SIG{__DIE__})='DEFAULT';
606: $result=&localenroll::get_userinfo($domain,$uname,$id,\%instusers,
607: \%instids);
608: };
609: if ($result eq 'ok') {
610: if (keys(%instusers) > 0) {
611: foreach my $key (keys(%instusers)) {
612: my $usrstr = &Apache::lonnet::freeze_escape($instusers{$key});
613: $response .= &escape(&escape($key).'='.$usrstr).'&';
614: }
615: }
616: $response=~s/\&$//;
617: } else {
618: $response = 'unavailable';
619: }
620: return $response;
621: }
622:
1.51 matthew 623: ########################################################
624: ########################################################
625:
626: =pod
627:
628: =item &do_sql_query
629:
630: Runs an sql metadata table query.
631:
632: Inputs: $query, $custom, $customshow
633:
634: Returns: A string containing escaped results.
635:
636: =cut
637:
638: ########################################################
639: ########################################################
640: {
641: my @metalist;
642:
643: sub process_file {
644: if ( -e $_ && # file exists
645: -f $_ && # and is a normal file
646: /\.meta$/ && # ends in meta
647: ! /^.+\.\d+\.[^\.]+\.meta$/ # is not a previous version
648: ) {
649: push(@metalist,$File::Find::name);
650: }
651: }
652:
653: sub do_sql_query {
1.92 ! raeburn 654: my ($query,$custom,$customshow,$domainstr,$searchdomain) = @_;
1.74 www 655:
656: #
657: # limit to searchdomain if given and table is metadata
658: #
1.92 ! raeburn 659: if ($domainstr && ($query=~/FROM metadata/)) {
! 660: my $havingstr;
! 661: $domainstr = &unescape($domainstr);
! 662: if ($domainstr =~ /,/) {
! 663: foreach my $dom (split(/,/,$domainstr)) {
! 664: if ($dom =~ /^$LONCAPA::domain_re$/) {
! 665: $havingstr .= 'domain="'.$dom.'" OR ';
! 666: }
! 667: }
! 668: $havingstr =~ s/ OR $//;
! 669: } else {
! 670: if ($domainstr =~ /^$LONCAPA::domain_re$/) {
! 671: $havingstr = 'domain="'.$domainstr.'"';
! 672: }
! 673: }
! 674: if ($havingstr) {
! 675: $query.=' HAVING ('.$havingstr.')';
! 676: }
! 677: } elsif (($searchdomain) && ($query=~/FROM metadata/)) {
1.74 www 678: $query.=' HAVING (domain="'.$searchdomain.'")';
679: }
680: # &logthis('doing query ('.$searchdomain.')'.$query);
681:
682:
683:
1.51 matthew 684: $custom = &unescape($custom);
685: $customshow = &unescape($customshow);
686: #
687: @metalist = ();
688: #
689: my $result = '';
690: my @results = ();
691: my @files;
692: my $subsetflag=0;
693: #
694: if ($query) {
695: #prepare and execute the query
696: my $sth = $dbh->prepare($query);
697: unless ($sth->execute()) {
1.59 albertel 698: &logthis('<font color="blue">'.
1.58 matthew 699: 'WARNING: Could not retrieve from database:'.
700: $sth->errstr().'</font>');
1.51 matthew 701: } else {
702: my $aref=$sth->fetchall_arrayref;
703: foreach my $row (@$aref) {
704: push @files,@{$row}[3] if ($custom or $customshow);
705: my @b=map { &escape($_); } @$row;
706: push @results,join(",", @b);
707: # Build up the @files array with the LON-CAPA urls
708: # of the resources.
709: }
710: }
711: }
712: # do custom metadata searching here and build into result
713: return join("&",@results) if (! ($custom or $customshow));
714: # Only get here if there is a custom query or custom show request
715: &logthis("Doing custom query for $custom");
716: if ($query) {
717: @metalist=map {
718: $perlvar{'lonDocRoot'}.$_.'.meta';
719: } @files;
720: } else {
721: my $dir = "$perlvar{'lonDocRoot'}/res/$perlvar{'lonDefDomain'}";
722: @metalist=();
723: opendir(RESOURCES,$dir);
724: my @homeusers=grep {
725: &ishome($dir.'/'.$_);
726: } grep {!/^\.\.?$/} readdir(RESOURCES);
727: closedir RESOURCES;
728: # Define the
729: foreach my $user (@homeusers) {
730: find (\&process_file,$dir.'/'.$user);
731: }
732: }
733: # if file is indicated in sql database and
734: # not part of sql-relevant query, do not pattern match.
735: #
736: # if file is not in sql database, output error.
737: #
738: # if file is indicated in sql database and is
739: # part of query result list, then do the pattern match.
740: my $customresult='';
741: my @results;
742: foreach my $metafile (@metalist) {
1.81 albertel 743: open(my $fh,$metafile);
1.51 matthew 744: my @lines=<$fh>;
745: my $stuff=join('',@lines);
746: if ($stuff=~/$custom/s) {
747: foreach my $f ('abstract','author','copyright',
748: 'creationdate','keywords','language',
749: 'lastrevisiondate','mime','notes',
750: 'owner','subject','title') {
751: $stuff=~s/\n?\<$f[^\>]*\>.*?<\/$f[^\>]*\>\n?//s;
752: }
753: my $mfile=$metafile;
754: my $docroot=$perlvar{'lonDocRoot'};
755: $mfile=~s/^$docroot//;
756: $mfile=~s/\.meta$//;
757: unless ($query) {
758: my $q2="SELECT * FROM metadata WHERE url ".
759: " LIKE BINARY '?'";
760: my $sth = $dbh->prepare($q2);
761: $sth->execute($mfile);
762: my $aref=$sth->fetchall_arrayref;
763: foreach my $a (@$aref) {
764: my @b=map { &escape($_)} @$a;
765: push @results,join(",", @b);
766: }
767: }
768: # &logthis("found: $stuff");
769: $customresult.='&custom='.&escape($mfile).','.
770: escape($stuff);
771: }
772: }
773: $result=join("&",@results) unless $query;
774: $result.=$customresult;
775: #
776: return $result;
777: } # End of &do_sql_query
778:
779: } # End of scoping curly braces for &process_file and &do_sql_query
1.78 raeburn 780:
781: sub portfolio_table_update {
782: my ($query,$arg1,$arg2,$arg3) = @_;
783: my %tablenames = (
784: 'portfolio' => 'portfolio_metadata',
785: 'access' => 'portfolio_access',
786: 'addedfields' => 'portfolio_addedfields',
787: );
788: my $result = 'ok';
789: my $tablechk = &check_table($query);
790: if ($tablechk == 0) {
791: my $request =
792: &LONCAPA::lonmetadata::create_metadata_storage($query,$query);
793: $dbh->do($request);
794: if ($dbh->err) {
795: &logthis("create $query".
796: " ERROR: ".$dbh->errstr);
797: $result = 'error';
798: }
799: }
800: if ($result eq 'ok') {
1.79 raeburn 801: my ($uname,$udom,$group) = split(/:/,&unescape($arg1));
1.78 raeburn 802: my $file_name = &unescape($arg2);
1.79 raeburn 803: my $action = $arg3;
1.78 raeburn 804: my $is_course = 0;
805: if ($group ne '') {
806: $is_course = 1;
807: }
808: my $urlstart = '/uploaded/'.$udom.'/'.$uname;
809: my $pathstart = &propath($udom,$uname).'/userfiles';
810: my ($fullpath,$url);
811: if ($is_course) {
812: $fullpath = $pathstart.'/groups/'.$group.'/portfolio'.
813: $file_name;
814: $url = $urlstart.'/groups/'.$group.'/portfolio'.$file_name;
815: } else {
816: $fullpath = $pathstart.'/portfolio'.$file_name;
817: $url = $urlstart.'/portfolio'.$file_name;
818: }
819: if ($query eq 'portfolio_metadata') {
1.79 raeburn 820: if ($action eq 'delete') {
821: my %loghash = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,\%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group,'update');
822: } elsif (-e $fullpath.'.meta') {
1.78 raeburn 823: my %loghash = &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,\%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group,'update');
824: if (keys(%loghash) > 0) {
825: &portfolio_logging(%loghash);
826: }
827: }
828: } elsif ($query eq 'portfolio_access') {
1.79 raeburn 829: my %access = &get_access_hash($uname,$udom,$group.$file_name);
1.78 raeburn 830: my %loghash =
831: &LONCAPA::lonmetadata::process_portfolio_access_data($dbh,undef,
832: \%tablenames,$url,$fullpath,\%access,'update');
833: if (keys(%loghash) > 0) {
834: &portfolio_logging(%loghash);
835: } else {
836: my $available = 0;
837: foreach my $key (keys(%access)) {
838: my ($num,$scope,$end,$start) =
839: ($key =~ /^([^:]+):([a-z]+)_(\d*)_?(\d*)$/);
840: if ($scope eq 'public' || $scope eq 'guest') {
841: $available = 1;
842: last;
843: }
844: }
845: if ($available) {
846: # Retrieve current values
847: my $condition = 'url='.$dbh->quote("$url");
848: my ($error,$row) =
849: &LONCAPA::lonmetadata::lookup_metadata($dbh,$condition,undef,
850: 'portfolio_metadata');
851: if (!$error) {
852: if (!(ref($row->[0]) eq 'ARRAY')) {
853: my %loghash =
854: &LONCAPA::lonmetadata::process_portfolio_metadata($dbh,undef,
855: \%tablenames,$url,$fullpath,$is_course,$udom,$uname,$group);
856: if (keys(%loghash) > 0) {
857: &portfolio_logging(%loghash);
858: }
859: }
860: }
861: }
862: }
863: }
864: }
865: return $result;
866: }
867:
868: sub get_access_hash {
869: my ($uname,$udom,$file) = @_;
870: my $hashref = &tie_user_hash($udom,$uname,'file_permissions',
871: &GDBM_READER());
872: my %curr_perms;
873: my %access;
874: if ($hashref) {
875: while (my ($key,$value) = each(%$hashref)) {
876: $key = &unescape($key);
877: next if ($key =~ /^error: 2 /);
1.81 albertel 878: $curr_perms{$key}=&Apache::lonnet::thaw_unescape($value);
1.78 raeburn 879: }
880: if (!&untie_user_hash($hashref)) {
881: &logthis("error: ".($!+0)." untie (GDBM) Failed");
882: }
883: } else {
884: &logthis("error: ".($!+0)." tie (GDBM) Failed");
885: }
886: if (keys(%curr_perms) > 0) {
887: if (ref($curr_perms{$file."\0".'accesscontrol'}) eq 'HASH') {
888: foreach my $acl (keys(%{$curr_perms{$file."\0".'accesscontrol'}})) {
889: $access{$acl} = $curr_perms{$file."\0".$acl};
890: }
891: }
892: }
893: return %access;
894: }
895:
1.82 raeburn 896: sub allusers_table_update {
897: my ($query,$uname,$udom,$userdata) = @_;
898: my %tablenames = (
899: 'allusers' => 'allusers',
900: );
901: my $result = 'ok';
902: my $tablechk = &check_table($query);
903: if ($tablechk == 0) {
904: my $request =
905: &LONCAPA::lonmetadata::create_metadata_storage($query,$query);
906: $dbh->do($request);
907: if ($dbh->err) {
908: &logthis("create $query".
909: " ERROR: ".$dbh->errstr);
910: $result = 'error';
911: }
912: }
913: if ($result eq 'ok') {
914: my %loghash =
915: &LONCAPA::lonmetadata::process_allusers_data($dbh,undef,
916: \%tablenames,$uname,$udom,$userdata,'update');
917: foreach my $key (keys(%loghash)) {
918: &logthis($loghash{$key});
919: }
920: }
921: return $result;
922: }
923:
1.78 raeburn 924: ###########################################
925: sub check_table {
926: my ($table_id) = @_;
927: my $sth=$dbh->prepare('SHOW TABLES');
928: $sth->execute();
929: my $aref = $sth->fetchall_arrayref;
930: $sth->finish();
931: if ($sth->err()) {
932: &logthis("fetchall_arrayref after SHOW TABLES".
933: " ERROR: ".$sth->errstr);
934: return undef;
935: }
936: my $result = 0;
937: foreach my $table (@{$aref}) {
938: if ($table->[0] eq $table_id) {
939: $result = 1;
940: last;
941: }
942: }
943: return $result;
944: }
945:
946: ###########################################
947:
948: sub portfolio_logging {
949: my (%portlog) = @_;
950: foreach my $key (keys(%portlog)) {
951: if (ref($portlog{$key}) eq 'HASH') {
952: foreach my $item (keys(%{$portlog{$key}})) {
953: &logthis($portlog{$key}{$item});
954: }
955: }
956: }
957: }
958:
959:
1.51 matthew 960: ########################################################
961: ########################################################
962:
963: =pod
964:
965: =item &logthis
966:
967: Inputs: $message, the message to log
968:
969: Returns: nothing
970:
971: Writes $message to the logfile.
972:
973: =cut
974:
975: ########################################################
976: ########################################################
977: sub logthis {
978: my $message=shift;
979: my $execdir=$perlvar{'lonDaemons'};
1.81 albertel 980: open(my $fh,">>$execdir/logs/lonsql.log");
1.51 matthew 981: my $now=time;
982: my $local=localtime($now);
983: print $fh "$local ($$): $message\n";
1.2 harris41 984: }
1.1 harris41 985:
1.51 matthew 986: ########################################################
987: ########################################################
988:
989: =pod
990:
991: =item &ishome
992:
993: Determine if the current machine is the home server for a user.
994: The determination is made by checking the filesystem for the users information.
995:
996: Inputs: $author
997:
998: Returns: 0 - this is not the authors home server, 1 - this is.
999:
1000: =cut
1001:
1002: ########################################################
1003: ########################################################
1.34 harris41 1004: sub ishome {
1005: my $author=shift;
1006: $author=~s/\/home\/httpd\/html\/res\/([^\/]*)\/([^\/]*).*/$1\/$2/;
1007: my ($udom,$uname)=split(/\//,$author);
1008: my $proname=propath($udom,$uname);
1009: if (-e $proname) {
1010: return 1;
1011: } else {
1012: return 0;
1013: }
1014: }
1015:
1.51 matthew 1016: ########################################################
1017: ########################################################
1018:
1019: =pod
1020:
1021: =item &courselog
1022:
1023: Inputs: $path, $command
1024:
1025: Returns: unescaped string of values.
1026:
1027: =cut
1028:
1029: ########################################################
1030: ########################################################
1031: sub courselog {
1032: my ($path,$command)=@_;
1033: my %filters=();
1034: foreach (split(/\:/,&unescape($command))) {
1035: my ($name,$value)=split(/\=/,$_);
1036: $filters{$name}=$value;
1037: }
1038: my @results=();
1039: open(IN,$path.'/activity.log') or return ('file_error');
1040: while (my $line=<IN>) {
1041: chomp($line);
1042: my ($timestamp,$host,$log)=split(/\:/,$line);
1043: #
1044: # $log has the actual log entries; currently still escaped, and
1045: # %26(timestamp)%3a(url)%3a(user)%3a(domain)
1046: # then additionally
1047: # %3aPOST%3a(name)%3d(value)%3a(name)%3d(value)
1048: # or
1049: # %3aCSTORE%3a(name)%3d(value)%26(name)%3d(value)
1050: #
1051: # get delimiter between timestamped entries to be &&&
1052: $log=~s/\%26(\d+)\%3a/\&\&\&$1\%3a/g;
1053: # now go over all log entries
1054: foreach (split(/\&\&\&/,&unescape($log))) {
1055: my ($time,$res,$uname,$udom,$action,@values)=split(/\:/,$_);
1056: my $values=&unescape(join(':',@values));
1057: $values=~s/\&/\:/g;
1058: $res=&unescape($res);
1059: my $include=1;
1060: if (($filters{'username'}) && ($uname ne $filters{'username'}))
1061: { $include=0; }
1062: if (($filters{'domain'}) && ($udom ne $filters{'domain'}))
1063: { $include=0; }
1064: if (($filters{'url'}) && ($res!~/$filters{'url'}/))
1065: { $include=0; }
1066: if (($filters{'start'}) && ($time<$filters{'start'}))
1067: { $include=0; }
1068: if (($filters{'end'}) && ($time>$filters{'end'}))
1069: { $include=0; }
1070: if (($filters{'action'} eq 'view') && ($action))
1071: { $include=0; }
1072: if (($filters{'action'} eq 'submit') && ($action ne 'POST'))
1073: { $include=0; }
1074: if (($filters{'action'} eq 'grade') && ($action ne 'CSTORE'))
1075: { $include=0; }
1076: if ($include) {
1077: push(@results,($time<1000000000?'0':'').$time.':'.$res.':'.
1078: $uname.':'.$udom.':'.
1079: $action.':'.$values);
1080: }
1081: }
1082: }
1083: close IN;
1084: return join('&',sort(@results));
1085: }
1086:
1087: ########################################################
1088: ########################################################
1089:
1090: =pod
1091:
1092: =item &userlog
1093:
1094: Inputs: $path, $command
1095:
1096: Returns: unescaped string of values.
1.40 harris41 1097:
1.51 matthew 1098: =cut
1.40 harris41 1099:
1.51 matthew 1100: ########################################################
1101: ########################################################
1102: sub userlog {
1103: my ($path,$command)=@_;
1104: my %filters=();
1105: foreach (split(/\:/,&unescape($command))) {
1106: my ($name,$value)=split(/\=/,$_);
1107: $filters{$name}=$value;
1108: }
1109: my @results=();
1110: open(IN,$path.'/activity.log') or return ('file_error');
1111: while (my $line=<IN>) {
1112: chomp($line);
1113: my ($timestamp,$host,$log)=split(/\:/,$line);
1114: $log=&unescape($log);
1115: my $include=1;
1116: if (($filters{'start'}) && ($timestamp<$filters{'start'}))
1117: { $include=0; }
1118: if (($filters{'end'}) && ($timestamp>$filters{'end'}))
1119: { $include=0; }
1.80 raeburn 1120: if (($filters{'action'} eq 'Role') && ($log !~/^Role/))
1121: { $include=0; }
1.51 matthew 1122: if (($filters{'action'} eq 'log') && ($log!~/^Log/)) { $include=0; }
1123: if (($filters{'action'} eq 'check') && ($log!~/^Check/))
1124: { $include=0; }
1125: if ($include) {
1.80 raeburn 1126: push(@results,$timestamp.':'.$host.':'.&escape($log));
1.51 matthew 1127: }
1128: }
1129: close IN;
1130: return join('&',sort(@results));
1.52 matthew 1131: }
1132:
1133: ########################################################
1134: ########################################################
1135:
1136: =pod
1137:
1138: =item Functions required for forking
1139:
1140: =over 4
1141:
1142: =item REAPER
1143:
1144: REAPER takes care of dead children.
1145:
1146: =item HUNTSMAN
1147:
1148: Signal handler for SIGINT.
1149:
1150: =item HUPSMAN
1151:
1152: Signal handler for SIGHUP
1153:
1154: =item DISCONNECT
1155:
1156: Disconnects from database.
1157:
1158: =back
1159:
1160: =cut
1161:
1162: ########################################################
1163: ########################################################
1164: sub REAPER { # takes care of dead children
1165: $SIG{CHLD} = \&REAPER;
1166: my $pid = wait;
1167: $children --;
1168: &logthis("Child $pid died");
1169: delete $children{$pid};
1170: }
1171:
1172: sub HUNTSMAN { # signal handler for SIGINT
1173: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1174: kill 'INT' => keys %children;
1175: my $execdir=$perlvar{'lonDaemons'};
1176: unlink("$execdir/logs/lonsql.pid");
1.59 albertel 1177: &logthis("<font color='red'>CRITICAL: Shutting down</font>");
1.52 matthew 1178: $unixsock = "mysqlsock";
1179: my $port="$perlvar{'lonSockDir'}/$unixsock";
1180: unlink($port);
1181: exit; # clean up with dignity
1182: }
1183:
1184: sub HUPSMAN { # signal handler for SIGHUP
1185: local($SIG{CHLD}) = 'IGNORE'; # we're going to kill our children
1186: kill 'INT' => keys %children;
1187: close($server); # free up socket
1.59 albertel 1188: &logthis("<font color='red'>CRITICAL: Restarting</font>");
1.52 matthew 1189: my $execdir=$perlvar{'lonDaemons'};
1190: $unixsock = "mysqlsock";
1191: my $port="$perlvar{'lonSockDir'}/$unixsock";
1192: unlink($port);
1193: exec("$execdir/lonsql"); # here we go again
1194: }
1195:
1196: sub DISCONNECT {
1197: $dbh->disconnect or
1.59 albertel 1198: &logthis("<font color='blue'>WARNING: Couldn't disconnect from database ".
1.52 matthew 1199: " $DBI::errstr : $@</font>");
1200: exit;
1.51 matthew 1201: }
1.40 harris41 1202:
1203:
1.51 matthew 1204: =pod
1.40 harris41 1205:
1.51 matthew 1206: =back
1.40 harris41 1207:
1208: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonsql CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom