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