[LON-CAPA-cvs] cvs: doc /loncapafiles loncapafiles.lpml loncom/auth lonslotcheck.pm loncom/homework bridgetask.pm lonhomework.pm loncom/interface slotrequest.pm

raeburn raeburn at source.lon-capa.org
Wed Jan 31 10:29:28 EST 2018


raeburn		Wed Jan 31 15:29:28 2018 EDT

  Added files:                 
    /loncom/auth	lonslotcheck.pm 

  Modified files:              
    /loncom/homework	bridgetask.pm lonhomework.pm 
    /loncom/interface	slotrequest.pm 
    /doc/loncapafiles	loncapafiles.lpml 
  Log:
  - Bug 6754 LON-CAPA as LTI Consumer
    Support for access control using slots for both "gradable" and "non-gradable"
    external tools.
  
  
-------------- next part --------------
Index: loncom/homework/bridgetask.pm
diff -u loncom/homework/bridgetask.pm:1.269 loncom/homework/bridgetask.pm:1.270
--- loncom/homework/bridgetask.pm:1.269	Thu Jan 18 05:09:28 2018
+++ loncom/homework/bridgetask.pm	Wed Jan 31 15:28:28 2018
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA 
 # definition of tags that give a structure to a document
 #
-# $Id: bridgetask.pm,v 1.269 2018/01/18 05:09:28 raeburn Exp $
+# $Id: bridgetask.pm,v 1.270 2018/01/31 15:28:28 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -123,7 +123,7 @@
     my ($symb) = &Apache::lonnet::whichuser();
     my ($map)  = &Apache::lonnet::decode_symb($symb);
     my @resources = 
-	$navmap->retrieveResources($map, sub { $_[0]->is_problem() || $_[0]->is_gradable() },0,0);
+	$navmap->retrieveResources($map, sub { $_[0]->is_problem() || $_[0]->is_tool() },0,0);
     my %old_history = %Apache::lonhomework::history;
     my %old_results = %Apache::lonhomework::results;
 
Index: loncom/homework/lonhomework.pm
diff -u loncom/homework/lonhomework.pm:1.369 loncom/homework/lonhomework.pm:1.370
--- loncom/homework/lonhomework.pm:1.369	Fri Dec 22 02:00:39 2017
+++ loncom/homework/lonhomework.pm	Wed Jan 31 15:28:28 2018
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # The LON-CAPA Homework handler
 #
-# $Id: lonhomework.pm,v 1.369 2017/12/22 02:00:39 raeburn Exp $
+# $Id: lonhomework.pm,v 1.370 2018/01/31 15:28:28 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -213,7 +213,7 @@
 
     # does it pass normal muster
     my ($status,$datemsg)=&check_access($id,$symb);
-    
+
     my $useslots = &Apache::lonnet::EXT("resource.0.useslots",$symb);
     if ($useslots ne 'resource' && $useslots ne 'map' 
 	&& $useslots ne 'map_map') {
@@ -409,76 +409,12 @@
     # used to gain access to it to work on it, until the due date is reached, and the
     # problem then becomes CLOSED.  Therefore return the slotstatus - 
     # (which will be one of: NOT_IN_A_SLOT, RESERVABLE, RESERVABLE_LATER, or NOTRESERVABLE).
+
     if (!defined($slot_name) && (($type eq 'problem') || ($type eq 'tool'))) {
         if ($slotstatus eq 'NOT_IN_A_SLOT') {
             if (!$num_usable_slots) {
-                if ($env{'request.course.id'}) {
-                    my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
-                    my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
-                    unless ($symb) {
-                        ($symb)=&Apache::lonnet::whichuser();
-                    }
-                    $slotstatus = 'NOTRESERVABLE';
-                    my ($reservable_now_order,$reservable_now,$reservable_future_order,
-                        $reservable_future) = 
-                        &Apache::loncommon::get_future_slots($cnum,$cdom,$now,$symb);
-                    if ((ref($reservable_now_order) eq 'ARRAY') && (ref($reservable_now) eq 'HASH')) {
-                        if (@{$reservable_now_order} > 0) {
-                            if ((!$checkedin) || (ref($consumed_uniq) ne 'ARRAY')) {
-                                $slotstatus = 'RESERVABLE';
-                                $datemsg = $reservable_now->{$reservable_now_order->[-1]}{'endreserve'};
-                            } else {
-                                my ($uniqstart,$uniqend,$useslot);
-                                if (ref($consumed_uniq) eq 'ARRAY') {
-                                    ($uniqstart,$uniqend)=@{$consumed_uniq};
-                                }
-                                foreach my $slot (reverse(@{$reservable_now_order})) {
-                                    if ($reservable_now->{$slot}{'uniqueperiod'} =~ /^(\d+)\,(\d+)$/) {
-                                        my ($new_uniq_start,$new_uniq_end) = ($1,$2);
-                                        next if (!
-                                            ($uniqstart < $new_uniq_start && $uniqend < $new_uniq_start) ||
-                                            ($uniqstart > $new_uniq_end   &&  $uniqend > $new_uniq_end  ));
-                                    }
-                                    $useslot = $slot;
-                                    last;
-                                }
-                                if ($useslot) {
-                                    $slotstatus = 'RESERVABLE';
-                                    $datemsg = $reservable_now->{$useslot}{'endreserve'};
-                                }
-                            }
-                        }
-                    }
-                    unless ($slotstatus eq 'RESERVABLE') {
-                        if ((ref($reservable_future_order) eq 'ARRAY') && (ref($reservable_future) eq 'HASH')) {
-                            if (@{$reservable_future_order} > 0) {
-                                if ((!$checkedin) || (ref($consumed_uniq) ne 'ARRAY')) {
-                                    $slotstatus = 'RESERVABLE_LATER';
-                                    $datemsg = $reservable_future->{$reservable_future_order->[0]}{'startreserve'};
-                                } else {
-                                    my ($uniqstart,$uniqend,$useslot);
-                                    if (ref($consumed_uniq) eq 'ARRAY') {
-                                        ($uniqstart,$uniqend)=@{$consumed_uniq};
-                                    }
-                                    foreach my $slot (@{$reservable_future_order}) {
-                                        if ($reservable_future->{$slot}{'uniqueperiod'} =~ /^(\d+),(\d+)$/) {
-                                            my ($new_uniq_start,$new_uniq_end) = ($1,$2);
-                                            next if (!
-                                               ($uniqstart < $new_uniq_start && $uniqend < $new_uniq_start) ||
-                                               ($uniqstart > $new_uniq_end   &&  $uniqend > $new_uniq_end  ));
-                                        }
-                                        $useslot = $slot;
-                                        last;
-                                    }
-                                    if ($useslot) {
-                                        $slotstatus = 'RESERVABLE_LATER';
-                                        $datemsg = $reservable_future->{$useslot}{'startreserve'};
-                                    }
-                                }
-                            }
-                        }
-                    }
-                }
+                ($slotstatus,$datemsg) = &check_reservable_slot($slotstatus,$symb,$now,$checkedin,
+                                                                $consumed_uniq);
             }
         }
         return ($slotstatus,$datemsg);
@@ -514,6 +450,81 @@
     return ($slotstatus,$datemsg,$slot_name,$returned_slot,$ipused);
 }
 
+sub check_reservable_slot {
+    my ($slotstatus,$symb,$now,$checkedin,$consumed_uniq) = @_;
+    my $datemsg;
+    if ($slotstatus eq 'NOT_IN_A_SLOT') {
+        if ($env{'request.course.id'}) {
+            my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
+            my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+            unless ($symb) {
+                ($symb)=&Apache::lonnet::whichuser();
+            }
+            $slotstatus = 'NOTRESERVABLE';
+            my ($reservable_now_order,$reservable_now,$reservable_future_order,
+                $reservable_future) =
+                &Apache::loncommon::get_future_slots($cnum,$cdom,$now,$symb);
+            if ((ref($reservable_now_order) eq 'ARRAY') && (ref($reservable_now) eq 'HASH')) {
+                if (@{$reservable_now_order} > 0) {
+                    if ((!$checkedin) || (ref($consumed_uniq) ne 'ARRAY')) {
+                        $slotstatus = 'RESERVABLE';
+                        $datemsg = $reservable_now->{$reservable_now_order->[-1]}{'endreserve'};
+                    } else {
+                        my ($uniqstart,$uniqend,$useslot);
+                        if (ref($consumed_uniq) eq 'ARRAY') {
+                            ($uniqstart,$uniqend)=@{$consumed_uniq};
+                        }
+                        foreach my $slot (reverse(@{$reservable_now_order})) {
+                            if ($reservable_now->{$slot}{'uniqueperiod'} =~ /^(\d+)\,(\d+)$/) {
+                                my ($new_uniq_start,$new_uniq_end) = ($1,$2);
+                                next if (!
+                                    ($uniqstart < $new_uniq_start && $uniqend < $new_uniq_start) ||
+                                    ($uniqstart > $new_uniq_end   &&  $uniqend > $new_uniq_end  ));
+                            }
+                            $useslot = $slot;
+                            last;
+                        }
+                        if ($useslot) {
+                            $slotstatus = 'RESERVABLE';
+                            $datemsg = $reservable_now->{$useslot}{'endreserve'};
+                        }
+                    }
+                }
+            }
+            unless ($slotstatus eq 'RESERVABLE') {
+                if ((ref($reservable_future_order) eq 'ARRAY') && (ref($reservable_future) eq 'HASH')) {
+                    if (@{$reservable_future_order} > 0) {
+                        if ((!$checkedin) || (ref($consumed_uniq) ne 'ARRAY')) {
+                            $slotstatus = 'RESERVABLE_LATER';
+                            $datemsg = $reservable_future->{$reservable_future_order->[0]}{'startreserve'};
+                        } else {
+                            my ($uniqstart,$uniqend,$useslot);
+                            if (ref($consumed_uniq) eq 'ARRAY') {
+                                ($uniqstart,$uniqend)=@{$consumed_uniq};
+                            }
+                            foreach my $slot (@{$reservable_future_order}) {
+                                if ($reservable_future->{$slot}{'uniqueperiod'} =~ /^(\d+),(\d+)$/) {
+                                    my ($new_uniq_start,$new_uniq_end) = ($1,$2);
+                                    next if (!
+                                      ($uniqstart < $new_uniq_start && $uniqend < $new_uniq_start) ||
+                                      ($uniqstart > $new_uniq_end   &&  $uniqend > $new_uniq_end  ));
+                                }
+                                $useslot = $slot;
+                                last;
+                            }
+                            if ($useslot) {
+                                $slotstatus = 'RESERVABLE_LATER';
+                                $datemsg = $reservable_future->{$useslot}{'startreserve'};
+                            }
+                        }
+                    }
+                }
+            }
+        }
+    }
+    return ($slotstatus,$datemsg);
+}
+
 # JB, 9/24/2002: Any changes in this function may require a change
 # in lonnavmaps::resource::getDateStatus.
 sub check_access {
Index: loncom/interface/slotrequest.pm
diff -u loncom/interface/slotrequest.pm:1.136 loncom/interface/slotrequest.pm:1.137
--- loncom/interface/slotrequest.pm:1.136	Fri Dec 22 02:00:46 2017
+++ loncom/interface/slotrequest.pm	Wed Jan 31 15:28:47 2018
@@ -1,7 +1,7 @@
 # The LearningOnline Network with CAPA
 # Handler for requesting to have slots added to a students record
 #
-# $Id: slotrequest.pm,v 1.136 2017/12/22 02:00:46 raeburn Exp $
+# $Id: slotrequest.pm,v 1.137 2018/01/31 15:28:47 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -465,7 +465,7 @@
         return 'error: Unable to determine current status';
     }
     my @problems = $navmap->retrieveResources(undef,
-					      sub { $_[0]->is_gradable() },1,0);
+					      sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0);
     my %used_slots;
     foreach my $problem (@problems) {
 	my $symb = $problem->symb();
@@ -805,7 +805,7 @@
         if ($passed_resource->is_map()) {
 	    my ($a_resource) = 
                 $navmap->retrieveResources($passed_resource, 
-                                           sub {$_[0]->is_gradable()},0,1);
+                                           sub {$_[0]->is_problem() || $_[0]->is_tool() },0,1);
             $symb = $a_resource->symb();
         }
     } else {
@@ -1890,6 +1890,7 @@
 
 sub manage_reservations {
     my ($r,$crstype,$slots,$consumed_uniqueperiods,$allavailable) = @_;
+    my ($cnum,$cdom)=&get_course();
     my $navmap = Apache::lonnavmaps::navmap->new();
     $r->print('<p>'
              .&mt('Instructors may use a reservation system to place restrictions on when and where assignments can be worked on.')
@@ -1921,9 +1922,107 @@
                   '</span>');
         return;
     }
-    my (%parent,%shownparent,%container,%container_title,%contents);
-    my ($depth,$count,$reservable,$lastcontainer,$rownum,$shown) = (0,0,0,0,0,0);
-    my @backgrounds = ("LC_odd_row","LC_even_row");
+    my (%output,%slotinfo,%statusbymap,%repsymbs,%shownmaps);
+    my @possibles = $navmap->retrieveResources(undef,
+                                              sub { $_[0]->is_problem() || $_[0]->is_tool() },1,0);
+
+    foreach my $resource (@possibles) {
+        my ($useslots) = $resource->slot_control();
+        next if (($useslots eq '') || ($useslots =~ /^\s*no\s*$/i));
+        my $symb = $resource->symb();
+        my ($slot_status,$date,$slot_name) = $resource->check_for_slot('0');
+        my ($msg,$get_choices,$slotdescription);
+        my $status = $resource->simpleStatus('0');
+        my ($msg,$get_choices,$slotdescription);
+        if ($slot_name ne '') {
+            my %slot=&Apache::lonnet::get_slot($slot_name);
+            $slotdescription=&get_description($slot_name,\%slot);
+        }
+        if ($slot_status == $resource->NOT_IN_A_SLOT) {
+            $msg=&mt('No current reservation.');
+            $get_choices = 1;
+        } elsif ($slot_status == $resource->NEEDS_CHECKIN) {
+            $msg='<span class="LC_nobreak">'.&mt('Reserved:').
+                 ' '.$slotdescription.'</span><br />'.
+                 &mt('Access requires proctor validation.');
+        } elsif ($slot_status == $resource->WAITING_FOR_GRADE) {
+            $msg=&mt('Submitted and currently in grading queue.');
+        } elsif ($slot_status == $resource->CORRECT) {
+            $msg=&mt('Problem is unavailable.');
+        } elsif ($slot_status == $resource->RESERVED) {
+            $msg='<span class="LC_nobreak">'.&mt('Reserved:').
+                 ' '.$slotdescription.'</span><br />'.
+                 &mt('Problem is currently available.');
+        } elsif ($slot_status == $resource->RESERVED_LOCATION) {
+            $msg='<span class="LC_nobreak">'.&mt('Reserved:').
+                 ' '.$slotdescription.'</span><br />'.
+                 &mt('Problem is available at a different location.');
+            $get_choices = 1;
+        } elsif ($slot_status == $resource->RESERVED_LATER) {
+            $msg='<span class="LC_nobreak">'.&mt('Reserved:').
+                 ' '.$slotdescription.'</span><br />'.
+                 &mt('Problem will be available later.');
+            $get_choices = 1;
+        } elsif ($slot_status == $resource->RESERVABLE) {
+            $msg=&mt('Reservation needed');
+            $get_choices = 1;
+        } elsif ($slot_status == $resource->RESERVABLE_LATER) {
+            $msg=&mt('Reservation needed: will be reservable later.');
+        } elsif ($slot_status == $resource->NOTRESERVABLE) {
+            $msg=&mt('Reservation needed: none available.');
+        } elsif ($slot_status == $resource->UNKNOWN) {
+            $msg=&mt('Unable to determine status due to network problems.');
+        } else {
+            if ($status != $resource->OPEN) {
+                $msg = &Apache::lonnavmaps::getDescription($resource,'0');
+            }
+        }
+        $output{$symb}{'msg'} = $msg;
+        if (($status == $resource->OPEN) && ($get_choices)) {
+            $output{$symb}{'hasaction'} = 1;
+        }
+        my ($mapurl,$id,$resurl) = &Apache::lonnet::decode_symb($symb);
+        $mapurl = &Apache::lonnet::clutter($mapurl);
+        unless ($mapurl =~ /default\.sequence$/) {
+            $shownmaps{$mapurl} = 1;
+            my $map = $navmap->getResourceByUrl($mapurl);
+            if (ref($map)) {
+                my @pcs = split(/,/,$map->map_hierarchy());
+                shift(@pcs);
+                shift(@pcs);
+                if (@pcs) {
+                    map { $shownmaps{$navmap->getByMapPc($_)->src()} = 1; } reverse(@pcs);
+                }
+            }
+        }
+        if (($useslots eq 'map_map') || ($useslots eq 'map')) {
+            if ($slot_status ne '') {
+                if (ref($statusbymap{$mapurl}{$slot_status}) eq 'ARRAY') {
+                    push(@{$statusbymap{$mapurl}{$slot_status}},$symb);
+                } else {
+                    $statusbymap{$mapurl}{$slot_status} = [$symb];
+                }
+            }
+        }
+    }
+
+    foreach my $mapurl (keys(%statusbymap)) {
+        if (ref($statusbymap{$mapurl}) eq 'HASH') {
+            if (keys(%{$statusbymap{$mapurl}}) == 1) {
+                my @values = values(%{$statusbymap{$mapurl}});
+                my $repsymb = $values[0][0];
+                if (ref($output{$repsymb}) eq 'HASH') {
+                    $output{$mapurl}{'msg'} = $output{$repsymb}{'msg'};
+                    $output{$mapurl}{'hasaction'} = $output{$repsymb}{'hasaction'};
+                }
+                $repsymbs{$mapurl} = $repsymb;
+            }
+        }
+    }
+
+    my (%parent,%container,%container_title);
+    my ($depth,$count,$reservable,$currcontainer,$rownum,$mapnum,$shown) = (0,0,0,0,0,0,0);
+    my @backgrounds = ("LC_even_row","LC_odd_row");
     my $numcolors = scalar(@backgrounds);
     my $location=&Apache::loncommon::lonhttpdurl("/adm/lonIcons/whitespace_21.gif");
     my $slotheader = '<p>'.
@@ -1931,254 +2030,125 @@
                  '</p>'.
                  '<table class="LC_data_table LC_tableOfContent" id="LC_slot_reservations">'."\n";
     my $shownheader = 0;
+    my $currmap;
     my $it=$navmap->getIterator(undef,undef,undef,1,undef,undef);
-    my (@ordered,%output,$mapitem,$got_map_slot,$currmapoutput,$mapnum);
-    $mapnum = 0;
-    $shown = 0;
     while (my $resource = $it->next()) {
         if ($resource == $it->BEGIN_MAP()) {
             $depth++;
-            $parent{$depth} = $lastcontainer;
-        }
-        if ($resource == $it->END_MAP()) {
-            $depth--;
-            $lastcontainer = $parent{$depth};
-            my %allstatuses;
-            foreach my $symb (@ordered) {
-                if (ref($output{$symb}) eq 'HASH') {
-                    if (($output{$symb}{'type'} eq 'map_map') || ($output{$symb}{'type'} eq 'map')) {
-                        if ($output{$symb}{'slotstatus'} ne '') {
-                            if (ref($allstatuses{$output{$symb}{'slotstatus'}}) eq 'ARRAY') {
-                                push(@{$allstatuses{$output{$symb}{'slotstatus'}}},$symb);
+            $parent{$depth} = $currcontainer;
+            if (ref($container{$currcontainer})) {
+                my $currmapres = $container{$currcontainer};
+                my $currmaptitle = $container_title{$currcontainer};
+                $currmap = $currmapres->src();
+                my $currmaptype = 'sequence';
+                if ($currmapres->is_page()) {
+                    $currmaptype = 'page';
+                }
+                if ($shownmaps{$currmap}) {
+                    $mapnum ++;
+                    $rownum ++;
+                    $shown ++;
+                    if (!$shownheader) {
+                        $r->print($slotheader);
+                        $shownheader = 1;
+                    }
+                    my $bgcolor = $backgrounds[$shown % $numcolors];
+                    my ($spacers,$icon);
+                    my $row = '<tr class="'.$bgcolor.'" id="LC_slotmaprow_'.$rownum.'">';
+                    if (ref($statusbymap{$currmap}) eq 'HASH') {
+                        my ($spacers,$icon) = &show_map_row($depth-1,$location,$currmaptype,$currmaptitle);
+                        my $arrowstate = 'open';
+                        if (keys(%{$statusbymap{$currmap}}) == 1) {
+                            $arrowstate = 'closed';
+                        }
+                        $row .= '<td>'.$spacers.'<img src="/adm/lonIcons/arrow.'.$arrowstate.'.gif" '.
+                                'id="arrow'.$mapnum.'" '.'alt="arrow" onmouseover="this.style.cursor=\'pointer\'" '.
+                                'onclick="'."toggleSlotMap('$mapnum','$rownum');".'" />'.
+                                $icon.(' ' x6).'</td>'."\n";
+                        if (ref($output{$currmap}) eq 'HASH') {
+                            my $formnum = $mapnum.'_'.$reservable+1;
+                            my $class = 'LC_slotmaptext_'.$mapnum;
+                            if ($output{$currmap}{'hasaction'}) {
+                                $row .= '<td valign="top"><span class="'.$class.'">'.
+                                          $output{$currmap}{'msg'}.
+                                          '</span></td><td valign="top">'.
+                                          &slot_chooser($repsymbs{$currmap},$class,$formnum,
+                                                        $allavailable,$slots,$consumed_uniqueperiods).
+                                          '</td>';
                             } else {
-                                $allstatuses{$output{$symb}{'slotstatus'}} = [$symb];
+                                $row .= '<td colspan="2" valign="middle"><span class="'.$class.'">'.
+                                          $output{$currmap}{'msg'}.
+                                          '</span></td>';
                             }
+                            $row .= '</tr>'."\n";
+                        } else {
+                            $row .= '<td colspan="2"> </td></tr>'."\n";
                         }
-                    }
-                }
-            }
-            if (keys(%allstatuses) == 1) {
-                $got_map_slot = 1;
-                my $repsymb;
-                my @values = values(%allstatuses);
-                if (ref($values[0]) eq 'ARRAY') {
-                    if (ref($output{$values[0][0]}) eq 'HASH') {
-                        $repsymb = $values[0][0];
-                    }
-                }
-                if (($mapitem) && ($repsymb)) {
-                    my $formnum = $mapnum.'_'.$output{$repsymb}{'reservable'};
-                    my $class = 'LC_slotmaptext_'.$mapnum;
-                    if ($output{$repsymb}{'hasaction'}) {
-                        $mapitem .= '<td valign="top"><span class="'.$class.'">'.
-                                    $output{$repsymb}{'msg'}.
-                                    '</span></td><td valign="top">'.
-                                    &slot_chooser($repsymb,$class,$formnum,$allavailable,$slots,
-                                                  $consumed_uniqueperiods).
-                                   '</td>';
-
                     } else {
-                        $mapitem .= '<td colspan="2" valign="middle"><span class="'.$class.'">'.
-                                    $output{$repsymb}{'msg'}.
-                                    '</span></td>';
-                    }
-                }
-                my $counter = 0;
-                foreach my $symb (@ordered) {
-                    if (ref($output{$symb}) eq 'HASH') {
-                        $counter ++;
-                        my $bgcolor = $backgrounds[($output{$symb}{'shown'} + $counter) % $numcolors];
-                        $currmapoutput .= $output{$symb}{'header'}.
-                                          '<tr class="'.$bgcolor.' LC_slotresrow_'.$output{$symb}{'mapnum'}.'"'.
-                                          ' style="display:none" id="LC_slotresrow_'.$output{$symb}{'rownum'}.'">'.
-                                          $output{$symb}{'info'}.
-                                          $output{$symb}{'data'}.'</tr>'."\n";
-                    }
-                }
-            } else {
-                my $counter = 0;
-                foreach my $symb (@ordered) {
-                    if (ref($output{$symb}) eq 'HASH') {
-                        $counter ++;
-                        my $bgcolor = $backgrounds[($output{$symb}{'shown'} + $counter) % $numcolors];
-                        $currmapoutput .= $output{$symb}{'header'}.
-                                          '<tr class="'.$bgcolor.' LC_slotresrow_'.$output{$symb}{'mapnum'}.'"'.
-                                          ' style="display:table-row" id="LC_slotresrow_'.$output{$symb}{'rownum'}.'">'.
-                                          $output{$symb}{'info'}.
-                                          $output{$symb}{'data'}.'</tr>'."\n";
-                        $shown ++;
+                        my ($spacers,$icon) = &show_map_row($depth,$location,$currmaptype,$currmaptitle);
+                        $row .= '<td>'.$spacers.$icon.(' ' x6).'</td><td colspan="2"> </td></tr>'."\n";
                     }
+                    $r->print($row);
                 }
             }
-            if ($mapitem) {
-                if ($got_map_slot) {
-                    $mapitem =~ s{(<img src=\"/adm/lonIcons/arrow\.)open(\.gif\")}{$1closed$2};
-                    $mapitem .= '</tr>'."\n";
-                } else {
-                    $mapitem .= '<td colspan="2"> </td></tr>'."\n";
-                }
-            }
-            $r->print($mapitem.$currmapoutput);
-            @ordered=();
-            undef(%output);
-            $currmapoutput = '';
-            $got_map_slot = '';
-            $mapitem = '';
-        }
-        if (ref($resource)) {
+        } elsif ($resource == $it->END_MAP()) {
+            $depth--;
+            $currcontainer = $parent{$depth};
+        } elsif (ref($resource)) {
             my $symb = $resource->symb();
-            $contents{$lastcontainer} ++;
-            next if (!$resource->is_gradable() && !$resource->is_sequence() && 
-                     !$resource->is_page());
+            next if (!$resource->is_problem() && !$resource->is_tool() &&
+                     !$resource->is_sequence() && !$resource->is_page());
             $count ++;
             if (($resource->is_sequence()) || ($resource->is_page())) {
-                $lastcontainer = $count;
-                $container{$lastcontainer} = $resource;
-                $container_title{$lastcontainer} = $resource->compTitle();
-            }
-            if ($resource->is_gradable()) {
-                my ($useslots) = $resource->slot_control();
-                next if (($useslots eq '') || ($useslots =~ /^\s*no\s*$/i));
-                push(@ordered,$symb); 
-                $output{$symb}{type} = $useslots;  
-                my ($msg,$get_choices,$slotdescription);
-                my $title = $resource->compTitle();
-                my $status = $resource->simpleStatus('0');
-                my ($slot_status,$date,$slot_name) = $resource->check_for_slot('0');
-
-                $output{$symb}{'slotstatus'} = $slot_status;
-                $output{$symb}{'slotname'} = $slot_name; 
-                if ($slot_name ne '') {
-                    my %slot=&Apache::lonnet::get_slot($slot_name);
-                    $slotdescription=&get_description($slot_name,\%slot);
-                }
-                if ($slot_status == $resource->NOT_IN_A_SLOT) {
-                    $msg=&mt('No current reservation.');
-                    $get_choices = 1;
-                } elsif ($slot_status == $resource->NEEDS_CHECKIN) {
-                    $msg='<span class="LC_nobreak">'.&mt('Reserved:').
-                         ' '.$slotdescription.'</span><br />'.
-                         &mt('Access requires proctor validation.');
-                } elsif ($slot_status == $resource->WAITING_FOR_GRADE) {
-                    $msg=&mt('Submitted and currently in grading queue.');
-                } elsif ($slot_status == $resource->CORRECT) {
-                    $msg=&mt('Problem is unavailable.');
-                } elsif ($slot_status == $resource->RESERVED) {
-                    $msg='<span class="LC_nobreak">'.&mt('Reserved:').
-                         ' '.$slotdescription.'</span><br />'.
-                         &mt('Problem is currently available.');
-                } elsif ($slot_status == $resource->RESERVED_LOCATION) {
-                    $msg='<span class="LC_nobreak">'.&mt('Reserved:').
-                         ' '.$slotdescription.'</span><br />'.
-                         &mt('Problem is available at a different location.');
-                    $get_choices = 1;
-                } elsif ($slot_status == $resource->RESERVED_LATER) {
-                    $msg='<span class="LC_nobreak">'.&mt('Reserved:').
-                         ' '.$slotdescription.'</span><br />'.
-                         &mt('Problem will be available later.');
-                    $get_choices = 1;
-                } elsif ($slot_status == $resource->RESERVABLE) {
-                    $msg=&mt('Reservation needed');
-                    $get_choices = 1;
-                } elsif ($slot_status == $resource->RESERVABLE_LATER) {
-                    $msg=&mt('Reservation needed: will be reservable later.');
-                } elsif ($slot_status == $resource->NOTRESERVABLE) {
-                    $msg=&mt('Reservation needed: none available.');
-                } elsif ($slot_status == $resource->UNKNOWN) {
-                    $msg=&mt('Unable to determine status due to network problems.');
-                } else {
-                    if ($status != $resource->OPEN) {
-                        $msg = &Apache::lonnavmaps::getDescription($resource,'0'); 
-                    }
-                }
-                $output{$symb}{'msg'} = $msg;
+                $currcontainer = $count;
+                $container{$currcontainer} = $resource;
+                $container_title{$currcontainer} = $resource->compTitle();
+            }
+            if (($resource->is_problem() || $resource->is_tool)) {
+                next unless (exists($output{$symb}));
                 $reservable ++;
-                $output{$symb}{'reservable'} = $reservable;
-                my $treelevel = $depth;
-                my $higherup = $lastcontainer;
-                if ($depth > 1) {
-                    my @maprows;
-                    while ($treelevel > 1) {
-                        if (ref($container{$higherup})) {
-                            my $res = $container{$higherup};
-                            last if (defined($shownparent{$higherup}));
-                            my $maptitle = $res->compTitle();
-                            my $type = 'sequence';
-                            if ($res->is_page()) {
-                                $type = 'page';
-                            }
-                            &show_map_row($treelevel,$location,$type,$maptitle,
-                                          \@maprows);
-                            $shownparent{$higherup} = 1;
-                        }
-                        $treelevel --;
-                        $higherup = $parent{$treelevel};
-                    }
-                    for (my $i=0; $i<@maprows; $i++) {
-                        $mapnum ++;
-                        $rownum ++;
-                        $shown ++;
-                        my $bgcolor = $backgrounds[$shown % $numcolors];
-                        if (!$shownheader) {
-                            $mapitem .= $slotheader;
-                            $shownheader = 1;
-                        }
-                        if (ref($maprows[$i]) eq 'ARRAY') {
-                            if ($i < scalar(@maprows)-1) {
-                                $mapitem .= '<tr class="'.$bgcolor.'" id="LC_slotmaprow_'.$rownum.'">'.
-                                            '<td>'.join('',@{$maprows[$i]}).'</td>'.
-                                            '<td colspan="2"> </td></tr>'."\n";
-                            } else {
-                                $mapitem .= 
-                                   '<tr class="'.$bgcolor.'" id="LC_slotmaprow_'.$rownum.'">'.
-                                   '<td>'.$maprows[$i][0].
-                                   '<img src="/adm/lonIcons/arrow.open.gif" id="arrow'.$mapnum.'" '.
-                                   'alt="arrow" onmouseover="this.style.cursor=\'pointer\'" '.
-                                   'onclick="'."toggleSlotMap('$mapnum','$rownum');".'" />'.
-                                   $maprows[$i][1].(' ' x6).'</td>'."\n";
-                            }
-                        }
-                    }
-                    $output{$symb}{'mapnum'} = $mapnum;
-                }
                 $rownum ++;
-                $output{$symb}{'rownum'} = $rownum;
-                $output{$symb}{'shown'} = $shown;
                 if (!$shownheader) {
-                    $output{$symb}{'header'} = $slotheader;
+                    $r->print($slotheader);
                     $shownheader = 1;
                 }
-                $output{$symb}{'info'} = '<td>';
+                my $style;
+                if (exists($output{$currmap})) {
+                    $style = 'none';
+                } else {
+                    $style = 'table-row';
+                    $shown ++;
+                }
+                my $title = $resource->compTitle();
+                my $bgcolor = $backgrounds[$shown % $numcolors];
+                $r->print('<tr class="'.$bgcolor.' LC_slotresrow_'.$mapnum.'"'.
+                          ' style="display:'.$style.'" id="LC_slotresrow_'.$rownum.'">'.
+                          '<td>');
                 for (my $i=0; $i<$depth; $i++) {
-                    $output{$symb}{'info'} .= '<img src="'.$location.'" alt="" />';
+                    $r->print('<img src="'.$location.'" alt="" />');
                 }
-                $output{$symb}{'info'} .= '<a href="'.$resource->src().'?symb='.$symb.'">'.
-                                         '<img class="LC_contentImage" src="/adm/lonIcons/';
+                $r->print('<a href="'.$resource->src().'?symb='.$symb.'">'.
+                          '<img class="LC_contentImage" src="/adm/lonIcons/');
                 if ($resource->is_task()) {
-                    $output{$symb}{'info'} .= 'task.gif" alt="'.&mt('Task');
+                    $r->print('task.gif" alt="'.&mt('Task'));
+                } elsif ($resource->is_tool()) {
+                    $r->print('unknown.gif" alt="'.&mt('External Tool'));
                 } else {
-                    $output{$symb}{'info'} .= 'problem.gif" alt="'.&mt('Problem');
-                }
-                $output{$symb}{'info'} .= '" /><b>'.$title.'</b></a>'.(' ' x6).'</td>';
-
-                my $hasaction;
-                if ($status == $resource->OPEN) {
-                    if ($get_choices) {
-                        $hasaction = 1;
-                        $output{$symb}{'hasaction'} = $hasaction;
-                    }
+                    $r->print('problem.gif" alt="'.&mt('Problem'));
                 }
+                $r->print('" /><b>'.$title.'</b></a>'.(' ' x6).'</td>');
                 my $class = 'LC_slottext_'.$mapnum;
-                if ($hasaction) {
-                    $output{$symb}{'data'} = '<td valign="top"><span class="'.$class.'">'.$msg.'</span></td>'.
-                                             '<td valign="top">'.
-                                             &slot_chooser($symb,$class,$reservable,$allavailable,$slots,
-                                                           $consumed_uniqueperiods).'</td>';
+                if ($output{$symb}{'hasaction'}) {
+                    $r->print('<td valign="top"><span class="'.$class.'">'.$output{$symb}{'msg'}.'</span></td>'.
+                              '<td valign="top">'.
+                              &slot_chooser($symb,$class,$reservable,$allavailable,$slots,
+                                            $consumed_uniqueperiods).'</td>');
                 } else {
-                    $output{$symb}{'data'} = '<td colspan="2" valign="middle">'.
-                                             '<span class="'.$class.'">'.$msg.'</span>'.
-                                             '</td>';
+                    $r->print('<td colspan="2" valign="middle">'.
+                              '<span class="'.$class.'">'.$output{$symb}{'msg'}.'</span>'.
+                              '</td>');
                 }
+                $r->print('</tr>'."\n");
             }
         }
     }
@@ -2199,9 +2169,9 @@
 }
 
 sub show_map_row {
-    my ($depth,$location,$type,$title,$maprows) = @_;
+    my ($depth,$location,$type,$title) = @_;
     my $spacers;
-    for (my $i=0; $i<$depth-2; $i++) {
+    for (my $i=0; $i<$depth-1; $i++) {
         $spacers .= '<img src="'.$location.'" alt="" />';
     }
     my $icon;
@@ -2211,8 +2181,7 @@
         $icon = '<img src="/adm/lonIcons/navmap.folder.open.gif" alt="" /> '."\n";
     }
     $icon .= $title;
-    unshift (@{$maprows},[$spacers,$icon]);
-    return;
+    return ($spacers,$icon);
 }
 
 sub slot_chooser {
@@ -2273,8 +2242,7 @@
         $udom = $env{'user.domain'};
     }
     my $formname = 'slotlog';
-    my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
-    my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+    my ($cnum,$cdom)=&get_course();
     my $crstype = &Apache::loncommon::course_type();
     my %log=&Apache::lonnet::dump('nohist_'.$cdom.'_'.$cnum.'_slotlog',$udom,$uname);
     if ($env{'form.origin'} eq 'aboutme') {
@@ -2449,8 +2417,7 @@
         return;
     }
     my $formname = 'reservationslog';
-    my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
-    my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
+    my ($cnum,$cdom)=&get_course();
     my %slotlog=&Apache::lonnet::dump('nohist_slotreservationslog',$cdom,$cnum);
     if ((keys(%slotlog))[0]=~/^error\:/) { undef(%slotlog); }
 
Index: doc/loncapafiles/loncapafiles.lpml
diff -u doc/loncapafiles/loncapafiles.lpml:1.963 doc/loncapafiles/loncapafiles.lpml:1.964
--- doc/loncapafiles/loncapafiles.lpml:1.963	Fri Jan 12 13:34:57 2018
+++ doc/loncapafiles/loncapafiles.lpml	Wed Jan 31 15:29:28 2018
@@ -2,7 +2,7 @@
  "http://lpml.sourceforge.net/DTD/lpml.dtd">
 <!-- loncapafiles.lpml -->
 
-<!-- $Id: loncapafiles.lpml,v 1.963 2018/01/12 13:34:57 raeburn Exp $ -->
+<!-- $Id: loncapafiles.lpml,v 1.964 2018/01/31 15:29:28 raeburn Exp $ -->
 
 <!--
 
@@ -6725,6 +6725,16 @@
 <status>works/unverified</status>
 </file>
 <file>
+<source>loncom/auth/lonslotcheck.pm</source>
+<target dist='default'>home/httpd/lib/perl/Apache/lonslotcheck.pm</target>
+<categoryname>handler</categoryname>
+<description>Checks if access to a non-gradable external tool uses slots. 
+Disable subsequent PerlHandlers if a slot is in use, and slot status does
+not currently allow access.
+</description>
+<status>works/unverified</status>
+</file>
+<file>
   <source>loncom/auth/publiccheck.pm</source>
   <target dist='default'>home/httpd/lib/perl/Apache/publiccheck.pm</target>
   <categoryname>handler</categoryname>

Index: loncom/auth/lonslotcheck.pm
+++ loncom/auth/lonslotcheck.pm
# Checks slot access settings - disable subsequent 
# PerlHandlers unless access availble
# $Id: lonslotcheck.pm,v 1.1 2018/01/31 15:29:07 raeburn Exp $
#
# Copyright Michigan State University Board of Trustees
#
# This file is part of the LearningOnline Network with CAPA (LON-CAPA).
#
# LON-CAPA is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# LON-CAPA is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with LON-CAPA; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#
# /home/httpd/html/adm/gpl.txt
#
# http://www.lon-capa.org/
#

package Apache::lonslotcheck;

use strict;
use Apache::lonnet;
use Apache::lonlocal;
use Apache::loncommon();
use Apache::structuretags();
use Apache::lonhomework();
use Apache::bridgetask();
use Apache::Constants qw(:common :http :methods);

sub handler {
    my ($r) = @_;
    if (($r->uri !~ /ext\.tool$/) ||
        (&Apache::lonnet::EXT('resource.0.gradable',$env{'request.symb'}) =~ /^yes$/i)) {
        return DECLINED;
    }
    my ($symb,$courseid,$udom,$uname) = &Apache::lonnet::whichuser();
    my $useslots = &Apache::lonnet::EXT("resource.0.useslots",$symb);
    if ($useslots ne 'resource' && $useslots ne 'map'
        && $useslots ne 'map_map') {
        return DECLINED;
    }
    my ($status,$accessmsg,$slot_name,$slot,$ipused) = 
        &check_slot_access($symb,$courseid,$udom,$uname);

    my $output;
    if ($status eq 'CHECKED_IN') {
        if ($slot_name ne '') {
            my $checkin = 'resource.0.checkedin';
            if (($Apache::lonhomework::history{$checkin}) &&
                ($Apache::lonhomework::history{"$checkin.slot"} eq $slot_name)) {
                &do_cleanup();
                return DECLINED;
            } else {
                my $closedate = &Apache::lonnet::EXT("resource.0.contentclose",$symb,
                                                     $udom,$uname);
                &Apache::structuretags::selfcheckin_resource($closedate,$slot_name,$slot,$symb);
                if ($Apache::lonhomework::results{$checkin}) {
                    &Apache::structuretags::finalize_storage();
                    &do_cleanup();
                    return DECLINED;
                } else {
                    $output = '<p class="LC_error">'.&mt('Error during self-checkin to slot').
                              '</p>';
                }
            }
        } else {
            $output = '<p class="LC_error">'.&mt('Error no slot available for self-checkin').
                          '</p>';
        }
    } elsif ($status eq 'NEEDS_CHECKIN') {
        if (defined($env{'form.submitted'}) && defined($env{'form.validate'})) {
            if (&Apache::bridgetask::proctor_check_auth($slot_name,$slot)) {
                &Apache::structuretags::finalize_storage();
                &do_cleanup();
                return DECLINED;
            } else {
                $output =  '<p class="LC_error">'.&mt('Check-in failed').'</p>'.
                           &Apache::bridgetask::proctor_validation_screen($slot);
            }
        } else {
            $output = &Apache::bridgetask::proctor_validation_screen($slot);
        }
    } elsif (( $status eq 'NOT_IN_A_SLOT' ) ||
             ( $status eq 'NOTRESERVABLE') ||
             ( $status eq 'RESERVABLE') ||
             ( $status eq 'RESERVABLE_LATER') ||
             ( $status eq 'NEED_DIFFERENT_IP')) {
        $output = &Apache::structuretags::access_status_msg('tool',$status,$symb,
                                                            'web',$ipused,$accessmsg);
    }

    $r->set_handlers('PerlHandler'=>undef);
    &Apache::loncommon::content_type($r,'text/html');
    $r->send_http_header;
    if ($r->header_only) {
        &do_cleanup();
        return OK;
    }

    my $start_page =
        &Apache::loncommon::start_page('Not Open',undef,
                                        {'bgcolor'        => '#FFFFFF',
                                         'force_register' => 1,});
    my $end_page =
        &Apache::loncommon::end_page({'discussion' => 1});
        $r->print($start_page.$output.$end_page);
    &do_cleanup();
    return OK;
}

sub check_slot_access {
    my ($symb,$courseid,$udom,$uname) = @_;
    &Apache::structuretags::initialize_storage($symb);
    my $checkin = 'resource.0.checkedin';
    my $checkedin = $Apache::lonhomework::history{$checkin};
    my ($returned_slot,$slot_name,$checkinslot,$ipused,$blockip,$now,$ip,
        $consumed_uniq);
    $now = time;
    $ip=$ENV{'REMOTE_ADDR'} || $env{'request.host'};
    if ($checkedin) {
        $checkinslot = $Apache::lonhomework::history{"$checkin.slot"};
        my %slot=&Apache::lonnet::get_slot($checkinslot);
        $consumed_uniq = $slot{'uniqueperiod'};
        if ($slot{'iptied'}) {
            $ipused = $Apache::lonhomework::history{"$checkin.ip"};
            unless (($ip ne '') && ($ipused eq $ip)) {
                $blockip = $slot{'iptied'};
                $slot_name = $checkinslot;
                $returned_slot = \%slot;
                return ('NEED_DIFFERENT_IP','',$slot_name,$returned_slot,$ipused);
            }
        }
    }

    my $availablestudent = &Apache::lonnet::EXT("resource.0.availablestudent",$symb);
    my $available = &Apache::lonnet::EXT("resource.0.available",$symb);
    my @slots= (split(':',$availablestudent),split(':',$available));

    my $slotstatus='NOT_IN_A_SLOT';
    my $num_usable_slots = 0;
    my $datemsg;

    foreach my $slot (@slots) {
        $slot =~ s/(^\s*|\s*$)//g;
        my %slot=&Apache::lonnet::get_slot($slot);
        next if ($slot{'endtime'} < $now);
        $num_usable_slots ++;
        if ($slot{'starttime'} < $now &&
            $slot{'endtime'} > $now &&
            &Apache::loncommon::check_ip_acc($slot{'ip'})) {
            if ($slot{'iptied'}) {
                if ($env{'request.course.id'}) {
                    my $cdom = $env{'course.'.$env{'request.course.id'}.'.domain'};
                    my $cnum = $env{'course.'.$env{'request.course.id'}.'.num'};
                    if ($slot eq $checkinslot) {
                        if ($ip eq $ipused) {
                            $slotstatus ='NEEDS_CHECKIN';
                        } else {
                            $slotstatus = 'NEED_DIFFERENT_IP';
                            $slot_name = $slot;
                            $returned_slot = \%slot;
                            last;
                        }
                    } elsif ($ip) {
                        my $uniqkey = "$slot\0$symb\0$ip";
                        my %used_ip = &Apache::lonnet::get('slot_uniqueips',[$uniqkey],$cdom,$cnum);
                        if ($used_ip{$uniqkey}) {
                            $slotstatus = 'NEED_DIFFERENT_IP';
                        } else {
                            $slotstatus ='NEEDS_CHECKIN';
                        }
                    }
                }
            } else {
                $slotstatus='NEEDS_CHECKIN';
            }
            if ($slotstatus eq 'NEEDS_CHECKIN') {
                $returned_slot=\%slot;
                $slot_name=$slot;
                last;
            }
        }
    }

    if (($slotstatus eq 'NEEDS_CHECKIN') && (ref($returned_slot) eq 'HASH')) {
        if (&Apache::lonhomework::proctor_checked_in($slot_name,$returned_slot,'tool')) {
            $slotstatus = 'CHECKED_IN';
            return ($slotstatus,$datemsg,$slot_name,$returned_slot,$ipused);
        }
    }

    # Previously used slot is no longer open, and has been checked in.
    # However, the resource is not closed, and potentially, another slot might be
    # used to gain access to it, until the content close date is reached.
    # Therefore return the slotstatus -
    # (which will be one of: NOT_IN_A_SLOT, RESERVABLE, RESERVABLE_LATER, or NOTRESERVABLE).

    if (!defined($slot_name)) {
        if ($slotstatus eq 'NOT_IN_A_SLOT') {
            if (!$num_usable_slots) {
                ($slotstatus,$datemsg) = &Apache::lonhomework::check_reservable_slot($slotstatus,$symb,$now,
                                                                                     $checkedin,$consumed_uniq);
            }
        }
    }
    return ($slotstatus,$datemsg,$slot_name,$returned_slot,$ipused);
}

sub do_cleanup {
    undef(%Apache::lonhomework::results);
    undef(%Apache::lonhomework::history);
}

1;


More information about the LON-CAPA-cvs mailing list