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