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