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

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

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