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

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

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