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