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

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

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