1: # The LearningOnline Network
2: #
3: # $Id: Lond.pm,v 1.6 2014/01/01 17:41:37 raeburn Exp $
4: #
5: # Copyright Michigan State University Board of Trustees
6: #
7: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
8: #
9: # LON-CAPA is free software; you can redistribute it and/or modify
10: # it under the terms of the GNU General Public License as published by
11: # the Free Software Foundation; either version 2 of the License, or
12: # (at your option) any later version.
13: #
14: # LON-CAPA is distributed in the hope that it will be useful,
15: # but WITHOUT ANY WARRANTY; without even the implied warranty of
16: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17: # GNU General Public License for more details.
18: #
19: # You should have received a copy of the GNU General Public License
20: # along with LON-CAPA; if not, write to the Free Software
21: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22: #
23: # /home/httpd/html/adm/gpl.txt
24: #
25: # http://www.lon-capa.org/
26: #
27: ###
28:
29: #NOTE perldoc at the end of file
30: #TODO move remaining lond functions into this
31:
32: package LONCAPA::Lond;
33:
34: use strict;
35: use lib '/home/httpd/lib/perl/';
36:
37: use LONCAPA;
38: use Apache::lonnet;
39: use GDBM_File;
40:
41:
42: sub dump_with_regexp {
43: my ( $tail, $clientversion ) = @_;
44: my ( $udom, $uname, $namespace, $regexp, $range ) =
45: split /:/, $tail;
46:
47: $regexp = $regexp ? unescape($regexp) : '.';
48:
49: my ($start,$end);
50:
51: if (defined($range)) {
52: if ($range =~ /^(\d+)\-(\d+)$/) {
53: ($start,$end) = ($1,$2);
54: } elsif ($range =~/^(\d+)$/) {
55: ($start,$end) = (0,$1);
56: } else {
57: undef($range);
58: }
59: }
60:
61: my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER()) or
62: return "error: ".($!+0)." tie(GDBM) Failed while attempting dump";
63:
64: my $qresult = '';
65: my $count = 0;
66: #
67: # When dump is for roles.db, determine if LON-CAPA version checking is needed.
68: # Sessions on 2.10 and later do not require version checking, as that occurs
69: # on the server hosting the user session, when constructing the roles/courses
70: # screen).
71: #
72: my $skipcheck;
73: my @ids = &Apache::lonnet::current_machine_ids();
74: my (%homecourses, $major, $minor, $now);
75: #
76: # If dump is for roles.db from a pre-2.10 server, determine the LON-CAPA
77: # version on the server which requested the data.
78: #
79: if ($namespace eq 'roles') {
80: if ($clientversion =~ /^\'?(\d+)\.(\d+)\.[\w.\-]+\'?/) {
81: $major = $1;
82: $minor = $2;
83:
84: }
85: if (($major > 2) || (($major == 2) && ($minor > 9))) {
86: $skipcheck = 1;
87: }
88: $now = time;
89: }
90: while (my ($key,$value) = each(%$hashref)) {
91: if ($namespace eq 'roles' && (!$skipcheck)) {
92: if ($key =~ m{^/($LONCAPA::match_domain)/($LONCAPA::match_courseid)(/?[^_]*)_(cc|co|in|ta|ep|ad|st|cr)$}) {
93: my $cdom = $1;
94: my $cnum = $2;
95: my ($role,$roleend,$rolestart) = split(/\_/,$value);
96: if (!$roleend || $roleend > $now) {
97: #
98: # For active course roles, check that requesting server is running a LON-CAPA
99: # version which meets any version requirements for the course. Do not include
100: # the role amongst the results returned if the requesting server's version is
101: # too old.
102: #
103: # This determination is handled differently depending on whether the course's
104: # homeserver is the current server, or whether it is a different server.
105: # In both cases, the course's version requirement needs to be retrieved.
106: #
107: next unless (&releasereqd_check($cnum,$cdom,$key,$value,$major,
108: $minor,\%homecourses,\@ids));
109: }
110: }
111: }
112: if ($regexp eq '.') {
113: $count++;
114: if (defined($range) && $count >= $end) { last; }
115: if (defined($range) && $count < $start) { next; }
116: $qresult.=$key.'='.$value.'&';
117: } else {
118: my $unescapeKey = &unescape($key);
119: if (eval('$unescapeKey=~/$regexp/')) {
120: $count++;
121: if (defined($range) && $count >= $end) { last; }
122: if (defined($range) && $count < $start) { next; }
123: $qresult.="$key=$value&";
124: }
125: }
126: }
127:
128: &untie_user_hash($hashref) or
129: return "error: ".($!+0)." untie(GDBM) Failed while attempting dump";
130: #
131: # If dump is for roles.db from a pre-2.10 server, check if the LON-CAPA
132: # version requirements for courses for which the current server is the home
133: # server permit course roles to be usable on the client server hosting the
134: # user's session. If so, include those role results in the data returned to
135: # the client server.
136: #
137: if (($namespace eq 'roles') && (!$skipcheck)) {
138: if (keys(%homecourses) > 0) {
139: $qresult .= &check_homecourses(\%homecourses,$regexp,$count,
140: $range,$start,$end,$major,$minor);
141: }
142: }
143: chop($qresult);
144: return $qresult;
145: }
146:
147:
148: sub releasereqd_check {
149: my ($cnum,$cdom,$key,$value,$major,$minor,$homecourses,$ids) = @_;
150: my $home = &Apache::lonnet::homeserver($cnum,$cdom);
151: return if ($home eq 'no_host');
152: my ($reqdmajor,$reqdminor,$displayrole);
153: if ($cnum =~ /$LONCAPA::match_community/) {
154: if ($major eq '' && $minor eq '') {
155: return unless ((ref($ids) eq 'ARRAY') &&
156: (grep(/^\Q$home\E$/,@{$ids})));
157: } else {
158: $reqdmajor = 2;
159: $reqdminor = 9;
160: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
161: }
162: }
163: my $hashid = $cdom.':'.$cnum;
164: my ($courseinfo,$cached) =
165: &Apache::lonnet::is_cached_new('courseinfo',$hashid);
166: if (defined($cached)) {
167: if (ref($courseinfo) eq 'HASH') {
168: if (exists($courseinfo->{'releaserequired'})) {
169: my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
170: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
171: }
172: }
173: } else {
174: if (ref($ids) eq 'ARRAY') {
175: if (grep(/^\Q$home\E$/,@{$ids})) {
176: if (ref($homecourses) eq 'HASH') {
177: if (ref($homecourses->{$cdom}) eq 'HASH') {
178: if (ref($homecourses->{$cdom}{$cnum}) eq 'HASH') {
179: if (ref($homecourses->{$cdom}{$cnum}) eq 'ARRAY') {
180: push(@{$homecourses->{$cdom}{$cnum}},{$key=>$value});
181: } else {
182: $homecourses->{$cdom}{$cnum} = [{$key=>$value}];
183: }
184: } else {
185: $homecourses->{$cdom}{$cnum} = [{$key=>$value}];
186: }
187: } else {
188: $homecourses->{$cdom}{$cnum} = [{$key=>$value}];
189: }
190: }
191: return;
192: }
193: }
194: my $courseinfo = &get_courseinfo_hash($cnum,$cdom,$home);
195: if (ref($courseinfo) eq 'HASH') {
196: if (exists($courseinfo->{'releaserequired'})) {
197: my ($reqdmajor,$reqdminor) = split(/\./,$courseinfo->{'releaserequired'});
198: return unless (&useable_role($reqdmajor,$reqdminor,$major,$minor));
199: }
200: } else {
201: return;
202: }
203: }
204: return 1;
205: }
206:
207:
208: sub check_homecourses {
209: my ($homecourses,$regexp,$count,$range,$start,$end,$major,$minor) = @_;
210: my ($result,%addtocache);
211: my $yesterday = time - 24*3600;
212: if (ref($homecourses) eq 'HASH') {
213: my (%okcourses,%courseinfo,%recent);
214: foreach my $domain (keys(%{$homecourses})) {
215: my $hashref =
216: &tie_domain_hash($domain, "nohist_courseids", &GDBM_WRCREAT());
217: if (ref($hashref) eq 'HASH') {
218: while (my ($key,$value) = each(%$hashref)) {
219: my $unesc_key = &unescape($key);
220: if ($unesc_key =~ /^lasttime:(\w+)$/) {
221: my $cid = $1;
222: $cid =~ s/_/:/;
223: if ($value > $yesterday ) {
224: $recent{$cid} = 1;
225: }
226: next;
227: }
228: my $items = &Apache::lonnet::thaw_unescape($value);
229: if (ref($items) eq 'HASH') {
230: my ($cdom,$cnum) = split(/_/,$unesc_key);
231: my $hashid = $cdom.':'.$cnum;
232: $courseinfo{$hashid} = $items;
233: if (ref($homecourses->{$cdom}{$cnum}) eq 'ARRAY') {
234: my ($reqdmajor,$reqdminor) = split(/\./,$items->{'releaserequired'});
235: if (&useable_role($reqdmajor,$reqdminor,$major,$minor)) {
236: $okcourses{$hashid} = 1;
237: }
238: }
239: }
240: }
241: unless (&untie_domain_hash($hashref)) {
242: &logthis("Failed to untie tied hash for nohist_courseids.db for $domain");
243: }
244: } else {
245: &logthis("Failed to tie hash for nohist_courseids.db for $domain");
246: }
247: }
248: foreach my $hashid (keys(%recent)) {
249: my ($result,$cached)=&Apache::lonnet::is_cached_new('courseinfo',$hashid);
250: unless ($cached) {
251: &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
252: }
253: }
254: foreach my $cdom (keys(%{$homecourses})) {
255: if (ref($homecourses->{$cdom}) eq 'HASH') {
256: foreach my $cnum (keys(%{$homecourses->{$cdom}})) {
257: my $hashid = $cdom.':'.$cnum;
258: next if ($recent{$hashid});
259: &Apache::lonnet::do_cache_new('courseinfo',$hashid,$courseinfo{$hashid},600);
260: }
261: }
262: }
263: foreach my $hashid (keys(%okcourses)) {
264: my ($cdom,$cnum) = split(/:/,$hashid);
265: if ((ref($homecourses->{$cdom}) eq 'HASH') &&
266: (ref($homecourses->{$cdom}{$cnum}) eq 'ARRAY')) {
267: foreach my $role (@{$homecourses->{$cdom}{$cnum}}) {
268: if (ref($role) eq 'HASH') {
269: while (my ($key,$value) = each(%{$role})) {
270: if ($regexp eq '.') {
271: $count++;
272: if (defined($range) && $count >= $end) { last; }
273: if (defined($range) && $count < $start) { next; }
274: $result.=$key.'='.$value.'&';
275: } else {
276: my $unescapeKey = &unescape($key);
277: if (eval('$unescapeKey=~/$regexp/')) {
278: $count++;
279: if (defined($range) && $count >= $end) { last; }
280: if (defined($range) && $count < $start) { next; }
281: $result.="$key=$value&";
282: }
283: }
284: }
285: }
286: }
287: }
288: }
289: }
290: return $result;
291: }
292:
293:
294: sub useable_role {
295: my ($reqdmajor,$reqdminor,$major,$minor) = @_;
296: if ($reqdmajor ne '' && $reqdminor ne '') {
297: return if (($major eq '' && $minor eq '') ||
298: ($major < $reqdmajor) ||
299: (($major == $reqdmajor) && ($minor < $reqdminor)));
300: }
301: return 1;
302: }
303:
304:
305: sub get_courseinfo_hash {
306: my ($cnum,$cdom,$home) = @_;
307: my %info;
308: eval {
309: local($SIG{ALRM}) = sub { die "timeout\n"; };
310: local($SIG{__DIE__})='DEFAULT';
311: alarm(3);
312: %info = &Apache::lonnet::courseiddump($cdom,'.',1,'.','.',$cnum,1,[$home],'.');
313: alarm(0);
314: };
315: if ($@) {
316: if ($@ eq "timeout\n") {
317: &logthis("<font color='blue'>WARNING courseiddump for $cnum:$cdom from $home timedout</font>");
318: } else {
319: &logthis("<font color='yellow'>WARNING unexpected error during eval of call for courseiddump from $home</font>");
320: }
321: } else {
322: if (ref($info{$cdom.'_'.$cnum}) eq 'HASH') {
323: my $hashid = $cdom.':'.$cnum;
324: return &Apache::lonnet::do_cache_new('courseinfo',$hashid,$info{$cdom.'_'.$cnum},600);
325: }
326: }
327: return;
328: }
329:
330: sub dump_course_id_handler {
331: my ($tail) = @_;
332:
333: my ($udom,$since,$description,$instcodefilter,$ownerfilter,$coursefilter,
334: $typefilter,$regexp_ok,$rtn_as_hash,$selfenrollonly,$catfilter,$showhidden,
335: $caller,$cloner,$cc_clone_list,$cloneonly,$createdbefore,$createdafter,
336: $creationcontext,$domcloner,$hasuniquecode) = split(/:/,$tail);
337: my $now = time;
338: my ($cloneruname,$clonerudom,%cc_clone);
339: if (defined($description)) {
340: $description=&unescape($description);
341: } else {
342: $description='.';
343: }
344: if (defined($instcodefilter)) {
345: $instcodefilter=&unescape($instcodefilter);
346: } else {
347: $instcodefilter='.';
348: }
349: my ($ownerunamefilter,$ownerdomfilter);
350: if (defined($ownerfilter)) {
351: $ownerfilter=&unescape($ownerfilter);
352: if ($ownerfilter ne '.' && defined($ownerfilter)) {
353: if ($ownerfilter =~ /^([^:]*):([^:]*)$/) {
354: $ownerunamefilter = $1;
355: $ownerdomfilter = $2;
356: } else {
357: $ownerunamefilter = $ownerfilter;
358: $ownerdomfilter = '';
359: }
360: }
361: } else {
362: $ownerfilter='.';
363: }
364:
365: if (defined($coursefilter)) {
366: $coursefilter=&unescape($coursefilter);
367: } else {
368: $coursefilter='.';
369: }
370: if (defined($typefilter)) {
371: $typefilter=&unescape($typefilter);
372: } else {
373: $typefilter='.';
374: }
375: if (defined($regexp_ok)) {
376: $regexp_ok=&unescape($regexp_ok);
377: }
378: if (defined($catfilter)) {
379: $catfilter=&unescape($catfilter);
380: }
381: if (defined($cloner)) {
382: $cloner = &unescape($cloner);
383: ($cloneruname,$clonerudom) = ($cloner =~ /^($LONCAPA::match_username):($LONCAPA::match_domain)$/);
384: }
385: if (defined($cc_clone_list)) {
386: $cc_clone_list = &unescape($cc_clone_list);
387: my @cc_cloners = split('&',$cc_clone_list);
388: foreach my $cid (@cc_cloners) {
389: my ($clonedom,$clonenum) = split(':',$cid);
390: next if ($clonedom ne $udom);
391: $cc_clone{$clonedom.'_'.$clonenum} = 1;
392: }
393: }
394: if ($createdbefore ne '') {
395: $createdbefore = &unescape($createdbefore);
396: } else {
397: $createdbefore = 0;
398: }
399: if ($createdafter ne '') {
400: $createdafter = &unescape($createdafter);
401: } else {
402: $createdafter = 0;
403: }
404: if ($creationcontext ne '') {
405: $creationcontext = &unescape($creationcontext);
406: } else {
407: $creationcontext = '.';
408: }
409: unless ($hasuniquecode) {
410: $hasuniquecode = '.';
411: }
412: my $unpack = 1;
413: if ($description eq '.' && $instcodefilter eq '.' && $ownerfilter eq '.' &&
414: $typefilter eq '.') {
415: $unpack = 0;
416: }
417: if (!defined($since)) { $since=0; }
418: my $qresult='';
419:
420: my $hashref = &tie_domain_hash($udom, "nohist_courseids", &GDBM_WRCREAT())
421: or return "error: ".($!+0)." tie(GDBM) Failed while attempting courseiddump";
422:
423: while (my ($key,$value) = each(%$hashref)) {
424: my ($unesc_key,$lasttime_key,$lasttime,$is_hash,%val,
425: %unesc_val,$selfenroll_end,$selfenroll_types,$created,
426: $context);
427: $unesc_key = &unescape($key);
428: if ($unesc_key =~ /^lasttime:/) {
429: next;
430: } else {
431: $lasttime_key = &escape('lasttime:'.$unesc_key);
432: }
433: if ($hashref->{$lasttime_key} ne '') {
434: $lasttime = $hashref->{$lasttime_key};
435: next if ($lasttime<$since);
436: }
437: my ($canclone,$valchange);
438: my $items = &Apache::lonnet::thaw_unescape($value);
439: if (ref($items) eq 'HASH') {
440: if ($hashref->{$lasttime_key} eq '') {
441: next if ($since > 1);
442: }
443: $is_hash = 1;
444: if ($domcloner) {
445: $canclone = 1;
446: } elsif (defined($clonerudom)) {
447: if ($items->{'cloners'}) {
448: my @cloneable = split(',',$items->{'cloners'});
449: if (@cloneable) {
450: if (grep(/^\*$/,@cloneable)) {
451: $canclone = 1;
452: } elsif (grep(/^\*:\Q$clonerudom\E$/,@cloneable)) {
453: $canclone = 1;
454: } elsif (grep(/^\Q$cloneruname\E:\Q$clonerudom\E$/,@cloneable)) {
455: $canclone = 1;
456: }
457: }
458: unless ($canclone) {
459: if ($cloneruname ne '' && $clonerudom ne '') {
460: if ($cc_clone{$unesc_key}) {
461: $canclone = 1;
462: $items->{'cloners'} .= ','.$cloneruname.':'.
463: $clonerudom;
464: $valchange = 1;
465: }
466: }
467: }
468: } elsif (defined($cloneruname)) {
469: if ($cc_clone{$unesc_key}) {
470: $canclone = 1;
471: $items->{'cloners'} = $cloneruname.':'.$clonerudom;
472: $valchange = 1;
473: }
474: unless ($canclone) {
475: if ($items->{'owner'} =~ /:/) {
476: if ($items->{'owner'} eq $cloner) {
477: $canclone = 1;
478: }
479: } elsif ($cloner eq $items->{'owner'}.':'.$udom) {
480: $canclone = 1;
481: }
482: if ($canclone) {
483: $items->{'cloners'} = $cloneruname.':'.$clonerudom;
484: $valchange = 1;
485: }
486: }
487: }
488: }
489: if ($unpack || !$rtn_as_hash) {
490: $unesc_val{'descr'} = $items->{'description'};
491: $unesc_val{'inst_code'} = $items->{'inst_code'};
492: $unesc_val{'owner'} = $items->{'owner'};
493: $unesc_val{'type'} = $items->{'type'};
494: $unesc_val{'cloners'} = $items->{'cloners'};
495: $unesc_val{'created'} = $items->{'created'};
496: $unesc_val{'context'} = $items->{'context'};
497: }
498: $selfenroll_types = $items->{'selfenroll_types'};
499: $selfenroll_end = $items->{'selfenroll_end_date'};
500: $created = $items->{'created'};
501: $context = $items->{'context'};
502: if ($selfenrollonly) {
503: next if (!$selfenroll_types);
504: if (($selfenroll_end > 0) && ($selfenroll_end <= $now)) {
505: next;
506: }
507: }
508: if ($creationcontext ne '.') {
509: next if (($context ne '') && ($context ne $creationcontext));
510: }
511: if ($createdbefore > 0) {
512: next if (($created eq '') || ($created > $createdbefore));
513: }
514: if ($createdafter > 0) {
515: next if (($created eq '') || ($created <= $createdafter));
516: }
517: if ($catfilter ne '') {
518: next if ($items->{'categories'} eq '');
519: my @categories = split('&',$items->{'categories'});
520: next if (@categories == 0);
521: my @subcats = split('&',$catfilter);
522: my $matchcat = 0;
523: foreach my $cat (@categories) {
524: if (grep(/^\Q$cat\E$/,@subcats)) {
525: $matchcat = 1;
526: last;
527: }
528: }
529: next if (!$matchcat);
530: }
531: if ($caller eq 'coursecatalog') {
532: if ($items->{'hidefromcat'} eq 'yes') {
533: next if !$showhidden;
534: }
535: }
536: if ($hasuniquecode ne '.') {
537: next unless ($items->{'uniquecode'});
538: }
539: } else {
540: next if ($catfilter ne '');
541: next if ($selfenrollonly);
542: next if ($createdbefore || $createdafter);
543: next if ($creationcontext ne '.');
544: if ((defined($clonerudom)) && (defined($cloneruname))) {
545: if ($cc_clone{$unesc_key}) {
546: $canclone = 1;
547: $val{'cloners'} = &escape($cloneruname.':'.$clonerudom);
548: }
549: }
550: $is_hash = 0;
551: my @courseitems = split(/:/,$value);
552: $lasttime = pop(@courseitems);
553: if ($hashref->{$lasttime_key} eq '') {
554: next if ($lasttime<$since);
555: }
556: ($val{'descr'},$val{'inst_code'},$val{'owner'},$val{'type'}) = @courseitems;
557: }
558: if ($cloneonly) {
559: next unless ($canclone);
560: }
561: my $match = 1;
562: if ($description ne '.') {
563: if (!$is_hash) {
564: $unesc_val{'descr'} = &unescape($val{'descr'});
565: }
566: if (eval{$unesc_val{'descr'} !~ /\Q$description\E/i}) {
567: $match = 0;
568: }
569: }
570: if ($instcodefilter ne '.') {
571: if (!$is_hash) {
572: $unesc_val{'inst_code'} = &unescape($val{'inst_code'});
573: }
574: if ($regexp_ok == 1) {
575: if (eval{$unesc_val{'inst_code'} !~ /$instcodefilter/}) {
576: $match = 0;
577: }
578: } elsif ($regexp_ok == -1) {
579: if (eval{$unesc_val{'inst_code'} =~ /$instcodefilter/}) {
580: $match = 0;
581: }
582: } else {
583: if (eval{$unesc_val{'inst_code'} !~ /\Q$instcodefilter\E/i}) {
584: $match = 0;
585: }
586: }
587: }
588: if ($ownerfilter ne '.') {
589: if (!$is_hash) {
590: $unesc_val{'owner'} = &unescape($val{'owner'});
591: }
592: if (($ownerunamefilter ne '') && ($ownerdomfilter ne '')) {
593: if ($unesc_val{'owner'} =~ /:/) {
594: if (eval{$unesc_val{'owner'} !~
595: /\Q$ownerunamefilter\E:\Q$ownerdomfilter\E$/i}) {
596: $match = 0;
597: }
598: } else {
599: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
600: $match = 0;
601: }
602: }
603: } elsif ($ownerunamefilter ne '') {
604: if ($unesc_val{'owner'} =~ /:/) {
605: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E:[^:]+$/i}) {
606: $match = 0;
607: }
608: } else {
609: if (eval{$unesc_val{'owner'} !~ /\Q$ownerunamefilter\E/i}) {
610: $match = 0;
611: }
612: }
613: } elsif ($ownerdomfilter ne '') {
614: if ($unesc_val{'owner'} =~ /:/) {
615: if (eval{$unesc_val{'owner'} !~ /^[^:]+:\Q$ownerdomfilter\E/}) {
616: $match = 0;
617: }
618: } else {
619: if ($ownerdomfilter ne $udom) {
620: $match = 0;
621: }
622: }
623: }
624: }
625: if ($coursefilter ne '.') {
626: if (eval{$unesc_key !~ /^$udom(_)\Q$coursefilter\E$/}) {
627: $match = 0;
628: }
629: }
630: if ($typefilter ne '.') {
631: if (!$is_hash) {
632: $unesc_val{'type'} = &unescape($val{'type'});
633: }
634: if ($unesc_val{'type'} eq '') {
635: if ($typefilter ne 'Course') {
636: $match = 0;
637: }
638: } else {
639: if (eval{$unesc_val{'type'} !~ /^\Q$typefilter\E$/}) {
640: $match = 0;
641: }
642: }
643: }
644: if ($match == 1) {
645: if ($rtn_as_hash) {
646: if ($is_hash) {
647: if ($valchange) {
648: my $newvalue = &Apache::lonnet::freeze_escape($items);
649: $qresult.=$key.'='.$newvalue.'&';
650: } else {
651: $qresult.=$key.'='.$value.'&';
652: }
653: } else {
654: my %rtnhash = ( 'description' => &unescape($val{'descr'}),
655: 'inst_code' => &unescape($val{'inst_code'}),
656: 'owner' => &unescape($val{'owner'}),
657: 'type' => &unescape($val{'type'}),
658: 'cloners' => &unescape($val{'cloners'}),
659: );
660: my $items = &Apache::lonnet::freeze_escape(\%rtnhash);
661: $qresult.=$key.'='.$items.'&';
662: }
663: } else {
664: if ($is_hash) {
665: $qresult .= $key.'='.&escape($unesc_val{'descr'}).':'.
666: &escape($unesc_val{'inst_code'}).':'.
667: &escape($unesc_val{'owner'}).'&';
668: } else {
669: $qresult .= $key.'='.$val{'descr'}.':'.$val{'inst_code'}.
670: ':'.$val{'owner'}.'&';
671: }
672: }
673: }
674: }
675: &untie_domain_hash($hashref) or
676: return "error: ".($!+0)." untie(GDBM) Failed while attempting courseiddump";
677:
678: chop($qresult);
679: return $qresult;
680: }
681:
682: sub dump_profile_database {
683: my ($tail) = @_;
684:
685: my ($udom,$uname,$namespace) = split(/:/,$tail);
686:
687: my $hashref = &tie_user_hash($udom, $uname, $namespace, &GDBM_READER()) or
688: return "error: ".($!+0)." tie(GDBM) Failed while attempting currentdump";
689:
690: # Structure of %data:
691: # $data{$symb}->{$parameter}=$value;
692: # $data{$symb}->{'v.'.$parameter}=$version;
693: # since $parameter will be unescaped, we do not
694: # have to worry about silly parameter names...
695:
696: my $qresult='';
697: my %data = (); # A hash of anonymous hashes..
698: while (my ($key,$value) = each(%$hashref)) {
699: my ($v,$symb,$param) = split(/:/,$key);
700: next if ($v eq 'version' || $symb eq 'keys');
701: next if (exists($data{$symb}) &&
702: exists($data{$symb}->{$param}) &&
703: $data{$symb}->{'v.'.$param} > $v);
704: $data{$symb}->{$param}=$value;
705: $data{$symb}->{'v.'.$param}=$v;
706: }
707:
708: &untie_user_hash($hashref) or
709: return "error: ".($!+0)." untie(GDBM) Failed while attempting currentdump";
710:
711: while (my ($symb,$param_hash) = each(%data)) {
712: while(my ($param,$value) = each (%$param_hash)){
713: next if ($param =~ /^v\./); # Ignore versions...
714: #
715: # Just dump the symb=value pairs separated by &
716: #
717: $qresult.=$symb.':'.$param.'='.$value.'&';
718: }
719: }
720:
721: chop($qresult);
722: return $qresult;
723: }
724:
725:
726: 1;
727:
728: __END__
729:
730: =head1 NAME
731:
732: LONCAPA::Lond.pm
733:
734: =head1 SYNOPSIS
735:
736: #TODO
737:
738: =head1 DESCRIPTION
739:
740: #TODO
741:
742: =head1 METHODS
743:
744: =over 4
745:
746: =item dump_with_regexp( $tail, $client )
747:
748: Dump a profile database with an optional regular expression to match against
749: the keys. In this dump, no effort is made to separate symb from version
750: information. Presumably the databases that are dumped by this command are of a
751: different structure. Need to look at this and improve the documentation of
752: both this and the currentdump handler.
753:
754: $tail a colon separated list containing
755:
756: =over
757:
758: =item domain
759:
760: =item user
761:
762: identifying the user.
763:
764: =item namespace
765:
766: identifying the database.
767:
768: =item regexp
769:
770: optional regular expression that is matched against database keywords to do
771: selective dumps.
772:
773: =item range
774:
775: optional range of entries e.g., 10-20 would return the 10th to 19th items, etc.
776:
777: =back
778:
779: $client is the channel open on the client.
780:
781: Returns: 1 (Continue processing).
782:
783: Side effects: response is written to $client.
784:
785: =item dump_course_id_handler
786:
787: #TODO copy from lond
788:
789: =item dump_profile_database
790:
791: #TODO copy from lond
792:
793: =item releasereqd_check( $cnum, $cdom, $key, $value, $major, $minor,
794: $homecourses, $ids )
795:
796: releasereqd_check() will determine if a LON-CAPA version (defined in the
797: $major,$minor args passed) is not too old to allow use of a role in a
798: course ($cnum,$cdom args passed), if at least one of the following applies:
799: (a) the course is a Community, (b) the course's home server is *not* the
800: current server, or (c) cached course information is not stale.
801:
802: For the case where none of these apply, the course is added to the
803: $homecourse hash ref (keys = courseIDs, values = array of a hash of roles).
804: The $homecourse hash ref is for courses for which the current server is the
805: home server. LON-CAPA version requirements are checked elsewhere for the
806: items in $homecourse.
807:
808:
809: =item check_homecourses( $homecourses, $regexp, $count, $range, $start, $end,
810: $major, $minor )
811:
812: check_homecourses() will retrieve course information for those courses which
813: are keys of the $homecourses hash ref (first arg). The nohist_courseids.db
814: GDBM file is tied and course information for each course retrieved. Last
815: visit (lasttime key) is also retrieved for each, and cached values updated
816: for any courses last visited less than 24 hours ago. Cached values are also
817: updated for any courses included in the $homecourses hash ref.
818:
819: The reason for the 24 hours constraint is that the cron entry in
820: /etc/cron.d/loncapa for /home/httpd/perl/refresh_courseids_db.pl causes
821: cached course information to be updated nightly for courses with activity
822: within the past 24 hours.
823:
824: Role information for the user (included in a ref to an array of hashes as the
825: value for each key in $homecourses) is appended to the result returned by the
826: routine, which will in turn be appended to the string returned to the client
827: hosting the user's session.
828:
829:
830: =item useable_role( $reqdmajor, $reqdminor, $major, $minor )
831:
832: useable_role() will compare the LON-CAPA version required by a course with
833: the version available on the client server. If the client server's version
834: is compatible, 1 will be returned.
835:
836:
837: =item get_courseinfo_hash( $cnum, $cdom, $home )
838:
839: get_courseinfo_hash() is used to retrieve course information from the db
840: file: nohist_courseids.db for a course for which the current server is *not*
841: the home server.
842:
843: A hash of a hash will be retrieved. The outer hash contains a single key --
844: courseID -- for the course for which the data are being requested.
845: The contents of the inner hash, for that single item in the outer hash
846: are returned (and cached in memcache for 10 minutes).
847:
848:
849:
850: =back
851:
852: =head1 BUGS
853:
854: No known bugs at this time.
855:
856: =head1 SEE ALSO
857:
858: L<Apache::lonnet>, L<lond>
859:
860: =cut
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to Lond.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom