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

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

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