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