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