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

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

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