Annotation of loncom/interface/lonnavmaps.pm, revision 1.326

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>