Annotation of loncom/interface/lonnavmaps.pm, revision 1.331
1.2 www 1: # The LearningOnline Network with CAPA
2: # Navigate Maps Handler
1.1 www 3: #
1.331 ! albertel 4: # $Id: lonnavmaps.pm,v 1.330 2005/06/20 19:47:47 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.329 albertel 1042: $newBranchText = "<img src='$location/branch.gif' border='0' alt='Branch' />";
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.329 albertel 1054: my $icon = "<img src='$location/unknown.gif' alt='' border='0' alt=' ' ' />";
1.133 bowersj2 1055:
1056: if ($resource->is_problem()) {
1.192 bowersj2 1057: if ($part eq '0' || $params->{'condensed'}) {
1.329 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.329 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.329 albertel 1078: $icon = "<img src='$location/$icon' alt='".
1079: ($nowOpen ? 'Open Folder' : 'Close Folder')."' border='0' />";
1.144 bowersj2 1080:
1081: $linkopen = "<a href='" . $params->{'url'} . '?' .
1082: $params->{'queryString'} . '&filter=';
1083: $linkopen .= ($nowOpen xor $it->{CONDITION}) ?
1084: addToFilter($filter, $mapId) :
1085: removeFromFilter($filter, $mapId);
1086: $linkopen .= "&condition=" . $it->{CONDITION} . '&hereType='
1087: . $params->{'hereType'} . '&here=' .
1088: &Apache::lonnet::escape($params->{'here'}) .
1.159 bowersj2 1089: '&jump=' .
1.144 bowersj2 1090: &Apache::lonnet::escape($resource->symb()) .
1091: "&folderManip=1'>";
1.306 foxr 1092:
1.144 bowersj2 1093: } else {
1094: # Don't allow users to manipulate folder
1.205 bowersj2 1095: $icon = "navmap.$folderType." . ($nowOpen ? 'closed' : 'open') .
1.144 bowersj2 1096: '.nomanip.gif';
1.329 albertel 1097: $icon = "<img src='$location/$icon' alt='".
1098: ($nowOpen ? 'Open Folder' : 'Close Folder')."' border='0' />";
1.144 bowersj2 1099:
1100: $linkopen = "";
1101: $linkclose = "";
1102: }
1.133 bowersj2 1103: }
1.51 bowersj2 1104:
1.133 bowersj2 1105: if ($resource->randomout()) {
1106: $nonLinkedText .= ' <i>(hidden)</i> ';
1107: }
1108:
1109: # We're done preparing and finally ready to start the rendering
1110: my $result = "<td align='left' valign='center'>";
1.140 bowersj2 1111:
1112: my $indentLevel = $params->{'indentLevel'};
1113: if ($newBranchText) { $indentLevel--; }
1114:
1.133 bowersj2 1115: # print indentation
1.140 bowersj2 1116: for (my $i = 0; $i < $indentLevel; $i++) {
1.133 bowersj2 1117: $result .= $params->{'indentString'};
1.84 bowersj2 1118: }
1119:
1.133 bowersj2 1120: # Decide what to display
1.306 foxr 1121:
1.133 bowersj2 1122: $result .= "$newBranchText$linkopen$icon$linkclose";
1123:
1124: my $curMarkerBegin = '';
1125: my $curMarkerEnd = '';
1.51 bowersj2 1126:
1.133 bowersj2 1127: # Is this the current resource?
1.158 bowersj2 1128: if (!$params->{'displayedHereMarker'} &&
1129: $resource->symb() eq $params->{'here'} ) {
1.133 bowersj2 1130: $curMarkerBegin = '<font color="red" size="+2">> </font>';
1131: $curMarkerEnd = '<font color="red" size="+2"><</font>';
1.158 bowersj2 1132: $params->{'displayedHereMarker'} = 1;
1.51 bowersj2 1133: }
1134:
1.192 bowersj2 1135: if ($resource->is_problem() && $part ne '0' &&
1.133 bowersj2 1136: !$params->{'condensed'}) {
1.274 matthew 1137: my $displaypart=$resource->part_display($part);
1.245 www 1138: $partLabel = " (Part: $displaypart)";
1.309 albertel 1139: if ($link!~/\#/) { $link.='#'.&Apache::lonnet::escape($part); }
1.133 bowersj2 1140: $title = "";
1.51 bowersj2 1141: }
1142:
1.163 bowersj2 1143: if ($params->{'condensed'} && $resource->countParts() > 1) {
1.133 bowersj2 1144: $nonLinkedText .= ' (' . $resource->countParts() . ' parts)';
1.51 bowersj2 1145: }
1146:
1.268 albertel 1147: my $target;
1.320 albertel 1148: if ($env{'environment.remotenavmap'} eq 'on') {
1.268 albertel 1149: $target=' target="loncapaclient" ';
1150: }
1.266 raeburn 1151: if (!$params->{'resource_nolink'} && !$resource->is_sequence() && !$resource->is_empty_sequence) {
1.268 albertel 1152: $result .= " $curMarkerBegin<a $target href='$link'>$title$partLabel</a>$curMarkerEnd $nonLinkedText</td>";
1.144 bowersj2 1153: } else {
1154: $result .= " $curMarkerBegin$title$partLabel$curMarkerEnd $nonLinkedText</td>";
1155: }
1.51 bowersj2 1156:
1.133 bowersj2 1157: return $result;
1158: }
1.51 bowersj2 1159:
1.133 bowersj2 1160: sub render_communication_status {
1161: my ($resource, $part, $params) = @_;
1.134 bowersj2 1162: my $discussionHTML = ""; my $feedbackHTML = ""; my $errorHTML = "";
1163:
1164: my $link = $params->{"resourceLink"};
1165: my $linkopen = "<a href='$link'>";
1166: my $linkclose = "</a>";
1.298 albertel 1167: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1.134 bowersj2 1168: if ($resource->hasDiscussion()) {
1169: $discussionHTML = $linkopen .
1.298 albertel 1170: '<img border="0" src="'.$location.'/chat.gif" />' .
1.134 bowersj2 1171: $linkclose;
1172: }
1173:
1174: if ($resource->getFeedback()) {
1175: my $feedback = $resource->getFeedback();
1176: foreach (split(/\,/, $feedback)) {
1177: if ($_) {
1178: $feedbackHTML .= ' <a href="/adm/email?display='
1179: . &Apache::lonnet::escape($_) . '">'
1.298 albertel 1180: . '<img src="'.$location.'/feedback.gif" '
1.134 bowersj2 1181: . 'border="0" /></a>';
1182: }
1183: }
1184: }
1185:
1186: if ($resource->getErrors()) {
1187: my $errors = $resource->getErrors();
1.254 matthew 1188: my $errorcount = 0;
1.134 bowersj2 1189: foreach (split(/,/, $errors)) {
1.254 matthew 1190: last if ($errorcount>=10); # Only output 10 bombs maximum
1.134 bowersj2 1191: if ($_) {
1.254 matthew 1192: $errorcount++;
1.134 bowersj2 1193: $errorHTML .= ' <a href="/adm/email?display='
1194: . &Apache::lonnet::escape($_) . '">'
1.298 albertel 1195: . '<img src="'.$location.'/bomb.gif" '
1.134 bowersj2 1196: . 'border="0" /></a>';
1197: }
1198: }
1.197 bowersj2 1199: }
1200:
1201: if ($params->{'multipart'} && $part != '0') {
1202: $discussionHTML = $feedbackHTML = $errorHTML = '';
1.134 bowersj2 1203: }
1204:
1205: return "<td width=\"75\" align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML$errorHTML </td>";
1206:
1.133 bowersj2 1207: }
1208: sub render_quick_status {
1209: my ($resource, $part, $params) = @_;
1.135 bowersj2 1210: my $result = "";
1211: my $firstDisplayed = !$params->{'condensed'} &&
1212: $params->{'multipart'} && $part eq "0";
1213:
1214: my $link = $params->{"resourceLink"};
1215: my $linkopen = "<a href='$link'>";
1216: my $linkclose = "</a>";
1217:
1218: if ($resource->is_problem() &&
1219: !$firstDisplayed) {
1.224 bowersj2 1220:
1221: my $icon = $statusIconMap{$resource->simpleStatus($part)};
1.135 bowersj2 1222: my $alt = $iconAltTags{$icon};
1223: if ($icon) {
1.298 albertel 1224: my $location=
1225: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/$icon");
1226: $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 1227: } else {
1228: $result .= "<td width='30'> </td>\n";
1229: }
1230: } else { # not problem, no icon
1231: $result .= "<td width='30'> </td>\n";
1232: }
1233:
1234: return $result;
1.133 bowersj2 1235: }
1236: sub render_long_status {
1237: my ($resource, $part, $params) = @_;
1.136 bowersj2 1238: my $result = "<td align='right' valign='center'>\n";
1239: my $firstDisplayed = !$params->{'condensed'} &&
1240: $params->{'multipart'} && $part eq "0";
1241:
1242: my $color;
1.212 bowersj2 1243: if ($resource->is_problem()) {
1.136 bowersj2 1244: $color = $colormap{$resource->status};
1245:
1.252 matthew 1246: if (dueInLessThan24Hours($resource, $part) ||
1.136 bowersj2 1247: lastTry($resource, $part)) {
1248: $color = $hurryUpColor;
1249: }
1250: }
1251:
1252: if ($resource->kind() eq "res" &&
1253: $resource->is_problem() &&
1254: !$firstDisplayed) {
1255: if ($color) {$result .= "<font color=\"$color\"><b>"; }
1256: $result .= getDescription($resource, $part);
1257: if ($color) {$result .= "</b></font>"; }
1258: }
1259: if ($resource->is_map() && advancedUser() && $resource->randompick()) {
1260: $result .= '(randomly select ' . $resource->randompick() .')';
1261: }
1.210 bowersj2 1262:
1.213 bowersj2 1263: # Debugging code
1264: #$result .= " " . $resource->awarded($part) . '/' . $resource->weight($part) .
1265: # ' - Part: ' . $part;
1266:
1.210 bowersj2 1267: $result .= "</td>\n";
1.136 bowersj2 1268:
1269: return $result;
1.51 bowersj2 1270: }
1271:
1.227 bowersj2 1272: # Colors obtained by taking the icons, matching the colors, and
1273: # possibly reducing the Value (HSV) of the color, if it's too bright
1274: # for text, generally by one third or so.
1.225 bowersj2 1275: my %statusColors =
1276: (
1277: $resObj->CLOSED => '#000000',
1.227 bowersj2 1278: $resObj->OPEN => '#998b13',
1279: $resObj->CORRECT => '#26933f',
1280: $resObj->INCORRECT => '#c48207',
1281: $resObj->ATTEMPTED => '#a87510',
1.225 bowersj2 1282: $resObj->ERROR => '#000000'
1283: );
1284: my %statusStrings =
1285: (
1286: $resObj->CLOSED => 'Not yet open',
1287: $resObj->OPEN => 'Open',
1288: $resObj->CORRECT => 'Correct',
1289: $resObj->INCORRECT => 'Incorrect',
1290: $resObj->ATTEMPTED => 'Attempted',
1291: $resObj->ERROR => 'Network Error'
1292: );
1293: my @statuses = ($resObj->CORRECT, $resObj->ATTEMPTED, $resObj->INCORRECT, $resObj->OPEN, $resObj->CLOSED, $resObj->ERROR);
1294:
1295: use Data::Dumper;
1296: sub render_parts_summary_status {
1297: my ($resource, $part, $params) = @_;
1.256 albertel 1298: if (!$resource->is_problem() && !$resource->contains_problem) { return '<td></td>'; }
1.225 bowersj2 1299: if ($params->{showParts}) {
1300: return '<td></td>';
1301: }
1302:
1303: my $td = "<td align='right'>\n";
1304: my $endtd = "</td>\n";
1.256 albertel 1305: my @probs;
1.225 bowersj2 1306:
1.256 albertel 1307: if ($resource->contains_problem) {
1308: @probs=$resource->retrieveResources($resource,sub { $_[0]->is_problem() },1,0);
1309: } else {
1310: @probs=($resource);
1311: }
1312: my $return;
1313: my %overallstatus;
1314: my $totalParts;
1315: foreach my $resource (@probs) {
1316: # If there is a single part, just show the simple status
1317: if ($resource->singlepart()) {
1318: my $status = $resource->simpleStatus(${$resource->parts}[0]);
1319: $overallstatus{$status}++;
1320: $totalParts++;
1321: next;
1322: }
1323: # Now we can be sure the $part doesn't really matter.
1324: my $statusCount = $resource->simpleStatusCount();
1325: my @counts;
1326: foreach my $status (@statuses) {
1327: # decouple display order from the simpleStatusCount order
1328: my $slot = Apache::lonnavmaps::resource::statusToSlot($status);
1329: if ($statusCount->[$slot]) {
1330: $overallstatus{$status}+=$statusCount->[$slot];
1331: $totalParts+=$statusCount->[$slot];
1332: }
1333: }
1334: }
1335: $return.= $td . $totalParts . ' parts: ';
1336: foreach my $status (@statuses) {
1337: if ($overallstatus{$status}) {
1338: $return.="<font color='" . $statusColors{$status} .
1339: "'>" . $overallstatus{$status} . ' '
1.225 bowersj2 1340: . $statusStrings{$status} . "</font>";
1341: }
1342: }
1.256 albertel 1343: $return.= $endtd;
1344: return $return;
1.225 bowersj2 1345: }
1346:
1.133 bowersj2 1347: my @preparedColumns = (\&render_resource, \&render_communication_status,
1.225 bowersj2 1348: \&render_quick_status, \&render_long_status,
1349: \&render_parts_summary_status);
1.132 bowersj2 1350:
1351: sub setDefault {
1352: my ($val, $default) = @_;
1353: if (!defined($val)) { return $default; }
1354: return $val;
1355: }
1356:
1.296 albertel 1357: sub cmp_title {
1358: my ($atitle,$btitle) = (lc($_[0]->compTitle),lc($_[1]->compTitle));
1359: $atitle=~s/^\s*//;
1360: $btitle=~s/^\s*//;
1361: return $atitle cmp $btitle;
1362: }
1363:
1.132 bowersj2 1364: sub render {
1365: my $args = shift;
1.140 bowersj2 1366: &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
1367: my $result = '';
1.132 bowersj2 1368: # Configure the renderer.
1369: my $cols = $args->{'cols'};
1370: if (!defined($cols)) {
1371: # no columns, no nav maps.
1372: return '';
1373: }
1.140 bowersj2 1374: my $mustCloseNavMap = 0;
1375: my $navmap;
1376: if (defined($args->{'navmap'})) {
1377: $navmap = $args->{'navmap'};
1378: }
1379:
1.158 bowersj2 1380: my $r = $args->{'r'};
1.140 bowersj2 1381: my $queryString = $args->{'queryString'};
1.159 bowersj2 1382: my $jump = $args->{'jump'};
1.158 bowersj2 1383: my $here = $args->{'here'};
1.153 bowersj2 1384: my $suppressNavmap = setDefault($args->{'suppressNavmap'}, 0);
1.256 albertel 1385: my $closeAllPages = setDefault($args->{'closeAllPages'}, 0);
1.140 bowersj2 1386: my $currentJumpDelta = 2; # change this to change how many resources are displayed
1387: # before the current resource when using #current
1388:
1389: # If we were passed 'here' information, we are not rendering
1390: # after a folder manipulation, and we were not passed an
1391: # iterator, make sure we open the folders to show the "here"
1392: # marker
1393: my $filterHash = {};
1394: # Figure out what we're not displaying
1.320 albertel 1395: foreach (split(/\,/, $env{"form.filter"})) {
1.140 bowersj2 1396: if ($_) {
1397: $filterHash->{$_} = "1";
1398: }
1399: }
1400:
1.191 bowersj2 1401: # Filter: Remember filter function and add our own filter: Refuse
1402: # to show hidden resources unless the user can see them.
1403: my $userCanSeeHidden = advancedUser();
1404: my $filterFunc = setDefault($args->{'filterFunc'},
1405: sub {return 1;});
1406: if (!$userCanSeeHidden) {
1407: # Without renaming the filterfunc, the server seems to go into
1408: # an infinite loop
1409: my $oldFilterFunc = $filterFunc;
1410: $filterFunc = sub { my $res = shift; return !$res->randomout() &&
1411: &$oldFilterFunc($res);};
1412: }
1413:
1.140 bowersj2 1414: my $condition = 0;
1.320 albertel 1415: if ($env{'form.condition'}) {
1.140 bowersj2 1416: $condition = 1;
1417: }
1418:
1.320 albertel 1419: if (!$env{'form.folderManip'} && !defined($args->{'iterator'})) {
1.140 bowersj2 1420: # Step 1: Check to see if we have a navmap
1421: if (!defined($navmap)) {
1.221 bowersj2 1422: $navmap = Apache::lonnavmaps::navmap->new();
1.140 bowersj2 1423: $mustCloseNavMap = 1;
1424: }
1425:
1426: # Step two: Locate what kind of here marker is necessary
1427: # Determine where the "here" marker is and where the screen jumps to.
1428:
1.320 albertel 1429: if ($env{'form.postsymb'}) {
1430: $here = $jump = &Apache::lonnet::symbclean($env{'form.postsymb'});
1431: } elsif ($env{'form.postdata'}) {
1.140 bowersj2 1432: # couldn't find a symb, is there a URL?
1.320 albertel 1433: my $currenturl = $env{'form.postdata'};
1.158 bowersj2 1434: #$currenturl=~s/^http\:\/\///;
1435: #$currenturl=~s/^[^\/]+//;
1.140 bowersj2 1436:
1.158 bowersj2 1437: $here = $jump = &Apache::lonnet::symbread($currenturl);
1.331 ! albertel 1438: }
! 1439: if ($here eq '') {
1.317 albertel 1440: my $last;
1.320 albertel 1441: if (tie(my %hash,'GDBM_File',$env{'request.course.fn'}.'_symb.db',
1.317 albertel 1442: &GDBM_READER(),0640)) {
1443: $last=$hash{'last_known'};
1444: untie(%hash);
1445: }
1446: if ($last) { $here = $jump = $last; }
1447: }
1.158 bowersj2 1448:
1.140 bowersj2 1449: # Step three: Ensure the folders are open
1450: my $mapIterator = $navmap->getIterator(undef, undef, undef, 1);
1.222 bowersj2 1451: my $curRes;
1.140 bowersj2 1452: my $found = 0;
1453:
1454: # We only need to do this if we need to open the maps to show the
1455: # current position. This will change the counter so we can't count
1456: # for the jump marker with this loop.
1.294 albertel 1457: while ($here && ($curRes = $mapIterator->next()) && !$found) {
1.158 bowersj2 1458: if (ref($curRes) && $curRes->symb() eq $here) {
1.140 bowersj2 1459: my $mapStack = $mapIterator->getStack();
1460:
1461: # Ensure the parent maps are open
1462: for my $map (@{$mapStack}) {
1463: if ($condition) {
1464: undef $filterHash->{$map->map_pc()};
1465: } else {
1466: $filterHash->{$map->map_pc()} = 1;
1467: }
1468: }
1469: $found = 1;
1470: }
1471: }
1.159 bowersj2 1472: }
1.140 bowersj2 1473:
1.320 albertel 1474: if ( !defined($args->{'iterator'}) && $env{'form.folderManip'} ) { # we came from a user's manipulation of the nav page
1.140 bowersj2 1475: # If this is a click on a folder or something, we want to preserve the "here"
1476: # from the querystring, and get the new "jump" marker
1.320 albertel 1477: $here = $env{'form.here'};
1478: $jump = $env{'form.jump'};
1.140 bowersj2 1479: }
1480:
1.132 bowersj2 1481: my $it = $args->{'iterator'};
1482: if (!defined($it)) {
1.320 albertel 1483: # Construct a default iterator based on $env{'form.'} information
1.140 bowersj2 1484:
1485: # Step 1: Check to see if we have a navmap
1486: if (!defined($navmap)) {
1.221 bowersj2 1487: $navmap = Apache::lonnavmaps::navmap->new();
1.140 bowersj2 1488: $mustCloseNavMap = 1;
1489: }
1490:
1.144 bowersj2 1491: # See if we're being passed a specific map
1492: if ($args->{'iterator_map'}) {
1493: my $map = $args->{'iterator_map'};
1.145 bowersj2 1494: $map = $navmap->getResourceByUrl($map);
1.144 bowersj2 1495: my $firstResource = $map->map_start();
1496: my $finishResource = $map->map_finish();
1497:
1498: $args->{'iterator'} = $it = $navmap->getIterator($firstResource, $finishResource, $filterHash, $condition);
1499: } else {
1500: $args->{'iterator'} = $it = $navmap->getIterator(undef, undef, $filterHash, $condition);
1501: }
1.132 bowersj2 1502: }
1.256 albertel 1503:
1.159 bowersj2 1504: # (re-)Locate the jump point, if any
1.191 bowersj2 1505: # Note this does not take filtering or hidden into account... need
1506: # to be fixed?
1.159 bowersj2 1507: my $mapIterator = $navmap->getIterator(undef, undef, $filterHash, 0);
1.222 bowersj2 1508: my $curRes;
1.159 bowersj2 1509: my $foundJump = 0;
1510: my $counter = 0;
1511:
1.222 bowersj2 1512: while (($curRes = $mapIterator->next()) && !$foundJump) {
1.159 bowersj2 1513: if (ref($curRes)) { $counter++; }
1514:
1515: if (ref($curRes) && $jump eq $curRes->symb()) {
1516:
1517: # This is why we have to use the main iterator instead of the
1518: # potentially faster DFS: The count has to be the same, so
1519: # the order has to be the same, which DFS won't give us.
1520: $args->{'currentJumpIndex'} = $counter;
1521: $foundJump = 1;
1522: }
1523: }
1524:
1.132 bowersj2 1525: my $showParts = setDefault($args->{'showParts'}, 1);
1526: my $condenseParts = setDefault($args->{'condenseParts'}, 1);
1.139 bowersj2 1527: # keeps track of when the current resource is found,
1528: # so we can back up a few and put the anchor above the
1529: # current resource
1.140 bowersj2 1530: my $printKey = $args->{'printKey'};
1531: my $printCloseAll = $args->{'printCloseAll'};
1532: if (!defined($printCloseAll)) { $printCloseAll = 1; }
1.298 albertel 1533:
1.140 bowersj2 1534: # Print key?
1535: if ($printKey) {
1536: $result .= '<table border="0" cellpadding="2" cellspacing="0">';
1537: my $date=localtime;
1538: $result.='<tr><td align="right" valign="bottom">Key: </td>';
1.298 albertel 1539: my $location=&Apache::loncommon::lonhttpdurl("/adm/lonMisc");
1.140 bowersj2 1540: if ($navmap->{LAST_CHECK}) {
1541: $result .=
1.298 albertel 1542: '<img src="'.$location.'/chat.gif"> '.&mt('New discussion since').' '.
1.140 bowersj2 1543: strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1544: '</td><td align="center" valign="bottom"> '.
1.298 albertel 1545: '<img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').'<p>'.
1.140 bowersj2 1546: '</td>';
1547: } else {
1548: $result .= '<td align="center" valign="bottom"> '.
1.298 albertel 1549: '<img src="'.$location.'/chat.gif"> '.&mt('Discussions').'</td><td align="center" valign="bottom">'.
1550: ' <img src="'.$location.'/feedback.gif"> '.&mt('New message (click to open)').
1.140 bowersj2 1551: '</td>';
1552: }
1553:
1554: $result .= '</tr></table>';
1555: }
1556:
1.172 bowersj2 1557: if ($printCloseAll && !$args->{'resource_no_folder_link'}) {
1.281 albertel 1558: my ($link,$text);
1.140 bowersj2 1559: if ($condition) {
1.281 albertel 1560: $link='"navmaps?condition=0&filter=&'.$queryString.
1561: '&here='.&Apache::lonnet::escape($here).'"';
1562: $text='Close All Folders';
1.140 bowersj2 1563: } else {
1.281 albertel 1564: $link='"navmaps?condition=1&filter=&'.$queryString.
1565: '&here='.&Apache::lonnet::escape($here).'"';
1566: $text='Open All Folders';
1567: }
1568: if ($args->{'caller'} eq 'navmapsdisplay') {
1569: &add_linkitem($args->{'linkitems'},'changefolder',
1570: 'location.href='.$link,$text);
1571: } else {
1572: $result.='<a href='.$link.'>'.&mt($text).'</a>';
1573: }
1.266 raeburn 1574: $result .= "\n";
1575: }
1.140 bowersj2 1576:
1.266 raeburn 1577: # Check for any unread discussions in all resources.
1.281 albertel 1578: if ($args->{'caller'} eq 'navmapsdisplay') {
1.296 albertel 1579: &add_linkitem($args->{'linkitems'},'clearbubbles',
1580: 'document.clearbubbles.submit()',
1581: 'Mark all posts read');
1.297 albertel 1582: my $time=time;
1.296 albertel 1583: $result .= (<<END);
1584: <form name="clearbubbles" method="post" action="/adm/feedback">
1585: <input type="hidden" name="navurl" value="$ENV{'QUERY_STRING'}" />
1.297 albertel 1586: <input type="hidden" name="navtime" value="$time" />
1.296 albertel 1587: END
1588: if ($args->{'sort'} eq 'discussion') {
1589: my $totdisc = 0;
1590: my $haveDisc = '';
1591: my @allres=$navmap->retrieveResources();
1592: foreach my $resource (@allres) {
1593: if ($resource->hasDiscussion()) {
1.323 albertel 1594: $haveDisc .= $resource->wrap_symb().':';
1.296 albertel 1595: $totdisc ++;
1.267 albertel 1596: }
1597: }
1.296 albertel 1598: if ($totdisc > 0) {
1599: $haveDisc =~ s/:$//;
1600: $result .= (<<END);
1601: <input type="hidden" name="navmaps" value="$haveDisc" />
1602: </form>
1603: END
1604: }
1.297 albertel 1605: }
1606: $result.='</form>';
1.266 raeburn 1607: }
1.276 albertel 1608:
1.281 albertel 1609: if ($args->{'caller'} eq 'navmapsdisplay') {
1.283 raeburn 1610: $result .= '<table><tr><td>'.
1611: &Apache::loncommon::help_open_menu('','Navigation Screen','Navigation_Screen','',undef,'RAT').'</td>';
1.320 albertel 1612: if ($env{'environment.remotenavmap'} ne 'on') {
1.283 raeburn 1613: $result .= '<td> </td>';
1614: } else {
1615: $result .= '</tr><tr>';
1616: }
1.281 albertel 1617: $result.=&show_linkitems($args->{'linkitems'});
1618: if ($args->{'sort_html'}) {
1.320 albertel 1619: if ($env{'environment.remotenavmap'} ne 'on') {
1.281 albertel 1620: $result.='<td> </td><td> </td><td> </td>'.
1621: '<td align="right">'.$args->{'sort_html'}.'</td></tr>';
1622: } else {
1623: $result.='</tr><tr><td align="left"><br />'.
1624: $args->{'sort_html'}.'</td></tr>';
1625: }
1626: }
1627: $result .= '</table>';
1628: } elsif ($args->{'sort_html'}) {
1629: $result.=$args->{'sort_html'};
1630: }
1.276 albertel 1631:
1.266 raeburn 1632: $result .= "<br />\n";
1.140 bowersj2 1633: if ($r) {
1634: $r->print($result);
1635: $r->rflush();
1636: $result = "";
1637: }
1.132 bowersj2 1638: # End parameter setting
1.133 bowersj2 1639:
1.132 bowersj2 1640: # Data
1.140 bowersj2 1641: $result .= '<table cellspacing="0" cellpadding="3" border="0" bgcolor="#FFFFFF">' ."\n";
1.132 bowersj2 1642: my $res = "Apache::lonnavmaps::resource";
1643: my %condenseStatuses =
1644: ( $res->NETWORK_FAILURE => 1,
1645: $res->NOTHING_SET => 1,
1646: $res->CORRECT => 1 );
1647: my @backgroundColors = ("#FFFFFF", "#F6F6F6");
1.133 bowersj2 1648:
1649: # Shared variables
1650: $args->{'counter'} = 0; # counts the rows
1651: $args->{'indentLevel'} = 0;
1652: $args->{'isNewBranch'} = 0;
1653: $args->{'condensed'} = 0;
1.298 albertel 1654: my $location=
1655: &Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace1.gif");
1.329 albertel 1656: $args->{'indentString'} = setDefault($args->{'indentString'}, "<img src='$location' width='25' height='1' alt=' ' border='0' />");
1.133 bowersj2 1657: $args->{'displayedHereMarker'} = 0;
1.132 bowersj2 1658:
1.190 bowersj2 1659: # If we're suppressing empty sequences, look for them here. Use DFS for speed,
1660: # since structure actually doesn't matter, except what map has what resources.
1661: if ($args->{'suppressEmptySequences'}) {
1662: my $dfsit = Apache::lonnavmaps::DFSiterator->new($navmap,
1663: $it->{FIRST_RESOURCE},
1664: $it->{FINISH_RESOURCE},
1665: {}, undef, 1);
1.222 bowersj2 1666: my $depth = 0;
1.190 bowersj2 1667: $dfsit->next();
1668: my $curRes = $dfsit->next();
1669: while ($depth > -1) {
1670: if ($curRes == $dfsit->BEGIN_MAP()) { $depth++; }
1671: if ($curRes == $dfsit->END_MAP()) { $depth--; }
1672:
1673: if (ref($curRes)) {
1674: # Parallel pre-processing: Do sequences have non-filtered-out children?
1.201 bowersj2 1675: if ($curRes->is_map()) {
1.190 bowersj2 1676: $curRes->{DATA}->{HAS_VISIBLE_CHILDREN} = 0;
1677: # Sequences themselves do not count as visible children,
1678: # unless those sequences also have visible children.
1679: # This means if a sequence appears, there's a "promise"
1680: # that there's something under it if you open it, somewhere.
1681: } else {
1682: # Not a sequence: if it's filtered, ignore it, otherwise
1683: # rise up the stack and mark the sequences as having children
1684: if (&$filterFunc($curRes)) {
1685: for my $sequence (@{$dfsit->getStack()}) {
1686: $sequence->{DATA}->{HAS_VISIBLE_CHILDREN} = 1;
1687: }
1688: }
1689: }
1690: }
1691: } continue {
1692: $curRes = $dfsit->next();
1693: }
1694: }
1695:
1.133 bowersj2 1696: my $displayedJumpMarker = 0;
1.132 bowersj2 1697: # Set up iteration.
1698: my $now = time();
1699: my $in24Hours = $now + 24 * 60 * 60;
1700: my $rownum = 0;
1701:
1.141 bowersj2 1702: # export "here" marker information
1703: $args->{'here'} = $here;
1704:
1.222 bowersj2 1705: $args->{'indentLevel'} = -1; # first BEGIN_MAP takes this to 0
1.270 albertel 1706: my @resources;
1707: my $code='';# sub { !(shift->is_map();) };
1708: if ($args->{'sort'} eq 'title') {
1.276 albertel 1709: my $oldFilterFunc = $filterFunc;
1710: my $filterFunc=
1711: sub {
1712: my ($res)=@_;
1713: if ($res->is_map()) { return 0;}
1714: return &$oldFilterFunc($res);
1715: };
1716: @resources=$navmap->retrieveResources(undef,$filterFunc);
1.296 albertel 1717: @resources= sort { &cmp_title($a,$b) } @resources;
1718: } elsif ($args->{'sort'} eq 'duedate') {
1719: my $oldFilterFunc = $filterFunc;
1720: my $filterFunc=
1721: sub {
1722: my ($res)=@_;
1723: if (!$res->is_problem()) { return 0;}
1724: return &$oldFilterFunc($res);
1725: };
1726: @resources=$navmap->retrieveResources(undef,$filterFunc);
1.289 raeburn 1727: @resources= sort {
1.270 albertel 1728: if ($a->duedate ne $b->duedate) {
1729: return $a->duedate cmp $b->duedate;
1730: }
1.296 albertel 1731: my $value=&cmp_title($a,$b);
1732: return $value;
1.270 albertel 1733: } @resources;
1.296 albertel 1734: } elsif ($args->{'sort'} eq 'discussion') {
1735: my $oldFilterFunc = $filterFunc;
1736: my $filterFunc=
1737: sub {
1738: my ($res)=@_;
1739: if (!$res->hasDiscussion() &&
1740: !$res->getFeedback() &&
1741: !$res->getErrors()) { return 0;}
1742: return &$oldFilterFunc($res);
1743: };
1744: @resources=$navmap->retrieveResources(undef,$filterFunc);
1745: @resources= sort { &cmp_title($a,$b) } @resources;
1.276 albertel 1746: } else {
1747: #unknow sort mechanism or default
1748: undef($args->{'sort'});
1.270 albertel 1749: }
1750:
1.276 albertel 1751:
1.270 albertel 1752: while (1) {
1753: if ($args->{'sort'}) {
1754: $curRes = shift(@resources);
1755: } else {
1756: $curRes = $it->next($closeAllPages);
1757: }
1758: if (!$curRes) { last; }
1759:
1.132 bowersj2 1760: # Maintain indentation level.
1761: if ($curRes == $it->BEGIN_MAP() ||
1762: $curRes == $it->BEGIN_BRANCH() ) {
1.133 bowersj2 1763: $args->{'indentLevel'}++;
1.132 bowersj2 1764: }
1765: if ($curRes == $it->END_MAP() ||
1766: $curRes == $it->END_BRANCH() ) {
1.133 bowersj2 1767: $args->{'indentLevel'}--;
1.132 bowersj2 1768: }
1769: # Notice new branches
1770: if ($curRes == $it->BEGIN_BRANCH()) {
1.133 bowersj2 1771: $args->{'isNewBranch'} = 1;
1772: }
1773:
1774: # If this isn't an actual resource, continue on
1775: if (!ref($curRes)) {
1776: next;
1.132 bowersj2 1777: }
1.133 bowersj2 1778:
1.143 bowersj2 1779: # If this has been filtered out, continue on
1780: if (!(&$filterFunc($curRes))) {
1781: $args->{'isNewBranch'} = 0; # Don't falsely remember this
1782: next;
1783: }
1.132 bowersj2 1784:
1.190 bowersj2 1785: # If this is an empty sequence and we're filtering them, continue on
1.201 bowersj2 1786: if ($curRes->is_map() && $args->{'suppressEmptySequences'} &&
1.190 bowersj2 1787: !$curRes->{DATA}->{HAS_VISIBLE_CHILDREN}) {
1788: next;
1789: }
1790:
1.153 bowersj2 1791: # If we're suppressing navmaps and this is a navmap, continue on
1792: if ($suppressNavmap && $curRes->src() =~ /^\/adm\/navmaps/) {
1793: next;
1794: }
1795:
1.191 bowersj2 1796: $args->{'counter'}++;
1797:
1.132 bowersj2 1798: # Does it have multiple parts?
1.133 bowersj2 1799: $args->{'multipart'} = 0;
1800: $args->{'condensed'} = 0;
1.132 bowersj2 1801: my @parts;
1802:
1803: # Decide what parts to show.
1.133 bowersj2 1804: if ($curRes->is_problem() && $showParts) {
1.132 bowersj2 1805: @parts = @{$curRes->parts()};
1.192 bowersj2 1806: $args->{'multipart'} = $curRes->multipart();
1.132 bowersj2 1807:
1808: if ($condenseParts) { # do the condensation
1809: if (!$curRes->opendate("0")) {
1.162 bowersj2 1810: @parts = ();
1.133 bowersj2 1811: $args->{'condensed'} = 1;
1.132 bowersj2 1812: }
1.133 bowersj2 1813: if (!$args->{'condensed'}) {
1.132 bowersj2 1814: # Decide whether to condense based on similarity
1.192 bowersj2 1815: my $status = $curRes->status($parts[0]);
1816: my $due = $curRes->duedate($parts[0]);
1817: my $open = $curRes->opendate($parts[0]);
1.132 bowersj2 1818: my $statusAllSame = 1;
1819: my $dueAllSame = 1;
1820: my $openAllSame = 1;
1.192 bowersj2 1821: for (my $i = 1; $i < scalar(@parts); $i++) {
1.132 bowersj2 1822: if ($curRes->status($parts[$i]) != $status){
1823: $statusAllSame = 0;
1824: }
1825: if ($curRes->duedate($parts[$i]) != $due ) {
1826: $dueAllSame = 0;
1827: }
1828: if ($curRes->opendate($parts[$i]) != $open) {
1829: $openAllSame = 0;
1830: }
1831: }
1832: # $*allSame is true if all the statuses were
1833: # the same. Now, if they are all the same and
1834: # match one of the statuses to condense, or they
1835: # are all open with the same due date, or they are
1836: # all OPEN_LATER with the same open date, display the
1837: # status of the first non-zero part (to get the 'correct'
1838: # status right, since 0 is never 'correct' or 'open').
1839: if (($statusAllSame && defined($condenseStatuses{$status})) ||
1840: ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
1841: ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
1.192 bowersj2 1842: @parts = ($parts[0]);
1.133 bowersj2 1843: $args->{'condensed'} = 1;
1.132 bowersj2 1844: }
1845: }
1.198 bowersj2 1846: # Multipart problem with one part: always "condense" (happens
1847: # to match the desirable behavior)
1848: if ($curRes->countParts() == 1) {
1849: @parts = ($parts[0]);
1850: $args->{'condensed'} = 1;
1851: }
1.132 bowersj2 1852: }
1.157 bowersj2 1853: }
1.132 bowersj2 1854:
1855: # If the multipart problem was condensed, "forget" it was multipart
1856: if (scalar(@parts) == 1) {
1.133 bowersj2 1857: $args->{'multipart'} = 0;
1.192 bowersj2 1858: } else {
1859: # Add part 0 so we display it correctly.
1860: unshift @parts, '0';
1.132 bowersj2 1861: }
1.310 albertel 1862:
1863: {
1864: my ($src,$symb,$anchor,$stack);
1865: if ($args->{'sort'}) {
1866: my $it = $navmap->getIterator(undef, undef, undef, 1);
1867: while ( my $res=$it->next()) {
1868: if (ref($res) &&
1869: $res->symb() eq $curRes->symb()) { last; }
1870: }
1871: $stack=$it->getStack();
1872: } else {
1873: $stack=$it->getStack();
1874: }
1875: ($src,$symb,$anchor)=getLinkForResource($stack);
1876: if (defined($anchor)) { $anchor='#'.$anchor; }
1877: my $srcHasQuestion = $src =~ /\?/;
1878: $args->{"resourceLink"} = $src.
1879: ($srcHasQuestion?'&':'?') .
1880: 'symb=' . &Apache::lonnet::escape($symb).$anchor;
1881: }
1.132 bowersj2 1882: # Now, we've decided what parts to show. Loop through them and
1883: # show them.
1.192 bowersj2 1884: foreach my $part (@parts) {
1.132 bowersj2 1885: $rownum ++;
1886: my $backgroundColor = $backgroundColors[$rownum % scalar(@backgroundColors)];
1887:
1888: $result .= " <tr bgcolor='$backgroundColor'>\n";
1.134 bowersj2 1889:
1890: # Set up some data about the parts that the cols might want
1891: my $filter = $it->{FILTER};
1.270 albertel 1892:
1.132 bowersj2 1893: # Now, display each column.
1894: foreach my $col (@$cols) {
1.139 bowersj2 1895: my $colHTML = '';
1896: if (ref($col)) {
1897: $colHTML .= &$col($curRes, $part, $args);
1898: } else {
1899: $colHTML .= &{$preparedColumns[$col]}($curRes, $part, $args);
1900: }
1.132 bowersj2 1901:
1.133 bowersj2 1902: # If this is the first column and it's time to print
1903: # the anchor, do so
1904: if ($col == $cols->[0] &&
1905: $args->{'counter'} == $args->{'currentJumpIndex'} -
1.139 bowersj2 1906: $currentJumpDelta) {
1907: # Jam the anchor after the <td> tag;
1908: # necessary for valid HTML (which Mozilla requires)
1909: $colHTML =~ s/\>/\>\<a name="curloc" \/\>/;
1.133 bowersj2 1910: $displayedJumpMarker = 1;
1911: }
1.139 bowersj2 1912: $result .= $colHTML . "\n";
1.132 bowersj2 1913: }
1.139 bowersj2 1914: $result .= " </tr>\n";
1.140 bowersj2 1915: $args->{'isNewBranch'} = 0;
1.139 bowersj2 1916: }
1.153 bowersj2 1917:
1.139 bowersj2 1918: if ($r && $rownum % 20 == 0) {
1919: $r->print($result);
1920: $result = "";
1921: $r->rflush();
1.132 bowersj2 1922: }
1.156 bowersj2 1923: } continue {
1.208 bowersj2 1924: if ($r) {
1925: # If we have the connection, make sure the user is still connected
1926: my $c = $r->connection;
1927: if ($c->aborted()) {
1928: # Who cares what we do, nobody will see it anyhow.
1929: return '';
1930: }
1931: }
1.132 bowersj2 1932: }
1933:
1.134 bowersj2 1934: # Print out the part that jumps to #curloc if it exists
1.159 bowersj2 1935: # delay needed because the browser is processing the jump before
1936: # it finishes rendering, so it goes to the wrong place!
1937: # onload might be better, but this routine has no access to that.
1938: # On mozilla, the 0-millisecond timeout seems to prevent this;
1939: # it's quite likely this might fix other browsers, too, and
1940: # certainly won't hurt anything.
1.139 bowersj2 1941: if ($displayedJumpMarker) {
1.247 albertel 1942: $result .= "
1943: <script>
1944: if (location.href.indexOf('#curloc')==-1) {
1945: setTimeout(\"location += '#curloc';\", 0)
1946: }
1947: </script>";
1.134 bowersj2 1948: }
1949:
1.132 bowersj2 1950: $result .= "</table>";
1.140 bowersj2 1951:
1952: if ($r) {
1953: $r->print($result);
1954: $result = "";
1955: $r->rflush();
1956: }
1957:
1.132 bowersj2 1958: return $result;
1959: }
1960:
1.281 albertel 1961: sub add_linkitem {
1962: my ($linkitems,$name,$cmd,$text)=@_;
1963: $$linkitems{$name}{'cmd'}=$cmd;
1964: $$linkitems{$name}{'text'}=&mt($text);
1965: }
1966:
1967: sub show_linkitems {
1968: my ($linkitems)=@_;
1.312 albertel 1969: my @linkorder = ("blank","launchnav","closenav","firsthomework",
1970: "everything","uncompleted","changefolder","clearbubbles");
1.281 albertel 1971:
1972: my $result .= (<<ENDBLOCK);
1.283 raeburn 1973: <td align="left">
1.281 albertel 1974: <script type="text/javascript">
1975: function changeNavDisplay () {
1976: var navchoice = document.linkitems.toplink[document.linkitems.toplink.selectedIndex].value;
1977: ENDBLOCK
1978: foreach my $link (@linkorder) {
1979: $result.= "if (navchoice == '$link') {".
1980: $linkitems->{$link}{'cmd'}."}\n";
1981: }
1982: $result.='}
1983: </script>
1984: <form name="linkitems" method="post">
1985: <nobr><select name="toplink">'."\n";
1986: foreach my $link (@linkorder) {
1987: if (defined($linkitems->{$link})) {
1988: if ($linkitems->{$link}{'text'} ne '') {
1989: $result .= ' <option value="'.$link.'">'.
1990: $linkitems->{$link}{'text'}."</option>\n";
1991: }
1992: }
1993: }
1994: $result .= '</select> <input type="button" name="chgnav"
1995: value="Go" onClick="javascript:changeNavDisplay()" />
1996: </nobr></form></td>'."\n";
1.298 albertel 1997:
1.281 albertel 1998: return $result;
1999: }
2000:
1.133 bowersj2 2001: 1;
2002:
2003: package Apache::lonnavmaps::navmap;
2004:
2005: =pod
2006:
1.216 bowersj2 2007: =head1 Object: Apache::lonnavmaps::navmap
1.133 bowersj2 2008:
1.217 bowersj2 2009: =head2 Overview
1.133 bowersj2 2010:
1.217 bowersj2 2011: The navmap object's job is to provide access to the resources
2012: in the course as Apache::lonnavmaps::resource objects, and to
2013: query and manage the relationship between those resource objects.
2014:
2015: Generally, you'll use the navmap object in one of three basic ways.
2016: In order of increasing complexity and power:
2017:
2018: =over 4
2019:
2020: =item * C<$navmap-E<gt>getByX>, where X is B<Id>, B<Symb>, B<Url> or B<MapPc>. This provides
2021: various ways to obtain resource objects, based on various identifiers.
2022: Use this when you want to request information about one object or
2023: a handful of resources you already know the identities of, from some
2024: other source. For more about Ids, Symbs, and MapPcs, see the
2025: Resource documentation. Note that Url should be a B<last resort>,
2026: not your first choice; it only works when there is only one
2027: instance of the resource in the course, which only applies to
2028: maps, and even that may change in the future.
2029:
2030: =item * C<my @resources = $navmap-E<gt>retrieveResources(args)>. This
2031: retrieves resources matching some criterion and returns them
2032: in a flat array, with no structure information. Use this when
2033: you are manipulating a series of resources, based on what map
2034: the are in, but do not care about branching, or exactly how
2035: the maps and resources are related. This is the most common case.
2036:
2037: =item * C<$it = $navmap-E<gt>getIterator(args)>. This allows you traverse
2038: the course's navmap in various ways without writing the traversal
2039: code yourself. See iterator documentation below. Use this when
2040: you need to know absolutely everything about the course, including
2041: branches and the precise relationship between maps and resources.
2042:
2043: =back
2044:
2045: =head2 Creation And Destruction
2046:
2047: To create a navmap object, use the following function:
1.133 bowersj2 2048:
2049: =over 4
2050:
1.221 bowersj2 2051: =item * B<Apache::lonnavmaps::navmap-E<gt>new>():
1.133 bowersj2 2052:
1.221 bowersj2 2053: Creates a new navmap object. Returns the navmap object if this is
2054: successful, or B<undef> if not.
1.174 albertel 2055:
1.216 bowersj2 2056: =back
2057:
2058: =head2 Methods
2059:
2060: =over 4
2061:
1.174 albertel 2062: =item * B<getIterator>(first, finish, filter, condition):
2063:
2064: See iterator documentation below.
1.133 bowersj2 2065:
2066: =cut
2067:
2068: use strict;
2069: use GDBM_File;
1.320 albertel 2070: use Apache::lonnet;
1.133 bowersj2 2071:
2072: sub new {
2073: # magic invocation to create a class instance
2074: my $proto = shift;
2075: my $class = ref($proto) || $proto;
2076: my $self = {};
2077:
2078: # Resource cache stores navmap resources as we reference them. We generate
2079: # them on-demand so we don't pay for creating resources unless we use them.
2080: $self->{RESOURCE_CACHE} = {};
2081:
2082: # Network failure flag, if we accessed the course or user opt and
2083: # failed
2084: $self->{NETWORK_FAILURE} = 0;
2085:
2086: # tie the nav hash
2087:
1.168 bowersj2 2088: my %navmaphash;
2089: my %parmhash;
1.320 albertel 2090: my $courseFn = $env{"request.course.fn"};
1.220 bowersj2 2091: if (!(tie(%navmaphash, 'GDBM_File', "${courseFn}.db",
1.133 bowersj2 2092: &GDBM_READER(), 0640))) {
2093: return undef;
2094: }
2095:
1.220 bowersj2 2096: if (!(tie(%parmhash, 'GDBM_File', "${courseFn}_parms.db",
1.133 bowersj2 2097: &GDBM_READER(), 0640)))
2098: {
1.170 matthew 2099: untie %{$self->{PARM_HASH}};
1.133 bowersj2 2100: return undef;
2101: }
2102:
1.199 bowersj2 2103: $self->{NAV_HASH} = \%navmaphash;
1.168 bowersj2 2104: $self->{PARM_HASH} = \%parmhash;
1.221 bowersj2 2105: $self->{PARM_CACHE} = {};
1.133 bowersj2 2106:
2107: bless($self);
2108:
2109: return $self;
2110: }
2111:
1.221 bowersj2 2112: sub generate_course_user_opt {
1.133 bowersj2 2113: my $self = shift;
1.221 bowersj2 2114: if ($self->{COURSE_USER_OPT_GENERATED}) { return; }
1.133 bowersj2 2115:
1.320 albertel 2116: my $uname=$env{'user.name'};
2117: my $udom=$env{'user.domain'};
2118: my $cid=$env{'request.course.id'};
1.326 albertel 2119: my $cdom=$env{'course.'.$cid.'.domain'};
2120: my $cnum=$env{'course.'.$cid.'.num'};
1.221 bowersj2 2121:
1.133 bowersj2 2122: # ------------------------------------------------- Get coursedata (if present)
1.326 albertel 2123: my $courseopt=&Apache::lonnet::get_courseresdata($cnum,$cdom);
2124: # Check for network failure
2125: if (!ref($courseopt)) {
2126: if ( $courseopt =~ /no.such.host/i || $courseopt =~ /con_lost/i) {
1.324 albertel 2127: $self->{NETWORK_FAILURE} = 1;
1.221 bowersj2 2128: }
1.326 albertel 2129: undef($courseopt);
2130: }
1.325 albertel 2131:
1.133 bowersj2 2132: # --------------------------------------------------- Get userdata (if present)
1.325 albertel 2133:
1.326 albertel 2134: my $useropt=&Apache::lonnet::get_userresdata($uname,$udom);
2135: # Check for network failure
2136: if (!ref($useropt)) {
2137: if ( $useropt =~ /no.such.host/i || $useropt =~ /con_lost/i) {
1.324 albertel 2138: $self->{NETWORK_FAILURE} = 1;
1.221 bowersj2 2139: }
1.326 albertel 2140: undef($useropt);
1.221 bowersj2 2141: }
2142:
1.326 albertel 2143: $self->{COURSE_OPT} = $courseopt;
2144: $self->{USER_OPT} = $useropt;
2145:
1.221 bowersj2 2146: $self->{COURSE_USER_OPT_GENERATED} = 1;
2147:
2148: return;
2149: }
2150:
2151: sub generate_email_discuss_status {
2152: my $self = shift;
1.259 raeburn 2153: my $symb = shift;
1.221 bowersj2 2154: if ($self->{EMAIL_DISCUSS_GENERATED}) { return; }
1.133 bowersj2 2155:
1.320 albertel 2156: my $cid=$env{'request.course.id'};
1.326 albertel 2157: my $cdom=$env{'course.'.$cid.'.domain'};
2158: my $cnum=$env{'course.'.$cid.'.num'};
1.221 bowersj2 2159:
2160: my %emailstatus = &Apache::lonnet::dump('email_status');
2161: my $logoutTime = $emailstatus{'logout'};
1.320 albertel 2162: my $courseLeaveTime = $emailstatus{'logout_'.$env{'request.course.id'}};
1.221 bowersj2 2163: $self->{LAST_CHECK} = (($courseLeaveTime > $logoutTime) ?
2164: $courseLeaveTime : $logoutTime);
2165: my %discussiontime = &Apache::lonnet::dump('discussiontimes',
2166: $cdom, $cnum);
1.259 raeburn 2167: my %lastread = &Apache::lonnet::dump('nohist_'.$cid.'_discuss',
1.320 albertel 2168: $env{'user.domain'},$env{'user.name'},'lastread');
1.259 raeburn 2169: my %lastreadtime = ();
2170: foreach (keys %lastread) {
2171: my $key = $_;
2172: $key =~ s/_lastread$//;
2173: $lastreadtime{$key} = $lastread{$_};
2174: }
2175:
1.221 bowersj2 2176: my %feedback=();
2177: my %error=();
1.325 albertel 2178: my @keys = &Apache::lonnet::getkeys('nohist_email',$env{'user.domain'},
2179: $env{'user.name'});
1.221 bowersj2 2180:
1.325 albertel 2181: foreach my $msgid (@keys) {
1.295 albertel 2182: if ((!$emailstatus{$msgid}) || ($emailstatus{$msgid} eq 'new')) {
2183: my $plain=
2184: &Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
2185: if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
2186: my ($what,$url)=($1,$2);
1.221 bowersj2 2187: if ($what eq 'Error') {
2188: $error{$url}.=','.$msgid;
2189: } else {
2190: $feedback{$url}.=','.$msgid;
2191: }
2192: }
2193: }
1.211 bowersj2 2194: }
1.221 bowersj2 2195:
1.295 albertel 2196: #url's of resources that have feedbacks
1.221 bowersj2 2197: $self->{FEEDBACK} = \%feedback;
1.295 albertel 2198: #or errors
2199: $self->{ERROR_MSG} = \%error;
1.221 bowersj2 2200: $self->{DISCUSSION_TIME} = \%discussiontime;
2201: $self->{EMAIL_STATUS} = \%emailstatus;
1.259 raeburn 2202: $self->{LAST_READ} = \%lastreadtime;
1.221 bowersj2 2203:
2204: $self->{EMAIL_DISCUSS_GENERATED} = 1;
2205: }
2206:
2207: sub get_user_data {
2208: my $self = shift;
2209: if ($self->{RETRIEVED_USER_DATA}) { return; }
1.211 bowersj2 2210:
1.221 bowersj2 2211: # Retrieve performance data on problems
1.320 albertel 2212: my %student_data = Apache::lonnet::currentdump($env{'request.course.id'},
2213: $env{'user.domain'},
2214: $env{'user.name'});
1.221 bowersj2 2215: $self->{STUDENT_DATA} = \%student_data;
1.133 bowersj2 2216:
1.221 bowersj2 2217: $self->{RETRIEVED_USER_DATA} = 1;
1.133 bowersj2 2218: }
2219:
2220: # Internal function: Takes a key to look up in the nav hash and implements internal
2221: # memory caching of that key.
2222: sub navhash {
2223: my $self = shift; my $key = shift;
2224: return $self->{NAV_HASH}->{$key};
2225: }
2226:
1.217 bowersj2 2227: =pod
2228:
2229: =item * B<courseMapDefined>(): Returns true if the course map is defined,
2230: false otherwise. Undefined course maps indicate an error somewhere in
2231: LON-CAPA, and you will not be able to proceed with using the navmap.
2232: See the B<NAV> screen for an example of using this.
2233:
2234: =cut
2235:
1.133 bowersj2 2236: # Checks to see if coursemap is defined, matching test in old lonnavmaps
2237: sub courseMapDefined {
2238: my $self = shift;
1.320 albertel 2239: my $uri = &Apache::lonnet::clutter($env{'request.course.uri'});
1.133 bowersj2 2240:
2241: my $firstres = $self->navhash("map_start_$uri");
2242: my $lastres = $self->navhash("map_finish_$uri");
2243: return $firstres && $lastres;
2244: }
2245:
2246: sub getIterator {
2247: my $self = shift;
2248: my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.314 albertel 2249: shift, undef, shift,
2250: shift, shift);
1.133 bowersj2 2251: return $iterator;
2252: }
2253:
2254: # Private method: Does the given resource (as a symb string) have
2255: # current discussion? Returns 0 if chat/mail data not extracted.
2256: sub hasDiscussion {
2257: my $self = shift;
2258: my $symb = shift;
1.221 bowersj2 2259: $self->generate_email_discuss_status();
2260:
1.133 bowersj2 2261: if (!defined($self->{DISCUSSION_TIME})) { return 0; }
2262:
2263: #return defined($self->{DISCUSSION_TIME}->{$symb});
1.259 raeburn 2264:
1.323 albertel 2265: # backward compatibility (bulletin boards used to be 'wrapped')
2266: my $ressymb = $self->wrap_symb($symb);
1.259 raeburn 2267: if ( defined ( $self->{LAST_READ}->{$ressymb} ) ) {
2268: return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_READ}->{$ressymb};
2269: } else {
1.266 raeburn 2270: # return $self->{DISCUSSION_TIME}->{$ressymb} > $self->{LAST_CHECK}; # v.1.1 behavior
2271: 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 2272: }
1.133 bowersj2 2273: }
2274:
1.321 raeburn 2275: sub wrap_symb {
1.322 albertel 2276: my $self = shift;
1.321 raeburn 2277: my $symb = shift;
1.322 albertel 2278: if ($symb =~ m-___(adm/\w+/\w+/)(\d+)(/bulletinboard)$-) {
2279: unless ($symb =~ m|adm/wrapper/adm|) {
2280: $symb = 'bulletin___'.$2.'___adm/wrapper/'.$1.$2.$3;
1.321 raeburn 2281: }
2282: }
1.322 albertel 2283: return $symb;
1.321 raeburn 2284: }
2285:
1.322 albertel 2286: # Private method: Does the given resource (as a symb string) have
2287: # current feedback? Returns the string in the feedback hash, which
2288: # will be false if it does not exist.
2289:
1.133 bowersj2 2290: sub getFeedback {
2291: my $self = shift;
2292: my $symb = shift;
2293:
1.221 bowersj2 2294: $self->generate_email_discuss_status();
2295:
1.133 bowersj2 2296: if (!defined($self->{FEEDBACK})) { return ""; }
2297:
2298: return $self->{FEEDBACK}->{$symb};
2299: }
2300:
2301: # Private method: Get the errors for that resource (by source).
2302: sub getErrors {
2303: my $self = shift;
2304: my $src = shift;
1.221 bowersj2 2305:
2306: $self->generate_email_discuss_status();
2307:
1.133 bowersj2 2308: if (!defined($self->{ERROR_MSG})) { return ""; }
2309: return $self->{ERROR_MSG}->{$src};
2310: }
2311:
2312: =pod
2313:
1.174 albertel 2314: =item * B<getById>(id):
2315:
2316: Based on the ID of the resource (1.1, 3.2, etc.), get a resource
2317: object for that resource. This method, or other methods that use it
2318: (as in the resource object) is the only proper way to obtain a
2319: resource object.
1.133 bowersj2 2320:
1.194 bowersj2 2321: =item * B<getBySymb>(symb):
2322:
2323: Based on the symb of the resource, get a resource object for that
2324: resource. This is one of the proper ways to get a resource object.
2325:
2326: =item * B<getMapByMapPc>(map_pc):
2327:
2328: Based on the map_pc of the resource, get a resource object for
2329: the given map. This is one of the proper ways to get a resource object.
2330:
1.133 bowersj2 2331: =cut
2332:
2333: # The strategy here is to cache the resource objects, and only construct them
2334: # as we use them. The real point is to prevent reading any more from the tied
2335: # hash then we have to, which should hopefully alleviate speed problems.
2336:
2337: sub getById {
2338: my $self = shift;
2339: my $id = shift;
2340:
2341: if (defined ($self->{RESOURCE_CACHE}->{$id}))
2342: {
2343: return $self->{RESOURCE_CACHE}->{$id};
2344: }
2345:
2346: # resource handles inserting itself into cache.
2347: # Not clear why the quotes are necessary, but as of this
2348: # writing it doesn't work without them.
2349: return "Apache::lonnavmaps::resource"->new($self, $id);
1.132 bowersj2 2350: }
1.133 bowersj2 2351:
1.172 bowersj2 2352: sub getBySymb {
2353: my $self = shift;
2354: my $symb = shift;
1.277 matthew 2355:
1.228 albertel 2356: my ($mapUrl, $id, $filename) = &Apache::lonnet::decode_symb($symb);
1.172 bowersj2 2357: my $map = $self->getResourceByUrl($mapUrl);
1.277 matthew 2358: my $returnvalue = undef;
2359: if (ref($map)) {
2360: $returnvalue = $self->getById($map->map_pc() .'.'.$id);
2361: }
2362: return $returnvalue;
1.194 bowersj2 2363: }
2364:
2365: sub getByMapPc {
2366: my $self = shift;
2367: my $map_pc = shift;
2368: my $map_id = $self->{NAV_HASH}->{'map_id_' . $map_pc};
2369: $map_id = $self->{NAV_HASH}->{'ids_' . $map_id};
2370: return $self->getById($map_id);
1.172 bowersj2 2371: }
2372:
1.133 bowersj2 2373: =pod
2374:
1.174 albertel 2375: =item * B<firstResource>():
2376:
2377: Returns a resource object reference corresponding to the first
2378: resource in the navmap.
1.133 bowersj2 2379:
2380: =cut
2381:
2382: sub firstResource {
2383: my $self = shift;
2384: my $firstResource = $self->navhash('map_start_' .
1.320 albertel 2385: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2386: return $self->getById($firstResource);
1.132 bowersj2 2387: }
1.133 bowersj2 2388:
2389: =pod
2390:
1.174 albertel 2391: =item * B<finishResource>():
2392:
2393: Returns a resource object reference corresponding to the last resource
2394: in the navmap.
1.133 bowersj2 2395:
2396: =cut
2397:
2398: sub finishResource {
2399: my $self = shift;
2400: my $firstResource = $self->navhash('map_finish_' .
1.320 albertel 2401: &Apache::lonnet::clutter($env{'request.course.uri'}));
1.133 bowersj2 2402: return $self->getById($firstResource);
1.132 bowersj2 2403: }
1.133 bowersj2 2404:
2405: # Parmval reads the parm hash and cascades the lookups. parmval_real does
2406: # the actual lookup; parmval caches the results.
2407: sub parmval {
2408: my $self = shift;
2409: my ($what,$symb)=@_;
2410: my $hashkey = $what."|||".$symb;
2411:
2412: if (defined($self->{PARM_CACHE}->{$hashkey})) {
2413: return $self->{PARM_CACHE}->{$hashkey};
2414: }
2415:
2416: my $result = $self->parmval_real($what, $symb);
2417: $self->{PARM_CACHE}->{$hashkey} = $result;
2418: return $result;
1.132 bowersj2 2419: }
2420:
1.133 bowersj2 2421: sub parmval_real {
2422: my $self = shift;
1.219 albertel 2423: my ($what,$symb,$recurse) = @_;
1.133 bowersj2 2424:
1.221 bowersj2 2425: # Make sure the {USER_OPT} and {COURSE_OPT} hashes are populated
2426: $self->generate_course_user_opt();
2427:
1.320 albertel 2428: my $cid=$env{'request.course.id'};
2429: my $csec=$env{'request.course.sec'};
2430: my $uname=$env{'user.name'};
2431: my $udom=$env{'user.domain'};
1.133 bowersj2 2432:
2433: unless ($symb) { return ''; }
2434: my $result='';
2435:
1.226 www 2436: my ($mapname,$id,$fn)=&Apache::lonnet::decode_symb($symb);
1.133 bowersj2 2437:
2438: # ----------------------------------------------------- Cascading lookup scheme
2439: my $rwhat=$what;
2440: $what=~s/^parameter\_//;
2441: $what=~s/\_/\./;
2442:
2443: my $symbparm=$symb.'.'.$what;
2444: my $mapparm=$mapname.'___(all).'.$what;
1.325 albertel 2445: my $usercourseprefix=$cid;
1.133 bowersj2 2446:
2447: my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
2448: my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
2449: my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
2450:
2451: my $courselevel= $usercourseprefix.'.'.$what;
2452: my $courselevelr=$usercourseprefix.'.'.$symbparm;
2453: my $courselevelm=$usercourseprefix.'.'.$mapparm;
2454:
2455: my $useropt = $self->{USER_OPT};
2456: my $courseopt = $self->{COURSE_OPT};
2457: my $parmhash = $self->{PARM_HASH};
2458:
2459: # ---------------------------------------------------------- first, check user
2460: if ($uname and defined($useropt)) {
2461: if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
2462: if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
2463: if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
2464: }
2465:
2466: # ------------------------------------------------------- second, check course
2467: if ($csec and defined($courseopt)) {
2468: if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
2469: if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
2470: if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
2471: }
2472:
2473: if (defined($courseopt)) {
2474: if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
2475: }
2476:
2477: # ----------------------------------------------------- third, check map parms
2478:
2479: my $thisparm=$$parmhash{$symbparm};
2480: if (defined($thisparm)) { return $thisparm; }
2481:
2482: # ----------------------------------------------------- fourth , check default
2483:
1.246 albertel 2484: my $meta_rwhat=$rwhat;
2485: $meta_rwhat=~s/\./_/g;
2486: my $default=&Apache::lonnet::metadata($fn,$meta_rwhat);
2487: if (defined($default)) { return $default}
2488: $default=&Apache::lonnet::metadata($fn,'parameter_'.$meta_rwhat);
1.133 bowersj2 2489: if (defined($default)) { return $default}
2490:
1.315 albertel 2491: # --------------------------------------------------- fifth, check more course
2492: if (defined($courseopt)) {
2493: if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
2494: if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
2495: }
2496:
2497: # --------------------------------------------------- sixth , cascade up parts
1.133 bowersj2 2498:
2499: my ($space,@qualifier)=split(/\./,$rwhat);
2500: my $qualifier=join('.',@qualifier);
2501: unless ($space eq '0') {
1.160 albertel 2502: my @parts=split(/_/,$space);
2503: my $id=pop(@parts);
2504: my $part=join('_',@parts);
2505: if ($part eq '') { $part='0'; }
1.219 albertel 2506: my $partgeneral=$self->parmval($part.".$qualifier",$symb,1);
1.160 albertel 2507: if (defined($partgeneral)) { return $partgeneral; }
1.133 bowersj2 2508: }
1.219 albertel 2509: if ($recurse) { return undef; }
2510: my $pack_def=&Apache::lonnet::packages_tab_default($fn,'resource.'.$what);
2511: if (defined($pack_def)) { return $pack_def; }
1.133 bowersj2 2512: return '';
1.145 bowersj2 2513: }
2514:
1.174 albertel 2515: =pod
1.145 bowersj2 2516:
1.174 albertel 2517: =item * B<getResourceByUrl>(url):
1.145 bowersj2 2518:
1.174 albertel 2519: Retrieves a resource object by URL of the resource. If passed a
2520: resource object, it will simply return it, so it is safe to use this
2521: method in code like "$res = $navmap->getResourceByUrl($res)", if
2522: you're not sure if $res is already an object, or just a URL. If the
2523: resource appears multiple times in the course, only the first instance
2524: will be returned. As a result, this is probably useful only for maps.
2525:
1.314 albertel 2526: =item * B<retrieveResources>(map, filterFunc, recursive, bailout, showall):
1.174 albertel 2527:
2528: The map is a specification of a map to retreive the resources from,
2529: either as a url or as an object. The filterFunc is a reference to a
2530: function that takes a resource object as its one argument and returns
2531: true if the resource should be included, or false if it should not
2532: be. If recursive is true, the map will be recursively examined,
2533: otherwise it will not be. If bailout is true, the function will return
1.314 albertel 2534: as soon as it finds a resource, if false it will finish. If showall is
2535: true it will not hide maps that contain nothing but one other map. By
2536: default, the map is the top-level map of the course, filterFunc is a
2537: function that always returns 1, recursive is true, bailout is false,
2538: showall is false. The resources will be returned in a list containing
2539: the resource objects for the corresponding resources, with B<no
2540: structure information> in the list; regardless of branching,
2541: recursion, etc., it will be a flat list.
1.174 albertel 2542:
2543: Thus, this is suitable for cases where you don't want the structure,
2544: just a list of all resources. It is also suitable for finding out how
2545: many resources match a given description; for this use, if all you
2546: want to know is if I<any> resources match the description, the bailout
2547: parameter will allow you to avoid potentially expensive enumeration of
2548: all matching resources.
1.145 bowersj2 2549:
1.318 albertel 2550: =item * B<hasResource>(map, filterFunc, recursive, showall):
1.145 bowersj2 2551:
1.174 albertel 2552: Convience method for
1.146 bowersj2 2553:
1.318 albertel 2554: scalar(retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0
1.146 bowersj2 2555:
1.174 albertel 2556: which will tell whether the map has resources matching the description
2557: in the filter function.
1.146 bowersj2 2558:
1.145 bowersj2 2559: =cut
2560:
1.277 matthew 2561:
1.145 bowersj2 2562: sub getResourceByUrl {
2563: my $self = shift;
2564: my $resUrl = shift;
2565:
2566: if (ref($resUrl)) { return $resUrl; }
2567:
2568: $resUrl = &Apache::lonnet::clutter($resUrl);
2569: my $resId = $self->{NAV_HASH}->{'ids_' . $resUrl};
2570: if ($resId =~ /,/) {
2571: $resId = (split (/,/, $resId))[0];
2572: }
2573: if (!$resId) { return ''; }
2574: return $self->getById($resId);
2575: }
2576:
2577: sub retrieveResources {
2578: my $self = shift;
2579: my $map = shift;
2580: my $filterFunc = shift;
2581: if (!defined ($filterFunc)) {
2582: $filterFunc = sub {return 1;};
2583: }
2584: my $recursive = shift;
2585: if (!defined($recursive)) { $recursive = 1; }
2586: my $bailout = shift;
2587: if (!defined($bailout)) { $bailout = 0; }
1.314 albertel 2588: my $showall = shift;
1.145 bowersj2 2589: # Create the necessary iterator.
2590: if (!ref($map)) { # assume it's a url of a map.
1.172 bowersj2 2591: $map = $self->getResourceByUrl($map);
1.145 bowersj2 2592: }
2593:
1.213 bowersj2 2594: # If nothing was passed, assume top-level map
2595: if (!$map) {
2596: $map = $self->getById('0.0');
2597: }
2598:
1.145 bowersj2 2599: # Check the map's validity.
1.213 bowersj2 2600: if (!$map->is_map()) {
1.145 bowersj2 2601: # Oh, to throw an exception.... how I'd love that!
2602: return ();
2603: }
2604:
1.146 bowersj2 2605: # Get an iterator.
2606: my $it = $self->getIterator($map->map_start(), $map->map_finish(),
1.314 albertel 2607: undef, $recursive, $showall);
1.146 bowersj2 2608:
2609: my @resources = ();
2610:
2611: # Run down the iterator and collect the resources.
1.222 bowersj2 2612: my $curRes;
2613:
2614: while ($curRes = $it->next()) {
1.146 bowersj2 2615: if (ref($curRes)) {
2616: if (!&$filterFunc($curRes)) {
2617: next;
2618: }
2619:
2620: push @resources, $curRes;
2621:
2622: if ($bailout) {
2623: return @resources;
2624: }
2625: }
2626:
2627: }
2628:
2629: return @resources;
2630: }
2631:
2632: sub hasResource {
2633: my $self = shift;
2634: my $map = shift;
2635: my $filterFunc = shift;
2636: my $recursive = shift;
1.318 albertel 2637: my $showall = shift;
1.146 bowersj2 2638:
1.318 albertel 2639: return scalar($self->retrieveResources($map, $filterFunc, $recursive, 1, $showall)) > 0;
1.133 bowersj2 2640: }
1.51 bowersj2 2641:
2642: 1;
2643:
2644: package Apache::lonnavmaps::iterator;
1.300 albertel 2645: use WeakRef;
1.320 albertel 2646: use Apache::lonnet;
2647:
1.51 bowersj2 2648: =pod
2649:
2650: =back
2651:
1.174 albertel 2652: =head1 Object: navmap Iterator
1.51 bowersj2 2653:
1.174 albertel 2654: An I<iterator> encapsulates the logic required to traverse a data
2655: structure. navmap uses an iterator to traverse the course map
2656: according to the criteria you wish to use.
2657:
2658: To obtain an iterator, call the B<getIterator>() function of a
2659: B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator
2660: directly.) This will return a reference to the iterator:
1.51 bowersj2 2661:
2662: C<my $resourceIterator = $navmap-E<gt>getIterator();>
2663:
2664: To get the next thing from the iterator, call B<next>:
2665:
2666: C<my $nextThing = $resourceIterator-E<gt>next()>
2667:
2668: getIterator behaves as follows:
2669:
2670: =over 4
2671:
1.174 albertel 2672: =item * B<getIterator>(firstResource, finishResource, filterHash, condition, forceTop, returnTopMap):
2673:
2674: All parameters are optional. firstResource is a resource reference
2675: corresponding to where the iterator should start. It defaults to
2676: navmap->firstResource() for the corresponding nav map. finishResource
2677: corresponds to where you want the iterator to end, defaulting to
2678: navmap->finishResource(). filterHash is a hash used as a set
2679: containing strings representing the resource IDs, defaulting to
2680: empty. Condition is a 1 or 0 that sets what to do with the filter
1.205 bowersj2 2681: hash: If a 0, then only resources that exist IN the filterHash will be
1.174 albertel 2682: recursed on. If it is a 1, only resources NOT in the filterHash will
2683: be recursed on. Defaults to 0. forceTop is a boolean value. If it is
2684: false (default), the iterator will only return the first level of map
2685: that is not just a single, 'redirecting' map. If true, the iterator
2686: will return all information, starting with the top-level map,
2687: regardless of content. returnTopMap, if true (default false), will
2688: cause the iterator to return the top-level map object (resource 0.0)
2689: before anything else.
2690:
2691: Thus, by default, only top-level resources will be shown. Change the
2692: condition to a 1 without changing the hash, and all resources will be
2693: shown. Changing the condition to 1 and including some values in the
2694: hash will allow you to selectively suppress parts of the navmap, while
2695: leaving it on 0 and adding things to the hash will allow you to
2696: selectively add parts of the nav map. See the handler code for
2697: examples.
2698:
2699: The iterator will return either a reference to a resource object, or a
2700: token representing something in the map, such as the beginning of a
2701: new branch. The possible tokens are:
2702:
2703: =over 4
1.51 bowersj2 2704:
1.222 bowersj2 2705: =item * B<END_ITERATOR>:
2706:
2707: The iterator has returned all that it's going to. Further calls to the
2708: iterator will just produce more of these. This is a "false" value, and
2709: is the only false value the iterator which will be returned, so it can
2710: be used as a loop sentinel.
2711:
1.217 bowersj2 2712: =item * B<BEGIN_MAP>:
1.51 bowersj2 2713:
1.174 albertel 2714: A new map is being recursed into. This is returned I<after> the map
2715: resource itself is returned.
1.51 bowersj2 2716:
1.217 bowersj2 2717: =item * B<END_MAP>:
1.174 albertel 2718:
2719: The map is now done.
1.51 bowersj2 2720:
1.217 bowersj2 2721: =item * B<BEGIN_BRANCH>:
1.70 bowersj2 2722:
1.174 albertel 2723: A branch is now starting. The next resource returned will be the first
2724: in that branch.
1.70 bowersj2 2725:
1.217 bowersj2 2726: =item * B<END_BRANCH>:
1.70 bowersj2 2727:
1.174 albertel 2728: The branch is now done.
1.51 bowersj2 2729:
2730: =back
2731:
1.174 albertel 2732: The tokens are retreivable via methods on the iterator object, i.e.,
2733: $iterator->END_MAP.
1.70 bowersj2 2734:
1.174 albertel 2735: Maps can contain empty resources. The iterator will automatically skip
2736: over such resources, but will still treat the structure
2737: correctly. Thus, a complicated map with several branches, but
2738: consisting entirely of empty resources except for one beginning or
2739: ending resource, will cause a lot of BRANCH_STARTs and BRANCH_ENDs,
2740: but only one resource will be returned.
1.116 bowersj2 2741:
1.242 matthew 2742: =back
2743:
1.222 bowersj2 2744: =head2 Normal Usage
2745:
2746: Normal usage of the iterator object is to do the following:
2747:
2748: my $it = $navmap->getIterator([your params here]);
2749: my $curRes;
2750: while ($curRes = $it->next()) {
2751: [your logic here]
2752: }
2753:
2754: Note that inside of the loop, it's frequently useful to check if
2755: "$curRes" is a reference or not with the reference function; only
2756: resource objects will be references, and any non-references will
2757: be the tokens described above.
2758:
2759: Also note there is some old code floating around that trys to track
2760: the depth of the iterator to see when it's done; do not copy that
2761: code. It is difficult to get right and harder to understand then
2762: this. They should be migrated to this new style.
1.51 bowersj2 2763:
2764: =cut
2765:
2766: # Here are the tokens for the iterator:
2767:
1.222 bowersj2 2768: sub END_ITERATOR { return 0; }
1.51 bowersj2 2769: sub BEGIN_MAP { return 1; } # begining of a new map
2770: sub END_MAP { return 2; } # end of the map
2771: sub BEGIN_BRANCH { return 3; } # beginning of a branch
2772: sub END_BRANCH { return 4; } # end of a branch
1.89 bowersj2 2773: sub FORWARD { return 1; } # go forward
2774: sub BACKWARD { return 2; }
1.51 bowersj2 2775:
1.96 bowersj2 2776: sub min {
2777: (my $a, my $b) = @_;
2778: if ($a < $b) { return $a; } else { return $b; }
2779: }
2780:
1.94 bowersj2 2781: sub new {
2782: # magic invocation to create a class instance
2783: my $proto = shift;
2784: my $class = ref($proto) || $proto;
2785: my $self = {};
2786:
1.300 albertel 2787: weaken($self->{NAV_MAP} = shift);
1.94 bowersj2 2788: return undef unless ($self->{NAV_MAP});
2789:
2790: # Handle the parameters
2791: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
2792: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
2793:
2794: # If the given resources are just the ID of the resource, get the
2795: # objects
2796: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
2797: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
2798: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
2799: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
2800:
2801: $self->{FILTER} = shift;
2802:
2803: # A hash, used as a set, of resource already seen
2804: $self->{ALREADY_SEEN} = shift;
2805: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
2806: $self->{CONDITION} = shift;
2807:
1.116 bowersj2 2808: # Do we want to automatically follow "redirection" maps?
2809: $self->{FORCE_TOP} = shift;
2810:
1.162 bowersj2 2811: # Do we want to return the top-level map object (resource 0.0)?
2812: $self->{RETURN_0} = shift;
2813: # have we done that yet?
2814: $self->{HAVE_RETURNED_0} = 0;
2815:
1.94 bowersj2 2816: # Now, we need to pre-process the map, by walking forward and backward
2817: # over the parts of the map we're going to look at.
1.96 bowersj2 2818:
1.97 bowersj2 2819: # The processing steps are exactly the same, except for a few small
2820: # changes, so I bundle those up in the following list of two elements:
2821: # (direction_to_iterate, VAL_name, next_resource_method_to_call,
2822: # first_resource).
2823: # This prevents writing nearly-identical code twice.
2824: my @iterations = ( [FORWARD(), 'TOP_DOWN_VAL', 'getNext',
2825: 'FIRST_RESOURCE'],
2826: [BACKWARD(), 'BOT_UP_VAL', 'getPrevious',
2827: 'FINISH_RESOURCE'] );
2828:
1.98 bowersj2 2829: my $maxDepth = 0; # tracks max depth
2830:
1.116 bowersj2 2831: # If there is only one resource in this map, and it's a map, we
2832: # want to remember that, so the user can ask for the first map
2833: # that isn't just a redirector.
2834: my $resource; my $resourceCount = 0;
2835:
1.209 bowersj2 2836: # Documentation on this algorithm can be found in the CVS repository at
2837: # /docs/lonnavdocs; these "**#**" markers correspond to documentation
2838: # in that file.
1.107 bowersj2 2839: # **1**
2840:
1.97 bowersj2 2841: foreach my $pass (@iterations) {
2842: my $direction = $pass->[0];
2843: my $valName = $pass->[1];
2844: my $nextResourceMethod = $pass->[2];
2845: my $firstResourceName = $pass->[3];
2846:
2847: my $iterator = Apache::lonnavmaps::DFSiterator->new($self->{NAV_MAP},
2848: $self->{FIRST_RESOURCE},
2849: $self->{FINISH_RESOURCE},
2850: {}, undef, 0, $direction);
1.96 bowersj2 2851:
1.97 bowersj2 2852: # prime the recursion
2853: $self->{$firstResourceName}->{DATA}->{$valName} = 0;
1.222 bowersj2 2854: $iterator->next();
1.97 bowersj2 2855: my $curRes = $iterator->next();
1.222 bowersj2 2856: my $depth = 1;
2857: while ($depth > 0) {
2858: if ($curRes == $iterator->BEGIN_MAP()) { $depth++; }
2859: if ($curRes == $iterator->END_MAP()) { $depth--; }
2860:
1.97 bowersj2 2861: if (ref($curRes)) {
1.116 bowersj2 2862: # If there's only one resource, this will save it
1.117 bowersj2 2863: # we have to filter empty resources from consideration here,
2864: # or even "empty", redirecting maps have two (start & finish)
2865: # or three (start, finish, plus redirector)
2866: if($direction == FORWARD && $curRes->src()) {
2867: $resource = $curRes; $resourceCount++;
2868: }
1.97 bowersj2 2869: my $resultingVal = $curRes->{DATA}->{$valName};
2870: my $nextResources = $curRes->$nextResourceMethod();
1.116 bowersj2 2871: my $nextCount = scalar(@{$nextResources});
1.104 bowersj2 2872:
1.116 bowersj2 2873: if ($nextCount == 1) { # **3**
1.97 bowersj2 2874: my $current = $nextResources->[0]->{DATA}->{$valName} || 999999999;
2875: $nextResources->[0]->{DATA}->{$valName} = min($resultingVal, $current);
2876: }
2877:
1.116 bowersj2 2878: if ($nextCount > 1) { # **4**
1.97 bowersj2 2879: foreach my $res (@{$nextResources}) {
2880: my $current = $res->{DATA}->{$valName} || 999999999;
2881: $res->{DATA}->{$valName} = min($current, $resultingVal + 1);
2882: }
2883: }
2884: }
1.96 bowersj2 2885:
1.107 bowersj2 2886: # Assign the final val (**2**)
1.97 bowersj2 2887: if (ref($curRes) && $direction == BACKWARD()) {
1.98 bowersj2 2888: my $finalDepth = min($curRes->{DATA}->{TOP_DOWN_VAL},
2889: $curRes->{DATA}->{BOT_UP_VAL});
2890:
2891: $curRes->{DATA}->{DISPLAY_DEPTH} = $finalDepth;
2892: if ($finalDepth > $maxDepth) {$maxDepth = $finalDepth;}
1.190 bowersj2 2893: }
1.222 bowersj2 2894:
2895: $curRes = $iterator->next();
1.96 bowersj2 2896: }
2897: }
1.94 bowersj2 2898:
1.116 bowersj2 2899: # Check: Was this only one resource, a map?
1.255 albertel 2900: if ($resourceCount == 1 && $resource->is_sequence() && !$self->{FORCE_TOP}) {
1.116 bowersj2 2901: my $firstResource = $resource->map_start();
2902: my $finishResource = $resource->map_finish();
2903: return
2904: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
2905: $finishResource, $self->{FILTER},
2906: $self->{ALREADY_SEEN},
1.314 albertel 2907: $self->{CONDITION},
2908: $self->{FORCE_TOP});
1.116 bowersj2 2909:
2910: }
2911:
1.98 bowersj2 2912: # Set up some bookkeeping information.
2913: $self->{CURRENT_DEPTH} = 0;
2914: $self->{MAX_DEPTH} = $maxDepth;
2915: $self->{STACK} = [];
2916: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
1.222 bowersj2 2917: $self->{FINISHED} = 0; # When true, the iterator has finished
1.98 bowersj2 2918:
2919: for (my $i = 0; $i <= $self->{MAX_DEPTH}; $i++) {
2920: push @{$self->{STACK}}, [];
2921: }
2922:
1.107 bowersj2 2923: # Prime the recursion w/ the first resource **5**
1.98 bowersj2 2924: push @{$self->{STACK}->[0]}, $self->{FIRST_RESOURCE};
2925: $self->{ALREADY_SEEN}->{$self->{FIRST_RESOURCE}->{ID}} = 1;
2926:
2927: bless ($self);
2928:
2929: return $self;
2930: }
2931:
2932: sub next {
2933: my $self = shift;
1.256 albertel 2934: my $closeAllPages=shift;
1.222 bowersj2 2935: if ($self->{FINISHED}) {
2936: return END_ITERATOR();
2937: }
2938:
1.162 bowersj2 2939: # If we want to return the top-level map object, and haven't yet,
2940: # do so.
2941: if ($self->{RETURN_0} && !$self->{HAVE_RETURNED_0}) {
2942: $self->{HAVE_RETURNED_0} = 1;
2943: return $self->{NAV_MAP}->getById('0.0');
2944: }
1.98 bowersj2 2945:
2946: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
2947: # grab the next from the recursive iterator
1.256 albertel 2948: my $next = $self->{RECURSIVE_ITERATOR}->next($closeAllPages);
1.98 bowersj2 2949:
2950: # is it a begin or end map? If so, update the depth
2951: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
2952: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
2953:
2954: # Are we back at depth 0? If so, stop recursing
2955: if ($self->{RECURSIVE_DEPTH} == 0) {
2956: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
2957: }
2958:
2959: return $next;
2960: }
2961:
2962: if (defined($self->{FORCE_NEXT})) {
2963: my $tmp = $self->{FORCE_NEXT};
2964: $self->{FORCE_NEXT} = undef;
2965: return $tmp;
2966: }
2967:
2968: # Have we not yet begun? If not, return BEGIN_MAP and
2969: # remember we've started.
2970: if ( !$self->{STARTED} ) {
2971: $self->{STARTED} = 1;
2972: return $self->BEGIN_MAP();
2973: }
2974:
2975: # Here's the guts of the iterator.
2976:
2977: # Find the next resource, if any.
2978: my $found = 0;
2979: my $i = $self->{MAX_DEPTH};
2980: my $newDepth;
2981: my $here;
2982: while ( $i >= 0 && !$found ) {
1.107 bowersj2 2983: if ( scalar(@{$self->{STACK}->[$i]}) > 0 ) { # **6**
2984: $here = pop @{$self->{STACK}->[$i]}; # **7**
1.98 bowersj2 2985: $found = 1;
2986: $newDepth = $i;
2987: }
2988: $i--;
2989: }
2990:
2991: # If we still didn't find anything, we're done.
2992: if ( !$found ) {
2993: # We need to get back down to the correct branch depth
2994: if ( $self->{CURRENT_DEPTH} > 0 ) {
2995: $self->{CURRENT_DEPTH}--;
2996: return END_BRANCH();
2997: } else {
1.222 bowersj2 2998: $self->{FINISHED} = 1;
1.98 bowersj2 2999: return END_MAP();
3000: }
3001: }
3002:
1.104 bowersj2 3003: # If this is not a resource, it must be an END_BRANCH marker we want
3004: # to return directly.
1.107 bowersj2 3005: if (!ref($here)) { # **8**
1.104 bowersj2 3006: if ($here == END_BRANCH()) { # paranoia, in case of later extension
3007: $self->{CURRENT_DEPTH}--;
3008: return $here;
3009: }
3010: }
3011:
3012: # Otherwise, it is a resource and it's safe to store in $self->{HERE}
3013: $self->{HERE} = $here;
3014:
1.98 bowersj2 3015: # Get to the right level
3016: if ( $self->{CURRENT_DEPTH} > $newDepth ) {
3017: push @{$self->{STACK}->[$newDepth]}, $here;
3018: $self->{CURRENT_DEPTH}--;
3019: return END_BRANCH();
3020: }
3021: if ( $self->{CURRENT_DEPTH} < $newDepth) {
3022: push @{$self->{STACK}->[$newDepth]}, $here;
3023: $self->{CURRENT_DEPTH}++;
3024: return BEGIN_BRANCH();
3025: }
3026:
3027: # If we made it here, we have the next resource, and we're at the
3028: # right branch level. So let's examine the resource for where
3029: # we can get to from here.
3030:
3031: # So we need to look at all the resources we can get to from here,
3032: # categorize them if we haven't seen them, remember if we have a new
3033: my $nextUnfiltered = $here->getNext();
1.104 bowersj2 3034: my $maxDepthAdded = -1;
3035:
1.98 bowersj2 3036: for (@$nextUnfiltered) {
3037: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
1.104 bowersj2 3038: my $depth = $_->{DATA}->{DISPLAY_DEPTH};
3039: push @{$self->{STACK}->[$depth]}, $_;
1.98 bowersj2 3040: $self->{ALREADY_SEEN}->{$_->{ID}} = 1;
1.104 bowersj2 3041: if ($maxDepthAdded < $depth) { $maxDepthAdded = $depth; }
1.98 bowersj2 3042: }
3043: }
1.104 bowersj2 3044:
3045: # Is this the end of a branch? If so, all of the resources examined above
3046: # led to lower levels then the one we are currently at, so we push a END_BRANCH
3047: # marker onto the stack so we don't forget.
3048: # Example: For the usual A(BC)(DE)F case, when the iterator goes down the
3049: # BC branch and gets to C, it will see F as the only next resource, but it's
3050: # one level lower. Thus, this is the end of the branch, since there are no
3051: # more resources added to this level or above.
1.111 bowersj2 3052: # We don't do this if the examined resource is the finish resource,
3053: # because the condition given above is true, but the "END_MAP" will
3054: # take care of things and we should already be at depth 0.
1.104 bowersj2 3055: my $isEndOfBranch = $maxDepthAdded < $self->{CURRENT_DEPTH};
1.111 bowersj2 3056: if ($isEndOfBranch && $here != $self->{FINISH_RESOURCE}) { # **9**
1.104 bowersj2 3057: push @{$self->{STACK}->[$self->{CURRENT_DEPTH}]}, END_BRANCH();
3058: }
3059:
1.98 bowersj2 3060: # That ends the main iterator logic. Now, do we want to recurse
3061: # down this map (if this resource is a map)?
1.256 albertel 3062: if ( ($self->{HERE}->is_sequence() || (!$closeAllPages && $self->{HERE}->is_page())) &&
1.98 bowersj2 3063: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
3064: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3065: my $firstResource = $self->{HERE}->map_start();
3066: my $finishResource = $self->{HERE}->map_finish();
3067:
3068: $self->{RECURSIVE_ITERATOR} =
3069: Apache::lonnavmaps::iterator->new($self->{NAV_MAP}, $firstResource,
3070: $finishResource, $self->{FILTER},
1.314 albertel 3071: $self->{ALREADY_SEEN},
3072: $self->{CONDITION},
3073: $self->{FORCE_TOP});
1.98 bowersj2 3074: }
3075:
1.116 bowersj2 3076: # If this is a blank resource, don't actually return it.
1.117 bowersj2 3077: # Should you ever find you need it, make sure to add an option to the code
3078: # that you can use; other things depend on this behavior.
1.138 bowersj2 3079: my $browsePriv = $self->{HERE}->browsePriv();
3080: if (!$self->{HERE}->src() ||
3081: (!($browsePriv eq 'F') && !($browsePriv eq '2')) ) {
1.256 albertel 3082: return $self->next($closeAllPages);
1.116 bowersj2 3083: }
3084:
1.98 bowersj2 3085: return $self->{HERE};
3086:
3087: }
3088:
3089: =pod
3090:
1.174 albertel 3091: The other method available on the iterator is B<getStack>, which
3092: returns an array populated with the current 'stack' of maps, as
3093: references to the resource objects. Example: This is useful when
3094: making the navigation map, as we need to check whether we are under a
3095: page map to see if we need to link directly to the resource, or to the
3096: page. The first elements in the array will correspond to the top of
3097: the stack (most inclusive map).
1.98 bowersj2 3098:
3099: =cut
3100:
3101: sub getStack {
3102: my $self=shift;
3103:
3104: my @stack;
3105:
3106: $self->populateStack(\@stack);
3107:
3108: return \@stack;
3109: }
3110:
3111: # Private method: Calls the iterators recursively to populate the stack.
3112: sub populateStack {
3113: my $self=shift;
3114: my $stack = shift;
3115:
3116: push @$stack, $self->{HERE} if ($self->{HERE});
3117:
3118: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3119: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3120: }
1.94 bowersj2 3121: }
3122:
3123: 1;
3124:
3125: package Apache::lonnavmaps::DFSiterator;
1.300 albertel 3126: use WeakRef;
1.320 albertel 3127: use Apache::lonnet;
3128:
1.100 bowersj2 3129: # Not documented in the perldoc: This is a simple iterator that just walks
3130: # through the nav map and presents the resources in a depth-first search
3131: # fashion, ignorant of conditionals, randomized resources, etc. It presents
3132: # BEGIN_MAP and END_MAP, but does not understand branches at all. It is
3133: # useful for pre-processing of some kind, and is in fact used by the main
3134: # iterator that way, but that's about it.
3135: # One could imagine merging this into the init routine of the main iterator,
1.251 www 3136: # but this might as well be left separate, since it is possible some other
1.100 bowersj2 3137: # use might be found for it. - Jeremy
1.94 bowersj2 3138:
1.117 bowersj2 3139: # Unlike the main iterator, this DOES return all resources, even blank ones.
3140: # The main iterator needs them to correctly preprocess the map.
3141:
1.94 bowersj2 3142: sub BEGIN_MAP { return 1; } # begining of a new map
3143: sub END_MAP { return 2; } # end of the map
3144: sub FORWARD { return 1; } # go forward
3145: sub BACKWARD { return 2; }
3146:
1.100 bowersj2 3147: # Params: Nav map ref, first resource id/ref, finish resource id/ref,
3148: # filter hash ref (or undef), already seen hash or undef, condition
3149: # (as in main iterator), direction FORWARD or BACKWARD (undef->forward).
1.51 bowersj2 3150: sub new {
3151: # magic invocation to create a class instance
3152: my $proto = shift;
3153: my $class = ref($proto) || $proto;
3154: my $self = {};
3155:
1.300 albertel 3156: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3157: return undef unless ($self->{NAV_MAP});
3158:
3159: $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
3160: $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
3161:
3162: # If the given resources are just the ID of the resource, get the
3163: # objects
3164: if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} =
3165: $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
3166: if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} =
3167: $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
3168:
3169: $self->{FILTER} = shift;
3170:
3171: # A hash, used as a set, of resource already seen
3172: $self->{ALREADY_SEEN} = shift;
1.140 bowersj2 3173: if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63 bowersj2 3174: $self->{CONDITION} = shift;
1.89 bowersj2 3175: $self->{DIRECTION} = shift || FORWARD();
1.51 bowersj2 3176:
1.100 bowersj2 3177: # Flag: Have we started yet?
1.51 bowersj2 3178: $self->{STARTED} = 0;
3179:
3180: # Should we continue calling the recursive iterator, if any?
3181: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3182: # The recursive iterator, if any
3183: $self->{RECURSIVE_ITERATOR} = undef;
3184: # Are we recursing on a map, or a branch?
3185: $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
3186: # And the count of how deep it is, so that this iterator can keep track of
3187: # when to pick back up again.
3188: $self->{RECURSIVE_DEPTH} = 0;
3189:
3190: # For keeping track of our branches, we maintain our own stack
1.100 bowersj2 3191: $self->{STACK} = [];
1.51 bowersj2 3192:
3193: # Start with the first resource
1.89 bowersj2 3194: if ($self->{DIRECTION} == FORWARD) {
1.100 bowersj2 3195: push @{$self->{STACK}}, $self->{FIRST_RESOURCE};
1.89 bowersj2 3196: } else {
1.100 bowersj2 3197: push @{$self->{STACK}}, $self->{FINISH_RESOURCE};
1.89 bowersj2 3198: }
1.51 bowersj2 3199:
3200: bless($self);
3201: return $self;
3202: }
3203:
3204: sub next {
3205: my $self = shift;
3206:
3207: # Are we using a recursive iterator? If so, pull from that and
3208: # watch the depth; we want to resume our level at the correct time.
1.98 bowersj2 3209: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
1.51 bowersj2 3210: # grab the next from the recursive iterator
3211: my $next = $self->{RECURSIVE_ITERATOR}->next();
3212:
3213: # is it a begin or end map? Update depth if so
3214: if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
3215: if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
3216:
3217: # Are we back at depth 0? If so, stop recursing.
3218: if ($self->{RECURSIVE_DEPTH} == 0) {
3219: $self->{RECURSIVE_ITERATOR_FLAG} = 0;
3220: }
3221:
3222: return $next;
3223: }
3224:
3225: # Is there a current resource to grab? If not, then return
1.100 bowersj2 3226: # END_MAP, which will end the iterator.
3227: if (scalar(@{$self->{STACK}}) == 0) {
3228: return $self->END_MAP();
1.51 bowersj2 3229: }
3230:
3231: # Have we not yet begun? If not, return BEGIN_MAP and
3232: # remember that we've started.
3233: if ( !$self->{STARTED} ) {
3234: $self->{STARTED} = 1;
3235: return $self->BEGIN_MAP;
3236: }
3237:
3238: # Get the next resource in the branch
1.100 bowersj2 3239: $self->{HERE} = pop @{$self->{STACK}};
1.52 bowersj2 3240:
1.100 bowersj2 3241: # remember that we've seen this, so we don't return it again later
1.51 bowersj2 3242: $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
3243:
3244: # Get the next possible resources
1.90 bowersj2 3245: my $nextUnfiltered;
1.89 bowersj2 3246: if ($self->{DIRECTION} == FORWARD()) {
1.90 bowersj2 3247: $nextUnfiltered = $self->{HERE}->getNext();
1.89 bowersj2 3248: } else {
1.90 bowersj2 3249: $nextUnfiltered = $self->{HERE}->getPrevious();
1.89 bowersj2 3250: }
1.51 bowersj2 3251: my $next = [];
3252:
3253: # filter the next possibilities to remove things we've
1.100 bowersj2 3254: # already seen.
1.51 bowersj2 3255: foreach (@$nextUnfiltered) {
1.52 bowersj2 3256: if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
3257: push @$next, $_;
3258: }
1.51 bowersj2 3259: }
3260:
3261: while (@$next) {
1.100 bowersj2 3262: # copy the next possibilities over to the stack
3263: push @{$self->{STACK}}, shift @$next;
1.51 bowersj2 3264: }
3265:
3266: # If this is a map and we want to recurse down it... (not filtered out)
1.70 bowersj2 3267: if ($self->{HERE}->is_map() &&
1.63 bowersj2 3268: (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) {
1.51 bowersj2 3269: $self->{RECURSIVE_ITERATOR_FLAG} = 1;
3270: my $firstResource = $self->{HERE}->map_start();
3271: my $finishResource = $self->{HERE}->map_finish();
3272:
3273: $self->{RECURSIVE_ITERATOR} =
1.94 bowersj2 3274: Apache::lonnavmaps::DFSiterator->new ($self->{NAV_MAP}, $firstResource,
1.63 bowersj2 3275: $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.91 bowersj2 3276: $self->{CONDITION}, $self->{DIRECTION});
1.51 bowersj2 3277: }
3278:
3279: return $self->{HERE};
1.190 bowersj2 3280: }
3281:
3282: # Identical to the full iterator methods of the same name. Hate to copy/paste
3283: # but I also hate to "inherit" either iterator from the other.
3284:
3285: sub getStack {
3286: my $self=shift;
3287:
3288: my @stack;
3289:
3290: $self->populateStack(\@stack);
3291:
3292: return \@stack;
3293: }
3294:
3295: # Private method: Calls the iterators recursively to populate the stack.
3296: sub populateStack {
3297: my $self=shift;
3298: my $stack = shift;
3299:
3300: push @$stack, $self->{HERE} if ($self->{HERE});
3301:
3302: if ($self->{RECURSIVE_ITERATOR_FLAG}) {
3303: $self->{RECURSIVE_ITERATOR}->populateStack($stack);
3304: }
1.51 bowersj2 3305: }
3306:
1.1 www 3307: 1;
1.2 www 3308:
1.51 bowersj2 3309: package Apache::lonnavmaps::resource;
1.300 albertel 3310: use WeakRef;
1.51 bowersj2 3311: use Apache::lonnet;
3312:
3313: =pod
3314:
1.217 bowersj2 3315: =head1 Object: resource
1.51 bowersj2 3316:
1.217 bowersj2 3317: X<resource, navmap object>
1.174 albertel 3318: A resource object encapsulates a resource in a resource map, allowing
3319: easy manipulation of the resource, querying the properties of the
3320: resource (including user properties), and represents a reference that
3321: can be used as the canonical representation of the resource by
3322: lonnavmap clients like renderers.
3323:
3324: A resource only makes sense in the context of a navmap, as some of the
3325: data is stored in the navmap object.
3326:
3327: You will probably never need to instantiate this object directly. Use
3328: Apache::lonnavmaps::navmap, and use the "start" method to obtain the
3329: starting resource.
1.51 bowersj2 3330:
1.188 bowersj2 3331: Resource objects respect the parameter_hiddenparts, which suppresses
3332: various parts according to the wishes of the map author. As of this
3333: writing, there is no way to override this parameter, and suppressed
3334: parts will never be returned, nor will their response types or ids be
3335: stored.
3336:
1.217 bowersj2 3337: =head2 Overview
1.51 bowersj2 3338:
1.217 bowersj2 3339: A B<Resource> is the most granular type of object in LON-CAPA that can
3340: be included in a course. It can either be a particular resource, like
3341: an HTML page, external resource, problem, etc., or it can be a
3342: container sequence, such as a "page" or a "map".
3343:
3344: To see a sequence from the user's point of view, please see the
3345: B<Creating a Course: Maps and Sequences> chapter of the Author's
3346: Manual.
3347:
3348: A Resource Object, once obtained from a navmap object via a B<getBy*>
3349: method of the navmap, or from an iterator, allows you to query
3350: information about that resource.
3351:
3352: Generally, you do not ever want to create a resource object yourself,
3353: so creation has been left undocumented. Always retrieve resources
3354: from navmap objects.
3355:
3356: =head3 Identifying Resources
3357:
3358: X<big hash>Every resource is identified by a Resource ID in the big hash that is
3359: unique to that resource for a given course. X<resource ID, in big hash>
3360: The Resource ID has the form #.#, where the first number is the same
3361: for every resource in a map, and the second is unique. For instance,
3362: for a course laid out like this:
3363:
3364: * Problem 1
3365: * Map
3366: * Resource 2
3367: * Resource 3
3368:
3369: C<Problem 1> and C<Map> will share a first number, and C<Resource 2>
3370: C<Resource 3> will share a first number. The second number may end up
3371: re-used between the two groups.
3372:
3373: The resource ID is only used in the big hash, but can be used in the
3374: context of a course to identify a resource easily. (For instance, the
3375: printing system uses it to record which resources from a sequence you
3376: wish to print.)
3377:
3378: X<symb> X<resource, symb>
3379: All resources also have B<symb>s, which uniquely identify a resource
3380: in a course. Many internal LON-CAPA functions expect a symb. A symb
3381: carries along with it the URL of the resource, and the map it appears
3382: in. Symbs are much larger then resource IDs.
1.51 bowersj2 3383:
3384: =cut
3385:
3386: sub new {
3387: # magic invocation to create a class instance
3388: my $proto = shift;
3389: my $class = ref($proto) || $proto;
3390: my $self = {};
3391:
1.300 albertel 3392: weaken($self->{NAV_MAP} = shift);
1.51 bowersj2 3393: $self->{ID} = shift;
3394:
3395: # Store this new resource in the parent nav map's cache.
3396: $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66 bowersj2 3397: $self->{RESOURCE_ERROR} = 0;
1.51 bowersj2 3398:
3399: # A hash that can be used by two-pass algorithms to store data
3400: # about this resource in. Not used by the resource object
3401: # directly.
3402: $self->{DATA} = {};
3403:
3404: bless($self);
3405:
3406: return $self;
3407: }
3408:
1.70 bowersj2 3409: # private function: simplify the NAV_HASH lookups we keep doing
3410: # pass the name, and to automatically append my ID, pass a true val on the
3411: # second param
3412: sub navHash {
3413: my $self = shift;
3414: my $param = shift;
3415: my $id = shift;
1.115 bowersj2 3416: return $self->{NAV_MAP}->navhash($param . ($id?$self->{ID}:""));
1.70 bowersj2 3417: }
3418:
1.51 bowersj2 3419: =pod
3420:
1.217 bowersj2 3421: =head2 Methods
1.70 bowersj2 3422:
1.217 bowersj2 3423: Once you have a resource object, here's what you can do with it:
3424:
3425: =head3 Attribute Retrieval
3426:
3427: Every resource has certain attributes that can be retrieved and used:
1.70 bowersj2 3428:
3429: =over 4
3430:
1.217 bowersj2 3431: =item * B<ID>: Every resource has an ID that is unique for that
3432: resource in the course it is in. The ID is actually in the hash
3433: representing the resource, so for a resource object $res, obtain
3434: it via C<$res->{ID}).
3435:
1.174 albertel 3436: =item * B<compTitle>:
3437:
3438: Returns a "composite title", that is equal to $res->title() if the
3439: resource has a title, and is otherwise the last part of the URL (e.g.,
3440: "problem.problem").
3441:
3442: =item * B<ext>:
3443:
3444: Returns true if the resource is external.
3445:
3446: =item * B<kind>:
3447:
3448: Returns the kind of the resource from the compiled nav map.
3449:
3450: =item * B<randomout>:
1.106 bowersj2 3451:
1.174 albertel 3452: Returns true if this resource was chosen to NOT be shown to the user
3453: by the random map selection feature. In other words, this is usually
3454: false.
1.70 bowersj2 3455:
1.174 albertel 3456: =item * B<randompick>:
1.70 bowersj2 3457:
1.174 albertel 3458: Returns true for a map if the randompick feature is being used on the
3459: map. (?)
1.70 bowersj2 3460:
1.174 albertel 3461: =item * B<src>:
1.51 bowersj2 3462:
1.174 albertel 3463: Returns the source for the resource.
1.70 bowersj2 3464:
1.174 albertel 3465: =item * B<symb>:
1.70 bowersj2 3466:
1.174 albertel 3467: Returns the symb for the resource.
1.70 bowersj2 3468:
1.174 albertel 3469: =item * B<title>:
1.70 bowersj2 3470:
1.174 albertel 3471: Returns the title of the resource.
3472:
1.51 bowersj2 3473: =back
3474:
3475: =cut
3476:
3477: # These info functions can be used directly, as they don't return
3478: # resource information.
1.85 bowersj2 3479: sub comesfrom { my $self=shift; return $self->navHash("comesfrom_", 1); }
1.303 albertel 3480: sub encrypted { my $self=shift; return $self->navHash("encrypted_", 1); }
1.70 bowersj2 3481: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.85 bowersj2 3482: sub from { my $self=shift; return $self->navHash("from_", 1); }
1.217 bowersj2 3483: # considered private and undocumented
1.51 bowersj2 3484: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
3485: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68 bowersj2 3486: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
3487: sub randompick {
3488: my $self = shift;
3489: return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
3490: '.0.parameter_randompick'};
3491: }
1.303 albertel 3492: sub link {
3493: my $self=shift;
3494: if ($self->encrypted()) { return &Apache::lonenc::encrypted($self->src); }
3495: return $self->src;
3496: }
1.51 bowersj2 3497: sub src {
3498: my $self=shift;
3499: return $self->navHash("src_", 1);
3500: }
1.303 albertel 3501: sub shown_symb {
3502: my $self=shift;
3503: if ($self->encrypted()) {return &Apache::lonenc::encrypted($self->symb());}
3504: return $self->symb();
3505: }
1.328 www 3506: sub id {
3507: my $self=shift;
3508: return $self->{ID};
3509: }
3510: sub enclosing_map_src {
3511: my $self=shift;
3512: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3513: return $self->navHash('map_id_'.$first);
3514: }
1.51 bowersj2 3515: sub symb {
3516: my $self=shift;
3517: (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
3518: my $symbSrc = &Apache::lonnet::declutter($self->src());
1.223 albertel 3519: my $symb = &Apache::lonnet::declutter($self->navHash('map_id_'.$first))
1.51 bowersj2 3520: . '___' . $second . '___' . $symbSrc;
1.223 albertel 3521: return &Apache::lonnet::symbclean($symb);
1.51 bowersj2 3522: }
1.321 raeburn 3523: sub wrap_symb {
3524: my $self = shift;
3525: return $self->{NAV_MAP}->wrap_symb($self->symb());
3526: }
1.213 bowersj2 3527: sub title {
3528: my $self=shift;
3529: if ($self->{ID} eq '0.0') {
3530: # If this is the top-level map, return the title of the course
3531: # since this map can not be titled otherwise.
1.320 albertel 3532: return $env{'course.'.$env{'request.course.id'}.'.description'};
1.213 bowersj2 3533: }
3534: return $self->navHash("title_", 1); }
1.217 bowersj2 3535: # considered private and undocumented
1.70 bowersj2 3536: sub to { my $self=shift; return $self->navHash("to_", 1); }
1.301 albertel 3537: sub condition {
3538: my $self=shift;
3539: my $undercond=$self->navHash("undercond_", 1);
3540: if (!defined($undercond)) { return 1; };
3541: my $condid=$self->navHash("condid_$undercond");
3542: if (!defined($condid)) { return 1; };
3543: my $condition=&Apache::lonnet::directcondval($condid);
3544: return $condition;
3545: }
3546:
1.106 bowersj2 3547: sub compTitle {
3548: my $self = shift;
3549: my $title = $self->title();
1.176 www 3550: $title=~s/\&colon\;/\:/gs;
1.106 bowersj2 3551: if (!$title) {
3552: $title = $self->src();
3553: $title = substr($title, rindex($title, '/') + 1);
3554: }
3555: return $title;
3556: }
1.70 bowersj2 3557: =pod
3558:
3559: B<Predicate Testing the Resource>
3560:
3561: These methods are shortcuts to deciding if a given resource has a given property.
3562:
3563: =over 4
3564:
1.174 albertel 3565: =item * B<is_map>:
3566:
3567: Returns true if the resource is a map type.
3568:
3569: =item * B<is_problem>:
1.70 bowersj2 3570:
1.174 albertel 3571: Returns true if the resource is a problem type, false
3572: otherwise. (Looks at the extension on the src field; might need more
3573: to work correctly.)
1.70 bowersj2 3574:
1.174 albertel 3575: =item * B<is_page>:
1.70 bowersj2 3576:
1.174 albertel 3577: Returns true if the resource is a page.
3578:
3579: =item * B<is_sequence>:
3580:
3581: Returns true if the resource is a sequence.
1.70 bowersj2 3582:
3583: =back
3584:
3585: =cut
3586:
1.256 albertel 3587: sub hasResource {
3588: my $self = shift;
3589: return $self->{NAV_MAP}->hasResource(@_);
3590: }
3591:
3592: sub retrieveResources {
3593: my $self = shift;
3594: return $self->{NAV_MAP}->retrieveResources(@_);
3595: }
1.70 bowersj2 3596:
3597: sub is_html {
1.51 bowersj2 3598: my $self=shift;
3599: my $src = $self->src();
1.70 bowersj2 3600: return ($src =~ /html$/);
1.51 bowersj2 3601: }
1.70 bowersj2 3602: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
3603: sub is_page {
1.51 bowersj2 3604: my $self=shift;
3605: my $src = $self->src();
1.205 bowersj2 3606: return $self->navHash("is_map_", 1) &&
3607: $self->navHash("map_type_" . $self->map_pc()) eq 'page';
1.51 bowersj2 3608: }
1.70 bowersj2 3609: sub is_problem {
1.51 bowersj2 3610: my $self=shift;
3611: my $src = $self->src();
1.256 albertel 3612: return ($src =~ /\.(problem|exam|quiz|assess|survey|form|library)$/)
3613: }
3614: sub contains_problem {
3615: my $self=shift;
3616: if ($self->is_page()) {
3617: my $hasProblem=$self->hasResource($self,sub { $_[0]->is_problem() },1);
3618: return $hasProblem;
3619: }
3620: return 0;
1.51 bowersj2 3621: }
1.70 bowersj2 3622: sub is_sequence {
1.51 bowersj2 3623: my $self=shift;
3624: my $src = $self->src();
1.205 bowersj2 3625: return $self->navHash("is_map_", 1) &&
3626: $self->navHash("map_type_" . $self->map_pc()) eq 'sequence';
1.51 bowersj2 3627: }
1.261 matthew 3628: sub is_survey {
3629: my $self = shift();
3630: my $part = shift();
1.263 albertel 3631: if ($self->parmval('type',$part) eq 'survey') {
1.261 matthew 3632: return 1;
3633: }
1.263 albertel 3634: if ($self->src() =~ /\.(survey)$/) {
1.261 matthew 3635: return 1;
3636: }
3637: return 0;
3638: }
1.51 bowersj2 3639:
1.266 raeburn 3640: sub is_empty_sequence {
3641: my $self=shift;
3642: my $src = $self->src();
3643: return !$self->is_page() && $self->navHash("is_map_", 1) && !$self->navHash("map_type_" . $self->map_pc());
3644: }
3645:
1.101 bowersj2 3646: # Private method: Shells out to the parmval in the nav map, handler parts.
1.51 bowersj2 3647: sub parmval {
3648: my $self = shift;
3649: my $what = shift;
1.185 bowersj2 3650: my $part = shift;
3651: if (!defined($part)) {
3652: $part = '0';
3653: }
1.51 bowersj2 3654: return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
3655: }
3656:
1.70 bowersj2 3657: =pod
3658:
3659: B<Map Methods>
3660:
1.174 albertel 3661: These methods are useful for getting information about the map
3662: properties of the resource, if the resource is a map (B<is_map>).
1.70 bowersj2 3663:
3664: =over 4
3665:
1.174 albertel 3666: =item * B<map_finish>:
3667:
3668: Returns a reference to a resource object corresponding to the finish
3669: resource of the map.
1.70 bowersj2 3670:
1.174 albertel 3671: =item * B<map_pc>:
1.70 bowersj2 3672:
1.174 albertel 3673: Returns the pc value of the map, which is the first number that
3674: appears in the resource ID of the resources in the map, and is the
3675: number that appears around the middle of the symbs of the resources in
3676: that map.
1.70 bowersj2 3677:
1.174 albertel 3678: =item * B<map_start>:
3679:
3680: Returns a reference to a resource object corresponding to the start
3681: resource of the map.
3682:
3683: =item * B<map_type>:
3684:
3685: Returns a string with the type of the map in it.
1.70 bowersj2 3686:
3687: =back
1.51 bowersj2 3688:
1.70 bowersj2 3689: =cut
1.51 bowersj2 3690:
3691: sub map_finish {
3692: my $self = shift;
3693: my $src = $self->src();
1.144 bowersj2 3694: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 3695: my $res = $self->navHash("map_finish_$src", 0);
3696: $res = $self->{NAV_MAP}->getById($res);
3697: return $res;
3698: }
1.70 bowersj2 3699: sub map_pc {
3700: my $self = shift;
3701: my $src = $self->src();
3702: return $self->navHash("map_pc_$src", 0);
3703: }
1.51 bowersj2 3704: sub map_start {
3705: my $self = shift;
3706: my $src = $self->src();
1.144 bowersj2 3707: $src = Apache::lonnet::clutter($src);
1.51 bowersj2 3708: my $res = $self->navHash("map_start_$src", 0);
3709: $res = $self->{NAV_MAP}->getById($res);
3710: return $res;
3711: }
3712: sub map_type {
3713: my $self = shift;
3714: my $pc = $self->map_pc();
3715: return $self->navHash("map_type_$pc", 0);
3716: }
3717:
3718: #####
3719: # Property queries
3720: #####
3721:
3722: # These functions will be responsible for returning the CORRECT
3723: # VALUE for the parameter, no matter what. So while they may look
3724: # like direct calls to parmval, they can be more then that.
3725: # So, for instance, the duedate function should use the "duedatetype"
3726: # information, rather then the resource object user.
3727:
3728: =pod
3729:
3730: =head2 Resource Parameters
3731:
1.174 albertel 3732: In order to use the resource parameters correctly, the nav map must
3733: have been instantiated with genCourseAndUserOptions set to true, so
3734: the courseopt and useropt is read correctly. Then, you can call these
3735: functions to get the relevant parameters for the resource. Each
3736: function defaults to part "0", but can be directed to another part by
3737: passing the part as the parameter.
3738:
3739: These methods are responsible for getting the parameter correct, not
3740: merely reflecting the contents of the GDBM hashes. As we move towards
3741: dates relative to other dates, these methods should be updated to
3742: reflect that. (Then, anybody using these methods will not have to update
3743: their code.)
3744:
3745: =over 4
3746:
3747: =item * B<acc>:
3748:
3749: Get the Client IP/Name Access Control information.
1.51 bowersj2 3750:
1.174 albertel 3751: =item * B<answerdate>:
1.51 bowersj2 3752:
1.174 albertel 3753: Get the answer-reveal date for the problem.
3754:
1.211 bowersj2 3755: =item * B<awarded>:
3756:
3757: Gets the awarded value for the problem part. Requires genUserData set to
3758: true when the navmap object was created.
3759:
1.174 albertel 3760: =item * B<duedate>:
3761:
3762: Get the due date for the problem.
3763:
3764: =item * B<tries>:
3765:
3766: Get the number of tries the student has used on the problem.
3767:
3768: =item * B<maxtries>:
3769:
3770: Get the number of max tries allowed.
3771:
3772: =item * B<opendate>:
1.51 bowersj2 3773:
1.174 albertel 3774: Get the open date for the problem.
1.51 bowersj2 3775:
1.174 albertel 3776: =item * B<sig>:
1.51 bowersj2 3777:
1.174 albertel 3778: Get the significant figures setting.
1.51 bowersj2 3779:
1.174 albertel 3780: =item * B<tol>:
1.51 bowersj2 3781:
1.174 albertel 3782: Get the tolerance for the problem.
1.51 bowersj2 3783:
1.174 albertel 3784: =item * B<tries>:
1.51 bowersj2 3785:
1.174 albertel 3786: Get the number of tries the user has already used on the problem.
1.51 bowersj2 3787:
1.174 albertel 3788: =item * B<type>:
1.51 bowersj2 3789:
1.174 albertel 3790: Get the question type for the problem.
1.70 bowersj2 3791:
1.174 albertel 3792: =item * B<weight>:
1.51 bowersj2 3793:
1.174 albertel 3794: Get the weight for the problem.
1.51 bowersj2 3795:
3796: =back
3797:
3798: =cut
3799:
3800: sub acc {
3801: (my $self, my $part) = @_;
3802: return $self->parmval("acc", $part);
3803: }
3804: sub answerdate {
3805: (my $self, my $part) = @_;
3806: # Handle intervals
3807: if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
3808: return $self->duedate($part) +
3809: $self->parmval("answerdate", $part);
3810: }
3811: return $self->parmval("answerdate", $part);
1.106 bowersj2 3812: }
1.211 bowersj2 3813: sub awarded {
3814: my $self = shift; my $part = shift;
1.221 bowersj2 3815: $self->{NAV_MAP}->get_user_data();
1.211 bowersj2 3816: if (!defined($part)) { $part = '0'; }
3817: return $self->{NAV_MAP}->{STUDENT_DATA}->{$self->symb()}->{'resource.'.$part.'.awarded'};
3818: }
1.51 bowersj2 3819: sub duedate {
3820: (my $self, my $part) = @_;
1.260 albertel 3821: my $interval=$self->parmval("interval", $part);
3822: if ($interval) {
3823: my $first_access=&Apache::lonnet::get_first_access('map',$self->symb);
3824: if ($first_access) { return ($first_access+$interval); }
3825: }
1.51 bowersj2 3826: return $self->parmval("duedate", $part);
3827: }
3828: sub maxtries {
3829: (my $self, my $part) = @_;
3830: return $self->parmval("maxtries", $part);
3831: }
3832: sub opendate {
3833: (my $self, my $part) = @_;
3834: if ($self->parmval("opendate.type", $part) eq 'date_interval') {
3835: return $self->duedate($part) -
3836: $self->parmval("opendate", $part);
3837: }
3838: return $self->parmval("opendate");
3839: }
1.185 bowersj2 3840: sub problemstatus {
3841: (my $self, my $part) = @_;
1.236 bowersj2 3842: return lc $self->parmval("problemstatus", $part);
1.185 bowersj2 3843: }
1.51 bowersj2 3844: sub sig {
3845: (my $self, my $part) = @_;
3846: return $self->parmval("sig", $part);
3847: }
3848: sub tol {
3849: (my $self, my $part) = @_;
3850: return $self->parmval("tol", $part);
3851: }
1.108 bowersj2 3852: sub tries {
3853: my $self = shift;
3854: my $tries = $self->queryRestoreHash('tries', shift);
3855: if (!defined($tries)) { return '0';}
1.51 bowersj2 3856: return $tries;
3857: }
1.70 bowersj2 3858: sub type {
3859: (my $self, my $part) = @_;
3860: return $self->parmval("type", $part);
3861: }
1.109 bowersj2 3862: sub weight {
3863: my $self = shift; my $part = shift;
1.211 bowersj2 3864: if (!defined($part)) { $part = '0'; }
3865: return &Apache::lonnet::EXT('resource.'.$part.'.weight',
1.320 albertel 3866: $self->symb(), $env{'user.domain'},
3867: $env{'user.name'},
3868: $env{'request.course.sec'});
1.274 matthew 3869: }
3870: sub part_display {
3871: my $self= shift(); my $partID = shift();
3872: if (! defined($partID)) { $partID = '0'; }
3873: my $display=&Apache::lonnet::EXT('resource.'.$partID.'.display',
3874: $self->symb);
3875: if (! defined($display) || $display eq '') {
3876: $display = $partID;
3877: }
3878: return $display;
1.70 bowersj2 3879: }
1.51 bowersj2 3880:
3881: # Multiple things need this
3882: sub getReturnHash {
3883: my $self = shift;
3884:
3885: if (!defined($self->{RETURN_HASH})) {
1.84 bowersj2 3886: my %tmpHash = &Apache::lonnet::restore($self->symb());
1.51 bowersj2 3887: $self->{RETURN_HASH} = \%tmpHash;
3888: }
3889: }
3890:
3891: ######
3892: # Status queries
3893: ######
3894:
3895: # These methods query the status of problems.
3896:
3897: # If we need to count parts, this function determines the number of
3898: # parts from the metadata. When called, it returns a reference to a list
3899: # of strings corresponding to the parts. (Thus, using it in a scalar context
3900: # tells you how many parts you have in the problem:
3901: # $partcount = scalar($resource->countParts());
3902: # Don't use $self->{PARTS} directly because you don't know if it's been
3903: # computed yet.
3904:
3905: =pod
3906:
3907: =head2 Resource misc
3908:
3909: Misc. functions for the resource.
3910:
3911: =over 4
3912:
1.174 albertel 3913: =item * B<hasDiscussion>:
1.59 bowersj2 3914:
1.174 albertel 3915: Returns a false value if there has been discussion since the user last
3916: logged in, true if there has. Always returns false if the discussion
3917: data was not extracted when the nav map was constructed.
3918:
3919: =item * B<getFeedback>:
3920:
3921: Gets the feedback for the resource and returns the raw feedback string
3922: for the resource, or the null string if there is no feedback or the
3923: email data was not extracted when the nav map was constructed. Usually
3924: used like this:
1.59 bowersj2 3925:
3926: for (split(/\,/, $res->getFeedback())) {
3927: my $link = &Apache::lonnet::escape($_);
3928: ...
3929:
3930: and use the link as appropriate.
3931:
3932: =cut
3933:
3934: sub hasDiscussion {
3935: my $self = shift;
3936: return $self->{NAV_MAP}->hasDiscussion($self->symb());
3937: }
3938:
3939: sub getFeedback {
3940: my $self = shift;
1.124 bowersj2 3941: my $source = $self->src();
1.125 bowersj2 3942: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
1.124 bowersj2 3943: return $self->{NAV_MAP}->getFeedback($source);
3944: }
3945:
3946: sub getErrors {
3947: my $self = shift;
3948: my $source = $self->src();
3949: if ($source =~ /^\/res\//) { $source = substr $source, 5; }
3950: return $self->{NAV_MAP}->getErrors($source);
1.59 bowersj2 3951: }
3952:
3953: =pod
3954:
1.174 albertel 3955: =item * B<parts>():
1.51 bowersj2 3956:
1.174 albertel 3957: Returns a list reference containing sorted strings corresponding to
1.193 bowersj2 3958: each part of the problem. Single part problems have only a part '0'.
3959: Multipart problems do not return their part '0', since they typically
3960: do not really matter.
1.174 albertel 3961:
3962: =item * B<countParts>():
3963:
3964: Returns the number of parts of the problem a student can answer. Thus,
3965: for single part problems, returns 1. For multipart, it returns the
1.193 bowersj2 3966: number of parts in the problem, not including psuedo-part 0.
1.51 bowersj2 3967:
1.290 matthew 3968: =item * B<countResponses>():
3969:
3970: Returns the total number of responses in the problem a student can answer.
3971:
3972: =item * B<responseTypes>():
3973:
3974: Returns a hash whose keys are the response types. The values are the number
3975: of times each response type is used. This is for the I<entire> problem, not
3976: just a single part.
3977:
1.192 bowersj2 3978: =item * B<multipart>():
3979:
1.193 bowersj2 3980: Returns true if the problem is multipart, false otherwise. Use this instead
3981: of countParts if all you want is multipart/not multipart.
1.192 bowersj2 3982:
1.187 bowersj2 3983: =item * B<responseType>($part):
3984:
3985: Returns the response type of the part, without the word "response" on the
3986: end. Example return values: 'string', 'essay', 'numeric', etc.
3987:
1.193 bowersj2 3988: =item * B<responseIds>($part):
1.187 bowersj2 3989:
1.193 bowersj2 3990: Retreives the response IDs for the given part as an array reference containing
3991: strings naming the response IDs. This may be empty.
1.187 bowersj2 3992:
1.51 bowersj2 3993: =back
3994:
3995: =cut
3996:
3997: sub parts {
3998: my $self = shift;
3999:
1.192 bowersj2 4000: if ($self->ext) { return []; }
1.67 bowersj2 4001:
1.51 bowersj2 4002: $self->extractParts();
4003: return $self->{PARTS};
4004: }
4005:
4006: sub countParts {
4007: my $self = shift;
4008:
4009: my $parts = $self->parts();
1.191 bowersj2 4010:
4011: # If I left this here, then it's not necessary.
4012: #my $delta = 0;
4013: #for my $part (@$parts) {
4014: # if ($part eq '0') { $delta--; }
4015: #}
1.66 bowersj2 4016:
4017: if ($self->{RESOURCE_ERROR}) {
4018: return 0;
4019: }
4020:
1.191 bowersj2 4021: return scalar(@{$parts}); # + $delta;
1.192 bowersj2 4022: }
4023:
1.290 matthew 4024: sub countResponses {
4025: my $self = shift;
4026: my $count;
1.293 matthew 4027: foreach my $part (@{$self->parts()}) {
4028: $count+= scalar($self->responseIds($part));
1.290 matthew 4029: }
4030: return $count;
4031: }
4032:
4033: sub responseTypes {
4034: my $self = shift;
1.291 albertel 4035: my %responses;
1.290 matthew 4036: foreach my $part ($self->parts()) {
4037: foreach my $responsetype ($self->responseType($part)) {
1.291 albertel 4038: $responses{$responsetype}++ if (defined($responsetype));
1.290 matthew 4039: }
4040: }
1.291 albertel 4041: return %responses;
1.290 matthew 4042: }
4043:
1.192 bowersj2 4044: sub multipart {
4045: my $self = shift;
4046: return $self->countParts() > 1;
1.51 bowersj2 4047: }
4048:
1.225 bowersj2 4049: sub singlepart {
4050: my $self = shift;
4051: return $self->countParts() == 1;
4052: }
4053:
1.187 bowersj2 4054: sub responseType {
1.184 bowersj2 4055: my $self = shift;
4056: my $part = shift;
4057:
4058: $self->extractParts();
1.235 albertel 4059: if (defined($self->{RESPONSE_TYPES}->{$part})) {
4060: return @{$self->{RESPONSE_TYPES}->{$part}};
4061: } else {
4062: return undef;
4063: }
1.187 bowersj2 4064: }
4065:
1.193 bowersj2 4066: sub responseIds {
1.187 bowersj2 4067: my $self = shift;
4068: my $part = shift;
4069:
4070: $self->extractParts();
1.235 albertel 4071: if (defined($self->{RESPONSE_IDS}->{$part})) {
4072: return @{$self->{RESPONSE_IDS}->{$part}};
4073: } else {
4074: return undef;
4075: }
1.184 bowersj2 4076: }
4077:
4078: # Private function: Extracts the parts information, both part names and
1.187 bowersj2 4079: # part types, and saves it.
1.51 bowersj2 4080: sub extractParts {
4081: my $self = shift;
4082:
1.153 bowersj2 4083: return if (defined($self->{PARTS}));
1.67 bowersj2 4084: return if ($self->ext);
1.51 bowersj2 4085:
4086: $self->{PARTS} = [];
4087:
1.181 bowersj2 4088: my %parts;
4089:
1.82 bowersj2 4090: # Retrieve part count, if this is a problem
4091: if ($self->is_problem()) {
1.240 albertel 4092: my $partorder = &Apache::lonnet::metadata($self->src(), 'partorder');
1.152 matthew 4093: my $metadata = &Apache::lonnet::metadata($self->src(), 'packages');
1.181 bowersj2 4094:
1.239 bowersj2 4095: if ($partorder) {
4096: my @parts;
4097: for my $part (split (/,/,$partorder)) {
4098: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4099: push @parts, $part;
1.241 albertel 4100: $parts{$part} = 1;
1.239 bowersj2 4101: }
4102: }
4103: $self->{PARTS} = \@parts;
4104: } else {
4105: if (!$metadata) {
4106: $self->{RESOURCE_ERROR} = 1;
4107: $self->{PARTS} = [];
4108: $self->{PART_TYPE} = {};
4109: return;
4110: }
4111: foreach (split(/\,/,$metadata)) {
4112: if ($_ =~ /^part_(.*)$/) {
4113: my $part = $1;
4114: # This floods the logs if it blows up
4115: if (defined($parts{$part})) {
1.241 albertel 4116: &Apache::lonnet::logthis("$part multiply defined in metadata for " . $self->symb());
4117: }
1.239 bowersj2 4118:
4119: # check to see if part is turned off.
4120:
4121: if (!Apache::loncommon::check_if_partid_hidden($part, $self->symb())) {
4122: $parts{$part} = 1;
4123: }
4124: }
4125: }
4126: my @sortedParts = sort keys %parts;
4127: $self->{PARTS} = \@sortedParts;
1.51 bowersj2 4128: }
1.82 bowersj2 4129:
1.187 bowersj2 4130:
1.284 matthew 4131: # These hashes probably do not need names that end with "Hash"....
1.187 bowersj2 4132: my %responseIdHash;
4133: my %responseTypeHash;
4134:
1.189 bowersj2 4135:
4136: # Init the responseIdHash
4137: foreach (@{$self->{PARTS}}) {
4138: $responseIdHash{$_} = [];
4139: }
4140:
1.187 bowersj2 4141: # Now, the unfortunate thing about this is that parts, part name, and
1.239 bowersj2 4142: # response id are delimited by underscores, but both the part
1.187 bowersj2 4143: # name and response id can themselves have underscores in them.
4144: # So we have to use our knowlege of part names to figure out
4145: # where the part names begin and end, and even then, it is possible
4146: # to construct ambiguous situations.
4147: foreach (split /,/, $metadata) {
4148: if ($_ =~ /^([a-zA-Z]+)response_(.*)/) {
4149: my $responseType = $1;
4150: my $partStuff = $2;
4151: my $partIdSoFar = '';
4152: my @partChunks = split /_/, $partStuff;
4153: my $i = 0;
4154: for ($i = 0; $i < scalar(@partChunks); $i++) {
4155: if ($partIdSoFar) { $partIdSoFar .= '_'; }
4156: $partIdSoFar .= $partChunks[$i];
4157: if ($parts{$partIdSoFar}) {
4158: my @otherChunks = @partChunks[$i+1..$#partChunks];
4159: my $responseId = join('_', @otherChunks);
1.188 bowersj2 4160: push @{$responseIdHash{$partIdSoFar}}, $responseId;
1.233 matthew 4161: push @{$responseTypeHash{$partIdSoFar}}, $responseType;
1.187 bowersj2 4162: }
4163: }
4164: }
4165: }
1.264 albertel 4166: my $resorder = &Apache::lonnet::metadata($self->src(),'responseorder');
1.284 matthew 4167: #
4168: # Reorder the arrays in the %responseIdHash and %responseTypeHash
1.264 albertel 4169: if ($resorder) {
4170: my @resorder=split(/,/,$resorder);
4171: foreach my $part (keys(%responseIdHash)) {
1.286 albertel 4172: my $i=0;
4173: my %resids = map { ($_,$i++) } @{ $responseIdHash{$part} };
1.264 albertel 4174: my @neworder;
4175: foreach my $possibleid (@resorder) {
4176: if (exists($resids{$possibleid})) {
1.286 albertel 4177: push(@neworder,$resids{$possibleid});
1.264 albertel 4178: }
4179: }
1.286 albertel 4180: my @ids;
4181: my @type;
4182: foreach my $element (@neworder) {
4183: push (@ids,$responseIdHash{$part}->[$element]);
4184: push (@type,$responseTypeHash{$part}->[$element]);
4185: }
4186: $responseIdHash{$part}=\@ids;
4187: $responseTypeHash{$part}=\@type;
1.264 albertel 4188: }
4189: }
1.187 bowersj2 4190: $self->{RESPONSE_IDS} = \%responseIdHash;
4191: $self->{RESPONSE_TYPES} = \%responseTypeHash;
1.154 bowersj2 4192: }
4193:
1.51 bowersj2 4194: return;
4195: }
4196:
4197: =pod
4198:
4199: =head2 Resource Status
4200:
1.174 albertel 4201: Problem resources have status information, reflecting their various
4202: dates and completion statuses.
1.51 bowersj2 4203:
1.174 albertel 4204: There are two aspects to the status: the date-related information and
4205: the completion information.
1.51 bowersj2 4206:
1.174 albertel 4207: Idiomatic usage of these two methods would probably look something
4208: like
1.51 bowersj2 4209:
4210: foreach ($resource->parts()) {
4211: my $dateStatus = $resource->getDateStatus($_);
4212: my $completionStatus = $resource->getCompletionStatus($_);
4213:
1.70 bowersj2 4214: or
4215:
4216: my $status = $resource->status($_);
4217:
1.51 bowersj2 4218: ... use it here ...
4219: }
4220:
1.174 albertel 4221: Which you use depends on exactly what you are looking for. The
4222: status() function has been optimized for the nav maps display and may
4223: not precisely match what you need elsewhere.
1.101 bowersj2 4224:
1.174 albertel 4225: The symbolic constants shown below can be accessed through the
4226: resource object: C<$res->OPEN>.
1.101 bowersj2 4227:
1.51 bowersj2 4228: =over 4
4229:
1.174 albertel 4230: =item * B<getDateStatus>($part):
4231:
4232: ($part defaults to 0). A convenience function that returns a symbolic
4233: constant telling you about the date status of the part. The possible
4234: return values are:
1.51 bowersj2 4235:
4236: =back
4237:
4238: B<Date Codes>
4239:
4240: =over 4
4241:
1.174 albertel 4242: =item * B<OPEN_LATER>:
4243:
4244: The problem will be opened later.
4245:
4246: =item * B<OPEN>:
4247:
4248: Open and not yet due.
4249:
1.51 bowersj2 4250:
1.174 albertel 4251: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 4252:
1.174 albertel 4253: The due date has passed, but the answer date has not yet arrived.
1.59 bowersj2 4254:
1.174 albertel 4255: =item * B<PAST_DUE_NO_ANSWER>:
1.54 bowersj2 4256:
1.174 albertel 4257: The due date has passed and there is no answer opening date set.
1.51 bowersj2 4258:
1.174 albertel 4259: =item * B<ANSWER_OPEN>:
1.51 bowersj2 4260:
1.174 albertel 4261: The answer date is here.
4262:
4263: =item * B<NETWORK_FAILURE>:
4264:
4265: The information is unknown due to network failure.
1.51 bowersj2 4266:
4267: =back
4268:
4269: =cut
4270:
4271: # Apparently the compiler optimizes these into constants automatically
1.54 bowersj2 4272: sub OPEN_LATER { return 0; }
4273: sub OPEN { return 1; }
4274: sub PAST_DUE_NO_ANSWER { return 2; }
4275: sub PAST_DUE_ANSWER_LATER { return 3; }
4276: sub ANSWER_OPEN { return 4; }
4277: sub NOTHING_SET { return 5; }
4278: sub NETWORK_FAILURE { return 100; }
4279:
4280: # getDateStatus gets the date status for a given problem part.
4281: # Because answer date, due date, and open date are fully independent
4282: # (i.e., it is perfectly possible to *only* have an answer date),
4283: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
4284: # (past, future, none given). This function handles this with a decision
4285: # tree. Read the comments to follow the decision tree.
1.51 bowersj2 4286:
4287: sub getDateStatus {
4288: my $self = shift;
4289: my $part = shift;
4290: $part = "0" if (!defined($part));
1.54 bowersj2 4291:
4292: # Always return network failure if there was one.
1.51 bowersj2 4293: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4294:
4295: my $now = time();
4296:
1.53 bowersj2 4297: my $open = $self->opendate($part);
4298: my $due = $self->duedate($part);
4299: my $answer = $self->answerdate($part);
4300:
4301: if (!$open && !$due && !$answer) {
4302: # no data on the problem at all
4303: # should this be the same as "open later"? think multipart.
4304: return $self->NOTHING_SET;
4305: }
1.59 bowersj2 4306: if (!$open || $now < $open) {return $self->OPEN_LATER}
4307: if (!$due || $now < $due) {return $self->OPEN}
4308: if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
4309: if ($answer) { return $self->ANSWER_OPEN; }
1.54 bowersj2 4310: return PAST_DUE_NO_ANSWER;
1.51 bowersj2 4311: }
4312:
4313: =pod
4314:
4315: B<>
4316:
4317: =over 4
4318:
1.174 albertel 4319: =item * B<getCompletionStatus>($part):
1.51 bowersj2 4320:
1.174 albertel 4321: ($part defaults to 0.) A convenience function that returns a symbolic
4322: constant telling you about the completion status of the part, with the
4323: following possible results:
4324:
4325: =back
1.51 bowersj2 4326:
4327: B<Completion Codes>
4328:
4329: =over 4
4330:
1.174 albertel 4331: =item * B<NOT_ATTEMPTED>:
4332:
4333: Has not been attempted at all.
4334:
4335: =item * B<INCORRECT>:
4336:
4337: Attempted, but wrong by student.
1.51 bowersj2 4338:
1.174 albertel 4339: =item * B<INCORRECT_BY_OVERRIDE>:
1.51 bowersj2 4340:
1.174 albertel 4341: Attempted, but wrong by instructor override.
1.51 bowersj2 4342:
1.174 albertel 4343: =item * B<CORRECT>:
1.51 bowersj2 4344:
1.174 albertel 4345: Correct or correct by instructor.
1.51 bowersj2 4346:
1.174 albertel 4347: =item * B<CORRECT_BY_OVERRIDE>:
1.51 bowersj2 4348:
1.174 albertel 4349: Correct by instructor override.
1.51 bowersj2 4350:
1.174 albertel 4351: =item * B<EXCUSED>:
4352:
4353: Excused. Not yet implemented.
4354:
4355: =item * B<NETWORK_FAILURE>:
4356:
4357: Information not available due to network failure.
4358:
4359: =item * B<ATTEMPTED>:
4360:
4361: Attempted, and not yet graded.
1.69 bowersj2 4362:
1.51 bowersj2 4363: =back
4364:
4365: =cut
4366:
1.53 bowersj2 4367: sub NOT_ATTEMPTED { return 10; }
4368: sub INCORRECT { return 11; }
4369: sub INCORRECT_BY_OVERRIDE { return 12; }
4370: sub CORRECT { return 13; }
4371: sub CORRECT_BY_OVERRIDE { return 14; }
4372: sub EXCUSED { return 15; }
1.69 bowersj2 4373: sub ATTEMPTED { return 16; }
1.51 bowersj2 4374:
4375: sub getCompletionStatus {
4376: my $self = shift;
4377: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4378:
1.108 bowersj2 4379: my $status = $self->queryRestoreHash('solved', shift);
1.51 bowersj2 4380:
1.251 www 4381: # Left as separate if statements in case we ever do more with this
1.51 bowersj2 4382: if ($status eq 'correct_by_student') {return $self->CORRECT;}
1.288 albertel 4383: if ($status eq 'correct_by_scantron') {return $self->CORRECT;}
1.51 bowersj2 4384: if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
4385: if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
4386: if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
4387: if ($status eq 'excused') {return $self->EXCUSED; }
1.69 bowersj2 4388: if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51 bowersj2 4389: return $self->NOT_ATTEMPTED;
1.108 bowersj2 4390: }
4391:
4392: sub queryRestoreHash {
4393: my $self = shift;
4394: my $hashentry = shift;
4395: my $part = shift;
1.185 bowersj2 4396: $part = "0" if (!defined($part) || $part eq '');
1.108 bowersj2 4397: return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
4398:
4399: $self->getReturnHash();
4400:
4401: return $self->{RETURN_HASH}->{'resource.'.$part.'.'.$hashentry};
1.51 bowersj2 4402: }
4403:
4404: =pod
4405:
4406: B<Composite Status>
4407:
1.174 albertel 4408: Along with directly returning the date or completion status, the
4409: resource object includes a convenience function B<status>() that will
4410: combine the two status tidbits into one composite status that can
1.191 bowersj2 4411: represent the status of the resource as a whole. This method represents
4412: the concept of the thing we want to display to the user on the nav maps
4413: screen, which is a combination of completion and open status. The precise logic is
1.174 albertel 4414: documented in the comments of the status method. The following results
4415: may be returned, all available as methods on the resource object
1.185 bowersj2 4416: ($res->NETWORK_FAILURE): In addition to the return values that match
4417: the date or completion status, this function can return "ANSWER_SUBMITTED"
4418: if that problemstatus parameter value is set to No, suppressing the
4419: incorrect/correct feedback.
1.51 bowersj2 4420:
4421: =over 4
4422:
1.174 albertel 4423: =item * B<NETWORK_FAILURE>:
4424:
4425: The network has failed and the information is not available.
1.51 bowersj2 4426:
1.174 albertel 4427: =item * B<NOTHING_SET>:
1.53 bowersj2 4428:
1.174 albertel 4429: No dates have been set for this problem (part) at all. (Because only
4430: certain parts of a multi-part problem may be assigned, this can not be
4431: collapsed into "open later", as we do not know a given part will EVER
4432: be opened. For single part, this is the same as "OPEN_LATER".)
1.51 bowersj2 4433:
1.174 albertel 4434: =item * B<CORRECT>:
1.51 bowersj2 4435:
1.174 albertel 4436: For any reason at all, the part is considered correct.
1.54 bowersj2 4437:
1.174 albertel 4438: =item * B<EXCUSED>:
1.51 bowersj2 4439:
1.174 albertel 4440: For any reason at all, the problem is excused.
1.51 bowersj2 4441:
1.174 albertel 4442: =item * B<PAST_DUE_NO_ANSWER>:
1.51 bowersj2 4443:
1.174 albertel 4444: The problem is past due, not considered correct, and no answer date is
4445: set.
1.51 bowersj2 4446:
1.174 albertel 4447: =item * B<PAST_DUE_ANSWER_LATER>:
1.51 bowersj2 4448:
1.174 albertel 4449: The problem is past due, not considered correct, and an answer date in
4450: the future is set.
1.51 bowersj2 4451:
1.174 albertel 4452: =item * B<ANSWER_OPEN>:
4453:
4454: The problem is past due, not correct, and the answer is now available.
4455:
4456: =item * B<OPEN_LATER>:
4457:
4458: The problem is not yet open.
4459:
4460: =item * B<TRIES_LEFT>:
4461:
4462: The problem is open, has been tried, is not correct, but there are
4463: tries left.
4464:
4465: =item * B<INCORRECT>:
4466:
4467: The problem is open, and all tries have been used without getting the
4468: correct answer.
4469:
4470: =item * B<OPEN>:
4471:
4472: The item is open and not yet tried.
4473:
4474: =item * B<ATTEMPTED>:
4475:
4476: The problem has been attempted.
1.69 bowersj2 4477:
1.185 bowersj2 4478: =item * B<ANSWER_SUBMITTED>:
4479:
4480: An answer has been submitted, but the student should not see it.
4481:
1.51 bowersj2 4482: =back
4483:
4484: =cut
4485:
1.185 bowersj2 4486: sub TRIES_LEFT { return 20; }
4487: sub ANSWER_SUBMITTED { return 21; }
1.51 bowersj2 4488:
4489: sub status {
4490: my $self = shift;
4491: my $part = shift;
4492: if (!defined($part)) { $part = "0"; }
4493: my $completionStatus = $self->getCompletionStatus($part);
4494: my $dateStatus = $self->getDateStatus($part);
4495:
4496: # What we have is a two-dimensional matrix with 4 entries on one
4497: # dimension and 5 entries on the other, which we want to colorize,
1.54 bowersj2 4498: # plus network failure and "no date data at all".
1.51 bowersj2 4499:
1.222 bowersj2 4500: #if ($self->{RESOURCE_ERROR}) { return NETWORK_FAILURE; }
1.53 bowersj2 4501: if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51 bowersj2 4502:
1.236 bowersj2 4503: my $suppressFeedback = $self->problemstatus($part) eq 'no';
4504: # If there's an answer date and we're past it, don't
4505: # suppress the feedback; student should know
1.330 albertel 4506: if ($self->duedate($part) && $self->duedate($part) < time() &&
4507: $self->answerdate($part) && $self->answerdate($part) < time()) {
1.236 bowersj2 4508: $suppressFeedback = 0;
4509: }
1.185 bowersj2 4510:
1.51 bowersj2 4511: # There are a few whole rows we can dispose of:
1.53 bowersj2 4512: if ($completionStatus == CORRECT ||
4513: $completionStatus == CORRECT_BY_OVERRIDE ) {
1.185 bowersj2 4514: return $suppressFeedback? ANSWER_SUBMITTED : CORRECT;
1.69 bowersj2 4515: }
4516:
4517: if ($completionStatus == ATTEMPTED) {
4518: return ATTEMPTED;
1.53 bowersj2 4519: }
4520:
4521: # If it's EXCUSED, then return that no matter what
4522: if ($completionStatus == EXCUSED) {
4523: return EXCUSED;
1.51 bowersj2 4524: }
4525:
1.53 bowersj2 4526: if ($dateStatus == NOTHING_SET) {
4527: return NOTHING_SET;
1.51 bowersj2 4528: }
4529:
1.69 bowersj2 4530: # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
4531: # by 4 matrix (date statuses).
1.51 bowersj2 4532:
1.54 bowersj2 4533: if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59 bowersj2 4534: $dateStatus == PAST_DUE_NO_ANSWER ) {
1.272 albertel 4535: return $suppressFeedback ? ANSWER_SUBMITTED : $dateStatus;
1.51 bowersj2 4536: }
4537:
1.53 bowersj2 4538: if ($dateStatus == ANSWER_OPEN) {
4539: return ANSWER_OPEN;
1.51 bowersj2 4540: }
4541:
4542: # Now: (incorrect, incorrect_override, not_attempted) x
4543: # (open_later), (open)
4544:
1.53 bowersj2 4545: if ($dateStatus == OPEN_LATER) {
4546: return OPEN_LATER;
1.51 bowersj2 4547: }
4548:
4549: # If it's WRONG...
1.53 bowersj2 4550: if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51 bowersj2 4551: # and there are TRIES LEFT:
1.79 bowersj2 4552: if ($self->tries($part) < $self->maxtries($part) || !$self->maxtries($part)) {
1.222 bowersj2 4553: return $suppressFeedback ? ANSWER_SUBMITTED : TRIES_LEFT;
1.51 bowersj2 4554: }
1.185 bowersj2 4555: return $suppressFeedback ? ANSWER_SUBMITTED : INCORRECT; # otherwise, return orange; student can't fix this
1.51 bowersj2 4556: }
4557:
4558: # Otherwise, it's untried and open
1.53 bowersj2 4559: return OPEN;
1.224 bowersj2 4560: }
4561:
4562: sub CLOSED { return 23; }
4563: sub ERROR { return 24; }
4564:
4565: =pod
4566:
4567: B<Simple Status>
4568:
4569: Convenience method B<simpleStatus> provides a "simple status" for the resource.
4570: "Simple status" corresponds to "which icon is shown on the
4571: Navmaps". There are six "simple" statuses:
4572:
4573: =over 4
4574:
4575: =item * B<CLOSED>: The problem is currently closed. (No icon shown.)
4576:
4577: =item * B<OPEN>: The problem is open and unattempted.
4578:
4579: =item * B<CORRECT>: The problem is correct for any reason.
4580:
4581: =item * B<INCORRECT>: The problem is incorrect and can still be
4582: completed successfully.
4583:
4584: =item * B<ATTEMPTED>: The problem has been attempted, but the student
4585: does not know if they are correct. (The ellipsis icon.)
4586:
4587: =item * B<ERROR>: There is an error retrieving information about this
4588: problem.
4589:
4590: =back
4591:
4592: =cut
4593:
4594: # This hash maps the composite status to this simple status, and
4595: # can be used directly, if you like
4596: my %compositeToSimple =
4597: (
4598: NETWORK_FAILURE() => ERROR,
4599: NOTHING_SET() => CLOSED,
4600: CORRECT() => CORRECT,
4601: EXCUSED() => CORRECT,
4602: PAST_DUE_NO_ANSWER() => INCORRECT,
4603: PAST_DUE_ANSWER_LATER() => INCORRECT,
4604: ANSWER_OPEN() => INCORRECT,
4605: OPEN_LATER() => CLOSED,
4606: TRIES_LEFT() => OPEN,
4607: INCORRECT() => INCORRECT,
4608: OPEN() => OPEN,
4609: ATTEMPTED() => ATTEMPTED,
4610: ANSWER_SUBMITTED() => ATTEMPTED
4611: );
4612:
4613: sub simpleStatus {
4614: my $self = shift;
4615: my $part = shift;
4616: my $status = $self->status($part);
4617: return $compositeToSimple{$status};
1.225 bowersj2 4618: }
4619:
4620: =pod
4621:
4622: B<simpleStatusCount> will return an array reference containing, in
4623: this order, the number of OPEN, CLOSED, CORRECT, INCORRECT, ATTEMPTED,
4624: and ERROR parts the given problem has.
4625:
4626: =cut
4627:
4628: # This maps the status to the slot we want to increment
4629: my %statusToSlotMap =
4630: (
4631: OPEN() => 0,
4632: CLOSED() => 1,
4633: CORRECT() => 2,
4634: INCORRECT() => 3,
4635: ATTEMPTED() => 4,
4636: ERROR() => 5
4637: );
4638:
4639: sub statusToSlot { return $statusToSlotMap{shift()}; }
4640:
4641: sub simpleStatusCount {
4642: my $self = shift;
4643:
4644: my @counts = (0, 0, 0, 0, 0, 0, 0);
4645: foreach my $part (@{$self->parts()}) {
4646: $counts[$statusToSlotMap{$self->simpleStatus($part)}]++;
4647: }
4648:
4649: return \@counts;
1.191 bowersj2 4650: }
4651:
4652: =pod
4653:
4654: B<Completable>
4655:
4656: The completable method represents the concept of I<whether the student can
4657: currently do the problem>. If the student can do the problem, which means
4658: that it is open, there are tries left, and if the problem is manually graded
4659: or the grade is suppressed via problemstatus, the student has not tried it
4660: yet, then the method returns 1. Otherwise, it returns 0, to indicate that
4661: either the student has tried it and there is no feedback, or that for
4662: some reason it is no longer completable (not open yet, successfully completed,
4663: out of tries, etc.). As an example, this is used as the filter for the
4664: "Uncompleted Homework" option for the nav maps.
4665:
4666: If this does not quite meet your needs, do not fiddle with it (unless you are
4667: fixing it to better match the student's conception of "completable" because
4668: it's broken somehow)... make a new method.
4669:
4670: =cut
4671:
4672: sub completable {
4673: my $self = shift;
4674: if (!$self->is_problem()) { return 0; }
4675: my $partCount = $self->countParts();
4676:
4677: foreach my $part (@{$self->parts()}) {
4678: if ($part eq '0' && $partCount != 1) { next; }
4679: my $status = $self->status($part);
4680: # "If any of the parts are open, or have tries left (implies open),
4681: # and it is not "attempted" (manually graded problem), it is
4682: # not "complete"
1.216 bowersj2 4683: if ($self->getCompletionStatus($part) == ATTEMPTED() ||
4684: $status == ANSWER_SUBMITTED() ) {
4685: # did this part already, as well as we can
4686: next;
4687: }
4688: if ($status == OPEN() || $status == TRIES_LEFT()) {
4689: return 1;
4690: }
1.191 bowersj2 4691: }
4692:
4693: # If all the parts were complete, so was this problem.
1.216 bowersj2 4694: return 0;
1.51 bowersj2 4695: }
4696:
4697: =pod
4698:
4699: =head2 Resource/Nav Map Navigation
4700:
4701: =over 4
4702:
1.174 albertel 4703: =item * B<getNext>():
4704:
4705: Retreive an array of the possible next resources after this
4706: one. Always returns an array, even in the one- or zero-element case.
4707:
4708: =item * B<getPrevious>():
1.85 bowersj2 4709:
1.174 albertel 4710: Retreive an array of the possible previous resources from this
4711: one. Always returns an array, even in the one- or zero-element case.
1.51 bowersj2 4712:
4713: =cut
4714:
4715: sub getNext {
4716: my $self = shift;
4717: my @branches;
4718: my $to = $self->to();
1.85 bowersj2 4719: foreach my $branch ( split(/,/, $to) ) {
1.51 bowersj2 4720: my $choice = $self->{NAV_MAP}->getById($branch);
1.301 albertel 4721: if (!$choice->condition()) { next; }
1.51 bowersj2 4722: my $next = $choice->goesto();
4723: $next = $self->{NAV_MAP}->getById($next);
4724:
1.131 bowersj2 4725: push @branches, $next;
1.85 bowersj2 4726: }
4727: return \@branches;
4728: }
4729:
4730: sub getPrevious {
4731: my $self = shift;
4732: my @branches;
4733: my $from = $self->from();
4734: foreach my $branch ( split /,/, $from) {
4735: my $choice = $self->{NAV_MAP}->getById($branch);
4736: my $prev = $choice->comesfrom();
4737: $prev = $self->{NAV_MAP}->getById($prev);
4738:
1.131 bowersj2 4739: push @branches, $prev;
1.51 bowersj2 4740: }
4741: return \@branches;
1.131 bowersj2 4742: }
4743:
4744: sub browsePriv {
4745: my $self = shift;
4746: if (defined($self->{BROWSE_PRIV})) {
4747: return $self->{BROWSE_PRIV};
4748: }
4749:
1.311 albertel 4750: $self->{BROWSE_PRIV} = &Apache::lonnet::allowed('bre',$self->src(),
4751: $self->symb());
1.51 bowersj2 4752: }
4753:
4754: =pod
1.2 www 4755:
1.51 bowersj2 4756: =back
1.2 www 4757:
1.51 bowersj2 4758: =cut
1.2 www 4759:
1.51 bowersj2 4760: 1;
1.2 www 4761:
1.51 bowersj2 4762: __END__
1.2 www 4763:
4764:
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