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

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

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