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