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

1.72      bowersj2    1: 
1.2       www         2: # The LearningOnline Network with CAPA
                      3: # Navigate Maps Handler
1.1       www         4: #
1.76      bowersj2    5: # $Id: lonnavmaps.pm,v 1.75 2002/10/11 21:34:42 bowersj2 Exp $
1.20      albertel    6: #
                      7: # Copyright Michigan State University Board of Trustees
                      8: #
                      9: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                     10: #
                     11: # LON-CAPA is free software; you can redistribute it and/or modify
                     12: # it under the terms of the GNU General Public License as published by
                     13: # the Free Software Foundation; either version 2 of the License, or
                     14: # (at your option) any later version.
                     15: #
                     16: # LON-CAPA is distributed in the hope that it will be useful,
                     17: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     18: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     19: # GNU General Public License for more details.
                     20: #
                     21: # You should have received a copy of the GNU General Public License
                     22: # along with LON-CAPA; if not, write to the Free Software
                     23: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     24: #
                     25: # /home/httpd/html/adm/gpl.txt
                     26: #
                     27: # http://www.lon-capa.org/
                     28: #
1.2       www        29: # (Page Handler
1.1       www        30: #
1.2       www        31: # (TeX Content Handler
1.1       www        32: #
1.2       www        33: # 05/29/00,05/30 Gerd Kortemeyer)
                     34: # 08/30,08/31,09/06,09/14,09/15,09/16,09/19,09/20,09/21,09/23,
                     35: # 10/02,10/10,10/14,10/16,10/18,10/19,10/31,11/6,11/14,11/16 Gerd Kortemeyer)
1.1       www        36: #
1.17      www        37: # 3/1/1,6/1,17/1,29/1,30/1,2/8,9/21,9/24,9/25 Gerd Kortemeyer
1.21      www        38: # YEAR=2002
                     39: # 1/1 Gerd Kortemeyer
                     40: #
1.2       www        41: 
1.1       www        42: package Apache::lonnavmaps;
                     43: 
                     44: use strict;
1.2       www        45: use Apache::Constants qw(:common :http);
                     46: use Apache::lonnet();
1.18      albertel   47: use Apache::loncommon();
1.2       www        48: use GDBM_File;
1.73      bowersj2   49: use POSIX qw (floor strftime);
1.2       www        50: 
                     51: # -------------------------------------------------------------- Module Globals
                     52: my %hash;
                     53: my @rows;
                     54: 
1.10      www        55: #
                     56: # These cache hashes need to be independent of user, resource and course
                     57: # (user and course can/should be in the keys)
                     58: #
                     59: 
                     60: my %courserdatas;
                     61: my %userrdatas;
                     62: 
                     63: #
                     64: # These global hashes are dependent on user, course and resource, 
                     65: # and need to be initialized every time when a sheet is calculated
                     66: #
                     67: my %courseopt;
                     68: my %useropt;
                     69: my %parmhash;
                     70: 
1.47      bowersj2   71: # This parameter keeps track of whether obtaining the user's information
                     72: # failed, which the colorizer in astatus can use
                     73: my $networkFailedFlag = 0;
                     74: 
1.2       www        75: # ------------------------------------------------------------------ Euclid gcd
                     76: 
                     77: sub euclid {
                     78:     my ($e,$f)=@_;
                     79:     my $a; my $b; my $r;
                     80:     if ($e>$f) { $b=$e; $r=$f; } else { $r=$e; $b=$f; }
                     81:     while ($r!=0) {
1.51      bowersj2   82:         $a=$b; $b=$r;
1.2       www        83:         $r=$a%$b;
                     84:     }
                     85:     return $b;
                     86: }
                     87: 
1.10      www        88: # --------------------------------------------------------------------- Parmval
                     89: 
                     90: # -------------------------------------------- Figure out a cascading parameter
                     91: #
                     92: # For this function to work
                     93: #
                     94: # * parmhash needs to be tied
                     95: # * courseopt and useropt need to be initialized for this user and course
                     96: #
                     97: 
                     98: sub parmval {
                     99:     my ($what,$symb)=@_;
                    100:     my $cid=$ENV{'request.course.id'};
                    101:     my $csec=$ENV{'request.course.sec'};
                    102:     my $uname=$ENV{'user.name'};
                    103:     my $udom=$ENV{'user.domain'};
                    104: 
                    105:     unless ($symb) { return ''; }
                    106:     my $result='';
                    107: 
                    108:     my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
                    109: 
                    110: # ----------------------------------------------------- Cascading lookup scheme
1.24      albertel  111:     my $rwhat=$what;
                    112:     $what=~s/^parameter\_//;
                    113:     $what=~s/\_/\./;
                    114: 
                    115:     my $symbparm=$symb.'.'.$what;
                    116:     my $mapparm=$mapname.'___(all).'.$what;
                    117:     my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
                    118: 
                    119:     my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
                    120:     my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
                    121:     my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
                    122: 
                    123:     my $courselevel= $usercourseprefix.'.'.$what;
                    124:     my $courselevelr=$usercourseprefix.'.'.$symbparm;
                    125:     my $courselevelm=$usercourseprefix.'.'.$mapparm;
                    126: 
                    127: # ---------------------------------------------------------- first, check user
1.57      albertel  128:     if (defined($uname)) {
                    129:         if (defined($useropt{$courselevelr})) { return $useropt{$courselevelr}; }
                    130:         if (defined($useropt{$courselevelm})) { return $useropt{$courselevelm}; }
                    131:         if (defined($useropt{$courselevel})) { return $useropt{$courselevel}; }
1.24      albertel  132:     }
1.10      www       133: 
1.24      albertel  134: # ------------------------------------------------------- second, check course
1.57      albertel  135:     if (defined($csec)) {
                    136:         if (defined($courseopt{$seclevelr})) { return $courseopt{$seclevelr}; }
                    137:         if (defined($courseopt{$seclevelm})) { return $courseopt{$seclevelm}; }
                    138:         if (defined($courseopt{$seclevel})) { return $courseopt{$seclevel}; }
1.24      albertel  139:     }
1.10      www       140: 
1.57      albertel  141:     if (defined($courseopt{$courselevelr})) { return $courseopt{$courselevelr}; }
                    142:     if (defined($courseopt{$courselevelm})) { return $courseopt{$courselevelm}; }
                    143:     if (defined($courseopt{$courselevel})) { return $courseopt{$courselevel}; }
1.10      www       144: 
1.24      albertel  145: # ----------------------------------------------------- third, check map parms
1.10      www       146: 
1.24      albertel  147:     my $thisparm=$parmhash{$symbparm};
1.57      albertel  148:     if (defined($thisparm)) { return $thisparm; }
1.10      www       149: 
1.24      albertel  150: # ----------------------------------------------------- fourth , check default
1.10      www       151: 
1.25      albertel  152:     my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1.57      albertel  153:     if (defined($default)) { return $default}
1.25      albertel  154: 
                    155: # --------------------------------------------------- fifth , cascade up parts
                    156: 
                    157:     my ($space,@qualifier)=split(/\./,$rwhat);
                    158:     my $qualifier=join('.',@qualifier);
                    159:     unless ($space eq '0') {
1.51      bowersj2  160:         my ($part,$id)=split(/\_/,$space);
                    161:         if ($id) {
                    162:             my $partgeneral=&parmval($part.".$qualifier",$symb);
1.57      albertel  163:             if (defined($partgeneral)) { return $partgeneral; }
1.51      bowersj2  164:         } else {
                    165:             my $resourcegeneral=&parmval("0.$qualifier",$symb);
1.57      albertel  166:             if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51      bowersj2  167:         }
1.25      albertel  168:     }
                    169:     return '';
1.10      www       170: }
                    171: 
                    172: 
                    173: 
1.9       www       174: # ------------------------------------------------------------- Find out status
1.25      albertel  175: # return codes
                    176: # tcode (timecode)
                    177: # 1: will open later
                    178: # 2: is open and not past due yet
                    179: # 3: is past due date
                    180: # 4: due in the next 24 hours
                    181: #
                    182: # code (curent solved status)
                    183: # 1: not attempted
                    184: # 2: attempted but wrong, or incorrect by instructor
                    185: # 3: solved or correct by instructor
1.29      albertel  186: # 4: partially correct (one or more parts correct)
                    187: # "excused" needs to be supported, but is not yet.
1.9       www       188: sub astatus {
                    189:     my $rid=shift;
1.29      albertel  190:     my $code=0;
1.9       www       191:     my $ctext='';
                    192:     $rid=~/(\d+)\.(\d+)/;
1.10      www       193:     my $symb=&Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.
1.51      bowersj2  194:         &Apache::lonnet::declutter($hash{'src_'.$rid});
1.15      www       195:     my %duedate=();
                    196:     my %opendate=();
                    197:     my %answerdate=();
1.25      albertel  198:     # need to always check part 0's open/due/answer status
1.51      bowersj2  199:     foreach (sort(split(/\,/,&Apache::lonnet::metadata($hash{'src_'.$rid},'allpo\ssiblekeys')))) {
1.15      www       200:         if ($_=~/^parameter\_(.*)\_opendate$/) {
1.51      bowersj2  201:             my $part=$1;
1.15      www       202:             $duedate{$part}=&parmval($part.'.duedate',$symb);
                    203:             $opendate{$part}=&parmval($part.'.opendate',$symb);
                    204:             $answerdate{$part}=&parmval($part.'.answerdate',$symb);
1.49      www       205:             if (&parmval($part.'.opendate.type',$symb) eq 'date_interval') {
1.51      bowersj2  206:                 $opendate{$part}=$duedate{$part}-$opendate{$part};
1.49      www       207:             }
1.50      www       208:             if (&parmval($part.'.answerdate.type',$symb) eq 'date_interval') {
1.49      www       209:                 $answerdate{$part}=$duedate{$part}+$answerdate{$part};
                    210:             }
1.15      www       211:         }
1.25      albertel  212:     }
1.11      www       213:     my $now=time;
                    214:     my $tcode=0;
1.16      www       215: 
                    216:     my %returnhash=&Apache::lonnet::restore($symb);
                    217: 
1.25      albertel  218:     foreach (sort(keys(%opendate))) {
1.51      bowersj2  219:         my $duedate=$duedate{$_};
                    220:         my $opendate=$opendate{$_};
                    221:         my $answerdate=$answerdate{$_};
                    222:         my $preface='';
                    223:         unless ($_ eq '0') { $preface=' Part: '.$_.' '; }
                    224:         if ($opendate) {
                    225:             if ($now<$duedate || (!$duedate)) {
                    226:                 unless ($tcode==4) { $tcode=2; }
                    227:                 if ($duedate) {
                    228:                     $ctext.=$preface.'Due: '.localtime($duedate);
                    229:                 } else {
                    230:                     $ctext.=$preface.'No Due Date';
                    231:                 }
                    232:                 if ($now<$opendate) {
                    233:                     unless ($tcode) { $tcode=1; }
                    234:                     $ctext.=$preface.'Open: '.localtime($opendate);
                    235:                 }
                    236:                 if ($duedate && $duedate-$now<86400) {
                    237:                     $tcode=4;
                    238:                     $ctext.=$preface.'Due: '.localtime($duedate);
                    239:                 }
                    240:             } else {
                    241:                 unless (($tcode==4) || ($tcode eq 2)) { $tcode=3; }
                    242:                 if ($now<$answerdate) {
                    243:                     $ctext.='Answer: '.localtime($duedate);
                    244:                 }
                    245:             }
                    246:         } else {
                    247:             unless (($tcode==2) || ($tcode==4)) { $tcode=1; }
                    248:         }
                    249:         
                    250:         my $status=$returnhash{'resource.'.$_.'.solved'};
                    251:         
                    252:         if ($status eq 'correct_by_student') {
                    253:             if ($code==0||$code==3) { $code=3; } else { $code=4; }
                    254:             $ctext.=' solved';
                    255:         } elsif ($status eq 'correct_by_override') {
                    256:             if ($code==0||$code==3) { $code=3; } else { $code=4; }
                    257:             $ctext.=' override';
                    258:         } elsif ($status eq 'incorrect_attempted') {
                    259:             if ($code!=4 && $code!=3) { $code=2; }
                    260:             if ($code==3) { $code=4; }
                    261:             $ctext.=' ('.
                    262:                 ($returnhash{'resource.'.$_.'.tries'}?
                    263:                  $returnhash{'resource.'.$_.'.tries'}:'0');
                    264:             my $numtries = &parmval($_.'.maxtries',$symb);
                    265:             if ($numtries) { $ctext.='/'.$numtries.' tries'; }
                    266:             $ctext.=')';
                    267:         } elsif ($status eq 'incorrect_by_override') {
                    268:             if ($code!=4 && $code!=3) { $code=2; }
                    269:             if ($code==3) { $code=4; }
                    270:             $ctext.=' override';
                    271:         } elsif ($status eq 'excused') {
                    272:             if ($code==0||$code==3) { $code=3; } else { $code=4; }
                    273:             $ctext.=' excused';
                    274:         } else {
                    275:             if ($code==0) { $code=1; }
                    276:         }
1.25      albertel  277:     }
1.16      www       278: 
1.11      www       279:     return 'p'.$code.$tcode.'"'.$ctext.'"';
1.9       www       280: }
                    281: 
1.2       www       282: 
1.31      albertel  283: sub addresource {
1.32      albertel  284:     my ($resource,$sofar,$rid,$showtypes,$indent,$linkid)=@_;
1.31      albertel  285:     if ($showtypes eq 'problems') {
1.51      bowersj2  286:         if ($resource!~/\.(problem|exam|quiz|assess|survey|form)$/) {
                    287:             return;
                    288:         }
1.31      albertel  289:     }
                    290:     my $brepriv=&Apache::lonnet::allowed('bre',$resource);
                    291:     if ($hash{'src_'.$rid}) {
1.51      bowersj2  292:         if (($brepriv eq '2') || ($brepriv eq 'F')) {
                    293:             my $pprefix='';
                    294:             if ($resource=~/\.(problem|exam|quiz|assess|survey|form)$/) {
                    295:                 $pprefix=&astatus($rid);
                    296:             }
                    297:             $$sofar++;
                    298:             if ($indent) { $pprefix='i'.$indent.','.$pprefix; }
                    299:             if ($linkid) { $pprefix='l'.$linkid.','.$pprefix; }
                    300:             if (defined($rows[$$sofar])) {
                    301:                 $rows[$$sofar].='&'.$pprefix.$rid;
                    302:             } else {
                    303:                 $rows[$$sofar]=$pprefix.$rid;
                    304:             }
                    305:         }
1.31      albertel  306:     }
                    307: }
                    308: 
                    309: sub followlinks () {
1.32      albertel  310:     my ($rid,$sofar,$beenhere,$further,$showtypes,$indent,$linkid)=@_;
1.31      albertel  311:     my $mincond=1;
                    312:     my $next='';
                    313:     foreach (split(/\,/,$hash{'to_'.$rid})) {
1.51      bowersj2  314:         my $thiscond=
                    315:             &Apache::lonnet::directcondval($hash{'condid_'.$hash{'undercond_'.$_}});
                    316:         if ($thiscond>=$mincond) {
                    317:             if ($next) {
                    318:                 $next.=','.$_.':'.$thiscond;
                    319:             } else {
                    320:                 $next=$_.':'.$thiscond;
                    321:             }
                    322:             if ($thiscond>$mincond) { $mincond=$thiscond; }
                    323:         }
1.31      albertel  324:     }
1.32      albertel  325:     my $col=0;
                    326:     &Apache::lonxml::debug("following links -$next-");
1.31      albertel  327:     foreach (split(/\,/,$next)) {
1.51      bowersj2  328:         my ($nextlinkid,$condval)=split(/\:/,$_);
                    329:         if ($condval>=$mincond) {
                    330:             my $now=&tracetable($sofar,$hash{'goesto_'.$nextlinkid},
                    331:                                 $beenhere,$showtypes,$indent,$linkid);
                    332:             if ($now>$further) {                
                    333:                 if ($col>0) {
                    334:                     my $string;
                    335:                     for(my $i=0;$i<$col;$i++) { $string.='&'; }
                    336:                     for(my $i=$further+1;$now-1>$i;$i++) {
                    337:                         $rows[$i]=$string.$rows[$i];
                    338:                     }
                    339:                 }
                    340:                 $further=$now;
                    341:             }
                    342:         }
                    343:         $col++;
1.31      albertel  344:     }
                    345:     return $further;
                    346: }
                    347: # ------------------------------------------------------------ Build page table
                    348: 
                    349: sub tracetable {
1.32      albertel  350:     my ($sofar,$rid,$beenhere,$showtypes,$indent,$linkid)=@_;
                    351:     my $newshowtypes=$showtypes;
1.31      albertel  352:     my $further=$sofar;
1.44      www       353: # $Apache::lonxml::debug=1;
1.32      albertel  354:     &Apache::lonxml::debug("$rid ; $linkid ; $sofar ; $beenhere ; ".$hash{'src_'.$rid});
                    355:     if ($beenhere=~/\&$rid\&/) { return $further; }
                    356:     $beenhere.=$rid.'&';
1.31      albertel  357: 
                    358:     if (defined($hash{'is_map_'.$rid})) {
1.51      bowersj2  359:         $sofar++;
                    360:         my $tprefix='';
                    361:         if ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
                    362:             eq 'sequence') {
                    363:             $tprefix='h';
                    364:         } elsif ($hash{'map_type_'.$hash{'map_pc_'.$hash{'src_'.$rid}}}
                    365:                  eq 'page') {
                    366:             $tprefix='j';
                    367:             if ($indent) { $tprefix='i'.$indent.','.$tprefix; }
                    368:             if ($linkid) { $tprefix='l'.$linkid.','.$tprefix; }
                    369:             $newshowtypes='problems';
                    370:             $indent++;
                    371:             #if in a .page continue to link the encompising .page
                    372:             if (!$linkid) { $linkid=$rid; }
                    373:         }
                    374:         if (defined($rows[$sofar])) {
                    375:             $rows[$sofar].='&'.$tprefix.$rid;
                    376:         } else {
                    377:             $rows[$sofar]=$tprefix.$rid;
                    378:         }
                    379:         if ((defined($hash{'map_start_'.$hash{'src_'.$rid}})) &&
                    380:             (defined($hash{'map_finish_'.$hash{'src_'.$rid}}))) {
                    381:             my $frid=$hash{'map_finish_'.$hash{'src_'.$rid}};
                    382:             $sofar=&tracetable($sofar,$hash{'map_start_'.$hash{'src_'.$rid}},
                    383:                                '&'.$frid.'&',$newshowtypes,$indent,$linkid);
                    384:             &addresource($hash{'src_'.$frid},\$sofar,$frid,$newshowtypes,
                    385:                          $indent,$linkid);
                    386:             if ($tprefix =~ /j$/) { $indent--; $linkid=''; }
                    387:         }
1.31      albertel  388:     } else {
1.51      bowersj2  389:         &addresource($hash{'src_'.$rid},\$sofar,$rid,$showtypes,
                    390:                      $indent,$linkid);
1.31      albertel  391:     }
                    392: 
                    393:     if (defined($hash{'to_'.$rid})) {
1.51      bowersj2  394:         $further=&followlinks($rid,$sofar,$beenhere,$further,$showtypes,
                    395:                               $indent,$linkid);
1.2       www       396:     }
1.31      albertel  397: 
1.2       www       398:     return $further;
                    399: }
                    400: 
                    401: # ================================================================ Main Handler
1.1       www       402: 
                    403: sub handler {
1.28      albertel  404:     my $r=shift;
1.2       www       405: 
1.51      bowersj2  406:     &Apache::loncommon::get_unprocessed_cgi($ENV{QUERY_STRING});
                    407: 
                    408:     if ($ENV{'form.jtest'} ne "1")
                    409:     {
                    410:         return new_handle($r);
                    411:     }
1.2       www       412: 
                    413: # ------------------------------------------- Set document type for header only
                    414: 
1.28      albertel  415:     if ($r->header_only) {
1.51      bowersj2  416:         if ($ENV{'browser.mathml'}) {
                    417:             $r->content_type('text/xml');
                    418:         } else {
                    419:             $r->content_type('text/html');
                    420:         }
                    421:         $r->send_http_header;
                    422:         return OK;
1.28      albertel  423:     }
                    424:     my $requrl=$r->uri;
                    425:     my $hashtied;
1.2       www       426: # ----------------------------------------------------------------- Tie db file
1.28      albertel  427:     my $fn;
                    428:     if ($ENV{'request.course.fn'}) {
1.51      bowersj2  429:         $fn=$ENV{'request.course.fn'};
                    430:         if (-e "$fn.db") {
                    431:             if ((tie(%hash,'GDBM_File',"$fn.db",&GDBM_READER(),0640)) &&
                    432:                 (tie(%parmhash,'GDBM_File',
                    433:                      $ENV{'request.course.fn'}.'_parms.db',
                    434:                      &GDBM_READER(),0640))) {
                    435:                 $hashtied=1;
                    436:             }
                    437:         }
1.28      albertel  438:     }
                    439:     if (!$hashtied) {
1.51      bowersj2  440:         $ENV{'user.error.msg'}="$requrl:bre:0:0:Course not initialized";
                    441:         return HTTP_NOT_ACCEPTABLE; 
1.28      albertel  442:     }
                    443: 
1.2       www       444: # ------------------------------------------------------------------- Hash tied
1.28      albertel  445: 
                    446:     if ($ENV{'browser.mathml'}) {
1.51      bowersj2  447:         $r->content_type('text/xml');
1.28      albertel  448:     } else {
1.51      bowersj2  449:         $r->content_type('text/html');
1.28      albertel  450:     }
                    451:     &Apache::loncommon::no_cache($r);
                    452:     $r->send_http_header;
                    453: 
1.42      www       454:     my $firstres=$hash{'map_start_'.
                    455:            &Apache::lonnet::clutter($ENV{'request.course.uri'})};
                    456:     my $lastres=$hash{'map_finish_'.
                    457:            &Apache::lonnet::clutter($ENV{'request.course.uri'})};
1.28      albertel  458:     if (!(($firstres) && ($lastres))) {
1.51      bowersj2  459:         $r->print('<html><body>Coursemap undefined.</body></html>');
1.28      albertel  460:     } else {
                    461: 
1.2       www       462: # ----------------------------------------------------------------- Render page
1.10      www       463: # -------------------------------------------------------------- Set parameters
                    464: 
                    465: 
                    466: # ---------------------------- initialize coursedata and userdata for this user
1.51      bowersj2  467:         undef %courseopt;
                    468:         undef %useropt;
1.10      www       469: 
1.51      bowersj2  470:         my $uname=$ENV{'user.name'};
                    471:         my $udom=$ENV{'user.domain'};
                    472:         my $uhome=$ENV{'user.home'};
                    473:         my $cid=$ENV{'request.course.id'};
                    474:         my $chome=$ENV{'course.'.$cid.'.home'};
                    475:         my ($cdom,$cnum)=split(/\_/,$cid);
                    476: 
                    477:         my $userprefix=$uname.'_'.$udom.'_';
                    478:         
                    479:         unless ($uhome eq 'no_host') { 
1.48      bowersj2  480: # ------------------------------------------------- Get coursedata (if present)
1.51      bowersj2  481:             unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
                    482:                 my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
                    483:                                                  ':resourcedata',$chome);
                    484:                 if ($reply!~/^error\:/) {
                    485:                     $courserdatas{$cid}=$reply;
                    486:                     $courserdatas{$cid.'.last_cache'}=time;
                    487:                 }
                    488:                 # check to see if network failed
                    489:                 elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
                    490:                 {
                    491:                     $networkFailedFlag = 1;
                    492:                 }
                    493:             }
                    494:             foreach (split(/\&/,$courserdatas{$cid})) {
                    495:                 my ($name,$value)=split(/\=/,$_);
                    496:                 $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
                    497:                     &Apache::lonnet::unescape($value);
                    498:             }
1.10      www       499: # --------------------------------------------------- Get userdata (if present)
1.51      bowersj2  500:             unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
                    501:                 my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
                    502:                 if ($reply!~/^error\:/) {
                    503:                     $userrdatas{$uname.'___'.$udom}=$reply;
                    504:                     $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
                    505:                 }
                    506:             }
                    507:             foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
                    508:                 my ($name,$value)=split(/\=/,$_);
                    509:                 $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
                    510:                     &Apache::lonnet::unescape($value);
                    511:             }
                    512:         }
1.28      albertel  513: 
1.51      bowersj2  514:         @rows=();
1.28      albertel  515: 
1.51      bowersj2  516:         &tracetable(0,$firstres,'&','',0);
1.2       www       517: 
                    518: # ------------------------------------------------------------------ Page parms
                    519: 
1.51      bowersj2  520:         my $j;
                    521:         my $i;
                    522:         my $lcm=1;
                    523:         my $contents=0;
1.2       www       524: 
                    525: # ---------------------------------------------- Go through table to get layout
                    526: 
1.51      bowersj2  527:         for ($i=0;$i<=$#rows;$i++) {
                    528:             if ($rows[$i]) {
                    529:                 &Apache::lonxml::debug("Row $i is:".$rows[$i]);
                    530:                 $contents++;
                    531:                 my @colcont=split(/\&/,$rows[$i]);
                    532:                 $lcm*=($#colcont+1)/euclid($lcm,($#colcont+1));
                    533:             } 
                    534:         }
1.5       www       535: 
1.2       www       536: 
1.51      bowersj2  537:         unless ($contents) {
                    538:             $r->print('<html><body>Empty Map.</body></html>');
                    539:         } else {
1.10      www       540: 
1.2       www       541: # ------------------------------------------------------------------ Build page
                    542: 
1.51      bowersj2  543:             my $currenturl=$ENV{'form.postdata'};
                    544:             $currenturl=~s/^http\:\/\///;
                    545:             $currenturl=~s/^[^\/]+//;
1.13      www       546: 
1.2       www       547: # ---------------------------------------------------------------- Send headers
                    548: 
1.51      bowersj2  549:             my $date=localtime;
                    550:             my $now=time;
1.21      www       551: # ----------------------------------------- Get email status and discussiontime
                    552: 
1.51      bowersj2  553:             my %emailstatus=&Apache::lonnet::dump('email_status');
                    554:             my $logouttime=$emailstatus{'logout'};
                    555:             my $courseleave=$emailstatus{'logout_'.$ENV{'request.course.id'}};
                    556:             my $lastcheck=($courseleave>$logouttime?$courseleave:$logouttime);
                    557: 
                    558:             my %discussiontimes=&Apache::lonnet::dump('discussiontimes',
                    559:                                                           $cdom,$cnum);
                    560: 
                    561:             my %feedback=();
                    562:             my %error=();
                    563:             foreach my $msgid (split(/\&/,&Apache::lonnet::reply('keys:'.
                    564:                                                                  $ENV{'user.domain'}.':'.
                    565:                                                                  $ENV{'user.name'}.':nohist_email',
                    566:                                                                  $ENV{'user.home'}))) {
                    567:                 $msgid=&Apache::lonnet::unescape($msgid);
                    568:                 my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
                    569:                 if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
                    570:                     my ($what,$url)=($1,$2);
                    571:                     my %status=
                    572:                         &Apache::lonnet::get('email_status',[$msgid]);
                    573:                     if ($status{$msgid}=~/^error\:/) { 
                    574:                         $status{$msgid}=''; 
                    575:                     }
                    576:                         
                    577:                     if (($status{$msgid} eq 'new') || 
                    578:                         (!$status{$msgid})) { 
                    579:                         if ($what eq 'Error') {
                    580:                             $error{$url}.=','.$msgid; 
                    581:                         } else {
                    582:                             $feedback{$url}.=','.$msgid;
                    583:                         }
                    584:                     }
                    585:                 }
                    586:             }
1.22      www       587: # ----------------------------------------------------------- Start Page Output
1.43      www       588:             my $bodytagadd='';
1.51      bowersj2  589:             $r->print(
1.43      www       590:                    '<html><head><title>Navigate Course Map</title></head>');
1.51      bowersj2  591:             if (($currenturl=~/^\/res/) &&
                    592:                 ($currenturl!~/^\/res\/adm/)) {
                    593:                 $bodytagadd='onLoad="window.location.hash='."'curloc'".'"';
                    594:             }
                    595:             $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
1.43      www       596:                                                   $bodytagadd));
1.51      bowersj2  597:             $r->print('<script>window.focus();</script>');
                    598:             my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
                    599:             if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
                    600:             $r->print("<h3>$date</h3>\n");
                    601:             $r->rflush();
                    602:             $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
                    603:                       localtime($lastcheck).
                    604:                       '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 
                    605:             if (($currenturl=~/^\/res/) &&
                    606:                 ($currenturl!~/^\/res\/adm/)) {
                    607:                 $r->print('<a href="#curloc">Current Location</a><p>');
                    608:             }
                    609: 
                    610:             # Handle a network error
                    611: 
                    612:             if ($networkFailedFlag)
                    613:             {
                    614:                 $r->print('<H2>LON-CAPA network failure.</H2>'."\n");
                    615:                 $r->print("<p>LON-CAPA's network is having difficulties, some problem" .
                    616:                           " information, such as due dates, will not be available.");
                    617:             }
1.13      www       618: # ----------------------------------------------------- The little content list
1.51      bowersj2  619:             for ($i=0;$i<=$#rows;$i++) {
                    620:                 if ($rows[$i]) {
                    621:                     my @colcont=split(/\&/,$rows[$i]);
                    622:                     my $avespan=$lcm/($#colcont+1);
                    623:                     for ($j=0;$j<=$#colcont;$j++) {
                    624:                         my $rid=$colcont[$j];
                    625:                         if ($rid=~/^h(.+)/) {
                    626:                             $rid=$1;
                    627:                             $r->print('&nbsp;&nbsp;&nbsp;<a href="#'.
                    628:                                       $rid.'">'.$hash{'title_'.$rid}.
                    629:                                       '</a><br>');
                    630:                         }
                    631:                     }
                    632:                 }
                    633:             }
1.2       www       634: # ----------------------------------------------------------------- Start table
1.51      bowersj2  635:             $r->print('<hr><table cols="'.$lcm.'" border="0">');
                    636:             for ($i=0;$i<=$#rows;$i++) {
                    637:                 if ($rows[$i]) {
                    638:                     $r->print("\n<tr>");
                    639:                     my @colcont=split(/\&/,$rows[$i]);
                    640:                     my $avespan=$lcm/($#colcont+1);
                    641: 
                    642:                     # for each item I wish to print on this row...
                    643:                     for ($j=0;$j<=$#colcont;$j++) {
                    644:                         my $indent;my $indentstr;
                    645:                         my $linkid;
                    646:                         my $rid=$colcont[$j];
1.36      www       647:                         $rid=~/(\d+)\.(\d+)$/;
1.51      bowersj2  648:                         my $src=
                    649:                            &Apache::lonnet::declutter($hash{'src_'.$1.'.'.$2});
                    650:                         my $symb=
                    651:           &Apache::lonnet::declutter($hash{'map_id_'.$1}).'___'.$2.'___'.$src;
                    652:                         my $add='<td>';
                    653:                         my $adde='</td>';
                    654:                         my $hwk='<font color="#223322">';
                    655:                         my $hwke='</font>';
                    656:                         if ($rid=~/^l(\d+\.\d+),(.+)/) { $linkid=$1; $rid=$2; }
                    657:                         if ($rid=~/^i(\d+),(.+)/) { $indent=$1; $rid=$2; }
                    658:                         if ($rid=~/^h(.+)/) {
                    659:                             $rid=$1;
                    660:                             $add='<th bgcolor="#AAFF55"><a name="'.$rid.'">';
                    661:                             $adde='</th>';
1.36      www       662:                             if (($ENV{'user.adv'}) && 
1.51      bowersj2  663:                                 ($parmhash{$symb.'.0.parameter_randompick'})) {
1.36      www       664:                                $adde=' (randomly select '.
1.51      bowersj2  665:                                    $parmhash{$symb.'.0.parameter_randompick'}.
1.36      www       666:                                    ')</th>';
                    667:                             }
1.51      bowersj2  668:                         }
                    669:                         if ($rid=~/^j(.+)/) { $rid=$1; }
                    670:                         if ($rid=~/^p(\d)(\d)\"([\w\: \(\)\/\,]*)\"(.+)/) {
                    671:                             # sub astatus describes what code/tcode mean
                    672:                             my $code=$1;
                    673:                             my $tcode=$2;
                    674:                             my $ctext=$3;
                    675:                             $rid=$4;
                    676:                             
                    677:                             # will open later
                    678:                             if ($tcode eq '1') { 
                    679:                                 $add='<td bgcolor="#AAAAAA">';
                    680:                             }
                    681: 
                    682:                             # solved/correct
                    683:                             if ($code eq '3') {
                    684:                                 $add='<td bgcolor="#AAFFAA">';
                    685:                             } elsif ($code eq '4') { # partially correct
                    686:                                 $add='<td bgcolor="#E0FFAA">';
                    687:                             } else {
                    688:                                 # not attempted
                    689:                                 
                    690:                                 # we end up here on network failure, so pick a neutral
                    691:                                 # color if the network failed instead of bright red.
                    692:                                 if ( $networkFailedFlag )
                    693:                                 {
                    694:                                     $add = '<td bgcolor="#AAAAAA">';
                    695:                                 }
                    696:                                 else
                    697:                                 {
                    698:                                     $add='<td bgcolor="#FFAAAA">';
                    699:                                 }
                    700: 
                    701:                                 if ($tcode eq '2') { # open, not past due
                    702:                                     $add='<td bgcolor="#FFFFAA">';
                    703:                                 }
                    704: 
                    705:                                 if ($tcode eq '4') { # due in next 24 hours
                    706:                                     $add='<td bgcolor="#FFFF33">';
                    707:                                     $adde='</td>';
                    708:                                 }
                    709:                             }
                    710:                             $hwk='<font color="#888811"><b>';
                    711:                             $hwke='</b></font>';
                    712:                             if ($code eq '1') {
                    713:                                 $hwke='</b> ('.$ctext.')</font>';
                    714:                             }
                    715:                             if ($code eq '2' || $code eq '4') {
                    716:                                 $hwk='<font color="#992222"><b>';
                    717:                                 $hwke='</b> ('.$ctext.')</font>';
                    718:                             }
                    719:                             if ($code eq '3') {
                    720:                                 $hwk='<font color="#229922"><b>';
                    721:                                 $hwke='</b> ('.$ctext.')</font>';
                    722:                             }
                    723:                             if ($networkFailedFlag) 
                    724:                             {
                    725:                                 $hwke='</b> (status unavailable)</font>';
                    726:                             }
                    727:                         }
                    728:                         if ($rid && $hash{'src_'.$rid} eq $currenturl) {
                    729:                             $add=$add.'<a name="curloc"></a>'.
                    730:                                 '<font color=red size=+2><b>&gt; </b></font>';
                    731:                             $adde=
                    732:                                 '<font color=red size=+2><b> &lt;</b></font>'.$adde;
                    733:                         }
                    734:                         if ($discussiontimes{$symb}>$lastcheck) {
                    735:                             $adde=
                    736:                                 '<img border=0 src="/adm/lonMisc/chat.gif">'.
                    737:                                     $adde;
                    738:                         }
                    739:                         if ($error{$src}) {
                    740:                             foreach (split(/\,/,$error{$src})) {
                    741:                                 if ($_) {
                    742:                                     $adde=
                    743:                                         '&nbsp;<a href="/adm/email?display='.
                    744:                                             &Apache::lonnet::escape($_).
                    745:                                                 '"><img src="/adm/lonMisc/bomb.gif" border=0></a>'
                    746:                                                     .$adde;
                    747:                                 }
                    748:                             }
                    749:                         }
                    750:                         if ($feedback{$src}) {
                    751:                             foreach (split(/\,/,$feedback{$src})) {
                    752:                                 if ($_) {
                    753:                                     $adde=
                    754:                                         '&nbsp;<a href="/adm/email?display='.
                    755:                                             &Apache::lonnet::escape($_).
                    756:                                                 '"><img src="/adm/lonMisc/feedback.gif" border=0></a>'
                    757:                                                     .$adde;
                    758:                                 }
                    759:                             }
                    760:                         }
                    761:                         if ($indent) {
                    762:                             my $is="&nbsp;&nbsp;";
                    763:                             for(my $i=-1;$i<$indent;$i++) { $indentstr.=$is; }
                    764:                         }
                    765:                         if (!$linkid) { $linkid=$rid; }
1.38      www       766:                         if ($hash{'randomout_'.$rid}) {
                    767:                             $adde=' <i>(hidden)</i>'.$adde;
                    768:                         }
1.51      bowersj2  769:                         $r->print($add.$indentstr);
                    770:                         if ($rid) {
                    771:                             $r->print('<a href="'.$hash{'src_'.$linkid}.
1.39      www       772:                                       (($hash{'src_'.$linkid}=~/\?/)?'&':'?').
                    773:                                       'symb='.&Apache::lonnet::escape($symb)
1.35      www       774:                                        .'">'.
1.51      bowersj2  775:                                       $hwk.$hash{'title_'.$rid}.$hwke.'</a>');
                    776:                         }
                    777:                         $r->print($adde);
                    778:                     }
                    779:                     $r->print('</tr>');
                    780:                 }
                    781:             }
                    782:             $r->print("\n</table>");
                    783:             $r->print('</body></html>');
1.2       www       784: # -------------------------------------------------------------------- End page
1.51      bowersj2  785:         }                  
1.2       www       786: # ------------------------------------------------------------- End render page
1.28      albertel  787:     }
1.2       www       788: # ------------------------------------------------------------------ Untie hash
1.28      albertel  789:     unless (untie(%hash)) {
1.51      bowersj2  790:         &Apache::lonnet::logthis("<font color=blue>WARNING: ".
                    791:                                  "Could not untie coursemap $fn (browse).</font>"); 
1.28      albertel  792:     }
                    793:     unless (untie(%parmhash)) {
1.51      bowersj2  794:         &Apache::lonnet::logthis("<font color=blue>WARNING: ".
                    795:                                  "Could not untie parmhash (browse).</font>"); 
1.28      albertel  796:     }
                    797:     return OK;
1.2       www       798: }
1.1       www       799: 
1.51      bowersj2  800: sub new_handle {
                    801:     my $r = shift;
                    802: 
                    803:     # Handle header-only request
                    804:     if ($r->header_only) {
                    805:         if ($ENV{'browser.mathml'}) {
                    806:             $r->content_type('text/xml');
                    807:         } else {
                    808:             $r->content_type('text/html');
                    809:         }
                    810:         $r->send_http_header;
                    811:         return OK;
                    812:     }
                    813: 
                    814:     # Send header, don't cache this page
                    815:     if ($ENV{'browser.mathml'}) {
                    816:         $r->content_type('text/xml');
                    817:     } else {
                    818:         $r->content_type('text/html');
                    819:     }
                    820:     &Apache::loncommon::no_cache($r);
                    821:     $r->send_http_header;
                    822: 
                    823:     # Initialize the nav map
                    824:     my $navmap = Apache::lonnavmaps::navmap->new(
                    825:                         $ENV{"request.course.fn"}.".db",
                    826:                         $ENV{"request.course.fn"}."_parms.db", 1);
                    827: 
1.55      bowersj2  828: 
                    829:     if (!defined($navmap)) {
                    830:         my $requrl = $r->uri;
                    831:         $ENV{'user.error.msg'} = "$requrl:bre:0:0:Course not initialized";
                    832:         return HTTP_NOT_ACCEPTABLE;
                    833:     }
1.64      bowersj2  834: 
                    835:     # Header
                    836:     $r->print(&Apache::loncommon::bodytag('Navigate Course Map','',
                    837:                                           ''));
                    838:     $r->print('<script>window.focus();</script>');
                    839:     my $desc=$ENV{'course.'.$ENV{'request.course.id'}.'.description'};
                    840:     if (defined($desc)) { $r->print("<h2>$desc</h2>\n"); }
                    841:     my $date=localtime;
                    842:     $r->print("<h3>$date</h3>\n");
                    843:     $r->rflush();
1.65      bowersj2  844:     if ($navmap->{LAST_CHECK}) {
1.66      bowersj2  845:         $r->print('<img src="/adm/lonMisc/chat.gif"> New discussion since '.
1.73      bowersj2  846:                   strftime("%A, %b %e at %I:%M %P", localtime($navmap->{LAST_CHECK})).
1.66      bowersj2  847:                   '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 
1.65      bowersj2  848:     } else {
1.66      bowersj2  849:         $r->print('<img src="/adm/lonMisc/chat.gif"> Discussions'.
                    850:                   '<br><img src="/adm/lonMisc/feedback.gif"> New message (click to open)<p>'); 
1.65      bowersj2  851:     }
1.64      bowersj2  852:     #if (($currenturl=~/^\/res/) &&
                    853:     #    ($currenturl!~/^\/res\/adm/)) {
                    854:     #    $r->print('<a href="#curloc">Current Location</a><p>');
                    855:     #}
1.55      bowersj2  856: 
                    857:     # Check that it's defined
                    858:     if (!($navmap->courseMapDefined())) {
                    859:         $r->print('<font size="+2" color="red">Coursemap undefined.</font>' .
                    860:                   '</body></html>');
                    861:         return OK;
                    862:     }
                    863: 
1.51      bowersj2  864:     # Grab a resource object so we have access to the constants; this
                    865:     # is technically not proper, but should be harmless
                    866:     my $res = $navmap->firstResource();
                    867: 
                    868:     # Defines a status->color mapping, null string means don't color
                    869:     my %colormap = 
1.54      bowersj2  870:     ( $res->NETWORK_FAILURE        => '',
1.59      bowersj2  871:       $res->CORRECT                => '',
1.54      bowersj2  872:       $res->EXCUSED                => '#BBBBFF',
1.59      bowersj2  873:       $res->PAST_DUE_ANSWER_LATER  => '',
                    874:       $res->PAST_DUE_NO_ANSWER     => '',
                    875:       $res->ANSWER_OPEN            => '#CCFFCC',
1.54      bowersj2  876:       $res->OPEN_LATER             => '',
1.59      bowersj2  877:       $res->TRIES_LEFT             => '',
                    878:       $res->INCORRECT              => '',
                    879:       $res->OPEN                   => '',
1.54      bowersj2  880:       $res->NOTHING_SET            => ''        );
1.59      bowersj2  881:     # And a special case in the nav map; what to do when the assignment
                    882:     # is not yet done and due in less then 24 hours
                    883:     my $hurryUpColor = "#FFCCCC";
                    884: 
                    885:     my %statusIconMap = 
1.66      bowersj2  886:         ( $res->NETWORK_FAILURE    => '',
                    887:           $res->NOTHING_SET        => '',
                    888:           $res->CORRECT            => 'navmap.correct.gif',
                    889:           $res->EXCUSED            => 'navmap.correct.gif',
                    890:           $res->PAST_DUE_NO_ANSWER => 'navmap.wrong.gif',
                    891:           $res->PAST_DUE_ANSWER_LATER => 'navmap.wrong.gif',
                    892:           $res->ANSWER_OPEN        => 'navmap.wrong.gif',
                    893:           $res->OPEN_LATER         => '',
                    894:           $res->TRIES_LEFT         => 'navmap.open.gif',
                    895:           $res->INCORRECT          => 'navmap.wrong.gif',
1.69      bowersj2  896:           $res->OPEN               => 'navmap.open.gif',
                    897:           $res->ATTEMPTED          => '' );
                    898: 
                    899:     my %iconAltTags = 
                    900:         ( 'navmap.correct.gif' => 'Correct',
                    901:           'navmap.wrong.gif'   => 'Incorrect',
                    902:           'navmap.open.gif'    => 'Open' );
1.59      bowersj2  903: 
                    904:     my %condenseStatuses =
1.66      bowersj2  905:         ( $res->NETWORK_FAILURE    => 1,
                    906:           $res->NOTHING_SET        => 1,
                    907:           $res->CORRECT            => 1 );
1.51      bowersj2  908: 
                    909:     my %filterHash;
                    910:     # Figure out what we're not displaying
                    911:     foreach (split(/\,/, $ENV{"form.filter"})) {
                    912:         if ($_) {
                    913:             $filterHash{$_} = "1";
                    914:         }
                    915:     }
                    916: 
1.63      bowersj2  917:     my $currenturl = $ENV{'form.postdata'};
                    918:     $currenturl=~s/^http\:\/\///;
                    919:     $currenturl=~s/^[^\/]+//;
1.75      bowersj2  920:     # alreadyHere allows us to only open the maps necessary to view
                    921:     # the current location once, while at the same time remembering
                    922:     # the current location. Without that check, the user would never
                    923:     # be able to close those maps; the user would close it, and the
                    924:     # currenturl scan would re-open it.
                    925:     my $queryAdd = "postdata=" . &Apache::lonnet::escape($currenturl) .
                    926:         "&alreadyHere=1";
1.63      bowersj2  927: 
1.66      bowersj2  928:     $r->print('<a href="navmaps?condition=1&filter=">Show All Resources</a><br /><br />');
1.63      bowersj2  929: 
1.51      bowersj2  930:     # Begin the HTML table
1.59      bowersj2  931:     # four cols: resource + indent, chat+feedback, icon, text string
1.51      bowersj2  932:     $r->print('<table cellspacing="3" cellpadding="0" bgcolor="#FFFFFF">' ."\n");
                    933: 
1.66      bowersj2  934:     my $condition = 0;
                    935:     if ($ENV{'form.condition'}) {
1.68      bowersj2  936:         $condition = 1;
1.66      bowersj2  937:     }
                    938: 
1.74      bowersj2  939:     # This needs to be updated to use symbs from the remote, 
                    940:     # instead of uris. The changes to this and the main rendering
                    941:     # loop should be obvious.
                    942:     # Here's a simple example of the iterator.
                    943:     # If there is a current resource
1.75      bowersj2  944:     if ($currenturl && !$ENV{'form.alreadyHere'}) {
1.74      bowersj2  945:         # Give me every resource...
                    946:         my $mapIterator = $navmap->getIterator(undef, undef, {}, 1);
                    947:         my $found != 0;
                    948:         my $depth = 1;
                    949:         $mapIterator->next(); # discard the first BEGIN_MAP
                    950:         my $curRes = $mapIterator->next();
                    951:         
                    952:         while ($depth > 0 && !$found) {
                    953:             if (ref($curRes) && $curRes->src() eq $currenturl) {
                    954:                 # If this is the correct resource, be sure to 
                    955:                 # show it by making sure the containing maps
                    956:                 # are open.
                    957: 
                    958:                 my $mapStack = $mapIterator->getStack();
                    959:                 for my $map (@{$mapStack}) {
                    960:                     if ($condition) {
                    961:                         undef $filterHash{$map->map_pc()};
                    962:                     } else {
                    963:                         $filterHash{$map->map_pc()} = 1;
                    964:                     }
                    965:                 }
                    966:                 $found = 1;
                    967:             }
                    968:             $curRes = $mapIterator->next();
                    969:         }
                    970:     }
                    971: 
1.53      bowersj2  972:     undef $res; # so we don't accidentally use it later
1.72      bowersj2  973:     my $indentLevel = 0;
1.61      bowersj2  974:     my $indentString = "<img src=\"/adm/lonIcons/whitespace1.gif\" width=\"25\" height=\"1\" alt=\"\" border=\"0\" />";
1.51      bowersj2  975: 
                    976:     my $isNewBranch = 0;
1.59      bowersj2  977:     my $now = time();
                    978:     my $in24Hours = $now + 24 * 60 * 60;
1.72      bowersj2  979:     my $depth = 1;
                    980: 
                    981:     # We know the first thing is a BEGIN_MAP (see "$self->{STARTED}"
                    982:     # code in iterator->next), so ignore the first one
1.74      bowersj2  983:     my $mapIterator = $navmap->getIterator(undef, undef, \%filterHash,
                    984:                                            $condition);
1.72      bowersj2  985:     $mapIterator->next();
                    986:     my $curRes = $mapIterator->next();
1.51      bowersj2  987: 
1.72      bowersj2  988:     while ($depth > 0) {
1.51      bowersj2  989:         if ($curRes == $mapIterator->BEGIN_MAP() ||
1.52      bowersj2  990:             $curRes == $mapIterator->BEGIN_BRANCH()) {
1.51      bowersj2  991:             $indentLevel++;
                    992:         }
                    993:         if ($curRes == $mapIterator->END_MAP() ||
1.52      bowersj2  994:             $curRes == $mapIterator->END_BRANCH()) {
1.51      bowersj2  995:             $indentLevel--;
                    996:         }
1.52      bowersj2  997:         if ($curRes == $mapIterator->BEGIN_BRANCH()) {
                    998:             $isNewBranch = 1;
1.72      bowersj2  999:         }
                   1000:         if ($curRes == $mapIterator->BEGIN_MAP()) {
                   1001:             $depth++;
                   1002:         }
                   1003:         if ($curRes == $mapIterator->END_MAP()) {
                   1004:             $depth--;
1.51      bowersj2 1005:         }
                   1006: 
1.68      bowersj2 1007:         # Is this resource being blotted out?
                   1008:         if (ref($curRes) && !advancedUser() && $curRes->randomout()) {
                   1009:             $curRes = $mapIterator->next();
                   1010:             next; # and totally ignore this resource
                   1011:         }
                   1012: 
1.51      bowersj2 1013:         if (ref($curRes) && $curRes->src()) {
                   1014: 
1.66      bowersj2 1015:             # Step one: Decide which parts to show
                   1016:             my @parts = @{$curRes->parts()};
                   1017:             my $multipart = scalar(@parts) > 1;
                   1018:             my $condensed = 0;
                   1019:                 
1.51      bowersj2 1020:             if ($curRes->is_problem()) {
1.66      bowersj2 1021:                 # Is it multipart?
1.59      bowersj2 1022: 
1.66      bowersj2 1023:                 if ($multipart) {
                   1024:                     # If it's multipart, see if part 0 is "open"
                   1025:                     # if it is, display all parts, if it isn't,
                   1026:                     # just display first
                   1027:                     if (!$curRes->opendate("0")) {
                   1028:                         @parts = ("0"); # just display the zero-th part
1.68      bowersj2 1029:                         $condensed = 1;
1.66      bowersj2 1030:                     } else {
                   1031:                         # Otherwise, only display part 0 if we want to 
                   1032:                         # attach feedback or email information to it
                   1033:                         if ($curRes->hasDiscussion() || $curRes->getFeedback()) {
                   1034:                             shift @parts;
                   1035:                         } else {
                   1036:                             # If there's discussion or feedback, that counts
                   1037:                             # as a difference, so display the parts.
                   1038:                             
                   1039:                             # Now, we decide whether to condense the
                   1040:                             # parts due to similarity
                   1041:                             my $status = $curRes->status($parts[1]);
                   1042:                             my $due = $curRes->duedate($parts[1]);
                   1043:                             my $open = $curRes->opendate($parts[1]);
                   1044:                             my $statusAllSame = 1;
                   1045:                             my $dueAllSame = 1;
                   1046:                             my $openAllSame = 1;
                   1047:                             for (my $i = 2; $i < scalar(@parts); $i++) {
                   1048:                                 if ($curRes->status($parts[$i]) != $status){
                   1049:                                     $statusAllSame = 0;
                   1050:                                 }
                   1051:                                 if ($curRes->duedate($parts[$i]) != $due ) {
                   1052:                                     $dueAllSame = 0;
                   1053:                                 }
                   1054:                                 if ($curRes->opendate($parts[$i]) != $open) {
                   1055:                                     $openAllSame = 0;
                   1056:                                 }
                   1057:                             }
                   1058:                             
                   1059:                             # $allSame is true if all the statuses were
                   1060:                             # the same. Now, if they are all the same and
                   1061:                             # match one of the statuses to condense, or they
                   1062:                             # are all open with the same due date, or they are
                   1063:                             # all OPEN_LATER with the same open date, display the
                   1064:                             # status of the first non-zero part (to get the 'correct'
                   1065:                             # status right, since 0 is never 'correct' or 'open').
                   1066:                             if (($statusAllSame && defined($condenseStatuses{$status})) ||
                   1067:                                 ($dueAllSame && $status == $curRes->OPEN && $statusAllSame)||
                   1068:                                 ($openAllSame && $status == $curRes->OPEN_LATER && $statusAllSame) ){
                   1069:                                 @parts = ($parts[1]);
                   1070:                                 $condensed = 1;
                   1071:                             }
                   1072:                         }
                   1073:                     }
                   1074:                 }
1.59      bowersj2 1075: 
1.51      bowersj2 1076:             } else {
                   1077:                 @parts[0] = "0"; # this is to get past foreach loop below
                   1078:                  # you can consider a non-problem resource as a resource
1.77    ! bowersj2 1079:                   # with only one part without loss
1.51      bowersj2 1080:             }
                   1081: 
1.66      bowersj2 1082:             # Display one part, in event of network error.
                   1083:             # If this is a single part, we can at least show the correct
                   1084:             # status, but if it's multipart, we're lost.
                   1085:             if ($curRes->{RESOURCE_ERROR}) {
                   1086:                 @parts = ("0");
                   1087:             }
                   1088: 
                   1089:             # Step two: Show the parts
1.51      bowersj2 1090:             foreach my $part (@parts) {
1.59      bowersj2 1091: 
1.66      bowersj2 1092:                 my $deltalevel = 0; # for inserting the branch icon
1.68      bowersj2 1093:                 my $nonLinkedText = ""; # unlinked stuff after title
1.51      bowersj2 1094:                 
                   1095:                 # For each thing we're displaying...
                   1096: 
                   1097:                 my $stack = $mapIterator->getStack();
                   1098:                 my $src = getLinkForResource($stack);
                   1099: 
                   1100:                 my $srcHasQuestion = $src =~ /\?/;
                   1101:                 my $link = $src.
                   1102:                     ($srcHasQuestion?'&':'?') .
                   1103:                     'symb='.&Apache::lonnet::escape($curRes->symb()).
                   1104:                     '"';
                   1105:                 my $title = $curRes->title();
                   1106:                 my $partLabel = "";
1.52      bowersj2 1107:                 my $newBranchText = "";
                   1108: 
                   1109:                 # If this is a new branch, label it so
                   1110:                 # (temporary, this should be an icon w/ alt text)
                   1111:                 if ($isNewBranch) {
1.59      bowersj2 1112:                     $newBranchText = "<img src=\"/adm/lonIcons/branch.gif\" border=\"0\">";
1.52      bowersj2 1113:                     $isNewBranch = 0;
1.66      bowersj2 1114:                     $deltalevel = 1;
1.52      bowersj2 1115:                 }
1.51      bowersj2 1116: 
                   1117:                 # links to open and close the folders
                   1118:                 my $linkopen = "<a href=\"$link\">";
                   1119:                 my $linkclose = "</a>";
                   1120: 
1.61      bowersj2 1121:                 my $icon = "<img src=\"/adm/lonIcons/html.gif\" alt=\"\" border=\"0\" />";
1.51      bowersj2 1122:                 if ($curRes->is_problem()) { 
1.66      bowersj2 1123:                     if ($part eq "0" || $condensed) {
                   1124:                         $icon = '<img src="/adm/lonIcons/problem.gif" alt="" border=\"0\" />'; 
                   1125:                     } else {
                   1126:                         $icon = $indentString;
                   1127:                     }
1.51      bowersj2 1128:                 }
                   1129: 
                   1130:                 # Display the correct icon, link to open or shut map
                   1131:                 if ($curRes->is_map()) { 
                   1132:                     my $mapId = $curRes->map_pc();
                   1133:                     my $nowOpen = !defined($filterHash{$mapId});
                   1134:                     $icon = $nowOpen ?
1.77    ! bowersj2 1135:                         "navmap.folder.closed.gif" : "navmap.folder.open.gif";
1.66      bowersj2 1136:                     $icon = "<img src=\"/adm/lonIcons/$icon\" alt=\"\" border=\"0\" />";
1.52      bowersj2 1137:                     $linkopen = "<a href=\"/adm/navmaps?filter=";
1.66      bowersj2 1138:                     $linkopen .= ($nowOpen xor $condition) ? 
1.51      bowersj2 1139:                         addToFilter(\%filterHash, $mapId) :
                   1140:                         removeFromFilter(\%filterHash, $mapId);
1.66      bowersj2 1141:                     $linkopen .= "&condition=$condition&$queryAdd\">";
1.51      bowersj2 1142:                     $linkclose = "</a>";
1.68      bowersj2 1143: 
1.51      bowersj2 1144:                 }
                   1145:                 
                   1146:                 my $colorizer = "";
                   1147:                 if ($curRes->is_problem()) {
                   1148:                     my $status = $curRes->status($part);
                   1149:                     my $color = $colormap{$status};
1.74      bowersj2 1150: 
                   1151:                     # Special case in the navmaps: If in less then
                   1152:                     # 24 hours, give it a bit of urgency
1.76      bowersj2 1153:                     if ($status == $curRes->OPEN() && $curRes->duedate() &&
                   1154:                         $curRes->duedate() < time()+(24*60*60) && 
                   1155:                         $curRes->duedate() > time()) {
1.74      bowersj2 1156:                         $color = $hurryUpColor;
                   1157:                     }
1.51      bowersj2 1158:                     if ($color ne "") {
                   1159:                         $colorizer = "bgcolor=\"$color\"";
                   1160:                     }
                   1161:                 }
                   1162: 
1.68      bowersj2 1163:                 if ($curRes->randomout()) {
                   1164:                     $nonLinkedText .= ' <i>(hidden)</i> ';
                   1165:                 }
                   1166: 
1.66      bowersj2 1167:                 # FIRST COL: The resource indentation, branch icon, and name
1.77    ! bowersj2 1168:                 $r->print("  <tr><td align=\"left\" valign=\"center\">\n");
1.51      bowersj2 1169: 
                   1170:                 # print indentation
1.59      bowersj2 1171:                 for (my $i = 0; $i < $indentLevel - $deltalevel; $i++) {
1.51      bowersj2 1172:                     $r->print($indentString);
                   1173:                 }
                   1174: 
1.61      bowersj2 1175:                 $r->print("  ${newBranchText}${linkopen}$icon${linkclose}\n");
1.51      bowersj2 1176: 
1.74      bowersj2 1177:                 my $curMarkerBegin = "";
                   1178:                 my $curMarkerEnd = "";
                   1179: 
                   1180:                 # Is this the current resource?
                   1181:                 if ($curRes->src() eq $currenturl) {
                   1182:                     $curMarkerBegin = '<a name="curloc" /><font color="red" size="+2">&gt; </font>';
                   1183:                     $curMarkerEnd = '<font color="red" size="+2"> &lt;</font>';
                   1184:                 }
                   1185: 
1.69      bowersj2 1186:                 if ($curRes->is_problem() && $part ne "0" && !$condensed) { 
1.66      bowersj2 1187:                     $partLabel = " (Part $part)"; 
                   1188:                     $title = "";
                   1189:                 }
                   1190:                 if ($multipart && $condensed) {
1.68      bowersj2 1191:                     $nonLinkedText .= ' (' . $curRes->countParts() . ' parts)';
1.66      bowersj2 1192:                 }
1.59      bowersj2 1193: 
1.74      bowersj2 1194:                 $r->print("  $curMarkerBegin<a href=\"$link\">$title$partLabel</a> $curMarkerEnd $nonLinkedText");
1.66      bowersj2 1195: 
                   1196:                 if ($curRes->{RESOURCE_ERROR}) {
                   1197:                     $r->print(&Apache::loncommon::help_open_topic ("Navmap_Host_Down",
                   1198:                                                   '<font size="-1">Host down</font>'));
                   1199:                     }
                   1200: 
                   1201:                 my $discussionHTML = ""; my $feedbackHTML = "";
                   1202: 
                   1203:                 # SECOND COL: Is there text or feedback?
                   1204:                 if ($curRes->hasDiscussion()) {
                   1205:                     $discussionHTML = $linkopen .
                   1206:                         '<img border="0" src="/adm/lonMisc/chat.gif" />' .
                   1207:                         $linkclose;
                   1208:                 }
                   1209: 
                   1210:                 if ($curRes->getFeedback()) {
                   1211:                     my $feedback = $curRes->getFeedback();
                   1212:                     foreach (split(/\,/, $feedback)) {
                   1213:                         if ($_) {
                   1214:                             $feedbackHTML .= '&nbsp;<a href="/adm/email?display='
                   1215:                                 . &Apache::lonnet::escape($_) . '">'
                   1216:                                 . '<img src="/adm/lonMisc/feedback.gif" '
                   1217:                                 . 'border="0" /></a>';
                   1218:                         }
                   1219:                     }
                   1220:                 }
                   1221: 
1.77    ! bowersj2 1222:                 $r->print("<td align=\"left\" valign=\"center\">$discussionHTML$feedbackHTML</td>");
1.66      bowersj2 1223: 
                   1224:                 # Is this the first displayed part of a multi-part problem
                   1225:                 # that has not been condensed, so we should suppress these two
                   1226:                 # columns?
                   1227:                 my $firstDisplayed = !$condensed && $multipart && $part eq "0";
                   1228: 
1.69      bowersj2 1229:                 # THIRD COL: Problem status icon
1.66      bowersj2 1230:                 if ($curRes->is_problem() &&
                   1231:                     !$firstDisplayed) {
                   1232:                     my $icon = $statusIconMap{$curRes->status($part)};
1.69      bowersj2 1233:                     my $alt = $iconAltTags{$icon};
1.66      bowersj2 1234:                     if ($icon) {
1.77    ! bowersj2 1235:                         $r->print("<td valign=\"center\" width=\"50\" align=\"right\">$linkopen<img src=\"/adm/lonIcons/$icon\" border=\"0\" alt=\"$alt\" />$linkclose</td>\n");
1.66      bowersj2 1236:                     } else {
                   1237:                         $r->print("<td></td>\n");
                   1238:                     }
                   1239:                 } else { # not problem, no icon
                   1240:                     $r->print("<td></td>\n");
                   1241:                 }
                   1242: 
1.69      bowersj2 1243:                 # FOURTH COL: Text description
1.77    ! bowersj2 1244:                 $r->print("<td $colorizer align=\"right\" valign=\"center\">\n");
1.51      bowersj2 1245:                 
1.61      bowersj2 1246:                 if ($curRes->kind() eq "res" &&
                   1247:                     $curRes->is_problem() &&
1.66      bowersj2 1248:                     !$firstDisplayed) {
1.53      bowersj2 1249:                     $r->print (getDescription($curRes, $part));
1.51      bowersj2 1250:                 }
1.68      bowersj2 1251:                 if ($curRes->is_map() && advancedUser() && $curRes->randompick()) {
                   1252:                     $r->print('(randomly select ' . $curRes->randompick() .')');
                   1253:                 }
1.59      bowersj2 1254: 
1.66      bowersj2 1255:                 $r->print("</td></tr>\n");
1.51      bowersj2 1256:             }
                   1257:         }
                   1258:         $curRes = $mapIterator->next();
                   1259:     }
                   1260: 
                   1261:     $r->print("</table></body></html>");
                   1262: 
1.59      bowersj2 1263:     $navmap->untieHashes();
                   1264: 
1.51      bowersj2 1265:     return OK;
                   1266: }
                   1267: 
                   1268: # Convenience functions: Returns a string that adds or subtracts
                   1269: # the second argument from the first hash, appropriate for the 
                   1270: # query string that determines which folders to recurse on
                   1271: sub addToFilter {
                   1272:     my $hashIn = shift;
                   1273:     my $addition = shift;
                   1274:     my %hash = %$hashIn;
                   1275:     $hash{$addition} = 1;
                   1276: 
                   1277:     return join (",", keys(%hash));
                   1278: }
                   1279: 
                   1280: sub removeFromFilter {
                   1281:     my $hashIn = shift;
                   1282:     my $subtraction = shift;
                   1283:     my %hash = %$hashIn;
                   1284: 
                   1285:     delete $hash{$subtraction};
                   1286:     return join(",", keys(%hash));
                   1287: }
                   1288: 
                   1289: # Convenience function: Given a stack returned from getStack on the iterator,
                   1290: # return the correct src() value.
                   1291: # Later, this should add an anchor when we start putting anchors in pages.
                   1292: sub getLinkForResource {
                   1293:     my $stack = shift;
                   1294:     my $res;
                   1295: 
                   1296:     # Check to see if there are any pages in the stack
                   1297:     foreach $res (@$stack) {
                   1298:         if (defined($res) && $res->is_page()) {
                   1299:             return $res->src();
                   1300:         }
                   1301:     }
                   1302: 
                   1303:     # Failing that, return the src of the last resource that is defined
                   1304:     # (when we first recurse on a map, it puts an undefined resource
                   1305:     # on the bottom because $self->{HERE} isn't defined yet, and we
                   1306:     # want the src for the map anyhow)
                   1307:     foreach (@$stack) {
                   1308:         if (defined($_)) { $res = $_; }
                   1309:     }
                   1310: 
                   1311:     return $res->src();
                   1312: }
                   1313: 
1.53      bowersj2 1314: # Convenience function: This seperates the logic of how to create
                   1315: # the problem text strings ("Due: DATE", "Open: DATE", "Not yet assigned",
                   1316: # etc.) into a seperate function. It takes a resource object as the
                   1317: # first parameter, and the part number of the resource as the second.
                   1318: # It's basically a big switch statement on the status of the resource.
                   1319: 
                   1320: sub getDescription {
                   1321:     my $res = shift;
                   1322:     my $part = shift;
1.69      bowersj2 1323:     my $status = $res->status($part);
1.53      bowersj2 1324: 
                   1325:     if ($status == $res->NETWORK_FAILURE) { return ""; }
                   1326:     if ($status == $res->NOTHING_SET) {
                   1327:         return "Not currently assigned.";
                   1328:     }
                   1329:     if ($status == $res->OPEN_LATER) {
1.73      bowersj2 1330:         return "Open " . timeToHumanString($res->opendate($part));
1.53      bowersj2 1331:     }
                   1332:     if ($status == $res->OPEN) {
1.66      bowersj2 1333:         if ($res->duedate()) {
1.73      bowersj2 1334:             return "Due " . timeToHumanString($res->duedate($part));
1.66      bowersj2 1335:         } else {
                   1336:             return "Open, no due date";
                   1337:         }
1.53      bowersj2 1338:     }
1.54      bowersj2 1339:     if ($status == $res->PAST_DUE_ANSWER_LATER) {
1.73      bowersj2 1340:         return "Answer open " . timeToHumanString($res->answerdate($part));
1.54      bowersj2 1341:     }
                   1342:     if ($status == $res->PAST_DUE_NO_ANSWER) {
1.73      bowersj2 1343:         return "Was due " . timeToHumanString($res->duedate($part));
1.53      bowersj2 1344:     }
                   1345:     if ($status == $res->ANSWER_OPEN) {
                   1346:         return "Answer available";
                   1347:     }
1.59      bowersj2 1348:     if ($status == $res->EXCUSED) {
1.66      bowersj2 1349:         return "Excused by instructor";
1.59      bowersj2 1350:     }
1.69      bowersj2 1351:     if ($status == $res->ATTEMPTED) {
                   1352:         return "Not yet graded.";
                   1353:     }
1.59      bowersj2 1354:     if ($status == $res->TRIES_LEFT) {
1.66      bowersj2 1355:         my $tries = $res->tries();
                   1356:         my $maxtries = $res->maxtries();
                   1357:         my $triesString = "($tries of $maxtries tries used)";
                   1358:         if ($res->duedate()) {
1.73      bowersj2 1359:             return "Due " . timeToHumanString($res->duedate($part)) .
1.66      bowersj2 1360:                 " $triesString";
                   1361:         } else {
                   1362:             return "No due date $triesString";
                   1363:         }
1.59      bowersj2 1364:     }
1.53      bowersj2 1365: }
                   1366: 
1.68      bowersj2 1367: sub advancedUser {
                   1368:     return $ENV{'user.adv'};
                   1369: }
                   1370: 
1.73      bowersj2 1371: 
                   1372: # timeToHumanString takes a time number and converts it to a
                   1373: # human-readable representation, meant to be used in the following
                   1374: # manner:
                   1375: # print "Due $timestring"
                   1376: # print "Open $timestring"
                   1377: # print "Answer available $timestring"
                   1378: # Very, very, very, VERY English-only... goodness help a localizer on
                   1379: # this func...
1.53      bowersj2 1380: sub timeToHumanString {
1.58      albertel 1381:     my ($time) = @_;
                   1382:     # zero, '0' and blank are bad times
1.73      bowersj2 1383:     if (!$time) {
                   1384:         return 'never';
                   1385:     }
                   1386: 
                   1387:     my $now = time();
                   1388: 
                   1389:     my @time = localtime($time);
                   1390:     my @now = localtime($now);
                   1391: 
                   1392:     # Positive = future
                   1393:     my $delta = $time - $now;
                   1394: 
                   1395:     my $minute = 60;
                   1396:     my $hour = 60 * $minute;
                   1397:     my $day = 24 * $hour;
                   1398:     my $week = 7 * $day;
                   1399:     my $inPast = 0;
                   1400: 
                   1401:     # Logic in comments:
                   1402:     # Is it now? (extremely unlikely)
                   1403:     if ( $delta == 0 ) {
                   1404:         return "this instant";
                   1405:     }
                   1406: 
                   1407:     if ($delta < 0) {
                   1408:         $inPast = 1;
                   1409:         $delta = -$delta;
                   1410:     }
                   1411: 
                   1412:     # Is it in the future?
                   1413:     if ( $delta > 0 ) {
                   1414:         # Is it less then a minute away?
                   1415:         my $tense = $inPast ? " ago" : "";
                   1416:         my $prefix = $inPast ? "" : "in ";
                   1417:         if ( $delta < $minute ) {
                   1418:             if ($delta == 1) { return "${prefix}1 second$tense"; }
                   1419:             return "$prefix$delta seconds$tense";
                   1420:         }
                   1421: 
                   1422:         # Is it less then an hour away?
                   1423:         if ( $delta < $hour ) {
                   1424:             # If so, use minutes
                   1425:             my $minutes = floor($delta / 60);
                   1426:             if ($minutes == 1) { return "${prefix}1 minute$tense"; }
                   1427:             return "$prefix$minutes minutes$tense";
                   1428:         }
                   1429:         
                   1430:         # Is it less then 24 hours away? If so,
                   1431:         # display hours + minutes
                   1432:         if ( $delta < $hour * 24) {
                   1433:             my $hours = floor($delta / $hour);
                   1434:             my $minutes = floor(($delta % $hour) / $minute);
                   1435:             my $hourString = "$hours hours";
                   1436:             my $minuteString = ", $minutes minutes";
                   1437:             if ($hours == 1) {
                   1438:                 $hourString = "1 hour";
                   1439:             }
                   1440:             if ($minutes == 1) {
                   1441:                 $minuteString = ", 1 minute";
                   1442:             }
                   1443:             if ($minutes == 0) {
                   1444:                 $minuteString = "";
                   1445:             }
                   1446:             return "$prefix$hourString$minuteString$tense";
                   1447:         }
                   1448: 
                   1449:         # Less then 5 days away, display day of the week and
                   1450:         # HH:MM
                   1451:         if ( $delta < $day * 5 ) {
                   1452:             my $timeStr = strftime("%A at %I:%M %P", localtime($time));
                   1453:             $timeStr =~ s/12:00 am/midnight/;
                   1454:             $timeStr =~ s/12:00 pm/noon/;
                   1455:             return ($inPast ? "last " : "next ") .
                   1456:                 $timeStr;
                   1457:         }
                   1458:         
                   1459:         # Is it this year?
                   1460:         if ( $time[5] == $now[5]) {
                   1461:             # Return on Month Day, HH:MM meridian
                   1462:             my $timeStr = strftime("on %A, %b %e at %I:%M %P", localtime($time));
                   1463:             $timeStr =~ s/12:00 am/midnight/;
                   1464:             $timeStr =~ s/12:00 pm/noon/;
                   1465:             return $timeStr;
                   1466:         }
                   1467: 
                   1468:         # Not this year, so show the year
                   1469:         my $timeStr = strftime("on %A, %b %e %G at %I:%M %P", localtime($time));
                   1470:         $timeStr =~ s/12:00 am/midnight/;
                   1471:         $timeStr =~ s/12:00 pm/noon/;
                   1472:         return $timeStr;
1.58      albertel 1473:     }
1.53      bowersj2 1474: }
                   1475: 
1.51      bowersj2 1476: 1;
                   1477: 
                   1478: package Apache::lonnavmaps::navmap;
                   1479: 
                   1480: =pod
                   1481: 
                   1482: lonnavmaps provides functions and objects for dealing with the compiled course hashes generated when a user enters the course, and also provides the Apache handler for the "Navigation Map" button.
                   1483: 
                   1484: =head1 navmap object: Encapsulating the compiled nav map
                   1485: 
                   1486: navmap is an object that encapsulates a compiled course map and provides a reasonable interface to it.
                   1487: 
                   1488: Most notably it provides a way to navigate the map sensibly and a flexible iterator that makes it easy to write various renderers based on nav maps.
                   1489: 
                   1490: You must obtain resource objects through the navmap object.
                   1491: 
                   1492: =head2 Methods
                   1493: 
                   1494: =over 4
                   1495: 
1.70      bowersj2 1496: =item * B<new>(navHashFile, parmHashFile, genCourseAndUserOptions, genMailDiscussStatus): Binds a new navmap object to the compiled nav map hash and parm hash given as filenames. genCourseAndUserOptions is a flag saying whether the course options and user options hash should be generated. This is for when you are using the parameters of the resources that require them; see documentation in resource object documentation. genMailDiscussStatus causes the nav map to retreive information about the email and discussion status of resources. Returns the navmap object if this is successful, or B<undef> if not. You must check for undef; errors will occur when you try to use the other methods otherwise.
1.51      bowersj2 1497: 
                   1498: =item * B<getIterator>(first, finish, filter, condition): See iterator documentation below.
                   1499: 
                   1500: =cut
                   1501: 
                   1502: use strict;
                   1503: use GDBM_File;
                   1504: 
                   1505: sub new {
                   1506:     # magic invocation to create a class instance
                   1507:     my $proto = shift;
                   1508:     my $class = ref($proto) || $proto;
                   1509:     my $self = {};
                   1510: 
                   1511:     $self->{NAV_HASH_FILE} = shift;
                   1512:     $self->{PARM_HASH_FILE} = shift;
                   1513:     $self->{GENERATE_COURSE_USER_OPT} = shift;
1.55      bowersj2 1514:     $self->{GENERATE_EMAIL_DISCUSS_STATUS} = shift;
1.51      bowersj2 1515: 
                   1516:     # Resource cache stores navmapresource's as we reference them. We generate
                   1517:     # them on-demand so we don't pay for creating resources unless we use them.
                   1518:     $self->{RESOURCE_CACHE} = {};
                   1519: 
                   1520:     # Network failure flag, if we accessed the course or user opt and
                   1521:     # failed
                   1522:     $self->{NETWORK_FAILURE} = 0;
                   1523: 
                   1524:     # tie the nav hash
                   1525:     my %navmaphash;
                   1526:     if (!(tie(%navmaphash, 'GDBM_File', $self->{NAV_HASH_FILE},
                   1527:               &GDBM_READER(), 0640))) {
                   1528:         return undef;
                   1529:     }
                   1530:     $self->{NAV_HASH} = \%navmaphash;
                   1531:     
                   1532:     my %parmhash;
                   1533:     if (!(tie(%parmhash, 'GDBM_File', $self->{PARM_HASH_FILE},
                   1534:               &GDBM_READER(), 0640)))
                   1535:     {
1.66      bowersj2 1536:         untie $self->{PARM_HASH};
1.51      bowersj2 1537:         return undef;
                   1538:     }
                   1539:     $self->{PARM_HASH} = \%parmhash;
                   1540:     $self->{HASH_TIED} = 1;
                   1541: 
                   1542:     # If the course opt hash and the user opt hash should be generated,
                   1543:     # generate them
                   1544:     if ($self->{GENERATE_COURSE_USER_OPT}) {
                   1545:         my $uname=$ENV{'user.name'};
                   1546:         my $udom=$ENV{'user.domain'};
                   1547:         my $uhome=$ENV{'user.home'};
                   1548:         my $cid=$ENV{'request.course.id'};
                   1549:         my $chome=$ENV{'course.'.$cid.'.home'};
                   1550:         my ($cdom,$cnum)=split(/\_/,$cid);
                   1551:         
                   1552:         my $userprefix=$uname.'_'.$udom.'_';
                   1553:         
                   1554:         my %courserdatas; my %useropt; my %courseopt;
                   1555:         unless ($uhome eq 'no_host') { 
                   1556: # ------------------------------------------------- Get coursedata (if present)
                   1557:             unless ((time-$courserdatas{$cid.'.last_cache'})<240) {
                   1558:                 my $reply=&Apache::lonnet::reply('dump:'.$cdom.':'.$cnum.
                   1559:                                                  ':resourcedata',$chome);
                   1560:                 if ($reply!~/^error\:/) {
                   1561:                     $courserdatas{$cid}=$reply;
                   1562:                     $courserdatas{$cid.'.last_cache'}=time;
                   1563:                 }
                   1564:                 # check to see if network failed
                   1565:                 elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
                   1566:                 {
                   1567:                     $self->{NETWORK_FAILURE} = 1;
                   1568:                 }
                   1569:             }
                   1570:             foreach (split(/\&/,$courserdatas{$cid})) {
                   1571:                 my ($name,$value)=split(/\=/,$_);
                   1572:                 $courseopt{$userprefix.&Apache::lonnet::unescape($name)}=
                   1573:                     &Apache::lonnet::unescape($value);
                   1574:             }
                   1575: # --------------------------------------------------- Get userdata (if present)
                   1576:             unless ((time-$userrdatas{$uname.'___'.$udom.'.last_cache'})<240) {
                   1577:                 my $reply=&Apache::lonnet::reply('dump:'.$udom.':'.$uname.':resourcedata',$uhome);
                   1578:                 if ($reply!~/^error\:/) {
                   1579:                     $userrdatas{$uname.'___'.$udom}=$reply;
                   1580:                     $userrdatas{$uname.'___'.$udom.'.last_cache'}=time;
                   1581:                 }
                   1582:                 # check to see if network failed
                   1583:                 elsif ( $reply=~/no.such.host/i || $reply=~/con.*lost/i )
                   1584:                 {
                   1585:                     $self->{NETWORK_FAILURE} = 1;
                   1586:                 }
                   1587:             }
                   1588:             foreach (split(/\&/,$userrdatas{$uname.'___'.$udom})) {
                   1589:                 my ($name,$value)=split(/\=/,$_);
                   1590:                 $useropt{$userprefix.&Apache::lonnet::unescape($name)}=
                   1591:                     &Apache::lonnet::unescape($value);
                   1592:             }
1.55      bowersj2 1593:             $self->{COURSE_OPT} = \%courseopt;
                   1594:             $self->{USER_OPT} = \%useropt;
1.51      bowersj2 1595:         }
                   1596:     }   
                   1597: 
1.55      bowersj2 1598:     if ($self->{GENERATE_EMAIL_DISCUSS_STATUS}) {
                   1599:         my $cid=$ENV{'request.course.id'};
                   1600:         my ($cdom,$cnum)=split(/\_/,$cid);
                   1601:         
                   1602:         my %emailstatus = &Apache::lonnet::dump('email_status');
1.56      bowersj2 1603:         my $logoutTime = $emailstatus{'logout'};
                   1604:         my $courseLeaveTime = $emailstatus{'logout_'.$ENV{'request.course.id'}};
1.55      bowersj2 1605:         $self->{LAST_CHECK} = ($courseLeaveTime > $logoutTime ?
                   1606:                                $courseLeaveTime : $logoutTime);
1.56      bowersj2 1607:         my %discussiontime = &Apache::lonnet::dump('discussiontimes', 
1.55      bowersj2 1608:                                                    $cdom, $cnum);
                   1609:         my %feedback=();
                   1610:         my %error=();
                   1611:         my $keys = &Apache::lonnet::reply('keys:'.
                   1612:                                           $ENV{'user.domain'}.':'.
                   1613:                                           $ENV{'user.name'}.':nohist_email',
                   1614:                                           $ENV{'user.home'});
                   1615: 
                   1616:         foreach my $msgid (split(/\&/, $keys)) {
                   1617:             $msgid=&Apache::lonnet::unescape($msgid);
                   1618:             my $plain=&Apache::lonnet::unescape(&Apache::lonnet::unescape($msgid));
                   1619:             if ($plain=~/(Error|Feedback) \[([^\]]+)\]/) {
                   1620:                 my ($what,$url)=($1,$2);
                   1621:                 my %status=
                   1622:                     &Apache::lonnet::get('email_status',[$msgid]);
                   1623:                 if ($status{$msgid}=~/^error\:/) { 
                   1624:                     $status{$msgid}=''; 
                   1625:                 }
                   1626:                 
                   1627:                 if (($status{$msgid} eq 'new') || 
                   1628:                     (!$status{$msgid})) { 
                   1629:                     if ($what eq 'Error') {
                   1630:                         $error{$url}.=','.$msgid; 
                   1631:                     } else {
                   1632:                         $feedback{$url}.=','.$msgid;
                   1633:                     }
                   1634:                 }
                   1635:             }
                   1636:         }
                   1637:         
                   1638:         $self->{FEEDBACK} = \%feedback;
                   1639:         $self->{ERROR_MSG} = \%error; # what is this? JB
                   1640:         $self->{DISCUSSION_TIME} = \%discussiontime;
                   1641:         $self->{EMAIL_STATUS} = \%emailstatus;
                   1642:         
                   1643:     }    
                   1644:     
1.51      bowersj2 1645:     bless($self);
1.55      bowersj2 1646:         
                   1647:     return $self;
                   1648: }
1.51      bowersj2 1649: 
1.55      bowersj2 1650: # Checks to see if coursemap is defined, matching test in old lonnavmaps
                   1651: sub courseMapDefined {
                   1652:     my $self = shift;
                   1653:     my $uri = &Apache::lonnet::clutter($ENV{'request.course.uri'});
                   1654: 
1.56      bowersj2 1655:     my $firstres = $self->{NAV_HASH}->{"map_start_$uri"};
                   1656:     my $lastres = $self->{NAV_HASH}->{"map_finish_$uri"};
1.55      bowersj2 1657:     return $firstres && $lastres;
1.51      bowersj2 1658: }
                   1659: 
                   1660: sub getIterator {
                   1661:     my $self = shift;
                   1662:     my $iterator = Apache::lonnavmaps::iterator->new($self, shift, shift,
1.63      bowersj2 1663:                                                      shift, undef, shift);
1.51      bowersj2 1664:     return $iterator;
                   1665: }
                   1666: 
                   1667: # unties the hash when done
                   1668: sub untieHashes {
                   1669:     my $self = shift;
1.60      bowersj2 1670:     untie %{$self->{NAV_HASH}} if ($self->{HASH_TIED});
                   1671:     untie %{$self->{PARM_HASH}} if ($self->{HASH_TIED});
1.51      bowersj2 1672:     $self->{HASH_TIED} = 0;
                   1673: }
                   1674: 
                   1675: # when the object is destroyed, be sure to untie all the hashes we tied.
                   1676: sub DESTROY {
                   1677:     my $self = shift;
                   1678:     $self->untieHashes();
                   1679: }
                   1680: 
1.59      bowersj2 1681: # Private function: Does the given resource (as a symb string) have
                   1682: # current discussion? Returns 0 if chat/mail data not extracted.
                   1683: sub hasDiscussion {
                   1684:     my $self = shift;
                   1685:     my $symb = shift;
                   1686:     if (!defined($self->{DISCUSSION_TIME})) { return 0; }
                   1687: 
                   1688:     return $self->{DISCUSSION_TIME}->{$symb} >
1.66      bowersj2 1689:            $self->{LAST_CHECK};
1.59      bowersj2 1690: }
                   1691: 
                   1692: # Private function: Does the given resource (as a symb string) have
                   1693: # current feedback? Returns the string in the feedback hash, which
                   1694: # will be false if it does not exist.
                   1695: sub getFeedback { 
                   1696:     my $self = shift;
                   1697:     my $symb = shift;
                   1698: 
                   1699:     if (!defined($self->{FEEDBACK})) { return ""; }
                   1700:     
                   1701:     return $self->{FEEDBACK}->{$symb};
                   1702: }
                   1703: 
1.51      bowersj2 1704: =pod
                   1705: 
                   1706: =item * B<getById>(id): Based on the ID of the resource (1.1, 3.2, etc.), get a resource object for that resource. This method, or other methods that use it (as in the resource object) is the only proper way to obtain a resource object.
                   1707: 
                   1708: =cut
                   1709: 
                   1710: # The strategy here is to cache the resource objects, and only construct them
                   1711: # as we use them. The real point is to prevent reading any more from the tied
                   1712: # hash then we have to, which should hopefully alleviate speed problems.
                   1713: # Caching is just an incidental detail I throw in because it makes sense.
                   1714: 
                   1715: sub getById {
                   1716:     my $self = shift;
                   1717:     my $id = shift;
                   1718: 
                   1719:     if (defined ($self->{RESOURCE_CACHE}->{$id}))
                   1720:     {
                   1721:         return $self->{RESOURCE_CACHE}->{$id};
                   1722:     }
                   1723: 
                   1724:     # resource handles inserting itself into cache.
                   1725:     return Apache::lonnavmaps::resource->new($self, $id);
                   1726: }
                   1727: 
                   1728: =pod
                   1729: 
                   1730: =item * B<firstResource>(): Returns a resource object reference corresponding to the first resource in the navmap.
                   1731: 
                   1732: =cut
                   1733: 
                   1734: sub firstResource {
                   1735:     my $self = shift;
                   1736:     my $firstResource = $self->{NAV_HASH}->{'map_start_' .
                   1737:                      &Apache::lonnet::clutter($ENV{'request.course.uri'})};
                   1738:     return $self->getById($firstResource);
                   1739: }
                   1740: 
                   1741: =pod
                   1742: 
                   1743: =item * B<finishResource>(): Returns a resource object reference corresponding to the last resource in the navmap.
                   1744: 
                   1745: =cut
                   1746: 
                   1747: sub finishResource {
                   1748:     my $self = shift;
                   1749:     my $firstResource = $self->{NAV_HASH}->{'map_finish_' .
                   1750:                      &Apache::lonnet::clutter($ENV{'request.course.uri'})};
                   1751:     return $self->getById($firstResource);
                   1752: }
                   1753: 
                   1754: # -------------------------------------------- Figure out a cascading parameter
                   1755: #
                   1756: # For this function to work
                   1757: #
                   1758: # * parmhash needs to be tied
                   1759: # * courseopt and useropt need to be initialized for this user and course
                   1760: #
                   1761: 
                   1762: sub parmval {
                   1763:     my $self = shift;
                   1764:     my ($what,$symb)=@_;
                   1765:     my $cid=$ENV{'request.course.id'};
                   1766:     my $csec=$ENV{'request.course.sec'};
                   1767:     my $uname=$ENV{'user.name'};
                   1768:     my $udom=$ENV{'user.domain'};
                   1769: 
                   1770:     unless ($symb) { return ''; }
                   1771:     my $result='';
                   1772: 
                   1773:     my ($mapname,$id,$fn)=split(/\_\_\_/,$symb);
                   1774: 
                   1775: # ----------------------------------------------------- Cascading lookup scheme
                   1776:     my $rwhat=$what;
                   1777:     $what=~s/^parameter\_//;
                   1778:     $what=~s/\_/\./;
                   1779: 
                   1780:     my $symbparm=$symb.'.'.$what;
                   1781:     my $mapparm=$mapname.'___(all).'.$what;
                   1782:     my $usercourseprefix=$uname.'_'.$udom.'_'.$cid;
                   1783: 
                   1784:     my $seclevel= $usercourseprefix.'.['.$csec.'].'.$what;
                   1785:     my $seclevelr=$usercourseprefix.'.['.$csec.'].'.$symbparm;
                   1786:     my $seclevelm=$usercourseprefix.'.['.$csec.'].'.$mapparm;
                   1787: 
                   1788:     my $courselevel= $usercourseprefix.'.'.$what;
                   1789:     my $courselevelr=$usercourseprefix.'.'.$symbparm;
                   1790:     my $courselevelm=$usercourseprefix.'.'.$mapparm;
                   1791: 
                   1792:     my $useropt = $self->{USER_OPT};
                   1793:     my $courseopt = $self->{COURSE_OPT};
                   1794:     my $parmhash = $self->{PARM_HASH};
                   1795: 
                   1796: # ---------------------------------------------------------- first, check user
                   1797:     if ($uname and defined($useropt)) {
1.57      albertel 1798:         if (defined($$useropt{$courselevelr})) { return $$useropt{$courselevelr}; }
                   1799:         if (defined($$useropt{$courselevelm})) { return $$useropt{$courselevelm}; }
                   1800:         if (defined($$useropt{$courselevel})) { return $$useropt{$courselevel}; }
1.51      bowersj2 1801:     }
                   1802: 
                   1803: # ------------------------------------------------------- second, check course
                   1804:     if ($csec and defined($courseopt)) {
1.57      albertel 1805:         if (defined($$courseopt{$seclevelr})) { return $$courseopt{$seclevelr}; }
                   1806:         if (defined($$courseopt{$seclevelm})) { return $$courseopt{$seclevelm}; }
                   1807:         if (defined($$courseopt{$seclevel})) { return $$courseopt{$seclevel}; }
1.51      bowersj2 1808:     }
                   1809: 
                   1810:     if (defined($courseopt)) {
1.57      albertel 1811:         if (defined($$courseopt{$courselevelr})) { return $$courseopt{$courselevelr}; }
                   1812:         if (defined($$courseopt{$courselevelm})) { return $$courseopt{$courselevelm}; }
                   1813:         if (defined($$courseopt{$courselevel})) { return $$courseopt{$courselevel}; }
1.51      bowersj2 1814:     }
                   1815: 
                   1816: # ----------------------------------------------------- third, check map parms
                   1817: 
                   1818:     my $thisparm=$$parmhash{$symbparm};
1.57      albertel 1819:     if (defined($thisparm)) { return $thisparm; }
1.51      bowersj2 1820: 
                   1821: # ----------------------------------------------------- fourth , check default
                   1822: 
                   1823:     my $default=&Apache::lonnet::metadata($fn,$rwhat.'.default');
1.57      albertel 1824:     if (defined($default)) { return $default}
1.51      bowersj2 1825: 
                   1826: # --------------------------------------------------- fifth , cascade up parts
                   1827: 
                   1828:     my ($space,@qualifier)=split(/\./,$rwhat);
                   1829:     my $qualifier=join('.',@qualifier);
                   1830:     unless ($space eq '0') {
                   1831:         my ($part,$id)=split(/\_/,$space);
                   1832:         if ($id) {
                   1833:             my $partgeneral=$self->parmval($part.".$qualifier",$symb);
1.57      albertel 1834:             if (defined($partgeneral)) { return $partgeneral; }
1.51      bowersj2 1835:         } else {
                   1836:             my $resourcegeneral=$self->parmval("0.$qualifier",$symb);
1.57      albertel 1837:             if (defined($resourcegeneral)) { return $resourcegeneral; }
1.51      bowersj2 1838:         }
                   1839:     }
                   1840:     return '';
                   1841: }
                   1842: 
                   1843: 
                   1844: 1;
                   1845: 
                   1846: package Apache::lonnavmaps::iterator;
                   1847: 
                   1848: # This package must precede "navmap" because "navmap" uses it. In
                   1849: # order to keep the documentation order straight, the iterator is documented
                   1850: # after the navmap object.
                   1851: 
                   1852: =pod
                   1853: 
                   1854: =back
                   1855: 
                   1856: =head1 navmap Iterator
                   1857: 
                   1858: An I<iterator> encapsulates the logic required to traverse a data structure. navmap uses an iterator to traverse the course map according to the criteria you wish to use.
                   1859: 
                   1860: To obtain an iterator, call the B<getIterator>() function of a B<navmap> object. (Do not instantiate Apache::lonnavmaps::iterator directly.) This will return a reference to the iterator:
                   1861: 
                   1862: C<my $resourceIterator = $navmap-E<gt>getIterator();>
                   1863: 
                   1864: To get the next thing from the iterator, call B<next>:
                   1865: 
                   1866: C<my $nextThing = $resourceIterator-E<gt>next()>
                   1867: 
                   1868: getIterator behaves as follows:
                   1869: 
                   1870: =over 4
                   1871: 
1.70      bowersj2 1872: =item B<getIterator>(firstResource, finishResource, filterHash, condition): All parameters are optional. firstResource is a resource reference corresponding to where the iterator should start. It defaults to navmap->firstResource() for the corresponding nav map. finishResource corresponds to where you want the iterator to end, defaulting to navmap->finishResource(). filterHash is a hash used as a set containing strings representing the resource IDs, defaulting to empty. Condition is a 1 or 0 that sets what to do with the filter hash: If a 0, then only resource that exist IN the filterHash will be recursed on. If it is a 1, only resources NOT in the filterHash will be recursed on. Defaults to 0, which is to say, do not recurse unless explicitly asked to.
1.51      bowersj2 1873: 
1.70      bowersj2 1874: Thus, by default, all resources will be shown. Change the condition to a 1 without changing the hash, and only the top level of the map will be shown. Changing the condition to 1 and including some values in the hash will allow you to selectively examine parts of the navmap, while leaving it on 0 and adding things to the hash will allow you to selectively ignore parts of the nav map. See the handler code for examples: By default, the condition is 0 and all folders are closed unless explicitly opened. Clicking "Show All Resources" will use a condition of 1 and an empty filterHash, resulting in all resources being shown.
1.51      bowersj2 1875: 
                   1876: The iterator will return either a reference to a resource object, or a token representing something in the map, such as the beginning of a new branch. The possible tokens are:
                   1877: 
                   1878: =over 4
                   1879: 
1.70      bowersj2 1880: =item * BEGIN_MAP: A new map is being recursed into. This is returned I<after> the map resource itself is returned.
                   1881: 
                   1882: =item * END_MAP: The map is now done.
                   1883: 
                   1884: =item * BEGIN_BRANCH: A branch is now starting. The next resource returned will be the first in that branch.
                   1885: 
                   1886: =item * END_BRANCH: The branch is now done.
1.51      bowersj2 1887: 
                   1888: =back
                   1889: 
1.70      bowersj2 1890: The tokens are retreivable via methods on the iterator object, i.e., $iterator->END_MAP.
                   1891: 
                   1892: =back
1.51      bowersj2 1893: 
                   1894: =cut
                   1895: 
                   1896: # Here are the tokens for the iterator:
                   1897: 
                   1898: sub BEGIN_MAP { return 1; }    # begining of a new map
                   1899: sub END_MAP { return 2; }      # end of the map
                   1900: sub BEGIN_BRANCH { return 3; } # beginning of a branch
                   1901: sub END_BRANCH { return 4; }   # end of a branch
                   1902: 
                   1903: # Params: nav map, start resource, end resource, filter, condition, 
                   1904: # already seen hash ref
                   1905: 
                   1906: sub new {
                   1907:     # magic invocation to create a class instance
                   1908:     my $proto = shift;
                   1909:     my $class = ref($proto) || $proto;
                   1910:     my $self = {};
                   1911: 
                   1912:     $self->{NAV_MAP} = shift;
                   1913:     return undef unless ($self->{NAV_MAP});
                   1914: 
                   1915:     # Handle the parameters
                   1916:     $self->{FIRST_RESOURCE} = shift || $self->{NAV_MAP}->firstResource();
                   1917:     $self->{FINISH_RESOURCE} = shift || $self->{NAV_MAP}->finishResource();
                   1918: 
                   1919:     # If the given resources are just the ID of the resource, get the
                   1920:     # objects
                   1921:     if (!ref($self->{FIRST_RESOURCE})) { $self->{FIRST_RESOURCE} = 
                   1922:              $self->{NAV_MAP}->getById($self->{FIRST_RESOURCE}); }
                   1923:     if (!ref($self->{FINISH_RESOURCE})) { $self->{FINISH_RESOURCE} = 
                   1924:              $self->{NAV_MAP}->getById($self->{FINISH_RESOURCE}); }
                   1925: 
                   1926:     $self->{FILTER} = shift;
                   1927: 
                   1928:     # A hash, used as a set, of resource already seen
                   1929:     $self->{ALREADY_SEEN} = shift;
                   1930:     if (!defined($self->{ALREADY_SEEN})) { $self->{ALREADY_SEEN} = {} };
1.63      bowersj2 1931:     $self->{CONDITION} = shift;
1.51      bowersj2 1932: 
                   1933:     # Flag: Have we started yet? If not, the first action is to return BEGIN_MAP.
                   1934:     $self->{STARTED} = 0;
                   1935: 
                   1936:     # Should we continue calling the recursive iterator, if any?
                   1937:     $self->{RECURSIVE_ITERATOR_FLAG} = 0;
                   1938:     # The recursive iterator, if any
                   1939:     $self->{RECURSIVE_ITERATOR} = undef;
                   1940:     # Are we recursing on a map, or a branch?
                   1941:     $self->{RECURSIVE_MAP} = 1; # we'll manually unset this when recursing on branches
                   1942:     # And the count of how deep it is, so that this iterator can keep track of
                   1943:     # when to pick back up again.
                   1944:     $self->{RECURSIVE_DEPTH} = 0;
                   1945: 
                   1946:     # For keeping track of our branches, we maintain our own stack
                   1947:     $self->{BRANCH_STACK} = [];
                   1948:     # If the size shrinks, we exhausted a branch
                   1949:     $self->{BRANCH_STACK_SIZE} = 0;
                   1950:     $self->{BRANCH_DEPTH} = 0;
                   1951: 
                   1952:     # For returning two things in a forced sequence
                   1953:     $self->{FORCE_NEXT} = undef;
                   1954: 
                   1955:     # Start with the first resource
                   1956:     push @{$self->{BRANCH_STACK}}, $self->{FIRST_RESOURCE};
                   1957:     $self->{BRANCH_STACK_SIZE} = 1;
                   1958: 
                   1959:     bless($self);
                   1960:     return $self;
                   1961: }
                   1962: 
                   1963: # Note... this function is *touchy*. I strongly recommend tracing
                   1964: # through it with the debugger a few times on a non-trivial map before
                   1965: # modifying it. Order is *everything*.
                   1966: sub next {
                   1967:     my $self = shift;
                   1968:     
                   1969:     # Iterator logic goes here
                   1970: 
                   1971:     # Are we using a recursive iterator? If so, pull from that and
                   1972:     # watch the depth; we want to resume our level at the correct time.
                   1973:     if ($self->{RECURSIVE_ITERATOR_FLAG})
                   1974:     {
                   1975:         # grab the next from the recursive iterator
                   1976:         my $next = $self->{RECURSIVE_ITERATOR}->next();
                   1977:         
                   1978:         # is it a begin or end map? Update depth if so
                   1979:         if ($next == BEGIN_MAP() ) { $self->{RECURSIVE_DEPTH}++; }
                   1980:         if ($next == END_MAP() ) { $self->{RECURSIVE_DEPTH}--; }
                   1981: 
                   1982:         # Are we back at depth 0? If so, stop recursing.
                   1983:         if ($self->{RECURSIVE_DEPTH} == 0) {
                   1984:             $self->{RECURSIVE_ITERATOR_FLAG} = 0;
                   1985:         }
                   1986:         
                   1987:         return $next;
                   1988:     }
                   1989: 
1.68      bowersj2 1990:     # Is this return value pre-determined?
                   1991:     if (defined($self->{FORCE_NEXT})) {
                   1992:         my $tmp = $self->{FORCE_NEXT};
                   1993:         $self->{FORCE_NEXT} = undef;
                   1994:         return $tmp;
                   1995:     }
                   1996: 
1.51      bowersj2 1997:     # Is there a current resource to grab? If not, then return
                   1998:     # END_BRANCH and END_MAP in succession.
                   1999:     if (scalar(@{$self->{BRANCH_STACK}}) == 0) {
                   2000:         if ($self->{BRANCH_DEPTH} > 0) {
                   2001:             $self->{FORCE_NEXT} = $self->END_MAP();
1.52      bowersj2 2002:             $self->{BRANCH_DEPTH}--;
1.51      bowersj2 2003:             return $self->END_BRANCH();
                   2004:         } else {
                   2005:             return $self->END_MAP();
                   2006:         }
                   2007:     }
                   2008: 
                   2009:     # Have we not yet begun? If not, return BEGIN_MAP and 
                   2010:     # remember that we've started.
                   2011:     if ( !$self->{STARTED} ) {
                   2012:         $self->{STARTED} = 1;
                   2013:         return $self->BEGIN_MAP;
                   2014:     }
                   2015: 
                   2016:     # Did the branch stack shrink since last run? If so,
                   2017:     # we exhausted a branch last time, therefore, we're about
                   2018:     # to start a new one. (We know because we already checked to see
                   2019:     # if the stack was empty.)
                   2020:     if ( scalar (@{$self->{BRANCH_STACK}}) < $self->{BRANCH_STACK_SIZE}) {
1.52      bowersj2 2021:         $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
                   2022:         $self->{BRANCH_DEPTH}++;
                   2023:         return $self->BEGIN_BRANCH();
1.51      bowersj2 2024:     }
                   2025: 
1.52      bowersj2 2026:     # Remember the size for comparision next time.
                   2027:     $self->{BRANCH_STACK_SIZE} = scalar(@{$self->{BRANCH_STACK}});
                   2028: 
                   2029:     # If the next resource we mean to return is going to need
                   2030:     # a lower branch level, terminate branches until we get 
                   2031:     # there.
                   2032: 
1.51      bowersj2 2033:     # Get the next resource in the branch
                   2034:     $self->{HERE} = pop @{$self->{BRANCH_STACK}};
1.52      bowersj2 2035: 
                   2036:     # Are we at the right depth? If not, close a branch and return
                   2037:     # the current resource onto the branch stack
                   2038:     if (defined($self->{HERE}->{DATA}->{ITERATOR_DEPTH})
                   2039:         && $self->{HERE}->{DATA}->{ITERATOR_DEPTH} <
                   2040:         $self->{BRANCH_DEPTH} ) {
                   2041:         $self->{BRANCH_DEPTH}--;
                   2042:         # return it so we can pick it up eventually
                   2043:         push @{$self->{BRANCH_STACK}}, $self->{HERE};
                   2044:         return $self->END_BRANCH();
                   2045:     }
                   2046: 
1.51      bowersj2 2047:     # We always return it after this point and never before
                   2048:     # (proof: look at just the return statements), so we
                   2049:     # remember that we've seen this.
                   2050:     $self->{ALREADY_SEEN}->{$self->{HERE}->{ID}} = 1;
                   2051:     
                   2052:     # Get the next possible resources
                   2053:     my $nextUnfiltered = $self->{HERE}->getNext();
                   2054:     my $next = [];
                   2055: 
                   2056:     # filter the next possibilities to remove things we've 
1.52      bowersj2 2057:     # already seen. Also, remember what branch depth they should
                   2058:     # be displayed at, since there's no other reliable way to tell.
1.51      bowersj2 2059:     foreach (@$nextUnfiltered) {
1.52      bowersj2 2060:         if (!defined($self->{ALREADY_SEEN}->{$_->{ID}})) {
                   2061:             push @$next, $_;
                   2062:             $_->{DATA}->{ITERATOR_DEPTH} = 
                   2063:                 $self->{BRANCH_DEPTH} + 1;
                   2064:         }
1.51      bowersj2 2065:     }
                   2066: 
                   2067:     # Handle branch cases:
                   2068:     # Nothing is available next: BRANCH_END
                   2069:     # 1 thing next: standard non-branch
                   2070:     # 2+ things next: have some branches
                   2071:     my $nextCount = scalar(@$next);
                   2072:     if ($nextCount == 0) {
1.52      bowersj2 2073:         # Return this and on the next run, close the branch up if we're 
                   2074:         # in a branch
                   2075:         if ($self->{BRANCH_DEPTH} > 0 ) {
                   2076:             $self->{FORCE_NEXT} = $self->END_BRANCH();
                   2077:             $self->{BRANCH_DEPTH}--;
                   2078:         }
1.51      bowersj2 2079:     }
                   2080:     
                   2081:     while (@$next) {
                   2082:         # copy the next possibilities over to the branch stack
                   2083:         # in the right order
1.52      bowersj2 2084:         push @{$self->{BRANCH_STACK}}, shift @$next;
1.51      bowersj2 2085:     }
                   2086: 
                   2087:     if ($nextCount >= 2) {
1.52      bowersj2 2088:         $self->{FORCE_NEXT} = $self->BEGIN_BRANCH();
                   2089:         $self->{BRANCH_DEPTH}++;
1.51      bowersj2 2090:         return $self->{HERE}; 
                   2091:     }
                   2092: 
                   2093:     # If this is a map and we want to recurse down it... (not filtered out)
1.70      bowersj2 2094:     if ($self->{HERE}->is_map() && 
1.63      bowersj2 2095:          (defined($self->{FILTER}->{$self->{HERE}->map_pc()}) xor $self->{CONDITION})) { 
1.51      bowersj2 2096:         $self->{RECURSIVE_ITERATOR_FLAG} = 1;
                   2097:         my $firstResource = $self->{HERE}->map_start();
                   2098:         my $finishResource = $self->{HERE}->map_finish();
                   2099: 
                   2100:         $self->{RECURSIVE_ITERATOR} =
                   2101:           Apache::lonnavmaps::iterator->new ($self->{NAV_MAP}, $firstResource, 
1.63      bowersj2 2102:                      $finishResource, $self->{FILTER}, $self->{ALREADY_SEEN},
1.66      bowersj2 2103:                                              $self->{CONDITION});
1.51      bowersj2 2104:     }
                   2105: 
                   2106:     return $self->{HERE};
                   2107: }
                   2108: 
                   2109: =pod
                   2110: 
                   2111: The other method available on the iterator is B<getStack>, which returns an array populated with the current 'stack' of maps, as references to the resource objects. Example: This is useful when making the navigation map, as we need to check whether we are under a page map to see if we need to link directly to the resource, or to the page. The first elements in the array will correspond to the top of the stack (most inclusive map).
                   2112: 
                   2113: =cut
                   2114: 
                   2115: sub getStack {
                   2116:     my $self=shift;
                   2117: 
                   2118:     my @stack;
                   2119: 
                   2120:     $self->populateStack(\@stack);
                   2121: 
                   2122:     return \@stack;
                   2123: }
                   2124: 
                   2125: # Private method: Calls the iterators recursively to populate the stack.
                   2126: sub populateStack {
                   2127:     my $self=shift;
                   2128:     my $stack = shift;
                   2129: 
                   2130:     push @$stack, $self->{HERE};
                   2131: 
                   2132:     if ($self->{RECURSIVE_ITERATOR_FLAG}) {
                   2133:         $self->{RECURSIVE_ITERATOR}->populateStack($stack);
                   2134:     }
                   2135: }
                   2136: 
1.1       www      2137: 1;
1.2       www      2138: 
1.51      bowersj2 2139: package Apache::lonnavmaps::resource;
                   2140: 
                   2141: use Apache::lonnet;
                   2142: 
                   2143: =pod
                   2144: 
                   2145: =head1 Object: resource
                   2146: 
                   2147: A resource object encapsulates a resource in a resource map, allowing easy manipulation of the resource, querying the properties of the resource (including user properties), and represents a reference that can be used as the canonical representation of the resource by lonnavmap clients like renderers.
                   2148: 
                   2149: A resource only makes sense in the context of a navmap, as some of the data is stored in the navmap object.
                   2150: 
                   2151: You will probably never need to instantiate this object directly. Use Apache::lonnavmap::navmap, and use the "start" method to obtain the starting resource.
                   2152: 
                   2153: =head2 Public Members
                   2154: 
                   2155: resource objects have a hash called DATA ($resourceRef->{DATA}) that you can store whatever you want in. This allows you to easily do two-pass algorithms without worrying about managing your own resource->data hash.
                   2156: 
                   2157: =head2 Methods
                   2158: 
                   2159: =over 4
                   2160: 
1.70      bowersj2 2161: =item * B<new>($navmapRef, $idString): The first arg is a reference to the parent navmap object. The second is the idString of the resource itself. Very rarely, if ever, called directly. Use the nav map->getByID() method.
                   2162: 
                   2163: =back
1.51      bowersj2 2164: 
                   2165: =cut
                   2166: 
                   2167: sub new {
                   2168:     # magic invocation to create a class instance
                   2169:     my $proto = shift;
                   2170:     my $class = ref($proto) || $proto;
                   2171:     my $self = {};
                   2172: 
                   2173:     $self->{NAV_MAP} = shift;
                   2174:     $self->{ID} = shift;
                   2175: 
                   2176:     # Store this new resource in the parent nav map's cache.
                   2177:     $self->{NAV_MAP}->{RESOURCE_CACHE}->{$self->{ID}} = $self;
1.66      bowersj2 2178:     $self->{RESOURCE_ERROR} = 0;
1.51      bowersj2 2179: 
                   2180:     # A hash that can be used by two-pass algorithms to store data
                   2181:     # about this resource in. Not used by the resource object
                   2182:     # directly.
                   2183:     $self->{DATA} = {};
                   2184:    
                   2185:     bless($self);
                   2186:     
                   2187:     return $self;
                   2188: }
                   2189: 
1.70      bowersj2 2190: # private function: simplify the NAV_HASH lookups we keep doing
                   2191: # pass the name, and to automatically append my ID, pass a true val on the
                   2192: # second param
                   2193: sub navHash {
                   2194:     my $self = shift;
                   2195:     my $param = shift;
                   2196:     my $id = shift;
                   2197:     return $self->{NAV_MAP}->{NAV_HASH}->{$param . ($id?$self->{ID}:"")};
                   2198: }
                   2199: 
1.51      bowersj2 2200: =pod
                   2201: 
1.70      bowersj2 2202: B<Metadata Retreival>
                   2203: 
                   2204: These are methods that help you retrieve metadata about the resource:
                   2205: 
                   2206: =over 4
                   2207: 
                   2208: =item * B<ext>: Returns true if the resource is external.
                   2209: 
                   2210: =item * B<goesto>: Returns the "goesto" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
                   2211: 
                   2212: =item * B<kind>: Returns the kind of the resource from the compiled nav map.
                   2213: 
                   2214: =item * B<randomout>: Returns true if this resource was chosen to NOT be shown to the user by the random map selection feature.
1.51      bowersj2 2215: 
1.70      bowersj2 2216: =item * B<randompick>: Returns true for a map if the randompick feature is being used on the map. (?)
                   2217: 
                   2218: =item * B<src>: Returns the source for the resource.
                   2219: 
                   2220: =item * B<symb>: Returns the symb for the resource.
                   2221: 
                   2222: =item * B<title>: Returns the title of the resource.
                   2223: 
                   2224: =item * B<to>: Returns the "to" value from the compiled nav map. (It is likely you want to use B<getNext> instead.)
1.51      bowersj2 2225: 
                   2226: =item * B<type>: Returns the type of the resource, "start", "normal", or "finish". 
                   2227: 
                   2228: =back
                   2229: 
                   2230: =cut
                   2231: 
                   2232: # These info functions can be used directly, as they don't return
                   2233: # resource information.
1.70      bowersj2 2234: sub ext { my $self=shift; return $self->navHash("ext_", 1) eq 'true:'; }
1.51      bowersj2 2235: sub goesto { my $self=shift; return $self->navHash("goesto_", 1); }
                   2236: sub kind { my $self=shift; return $self->navHash("kind_", 1); }
1.68      bowersj2 2237: sub randomout { my $self=shift; return $self->navHash("randomout_", 1); }
                   2238: sub randompick { 
                   2239:     my $self = shift;
                   2240:     return $self->{NAV_MAP}->{PARM_HASH}->{$self->symb .
                   2241:                                                '.0.parameter_randompick'};
                   2242: }
1.51      bowersj2 2243: sub src { 
                   2244:     my $self=shift;
                   2245:     return $self->navHash("src_", 1);
                   2246: }
                   2247: sub symb {
                   2248:     my $self=shift;
                   2249:     (my $first, my $second) = $self->{ID} =~ /(\d+).(\d+)/;
                   2250:     my $symbSrc = &Apache::lonnet::declutter($self->src());
                   2251:     return &Apache::lonnet::declutter(
                   2252:          $self->navHash('map_id_'.$first)) 
                   2253:         . '___' . $second . '___' . $symbSrc;
                   2254: }
1.70      bowersj2 2255: sub title { my $self=shift; return $self->navHash("title_", 1); }
                   2256: sub to { my $self=shift; return $self->navHash("to_", 1); }
                   2257: sub type { my $self=shift; return $self->navHash("type_", 1); }
                   2258: 
                   2259: =pod
                   2260: 
                   2261: B<Predicate Testing the Resource>
                   2262: 
                   2263: These methods are shortcuts to deciding if a given resource has a given property.
                   2264: 
                   2265: =over 4
                   2266: 
                   2267: =item * B<is_map>: Returns true if the resource is a map type.
                   2268: 
                   2269: =item * B<is_problem>: Returns true if the resource is a problem type, false otherwise. (Looks at the extension on the src field; might need more to work correctly.)
                   2270: 
                   2271: =item * B<is_page>: Returns true if the resource is a page.
                   2272: 
                   2273: =item * B<is_problem>: Returns true if the resource is a problem.
                   2274: 
                   2275: =item * B<is_sequence>: Returns true if the resource sequence.
                   2276: 
                   2277: =back
                   2278: 
                   2279: =cut
                   2280: 
                   2281: 
                   2282: sub is_html {
1.51      bowersj2 2283:     my $self=shift;
                   2284:     my $src = $self->src();
1.70      bowersj2 2285:     return ($src =~ /html$/);
1.51      bowersj2 2286: }
1.70      bowersj2 2287: sub is_map { my $self=shift; return defined($self->navHash("is_map_", 1)); }
                   2288: sub is_page {
1.51      bowersj2 2289:     my $self=shift;
                   2290:     my $src = $self->src();
1.70      bowersj2 2291:     return ($src =~ /page$/);
1.51      bowersj2 2292: }
1.70      bowersj2 2293: sub is_problem {
1.51      bowersj2 2294:     my $self=shift;
                   2295:     my $src = $self->src();
1.70      bowersj2 2296:     return ($src =~ /problem$/);
1.51      bowersj2 2297: }
1.70      bowersj2 2298: sub is_sequence {
1.51      bowersj2 2299:     my $self=shift;
                   2300:     my $src = $self->src();
1.70      bowersj2 2301:     return ($src =~ /sequence$/);
1.51      bowersj2 2302: }
                   2303: 
                   2304: 
                   2305: 
                   2306: 
1.70      bowersj2 2307: 
1.51      bowersj2 2308: # Move this into POD: In order to use these correctly, courseopt
                   2309: # and useropt need to be generated
                   2310: sub parmval {
                   2311:     my $self = shift;
                   2312:     my $what = shift;
                   2313:     my $part = shift || "0";
                   2314:     return $self->{NAV_MAP}->parmval($part.'.'.$what, $self->symb());
                   2315: }
                   2316: 
1.70      bowersj2 2317: =pod
                   2318: 
                   2319: B<Map Methods>
                   2320: 
                   2321: These methods are useful for getting information about the map properties of the resource, if the resource is a map (B<is_map>).
                   2322: 
                   2323: =over 4
                   2324: 
                   2325: =item * B<map_finish>: Returns a reference to a resource object corresponding to the finish resource of the map.
                   2326: 
                   2327: =item * B<map_pc>: Returns the pc value of the map, which is the first number that appears in the resource ID of the resources in the map, and is the number that appears around the middle of the symbs of the resources in that map.
                   2328: 
                   2329: =item * B<map_start>: Returns a reference to a resource object corresponding to the start resource of the map.
                   2330: 
                   2331: =item * B<map_type>: Returns a string with the type of the map in it.
                   2332: 
                   2333: =back
1.51      bowersj2 2334: 
1.70      bowersj2 2335: =cut
1.51      bowersj2 2336: 
                   2337: sub map_finish {
                   2338:     my $self = shift;
                   2339:     my $src = $self->src();
                   2340:     my $res = $self->navHash("map_finish_$src", 0);
                   2341:     $res = $self->{NAV_MAP}->getById($res);
                   2342:     return $res;
                   2343: }
1.70      bowersj2 2344: sub map_pc {
                   2345:     my $self = shift;
                   2346:     my $src = $self->src();
                   2347:     return $self->navHash("map_pc_$src", 0);
                   2348: }
1.51      bowersj2 2349: sub map_start {
                   2350:     my $self = shift;
                   2351:     my $src = $self->src();
                   2352:     my $res = $self->navHash("map_start_$src", 0);
                   2353:     $res = $self->{NAV_MAP}->getById($res);
                   2354:     return $res;
                   2355: }
                   2356: sub map_type {
                   2357:     my $self = shift;
                   2358:     my $pc = $self->map_pc();
                   2359:     return $self->navHash("map_type_$pc", 0);
                   2360: }
                   2361: 
                   2362: 
                   2363: 
                   2364: #####
                   2365: # Property queries
                   2366: #####
                   2367: 
                   2368: # These functions will be responsible for returning the CORRECT
                   2369: # VALUE for the parameter, no matter what. So while they may look
                   2370: # like direct calls to parmval, they can be more then that.
                   2371: # So, for instance, the duedate function should use the "duedatetype"
                   2372: # information, rather then the resource object user.
                   2373: 
                   2374: =pod
                   2375: 
                   2376: =head2 Resource Parameters
                   2377: 
1.70      bowersj2 2378: In order to use the resource parameters correctly, the nav map must have been instantiated with genCourseAndUserOptions set to true, so the courseopt and useropt is read correctly. Then, you can call these functions to get the relevant parameters for the resource. Each function defaults to part "0", but can be directed to another part by passing the part as the parameter.
1.51      bowersj2 2379: 
                   2380: These methods are responsible for getting the parameter correct, not merely reflecting the contents of the GDBM hashes. As we move towards dates relative to other dates, these methods should be updated to reflect that. (Then, anybody using these methods won't have to update their code.)
                   2381: 
                   2382: =over 4
                   2383: 
                   2384: =item * B<acc>: Get the Client IP/Name Access Control information.
                   2385: 
                   2386: =item * B<answerdate>: Get the answer-reveal date for the problem.
                   2387: 
                   2388: =item * B<duedate>: Get the due date for the problem.
                   2389: 
                   2390: =item * B<tries>: Get the number of tries the student has used on the problem.
                   2391: 
                   2392: =item * B<maxtries>: Get the number of max tries allowed.
                   2393: 
                   2394: =item * B<opendate>: Get the open date for the problem.
                   2395: 
                   2396: =item * B<sig>: Get the significant figures setting.
                   2397: 
                   2398: =item * B<tol>: Get the tolerance for the problem.
                   2399: 
1.70      bowersj2 2400: =item * B<tries>: Get the number of tries the user has already used on the problem.
                   2401: 
1.51      bowersj2 2402: =item * B<type>: Get the question type for the problem.
                   2403: 
                   2404: =item * B<weight>: Get the weight for the problem.
                   2405: 
                   2406: =back
                   2407: 
                   2408: =cut
                   2409: 
                   2410: sub acc {
                   2411:     (my $self, my $part) = @_;
                   2412:     return $self->parmval("acc", $part);
                   2413: }
                   2414: sub answerdate {
                   2415:     (my $self, my $part) = @_;
                   2416:     # Handle intervals
                   2417:     if ($self->parmval("answerdate.type", $part) eq 'date_interval') {
                   2418:         return $self->duedate($part) + 
                   2419:             $self->parmval("answerdate", $part);
                   2420:     }
                   2421:     return $self->parmval("answerdate", $part);
                   2422: }
                   2423: sub duedate {
                   2424:     (my $self, my $part) = @_;
                   2425:     return $self->parmval("duedate", $part);
                   2426: }
                   2427: sub maxtries {
                   2428:     (my $self, my $part) = @_;
                   2429:     return $self->parmval("maxtries", $part);
                   2430: }
                   2431: sub opendate {
                   2432:     (my $self, my $part) = @_;
                   2433:     if ($self->parmval("opendate.type", $part) eq 'date_interval') {
                   2434:         return $self->duedate($part) -
                   2435:             $self->parmval("opendate", $part);
                   2436:     }
                   2437:     return $self->parmval("opendate");
                   2438: }
                   2439: sub sig {
                   2440:     (my $self, my $part) = @_;
                   2441:     return $self->parmval("sig", $part);
                   2442: }
                   2443: sub tol {
                   2444:     (my $self, my $part) = @_;
                   2445:     return $self->parmval("tol", $part);
                   2446: }
                   2447: sub tries {
                   2448:     my $self = shift;
                   2449:     my $part = shift;
                   2450:     $part = '0' if (!defined($part));
                   2451: 
                   2452:     # Make sure return hash is loaded, should error check
                   2453:     $self->getReturnHash();
                   2454:     
                   2455:     my $tries = $self->{RETURN_HASH}->{'resource.'.$part.'.tries'};
                   2456:     if (!defined($tries)) {return '0';}
                   2457:     return $tries;
                   2458: }
1.70      bowersj2 2459: sub type {
                   2460:     (my $self, my $part) = @_;
                   2461:     return $self->parmval("type", $part);
                   2462: }
                   2463: sub weight {
                   2464:     (my $self, my $part) = @_;
                   2465:     return $self->parmval("weight", $part);
                   2466: }
1.51      bowersj2 2467: 
                   2468: # Multiple things need this
                   2469: sub getReturnHash {
                   2470:     my $self = shift;
                   2471:     
                   2472:     if (!defined($self->{RETURN_HASH})) {
                   2473:         my %tmpHash = &Apache::lonnet::restore($self->symb());
                   2474:         $self->{RETURN_HASH} = \%tmpHash;
                   2475:     }
                   2476: }       
                   2477: 
                   2478: ######
                   2479: # Status queries
                   2480: ######
                   2481: 
                   2482: # These methods query the status of problems.
                   2483: 
                   2484: # If we need to count parts, this function determines the number of
                   2485: # parts from the metadata. When called, it returns a reference to a list
                   2486: # of strings corresponding to the parts. (Thus, using it in a scalar context
                   2487: # tells you how many parts you have in the problem:
                   2488: # $partcount = scalar($resource->countParts());
                   2489: # Don't use $self->{PARTS} directly because you don't know if it's been
                   2490: # computed yet.
                   2491: 
                   2492: =pod
                   2493: 
                   2494: =head2 Resource misc
                   2495: 
                   2496: Misc. functions for the resource.
                   2497: 
                   2498: =over 4
                   2499: 
1.59      bowersj2 2500: =item * B<hasDiscussion>: Returns a false value if there has been discussion since the user last logged in, true if there has. Always returns false if the discussion data was not extracted when the nav map was constructed.
                   2501: 
                   2502: =item * B<getFeedback>: Gets the feedback for the resource and returns the raw feedback string for the resource, or the null string if there is no feedback or the email data was not extracted when the nav map was constructed. Usually used like this:
                   2503: 
                   2504:  for (split(/\,/, $res->getFeedback())) {
                   2505:     my $link = &Apache::lonnet::escape($_);
                   2506:     ...
                   2507: 
                   2508: and use the link as appropriate.
                   2509: 
                   2510: =cut
                   2511: 
                   2512: sub hasDiscussion {
                   2513:     my $self = shift;
                   2514:     return $self->{NAV_MAP}->hasDiscussion($self->symb());
                   2515: }
                   2516: 
                   2517: sub getFeedback {
                   2518:     my $self = shift;
                   2519:     return $self->{NAV_MAP}->getFeedback($self->symb());
                   2520: }
                   2521: 
                   2522: =pod
                   2523: 
1.70      bowersj2 2524: =item * B<parts>(): Returns a list reference containing sorted strings corresponding to each part of the problem. To count the number of parts, use the list in a scalar context, and subtract one if greater then two. (One part problems have a part 0. Multi-parts have a part 0, plus a part for each part. Filtering part 0 if you want it is up to you.)
1.51      bowersj2 2525: 
1.70      bowersj2 2526: =item * B<countParts>(): Returns the number of parts of the problem a student can answer. Thus, for single part problems, returns 1. For multipart, it returns the number of parts in the problem, not including psuedo-part 0. Thus, B<parts> may return an array with fewer parts in it then countParts might lead you to believe.
1.51      bowersj2 2527: 
                   2528: =back
                   2529: 
                   2530: =cut
                   2531: 
                   2532: sub parts {
                   2533:     my $self = shift;
                   2534: 
1.67      bowersj2 2535:     if ($self->ext) { return ['0']; }
                   2536: 
1.51      bowersj2 2537:     $self->extractParts();
                   2538:     return $self->{PARTS};
                   2539: }
                   2540: 
                   2541: sub countParts {
                   2542:     my $self = shift;
                   2543:     
                   2544:     my $parts = $self->parts();
1.66      bowersj2 2545: 
                   2546:     if ($self->{RESOURCE_ERROR}) {
                   2547:         return 0;
                   2548:     }
                   2549: 
                   2550:     if (scalar(@{$parts}) < 2) { return 1;}
1.51      bowersj2 2551: 
                   2552:     return scalar(@{$parts}) - 1;
                   2553: }
                   2554: 
                   2555: # Private function: Extracts the parts information and saves it
                   2556: sub extractParts { 
                   2557:     my $self = shift;
                   2558:     
                   2559:     return if ($self->{PARTS});
1.67      bowersj2 2560:     return if ($self->ext);
1.51      bowersj2 2561: 
                   2562:     $self->{PARTS} = [];
                   2563: 
                   2564:     # Retrieve part count
1.66      bowersj2 2565:     my $metadata = &Apache::lonnet::metadata($self->src(), 'allpossiblekeys');
                   2566:     if (!$metadata) {
                   2567:         $self->{RESOURCE_ERROR} = 1;
                   2568:         $self->{PARTS} = [];
                   2569:         return;
                   2570:     }
                   2571: 
                   2572:     foreach (split(/\,/,$metadata)) {
1.51      bowersj2 2573:         if ($_ =~ /^parameter\_(.*)\_opendate$/) {
                   2574:             push @{$self->{PARTS}}, $1;
                   2575:         }
                   2576:     }
1.66      bowersj2 2577: 
1.51      bowersj2 2578:     
                   2579:     # Is this possible to do in one line? - Jeremy
                   2580:     my @sortedParts = sort @{$self->{PARTS}};
                   2581:     $self->{PARTS} = \@sortedParts;
                   2582: 
                   2583:     return;
                   2584: }
                   2585: 
                   2586: =pod
                   2587: 
                   2588: =head2 Resource Status
                   2589: 
                   2590: Problem resources have status information, reflecting their various dates and completion statuses. You can obtain this information and import symbolic constants to represent the status.
                   2591: 
                   2592: There are two aspects to the status: the date-related information and the completion information.
                   2593: 
                   2594: Idiomatic usage of these two methods would probably look something like
                   2595: 
                   2596:  foreach ($resource->parts()) {
                   2597:     my $dateStatus = $resource->getDateStatus($_);
                   2598:     my $completionStatus = $resource->getCompletionStatus($_);
                   2599: 
1.70      bowersj2 2600:     or
                   2601: 
                   2602:     my $status = $resource->status($_);
                   2603: 
1.51      bowersj2 2604:     ... use it here ...
                   2605:  }
                   2606: 
                   2607: =over 4
                   2608: 
1.70      bowersj2 2609: =item * B<getDateStatus>($part): ($part defaults to 0). A convenience function that returns a symbolic constant telling you about the date status of the part. The possible return values are:
1.51      bowersj2 2610: 
                   2611: =back
                   2612: 
                   2613: B<Date Codes>
                   2614: 
                   2615: =over 4
                   2616: 
                   2617: =item * B<OPEN_LATER>: The problem will be opened later.
                   2618: 
                   2619: =item * B<OPEN>: Open and not yet due.
                   2620: 
1.59      bowersj2 2621: 
1.54      bowersj2 2622: =item * B<PAST_DUE_ANSWER_LATER>: The due date has passed, but the answer date has not yet arrived.
                   2623: 
                   2624: =item * B<PAST_DUE_NO_ANSWER>: The due date has passed and there is no answer opening date set.
1.51      bowersj2 2625: 
                   2626: =item * B<ANSWER_OPEN>: The answer date is here.
                   2627: 
                   2628: =item * B<NETWORK_FAILURE>: The information is unknown due to network failure.
                   2629: 
                   2630: =back
                   2631: 
                   2632: =cut
                   2633: 
                   2634: # Apparently the compiler optimizes these into constants automatically
1.54      bowersj2 2635: sub OPEN_LATER             { return 0; }
                   2636: sub OPEN                   { return 1; }
                   2637: sub PAST_DUE_NO_ANSWER     { return 2; }
                   2638: sub PAST_DUE_ANSWER_LATER  { return 3; }
                   2639: sub ANSWER_OPEN            { return 4; }
                   2640: sub NOTHING_SET            { return 5; } 
                   2641: sub NETWORK_FAILURE        { return 100; }
                   2642: 
                   2643: # getDateStatus gets the date status for a given problem part. 
                   2644: # Because answer date, due date, and open date are fully independent
                   2645: # (i.e., it is perfectly possible to *only* have an answer date), 
                   2646: # we have to completely cover the 3x3 maxtrix of (answer, due, open) x
                   2647: # (past, future, none given). This function handles this with a decision
                   2648: # tree. Read the comments to follow the decision tree.
1.51      bowersj2 2649: 
                   2650: sub getDateStatus {
                   2651:     my $self = shift;
                   2652:     my $part = shift;
                   2653:     $part = "0" if (!defined($part));
1.54      bowersj2 2654: 
                   2655:     # Always return network failure if there was one.
1.51      bowersj2 2656:     return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
                   2657: 
                   2658:     my $now = time();
                   2659: 
1.53      bowersj2 2660:     my $open = $self->opendate($part);
                   2661:     my $due = $self->duedate($part);
                   2662:     my $answer = $self->answerdate($part);
                   2663: 
                   2664:     if (!$open && !$due && !$answer) {
                   2665:         # no data on the problem at all
                   2666:         # should this be the same as "open later"? think multipart.
                   2667:         return $self->NOTHING_SET;
                   2668:     }
1.59      bowersj2 2669:     if (!$open || $now < $open) {return $self->OPEN_LATER}
                   2670:     if (!$due || $now < $due) {return $self->OPEN}
                   2671:     if ($answer && $now < $answer) {return $self->PAST_DUE_ANSWER_LATER}
                   2672:     if ($answer) { return $self->ANSWER_OPEN; }
1.54      bowersj2 2673:     return PAST_DUE_NO_ANSWER;
1.51      bowersj2 2674: }
                   2675: 
                   2676: =pod
                   2677: 
                   2678: B<>
                   2679: 
                   2680: =over 4
                   2681: 
                   2682: =item * B<getCompletionStatus>($part): ($part defaults to 0.) A convenience function that returns a symbolic constant telling you about the completion status of the part, with the following possible results:
                   2683: 
                   2684: =back 
                   2685: 
                   2686: B<Completion Codes>
                   2687: 
                   2688: =over 4
                   2689: 
                   2690: =item * B<NOT_ATTEMPTED>: Has not been attempted at all.
                   2691: 
                   2692: =item * B<INCORRECT>: Attempted, but wrong by student.
                   2693: 
                   2694: =item * B<INCORRECT_BY_OVERRIDE>: Attempted, but wrong by instructor override.
                   2695: 
                   2696: =item * B<CORRECT>: Correct or correct by instructor.
                   2697: 
                   2698: =item * B<CORRECT_BY_OVERRIDE>: Correct by instructor override.
                   2699: 
                   2700: =item * B<EXCUSED>: Excused. Not yet implemented.
                   2701: 
                   2702: =item * B<NETWORK_FAILURE>: Information not available due to network failure.
                   2703: 
1.69      bowersj2 2704: =item * B<ATTEMPTED>: Attempted, and not yet graded.
                   2705: 
1.51      bowersj2 2706: =back
                   2707: 
                   2708: =cut
                   2709: 
1.53      bowersj2 2710: sub NOT_ATTEMPTED         { return 10; }
                   2711: sub INCORRECT             { return 11; }
                   2712: sub INCORRECT_BY_OVERRIDE { return 12; }
                   2713: sub CORRECT               { return 13; }
                   2714: sub CORRECT_BY_OVERRIDE   { return 14; }
                   2715: sub EXCUSED               { return 15; }
1.69      bowersj2 2716: sub ATTEMPTED             { return 16; }
1.51      bowersj2 2717: 
                   2718: sub getCompletionStatus {
                   2719:     my $self = shift;
                   2720:     my $part = shift;
                   2721:     $part = "0" if (!defined($part));
                   2722:     return $self->NETWORK_FAILURE if ($self->{NAV_MAP}->{NETWORK_FAILURE});
                   2723: 
                   2724:     # Make sure return hash exists
                   2725:     $self->getReturnHash();
                   2726:     
                   2727:     my $status = $self->{RETURN_HASH}->{'resource.'.$part.'.solved'};
                   2728: 
                   2729:     # Left as seperate if statements in case we ever do more with this
                   2730:     if ($status eq 'correct_by_student') {return $self->CORRECT;}
                   2731:     if ($status eq 'correct_by_override') {return $self->CORRECT_BY_OVERRIDE; }
                   2732:     if ($status eq 'incorrect_attempted') {return $self->INCORRECT; }
                   2733:     if ($status eq 'incorrect_by_override') {return $self->INCORRECT_BY_OVERRIDE; }
                   2734:     if ($status eq 'excused') {return $self->EXCUSED; }
1.69      bowersj2 2735:     if ($status eq 'ungraded_attempted') {return $self->ATTEMPTED; }
1.51      bowersj2 2736:     return $self->NOT_ATTEMPTED;
                   2737: }
                   2738: 
                   2739: =pod
                   2740: 
                   2741: B<Composite Status>
                   2742: 
                   2743: Along with directly returning the date or completion status, the resource object includes a convenience function B<status>() that will combine the two status tidbits into one composite status that can represent the status of the resource as a whole. The precise logic is documented in the comments of the status method. The following results may be returned, all available as methods on the resource object ($res->NETWORK_FAILURE()):
                   2744: 
                   2745: =over 4
                   2746: 
1.70      bowersj2 2747: =item * B<NETWORK_FAILURE>: The network has failed and the information is not available.
1.51      bowersj2 2748: 
1.70      bowersj2 2749: =item * B<NOTHING_SET>: No dates have been set for this problem (part) at all. (Because only certain parts of a multi-part problem may be assigned, this can not be collapsed into "open later", as we don't know a given part will EVER be opened. For single part, this is the same as "OPEN_LATER".)
1.53      bowersj2 2750: 
1.70      bowersj2 2751: =item * B<CORRECT>: For any reason at all, the part is considered correct.
1.51      bowersj2 2752: 
1.70      bowersj2 2753: =item * B<EXCUSED>: For any reason at all, the problem is excused.
1.51      bowersj2 2754: 
1.70      bowersj2 2755: =item * B<PAST_DUE_NO_ANSWER>: The problem is past due, not considered correct, and no answer date is set.
1.54      bowersj2 2756: 
1.70      bowersj2 2757: =item * B<PAST_DUE_ANSWER_LATER>: The problem is past due, not considered correct, and an answer date in the future is set.
1.51      bowersj2 2758: 
1.70      bowersj2 2759: =item * B<ANSWER_OPEN>: The problem is past due, not correct, and the answer is now available.
1.51      bowersj2 2760: 
1.70      bowersj2 2761: =item * B<OPEN_LATER>: The problem is not yet open.
1.51      bowersj2 2762: 
1.70      bowersj2 2763: =item * B<TRIES_LEFT>: The problem is open, has been tried, is not correct, but there are tries left.
1.51      bowersj2 2764: 
1.70      bowersj2 2765: =item * B<INCORRECT>: The problem is open, and all tries have been used without getting the correct answer.
1.51      bowersj2 2766: 
1.70      bowersj2 2767: =item * B<OPEN>: The item is open and not yet tried.
1.51      bowersj2 2768: 
1.70      bowersj2 2769: =item * B<ATTEMPTED>: The problem has been attempted.
1.69      bowersj2 2770: 
1.51      bowersj2 2771: =back
                   2772: 
                   2773: =cut
                   2774: 
                   2775: sub TRIES_LEFT { return 10; }
                   2776: 
                   2777: sub status {
                   2778:     my $self = shift;
                   2779:     my $part = shift;
                   2780:     if (!defined($part)) { $part = "0"; }
                   2781:     my $completionStatus = $self->getCompletionStatus($part);
                   2782:     my $dateStatus = $self->getDateStatus($part);
                   2783: 
                   2784:     # What we have is a two-dimensional matrix with 4 entries on one
                   2785:     # dimension and 5 entries on the other, which we want to colorize,
1.54      bowersj2 2786:     # plus network failure and "no date data at all".
1.51      bowersj2 2787: 
1.53      bowersj2 2788:     if ($completionStatus == NETWORK_FAILURE) { return NETWORK_FAILURE; }
1.51      bowersj2 2789: 
                   2790:     # There are a few whole rows we can dispose of:
1.53      bowersj2 2791:     if ($completionStatus == CORRECT ||
                   2792:         $completionStatus == CORRECT_BY_OVERRIDE ) {
1.69      bowersj2 2793:         return CORRECT; 
                   2794:     }
                   2795: 
                   2796:     if ($completionStatus == ATTEMPTED) {
                   2797:         return ATTEMPTED;
1.53      bowersj2 2798:     }
                   2799: 
                   2800:     # If it's EXCUSED, then return that no matter what
                   2801:     if ($completionStatus == EXCUSED) {
                   2802:         return EXCUSED; 
1.51      bowersj2 2803:     }
                   2804: 
1.53      bowersj2 2805:     if ($dateStatus == NOTHING_SET) {
                   2806:         return NOTHING_SET;
1.51      bowersj2 2807:     }
                   2808: 
1.69      bowersj2 2809:     # Now we're down to a 4 (incorrect, incorrect_override, not_attempted)
                   2810:     # by 4 matrix (date statuses).
1.51      bowersj2 2811: 
1.54      bowersj2 2812:     if ($dateStatus == PAST_DUE_ANSWER_LATER ||
1.59      bowersj2 2813:         $dateStatus == PAST_DUE_NO_ANSWER ) {
1.54      bowersj2 2814:         return $dateStatus; 
1.51      bowersj2 2815:     }
                   2816: 
1.53      bowersj2 2817:     if ($dateStatus == ANSWER_OPEN) {
                   2818:         return ANSWER_OPEN;
1.51      bowersj2 2819:     }
                   2820: 
                   2821:     # Now: (incorrect, incorrect_override, not_attempted) x 
                   2822:     # (open_later), (open)
                   2823:     
1.53      bowersj2 2824:     if ($dateStatus == OPEN_LATER) {
                   2825:         return OPEN_LATER;
1.51      bowersj2 2826:     }
                   2827: 
                   2828:     # If it's WRONG...
1.53      bowersj2 2829:     if ($completionStatus == INCORRECT || $completionStatus == INCORRECT_BY_OVERRIDE) {
1.51      bowersj2 2830:         # and there are TRIES LEFT:
                   2831:         if ($self->tries() < $self->maxtries()) {
1.53      bowersj2 2832:             return TRIES_LEFT;
1.51      bowersj2 2833:         }
1.53      bowersj2 2834:         return INCORRECT; # otherwise, return orange; student can't fix this
1.51      bowersj2 2835:     }
                   2836: 
                   2837:     # Otherwise, it's untried and open
1.53      bowersj2 2838:     return OPEN; 
1.51      bowersj2 2839: }
                   2840: 
                   2841: =pod
                   2842: 
                   2843: =head2 Resource/Nav Map Navigation
                   2844: 
                   2845: =over 4
                   2846: 
                   2847: =item * B<getNext>(): Gets the next resource in the navmap after this one.
                   2848: 
                   2849: =cut
                   2850: 
                   2851: # For the simple single-link case, to get from a resource to the next
                   2852: # resource, you need to look up the "to_" link in the nav hash, then
                   2853: # follow that with the "goesto_" link.
                   2854: 
                   2855: sub getNext {
                   2856:     my $self = shift;
                   2857:     my $alreadySeenHash = shift;
                   2858:     my @branches;
                   2859:     my $to = $self->to();
                   2860:     foreach my $branch ( split(/\,/, $to) ) {
                   2861:         my $choice = $self->{NAV_MAP}->getById($branch);
                   2862:         my $next = $choice->goesto();
                   2863:         $next = $self->{NAV_MAP}->getById($next);
                   2864: 
1.61      bowersj2 2865:         # Don't remember it if we've already seen it or if
1.66      bowersj2 2866:         # the student doesn't have browse priviledges
                   2867:         my $browsePriv = &Apache::lonnet::allowed('bre', $self->src);
1.51      bowersj2 2868:         if (!defined($alreadySeenHash) ||
1.61      bowersj2 2869:             !defined($alreadySeenHash->{$next->{ID}}) ||
1.66      bowersj2 2870:             ($browsePriv ne '2' && $browsePriv ne 'F')) {
1.51      bowersj2 2871:                 push @branches, $next;
                   2872:             }
                   2873:     }
                   2874:     return \@branches;
                   2875: }
                   2876: 
                   2877: =pod
1.2       www      2878: 
1.51      bowersj2 2879: =back
1.2       www      2880: 
1.51      bowersj2 2881: =cut
1.2       www      2882: 
1.51      bowersj2 2883: 1;
1.2       www      2884: 
1.51      bowersj2 2885: __END__
1.2       www      2886: 
                   2887: 

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