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