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

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

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