Annotation of loncom/interface/lonnavmaps.pm, revision 1.321
1.2 www 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
1.1 www 3: #
1.321 ! raeburn 4: # $Id: lonnavmaps.pm,v 1.320 2005/04/07 06:56:23 albertel Exp $
1.20 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.245 www 28: ###
1.2 www 29:
1.1 www 30: package Apache::lonnavmaps;
31:
32: use strict;
1.317 albertel 33: use GDBM_File;
1.2 www 34: use Apache::Constants qw(:common :http);
1.18 albertel 35: use Apache::loncommon();
1.150 www 36: use Apache::lonmenu();
1.305 albertel 37: use Apache::lonenc();
1.229 www 38: use Apache::lonlocal;
1.306 foxr 39: use Apache::lonnet;
1.73 bowersj2 40: use POSIX qw (floor strftime);
1.300 albertel 41: use Data::Dumper; # for debugging, not always
1.316 albertel 42: use Time::HiRes qw( gettimeofday tv_interval );
1.2 www 43:
1.133 bowersj2 44: # symbolic constants
45: sub SYMB { return 1; }
46: sub URL { return 2; }
47: sub NOTHING { return 3; }
48:
49: # Some data
50:
1.140 bowersj2 51: my $resObj = "Apache::lonnavmaps::resource";
52:
1.135 bowersj2 53: # Keep these mappings in sync with lonquickgrades, which uses the colors
54: # instead of the icons.
55: my %statusIconMap =
1.224 bowersj2 56: (
57: $resObj->CLOSED => '',
58: $resObj->OPEN => 'navmap.open.gif',
59: $resObj->CORRECT => 'navmap.correct.gif',
60: $resObj->INCORRECT => 'navmap.wrong.gif',
61: $resObj->ATTEMPTED => 'navmap.ellipsis.gif',
62: $resObj->ERROR => ''
63: );
1.135 bowersj2 64:
65: my %iconAltTags =
66: ( 'navmap.correct.gif' => 'Correct',
67: 'navmap.wrong.gif' => 'Incorrect',
68: 'navmap.open.gif' => 'Open' );
1.133 bowersj2 69:
1.136 bowersj2 70: # Defines a status->color mapping, null string means don't color
71: my %colormap =
1.140 bowersj2 72: ( $resObj->NETWORK_FAILURE => '',
73: $resObj->CORRECT => '',
74: $resObj->EXCUSED => '#3333FF',
75: $resObj->PAST_DUE_ANSWER_LATER => '',
76: $resObj->PAST_DUE_NO_ANSWER => '',
77: $resObj->ANSWER_OPEN => '#006600',
78: $resObj->OPEN_LATER => '',
79: $resObj->TRIES_LEFT => '',
80: $resObj->INCORRECT => '',
81: $resObj->OPEN => '',
1.207 bowersj2 82: $resObj->NOTHING_SET => '',
83: $resObj->ATTEMPTED => '',
84: $resObj->ANSWER_SUBMITTED => ''
85: );
1.136 bowersj2 86: # And a special case in the nav map; what to do when the assignment
87: # is not yet done and due in less then 24 hours
88: my $hurryUpColor = "#FF0000";
1.130 www 89:
1.268 albertel 90: sub launch_win {
1.281 albertel 91: my ($mode,$script,$toplinkitems)=@_;
1.268 albertel 92: my $result;
93: if ($script ne 'no') {
94: $result.='<script type="text/javascript">';
95: }
96: $result.='function launch_navmapwin() {
97: newWindow=open(\'/adm/navmaps?launchExternal\',\'loncapanav\',\'width=400,height=600,scrollbars=1\');
98: }';
99: if ($mode eq 'now') {
100: $result.="\nlaunch_navmapwin();\n";
101: }
102: if ($script ne 'no') {
103: $result.='</script>';
104: }
105: if ($mode eq 'link') {
1.281 albertel 106: &add_linkitem($toplinkitems,'launchnav','launch_navmapwin()',
107: "Launch navigation window");
1.268 albertel 108: }
109: return $result;
110: }
111:
1.269 albertel 112: sub close {
1.320 albertel 113: if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
1.269 albertel 114: return(<<ENDCLOSE);
115: <script type="text/javascript">
116: window.status='Accessing Nav Control';
117: menu=window.open("/adm/rat/empty.html","loncapanav",
118: "height=600,width=400,scrollbars=1");
119: window.status='Closing Nav Control';
120: menu.close();
121: window.status='Done.';
122: </script>
123: ENDCLOSE
124: }
1.268 albertel 125:
1.270 albertel 126: sub update {
1.320 albertel 127: if ($env{'environment.remotenavmap'} ne 'on') { return ''; }
128: if (!$env{'request.course.id'}) { return ''; }
1.270 albertel 129: if ($ENV{'REQUEST_URI'}=~m|^/adm/navmaps|) { return ''; }
130: return(<<ENDUPDATE);
131: <form name="navform"></form>
132: <script type="text/javascript">
133: this.document.navform.action='/adm/navmaps#curloc';
134: this.document.navform.target='loncapanav';
135: this.document.navform.submit();
136: </script>
137: ENDUPDATE
138: }
1.268 albertel 139:
1.1 www 140: sub handler {
1.99 bowersj2 141: my $r = shift;
1.118 bowersj2 142: real_handler($r);
143: }
144:
145: sub real_handler {
146: my $r = shift;
1.316 albertel 147: #my $t0=[&gettimeofday()];
1.51 bowersj2 148: # Handle header-only request
149: if ($r->header_only) {
1.320 albertel 150: if ($env{'browser.mathml'}) {
1.232 www 151: &Apache::loncommon::content_type($r,'text/xml');
1.51 bowersj2 152: } else {
1.232 www 153: &Apache::loncommon::content_type($r,'text/html');
1.51 bowersj2 154: }
155: $r->send_http_header;
156: return OK;
157: }
158:
159: # Send header, don't cache this page
1.320 albertel 160: if ($env{'browser.mathml'}) {
1.232 www 161: &Apache::loncommon::content_type($r,'text/xml');
1.51 bowersj2 162: } else {
1.232 www 163: &Apache::loncommon::content_type($r,'text/html');
1.51 bowersj2 164: }
165: &Apache::loncommon::no_cache($r);
166: $r->send_http_header;
167:
1.281 albertel 168: my %toplinkitems=();
1.312 albertel 169: &add_linkitem(\%toplinkitems,'blank','',"Select Action");
1.268 albertel 170: if ($ENV{QUERY_STRING} eq 'collapseExternal') {
171: &Apache::lonnet::put('environment',{'remotenavmap' => 'off'});
172: &Apache::lonnet::appenv('environment.remotenavmap' => 'off');
1.275 albertel 173: my $menu=&Apache::lonmenu::reopenmenu();
174: my $navstatus=&Apache::lonmenu::get_nav_status();
175: if ($menu) {
176: $menu=(<<MENU)
177: swmenu=$menu
178: swmenu.clearTimeout(swmenu.menucltim);
179: $navstatus
180: MENU
1.280 albertel 181: } else {
182: my $nothing = &Apache::lonhtmlcommon::javascript_nothing();
183: my $mainwindow='window.open('.$nothing.',"loncapaclient","",false);';
184: $menu=(<<MENU)
185: swmenu=$mainwindow
186: $navstatus
187: MENU
1.275 albertel 188: }
1.316 albertel 189: my $html=&Apache::lonxml::xmlbegin();
1.268 albertel 190: $r->print(<<"ENDSUBM");
1.316 albertel 191: $html
1.268 albertel 192: <head>
193: <script type="text/javascript">
194: function submitthis() {
1.275 albertel 195: $menu
1.268 albertel 196: self.close();
197: }
1.275 albertel 198:
1.268 albertel 199: </script>
200: </head>
201: <body bgcolor="#FFFFFF" onLoad="submitthis()"></body>
202: </html>
203: ENDSUBM
204: return;
205: }
206: if ($ENV{QUERY_STRING} eq 'launchExternal') {
207: &Apache::lonnet::put('environment',{'remotenavmap' => 'on'});
208: &Apache::lonnet::appenv('environment.remotenavmap' => 'on');
209: }
210:
1.106 bowersj2 211: # Create the nav map
1.221 bowersj2 212: my $navmap = Apache::lonnavmaps::navmap->new();
1.51 bowersj2 213:
1.55 bowersj2 214: if (!defined($navmap)) {
215: my $requrl = $r->uri;
1.320 albertel 216: $env{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
1.55 bowersj2 217: return HTTP_NOT_ACCEPTABLE;
218: }
1.316 albertel 219: my $html=&Apache::lonxml::xmlbegin();
220: $r->print("$html<head>\n");
1.229 www 221: $r->print("<title>".&mt('Navigate Course Contents')."</title>");
1.150 www 222: # ------------------------------------------------------------ Get query string
1.313 albertel 223: &Apache::loncommon::get_unprocessed_cgi($ENV{'QUERY_STRING'},['register','sort','showOnlyHomework','postsymb']);
1.158 bowersj2 224:
1.150 www 225: # ----------------------------------------------------- Force menu registration
226: my $addentries='';
1.268 albertel 227: my $more_unload;
1.278 albertel 228: my $body_only='';
1.320 albertel 229: if ($env{'environment.remotenavmap'} eq 'on') {
1.268 albertel 230: $r->print('<script type="text/javascript">
231: function collapse() {
232: this.document.location="/adm/navmaps?collapseExternal";
233: }
234: </script>');
235: # FIXME need to be smarter to only catch window close events
236: # $more_unload="collapse()"
1.278 albertel 237: $body_only=1;
1.268 albertel 238: }
1.320 albertel 239: if ($env{'form.register'}) {
1.268 albertel 240: $addentries=' onLoad="'.&Apache::lonmenu::loadevents().
241: '" onUnload="'.&Apache::lonmenu::unloadevents().';'.
242: $more_unload.'"';
243: $r->print(&Apache::lonmenu::registerurl(1));
244: } else {
245: $addentries=' onUnload="'.$more_unload.'"';
1.150 www 246: }
1.111 bowersj2 247:
1.64 bowersj2 248: # Header
1.150 www 249: $r->print('</head>'.
250: &Apache::loncommon::bodytag('Navigate Course Contents','',
1.278 albertel 251: $addentries,$body_only,'',
1.320 albertel 252: $env{'form.register'}));
1.283 raeburn 253: $r->print('<script>window.focus();</script>');
1.265 albertel 254:
1.124 bowersj2 255: $r->rflush();
256:
1.55 bowersj2 257: # Check that it's defined
258: if (!($navmap->courseMapDefined())) {
1.283 raeburn 259: $r->print(&Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT'));
1.55 bowersj2 260: $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
261: '</body></html>');
262: return OK;
263: }
264:
1.178 bowersj2 265: # See if there's only one map in the top-level, if we don't
266: # already have a filter... if so, automatically display it
1.222 bowersj2 267: # (older code; should use retrieveResources)
1.179 bowersj2 268: if ($ENV{QUERY_STRING} !~ /filter/) {
1.178 bowersj2 269: my $iterator = $navmap->getIterator(undef, undef, undef, 0);
1.222 bowersj2 270: my $curRes;
1.178 bowersj2 271: my $sequenceCount = 0;
272: my $sequenceId;
1.222 bowersj2 273: while ($curRes = $iterator->next()) {
1.178 bowersj2 274: if (ref($curRes) && $curRes->is_sequence()) {
275: $sequenceCount++;
276: $sequenceId = $curRes->map_pc();
1.179 bowersj2 277: }
1.178 bowersj2 278: }
279:
280: if ($sequenceCount == 1) {
281: # The automatic iterator creation in the render call
282: # will pick this up. We know the condition because
1.320 albertel 283: # the defined($env{'form.filter'}) also ensures this
1.178 bowersj2 284: # is a fresh call.
1.320 albertel 285: $env{'form.filter'} = "$sequenceId";
1.155 bowersj2 286: }
287: }
288:
1.268 albertel 289: if ($ENV{QUERY_STRING} eq 'launchExternal') {
290: $r->print('
291: <form name="returnwin" action="/adm/flip?postdata=return%3a"
292: method="post" target="loncapaclient">
293: </form>');
294: $r->print('
295: <script type="text/javascript">
296: this.document.returnwin.submit();
297: </script>');
298: }
299:
1.320 albertel 300: if ($env{'environment.remotenavmap'} ne 'on') {
1.281 albertel 301: $r->print(&launch_win('link','yes',\%toplinkitems));
1.268 albertel 302: }
1.320 albertel 303: if ($env{'environment.remotenavmap'} eq 'on') {
1.281 albertel 304: &add_linkitem(\%toplinkitems,'closenav','collapse()',
305: "Close navigation window");
1.268 albertel 306: }
307:
1.191 bowersj2 308: my $jumpToFirstHomework = 0;
1.184 bowersj2 309: # Check to see if the student is jumping to next open, do-able problem
1.281 albertel 310: if ($ENV{QUERY_STRING} =~ /^jumpToFirstHomework/) {
1.191 bowersj2 311: $jumpToFirstHomework = 1;
1.184 bowersj2 312: # Find the next homework problem that they can do.
313: my $iterator = $navmap->getIterator(undef, undef, undef, 1);
1.222 bowersj2 314: my $curRes;
1.184 bowersj2 315: my $foundDoableProblem = 0;
316: my $problemRes;
317:
1.222 bowersj2 318: while (($curRes = $iterator->next()) && !$foundDoableProblem) {
1.184 bowersj2 319: if (ref($curRes) && $curRes->is_problem()) {
320: my $status = $curRes->status();
1.191 bowersj2 321: if ($curRes->completable()) {
1.184 bowersj2 322: $problemRes = $curRes;
323: $foundDoableProblem = 1;
324:
325: # Pop open all previous maps
326: my $stack = $iterator->getStack();
327: pop @$stack; # last resource in the stack is the problem
328: # itself, which we don't need in the map stack
329: my @mapPcs = map {$_->map_pc()} @$stack;
1.320 albertel 330: $env{'form.filter'} = join(',', @mapPcs);
1.184 bowersj2 331:
332: # Mark as both "here" and "jump"
1.320 albertel 333: $env{'form.postsymb'} = $curRes->symb();
1.184 bowersj2 334: }
335: }
336: }
337:
338: # If we found no problems, print a note to that effect.
339: if (!$foundDoableProblem) {
340: $r->print("<font size='+2'>All homework assignments have been completed.</font><br /><br />");
341: }
342: } else {
1.281 albertel 343: &add_linkitem(\%toplinkitems,'firsthomework',
344: 'location.href="navmaps?jumpToFirstHomework"',
1.287 albertel 345: "Show Me My First Homework Problem");
1.184 bowersj2 346: }
347:
1.191 bowersj2 348: my $suppressEmptySequences = 0;
349: my $filterFunc = undef;
1.201 bowersj2 350: my $resource_no_folder_link = 0;
351:
1.191 bowersj2 352: # Display only due homework.
353: my $showOnlyHomework = 0;
1.320 albertel 354: if ($env{'form.showOnlyHomework'} eq "1") {
1.191 bowersj2 355: $showOnlyHomework = 1;
356: $suppressEmptySequences = 1;
357: $filterFunc = sub { my $res = shift;
1.201 bowersj2 358: return $res->completable() || $res->is_map();
1.191 bowersj2 359: };
1.281 albertel 360: &add_linkitem(\%toplinkitems,'everything',
1.320 albertel 361: 'location.href="navmaps?sort='.$env{'form.sort'}.'"',
1.281 albertel 362: "Show Everything");
1.229 www 363: $r->print("<p><font size='+2'>".&mt("Uncompleted Homework")."</font></p>");
1.320 albertel 364: $env{'form.filter'} = '';
365: $env{'form.condition'} = 1;
1.201 bowersj2 366: $resource_no_folder_link = 1;
1.191 bowersj2 367: } else {
1.281 albertel 368: &add_linkitem(\%toplinkitems,'uncompleted',
1.320 albertel 369: 'location.href="navmaps?sort='.$env{'form.sort'}.
1.281 albertel 370: '&showOnlyHomework=1"',
371: "Show Only Uncompleted Homework");
1.191 bowersj2 372: }
373:
1.320 albertel 374: my %selected=($env{'form.sort'} => 'selected=on');
1.276 albertel 375: my $sort_html=("<form>
1.270 albertel 376: <nobr>
1.320 albertel 377: <input type=\"hidden\" name=\"showOnlyHomework\" value=\"".$env{'form.showOnlyHomework'}."\" />
1.276 albertel 378: <input type=\"submit\" value=\"".&mt('Sort by:')."\" />
1.270 albertel 379: <select name=\"sort\">
1.276 albertel 380: <option value=\"default\" $selected{'default'}>".&mt('Default')."</option>
381: <option value=\"title\" $selected{'title'} >".&mt('Title')."</option>
382: <option value=\"duedate\" $selected{'duedate'}>".&mt('Duedate')."</option>
1.307 raeburn 383: <option value=\"discussion\" $selected{'discussion'}>".&mt('Has New Discussion')."</option>
1.270 albertel 384: </select>
385: </nobr>
386: </form>");
1.133 bowersj2 387: # renderer call
1.285 albertel 388: my $renderArgs = { 'cols' => [0,1,2,3],
1.320 albertel 389: 'sort' => $env{'form.sort'},
1.191 bowersj2 390: 'url' => '/adm/navmaps',
391: 'navmap' => $navmap,
392: 'suppressNavmap' => 1,
393: 'suppressEmptySequences' => $suppressEmptySequences,
394: 'filterFunc' => $filterFunc,
1.201 bowersj2 395: 'resource_no_folder_link' => $resource_no_folder_link,
1.276 albertel 396: 'sort_html'=> $sort_html,
1.281 albertel 397: 'r' => $r,
398: 'caller' => 'navmapsdisplay',
399: 'linkitems' => \%toplinkitems};
1.191 bowersj2 400: my $render = render($renderArgs);
1.133 bowersj2 401:
1.191 bowersj2 402: # If no resources were printed, print a reassuring message so the
403: # user knows there was no error.
404: if ($renderArgs->{'counter'} == 0) {
405: if ($showOnlyHomework) {
1.229 www 406: $r->print("<p><font size='+1'>".&mt("All homework is currently completed").".</font></p>");
1.191 bowersj2 407: } else { # both jumpToFirstHomework and normal use the same: course must be empty
408: $r->print("<p><font size='+1'>This course is empty.</font></p>");
409: }
410: }
1.316 albertel 411: #my $td=&tv_interval($t0);
412: #$r->print("<br />$td");
1.51 bowersj2 413:
1.128 bowersj2 414: $r->print("</body></html>");
1.134 bowersj2 415: $r->rflush();
1.59 bowersj2 416:
1.51 bowersj2 417: return OK;
418: }
419:
420: # Convenience functions: Returns a string that adds or subtracts
421: # the second argument from the first hash, appropriate for the
422: # query string that determines which folders to recurse on
423: sub addToFilter {
424: my $hashIn = shift;
425: my $addition = shift;
426: my %hash = %$hashIn;
427: $hash{$addition} = 1;
428:
429: return join (",", keys(%hash));
430: }
431:
432: sub removeFromFilter {
433: my $hashIn = shift;
434: my $subtraction = shift;
435: my %hash = %$hashIn;
436:
437: delete $hash{$subtraction};
438: return join(",", keys(%hash));
439: }
440:
441: # Convenience function: Given a stack returned from getStack on the iterator,
442: # return the correct src() value.
443: sub getLinkForResource {
444: my $stack = shift;
445: my $res;
446:
447: # Check to see if there are any pages in the stack
448: foreach $res (@$stack) {
1.248 www 449: if (defined($res)) {
1.308 albertel 450: my $anchor;
1.248 www 451: if ($res->is_page()) {
1.308 albertel 452: foreach (@$stack) { if (defined($_)) { $anchor = $_; } }
453: $anchor=&Apache::lonnet::escape($anchor->shown_symb());
454: return ($res->link(),$res->shown_symb(),$anchor);
1.248 www 455: }
456: # in case folder was skipped over as "only sequence"
457: my ($map,$id,$src)=&Apache::lonnet::decode_symb($res->symb());
458: if ($map=~/\.page$/) {
1.308 albertel 459: my $url=&Apache::lonnet::clutter($map);
460: $anchor=&Apache::lonnet::escape($src->shown_symb());
461: return ($url,$res->shown_symb(),$anchor);
1.248 www 462: }
1.51 bowersj2 463: }
464: }
465:
466: # Failing that, return the src of the last resource that is defined
467: # (when we first recurse on a map, it puts an undefined resource
468: # on the bottom because $self->{HERE} isn't defined yet, and we
469: # want the src for the map anyhow)
470: foreach (@$stack) {
471: if (defined($_)) { $res = $_; }
472: }
473:
1.308 albertel 474: return ($res->link(),$res->shown_symb());
1.51 bowersj2 475: }
476:
1.251 www 477: # Convenience function: This separates the logic of how to create
1.53 bowersj2 478: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
1.251 www 479: # etc.) into a separate function. It takes a resource object as the
1.53 bowersj2 480: # first parameter, and the part number of the resource as the second.
481: # It's basically a big switch statement on the status of the resource.
482:
483: sub getDescription {
484: my $res = shift;
485: my $part = shift;
1.69 bowersj2 486: my $status = $res->status($part);
1.53 bowersj2 487:
1.182 bowersj2 488: if ($status == $res->NETWORK_FAILURE) {
1.229 www 489: return &mt("Having technical difficulties; please check status later");
1.182 bowersj2 490: }
1.53 bowersj2 491: if ($status == $res->NOTHING_SET) {
1.229 www 492: return &mt("Not currently assigned.");
1.53 bowersj2 493: }
494: if ($status == $res->OPEN_LATER) {
1.73 bowersj2 495: return "Open " . timeToHumanString($res->opendate($part));
1.53 bowersj2 496: }
497: if ($status == $res->OPEN) {
1.79 bowersj2 498: if ($res->duedate($part)) {
1.229 www 499: return &mt("Due")." " .timeToHumanString($res->duedate($part));
1.66 bowersj2 500: } else {
1.229 www 501: return &mt("Open, no due date");
1.66 bowersj2 502: }
1.53 bowersj2 503: }
1.54 bowersj2 504: if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.229 www 505: return &mt("Answer open")." " . timeToHumanString($res->answerdate($part));
1.54 bowersj2 506: }
507: if ($status == $res->PAST_DUE_NO_ANSWER) {
1.229 www 508: return &mt("Was due")." " . timeToHumanString($res->duedate($part));
1.53 bowersj2 509: }
510: if ($status == $res->ANSWER_OPEN) {
1.229 www 511: return &mt("Answer available");
1.53 bowersj2 512: }
1.59 bowersj2 513: if ($status == $res->EXCUSED) {
1.229 www 514: return &mt("Excused by instructor");
1.59 bowersj2 515: }
1.69 bowersj2 516: if ($status == $res->ATTEMPTED) {
1.229 www 517: return &mt("Answer submitted, not yet graded");
1.69 bowersj2 518: }
1.59 bowersj2 519: if ($status == $res->TRIES_LEFT) {
1.79 bowersj2 520: my $tries = $res->tries($part);
521: my $maxtries = $res->maxtries($part);
522: my $triesString = "";
523: if ($tries && $maxtries) {
524: $triesString = "<font size=\"-1\"><i>($tries of $maxtries tries used)</i></font>";
525: if ($maxtries > 1 && $maxtries - $tries == 1) {
526: $triesString = "<b>$triesString</b>";
527: }
528: }
1.244 albertel 529: if ($res->duedate($part)) {
1.229 www 530: return &mt("Due")." " . timeToHumanString($res->duedate($part)) .
1.66 bowersj2 531: " $triesString";
532: } else {
1.229 www 533: return &mt("No due date")." $triesString";
1.66 bowersj2 534: }
1.59 bowersj2 535: }
1.185 bowersj2 536: if ($status == $res->ANSWER_SUBMITTED) {
1.229 www 537: return &mt('Answer submitted');
1.185 bowersj2 538: }
1.53 bowersj2 539: }
540:
1.115 bowersj2 541: # Convenience function, so others can use it: Is the problem due in less then
542: # 24 hours, and still can be done?
543:
1.252 matthew 544: sub dueInLessThan24Hours {
1.115 bowersj2 545: my $res = shift;
546: my $part = shift;
547: my $status = $res->status($part);
548:
1.207 bowersj2 549: return ($status == $res->OPEN() ||
1.115 bowersj2 550: $status == $res->TRIES_LEFT()) &&
1.244 albertel 551: $res->duedate($part) && $res->duedate($part) < time()+(24*60*60) &&
552: $res->duedate($part) > time();
1.115 bowersj2 553: }
554:
555: # Convenience function, so others can use it: Is there only one try remaining for the
556: # part, with more then one try to begin with, not due yet and still can be done?
557: sub lastTry {
558: my $res = shift;
559: my $part = shift;
560:
561: my $tries = $res->tries($part);
562: my $maxtries = $res->maxtries($part);
563: return $tries && $maxtries && $maxtries > 1 &&
1.244 albertel 564: $maxtries - $tries == 1 && $res->duedate($part) &&
565: $res->duedate($part) > time();
1.115 bowersj2 566: }
567:
1.320 albertel 568: # This puts a human-readable name on the env variable.
1.177 www 569:
1.68 bowersj2 570: sub advancedUser {
1.320 albertel 571: return $env{'request.role.adv'};
1.68 bowersj2 572: }
573:
1.73 bowersj2 574:
575: # timeToHumanString takes a time number and converts it to a
576: # human-readable representation, meant to be used in the following
577: # manner:
578: # print "Due $timestring"
579: # print "Open $timestring"
580: # print "Answer available $timestring"
581: # Very, very, very, VERY English-only... goodness help a localizer on
582: # this func...
1.53 bowersj2 583: sub timeToHumanString {
1.58 albertel 584: my ($time) = @_;
585: # zero, '0' and blank are bad times
1.73 bowersj2 586: if (!$time) {
1.229 www 587: return &mt('never');
1.73 bowersj2 588: }
1.231 www 589: unless (&Apache::lonlocal::current_language()=~/^en/) {
1.237 www 590: return &Apache::lonlocal::locallocaltime($time);
1.229 www 591: }
1.73 bowersj2 592: my $now = time();
593:
594: my @time = localtime($time);
595: my @now = localtime($now);
596:
597: # Positive = future
598: my $delta = $time - $now;
599:
600: my $minute = 60;
601: my $hour = 60 * $minute;
602: my $day = 24 * $hour;
603: my $week = 7 * $day;
604: my $inPast = 0;
605:
606: # Logic in comments:
607: # Is it now? (extremely unlikely)
608: if ( $delta == 0 ) {
609: return "this instant";
610: }
611:
612: if ($delta < 0) {
613: $inPast = 1;
614: $delta = -$delta;
615: }
616:
617: if ( $delta > 0 ) {
1.101 bowersj2 618:
1.73 bowersj2 619: my $tense = $inPast ? " ago" : "";
620: my $prefix = $inPast ? "" : "in ";
1.101 bowersj2 621:
622: # Less then a minute
1.73 bowersj2 623: if ( $delta < $minute ) {
624: if ($delta == 1) { return "${prefix}1 second$tense"; }
625: return "$prefix$delta seconds$tense";
626: }
627:
1.101 bowersj2 628: # Less then an hour
1.73 bowersj2 629: if ( $delta < $hour ) {
630: # If so, use minutes
631: my $minutes = floor($delta / 60);
632: if ($minutes == 1) { return "${prefix}1 minute$tense"; }
633: return "$prefix$minutes minutes$tense";
634: }
635:
636: # Is it less then 24 hours away? If so,
637: # display hours + minutes
638: if ( $delta < $hour * 24) {
639: my $hours = floor($delta / $hour);
640: my $minutes = floor(($delta % $hour) / $minute);
641: my $hourString = "$hours hours";
642: my $minuteString = ", $minutes minutes";
643: if ($hours == 1) {
644: $hourString = "1 hour";
645: }
646: if ($minutes == 1) {
647: $minuteString = ", 1 minute";
648: }
649: if ($minutes == 0) {
650: $minuteString = "";
651: }
652: return "$prefix$hourString$minuteString$tense";
653: }
654:
655: # Less then 5 days away, display day of the week and
656: # HH:MM
657: if ( $delta < $day * 5 ) {
1.85 bowersj2 658: my $timeStr = strftime("%A, %b %e at %I:%M %P", localtime($time));
1.238 albertel 659: $timeStr =~ s/12:00 am/00:00/;
1.73 bowersj2 660: $timeStr =~ s/12:00 pm/noon/;
661: return ($inPast ? "last " : "next ") .
662: $timeStr;
663: }
664:
665: # Is it this year?
666: if ( $time[5] == $now[5]) {
667: # Return on Month Day, HH:MM meridian
668: my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
1.238 albertel 669: $timeStr =~ s/12:00 am/00:00/;
1.73 bowersj2 670: $timeStr =~ s/12:00 pm/noon/;
671: return $timeStr;
672: }
673:
674: # Not this year, so show the year
1.279 albertel 675: my $timeStr = strftime("on %A, %b %e %Y at %I:%M %P", localtime($time));
1.238 albertel 676: $timeStr =~ s/12:00 am/00:00/;
1.73 bowersj2 677: $timeStr =~ s/12:00 pm/noon/;
678: return $timeStr;
1.58 albertel 679: }
1.53 bowersj2 680: }
681:
1.51 bowersj2 682:
1.133 bowersj2 683: =pod
684:
1.174 albertel 685: =head1 NAME
686:
1.217 bowersj2 687: Apache::lonnavmap - Subroutines to handle and render the navigation
688: maps
1.174 albertel 689:
690: =head1 SYNOPSIS
691:
692: The main handler generates the navigational listing for the course,
693: the other objects export this information in a usable fashion for
1.205 bowersj2 694: other modules.
1.133 bowersj2 695:
1.216 bowersj2 696: =head1 OVERVIEW
697:
1.217 bowersj2 698: X<lonnavmaps, overview> When a user enters a course, LON-CAPA examines the
1.218 bowersj2 699: course structure and caches it in what is often referred to as the
700: "big hash" X<big hash>. You can see it if you are logged into
701: LON-CAPA, in a course, by going to /adm/test. (You may need to
702: tweak the /home/httpd/lonTabs/htpasswd file to view it.) The
703: content of the hash will be under the heading "Big Hash".
1.216 bowersj2 704:
705: Big Hash contains, among other things, how resources are related
706: to each other (next/previous), what resources are maps, which
707: resources are being chosen to not show to the student (for random
708: selection), and a lot of other things that can take a lot of time
709: to compute due to the amount of data that needs to be collected and
710: processed.
711:
712: Apache::lonnavmaps provides an object model for manipulating this
713: information in a higher-level fashion then directly manipulating
714: the hash. It also provides access to several auxilary functions
715: that aren't necessarily stored in the Big Hash, but are a per-
716: resource sort of value, like whether there is any feedback on
717: a given resource.
718:
719: Apache::lonnavmaps also abstracts away branching, and someday,
720: conditions, for the times where you don't really care about those
721: things.
722:
723: Apache::lonnavmaps also provides fairly powerful routines for
724: rendering navmaps, and last but not least, provides the navmaps
725: view for when the user clicks the NAV button.
726:
727: B<Note>: Apache::lonnavmaps I<only> works for the "currently
728: logged in user"; if you want things like "due dates for another
729: student" lonnavmaps can not directly retrieve information like
730: that. You need the EXT function. This module can still help,
731: because many things, such as the course structure, are constant
732: between users, and Apache::lonnavmaps can help by providing
733: symbs for the EXT call.
734:
735: The rest of this file will cover the provided rendering routines,
736: which can often be used without fiddling with the navmap object at
737: all, then documents the Apache::lonnavmaps::navmap object, which
738: is the key to accessing the Big Hash information, covers the use
739: of the Iterator (which provides the logic for traversing the
740: somewhat-complicated Big Hash data structure), documents the
741: Apache::lonnavmaps::Resource objects that are returned by
742:
1.205 bowersj2 743: =head1 Subroutine: render
1.133 bowersj2 744:
1.174 albertel 745: The navmap renderer package provides a sophisticated rendering of the
746: standard navigation maps interface into HTML. The provided nav map
747: handler is actually just a glorified call to this.
1.133 bowersj2 748:
1.216 bowersj2 749: Because of the large number of parameters this function accepts,
1.174 albertel 750: instead of passing it arguments as is normal, pass it in an anonymous
1.216 bowersj2 751: hash with the desired options.
1.174 albertel 752:
753: The package provides a function called 'render', called as
1.205 bowersj2 754: Apache::lonnavmaps::render({}).
1.51 bowersj2 755:
1.133 bowersj2 756: =head2 Overview of Columns
1.51 bowersj2 757:
1.174 albertel 758: The renderer will build an HTML table for the navmap and return
759: it. The table is consists of several columns, and a row for each
760: resource (or possibly each part). You tell the renderer how many
761: columns to create and what to place in each column, optionally using
1.205 bowersj2 762: one or more of the prepared columns, and the renderer will assemble
1.174 albertel 763: the table.
764:
765: Any additional generally useful column types should be placed in the
766: renderer code here, so anybody can use it anywhere else. Any code
767: specific to the current application (such as the addition of <input>
768: elements in a column) should be placed in the code of the thing using
769: the renderer.
770:
771: At the core of the renderer is the array reference COLS (see Example
772: section below for how to pass this correctly). The COLS array will
773: consist of entries of one of two types of things: Either an integer
774: representing one of the pre-packaged column types, or a sub reference
775: that takes a resource reference, a part number, and a reference to the
776: argument hash passed to the renderer, and returns a string that will
777: be inserted into the HTML representation as it.
778:
1.216 bowersj2 779: All other parameters are ways of either changing how the columns
780: are printing, or which rows are shown.
781:
1.174 albertel 782: The pre-packaged column names are refered to by constants in the
1.205 bowersj2 783: Apache::lonnavmaps namespace. The following currently exist:
1.51 bowersj2 784:
1.174 albertel 785: =over 4
1.51 bowersj2 786:
1.216 bowersj2 787: =item * B<Apache::lonnavmaps::resource>:
1.51 bowersj2 788:
1.174 albertel 789: The general info about the resource: Link, icon for the type, etc. The
1.216 bowersj2 790: first column in the standard nav map display. This column provides the
791: indentation effect seen in the B<NAV> screen. This column also accepts
1.205 bowersj2 792: the following parameters in the renderer hash:
1.51 bowersj2 793:
1.133 bowersj2 794: =over 4
1.51 bowersj2 795:
1.216 bowersj2 796: =item * B<resource_nolink>: default false
1.51 bowersj2 797:
1.216 bowersj2 798: If true, the resource will not be linked. By default, all non-folder
799: resources are linked.
1.174 albertel 800:
1.216 bowersj2 801: =item * B<resource_part_count>: default true
1.51 bowersj2 802:
1.216 bowersj2 803: If true, the resource will show a part count B<if> the full
804: part list is not displayed. (See "condense_parts" later.) If false,
805: the resource will never show a part count.
1.133 bowersj2 806:
1.174 albertel 807: =item * B<resource_no_folder_link>:
1.133 bowersj2 808:
1.174 albertel 809: If true, the resource's folder will not be clickable to open or close
810: it. Default is false. True implies printCloseAll is false, since you
811: can't close or open folders when this is on anyhow.
1.144 bowersj2 812:
1.133 bowersj2 813: =back
1.51 bowersj2 814:
1.225 bowersj2 815: =item * B<Apache::lonnavmaps::communication_status>:
1.174 albertel 816:
817: Whether there is discussion on the resource, email for the user, or
818: (lumped in here) perl errors in the execution of the problem. This is
819: the second column in the main nav map.
820:
1.225 bowersj2 821: =item * B<Apache::lonnavmaps::quick_status>:
1.51 bowersj2 822:
1.216 bowersj2 823: An icon for the status of a problem, with five possible states:
824: Correct, incorrect, open, awaiting grading (for a problem where the
825: computer's grade is suppressed, or the computer can't grade, like
826: essay problem), or none (not open yet, not a problem). The
1.174 albertel 827: third column of the standard navmap.
1.51 bowersj2 828:
1.225 bowersj2 829: =item * B<Apache::lonnavmaps::long_status>:
1.174 albertel 830:
831: A text readout of the details of the current status of the problem,
832: such as "Due in 22 hours". The fourth column of the standard navmap.
1.51 bowersj2 833:
1.225 bowersj2 834: =item * B<Apache::lonnavmaps::part_status_summary>:
835:
836: A text readout summarizing the status of the problem. If it is a
837: single part problem, will display "Correct", "Incorrect",
838: "Not yet open", "Open", "Attempted", or "Error". If there are
839: multiple parts, this will output a string that in HTML will show a
840: status of how many parts are in each status, in color coding, trying
841: to match the colors of the icons within reason.
842:
843: Note this only makes sense if you are I<not> showing parts. If
844: C<showParts> is true (see below), this column will not output
845: anything.
846:
1.133 bowersj2 847: =back
1.51 bowersj2 848:
1.133 bowersj2 849: If you add any others please be sure to document them here.
1.51 bowersj2 850:
1.174 albertel 851: An example of a column renderer that will show the ID number of a
852: resource, along with the part name if any:
1.51 bowersj2 853:
1.133 bowersj2 854: sub {
855: my ($resource, $part, $params) = @_;
856: if ($part) { return '<td>' . $resource->{ID} . ' ' . $part . '</td>'; }
857: return '<td>' . $resource->{ID} . '</td>';
858: }
1.51 bowersj2 859:
1.174 albertel 860: Note these functions are responsible for the TD tags, which allow them
861: to override vertical and horizontal alignment, etc.
1.130 www 862:
1.133 bowersj2 863: =head2 Parameters
1.115 bowersj2 864:
1.217 bowersj2 865: Minimally, you should be
1.174 albertel 866: able to get away with just using 'cols' (to specify the columns
867: shown), 'url' (necessary for the folders to link to the current screen
868: correctly), and possibly 'queryString' if your app calls for it. In
869: that case, maintaining the state of the folders will be done
870: automatically.
1.140 bowersj2 871:
1.133 bowersj2 872: =over 4
1.51 bowersj2 873:
1.320 albertel 874: =item * B<iterator>: default: constructs one from %env
1.174 albertel 875:
876: A reference to a fresh ::iterator to use from the navmaps. The
877: rendering will reflect the options passed to the iterator, so you can
878: use that to just render a certain part of the course, if you like. If
879: one is not passed, the renderer will attempt to construct one from
1.320 albertel 880: env{'form.filter'} and env{'form.condition'} information, plus the
1.174 albertel 881: 'iterator_map' parameter if any.
882:
1.216 bowersj2 883: =item * B<iterator_map>: default: not used
1.174 albertel 884:
885: If you are letting the renderer do the iterator handling, you can
886: instruct the renderer to render only a particular map by passing it
887: the source of the map you want to process, like
888: '/res/103/jerf/navmap.course.sequence'.
889:
1.320 albertel 890: =item * B<navmap>: default: constructs one from %env
1.174 albertel 891:
892: A reference to a navmap, used only if an iterator is not passed in. If
893: this is necessary to make an iterator but it is not passed in, a new
1.320 albertel 894: one will be constructed based on env info. This is useful to do basic
1.174 albertel 895: error checking before passing it off to render.
896:
1.216 bowersj2 897: =item * B<r>: default: must be passed in
1.174 albertel 898:
899: The standard Apache response object. This must be passed to the
900: renderer or the course hash will be locked.
901:
1.216 bowersj2 902: =item * B<cols>: default: empty (useless)
1.174 albertel 903:
904: An array reference
905:
1.216 bowersj2 906: =item * B<showParts>:default true
1.174 albertel 907:
1.216 bowersj2 908: A flag. If true, a line for the resource itself, and a line
1.174 albertel 909: for each part will be displayed. If not, only one line for each
910: resource will be displayed.
911:
1.216 bowersj2 912: =item * B<condenseParts>: default true
1.174 albertel 913:
1.216 bowersj2 914: A flag. If true, if all parts of the problem have the same
1.174 albertel 915: status and that status is Nothing Set, Correct, or Network Failure,
916: then only one line will be displayed for that resource anyhow. If no,
917: all parts will always be displayed. If showParts is 0, this is
918: ignored.
919:
1.320 albertel 920: =item * B<jumpCount>: default: determined from %env
1.174 albertel 921:
1.216 bowersj2 922: A string identifying the URL to place the anchor 'curloc' at.
923: It is the responsibility of the renderer user to
1.174 albertel 924: ensure that the #curloc is in the URL. By default, determined through
1.320 albertel 925: the use of the env{} 'jump' information, and should normally "just
1.174 albertel 926: work" correctly.
1.144 bowersj2 927:
1.216 bowersj2 928: =item * B<here>: default: empty string
1.140 bowersj2 929:
1.216 bowersj2 930: A Symb identifying where to place the 'here' marker. The empty
931: string means no marker.
1.92 bowersj2 932:
1.216 bowersj2 933: =item * B<indentString>: default: 25 pixel whitespace image
1.164 bowersj2 934:
1.216 bowersj2 935: A string identifying the indentation string to use.
1.92 bowersj2 936:
1.216 bowersj2 937: =item * B<queryString>: default: empty
1.51 bowersj2 938:
1.174 albertel 939: A string which will be prepended to the query string used when the
1.216 bowersj2 940: folders are opened or closed. You can use this to pass
941: application-specific values.
1.55 bowersj2 942:
1.216 bowersj2 943: =item * B<url>: default: none
1.84 bowersj2 944:
1.174 albertel 945: The url the folders will link to, which should be the current
1.216 bowersj2 946: page. Required if the resource info column is shown, and you
947: are allowing the user to open and close folders.
1.115 bowersj2 948:
1.216 bowersj2 949: =item * B<currentJumpIndex>: default: no jumping
1.55 bowersj2 950:
1.174 albertel 951: Describes the currently-open row number to cause the browser to jump
952: to, because the user just opened that folder. By default, pulled from
1.320 albertel 953: the Jump information in the env{'form.*'}.
1.51 bowersj2 954:
1.216 bowersj2 955: =item * B<printKey>: default: false
1.51 bowersj2 956:
1.174 albertel 957: If true, print the key that appears on the top of the standard
1.216 bowersj2 958: navmaps.
1.139 bowersj2 959:
1.216 bowersj2 960: =item * B<printCloseAll>: default: true
1.140 bowersj2 961:
1.174 albertel 962: If true, print the "Close all folders" or "open all folders"
1.216 bowersj2 963: links.
1.140 bowersj2 964:
1.216 bowersj2 965: =item * B<filterFunc>: default: sub {return 1;} (accept everything)
1.153 bowersj2 966:
1.174 albertel 967: A function that takes the resource object as its only parameter and
968: returns a true or false value. If true, the resource is displayed. If
1.216 bowersj2 969: false, it is simply skipped in the display.
1.174 albertel 970:
1.216 bowersj2 971: =item * B<suppressEmptySequences>: default: false
1.190 bowersj2 972:
973: If you're using a filter function, and displaying sequences to orient
974: the user, then frequently some sequences will be empty. Setting this to
975: true will cause those sequences not to display, so as not to confuse the
976: user into thinking that if the sequence is there there should be things
1.216 bowersj2 977: under it; for example, see the "Show Uncompleted Homework" view on the
978: B<NAV> screen.
1.190 bowersj2 979:
1.216 bowersj2 980: =item * B<suppressNavmaps>: default: false
1.174 albertel 981:
1.216 bowersj2 982: If true, will not display Navigate Content resources.
1.143 bowersj2 983:
1.133 bowersj2 984: =back
1.51 bowersj2 985:
1.133 bowersj2 986: =head2 Additional Info
1.51 bowersj2 987:
1.174 albertel 988: In addition to the parameters you can pass to the renderer, which will
989: be passed through unchange to the column renderers, the renderer will
990: generate the following information which your renderer may find
991: useful:
992:
1.216 bowersj2 993: =over 4
994:
995: =item * B<counter>:
1.145 bowersj2 996:
1.216 bowersj2 997: Contains the number of rows printed. Useful after calling the render
998: function, as you can detect whether anything was printed at all.
999:
1000: =item * B<isNewBranch>:
1001:
1002: Useful for renderers: If this resource is currently the first resource
1003: of a new branch, this will be true. The Resource column (leftmost in the
1004: navmaps screen) uses this to display the "new branch" icon
1.59 bowersj2 1005:
1.133 bowersj2 1006: =back
1.59 bowersj2 1007:
1.133 bowersj2 1008: =cut
1.59 bowersj2 1009:
1.133 bowersj2 1010: sub resource { return 0; }
1011: sub communication_status { return 1; }
1012: sub quick_status { return 2; }
1013: sub long_status { return 3; }
1.225 bowersj2 1014: sub part_status_summary { return 4; }
1.51 bowersj2 1015:
1.133 bowersj2 1016: sub render_resource {
1017: my ($resource, $part, $params) = @_;
1.51 bowersj2 1018:
1.133 bowersj2 1019: my $nonLinkedText = ''; # stuff after resource title not in link
1.51 bowersj2 1020:
1.134 bowersj2 1021: my $link = $params->{"resourceLink"};
1.306 foxr 1022:
1023: # The URL part is not escaped at this point, but the symb is...
1024: # The stuff to the left of the ? must have ' replaced by \' since
1025: # it will be quoted with ' in the href.
1026:
1027: my ($left,$right) = split(/\?/, $link);
1028: $left =~ s/'/\\'/g;
1029: $link = $left.'?'.$right;
1030:
1.134 bowersj2 1031: my $src = $resource->src();
1032: my $it = $params->{"iterator"};
1.133 bowersj2 1033: my $filter = $it->{FILTER};
1034:
1035: my $title = $resource->compTitle();
1.258 albertel 1036:
1.133 bowersj2 1037: my $partLabel = "";
1038: my $newBranchText = "";
1.298 albertel 1039: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons");
1.133 bowersj2 1040: # If this is a new branch, label it so
1041: if ($params->{'isNewBranch'}) {
1.298 albertel 1042: $newBranchText = "<img src='$location/branch.gif' border='0' />";
1.51 bowersj2 1043: }
1044:
1.133 bowersj2 1045: # links to open and close the folder
1.306 foxr 1046:
1047:
1.133 bowersj2 1048: my $linkopen = "<a href='$link'>";
1.306 foxr 1049:
1050:
1.133 bowersj2 1051: my $linkclose = "</a>";
1.51 bowersj2 1052:
1.204 albertel 1053: # Default icon: unknown page
1.298 albertel 1054: my $icon = "<img src='$location/unknown.gif' alt='' border='0' />";
1.133 bowersj2 1055:
1056: if ($resource->is_problem()) {
1.192 bowersj2 1057: if ($part eq '0' || $params->{'condensed'}) {
1.298 albertel 1058: $icon ='<img src="'.$location.'/problem.gif" alt="" border="0" />';
1.133 bowersj2 1059: } else {
1060: $icon = $params->{'indentString'};
1061: }
1.204 albertel 1062: } else {
1.319 albertel 1063: $icon = "<img src='".&Apache::loncommon::icon($resource->src)."' alt='' border='0' />";
1.133 bowersj2 1064: }
1.51 bowersj2 1065:
1.133 bowersj2 1066: # Display the correct map icon to open or shut map
1067: if ($resource->is_map()) {
1068: my $mapId = $resource->map_pc();
1069: my $nowOpen = !defined($filter->{$mapId});
1070: if ($it->{CONDITION}) {
1071: $nowOpen = !$nowOpen;
1072: }
1.144 bowersj2 1073:
1.205 bowersj2 1074: my $folderType = $resource->is_sequence() ? 'folder' : 'page';
1075:
1.144 bowersj2 1076: if (!$params->{'resource_no_folder_link'}) {
1.205 bowersj2 1077: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') . '.gif';
1.298 albertel 1078: $icon = "<img src='$location/$icon' alt='' border='0' />";
1.144 bowersj2 1079:
1080: $linkopen = "<a href='" . $params->{'url'} . '?' .
1081: $params->{'queryString'} . '&filter=';
1082: $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
1083: addToFilter($filter, $mapId) :
1084: removeFromFilter($filter, $mapId);
1085: $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
1086: . $params->{'hereType'} . '&here=' .
1087: &Apache::lonnet::escape($params->{'here'}) .
1.159 bowersj2 1088: '&jump=' .
1.144 bowersj2 1089: &Apache::lonnet::escape($resource->symb()) .
1090: "&folderManip=1'>";
1.306 foxr 1091:
1.144 bowersj2 1092: } else {
1093: # Don't allow users to manipulate folder
1.205 bowersj2 1094: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
1.144 bowersj2 1095: '.nomanip.gif';
1.298 albertel 1096: $icon = "<img src='$location/$icon' alt='' border='0' />";
1.144 bowersj2 1097:
1098: $linkopen = "";
1099: $linkclose = "";
1100: }
1.133 bowersj2 1101: }
1.51 bowersj2 1102:
1.133 bowersj2 1103: if ($resource->randomout()) {
1104: $nonLinkedText .= ' <i>(hidden)</i> ';
1105: }
1106:
1107: # We're done preparing and finally ready to start the rendering
1108: my $result = "<td align='left' valign='center'>";
1.140 bowersj2 1109:
1110: my $indentLevel = $params->{'indentLevel'};
1111: if ($newBranchText) { $indentLevel--; }
1112:
1.133 bowersj2 1113: # print indentation
1.140 bowersj2 1114: for (my $i = 0; $i < $indentLevel; $i++) {
1.133 bowersj2 1115: $result .= $params->{'indentString'};
1.84 bowersj2 1116: }
1117:
1.133 bowersj2 1118: # Decide what to display
1.306 foxr 1119:
1.133 bowersj2 1120: $result .= "$newBranchText$linkopen$icon$linkclose";
1121:
1122: my $curMarkerBegin = '';
1123: my $curMarkerEnd = '';
1.51 bowersj2 1124:
1.133 bowersj2 1125: # Is this the current resource?
1.158 bowersj2 1126: if (!$params->{'displayedHereMarker'} &&
1127: $resource->symb() eq $params->{'here'} ) {
1.133 bowersj2 1128: $curMarkerBegin = '<font color="red" size="+2">> </font>';
1129: $curMarkerEnd = '<font color="red" size="+2"><</font>';
1.158 bowersj2 1130: $params->{'displayedHereMarker'} = 1;
1.51 bowersj2 1131: }
1132:
1.192 bowersj2 1133: if ($resource->is_problem() && $part ne '0' &&
1.133 bowersj2 1134: !$params->{'condensed'}) {
1.274 matthew 1135: my $displaypart=$resource->part_display($part);
1.245 www 1136: $partLabel = " (Part: $displaypart)";
1.309 albertel 1137: if ($link!~/\#/) { $link.='#'.&Apache::lonnet::escape($part); }
1.133 bowersj2 1138: $title = "";
1.51 bowersj2 1139: }
1140:
1.163 bowersj2 1141: if ($params->{'condensed'} && $resource->countParts() > 1) {
1.133 bowersj2 1142: $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
1.51 bowersj2 1143: }
1144:
1.268 albertel 1145: my $target;
1.320 albertel 1146: if ($env{'environment.remotenavmap'} eq 'on') {
1.268 albertel 1147: $target=' target="loncapaclient" ';
1148: }
1.266 raeburn 1149: if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
1.268 albertel 1150: $result .= " $curMarkerBegin<a $target href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
1.144 bowersj2 1151: } else {
1152: $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
1153: }
1.51 bowersj2 1154:
1.133 bowersj2 1155: return $result;
1156: }
1.51 bowersj2 1157:
1.133 bowersj2 1158: sub render_communication_status {
1159: my ($resource, $part, $params) = @_;
1.134 bowersj2 1160: my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
1161:
1162: my $link = $params->{"resourceLink"};
1163: my $linkopen = "<a href='$link'>";
1164: my $linkclose = "</a>";
1.298 albertel 1165: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1.134 bowersj2 1166: if ($resource->hasDiscussion()) {
1167: $discussionHTML = $linkopen .
1.298 albertel 1168: '<img border="0" src="'.$location.'/chat.gif" />' .
1.134 bowersj2 1169: $linkclose;
1170: }
1171:
1172: if ($resource->getFeedback()) {
1173: my $feedback = $resource->getFeedback();
1174: foreach (split(/\,/, $feedback)) {
1175: if ($_) {
1176: $feedbackHTML .= ' <a href="/adm/email?display='
1177: . &Apache::lonnet::escape($_) . '">'
1.298 albertel 1178: . '<img src="'.$location.'/feedback.gif" '
1.134 bowersj2 1179: . 'border="0" /></a>';
1180: }
1181: }
1182: }
1183:
1184: if ($resource->getErrors()) {
1185: my $errors = $resource->getErrors();
1.254 matthew 1186: my $errorcount = 0;
1.134 bowersj2 1187: foreach (split(/,/, $errors)) {
1.254 matthew 1188: last if ($errorcount>=10); # Only output 10 bombs maximum
1.134 bowersj2 1189: if ($_) {
1.254 matthew 1190: $errorcount++;
1.134 bowersj2 1191: $errorHTML .= ' <a href="/adm/email?display='
1192: . &Apache::lonnet::escape($_) . '">'
1.298 albertel 1193: . '<img src="'.$location.'/bomb.gif" '
1.134 bowersj2 1194: . 'border="0" /></a>';
1195: }
1196: }
1.197 bowersj2 1197: }
1198:
1199: if ($params->{'multipart'} && $part != '0') {
1200: $discussionHTML = $feedbackHTML = $errorHTML = '';
1.134 bowersj2 1201: }
1202:
1203: return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>";
1204:
1.133 bowersj2 1205: }
1206: sub render_quick_status {
1207: my ($resource, $part, $params) = @_;
1.135 bowersj2 1208: my $result = "";
1209: my $firstDisplayed = !$params->{'condensed'} &&
1210: $params->{'multipart'} && $part eq "0";
1211:
1212: my $link = $params->{"resourceLink"};
1213: my $linkopen = "<a href='$link'>";
1214: my $linkclose = "</a>";
1215:
1216: if ($resource->is_problem() &&
1217: !$firstDisplayed) {
1.224 bowersj2 1218:
1219: my $icon = $statusIconMap{$resource->simpleStatus($part)};
1.135 bowersj2 1220: my $alt = $iconAltTags{$icon};
1221: if ($icon) {
1.298 albertel 1222: my $location=
1223: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
1224: $result .= "<td width='30' valign='center' width='50' align='right'>$linkopen<img width='25' height='25' src='$location' border='0' alt='$alt' />$linkclose</td>\n";
1.135 bowersj2 1225: } else {
1226: $result .= "<td width='30'> </td>\n";
1227: }
1228: } else { # not problem, no icon
1229: $result .= "<td width='30'> </td>\n";
1230: }
1231:
1232: return $result;
1.133 bowersj2 1233: }
1234: sub render_long_status {
1235: my ($resource, $part, $params) = @_;
1.136 bowersj2 1236: my $result = "<td align='right' valign='center'>\n";
1237: my $firstDisplayed = !$params->{'condensed'} &&
1238: $params->{'multipart'} && $part eq "0";
1239:
1240: my $color;
1.212 bowersj2 1241: if ($resource->is_problem()) {
1.136 bowersj2 1242: $color = $colormap{$resource->status};
1243:
1.252 matthew 1244: if (dueInLessThan24Hours($resource, $part) ||
1.136 bowersj2 1245: lastTry($resource, $part)) {
1246: $color = $hurryUpColor;
1247: }
1248: }
1249:
1250: if ($resource->kind() eq "res" &&
1251: $resource->is_problem() &&
1252: !$firstDisplayed) {
1253: if ($color) {$result .= "<font color=\"$color\"><b>"; }
1254: $result .= getDescription($resource, $part);
1255: if ($color) {$result .= "</b></font>"; }
1256: }
1257: if ($resource->is_map() && advancedUser() && $resource->randompick()) {
1258: $result .= '(randomly select ' . $resource->randompick() .')';
1259: }
1.210 bowersj2 1260:
1.213 bowersj2 1261: # Debugging code
1262: #$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) .
1263: # ' - Part: ' . $part;
1264:
1.210 bowersj2 1265: $result .= "</td>\n";
1.136 bowersj2 1266:
1267: return $result;
1.51 bowersj2 1268: }
1269:
1.227 bowersj2 1270: # Colors obtained by taking the icons, matching the colors, and
1271: # possibly reducing the Value (HSV) of the color, if it's too bright
1272: # for text, generally by one third or so.
1.225 bowersj2 1273: my %statusColors =
1274: (
1275: $resObj->CLOSED => '#000000',
1.227 bowersj2 1276: $resObj->OPEN => '#998b13',
1277: $resObj->CORRECT => '#26933f',
1278: $resObj->INCORRECT => '#c48207',
1279: $resObj->ATTEMPTED => '#a87510',
1.225 bowersj2 1280: $resObj->ERROR => '#000000'
1281: );
1282: my %statusStrings =
1283: (
1284: $resObj->CLOSED => 'Not yet open',
1285: $resObj->OPEN => 'Open',
1286: $resObj->CORRECT => 'Correct',
1287: $resObj->INCORRECT => 'Incorrect',
1288: $resObj->ATTEMPTED => 'Attempted',
1289: $resObj->ERROR => 'Network Error'
1290: );
1291: my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);
1292:
1293: use Data::Dumper;
1294: sub render_parts_summary_status {
1295: my ($resource, $part, $params) = @_;
1.256 albertel 1296: if (!$resource->is_problem() && !$resource->contains_problem) { return '<td></td>'; }
1.225 bowersj2 1297: if ($params->{showParts}) {
1298: return '<td></td>';
1299: }
1300:
1301: my $td = "<td align='right'>\n";
1302: my $endtd = "</td>\n";
1.256 albertel 1303: my @probs;
1.225 bowersj2 1304:
1.256 albertel 1305: if ($resource->contains_problem) {
1306: @probs=$resource->retrieveResources($resource,sub { $_[0]->is_problem() },1,0);
1307: } else {
1308: @probs=($resource);
1309: }
1310: my $return;
1311: my %overallstatus;
1312: my $totalParts;
1313: foreach my $resource (@probs) {
1314: # If there is a single part, just show the simple status
1315: if ($resource->singlepart()) {
1316: my $status = $resource->simpleStatus(${$resource->parts}[0]);
1317: $overallstatus{$status}++;
1318: $totalParts++;
1319: next;
1320: }
1321: # Now we can be sure the $part doesn't really matter.
1322: my $statusCount = $resource->simpleStatusCount();
1323: my @counts;
1324: foreach my $status (@statuses) {
1325: # decouple display order from the simpleStatusCount order
1326: my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
1327: if ($statusCount->[$slot]) {
1328: $overallstatus{$status}+=$statusCount->[$slot];
1329: $totalParts+=$statusCount->[$slot];
1330: }
1331: }
1332: }
1333: $return.= $td . $totalParts . ' parts: ';
1334: foreach my $status (@statuses) {
1335: if ($overallstatus{$status}) {
1336: $return.="<font color='" . $statusColors{$status} .
1337: "'>" . $overallstatus{$status} . ' '
1.225 bowersj2 1338: . $statusStrings{$status} . "</font>";
1339: }
1340: }
1.256 albertel 1341: $return.= $endtd;
1342: return $return;
1.225 bowersj2 1343: }
1344:
1.133 bowersj2 1345: my @preparedColumns = (\&render_resource, \&render_communication_status,
1.225 bowersj2 1346: \&render_quick_status, \&render_long_status,
1347: \&render_parts_summary_status);
1.132 bowersj2 1348:
1349: sub setDefault {
1350: my ($val, $default) = @_;
1351: if (!defined($val)) { return $default; }
1352: return $val;
1353: }
1354:
1.296 albertel 1355: sub cmp_title {
1356: my ($atitle,$btitle) = (lc($_[0]->compTitle),lc($_[1]->compTitle));
1357: $atitle=~s/^\s*//;
1358: $btitle=~s/^\s*//;
1359: return $atitle cmp $btitle;
1360: }
1361:
1.132 bowersj2 1362: sub render {
1363: my $args = shift;
1.140 bowersj2 1364: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
1365: my $result = '';
1.132 bowersj2 1366: # Configure the renderer.
1367: my $cols = $args->{'cols'};
1368: if (!defined($cols)) {
1369: # no columns, no nav maps.
1370: return '';
1371: }
1.140 bowersj2 1372: my $mustCloseNavMap = 0;
1373: my $navmap;
1374: if (defined($args->{'navmap'})) {
1375: $navmap = $args->{'navmap'};
1376: }
1377:
1.158 bowersj2 1378: my $r = $args->{'r'};
1.140 bowersj2 1379: my $queryString = $args->{'queryString'};
1.159 bowersj2 1380: my $jump = $args->{'jump'};
1.158 bowersj2 1381: my $here = $args->{'here'};
1.153 bowersj2 1382: my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
1.256 albertel 1383: my $closeAllPages = setDefault($args->{'closeAllPages'}, 0);
1.140 bowersj2 1384: my $currentJumpDelta = 2; # change this to change how many resources are displayed
1385: # before the current resource when using #current
1386:
1387: # If we were passed 'here' information, we are not rendering
1388: # after a folder manipulation, and we were not passed an
1389: # iterator, make sure we open the folders to show the "here"
1390: # marker
1391: my $filterHash = {};
1392: # Figure out what we're not displaying
1.320 albertel 1393: foreach (split(/\,/, $env{"form.filter"})) {
1.140 bowersj2 1394: if ($_) {
1395: $filterHash->{$_} = "1";
1396: }
1397: }
1398:
1.191 bowersj2 1399: # Filter: Remember filter function and add our own filter: Refuse
1400: # to show hidden resources unless the user can see them.
1401: my $userCanSeeHidden = advancedUser();
1402: my $filterFunc = setDefault($args->{'filterFunc'},
1403: sub {return 1;});
1404: if (!$userCanSeeHidden) {
1405: # Without renaming the filterfunc, the server seems to go into
1406: # an infinite loop
1407: my $oldFilterFunc = $filterFunc;
1408: $filterFunc = sub { my $res = shift; return !$res->randomout() &&
1409: &$oldFilterFunc($res);};
1410: }
1411:
1.140 bowersj2 1412: my $condition = 0;
1.320 albertel 1413: if ($env{'form.condition'}) {
1.140 bowersj2 1414: $condition = 1;
1415: }
1416:
1.320 albertel 1417: if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) {
1.140 bowersj2 1418: # Step 1: Check to see if we have a navmap
1419: if (!defined($navmap)) {
1.221 bowersj2 1420: $navmap = Apache::lonnavmaps::navmap->new();
1.140 bowersj2 1421: $mustCloseNavMap = 1;
1422: }
1423:
1424: # Step two: Locate what kind of here marker is necessary
1425: # Determine where the "here" marker is and where the screen jumps to.
1426:
1.320 albertel 1427: if ($env{'form.postsymb'}) {
1428: $here = $jump = &Apache::lonnet::symbclean($env{'form.postsymb'});
1429: } elsif ($env{'form.postdata'}) {
1.140 bowersj2 1430: # couldn't find a symb, is there a URL?
1.320 albertel 1431: my $currenturl = $env{'form.postdata'};
1.158 bowersj2 1432: #$currenturl=~s/^http\:\/\///;
1433: #$currenturl=~s/^[^\/]+//;
1.140 bowersj2 1434:
1.158 bowersj2 1435: $here = $jump = &Apache::lonnet::symbread($currenturl);
1.317 albertel 1436: } else {
1437: my $last;
1.320 albertel 1438: if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.317 albertel 1439: &GDBM_READER(),0640)) {
1440: $last=$hash{'last_known'};
1441: untie(%hash);
1442: }
1443: if ($last) { $here = $jump = $last; }
1444: }
1.158 bowersj2 1445:
1.140 bowersj2 1446: # Step three: Ensure the folders are open
1447: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
1.222 bowersj2 1448: my $curRes;
1.140 bowersj2 1449: my $found = 0;
1450:
1451: # We only need to do this if we need to open the maps to show the
1452: # current position. This will change the counter so we can't count
1453: # for the jump marker with this loop.
1.294 albertel 1454: while ($here && ($curRes = $mapIterator->next()) && !$found) {
1.158 bowersj2 1455: if (ref($curRes) && $curRes->symb() eq $here) {
1.140 bowersj2 1456: my $mapStack = $mapIterator->getStack();
1457:
1458: # Ensure the parent maps are open
1459: for my $map (@{$mapStack}) {
1460: if ($condition) {
1461: undef $filterHash->{$map->map_pc()};
1462: } else {
1463: $filterHash->{$map->map_pc()} = 1;
1464: }
1465: }
1466: $found = 1;
1467: }
1468: }
1.159 bowersj2 1469: }
1.140 bowersj2 1470:
1.320 albertel 1471: if ( !defined($args->{'iterator'}) && $env{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
1.140 bowersj2 1472: # If this is a click on a folder or something, we want to preserve the "here"
1473: # from the querystring, and get the new "jump" marker
1.320 albertel 1474: $here = $env{'form.here'};
1475: $jump = $env{'form.jump'};
1.140 bowersj2 1476: }
1477:
1.132 bowersj2 1478: my $it = $args->{'iterator'};
1479: if (!defined($it)) {
1.320 albertel 1480: # Construct a default iterator based on $env{'form.'} information
1.140 bowersj2 1481:
1482: # Step 1: Check to see if we have a navmap
1483: if (!defined($navmap)) {
1.221 bowersj2 1484: $navmap = Apache::lonnavmaps::navmap->new();
1.140 bowersj2 1485: $mustCloseNavMap = 1;
1486: }
1487:
1.144 bowersj2 1488: # See if we're being passed a specific map
1489: if ($args->{'iterator_map'}) {
1490: my $map = $args->{'iterator_map'};
1.145 bowersj2 1491: $map = $navmap->getResourceByUrl($map);
1.144 bowersj2 1492: my $firstResource = $map->map_start();
1493: my $finishResource = $map->map_finish();
1494:
1495: $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
1496: } else {
1497: $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
1498: }
1.132 bowersj2 1499: }
1.256 albertel 1500:
1.159 bowersj2 1501: # (re-)Locate the jump point, if any
1.191 bowersj2 1502: # Note this does not take filtering or hidden into account... need
1503: # to be fixed?
1.159 bowersj2 1504: my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
1.222 bowersj2 1505: my $curRes;
1.159 bowersj2 1506: my $foundJump = 0;
1507: my $counter = 0;
1508:
1.222 bowersj2 1509: while (($curRes = $mapIterator->next()) && !$foundJump) {
1.159 bowersj2 1510: if (ref($curRes)) { $counter++; }
1511:
1512: if (ref($curRes) && $jump eq $curRes->symb()) {
1513:
1514: # This is why we have to use the main iterator instead of the
1515: # potentially faster DFS: The count has to be the same, so
1516: # the order has to be the same, which DFS won't give us.
1517: $args->{'currentJumpIndex'} = $counter;
1518: $foundJump = 1;
1519: }
1520: }
1521:
1.132 bowersj2 1522: my $showParts = setDefault($args->{'showParts'}, 1);
1523: my $condenseParts = setDefault($args->{'condenseParts'}, 1);
1.139 bowersj2 1524: # keeps track of when the current resource is found,
1525: # so we can back up a few and put the anchor above the
1526: # current resource
1.140 bowersj2 1527: my $printKey = $args->{'printKey'};
1528: my $printCloseAll = $args->{'printCloseAll'};
1529: if (!defined($printCloseAll)) { $printCloseAll = 1; }
1.298 albertel 1530:
1.140 bowersj2 1531: # Print key?
1532: if ($printKey) {
1533: $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1534: my $date=localtime;
1535: $result.='<tr><td align="right" valign="bottom">Key: </td>';
1.298 albertel 1536: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1.140 bowersj2 1537: if ($navmap->{LAST_CHECK}) {
1538: $result .=
1.298 albertel 1539: '<img src="'.$location.'/chat.gif"> '.&mt('New discussion since').' '.
1.140 bowersj2 1540: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1541: '</td><td align="center" valign="bottom"> '.
1.298 albertel 1542: '<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
1.140 bowersj2 1543: '</td>';
1544: } else {
1545: $result .= '<td align="center" valign="bottom"> '.
1.298 albertel 1546: '<img src="'.$location.'/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
1547: ' <img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').
1.140 bowersj2 1548: '</td>';
1549: }
1550:
1551: $result .= '</tr></table>';
1552: }
1553:
1.172 bowersj2 1554: if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
1.281 albertel 1555: my ($link,$text);
1.140 bowersj2 1556: if ($condition) {
1.281 albertel 1557: $link='"navmaps?condition=0&filter=&'.$queryString.
1558: '&here='.&Apache::lonnet::escape($here).'"';
1559: $text='Close All Folders';
1.140 bowersj2 1560: } else {
1.281 albertel 1561: $link='"navmaps?condition=1&filter=&'.$queryString.
1562: '&here='.&Apache::lonnet::escape($here).'"';
1563: $text='Open All Folders';
1564: }
1565: if ($args->{'caller'} eq 'navmapsdisplay') {
1566: &add_linkitem($args->{'linkitems'},'changefolder',
1567: 'location.href='.$link,$text);
1568: } else {
1569: $result.='<a href='.$link.'>'.&mt($text).'</a>';
1570: }
1.266 raeburn 1571: $result .= "\n";
1572: }
1.140 bowersj2 1573:
1.266 raeburn 1574: # Check for any unread discussions in all resources.
1.281 albertel 1575: if ($args->{'caller'} eq 'navmapsdisplay') {
1.296 albertel 1576: &add_linkitem($args->{'linkitems'},'clearbubbles',
1577: 'document.clearbubbles.submit()',
1578: 'Mark all posts read');
1.297 albertel 1579: my $time=time;
1.296 albertel 1580: $result .= (<<END);
1581: <form name="clearbubbles" method="post" action="/adm/feedback">
1582: <input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
1.297 albertel 1583: <input type="hidden" name="navtime" value="$time" />
1.296 albertel 1584: END
1585: if ($args->{'sort'} eq 'discussion') {
1586: my $totdisc = 0;
1587: my $haveDisc = '';
1588: my @allres=$navmap->retrieveResources();
1589: foreach my $resource (@allres) {
1590: if ($resource->hasDiscussion()) {
1.321 ! raeburn 1591: my $ressymb = $resource->symb();
! 1592: if ($ressymb =~ m-___adm/\w+/\w+/\d+/bulletinboard$-) {
! 1593: $ressymb = $resource->wrap_symb();
1.296 albertel 1594: }
1595: $haveDisc .= $ressymb.':';
1596: $totdisc ++;
1.267 albertel 1597: }
1598: }
1.296 albertel 1599: if ($totdisc > 0) {
1600: $haveDisc =~ s/:$//;
1601: $result .= (<<END);
1602: <input type="hidden" name="navmaps" value="$haveDisc" />
1603: </form>
1604: END
1605: }
1.297 albertel 1606: }
1607: $result.='</form>';
1.266 raeburn 1608: }
1.276 albertel 1609:
1.281 albertel 1610: if ($args->{'caller'} eq 'navmapsdisplay') {
1.283 raeburn 1611: $result .= '<table><tr><td>'.
1612: &Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT').'</td>';
1.320 albertel 1613: if ($env{'environment.remotenavmap'} ne 'on') {
1.283 raeburn 1614: $result .= '<td> </td>';
1615: } else {
1616: $result .= '</tr><tr>';
1617: }
1.281 albertel 1618: $result.=&show_linkitems($args->{'linkitems'});
1619: if ($args->{'sort_html'}) {
1.320 albertel 1620: if ($env{'environment.remotenavmap'} ne 'on') {
1.281 albertel 1621: $result.='<td> </td><td> </td><td> </td>'.
1622: '<td align="right">'.$args->{'sort_html'}.'</td></tr>';
1623: } else {
1624: $result.='</tr><tr><td align="left"><br />'.
1625: $args->{'sort_html'}.'</td></tr>';
1626: }
1627: }
1628: $result .= '</table>';
1629: } elsif ($args->{'sort_html'}) {
1630: $result.=$args->{'sort_html'};
1631: }
1.276 albertel 1632:
1.266 raeburn 1633: $result .= "<br />\n";
1.140 bowersj2 1634: if ($r) {
1635: $r->print($result);
1636: $r->rflush();
1637: $result = "";
1638: }
1.132 bowersj2 1639: # End parameter setting
1.133 bowersj2 1640:
1.132 bowersj2 1641: # Data
1.140 bowersj2 1642: $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
1.132 bowersj2 1643: my $res = "Apache::lonnavmaps::resource";
1644: my %condenseStatuses =
1645: ( $res->NETWORK_FAILURE => 1,
1646: $res->NOTHING_SET => 1,
1647: $res->CORRECT => 1 );
1648: my @backgroundColors = ("#FFFFFF", "#F6F6F6");
1.133 bowersj2 1649:
1650: # Shared variables
1651: $args->{'counter'} = 0; # counts the rows
1652: $args->{'indentLevel'} = 0;
1653: $args->{'isNewBranch'} = 0;
1654: $args->{'condensed'} = 0;
1.298 albertel 1655: my $location=
1656: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");
1657: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' width='25' height='1' alt='' border='0' />");
1.133 bowersj2 1658: $args->{'displayedHereMarker'} = 0;
1.132 bowersj2 1659:
1.190 bowersj2 1660: # If we're suppressing empty sequences, look for them here. Use DFS for speed,
1661: # since structure actually doesn't matter, except what map has what resources.
1662: if ($args->{'suppressEmptySequences'}) {
1663: my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
1664: $it->{FIRST_RESOURCE},
1665: $it->{FINISH_RESOURCE},
1666: {}, undef, 1);
1.222 bowersj2 1667: my $depth = 0;
1.190 bowersj2 1668: $dfsit->next();
1669: my $curRes = $dfsit->next();
1670: while ($depth > -1) {
1671: if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
1672: if ($curRes == $dfsit->END_MAP()) { $depth--; }
1673:
1674: if (ref($curRes)) {
1675: # Parallel pre-processing: Do sequences have non-filtered-out children?
1.201 bowersj2 1676: if ($curRes->is_map()) {
1.190 bowersj2 1677: $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
1678: # Sequences themselves do not count as visible children,
1679: # unless those sequences also have visible children.
1680: # This means if a sequence appears, there's a "promise"
1681: # that there's something under it if you open it, somewhere.
1682: } else {
1683: # Not a sequence: if it's filtered, ignore it, otherwise
1684: # rise up the stack and mark the sequences as having children
1685: if (&$filterFunc($curRes)) {
1686: for my $sequence (@{$dfsit->getStack()}) {
1687: $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
1688: }
1689: }
1690: }
1691: }
1692: } continue {
1693: $curRes = $dfsit->next();
1694: }
1695: }
1696:
1.133 bowersj2 1697: my $displayedJumpMarker = 0;
1.132 bowersj2 1698: # Set up iteration.
1699: my $now = time();
1700: my $in24Hours = $now + 24 * 60 * 60;
1701: my $rownum = 0;
1702:
1.141 bowersj2 1703: # export "here" marker information
1704: $args->{'here'} = $here;
1705:
1.222 bowersj2 1706: $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
1.270 albertel 1707: my @resources;
1708: my $code='';# sub { !(shift->is_map();) };
1709: if ($args->{'sort'} eq 'title') {
1.276 albertel 1710: my $oldFilterFunc = $filterFunc;
1711: my $filterFunc=
1712: sub {
1713: my ($res)=@_;
1714: if ($res->is_map()) { return 0;}
1715: return &$oldFilterFunc($res);
1716: };
1717: @resources=$navmap->retrieveResources(undef,$filterFunc);
1.296 albertel 1718: @resources= sort { &cmp_title($a,$b) } @resources;
1719: } elsif ($args->{'sort'} eq 'duedate') {
1720: my $oldFilterFunc = $filterFunc;
1721: my $filterFunc=
1722: sub {
1723: my ($res)=@_;
1724: if (!$res->is_problem()) { return 0;}
1725: return &$oldFilterFunc($res);
1726: };
1727: @resources=$navmap->retrieveResources(undef,$filterFunc);
1.289 raeburn 1728: @resources= sort {
1.270 albertel 1729: if ($a->duedate ne $b->duedate) {
1730: return $a->duedate cmp $b->duedate;
1731: }
1.296 albertel 1732: my $value=&cmp_title($a,$b);
1733: return $value;
1.270 albertel 1734: } @resources;
1.296 albertel 1735: } elsif ($args->{'sort'} eq 'discussion') {
1736: my $oldFilterFunc = $filterFunc;
1737: my $filterFunc=
1738: sub {
1739: my ($res)=@_;
1740: if (!$res->hasDiscussion() &&
1741: !$res->getFeedback() &&
1742: !$res->getErrors()) { return 0;}
1743: return &$oldFilterFunc($res);
1744: };
1745: @resources=$navmap->retrieveResources(undef,$filterFunc);
1746: @resources= sort { &cmp_title($a,$b) } @resources;
1.276 albertel 1747: } else {
1748: #unknow sort mechanism or default
1749: undef($args->{'sort'});
1.270 albertel 1750: }
1751:
1.276 albertel 1752:
1.270 albertel 1753: while (1) {
1754: if ($args->{'sort'}) {
1755: $curRes = shift(@resources);
1756: } else {
1757: $curRes = $it->next($closeAllPages);
1758: }
1759: if (!$curRes) { last; }
1760:
1.132 bowersj2 1761: # Maintain indentation level.
1762: if ($curRes == $it->BEGIN_MAP() ||
1763: $curRes == $it->BEGIN_BRANCH() ) {
1.133 bowersj2 1764: $args->{'indentLevel'}++;
1.132 bowersj2 1765: }
1766: if ($curRes == $it->END_MAP() ||
1767: $curRes == $it->END_BRANCH() ) {
1.133 bowersj2 1768: $args->{'indentLevel'}--;
1.132 bowersj2 1769: }
1770: # Notice new branches
1771: if ($curRes == $it->BEGIN_BRANCH()) {
1.133 bowersj2 1772: $args->{'isNewBranch'} = 1;
1773: }
1774:
1775: # If this isn't an actual resource, continue on
1776: if (!ref($curRes)) {
1777: next;
1.132 bowersj2 1778: }
1.133 bowersj2 1779:
1.143 bowersj2 1780: # If this has been filtered out, continue on
1781: if (!(&$filterFunc($curRes))) {
1782: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1783: next;
1784: }
1.132 bowersj2 1785:
1.190 bowersj2 1786: # If this is an empty sequence and we're filtering them, continue on
1.201 bowersj2 1787: if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
1.190 bowersj2 1788: !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
1789: next;
1790: }
1791:
1.153 bowersj2 1792: # If we're suppressing navmaps and this is a navmap, continue on
1793: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1794: next;
1795: }
1796:
1.191 bowersj2 1797: $args->{'counter'}++;
1798:
1.132 bowersj2 1799: # Does it have multiple parts?
1.133 bowersj2 1800: $args->{'multipart'} = 0;
1801: $args->{'condensed'} = 0;
1.132 bowersj2 1802: my @parts;
1803:
1804: # Decide what parts to show.
1.133 bowersj2 1805: if ($curRes->is_problem() && $showParts) {
1.132 bowersj2 1806: @parts = @{$curRes->parts()};
1.192 bowersj2 1807: $args->{'multipart'} = $curRes->multipart();
1.132 bowersj2 1808:
1809: if ($condenseParts) { # do the condensation
1810: if (!$curRes->opendate("0")) {
1.162 bowersj2 1811: @parts = ();
1.133 bowersj2 1812: $args->{'condensed'} = 1;
1.132 bowersj2 1813: }
1.133 bowersj2 1814: if (!$args->{'condensed'}) {
1.132 bowersj2 1815: # Decide whether to condense based on similarity
1.192 bowersj2 1816: my $status = $curRes->status($parts[0]);
1817: my $due = $curRes->duedate($parts[0]);
1818: my $open = $curRes->opendate($parts[0]);
1.132 bowersj2 1819: my $statusAllSame = 1;
1820: my $dueAllSame = 1;
1821: my $openAllSame = 1;
1.192 bowersj2 1822: for (my $i = 1; $i < scalar(@parts); $i++) {
1.132 bowersj2 1823: if ($curRes->status($parts[$i]) != $status){
1824: $statusAllSame = 0;
1825: }
1826: if ($curRes->duedate($parts[$i]) != $due ) {
1827: $dueAllSame = 0;
1828: }
1829: if ($curRes->opendate($parts[$i]) != $open) {
1830: $openAllSame = 0;
1831: }
1832: }
1833: # $*allSame is true if all the statuses were
1834: # the same. Now, if they are all the same and
1835: # match one of the statuses to condense, or they
1836: # are all open with the same due date, or they are
1837: # all OPEN_LATER with the same open date, display the
1838: # status of the first non-zero part (to get the 'correct'
1839: # status right, since 0 is never 'correct' or 'open').
1840: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1841: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1842: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1.192 bowersj2 1843: @parts = ($parts[0]);
1.133 bowersj2 1844: $args->{'condensed'} = 1;
1.132 bowersj2 1845: }
1846: }
1.198 bowersj2 1847: # Multipart problem with one part: always "condense" (happens
1848: # to match the desirable behavior)
1849: if ($curRes->countParts() == 1) {
1850: @parts = ($parts[0]);
1851: $args->{'condensed'} = 1;
1852: }
1.132 bowersj2 1853: }
1.157 bowersj2 1854: }
1.132 bowersj2 1855:
1856: # If the multipart problem was condensed, "forget" it was multipart
1857: if (scalar(@parts) == 1) {
1.133 bowersj2 1858: $args->{'multipart'} = 0;
1.192 bowersj2 1859: } else {
1860: # Add part 0 so we display it correctly.
1861: unshift @parts, '0';
1.132 bowersj2 1862: }
1.310 albertel 1863:
1864: {
1865: my ($src,$symb,$anchor,$stack);
1866: if ($args->{'sort'}) {
1867: my $it = $navmap->getIterator(undef, undef, undef, 1);
1868: while ( my $res=$it->next()) {
1869: if (ref($res) &&
1870: $res->symb() eq $curRes->symb()) { last; }
1871: }
1872: $stack=$it->getStack();
1873: } else {
1874: $stack=$it->getStack();
1875: }
1876: ($src,$symb,$anchor)=getLinkForResource($stack);
1877: if (defined($anchor)) { $anchor='#'.$anchor; }
1878: my $srcHasQuestion = $src =~ /\?/;
1879: $args->{"resourceLink"} = $src.
1880: ($srcHasQuestion?'&':'?') .
1881: 'symb=' . &Apache::lonnet::escape($symb).$anchor;
1882: }
1.132 bowersj2 1883: # Now, we've decided what parts to show. Loop through them and
1884: # show them.
1.192 bowersj2 1885: foreach my $part (@parts) {
1.132 bowersj2 1886: $rownum ++;
1887: my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
1888:
1889: $result .= " <tr bgcolor='$backgroundColor'>\n";
1.134 bowersj2 1890:
1891: # Set up some data about the parts that the cols might want
1892: my $filter = $it->{FILTER};
1.270 albertel 1893:
1.132 bowersj2 1894: # Now, display each column.
1895: foreach my $col (@$cols) {
1.139 bowersj2 1896: my $colHTML = '';
1897: if (ref($col)) {
1898: $colHTML .= &$col($curRes, $part, $args);
1899: } else {
1900: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1901: }
1.132 bowersj2 1902:
1.133 bowersj2 1903: # If this is the first column and it's time to print
1904: # the anchor, do so
1905: if ($col == $cols->[0] &&
1906: $args->{'counter'} == $args->{'currentJumpIndex'} -
1.139 bowersj2 1907: $currentJumpDelta) {
1908: # Jam the anchor after the <td> tag;
1909: # necessary for valid HTML (which Mozilla requires)
1910: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1.133 bowersj2 1911: $displayedJumpMarker = 1;
1912: }
1.139 bowersj2 1913: $result .= $colHTML . "\n";
1.132 bowersj2 1914: }
1.139 bowersj2 1915: $result .= " </tr>\n";
1.140 bowersj2 1916: $args->{'isNewBranch'} = 0;
1.139 bowersj2 1917: }
1.153 bowersj2 1918:
1.139 bowersj2 1919: if ($r && $rownum % 20 == 0) {
1920: $r->print($result);
1921: $result = "";
1922: $r->rflush();
1.132 bowersj2 1923: }
1.156 bowersj2 1924: } continue {
1.208 bowersj2 1925: if ($r) {
1926: # If we have the connection, make sure the user is still connected
1927: my $c = $r->connection;
1928: if ($c->aborted()) {
1929: # Who cares what we do, nobody will see it anyhow.
1930: return '';
1931: }
1932: }
1.132 bowersj2 1933: }
1934:
1.134 bowersj2 1935: # Print out the part that jumps to #curloc if it exists
1.159 bowersj2 1936: # delay needed because the browser is processing the jump before
1937: # it finishes rendering, so it goes to the wrong place!
1938: # onload might be better, but this routine has no access to that.
1939: # On mozilla, the 0-millisecond timeout seems to prevent this;
1940: # it's quite likely this might fix other browsers, too, and
1941: # certainly won't hurt anything.
1.139 bowersj2 1942: if ($displayedJumpMarker) {
1.247 albertel 1943: $result .= "
1944: <script>
1945: if (location.href.indexOf('#curloc')==-1) {
1946: setTimeout(\"location += '#curloc';\", 0)
1947: }
1948: </script>";
1.134 bowersj2 1949: }
1950:
1.132 bowersj2 1951: $result .= "</table>";
1.140 bowersj2 1952:
1953: if ($r) {
1954: $r->print($result);
1955: $result = "";
1956: $r->rflush();
1957: }
1958:
1.132 bowersj2 1959: return $result;
1960: }
1961:
1.281 albertel 1962: sub add_linkitem {
1963: my ($linkitems,$name,$cmd,$text)=@_;
1964: $$linkitems{$name}{'cmd'}=$cmd;
1965: $$linkitems{$name}{'text'}=&mt($text);
1966: }
1967:
1968: sub show_linkitems {
1969: my ($linkitems)=@_;
1.312 albertel 1970: my @linkorder = ("blank","launchnav","closenav","firsthomework",
1971: "everything","uncompleted","changefolder","clearbubbles");
1.281 albertel 1972:
1973: my $result .= (<<ENDBLOCK);
1.283 raeburn 1974: <td align="left">
1.281 albertel 1975: <script type="text/javascript">
1976: function changeNavDisplay () {
1977: var navchoice = document.linkitems.toplink[document.linkitems.toplink.selectedIndex].value;
1978: ENDBLOCK
1979: foreach my $link (@linkorder) {
1980: $result.= "if (navchoice == '$link') {".
1981: $linkitems->{$link}{'cmd'}."}\n";
1982: }
1983: $result.='}
1984: </script>
1985: <form name="linkitems" method="post">
1986: <nobr><select name="toplink">'."\n";
1987: foreach my $link (@linkorder) {
1988: if (defined($linkitems->{$link})) {
1989: if ($linkitems->{$link}{'text'} ne '') {
1990: $result .= ' <option value="'.$link.'">'.
1991: $linkitems->{$link}{'text'}."</option>\n";
1992: }
1993: }
1994: }
1995: $result .= '</select> <input type="button" name="chgnav"
1996: value="Go" onClick="javascript:changeNavDisplay()" />
1997: </nobr></form></td>'."\n";
1.298 albertel 1998:
1.281 albertel 1999: return $result;
2000: }
2001:
1.133 bowersj2 2002: 1;
2003:
2004: package Apache::lonnavmaps::navmap;
2005:
2006: =pod
2007:
1.216 bowersj2 2008: =head1 Object: Apache::lonnavmaps::navmap
1.133 bowersj2 2009:
1.217 bowersj2 2010: =head2 Overview
1.133 bowersj2 2011:
1.217 bowersj2 2012: The navmap object's job is to provide access to the resources
2013: in the course as Apache::lonnavmaps::resource objects, and to
2014: query and manage the relationship between those resource objects.
2015:
2016: Generally, you'll use the navmap object in one of three basic ways.
2017: In order of increasing complexity and power:
2018:
2019: =over 4
2020:
2021: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb>, B<Url> or B<MapPc>. This provides
2022: various ways to obtain resource objects, based on various identifiers.
2023: Use this when you want to request information about one object or
2024: a handful of resources you already know the identities of, from some
2025: other source. For more about Ids, Symbs, and MapPcs, see the
2026: Resource documentation. Note that Url should be a B<last resort>,
2027: not your first choice; it only works when there is only one
2028: instance of the resource in the course, which only applies to
2029: maps, and even that may change in the future.
2030:
2031: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
2032: retrieves resources matching some criterion and returns them
2033: in a flat array, with no structure information. Use this when
2034: you are manipulating a series of resources, based on what map
2035: the are in, but do not care about branching, or exactly how
2036: the maps and resources are related. This is the most common case.
2037:
2038: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
2039: the course's navmap in various ways without writing the traversal
2040: code yourself. See iterator documentation below. Use this when
2041: you need to know absolutely everything about the course, including
2042: branches and the precise relationship between maps and resources.
2043:
2044: =back
2045:
2046: =head2 Creation And Destruction
2047:
2048: To create a navmap object, use the following function:
1.133 bowersj2 2049:
2050: =over 4
2051:
1.221 bowersj2 2052: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1.133 bowersj2 2053:
1.221 bowersj2 2054: Creates a new navmap object. Returns the navmap object if this is
2055: successful, or B<undef> if not.
1.174 albertel 2056:
1.216 bowersj2 2057: =back
2058:
2059: =head2 Methods
2060:
2061: =over 4
2062:
1.174 albertel 2063: =item * B<getIterator>(first, finish, filter, condition):
2064:
2065: See iterator documentation below.
1.133 bowersj2 2066:
2067: =cut
2068:
2069: use strict;
2070: use GDBM_File;
1.320 albertel 2071: use Apache::lonnet;
1.133 bowersj2 2072:
2073: sub new {
2074: # magic invocation to create a class instance
2075: my $proto = shift;
2076: my $class = ref($proto) || $proto;
2077: my $self = {};
2078:
2079: # Resource cache stores navmap resources as we reference them. We generate
2080: # them on-demand so we don't pay for creating resources unless we use them.
2081: $self->{RESOURCE_CACHE} = {};
2082:
2083: # Network failure flag, if we accessed the course or user opt and
2084: # failed
2085: $self->{NETWORK_FAILURE} = 0;
2086:
2087: # tie the nav hash
2088:
1.168 bowersj2 2089: my %navmaphash;
2090: my %parmhash;
1.320 albertel 2091: my $courseFn = $env{"request.course.fn"};
1.220 bowersj2 2092: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
1.133 bowersj2 2093: &GDBM_READER(), 0640))) {
2094: return undef;
2095: }
2096:
1.220 bowersj2 2097: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
1.133 bowersj2 2098: &GDBM_READER(), 0640)))
2099: {
1.170 matthew 2100: untie %{$self->{PARM_HASH}};
1.133 bowersj2 2101: return undef;
2102: }
2103:
1.199 bowersj2 2104: $self->{NAV_HASH} = \%navmaphash;
1.168 bowersj2 2105: $self->{PARM_HASH} = \%parmhash;
1.221 bowersj2 2106: $self->{PARM_CACHE} = {};
1.133 bowersj2 2107:
2108: bless($self);
2109:
2110: return $self;
2111: }
2112:
1.221 bowersj2 2113: sub generate_course_user_opt {
1.133 bowersj2 2114: my $self = shift;
1.221 bowersj2 2115: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
1.133 bowersj2 2116:
1.320 albertel 2117: my $uname=$env{'user.name'};
2118: my $udom=$env{'user.domain'};
2119: my $uhome=$env{'user.home'};
2120: my $cid=$env{'request.course.id'};
2121: my $chome=$env{'course.'.$cid.'.home'};
1.221 bowersj2 2122: my ($cdom,$cnum)=split(/\_/,$cid);
2123:
2124: my $userprefix=$uname.'_'.$udom.'_';
2125:
2126: my %courserdatas; my %useropt; my %courseopt; my %userrdatas;
2127: unless ($uhome eq 'no_host') {
1.133 bowersj2 2128: # ------------------------------------------------- Get coursedata (if present)
1.221 bowersj2 2129: unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
2130: my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
2131: ':resourcedata',$chome);
2132: # Check for network failure
2133: if ( $reply =~ /no.such.host/i || $reply =~ /con_lost/i) {
2134: $self->{NETWORK_FAILURE} = 1;
2135: } elsif ($reply!~/^error\:/) {
2136: $courserdatas{$cid}=$reply;
2137: $courserdatas{$cid.'.last_cache'}=time;
2138: }
2139: }
2140: foreach (split(/\&/,$courserdatas{$cid})) {
2141: my ($name,$value)=split(/\=/,$_);
2142: $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
2143: &Apache::lonnet::unescape($value);
2144: }
1.133 bowersj2 2145: # --------------------------------------------------- Get userdata (if present)
1.221 bowersj2 2146: unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
2147: my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
2148: if ($reply!~/^error\:/) {
2149: $userrdatas{$uname.'___'.$udom}=$reply;
2150: $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
2151: }
2152: # check to see if network failed
2153: elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
2154: {
2155: $self->{NETWORK_FAILURE} = 1;
2156: }
2157: }
2158: foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
2159: my ($name,$value)=split(/\=/,$_);
2160: $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
2161: &Apache::lonnet::unescape($value);
2162: }
2163: $self->{COURSE_OPT} = \%courseopt;
2164: $self->{USER_OPT} = \%useropt;
2165: }
2166:
2167: $self->{COURSE_USER_OPT_GENERATED} = 1;
2168:
2169: return;
2170: }
2171:
2172: sub generate_email_discuss_status {
2173: my $self = shift;
1.259 raeburn 2174: my $symb = shift;
1.221 bowersj2 2175: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
1.133 bowersj2 2176:
1.320 albertel 2177: my $cid=$env{'request.course.id'};
1.221 bowersj2 2178: my ($cdom,$cnum)=split(/\_/,$cid);
2179:
2180: my %emailstatus = &Apache::lonnet::dump('email_status');
2181: my $logoutTime = $emailstatus{'logout'};
1.320 albertel 2182: my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
1.221 bowersj2 2183: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
2184: $courseLeaveTime : $logoutTime);
2185: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
2186: $cdom, $cnum);
1.259 raeburn 2187: my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
1.320 albertel 2188: $env{'user.domain'},$env{'user.name'},'lastread');
1.259 raeburn 2189: my %lastreadtime = ();
2190: foreach (keys %lastread) {
2191: my $key = $_;
2192: $key =~ s/_lastread$//;
2193: $lastreadtime{$key} = $lastread{$_};
2194: }
2195:
1.221 bowersj2 2196: my %feedback=();
2197: my %error=();
2198: my $keys = &Apache::lonnet::reply('keys:'.
1.320 albertel 2199: $env{'user.domain'}.':'.
2200: $env{'user.name'}.':nohist_email',
2201: $env{'user.home'});
1.221 bowersj2 2202:
2203: foreach my $msgid (split(/\&/, $keys)) {
2204: $msgid=&Apache::lonnet::unescape($msgid);
1.295 albertel 2205: if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) {
2206: my $plain=
2207: &Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
2208: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
2209: my ($what,$url)=($1,$2);
1.221 bowersj2 2210: if ($what eq 'Error') {
2211: $error{$url}.=','.$msgid;
2212: } else {
2213: $feedback{$url}.=','.$msgid;
2214: }
2215: }
2216: }
1.211 bowersj2 2217: }
1.221 bowersj2 2218:
1.295 albertel 2219: #url's of resources that have feedbacks
1.221 bowersj2 2220: $self->{FEEDBACK} = \%feedback;
1.295 albertel 2221: #or errors
2222: $self->{ERROR_MSG} = \%error;
1.221 bowersj2 2223: $self->{DISCUSSION_TIME} = \%discussiontime;
2224: $self->{EMAIL_STATUS} = \%emailstatus;
1.259 raeburn 2225: $self->{LAST_READ} = \%lastreadtime;
1.221 bowersj2 2226:
2227: $self->{EMAIL_DISCUSS_GENERATED} = 1;
2228: }
2229:
2230: sub get_user_data {
2231: my $self = shift;
2232: if ($self->{RETRIEVED_USER_DATA}) { return; }
1.211 bowersj2 2233:
1.221 bowersj2 2234: # Retrieve performance data on problems
1.320 albertel 2235: my %student_data = Apache::lonnet::currentdump($env{'request.course.id'},
2236: $env{'user.domain'},
2237: $env{'user.name'});
1.221 bowersj2 2238: $self->{STUDENT_DATA} = \%student_data;
1.133 bowersj2 2239:
1.221 bowersj2 2240: $self->{RETRIEVED_USER_DATA} = 1;
1.133 bowersj2 2241: }
2242:
2243: # Internal function: Takes a key to look up in the nav hash and implements internal
2244: # memory caching of that key.
2245: sub navhash {
2246: my $self = shift; my $key = shift;
2247: return $self->{NAV_HASH}->{$key};
2248: }
2249:
1.217 bowersj2 2250: =pod
2251:
2252: =item * B<courseMapDefined>(): Returns true if the course map is defined,
2253: false otherwise. Undefined course maps indicate an error somewhere in
2254: LON-CAPA, and you will not be able to proceed with using the navmap.
2255: See the B<NAV> screen for an example of using this.
2256:
2257: =cut
2258:
1.133 bowersj2 2259: # Checks to see if coursemap is defined, matching test in old lonnavmaps
2260: sub courseMapDefined {
2261: my $self = shift;
1.320 albertel 2262: my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});
1.133 bowersj2 2263:
2264: my $firstres = $self->navhash("map_start_$uri");
2265: my $lastres = $self->navhash("map_finish_$uri");
2266: return $firstres && $lastres;
2267: }
2268:
2269: sub getIterator {
2270: my $self = shift;
2271: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.314 albertel 2272: shift, undef, shift,
2273: shift, shift);
1.133 bowersj2 2274: return $iterator;
2275: }
2276:
2277: # Private method: Does the given resource (as a symb string) have
2278: # current discussion? Returns 0 if chat/mail data not extracted.
2279: sub hasDiscussion {
2280: my $self = shift;
2281: my $symb = shift;
1.221 bowersj2 2282: $self->generate_email_discuss_status();
2283:
1.133 bowersj2 2284: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
2285:
2286: #return defined($self->{DISCUSSION_TIME}->{$symb});
1.259 raeburn 2287:
2288: # backward compatibility (bulletin boards used to be 'wrapped')
2289: my $ressymb = $symb;
1.321 ! raeburn 2290: if ($ressymb =~ m-___adm/\w+/\w+/\d+/bulletinboard$-) {
! 2291: $ressymb = $self->wrap_symb($ressymb);
1.259 raeburn 2292: }
2293: if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
2294: return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
2295: } else {
1.266 raeburn 2296: # return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
2297: return $self->{DISCUSSION_TIME}->{$ressymb} > 0; # in 1.2 will display speech bubble icons for all items with posts until marked as read (even if read in v 1.1).
1.259 raeburn 2298: }
1.133 bowersj2 2299: }
2300:
2301: # Private method: Does the given resource (as a symb string) have
2302: # current feedback? Returns the string in the feedback hash, which
2303: # will be false if it does not exist.
1.321 ! raeburn 2304:
! 2305: sub wrap_symb {
! 2306: my $self=shift;
! 2307: my $symb = shift;
! 2308: my $ressymb = $symb;
! 2309: if ($ressymb =~ m-___(adm/\w+/\w+/)(\d+)(/bulletinboard)$-) {
! 2310: unless ($ressymb =~ m|adm/wrapper/adm|) {
! 2311: $ressymb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
! 2312: }
! 2313: }
! 2314: return $ressymb;
! 2315: }
! 2316:
1.133 bowersj2 2317: sub getFeedback {
2318: my $self = shift;
2319: my $symb = shift;
2320:
1.221 bowersj2 2321: $self->generate_email_discuss_status();
2322:
1.133 bowersj2 2323: if (!defined($self->{FEEDBACK})) { return ""; }
2324:
2325: return $self->{FEEDBACK}->{$symb};
2326: }
2327:
2328: # Private method: Get the errors for that resource (by source).
2329: sub getErrors {
2330: my $self = shift;
2331: my $src = shift;
1.221 bowersj2 2332:
2333: $self->generate_email_discuss_status();
2334:
1.133 bowersj2 2335: if (!defined($self->{ERROR_MSG})) { return ""; }
2336: return $self->{ERROR_MSG}->{$src};
2337: }
2338:
2339: =pod
2340:
1.174 albertel 2341: =item * B<getById>(id):
2342:
2343: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2344: object for that resource. This method, or other methods that use it
2345: (as in the resource object) is the only proper way to obtain a
2346: resource object.
1.133 bowersj2 2347:
1.194 bowersj2 2348: =item * B<getBySymb>(symb):
2349:
2350: Based on the symb of the resource, get a resource object for that
2351: resource. This is one of the proper ways to get a resource object.
2352:
2353: =item * B<getMapByMapPc>(map_pc):
2354:
2355: Based on the map_pc of the resource, get a resource object for
2356: the given map. This is one of the proper ways to get a resource object.
2357:
1.133 bowersj2 2358: =cut
2359:
2360: # The strategy here is to cache the resource objects, and only construct them
2361: # as we use them. The real point is to prevent reading any more from the tied
2362: # hash then we have to, which should hopefully alleviate speed problems.
2363:
2364: sub getById {
2365: my $self = shift;
2366: my $id = shift;
2367:
2368: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2369: {
2370: return $self->{RESOURCE_CACHE}->{$id};
2371: }
2372:
2373: # resource handles inserting itself into cache.
2374: # Not clear why the quotes are necessary, but as of this
2375: # writing it doesn't work without them.
2376: return "Apache::lonnavmaps::resource"->new($self, $id);
1.132 bowersj2 2377: }
1.133 bowersj2 2378:
1.172 bowersj2 2379: sub getBySymb {
2380: my $self = shift;
2381: my $symb = shift;
1.277 matthew 2382:
1.228 albertel 2383: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
1.172 bowersj2 2384: my $map = $self->getResourceByUrl($mapUrl);
1.277 matthew 2385: my $returnvalue = undef;
2386: if (ref($map)) {
2387: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2388: }
2389: return $returnvalue;
1.194 bowersj2 2390: }
2391:
2392: sub getByMapPc {
2393: my $self = shift;
2394: my $map_pc = shift;
2395: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2396: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2397: return $self->getById($map_id);
1.172 bowersj2 2398: }
2399:
1.133 bowersj2 2400: =pod
2401:
1.174 albertel 2402: =item * B<firstResource>():
2403:
2404: Returns a resource object reference corresponding to the first
2405: resource in the navmap.
1.133 bowersj2 2406:
2407: =cut
2408:
2409: sub firstResource {
2410: my $self = shift;
2411: my $firstResource = $self->navhash('map_start_' .
1.320 albertel 2412: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2413: return $self->getById($firstResource);
1.132 bowersj2 2414: }
1.133 bowersj2 2415:
2416: =pod
2417:
1.174 albertel 2418: =item * B<finishResource>():
2419:
2420: Returns a resource object reference corresponding to the last resource
2421: in the navmap.
1.133 bowersj2 2422:
2423: =cut
2424:
2425: sub finishResource {
2426: my $self = shift;
2427: my $firstResource = $self->navhash('map_finish_' .
1.320 albertel 2428: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2429: return $self->getById($firstResource);
1.132 bowersj2 2430: }
1.133 bowersj2 2431:
2432: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2433: # the actual lookup; parmval caches the results.
2434: sub parmval {
2435: my $self = shift;
2436: my ($what,$symb)=@_;
2437: my $hashkey = $what."|||".$symb;
2438:
2439: if (defined($self->{PARM_CACHE}->{$hashkey})) {
2440: return $self->{PARM_CACHE}->{$hashkey};
2441: }
2442:
2443: my $result = $self->parmval_real($what, $symb);
2444: $self->{PARM_CACHE}->{$hashkey} = $result;
2445: return $result;
1.132 bowersj2 2446: }
2447:
1.133 bowersj2 2448: sub parmval_real {
2449: my $self = shift;
1.219 albertel 2450: my ($what,$symb,$recurse) = @_;
1.133 bowersj2 2451:
1.221 bowersj2 2452: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2453: $self->generate_course_user_opt();
2454:
1.320 albertel 2455: my $cid=$env{'request.course.id'};
2456: my $csec=$env{'request.course.sec'};
2457: my $uname=$env{'user.name'};
2458: my $udom=$env{'user.domain'};
1.133 bowersj2 2459:
2460: unless ($symb) { return ''; }
2461: my $result='';
2462:
1.226 www 2463: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
1.133 bowersj2 2464:
2465: # ----------------------------------------------------- Cascading lookup scheme
2466: my $rwhat=$what;
2467: $what=~s/^parameter\_//;
2468: $what=~s/\_/\./;
2469:
2470: my $symbparm=$symb.'.'.$what;
2471: my $mapparm=$mapname.'___(all).'.$what;
2472: my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
2473:
2474: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2475: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2476: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2477:
2478: my $courselevel= $usercourseprefix.'.'.$what;
2479: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2480: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2481:
2482: my $useropt = $self->{USER_OPT};
2483: my $courseopt = $self->{COURSE_OPT};
2484: my $parmhash = $self->{PARM_HASH};
2485:
2486: # ---------------------------------------------------------- first, check user
2487: if ($uname and defined($useropt)) {
2488: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
2489: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
2490: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
2491: }
2492:
2493: # ------------------------------------------------------- second, check course
2494: if ($csec and defined($courseopt)) {
2495: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
2496: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
2497: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
2498: }
2499:
2500: if (defined($courseopt)) {
2501: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
2502: }
2503:
2504: # ----------------------------------------------------- third, check map parms
2505:
2506: my $thisparm=$$parmhash{$symbparm};
2507: if (defined($thisparm)) { return $thisparm; }
2508:
2509: # ----------------------------------------------------- fourth , check default
2510:
1.246 albertel 2511: my $meta_rwhat=$rwhat;
2512: $meta_rwhat=~s/\./_/g;
2513: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
2514: if (defined($default)) { return $default}
2515: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
1.133 bowersj2 2516: if (defined($default)) { return $default}
2517:
1.315 albertel 2518: # --------------------------------------------------- fifth, check more course
2519: if (defined($courseopt)) {
2520: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
2521: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
2522: }
2523:
2524: # --------------------------------------------------- sixth , cascade up parts
1.133 bowersj2 2525:
2526: my ($space,@qualifier)=split(/\./,$rwhat);
2527: my $qualifier=join('.',@qualifier);
2528: unless ($space eq '0') {
1.160 albertel 2529: my @parts=split(/_/,$space);
2530: my $id=pop(@parts);
2531: my $part=join('_',@parts);
2532: if ($part eq '') { $part='0'; }
1.219 albertel 2533: my $partgeneral=$self->parmval($part.".$qualifier",$symb,1);
1.160 albertel 2534: if (defined($partgeneral)) { return $partgeneral; }
1.133 bowersj2 2535: }
1.219 albertel 2536: if ($recurse) { return undef; }
2537: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
2538: if (defined($pack_def)) { return $pack_def; }
1.133 bowersj2 2539: return '';
1.145 bowersj2 2540: }
2541:
1.174 albertel 2542: =pod
1.145 bowersj2 2543:
1.174 albertel 2544: =item * B<getResourceByUrl>(url):
1.145 bowersj2 2545:
1.174 albertel 2546: Retrieves a resource object by URL of the resource. If passed a
2547: resource object, it will simply return it, so it is safe to use this
2548: method in code like "$res = $navmap->getResourceByUrl($res)", if
2549: you're not sure if $res is already an object, or just a URL. If the
2550: resource appears multiple times in the course, only the first instance
2551: will be returned. As a result, this is probably useful only for maps.
2552:
1.314 albertel 2553: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):
1.174 albertel 2554:
2555: The map is a specification of a map to retreive the resources from,
2556: either as a url or as an object. The filterFunc is a reference to a
2557: function that takes a resource object as its one argument and returns
2558: true if the resource should be included, or false if it should not
2559: be. If recursive is true, the map will be recursively examined,
2560: otherwise it will not be. If bailout is true, the function will return
1.314 albertel 2561: as soon as it finds a resource, if false it will finish. If showall is
2562: true it will not hide maps that contain nothing but one other map. By
2563: default, the map is the top-level map of the course, filterFunc is a
2564: function that always returns 1, recursive is true, bailout is false,
2565: showall is false. The resources will be returned in a list containing
2566: the resource objects for the corresponding resources, with B<no
2567: structure information> in the list; regardless of branching,
2568: recursion, etc., it will be a flat list.
1.174 albertel 2569:
2570: Thus, this is suitable for cases where you don't want the structure,
2571: just a list of all resources. It is also suitable for finding out how
2572: many resources match a given description; for this use, if all you
2573: want to know is if I<any> resources match the description, the bailout
2574: parameter will allow you to avoid potentially expensive enumeration of
2575: all matching resources.
1.145 bowersj2 2576:
1.318 albertel 2577: =item * B<hasResource>(map, filterFunc, recursive, showall):
1.145 bowersj2 2578:
1.174 albertel 2579: Convience method for
1.146 bowersj2 2580:
1.318 albertel 2581: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
1.146 bowersj2 2582:
1.174 albertel 2583: which will tell whether the map has resources matching the description
2584: in the filter function.
1.146 bowersj2 2585:
1.145 bowersj2 2586: =cut
2587:
1.277 matthew 2588:
1.145 bowersj2 2589: sub getResourceByUrl {
2590: my $self = shift;
2591: my $resUrl = shift;
2592:
2593: if (ref($resUrl)) { return $resUrl; }
2594:
2595: $resUrl = &Apache::lonnet::clutter($resUrl);
2596: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
2597: if ($resId =~ /,/) {
2598: $resId = (split (/,/, $resId))[0];
2599: }
2600: if (!$resId) { return ''; }
2601: return $self->getById($resId);
2602: }
2603:
2604: sub retrieveResources {
2605: my $self = shift;
2606: my $map = shift;
2607: my $filterFunc = shift;
2608: if (!defined ($filterFunc)) {
2609: $filterFunc = sub {return 1;};
2610: }
2611: my $recursive = shift;
2612: if (!defined($recursive)) { $recursive = 1; }
2613: my $bailout = shift;
2614: if (!defined($bailout)) { $bailout = 0; }
1.314 albertel 2615: my $showall = shift;
1.145 bowersj2 2616: # Create the necessary iterator.
2617: if (!ref($map)) { # assume it's a url of a map.
1.172 bowersj2 2618: $map = $self->getResourceByUrl($map);
1.145 bowersj2 2619: }
2620:
1.213 bowersj2 2621: # If nothing was passed, assume top-level map
2622: if (!$map) {
2623: $map = $self->getById('0.0');
2624: }
2625:
1.145 bowersj2 2626: # Check the map's validity.
1.213 bowersj2 2627: if (!$map->is_map()) {
1.145 bowersj2 2628: # Oh, to throw an exception.... how I'd love that!
2629: return ();
2630: }
2631:
1.146 bowersj2 2632: # Get an iterator.
2633: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
1.314 albertel 2634: undef, $recursive, $showall);
1.146 bowersj2 2635:
2636: my @resources = ();
2637:
2638: # Run down the iterator and collect the resources.
1.222 bowersj2 2639: my $curRes;
2640:
2641: while ($curRes = $it->next()) {
1.146 bowersj2 2642: if (ref($curRes)) {
2643: if (!&$filterFunc($curRes)) {
2644: next;
2645: }
2646:
2647: push @resources, $curRes;
2648:
2649: if ($bailout) {
2650: return @resources;
2651: }
2652: }
2653:
2654: }
2655:
2656: return @resources;
2657: }
2658:
2659: sub hasResource {
2660: my $self = shift;
2661: my $map = shift;
2662: my $filterFunc = shift;
2663: my $recursive = shift;
1.318 albertel 2664: my $showall = shift;
1.146 bowersj2 2665:
1.318 albertel 2666: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
1.133 bowersj2 2667: }
1.51 bowersj2 2668:
2669: 1;
2670:
2671: package Apache::lonnavmaps::iterator;
1.300 albertel 2672: use WeakRef;
1.320 albertel 2673: use Apache::lonnet;
2674:
1.51 bowersj2 2675: =pod
2676:
2677: =back
2678:
1.174 albertel 2679: =head1 Object: navmap Iterator
1.51 bowersj2 2680:
1.174 albertel 2681: An I<iterator> encapsulates the logic required to traverse a data
2682: structure. navmap uses an iterator to traverse the course map
2683: according to the criteria you wish to use.
2684:
2685: To obtain an iterator, call the B<getIterator>() function of a
2686: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2687: directly.) This will return a reference to the iterator:
1.51 bowersj2 2688:
2689: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2690:
2691: To get the next thing from the iterator, call B<next>:
2692:
2693: C<my $nextThing = $resourceIterator-E<gt>next()>
2694:
2695: getIterator behaves as follows:
2696:
2697: =over 4
2698:
1.174 albertel 2699: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2700:
2701: All parameters are optional. firstResource is a resource reference
2702: corresponding to where the iterator should start. It defaults to
2703: navmap->firstResource() for the corresponding nav map. finishResource
2704: corresponds to where you want the iterator to end, defaulting to
2705: navmap->finishResource(). filterHash is a hash used as a set
2706: containing strings representing the resource IDs, defaulting to
2707: empty. Condition is a 1 or 0 that sets what to do with the filter
1.205 bowersj2 2708: hash: If a 0, then only resources that exist IN the filterHash will be
1.174 albertel 2709: recursed on. If it is a 1, only resources NOT in the filterHash will
2710: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2711: false (default), the iterator will only return the first level of map
2712: that is not just a single, 'redirecting' map. If true, the iterator
2713: will return all information, starting with the top-level map,
2714: regardless of content. returnTopMap, if true (default false), will
2715: cause the iterator to return the top-level map object (resource 0.0)
2716: before anything else.
2717:
2718: Thus, by default, only top-level resources will be shown. Change the
2719: condition to a 1 without changing the hash, and all resources will be
2720: shown. Changing the condition to 1 and including some values in the
2721: hash will allow you to selectively suppress parts of the navmap, while
2722: leaving it on 0 and adding things to the hash will allow you to
2723: selectively add parts of the nav map. See the handler code for
2724: examples.
2725:
2726: The iterator will return either a reference to a resource object, or a
2727: token representing something in the map, such as the beginning of a
2728: new branch. The possible tokens are:
2729:
2730: =over 4
1.51 bowersj2 2731:
1.222 bowersj2 2732: =item * B<END_ITERATOR>:
2733:
2734: The iterator has returned all that it's going to. Further calls to the
2735: iterator will just produce more of these. This is a "false" value, and
2736: is the only false value the iterator which will be returned, so it can
2737: be used as a loop sentinel.
2738:
1.217 bowersj2 2739: =item * B<BEGIN_MAP>:
1.51 bowersj2 2740:
1.174 albertel 2741: A new map is being recursed into. This is returned I<after> the map
2742: resource itself is returned.
1.51 bowersj2 2743:
1.217 bowersj2 2744: =item * B<END_MAP>:
1.174 albertel 2745:
2746: The map is now done.
1.51 bowersj2 2747:
1.217 bowersj2 2748: =item * B<BEGIN_BRANCH>:
1.70 bowersj2 2749:
1.174 albertel 2750: A branch is now starting. The next resource returned will be the first
2751: in that branch.
1.70 bowersj2 2752:
1.217 bowersj2 2753: =item * B<END_BRANCH>:
1.70 bowersj2 2754:
1.174 albertel 2755: The branch is now done.
1.51 bowersj2 2756:
2757: =back
2758:
1.174 albertel 2759: The tokens are retreivable via methods on the iterator object, i.e.,
2760: $iterator->END_MAP.
1.70 bowersj2 2761:
1.174 albertel 2762: Maps can contain empty resources. The iterator will automatically skip
2763: over such resources, but will still treat the structure
2764: correctly. Thus, a complicated map with several branches, but
2765: consisting entirely of empty resources except for one beginning or
2766: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2767: but only one resource will be returned.
1.116 bowersj2 2768:
1.242 matthew 2769: =back
2770:
1.222 bowersj2 2771: =head2 Normal Usage
2772:
2773: Normal usage of the iterator object is to do the following:
2774:
2775: my $it = $navmap->getIterator([your params here]);
2776: my $curRes;
2777: while ($curRes = $it->next()) {
2778: [your logic here]
2779: }
2780:
2781: Note that inside of the loop, it's frequently useful to check if
2782: "$curRes" is a reference or not with the reference function; only
2783: resource objects will be references, and any non-references will
2784: be the tokens described above.
2785:
2786: Also note there is some old code floating around that trys to track
2787: the depth of the iterator to see when it's done; do not copy that
2788: code. It is difficult to get right and harder to understand then
2789: this. They should be migrated to this new style.
1.51 bowersj2 2790:
2791: =cut
2792:
2793: # Here are the tokens for the iterator:
2794:
1.222 bowersj2 2795: sub END_ITERATOR { return 0; }
1.51 bowersj2 2796: sub BEGIN_MAP { return 1; } # begining of a new map
2797: sub END_MAP { return 2; } # end of the map
2798: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2799: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 2800: sub FORWARD { return 1; } # go forward
2801: sub BACKWARD { return 2; }
1.51 bowersj2 2802:
1.96 bowersj2 2803: sub min {
2804: (my $a, my $b) = @_;
2805: if ($a < $b) { return $a; } else { return $b; }
2806: }
2807:
1.94 bowersj2 2808: sub new {
2809: # magic invocation to create a class instance
2810: my $proto = shift;
2811: my $class = ref($proto) || $proto;
2812: my $self = {};
2813:
1.300 albertel 2814: weaken($self->{NAV_MAP} = shift);
1.94 bowersj2 2815: return undef unless ($self->{NAV_MAP});
2816:
2817: # Handle the parameters
2818: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2819: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2820:
2821: # If the given resources are just the ID of the resource, get the
2822: # objects
2823: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2824: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2825: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2826: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2827:
2828: $self->{FILTER} = shift;
2829:
2830: # A hash, used as a set, of resource already seen
2831: $self->{ALREADY_SEEN} = shift;
2832: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2833: $self->{CONDITION} = shift;
2834:
1.116 bowersj2 2835: # Do we want to automatically follow "redirection" maps?
2836: $self->{FORCE_TOP} = shift;
2837:
1.162 bowersj2 2838: # Do we want to return the top-level map object (resource 0.0)?
2839: $self->{RETURN_0} = shift;
2840: # have we done that yet?
2841: $self->{HAVE_RETURNED_0} = 0;
2842:
1.94 bowersj2 2843: # Now, we need to pre-process the map, by walking forward and backward
2844: # over the parts of the map we're going to look at.
1.96 bowersj2 2845:
1.97 bowersj2 2846: # The processing steps are exactly the same, except for a few small
2847: # changes, so I bundle those up in the following list of two elements:
2848: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2849: # first_resource).
2850: # This prevents writing nearly-identical code twice.
2851: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2852: 'FIRST_RESOURCE'],
2853: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2854: 'FINISH_RESOURCE'] );
2855:
1.98 bowersj2 2856: my $maxDepth = 0; # tracks max depth
2857:
1.116 bowersj2 2858: # If there is only one resource in this map, and it's a map, we
2859: # want to remember that, so the user can ask for the first map
2860: # that isn't just a redirector.
2861: my $resource; my $resourceCount = 0;
2862:
1.209 bowersj2 2863: # Documentation on this algorithm can be found in the CVS repository at
2864: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2865: # in that file.
1.107 bowersj2 2866: # **1**
2867:
1.97 bowersj2 2868: foreach my $pass (@iterations) {
2869: my $direction = $pass->[0];
2870: my $valName = $pass->[1];
2871: my $nextResourceMethod = $pass->[2];
2872: my $firstResourceName = $pass->[3];
2873:
2874: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2875: $self->{FIRST_RESOURCE},
2876: $self->{FINISH_RESOURCE},
2877: {}, undef, 0, $direction);
1.96 bowersj2 2878:
1.97 bowersj2 2879: # prime the recursion
2880: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.222 bowersj2 2881: $iterator->next();
1.97 bowersj2 2882: my $curRes = $iterator->next();
1.222 bowersj2 2883: my $depth = 1;
2884: while ($depth > 0) {
2885: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2886: if ($curRes == $iterator->END_MAP()) { $depth--; }
2887:
1.97 bowersj2 2888: if (ref($curRes)) {
1.116 bowersj2 2889: # If there's only one resource, this will save it
1.117 bowersj2 2890: # we have to filter empty resources from consideration here,
2891: # or even "empty", redirecting maps have two (start & finish)
2892: # or three (start, finish, plus redirector)
2893: if($direction == FORWARD && $curRes->src()) {
2894: $resource = $curRes; $resourceCount++;
2895: }
1.97 bowersj2 2896: my $resultingVal = $curRes->{DATA}->{$valName};
2897: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 2898: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 2899:
1.116 bowersj2 2900: if ($nextCount == 1) { # **3**
1.97 bowersj2 2901: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2902: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2903: }
2904:
1.116 bowersj2 2905: if ($nextCount > 1) { # **4**
1.97 bowersj2 2906: foreach my $res (@{$nextResources}) {
2907: my $current = $res->{DATA}->{$valName} || 999999999;
2908: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2909: }
2910: }
2911: }
1.96 bowersj2 2912:
1.107 bowersj2 2913: # Assign the final val (**2**)
1.97 bowersj2 2914: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 2915: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2916: $curRes->{DATA}->{BOT_UP_VAL});
2917:
2918: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2919: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1.190 bowersj2 2920: }
1.222 bowersj2 2921:
2922: $curRes = $iterator->next();
1.96 bowersj2 2923: }
2924: }
1.94 bowersj2 2925:
1.116 bowersj2 2926: # Check: Was this only one resource, a map?
1.255 albertel 2927: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
1.116 bowersj2 2928: my $firstResource = $resource->map_start();
2929: my $finishResource = $resource->map_finish();
2930: return
2931: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2932: $finishResource, $self->{FILTER},
2933: $self->{ALREADY_SEEN},
1.314 albertel 2934: $self->{CONDITION},
2935: $self->{FORCE_TOP});
1.116 bowersj2 2936:
2937: }
2938:
1.98 bowersj2 2939: # Set up some bookkeeping information.
2940: $self->{CURRENT_DEPTH} = 0;
2941: $self->{MAX_DEPTH} = $maxDepth;
2942: $self->{STACK} = [];
2943: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1.222 bowersj2 2944: $self->{FINISHED} = 0; # When true, the iterator has finished
1.98 bowersj2 2945:
2946: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
2947: push @{$self->{STACK}}, [];
2948: }
2949:
1.107 bowersj2 2950: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 2951: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
2952: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
2953:
2954: bless ($self);
2955:
2956: return $self;
2957: }
2958:
2959: sub next {
2960: my $self = shift;
1.256 albertel 2961: my $closeAllPages=shift;
1.222 bowersj2 2962: if ($self->{FINISHED}) {
2963: return END_ITERATOR();
2964: }
2965:
1.162 bowersj2 2966: # If we want to return the top-level map object, and haven't yet,
2967: # do so.
2968: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
2969: $self->{HAVE_RETURNED_0} = 1;
2970: return $self->{NAV_MAP}->getById('0.0');
2971: }
1.98 bowersj2 2972:
2973: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2974: # grab the next from the recursive iterator
1.256 albertel 2975: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
1.98 bowersj2 2976:
2977: # is it a begin or end map? If so, update the depth
2978: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2979: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2980:
2981: # Are we back at depth 0? If so, stop recursing
2982: if ($self->{RECURSIVE_DEPTH} == 0) {
2983: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2984: }
2985:
2986: return $next;
2987: }
2988:
2989: if (defined($self->{FORCE_NEXT})) {
2990: my $tmp = $self->{FORCE_NEXT};
2991: $self->{FORCE_NEXT} = undef;
2992: return $tmp;
2993: }
2994:
2995: # Have we not yet begun? If not, return BEGIN_MAP and
2996: # remember we've started.
2997: if ( !$self->{STARTED} ) {
2998: $self->{STARTED} = 1;
2999: return $self->BEGIN_MAP();
3000: }
3001:
3002: # Here's the guts of the iterator.
3003:
3004: # Find the next resource, if any.
3005: my $found = 0;
3006: my $i = $self->{MAX_DEPTH};
3007: my $newDepth;
3008: my $here;
3009: while ( $i >= 0 && !$found ) {
1.107 bowersj2 3010: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
3011: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 3012: $found = 1;
3013: $newDepth = $i;
3014: }
3015: $i--;
3016: }
3017:
3018: # If we still didn't find anything, we're done.
3019: if ( !$found ) {
3020: # We need to get back down to the correct branch depth
3021: if ( $self->{CURRENT_DEPTH} > 0 ) {
3022: $self->{CURRENT_DEPTH}--;
3023: return END_BRANCH();
3024: } else {
1.222 bowersj2 3025: $self->{FINISHED} = 1;
1.98 bowersj2 3026: return END_MAP();
3027: }
3028: }
3029:
1.104 bowersj2 3030: # If this is not a resource, it must be an END_BRANCH marker we want
3031: # to return directly.
1.107 bowersj2 3032: if (!ref($here)) { # **8**
1.104 bowersj2 3033: if ($here == END_BRANCH()) { # paranoia, in case of later extension
3034: $self->{CURRENT_DEPTH}--;
3035: return $here;
3036: }
3037: }
3038:
3039: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
3040: $self->{HERE} = $here;
3041:
1.98 bowersj2 3042: # Get to the right level
3043: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
3044: push @{$self->{STACK}->[$newDepth]}, $here;
3045: $self->{CURRENT_DEPTH}--;
3046: return END_BRANCH();
3047: }
3048: if ( $self->{CURRENT_DEPTH} < $newDepth) {
3049: push @{$self->{STACK}->[$newDepth]}, $here;
3050: $self->{CURRENT_DEPTH}++;
3051: return BEGIN_BRANCH();
3052: }
3053:
3054: # If we made it here, we have the next resource, and we're at the
3055: # right branch level. So let's examine the resource for where
3056: # we can get to from here.
3057:
3058: # So we need to look at all the resources we can get to from here,
3059: # categorize them if we haven't seen them, remember if we have a new
3060: my $nextUnfiltered = $here->getNext();
1.104 bowersj2 3061: my $maxDepthAdded = -1;
3062:
1.98 bowersj2 3063: for (@$nextUnfiltered) {
3064: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 3065: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
3066: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 3067: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 3068: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 3069: }
3070: }
1.104 bowersj2 3071:
3072: # Is this the end of a branch? If so, all of the resources examined above
3073: # led to lower levels then the one we are currently at, so we push a END_BRANCH
3074: # marker onto the stack so we don't forget.
3075: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
3076: # BC branch and gets to C, it will see F as the only next resource, but it's
3077: # one level lower. Thus, this is the end of the branch, since there are no
3078: # more resources added to this level or above.
1.111 bowersj2 3079: # We don't do this if the examined resource is the finish resource,
3080: # because the condition given above is true, but the "END_MAP" will
3081: # take care of things and we should already be at depth 0.
1.104 bowersj2 3082: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 3083: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 3084: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
3085: }
3086:
1.98 bowersj2 3087: # That ends the main iterator logic. Now, do we want to recurse
3088: # down this map (if this resource is a map)?
1.256 albertel 3089: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
1.98 bowersj2 3090: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3091: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3092: my $firstResource = $self->{HERE}->map_start();
3093: my $finishResource = $self->{HERE}->map_finish();
3094:
3095: $self->{RECURSIVE_ITERATOR} =
3096: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3097: $finishResource, $self->{FILTER},
1.314 albertel 3098: $self->{ALREADY_SEEN},
3099: $self->{CONDITION},
3100: $self->{FORCE_TOP});
1.98 bowersj2 3101: }
3102:
1.116 bowersj2 3103: # If this is a blank resource, don't actually return it.
1.117 bowersj2 3104: # Should you ever find you need it, make sure to add an option to the code
3105: # that you can use; other things depend on this behavior.
1.138 bowersj2 3106: my $browsePriv = $self->{HERE}->browsePriv();
3107: if (!$self->{HERE}->src() ||
3108: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
1.256 albertel 3109: return $self->next($closeAllPages);
1.116 bowersj2 3110: }
3111:
1.98 bowersj2 3112: return $self->{HERE};
3113:
3114: }
3115:
3116: =pod
3117:
1.174 albertel 3118: The other method available on the iterator is B<getStack>, which
3119: returns an array populated with the current 'stack' of maps, as
3120: references to the resource objects. Example: This is useful when
3121: making the navigation map, as we need to check whether we are under a
3122: page map to see if we need to link directly to the resource, or to the
3123: page. The first elements in the array will correspond to the top of
3124: the stack (most inclusive map).
1.98 bowersj2 3125:
3126: =cut
3127:
3128: sub getStack {
3129: my $self=shift;
3130:
3131: my @stack;
3132:
3133: $self->populateStack(\@stack);
3134:
3135: return \@stack;
3136: }
3137:
3138: # Private method: Calls the iterators recursively to populate the stack.
3139: sub populateStack {
3140: my $self=shift;
3141: my $stack = shift;
3142:
3143: push @$stack, $self->{HERE} if ($self->{HERE});
3144:
3145: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3146: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3147: }
1.94 bowersj2 3148: }
3149:
3150: 1;
3151:
3152: package Apache::lonnavmaps::DFSiterator;
1.300 albertel 3153: use WeakRef;
1.320 albertel 3154: use Apache::lonnet;
3155:
1.100 bowersj2 3156: # Not documented in the perldoc: This is a simple iterator that just walks
3157: # through the nav map and presents the resources in a depth-first search
3158: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3159: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3160: # useful for pre-processing of some kind, and is in fact used by the main
3161: # iterator that way, but that's about it.
3162: # One could imagine merging this into the init routine of the main iterator,
1.251 www 3163: # but this might as well be left separate, since it is possible some other
1.100 bowersj2 3164: # use might be found for it. - Jeremy
1.94 bowersj2 3165:
1.117 bowersj2 3166: # Unlike the main iterator, this DOES return all resources, even blank ones.
3167: # The main iterator needs them to correctly preprocess the map.
3168:
1.94 bowersj2 3169: sub BEGIN_MAP { return 1; } # begining of a new map
3170: sub END_MAP { return 2; } # end of the map
3171: sub FORWARD { return 1; } # go forward
3172: sub BACKWARD { return 2; }
3173:
1.100 bowersj2 3174: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3175: # filter hash ref (or undef), already seen hash or undef, condition
3176: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 3177: sub new {
3178: # magic invocation to create a class instance
3179: my $proto = shift;
3180: my $class = ref($proto) || $proto;
3181: my $self = {};
3182:
1.300 albertel 3183: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3184: return undef unless ($self->{NAV_MAP});
3185:
3186: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3187: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3188:
3189: # If the given resources are just the ID of the resource, get the
3190: # objects
3191: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3192: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3193: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3194: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3195:
3196: $self->{FILTER} = shift;
3197:
3198: # A hash, used as a set, of resource already seen
3199: $self->{ALREADY_SEEN} = shift;
1.140 bowersj2 3200: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 3201: $self->{CONDITION} = shift;
1.89 bowersj2 3202: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 3203:
1.100 bowersj2 3204: # Flag: Have we started yet?
1.51 bowersj2 3205: $self->{STARTED} = 0;
3206:
3207: # Should we continue calling the recursive iterator, if any?
3208: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3209: # The recursive iterator, if any
3210: $self->{RECURSIVE_ITERATOR} = undef;
3211: # Are we recursing on a map, or a branch?
3212: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3213: # And the count of how deep it is, so that this iterator can keep track of
3214: # when to pick back up again.
3215: $self->{RECURSIVE_DEPTH} = 0;
3216:
3217: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 3218: $self->{STACK} = [];
1.51 bowersj2 3219:
3220: # Start with the first resource
1.89 bowersj2 3221: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 3222: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 3223: } else {
1.100 bowersj2 3224: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 3225: }
1.51 bowersj2 3226:
3227: bless($self);
3228: return $self;
3229: }
3230:
3231: sub next {
3232: my $self = shift;
3233:
3234: # Are we using a recursive iterator? If so, pull from that and
3235: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 3236: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 3237: # grab the next from the recursive iterator
3238: my $next = $self->{RECURSIVE_ITERATOR}->next();
3239:
3240: # is it a begin or end map? Update depth if so
3241: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3242: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3243:
3244: # Are we back at depth 0? If so, stop recursing.
3245: if ($self->{RECURSIVE_DEPTH} == 0) {
3246: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3247: }
3248:
3249: return $next;
3250: }
3251:
3252: # Is there a current resource to grab? If not, then return
1.100 bowersj2 3253: # END_MAP, which will end the iterator.
3254: if (scalar(@{$self->{STACK}}) == 0) {
3255: return $self->END_MAP();
1.51 bowersj2 3256: }
3257:
3258: # Have we not yet begun? If not, return BEGIN_MAP and
3259: # remember that we've started.
3260: if ( !$self->{STARTED} ) {
3261: $self->{STARTED} = 1;
3262: return $self->BEGIN_MAP;
3263: }
3264:
3265: # Get the next resource in the branch
1.100 bowersj2 3266: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 3267:
1.100 bowersj2 3268: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 3269: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3270:
3271: # Get the next possible resources
1.90 bowersj2 3272: my $nextUnfiltered;
1.89 bowersj2 3273: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 3274: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 3275: } else {
1.90 bowersj2 3276: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 3277: }
1.51 bowersj2 3278: my $next = [];
3279:
3280: # filter the next possibilities to remove things we've
1.100 bowersj2 3281: # already seen.
1.51 bowersj2 3282: foreach (@$nextUnfiltered) {
1.52 bowersj2 3283: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
3284: push @$next, $_;
3285: }
1.51 bowersj2 3286: }
3287:
3288: while (@$next) {
1.100 bowersj2 3289: # copy the next possibilities over to the stack
3290: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 3291: }
3292:
3293: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 3294: if ($self->{HERE}->is_map() &&
1.63 bowersj2 3295: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 3296: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3297: my $firstResource = $self->{HERE}->map_start();
3298: my $finishResource = $self->{HERE}->map_finish();
3299:
3300: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 3301: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 3302: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 3303: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 3304: }
3305:
3306: return $self->{HERE};
1.190 bowersj2 3307: }
3308:
3309: # Identical to the full iterator methods of the same name. Hate to copy/paste
3310: # but I also hate to "inherit" either iterator from the other.
3311:
3312: sub getStack {
3313: my $self=shift;
3314:
3315: my @stack;
3316:
3317: $self->populateStack(\@stack);
3318:
3319: return \@stack;
3320: }
3321:
3322: # Private method: Calls the iterators recursively to populate the stack.
3323: sub populateStack {
3324: my $self=shift;
3325: my $stack = shift;
3326:
3327: push @$stack, $self->{HERE} if ($self->{HERE});
3328:
3329: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3330: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3331: }
1.51 bowersj2 3332: }
3333:
1.1 www 3334: 1;
1.2 www 3335:
1.51 bowersj2 3336: package Apache::lonnavmaps::resource;
1.300 albertel 3337: use WeakRef;
1.51 bowersj2 3338: use Apache::lonnet;
3339:
3340: =pod
3341:
1.217 bowersj2 3342: =head1 Object: resource
1.51 bowersj2 3343:
1.217 bowersj2 3344: X<resource, navmap object>
1.174 albertel 3345: A resource object encapsulates a resource in a resource map, allowing
3346: easy manipulation of the resource, querying the properties of the
3347: resource (including user properties), and represents a reference that
3348: can be used as the canonical representation of the resource by
3349: lonnavmap clients like renderers.
3350:
3351: A resource only makes sense in the context of a navmap, as some of the
3352: data is stored in the navmap object.
3353:
3354: You will probably never need to instantiate this object directly. Use
3355: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
3356: starting resource.
1.51 bowersj2 3357:
1.188 bowersj2 3358: Resource objects respect the parameter_hiddenparts, which suppresses
3359: various parts according to the wishes of the map author. As of this
3360: writing, there is no way to override this parameter, and suppressed
3361: parts will never be returned, nor will their response types or ids be
3362: stored.
3363:
1.217 bowersj2 3364: =head2 Overview
1.51 bowersj2 3365:
1.217 bowersj2 3366: A B<Resource> is the most granular type of object in LON-CAPA that can
3367: be included in a course. It can either be a particular resource, like
3368: an HTML page, external resource, problem, etc., or it can be a
3369: container sequence, such as a "page" or a "map".
3370:
3371: To see a sequence from the user's point of view, please see the
3372: B<Creating a Course: Maps and Sequences> chapter of the Author's
3373: Manual.
3374:
3375: A Resource Object, once obtained from a navmap object via a B<getBy*>
3376: method of the navmap, or from an iterator, allows you to query
3377: information about that resource.
3378:
3379: Generally, you do not ever want to create a resource object yourself,
3380: so creation has been left undocumented. Always retrieve resources
3381: from navmap objects.
3382:
3383: =head3 Identifying Resources
3384:
3385: X<big hash>Every resource is identified by a Resource ID in the big hash that is
3386: unique to that resource for a given course. X<resource ID, in big hash>
3387: The Resource ID has the form #.#, where the first number is the same
3388: for every resource in a map, and the second is unique. For instance,
3389: for a course laid out like this:
3390:
3391: * Problem 1
3392: * Map
3393: * Resource 2
3394: * Resource 3
3395:
3396: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
3397: C<Resource 3> will share a first number. The second number may end up
3398: re-used between the two groups.
3399:
3400: The resource ID is only used in the big hash, but can be used in the
3401: context of a course to identify a resource easily. (For instance, the
3402: printing system uses it to record which resources from a sequence you
3403: wish to print.)
3404:
3405: X<symb> X<resource, symb>
3406: All resources also have B<symb>s, which uniquely identify a resource
3407: in a course. Many internal LON-CAPA functions expect a symb. A symb
3408: carries along with it the URL of the resource, and the map it appears
3409: in. Symbs are much larger then resource IDs.
1.51 bowersj2 3410:
3411: =cut
3412:
3413: sub new {
3414: # magic invocation to create a class instance
3415: my $proto = shift;
3416: my $class = ref($proto) || $proto;
3417: my $self = {};
3418:
1.300 albertel 3419: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3420: $self->{ID} = shift;
3421:
3422: # Store this new resource in the parent nav map's cache.
3423: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 3424: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 3425:
3426: # A hash that can be used by two-pass algorithms to store data
3427: # about this resource in. Not used by the resource object
3428: # directly.
3429: $self->{DATA} = {};
3430:
3431: bless($self);
3432:
3433: return $self;
3434: }
3435:
1.70 bowersj2 3436: # private function: simplify the NAV_HASH lookups we keep doing
3437: # pass the name, and to automatically append my ID, pass a true val on the
3438: # second param
3439: sub navHash {
3440: my $self = shift;
3441: my $param = shift;
3442: my $id = shift;
1.115 bowersj2 3443: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
1.70 bowersj2 3444: }
3445:
1.51 bowersj2 3446: =pod
3447:
1.217 bowersj2 3448: =head2 Methods
1.70 bowersj2 3449:
1.217 bowersj2 3450: Once you have a resource object, here's what you can do with it:
3451:
3452: =head3 Attribute Retrieval
3453:
3454: Every resource has certain attributes that can be retrieved and used:
1.70 bowersj2 3455:
3456: =over 4
3457:
1.217 bowersj2 3458: =item * B<ID>: Every resource has an ID that is unique for that
3459: resource in the course it is in. The ID is actually in the hash
3460: representing the resource, so for a resource object $res, obtain
3461: it via C<$res->{ID}).
3462:
1.174 albertel 3463: =item * B<compTitle>:
3464:
3465: Returns a "composite title", that is equal to $res->title() if the
3466: resource has a title, and is otherwise the last part of the URL (e.g.,
3467: "problem.problem").
3468:
3469: =item * B<ext>:
3470:
3471: Returns true if the resource is external.
3472:
3473: =item * B<kind>:
3474:
3475: Returns the kind of the resource from the compiled nav map.
3476:
3477: =item * B<randomout>:
1.106 bowersj2 3478:
1.174 albertel 3479: Returns true if this resource was chosen to NOT be shown to the user
3480: by the random map selection feature. In other words, this is usually
3481: false.
1.70 bowersj2 3482:
1.174 albertel 3483: =item * B<randompick>:
1.70 bowersj2 3484:
1.174 albertel 3485: Returns true for a map if the randompick feature is being used on the
3486: map. (?)
1.70 bowersj2 3487:
1.174 albertel 3488: =item * B<src>:
1.51 bowersj2 3489:
1.174 albertel 3490: Returns the source for the resource.
1.70 bowersj2 3491:
1.174 albertel 3492: =item * B<symb>:
1.70 bowersj2 3493:
1.174 albertel 3494: Returns the symb for the resource.
1.70 bowersj2 3495:
1.174 albertel 3496: =item * B<title>:
1.70 bowersj2 3497:
1.174 albertel 3498: Returns the title of the resource.
3499:
1.51 bowersj2 3500: =back
3501:
3502: =cut
3503:
3504: # These info functions can be used directly, as they don't return
3505: # resource information.
1.85 bowersj2 3506: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.303 albertel 3507: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
1.70 bowersj2 3508: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 3509: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.217 bowersj2 3510: # considered private and undocumented
1.51 bowersj2 3511: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3512: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 3513: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3514: sub randompick {
3515: my $self = shift;
3516: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
3517: '.0.parameter_randompick'};
3518: }
1.303 albertel 3519: sub link {
3520: my $self=shift;
3521: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
3522: return $self->src;
3523: }
1.51 bowersj2 3524: sub src {
3525: my $self=shift;
3526: return $self->navHash("src_", 1);
3527: }
1.303 albertel 3528: sub shown_symb {
3529: my $self=shift;
3530: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
3531: return $self->symb();
3532: }
1.51 bowersj2 3533: sub symb {
3534: my $self=shift;
3535: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3536: my $symbSrc = &Apache::lonnet::declutter($self->src());
1.223 albertel 3537: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
1.51 bowersj2 3538: . '___' . $second . '___' . $symbSrc;
1.223 albertel 3539: return &Apache::lonnet::symbclean($symb);
1.51 bowersj2 3540: }
1.321 ! raeburn 3541: sub wrap_symb {
! 3542: my $self = shift;
! 3543: return $self->{NAV_MAP}->wrap_symb($self->symb());
! 3544: }
1.213 bowersj2 3545: sub title {
3546: my $self=shift;
3547: if ($self->{ID} eq '0.0') {
3548: # If this is the top-level map, return the title of the course
3549: # since this map can not be titled otherwise.
1.320 albertel 3550: return $env{'course.'.$env{'request.course.id'}.'.description'};
1.213 bowersj2 3551: }
3552: return $self->navHash("title_", 1); }
1.217 bowersj2 3553: # considered private and undocumented
1.70 bowersj2 3554: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.301 albertel 3555: sub condition {
3556: my $self=shift;
3557: my $undercond=$self->navHash("undercond_", 1);
3558: if (!defined($undercond)) { return 1; };
3559: my $condid=$self->navHash("condid_$undercond");
3560: if (!defined($condid)) { return 1; };
3561: my $condition=&Apache::lonnet::directcondval($condid);
3562: return $condition;
3563: }
3564:
1.106 bowersj2 3565: sub compTitle {
3566: my $self = shift;
3567: my $title = $self->title();
1.176 www 3568: $title=~s/\&colon\;/\:/gs;
1.106 bowersj2 3569: if (!$title) {
3570: $title = $self->src();
3571: $title = substr($title, rindex($title, '/') + 1);
3572: }
3573: return $title;
3574: }
1.70 bowersj2 3575: =pod
3576:
3577: B<Predicate Testing the Resource>
3578:
3579: These methods are shortcuts to deciding if a given resource has a given property.
3580:
3581: =over 4
3582:
1.174 albertel 3583: =item * B<is_map>:
3584:
3585: Returns true if the resource is a map type.
3586:
3587: =item * B<is_problem>:
1.70 bowersj2 3588:
1.174 albertel 3589: Returns true if the resource is a problem type, false
3590: otherwise. (Looks at the extension on the src field; might need more
3591: to work correctly.)
1.70 bowersj2 3592:
1.174 albertel 3593: =item * B<is_page>:
1.70 bowersj2 3594:
1.174 albertel 3595: Returns true if the resource is a page.
3596:
3597: =item * B<is_sequence>:
3598:
3599: Returns true if the resource is a sequence.
1.70 bowersj2 3600:
3601: =back
3602:
3603: =cut
3604:
1.256 albertel 3605: sub hasResource {
3606: my $self = shift;
3607: return $self->{NAV_MAP}->hasResource(@_);
3608: }
3609:
3610: sub retrieveResources {
3611: my $self = shift;
3612: return $self->{NAV_MAP}->retrieveResources(@_);
3613: }
1.70 bowersj2 3614:
3615: sub is_html {
1.51 bowersj2 3616: my $self=shift;
3617: my $src = $self->src();
1.70 bowersj2 3618: return ($src =~ /html$/);
1.51 bowersj2 3619: }
1.70 bowersj2 3620: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3621: sub is_page {
1.51 bowersj2 3622: my $self=shift;
3623: my $src = $self->src();
1.205 bowersj2 3624: return $self->navHash("is_map_", 1) &&
3625: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
1.51 bowersj2 3626: }
1.70 bowersj2 3627: sub is_problem {
1.51 bowersj2 3628: my $self=shift;
3629: my $src = $self->src();
1.256 albertel 3630: return ($src =~ /\.(problem|exam|quiz|assess|survey|form|library)$/)
3631: }
3632: sub contains_problem {
3633: my $self=shift;
3634: if ($self->is_page()) {
3635: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
3636: return $hasProblem;
3637: }
3638: return 0;
1.51 bowersj2 3639: }
1.70 bowersj2 3640: sub is_sequence {
1.51 bowersj2 3641: my $self=shift;
3642: my $src = $self->src();
1.205 bowersj2 3643: return $self->navHash("is_map_", 1) &&
3644: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
1.51 bowersj2 3645: }
1.261 matthew 3646: sub is_survey {
3647: my $self = shift();
3648: my $part = shift();
1.263 albertel 3649: if ($self->parmval('type',$part) eq 'survey') {
1.261 matthew 3650: return 1;
3651: }
1.263 albertel 3652: if ($self->src() =~ /\.(survey)$/) {
1.261 matthew 3653: return 1;
3654: }
3655: return 0;
3656: }
1.51 bowersj2 3657:
1.266 raeburn 3658: sub is_empty_sequence {
3659: my $self=shift;
3660: my $src = $self->src();
3661: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
3662: }
3663:
1.101 bowersj2 3664: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 3665: sub parmval {
3666: my $self = shift;
3667: my $what = shift;
1.185 bowersj2 3668: my $part = shift;
3669: if (!defined($part)) {
3670: $part = '0';
3671: }
1.51 bowersj2 3672: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3673: }
3674:
1.70 bowersj2 3675: =pod
3676:
3677: B<Map Methods>
3678:
1.174 albertel 3679: These methods are useful for getting information about the map
3680: properties of the resource, if the resource is a map (B<is_map>).
1.70 bowersj2 3681:
3682: =over 4
3683:
1.174 albertel 3684: =item * B<map_finish>:
3685:
3686: Returns a reference to a resource object corresponding to the finish
3687: resource of the map.
1.70 bowersj2 3688:
1.174 albertel 3689: =item * B<map_pc>:
1.70 bowersj2 3690:
1.174 albertel 3691: Returns the pc value of the map, which is the first number that
3692: appears in the resource ID of the resources in the map, and is the
3693: number that appears around the middle of the symbs of the resources in
3694: that map.
1.70 bowersj2 3695:
1.174 albertel 3696: =item * B<map_start>:
3697:
3698: Returns a reference to a resource object corresponding to the start
3699: resource of the map.
3700:
3701: =item * B<map_type>:
3702:
3703: Returns a string with the type of the map in it.
1.70 bowersj2 3704:
3705: =back
1.51 bowersj2 3706:
1.70 bowersj2 3707: =cut
1.51 bowersj2 3708:
3709: sub map_finish {
3710: my $self = shift;
3711: my $src = $self->src();
1.144 bowersj2 3712: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 3713: my $res = $self->navHash("map_finish_$src", 0);
3714: $res = $self->{NAV_MAP}->getById($res);
3715: return $res;
3716: }
1.70 bowersj2 3717: sub map_pc {
3718: my $self = shift;
3719: my $src = $self->src();
3720: return $self->navHash("map_pc_$src", 0);
3721: }
1.51 bowersj2 3722: sub map_start {
3723: my $self = shift;
3724: my $src = $self->src();
1.144 bowersj2 3725: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 3726: my $res = $self->navHash("map_start_$src", 0);
3727: $res = $self->{NAV_MAP}->getById($res);
3728: return $res;
3729: }
3730: sub map_type {
3731: my $self = shift;
3732: my $pc = $self->map_pc();
3733: return $self->navHash("map_type_$pc", 0);
3734: }
3735:
3736: #####
3737: # Property queries
3738: #####
3739:
3740: # These functions will be responsible for returning the CORRECT
3741: # VALUE for the parameter, no matter what. So while they may look
3742: # like direct calls to parmval, they can be more then that.
3743: # So, for instance, the duedate function should use the "duedatetype"
3744: # information, rather then the resource object user.
3745:
3746: =pod
3747:
3748: =head2 Resource Parameters
3749:
1.174 albertel 3750: In order to use the resource parameters correctly, the nav map must
3751: have been instantiated with genCourseAndUserOptions set to true, so
3752: the courseopt and useropt is read correctly. Then, you can call these
3753: functions to get the relevant parameters for the resource. Each
3754: function defaults to part "0", but can be directed to another part by
3755: passing the part as the parameter.
3756:
3757: These methods are responsible for getting the parameter correct, not
3758: merely reflecting the contents of the GDBM hashes. As we move towards
3759: dates relative to other dates, these methods should be updated to
3760: reflect that. (Then, anybody using these methods will not have to update
3761: their code.)
3762:
3763: =over 4
3764:
3765: =item * B<acc>:
3766:
3767: Get the Client IP/Name Access Control information.
1.51 bowersj2 3768:
1.174 albertel 3769: =item * B<answerdate>:
1.51 bowersj2 3770:
1.174 albertel 3771: Get the answer-reveal date for the problem.
3772:
1.211 bowersj2 3773: =item * B<awarded>:
3774:
3775: Gets the awarded value for the problem part. Requires genUserData set to
3776: true when the navmap object was created.
3777:
1.174 albertel 3778: =item * B<duedate>:
3779:
3780: Get the due date for the problem.
3781:
3782: =item * B<tries>:
3783:
3784: Get the number of tries the student has used on the problem.
3785:
3786: =item * B<maxtries>:
3787:
3788: Get the number of max tries allowed.
3789:
3790: =item * B<opendate>:
1.51 bowersj2 3791:
1.174 albertel 3792: Get the open date for the problem.
1.51 bowersj2 3793:
1.174 albertel 3794: =item * B<sig>:
1.51 bowersj2 3795:
1.174 albertel 3796: Get the significant figures setting.
1.51 bowersj2 3797:
1.174 albertel 3798: =item * B<tol>:
1.51 bowersj2 3799:
1.174 albertel 3800: Get the tolerance for the problem.
1.51 bowersj2 3801:
1.174 albertel 3802: =item * B<tries>:
1.51 bowersj2 3803:
1.174 albertel 3804: Get the number of tries the user has already used on the problem.
1.51 bowersj2 3805:
1.174 albertel 3806: =item * B<type>:
1.51 bowersj2 3807:
1.174 albertel 3808: Get the question type for the problem.
1.70 bowersj2 3809:
1.174 albertel 3810: =item * B<weight>:
1.51 bowersj2 3811:
1.174 albertel 3812: Get the weight for the problem.
1.51 bowersj2 3813:
3814: =back
3815:
3816: =cut
3817:
3818: sub acc {
3819: (my $self, my $part) = @_;
3820: return $self->parmval("acc", $part);
3821: }
3822: sub answerdate {
3823: (my $self, my $part) = @_;
3824: # Handle intervals
3825: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
3826: return $self->duedate($part) +
3827: $self->parmval("answerdate", $part);
3828: }
3829: return $self->parmval("answerdate", $part);
1.106 bowersj2 3830: }
1.211 bowersj2 3831: sub awarded {
3832: my $self = shift; my $part = shift;
1.221 bowersj2 3833: $self->{NAV_MAP}->get_user_data();
1.211 bowersj2 3834: if (!defined($part)) { $part = '0'; }
3835: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
3836: }
1.51 bowersj2 3837: sub duedate {
3838: (my $self, my $part) = @_;
1.260 albertel 3839: my $interval=$self->parmval("interval", $part);
3840: if ($interval) {
3841: my $first_access=&Apache::lonnet::get_first_access('map',$self->symb);
3842: if ($first_access) { return ($first_access+$interval); }
3843: }
1.51 bowersj2 3844: return $self->parmval("duedate", $part);
3845: }
3846: sub maxtries {
3847: (my $self, my $part) = @_;
3848: return $self->parmval("maxtries", $part);
3849: }
3850: sub opendate {
3851: (my $self, my $part) = @_;
3852: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
3853: return $self->duedate($part) -
3854: $self->parmval("opendate", $part);
3855: }
3856: return $self->parmval("opendate");
3857: }
1.185 bowersj2 3858: sub problemstatus {
3859: (my $self, my $part) = @_;
1.236 bowersj2 3860: return lc $self->parmval("problemstatus", $part);
1.185 bowersj2 3861: }
1.51 bowersj2 3862: sub sig {
3863: (my $self, my $part) = @_;
3864: return $self->parmval("sig", $part);
3865: }
3866: sub tol {
3867: (my $self, my $part) = @_;
3868: return $self->parmval("tol", $part);
3869: }
1.108 bowersj2 3870: sub tries {
3871: my $self = shift;
3872: my $tries = $self->queryRestoreHash('tries', shift);
3873: if (!defined($tries)) { return '0';}
1.51 bowersj2 3874: return $tries;
3875: }
1.70 bowersj2 3876: sub type {
3877: (my $self, my $part) = @_;
3878: return $self->parmval("type", $part);
3879: }
1.109 bowersj2 3880: sub weight {
3881: my $self = shift; my $part = shift;
1.211 bowersj2 3882: if (!defined($part)) { $part = '0'; }
3883: return &Apache::lonnet::EXT('resource.'.$part.'.weight',
1.320 albertel 3884: $self->symb(), $env{'user.domain'},
3885: $env{'user.name'},
3886: $env{'request.course.sec'});
1.274 matthew 3887: }
3888: sub part_display {
3889: my $self= shift(); my $partID = shift();
3890: if (! defined($partID)) { $partID = '0'; }
3891: my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
3892: $self->symb);
3893: if (! defined($display) || $display eq '') {
3894: $display = $partID;
3895: }
3896: return $display;
1.70 bowersj2 3897: }
1.51 bowersj2 3898:
3899: # Multiple things need this
3900: sub getReturnHash {
3901: my $self = shift;
3902:
3903: if (!defined($self->{RETURN_HASH})) {
1.84 bowersj2 3904: my %tmpHash = &Apache::lonnet::restore($self->symb());
1.51 bowersj2 3905: $self->{RETURN_HASH} = \%tmpHash;
3906: }
3907: }
3908:
3909: ######
3910: # Status queries
3911: ######
3912:
3913: # These methods query the status of problems.
3914:
3915: # If we need to count parts, this function determines the number of
3916: # parts from the metadata. When called, it returns a reference to a list
3917: # of strings corresponding to the parts. (Thus, using it in a scalar context
3918: # tells you how many parts you have in the problem:
3919: # $partcount = scalar($resource->countParts());
3920: # Don't use $self->{PARTS} directly because you don't know if it's been
3921: # computed yet.
3922:
3923: =pod
3924:
3925: =head2 Resource misc
3926:
3927: Misc. functions for the resource.
3928:
3929: =over 4
3930:
1.174 albertel 3931: =item * B<hasDiscussion>:
1.59 bowersj2 3932:
1.174 albertel 3933: Returns a false value if there has been discussion since the user last
3934: logged in, true if there has. Always returns false if the discussion
3935: data was not extracted when the nav map was constructed.
3936:
3937: =item * B<getFeedback>:
3938:
3939: Gets the feedback for the resource and returns the raw feedback string
3940: for the resource, or the null string if there is no feedback or the
3941: email data was not extracted when the nav map was constructed. Usually
3942: used like this:
1.59 bowersj2 3943:
3944: for (split(/\,/, $res->getFeedback())) {
3945: my $link = &Apache::lonnet::escape($_);
3946: ...
3947:
3948: and use the link as appropriate.
3949:
3950: =cut
3951:
3952: sub hasDiscussion {
3953: my $self = shift;
3954: return $self->{NAV_MAP}->hasDiscussion($self->symb());
3955: }
3956:
3957: sub getFeedback {
3958: my $self = shift;
1.124 bowersj2 3959: my $source = $self->src();
1.125 bowersj2 3960: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.124 bowersj2 3961: return $self->{NAV_MAP}->getFeedback($source);
3962: }
3963:
3964: sub getErrors {
3965: my $self = shift;
3966: my $source = $self->src();
3967: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
3968: return $self->{NAV_MAP}->getErrors($source);
1.59 bowersj2 3969: }
3970:
3971: =pod
3972:
1.174 albertel 3973: =item * B<parts>():
1.51 bowersj2 3974:
1.174 albertel 3975: Returns a list reference containing sorted strings corresponding to
1.193 bowersj2 3976: each part of the problem. Single part problems have only a part '0'.
3977: Multipart problems do not return their part '0', since they typically
3978: do not really matter.
1.174 albertel 3979:
3980: =item * B<countParts>():
3981:
3982: Returns the number of parts of the problem a student can answer. Thus,
3983: for single part problems, returns 1. For multipart, it returns the
1.193 bowersj2 3984: number of parts in the problem, not including psuedo-part 0.
1.51 bowersj2 3985:
1.290 matthew 3986: =item * B<countResponses>():
3987:
3988: Returns the total number of responses in the problem a student can answer.
3989:
3990: =item * B<responseTypes>():
3991:
3992: Returns a hash whose keys are the response types. The values are the number
3993: of times each response type is used. This is for the I<entire> problem, not
3994: just a single part.
3995:
1.192 bowersj2 3996: =item * B<multipart>():
3997:
1.193 bowersj2 3998: Returns true if the problem is multipart, false otherwise. Use this instead
3999: of countParts if all you want is multipart/not multipart.
1.192 bowersj2 4000:
1.187 bowersj2 4001: =item * B<responseType>($part):
4002:
4003: Returns the response type of the part, without the word "response" on the
4004: end. Example return values: 'string', 'essay', 'numeric', etc.
4005:
1.193 bowersj2 4006: =item * B<responseIds>($part):
1.187 bowersj2 4007:
1.193 bowersj2 4008: Retreives the response IDs for the given part as an array reference containing
4009: strings naming the response IDs. This may be empty.
1.187 bowersj2 4010:
1.51 bowersj2 4011: =back
4012:
4013: =cut
4014:
4015: sub parts {
4016: my $self = shift;
4017:
1.192 bowersj2 4018: if ($self->ext) { return []; }
1.67 bowersj2 4019:
1.51 bowersj2 4020: $self->extractParts();
4021: return $self->{PARTS};
4022: }
4023:
4024: sub countParts {
4025: my $self = shift;
4026:
4027: my $parts = $self->parts();
1.191 bowersj2 4028:
4029: # If I left this here, then it's not necessary.
4030: #my $delta = 0;
4031: #for my $part (@$parts) {
4032: # if ($part eq '0') { $delta--; }
4033: #}
1.66 bowersj2 4034:
4035: if ($self->{RESOURCE_ERROR}) {
4036: return 0;
4037: }
4038:
1.191 bowersj2 4039: return scalar(@{$parts}); # + $delta;
1.192 bowersj2 4040: }
4041:
1.290 matthew 4042: sub countResponses {
4043: my $self = shift;
4044: my $count;
1.293 matthew 4045: foreach my $part (@{$self->parts()}) {
4046: $count+= scalar($self->responseIds($part));
1.290 matthew 4047: }
4048: return $count;
4049: }
4050:
4051: sub responseTypes {
4052: my $self = shift;
1.291 albertel 4053: my %responses;
1.290 matthew 4054: foreach my $part ($self->parts()) {
4055: foreach my $responsetype ($self->responseType($part)) {
1.291 albertel 4056: $responses{$responsetype}++ if (defined($responsetype));
1.290 matthew 4057: }
4058: }
1.291 albertel 4059: return %responses;
1.290 matthew 4060: }
4061:
1.192 bowersj2 4062: sub multipart {
4063: my $self = shift;
4064: return $self->countParts() > 1;
1.51 bowersj2 4065: }
4066:
1.225 bowersj2 4067: sub singlepart {
4068: my $self = shift;
4069: return $self->countParts() == 1;
4070: }
4071:
1.187 bowersj2 4072: sub responseType {
1.184 bowersj2 4073: my $self = shift;
4074: my $part = shift;
4075:
4076: $self->extractParts();
1.235 albertel 4077: if (defined($self->{RESPONSE_TYPES}->{$part})) {
4078: return @{$self->{RESPONSE_TYPES}->{$part}};
4079: } else {
4080: return undef;
4081: }
1.187 bowersj2 4082: }
4083:
1.193 bowersj2 4084: sub responseIds {
1.187 bowersj2 4085: my $self = shift;
4086: my $part = shift;
4087:
4088: $self->extractParts();
1.235 albertel 4089: if (defined($self->{RESPONSE_IDS}->{$part})) {
4090: return @{$self->{RESPONSE_IDS}->{$part}};
4091: } else {
4092: return undef;
4093: }
1.184 bowersj2 4094: }
4095:
4096: # Private function: Extracts the parts information, both part names and
1.187 bowersj2 4097: # part types, and saves it.
1.51 bowersj2 4098: sub extractParts {
4099: my $self = shift;
4100:
1.153 bowersj2 4101: return if (defined($self->{PARTS}));
1.67 bowersj2 4102: return if ($self->ext);
1.51 bowersj2 4103:
4104: $self->{PARTS} = [];
4105:
1.181 bowersj2 4106: my %parts;
4107:
1.82 bowersj2 4108: # Retrieve part count, if this is a problem
4109: if ($self->is_problem()) {
1.240 albertel 4110: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
1.152 matthew 4111: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
1.181 bowersj2 4112:
1.239 bowersj2 4113: if ($partorder) {
4114: my @parts;
4115: for my $part (split (/,/,$partorder)) {
4116: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4117: push @parts, $part;
1.241 albertel 4118: $parts{$part} = 1;
1.239 bowersj2 4119: }
4120: }
4121: $self->{PARTS} = \@parts;
4122: } else {
4123: if (!$metadata) {
4124: $self->{RESOURCE_ERROR} = 1;
4125: $self->{PARTS} = [];
4126: $self->{PART_TYPE} = {};
4127: return;
4128: }
4129: foreach (split(/\,/,$metadata)) {
4130: if ($_ =~ /^part_(.*)$/) {
4131: my $part = $1;
4132: # This floods the logs if it blows up
4133: if (defined($parts{$part})) {
1.241 albertel 4134: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
4135: }
1.239 bowersj2 4136:
4137: # check to see if part is turned off.
4138:
4139: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4140: $parts{$part} = 1;
4141: }
4142: }
4143: }
4144: my @sortedParts = sort keys %parts;
4145: $self->{PARTS} = \@sortedParts;
1.51 bowersj2 4146: }
1.82 bowersj2 4147:
1.187 bowersj2 4148:
1.284 matthew 4149: # These hashes probably do not need names that end with "Hash"....
1.187 bowersj2 4150: my %responseIdHash;
4151: my %responseTypeHash;
4152:
1.189 bowersj2 4153:
4154: # Init the responseIdHash
4155: foreach (@{$self->{PARTS}}) {
4156: $responseIdHash{$_} = [];
4157: }
4158:
1.187 bowersj2 4159: # Now, the unfortunate thing about this is that parts, part name, and
1.239 bowersj2 4160: # response id are delimited by underscores, but both the part
1.187 bowersj2 4161: # name and response id can themselves have underscores in them.
4162: # So we have to use our knowlege of part names to figure out
4163: # where the part names begin and end, and even then, it is possible
4164: # to construct ambiguous situations.
4165: foreach (split /,/, $metadata) {
4166: if ($_ =~ /^([a-zA-Z]+)response_(.*)/) {
4167: my $responseType = $1;
4168: my $partStuff = $2;
4169: my $partIdSoFar = '';
4170: my @partChunks = split /_/, $partStuff;
4171: my $i = 0;
4172: for ($i = 0; $i < scalar(@partChunks); $i++) {
4173: if ($partIdSoFar) { $partIdSoFar .= '_'; }
4174: $partIdSoFar .= $partChunks[$i];
4175: if ($parts{$partIdSoFar}) {
4176: my @otherChunks = @partChunks[$i+1..$#partChunks];
4177: my $responseId = join('_', @otherChunks);
1.188 bowersj2 4178: push @{$responseIdHash{$partIdSoFar}}, $responseId;
1.233 matthew 4179: push @{$responseTypeHash{$partIdSoFar}}, $responseType;
1.187 bowersj2 4180: }
4181: }
4182: }
4183: }
1.264 albertel 4184: my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
1.284 matthew 4185: #
4186: # Reorder the arrays in the %responseIdHash and %responseTypeHash
1.264 albertel 4187: if ($resorder) {
4188: my @resorder=split(/,/,$resorder);
4189: foreach my $part (keys(%responseIdHash)) {
1.286 albertel 4190: my $i=0;
4191: my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
1.264 albertel 4192: my @neworder;
4193: foreach my $possibleid (@resorder) {
4194: if (exists($resids{$possibleid})) {
1.286 albertel 4195: push(@neworder,$resids{$possibleid});
1.264 albertel 4196: }
4197: }
1.286 albertel 4198: my @ids;
4199: my @type;
4200: foreach my $element (@neworder) {
4201: push (@ids,$responseIdHash{$part}->[$element]);
4202: push (@type,$responseTypeHash{$part}->[$element]);
4203: }
4204: $responseIdHash{$part}=\@ids;
4205: $responseTypeHash{$part}=\@type;
1.264 albertel 4206: }
4207: }
1.187 bowersj2 4208: $self->{RESPONSE_IDS} = \%responseIdHash;
4209: $self->{RESPONSE_TYPES} = \%responseTypeHash;
1.154 bowersj2 4210: }
4211:
1.51 bowersj2 4212: return;
4213: }
4214:
4215: =pod
4216:
4217: =head2 Resource Status
4218:
1.174 albertel 4219: Problem resources have status information, reflecting their various
4220: dates and completion statuses.
1.51 bowersj2 4221:
1.174 albertel 4222: There are two aspects to the status: the date-related information and
4223: the completion information.
1.51 bowersj2 4224:
1.174 albertel 4225: Idiomatic usage of these two methods would probably look something
4226: like
1.51 bowersj2 4227:
4228: foreach ($resource->parts()) {
4229: my $dateStatus = $resource->getDateStatus($_);
4230: my $completionStatus = $resource->getCompletionStatus($_);
4231:
1.70 bowersj2 4232: or
4233:
4234: my $status = $resource->status($_);
4235:
1.51 bowersj2 4236: ... use it here ...
4237: }
4238:
1.174 albertel 4239: Which you use depends on exactly what you are looking for. The
4240: status() function has been optimized for the nav maps display and may
4241: not precisely match what you need elsewhere.
1.101 bowersj2 4242:
1.174 albertel 4243: The symbolic constants shown below can be accessed through the
4244: resource object: C<$res->OPEN>.
1.101 bowersj2 4245:
1.51 bowersj2 4246: =over 4
4247:
1.174 albertel 4248: =item * B<getDateStatus>($part):
4249:
4250: ($part defaults to 0). A convenience function that returns a symbolic
4251: constant telling you about the date status of the part. The possible
4252: return values are:
1.51 bowersj2 4253:
4254: =back
4255:
4256: B<Date Codes>
4257:
4258: =over 4
4259:
1.174 albertel 4260: =item * B<OPEN_LATER>:
4261:
4262: The problem will be opened later.
4263:
4264: =item * B<OPEN>:
4265:
4266: Open and not yet due.
4267:
1.51 bowersj2 4268:
1.174 albertel 4269: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 4270:
1.174 albertel 4271: The due date has passed, but the answer date has not yet arrived.
1.59 bowersj2 4272:
1.174 albertel 4273: =item * B<PAST_DUE_NO_ANSWER>:
1.54 bowersj2 4274:
1.174 albertel 4275: The due date has passed and there is no answer opening date set.
1.51 bowersj2 4276:
1.174 albertel 4277: =item * B<ANSWER_OPEN>:
1.51 bowersj2 4278:
1.174 albertel 4279: The answer date is here.
4280:
4281: =item * B<NETWORK_FAILURE>:
4282:
4283: The information is unknown due to network failure.
1.51 bowersj2 4284:
4285: =back
4286:
4287: =cut
4288:
4289: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 4290: sub OPEN_LATER { return 0; }
4291: sub OPEN { return 1; }
4292: sub PAST_DUE_NO_ANSWER { return 2; }
4293: sub PAST_DUE_ANSWER_LATER { return 3; }
4294: sub ANSWER_OPEN { return 4; }
4295: sub NOTHING_SET { return 5; }
4296: sub NETWORK_FAILURE { return 100; }
4297:
4298: # getDateStatus gets the date status for a given problem part.
4299: # Because answer date, due date, and open date are fully independent
4300: # (i.e., it is perfectly possible to *only* have an answer date),
4301: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
4302: # (past, future, none given). This function handles this with a decision
4303: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 4304:
4305: sub getDateStatus {
4306: my $self = shift;
4307: my $part = shift;
4308: $part = "0" if (!defined($part));
1.54 bowersj2 4309:
4310: # Always return network failure if there was one.
1.51 bowersj2 4311: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4312:
4313: my $now = time();
4314:
1.53 bowersj2 4315: my $open = $self->opendate($part);
4316: my $due = $self->duedate($part);
4317: my $answer = $self->answerdate($part);
4318:
4319: if (!$open && !$due && !$answer) {
4320: # no data on the problem at all
4321: # should this be the same as "open later"? think multipart.
4322: return $self->NOTHING_SET;
4323: }
1.59 bowersj2 4324: if (!$open || $now < $open) {return $self->OPEN_LATER}
4325: if (!$due || $now < $due) {return $self->OPEN}
4326: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
4327: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 4328: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 4329: }
4330:
4331: =pod
4332:
4333: B<>
4334:
4335: =over 4
4336:
1.174 albertel 4337: =item * B<getCompletionStatus>($part):
1.51 bowersj2 4338:
1.174 albertel 4339: ($part defaults to 0.) A convenience function that returns a symbolic
4340: constant telling you about the completion status of the part, with the
4341: following possible results:
4342:
4343: =back
1.51 bowersj2 4344:
4345: B<Completion Codes>
4346:
4347: =over 4
4348:
1.174 albertel 4349: =item * B<NOT_ATTEMPTED>:
4350:
4351: Has not been attempted at all.
4352:
4353: =item * B<INCORRECT>:
4354:
4355: Attempted, but wrong by student.
1.51 bowersj2 4356:
1.174 albertel 4357: =item * B<INCORRECT_BY_OVERRIDE>:
1.51 bowersj2 4358:
1.174 albertel 4359: Attempted, but wrong by instructor override.
1.51 bowersj2 4360:
1.174 albertel 4361: =item * B<CORRECT>:
1.51 bowersj2 4362:
1.174 albertel 4363: Correct or correct by instructor.
1.51 bowersj2 4364:
1.174 albertel 4365: =item * B<CORRECT_BY_OVERRIDE>:
1.51 bowersj2 4366:
1.174 albertel 4367: Correct by instructor override.
1.51 bowersj2 4368:
1.174 albertel 4369: =item * B<EXCUSED>:
4370:
4371: Excused. Not yet implemented.
4372:
4373: =item * B<NETWORK_FAILURE>:
4374:
4375: Information not available due to network failure.
4376:
4377: =item * B<ATTEMPTED>:
4378:
4379: Attempted, and not yet graded.
1.69 bowersj2 4380:
1.51 bowersj2 4381: =back
4382:
4383: =cut
4384:
1.53 bowersj2 4385: sub NOT_ATTEMPTED { return 10; }
4386: sub INCORRECT { return 11; }
4387: sub INCORRECT_BY_OVERRIDE { return 12; }
4388: sub CORRECT { return 13; }
4389: sub CORRECT_BY_OVERRIDE { return 14; }
4390: sub EXCUSED { return 15; }
1.69 bowersj2 4391: sub ATTEMPTED { return 16; }
1.51 bowersj2 4392:
4393: sub getCompletionStatus {
4394: my $self = shift;
4395: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4396:
1.108 bowersj2 4397: my $status = $self->queryRestoreHash('solved', shift);
1.51 bowersj2 4398:
1.251 www 4399: # Left as separate if statements in case we ever do more with this
1.51 bowersj2 4400: if ($status eq 'correct_by_student') {return $self->CORRECT;}
1.288 albertel 4401: if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
1.51 bowersj2 4402: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
4403: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
4404: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
4405: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 4406: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 4407: return $self->NOT_ATTEMPTED;
1.108 bowersj2 4408: }
4409:
4410: sub queryRestoreHash {
4411: my $self = shift;
4412: my $hashentry = shift;
4413: my $part = shift;
1.185 bowersj2 4414: $part = "0" if (!defined($part) || $part eq '');
1.108 bowersj2 4415: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4416:
4417: $self->getReturnHash();
4418:
4419: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 4420: }
4421:
4422: =pod
4423:
4424: B<Composite Status>
4425:
1.174 albertel 4426: Along with directly returning the date or completion status, the
4427: resource object includes a convenience function B<status>() that will
4428: combine the two status tidbits into one composite status that can
1.191 bowersj2 4429: represent the status of the resource as a whole. This method represents
4430: the concept of the thing we want to display to the user on the nav maps
4431: screen, which is a combination of completion and open status. The precise logic is
1.174 albertel 4432: documented in the comments of the status method. The following results
4433: may be returned, all available as methods on the resource object
1.185 bowersj2 4434: ($res->NETWORK_FAILURE): In addition to the return values that match
4435: the date or completion status, this function can return "ANSWER_SUBMITTED"
4436: if that problemstatus parameter value is set to No, suppressing the
4437: incorrect/correct feedback.
1.51 bowersj2 4438:
4439: =over 4
4440:
1.174 albertel 4441: =item * B<NETWORK_FAILURE>:
4442:
4443: The network has failed and the information is not available.
1.51 bowersj2 4444:
1.174 albertel 4445: =item * B<NOTHING_SET>:
1.53 bowersj2 4446:
1.174 albertel 4447: No dates have been set for this problem (part) at all. (Because only
4448: certain parts of a multi-part problem may be assigned, this can not be
4449: collapsed into "open later", as we do not know a given part will EVER
4450: be opened. For single part, this is the same as "OPEN_LATER".)
1.51 bowersj2 4451:
1.174 albertel 4452: =item * B<CORRECT>:
1.51 bowersj2 4453:
1.174 albertel 4454: For any reason at all, the part is considered correct.
1.54 bowersj2 4455:
1.174 albertel 4456: =item * B<EXCUSED>:
1.51 bowersj2 4457:
1.174 albertel 4458: For any reason at all, the problem is excused.
1.51 bowersj2 4459:
1.174 albertel 4460: =item * B<PAST_DUE_NO_ANSWER>:
1.51 bowersj2 4461:
1.174 albertel 4462: The problem is past due, not considered correct, and no answer date is
4463: set.
1.51 bowersj2 4464:
1.174 albertel 4465: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 4466:
1.174 albertel 4467: The problem is past due, not considered correct, and an answer date in
4468: the future is set.
1.51 bowersj2 4469:
1.174 albertel 4470: =item * B<ANSWER_OPEN>:
4471:
4472: The problem is past due, not correct, and the answer is now available.
4473:
4474: =item * B<OPEN_LATER>:
4475:
4476: The problem is not yet open.
4477:
4478: =item * B<TRIES_LEFT>:
4479:
4480: The problem is open, has been tried, is not correct, but there are
4481: tries left.
4482:
4483: =item * B<INCORRECT>:
4484:
4485: The problem is open, and all tries have been used without getting the
4486: correct answer.
4487:
4488: =item * B<OPEN>:
4489:
4490: The item is open and not yet tried.
4491:
4492: =item * B<ATTEMPTED>:
4493:
4494: The problem has been attempted.
1.69 bowersj2 4495:
1.185 bowersj2 4496: =item * B<ANSWER_SUBMITTED>:
4497:
4498: An answer has been submitted, but the student should not see it.
4499:
1.51 bowersj2 4500: =back
4501:
4502: =cut
4503:
1.185 bowersj2 4504: sub TRIES_LEFT { return 20; }
4505: sub ANSWER_SUBMITTED { return 21; }
1.51 bowersj2 4506:
4507: sub status {
4508: my $self = shift;
4509: my $part = shift;
4510: if (!defined($part)) { $part = "0"; }
4511: my $completionStatus = $self->getCompletionStatus($part);
4512: my $dateStatus = $self->getDateStatus($part);
4513:
4514: # What we have is a two-dimensional matrix with 4 entries on one
4515: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 4516: # plus network failure and "no date data at all".
1.51 bowersj2 4517:
1.222 bowersj2 4518: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
1.53 bowersj2 4519: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 4520:
1.236 bowersj2 4521: my $suppressFeedback = $self->problemstatus($part) eq 'no';
4522: # If there's an answer date and we're past it, don't
4523: # suppress the feedback; student should know
4524: if ($self->answerdate($part) && $self->answerdate($part) < time()) {
4525: $suppressFeedback = 0;
4526: }
1.185 bowersj2 4527:
1.51 bowersj2 4528: # There are a few whole rows we can dispose of:
1.53 bowersj2 4529: if ($completionStatus == CORRECT ||
4530: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.185 bowersj2 4531: return $suppressFeedback? ANSWER_SUBMITTED : CORRECT;
1.69 bowersj2 4532: }
4533:
4534: if ($completionStatus == ATTEMPTED) {
4535: return ATTEMPTED;
1.53 bowersj2 4536: }
4537:
4538: # If it's EXCUSED, then return that no matter what
4539: if ($completionStatus == EXCUSED) {
4540: return EXCUSED;
1.51 bowersj2 4541: }
4542:
1.53 bowersj2 4543: if ($dateStatus == NOTHING_SET) {
4544: return NOTHING_SET;
1.51 bowersj2 4545: }
4546:
1.69 bowersj2 4547: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
4548: # by 4 matrix (date statuses).
1.51 bowersj2 4549:
1.54 bowersj2 4550: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 4551: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.272 albertel 4552: return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
1.51 bowersj2 4553: }
4554:
1.53 bowersj2 4555: if ($dateStatus == ANSWER_OPEN) {
4556: return ANSWER_OPEN;
1.51 bowersj2 4557: }
4558:
4559: # Now: (incorrect, incorrect_override, not_attempted) x
4560: # (open_later), (open)
4561:
1.53 bowersj2 4562: if ($dateStatus == OPEN_LATER) {
4563: return OPEN_LATER;
1.51 bowersj2 4564: }
4565:
4566: # If it's WRONG...
1.53 bowersj2 4567: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 4568: # and there are TRIES LEFT:
1.79 bowersj2 4569: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.222 bowersj2 4570: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
1.51 bowersj2 4571: }
1.185 bowersj2 4572: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 4573: }
4574:
4575: # Otherwise, it's untried and open
1.53 bowersj2 4576: return OPEN;
1.224 bowersj2 4577: }
4578:
4579: sub CLOSED { return 23; }
4580: sub ERROR { return 24; }
4581:
4582: =pod
4583:
4584: B<Simple Status>
4585:
4586: Convenience method B<simpleStatus> provides a "simple status" for the resource.
4587: "Simple status" corresponds to "which icon is shown on the
4588: Navmaps". There are six "simple" statuses:
4589:
4590: =over 4
4591:
4592: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
4593:
4594: =item * B<OPEN>: The problem is open and unattempted.
4595:
4596: =item * B<CORRECT>: The problem is correct for any reason.
4597:
4598: =item * B<INCORRECT>: The problem is incorrect and can still be
4599: completed successfully.
4600:
4601: =item * B<ATTEMPTED>: The problem has been attempted, but the student
4602: does not know if they are correct. (The ellipsis icon.)
4603:
4604: =item * B<ERROR>: There is an error retrieving information about this
4605: problem.
4606:
4607: =back
4608:
4609: =cut
4610:
4611: # This hash maps the composite status to this simple status, and
4612: # can be used directly, if you like
4613: my %compositeToSimple =
4614: (
4615: NETWORK_FAILURE() => ERROR,
4616: NOTHING_SET() => CLOSED,
4617: CORRECT() => CORRECT,
4618: EXCUSED() => CORRECT,
4619: PAST_DUE_NO_ANSWER() => INCORRECT,
4620: PAST_DUE_ANSWER_LATER() => INCORRECT,
4621: ANSWER_OPEN() => INCORRECT,
4622: OPEN_LATER() => CLOSED,
4623: TRIES_LEFT() => OPEN,
4624: INCORRECT() => INCORRECT,
4625: OPEN() => OPEN,
4626: ATTEMPTED() => ATTEMPTED,
4627: ANSWER_SUBMITTED() => ATTEMPTED
4628: );
4629:
4630: sub simpleStatus {
4631: my $self = shift;
4632: my $part = shift;
4633: my $status = $self->status($part);
4634: return $compositeToSimple{$status};
1.225 bowersj2 4635: }
4636:
4637: =pod
4638:
4639: B<simpleStatusCount> will return an array reference containing, in
4640: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
4641: and ERROR parts the given problem has.
4642:
4643: =cut
4644:
4645: # This maps the status to the slot we want to increment
4646: my %statusToSlotMap =
4647: (
4648: OPEN() => 0,
4649: CLOSED() => 1,
4650: CORRECT() => 2,
4651: INCORRECT() => 3,
4652: ATTEMPTED() => 4,
4653: ERROR() => 5
4654: );
4655:
4656: sub statusToSlot { return $statusToSlotMap{shift()}; }
4657:
4658: sub simpleStatusCount {
4659: my $self = shift;
4660:
4661: my @counts = (0, 0, 0, 0, 0, 0, 0);
4662: foreach my $part (@{$self->parts()}) {
4663: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
4664: }
4665:
4666: return \@counts;
1.191 bowersj2 4667: }
4668:
4669: =pod
4670:
4671: B<Completable>
4672:
4673: The completable method represents the concept of I<whether the student can
4674: currently do the problem>. If the student can do the problem, which means
4675: that it is open, there are tries left, and if the problem is manually graded
4676: or the grade is suppressed via problemstatus, the student has not tried it
4677: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
4678: either the student has tried it and there is no feedback, or that for
4679: some reason it is no longer completable (not open yet, successfully completed,
4680: out of tries, etc.). As an example, this is used as the filter for the
4681: "Uncompleted Homework" option for the nav maps.
4682:
4683: If this does not quite meet your needs, do not fiddle with it (unless you are
4684: fixing it to better match the student's conception of "completable" because
4685: it's broken somehow)... make a new method.
4686:
4687: =cut
4688:
4689: sub completable {
4690: my $self = shift;
4691: if (!$self->is_problem()) { return 0; }
4692: my $partCount = $self->countParts();
4693:
4694: foreach my $part (@{$self->parts()}) {
4695: if ($part eq '0' && $partCount != 1) { next; }
4696: my $status = $self->status($part);
4697: # "If any of the parts are open, or have tries left (implies open),
4698: # and it is not "attempted" (manually graded problem), it is
4699: # not "complete"
1.216 bowersj2 4700: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
4701: $status == ANSWER_SUBMITTED() ) {
4702: # did this part already, as well as we can
4703: next;
4704: }
4705: if ($status == OPEN() || $status == TRIES_LEFT()) {
4706: return 1;
4707: }
1.191 bowersj2 4708: }
4709:
4710: # If all the parts were complete, so was this problem.
1.216 bowersj2 4711: return 0;
1.51 bowersj2 4712: }
4713:
4714: =pod
4715:
4716: =head2 Resource/Nav Map Navigation
4717:
4718: =over 4
4719:
1.174 albertel 4720: =item * B<getNext>():
4721:
4722: Retreive an array of the possible next resources after this
4723: one. Always returns an array, even in the one- or zero-element case.
4724:
4725: =item * B<getPrevious>():
1.85 bowersj2 4726:
1.174 albertel 4727: Retreive an array of the possible previous resources from this
4728: one. Always returns an array, even in the one- or zero-element case.
1.51 bowersj2 4729:
4730: =cut
4731:
4732: sub getNext {
4733: my $self = shift;
4734: my @branches;
4735: my $to = $self->to();
1.85 bowersj2 4736: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 4737: my $choice = $self->{NAV_MAP}->getById($branch);
1.301 albertel 4738: if (!$choice->condition()) { next; }
1.51 bowersj2 4739: my $next = $choice->goesto();
4740: $next = $self->{NAV_MAP}->getById($next);
4741:
1.131 bowersj2 4742: push @branches, $next;
1.85 bowersj2 4743: }
4744: return \@branches;
4745: }
4746:
4747: sub getPrevious {
4748: my $self = shift;
4749: my @branches;
4750: my $from = $self->from();
4751: foreach my $branch ( split /,/, $from) {
4752: my $choice = $self->{NAV_MAP}->getById($branch);
4753: my $prev = $choice->comesfrom();
4754: $prev = $self->{NAV_MAP}->getById($prev);
4755:
1.131 bowersj2 4756: push @branches, $prev;
1.51 bowersj2 4757: }
4758: return \@branches;
1.131 bowersj2 4759: }
4760:
4761: sub browsePriv {
4762: my $self = shift;
4763: if (defined($self->{BROWSE_PRIV})) {
4764: return $self->{BROWSE_PRIV};
4765: }
4766:
1.311 albertel 4767: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
4768: $self->symb());
1.51 bowersj2 4769: }
4770:
4771: =pod
1.2 www 4772:
1.51 bowersj2 4773: =back
1.2 www 4774:
1.51 bowersj2 4775: =cut
1.2 www 4776:
1.51 bowersj2 4777: 1;
1.2 www 4778:
1.51 bowersj2 4779: __END__
1.2 www 4780:
4781:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonnavmaps.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface