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

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

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