[LON-CAPA-cvs] cvs: loncom /interface portfolio.pm

raeburn lon-capa-cvs@mail.lon-capa.org
Sun, 05 Nov 2006 21:08:53 -0000


This is a MIME encoded message

--raeburn1162760933
Content-Type: text/plain

raeburn		Sun Nov  5 16:08:53 2006 EDT

  Modified files:              
    /loncom/interface	portfolio.pm 
  Log:
  Setting of conditional access controls now occurs on a seperate screen from setting of public and passphrase-protected controls.
  
  
--raeburn1162760933
Content-Type: text/plain
Content-Disposition: attachment; filename="raeburn-20061105160853.txt"

Index: loncom/interface/portfolio.pm
diff -u loncom/interface/portfolio.pm:1.169 loncom/interface/portfolio.pm:1.170
--- loncom/interface/portfolio.pm:1.169	Wed Nov  1 11:12:35 2006
+++ loncom/interface/portfolio.pm	Sun Nov  5 16:08:53 2006
@@ -1,7 +1,7 @@
 # The LearningOnline Network
 # portfolio browser
 #
-# $Id: portfolio.pm,v 1.169 2006/11/01 16:12:35 albertel Exp $
+# $Id: portfolio.pm,v 1.170 2006/11/05 21:08:53 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -244,7 +244,7 @@
                                                   $current_permissions,$group);
     my %access_controls = &Apache::lonnet::get_access_controls($current_permissions,$group);
     my $now = time;
-    if ($env{"form.mode"} eq 'selectfile'){
+    if ($env{"form.mode"} eq 'selectfile') {
 	&select_files($r);
 	$checked_files =&Apache::lonnet::files_in_path($uname,$env{'form.currentpath'});
 	$select_mode = 'true';
@@ -745,7 +745,7 @@
 }
 
 sub display_access {
-    my ($r,$url,$group,$can_setacl,$port_path) = @_;
+    my ($r,$url,$group,$can_setacl,$port_path,$action) = @_;
     my ($uname,$udom) = &get_name_dom();
     my $file_name = $env{'form.currentpath'}.$env{'form.access'};
     $file_name = &prepend_group($file_name);
@@ -753,15 +753,20 @@
                                                                         $uname);
     my %access_controls = &Apache::lonnet::get_access_controls($current_permissions,$group,$file_name);
     my $aclcount = keys(%access_controls);
-    my $header = '<h3>'.&mt('Allowing others to retrieve file: [_1]',$port_path.$env{'form.currentpath'}.$env{'form.access'}).'</h3>';
-    my $info .= &mt('Access to this file by others can be set to be one or more of the following types: public, passphrase-protected or conditional.');
-    $info .= '<br /><ul><li>'.&mt('Public files are available to anyone without the need for login.');
-    $info .= '</li><li>'.&mt('Passphrase-protected files do not require log-in, but will require the viewer to enter the passphrase you set.');
-    $info .= '</li><li>'.&mt('Conditional files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').'<br />';
-    $info .= &mt('The conditions can include affiliation with a particular course or group, or a user account in a specific domain.').'<br />';
-    $info .= &mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.').'</li></ul>';
-    if ($group eq '') {
-        $info .= (&mt("A listing of files viewable without log-in is available at: <a href='/adm/$udom/$uname/aboutme/portfolio'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme/portfolio</a>.<br />For logged in users a 'Display file listing' link will also appear (when there are viewable files) on your personal information page:<br /><a href='/adm/$udom/$uname/aboutme'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme</a><br />"));
+    my ($header,$info);
+    if ($action eq 'chgaccess') {
+        $header = '<h3>'.&mt('Allowing others to retrieve file: [_1]',$port_path.$env{'form.currentpath'}.$env{'form.access'}).'</h3>';
+        $info .= &mt('Access to this file by others can be set to be one or more of the following types: public, passphrase-protected or conditional.');
+        $info .= '<br /><ul><li>'.&mt('Public files are available to anyone without the need for login.');
+        $info .= '</li><li>'.&mt('Passphrase-protected files do not require log-in, but will require the viewer to enter the passphrase you set.');
+        $info .= '</li><li>'.&explain_conditionals();
+        $info .= '</li></ul>';
+        if ($group eq '') {
+            $info .= (&mt("A listing of files viewable without log-in is available at: <a href='/adm/$udom/$uname/aboutme/portfolio'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme/portfolio</a>.<br />For logged in users a 'Display file listing' link will also appear (when there are viewable files) on your personal information page:<br /><a href='/adm/$udom/$uname/aboutme'>http://$ENV{'SERVER_NAME'}/adm/$udom/$uname/aboutme</a><br />"));
+        }
+    } else {
+        $header = '<h3>'.&mt('Conditional access controls for file: [_1]',$port_path.$env{'form.currentpath'}.$env{'form.access'}).'</h3>'.
+                  &explain_conditionals().'<br />';
     }
     if ($can_setacl) {
         &open_form($r,$url);
@@ -769,7 +774,8 @@
 	$r->print('<br />'.&Apache::loncommon::help_open_topic('Portfolio ShareFile SetAccess', 'Help on setting up share access'));
 	$r->print(&Apache::loncommon::help_open_topic('Portfolio ShareFile ChangeSetting', 'Help on changing settings'));
 	$r->print(&Apache::loncommon::help_open_topic('Portfolio ShareFile StopAccess', 'Help on removing share access'));
-        &access_setting_table($r,$access_controls{$file_name});
+        &access_setting_table($r,$url,$file_name,$access_controls{$file_name},
+                              $action);
         my $button_text = {
                         'continue' => &mt('Proceed'),
                         'cancel' => &mt('Back to directory listing'),
@@ -784,6 +790,13 @@
     }
 }
 
+sub explain_conditionals {
+    return
+        &mt('Conditional files are accessible to logged-in users with accounts in the LON-CAPA network, who satisfy the conditions you set.').'<br />'."\n".
+        &mt('The conditions can include affiliation with a particular course, or a user account in a specific domain.').'<br />'."\n".
+        &mt('Alternatively access can be granted to people with specific LON-CAPA usernames and domains.');
+}
+
 sub view_access_settings {
     my ($r,$url,$access_controls,$aclcount) = @_;
     my ($showstart,$showend);
@@ -822,9 +835,8 @@
                       domains => 'Conditional: domain-based',
                       users => 'Conditional: user-based',
                       course => 'Conditional: course-based',
-                      group => 'Conditional: group-based',
                      );
-    my @allscopes = ('public','guest','domains','users','course','group');
+    my @allscopes = ('public','guest','domains','users','course');
     foreach my $scope (@allscopes) {
         if ((!(exists($todisplay{$scope}))) || (ref($todisplay{$scope}) ne 'HASH')) {
             next;
@@ -847,7 +859,7 @@
                 }
             }
             $r->print('<td>'.&mt($scope_desc{$scope}));
-            if (($scope eq 'course') || ($scope eq 'group')) {
+            if ($scope eq 'course') {
                 if ($chg ne 'delete') {
                     my $cid = $content->{'domain'}.'_'.$content->{'number'};
                     my %course_description = &Apache::lonnet::coursedescription($cid);
@@ -859,16 +871,12 @@
             if ($chg ne 'delete') {
                 if ($scope eq 'guest') {
                     $r->print(&mt('Passphrase').': '.$content->{'password'});
-                } elsif ($scope eq 'course' || $scope eq 'group') {
+                } elsif ($scope eq 'course') {
                     $r->print('<table><tr>');
                     $r->print('<th>'.&mt('Roles').'</th><th>'.
                           &mt('Access').'</th><th>'.
                                           &mt('Sections').'</th>');
-                    if ($scope eq 'course') {
-                        $r->print('<th>'.&mt('Groups').'</th>');
-                    } else {
-                        $r->print('<th>'.&mt('Teams').'</th>');
-                    }
+                    $r->print('<th>'.&mt('Groups').'</th>');
                     $r->print('</tr>');
                     foreach my $id (sort(keys(%{$content->{'roles'}}))) {
                         $r->print('<tr>');
@@ -892,11 +900,11 @@
                             } else {
                                 $r->print(join(',',@{$content->{'roles'}{$id}{$item}}));
                             }
-                            $r->print('</tr>');
+                            $r->print('</td>');
                         }
-			$r->print("</table>");
+			$r->print('</tr>');
                     }
-		    $r->print("</tr></table>");
+		    $r->print('</table>');
                 } elsif ($scope eq 'domains') {
                     $r->print(&mt('Domains: ').join(',',@{$content->{'dom'}}));
                 } elsif ($scope eq 'users') {
@@ -1010,14 +1018,14 @@
     my $totalnew = 0;
     my $status = 'new';
     my ($firstitem,$lastitem);
-    foreach my $newitem ('course','group','domains','users') {
+    foreach my $newitem ('course','domains','users') {
         $allnew += $env{'form.new'.$newitem};
     }
     if ($allnew > 0) {
         my $now = time;
         my $then = $now + (60*60*24*180); # six months approx.
         &open_form($r,$url);
-        foreach my $newitem ('course','group','domains','users') {
+        foreach my $newitem ('course','domains','users') {
             if ($env{'form.new'.$newitem} > 0) {
                 $r->print('<br />'.&mt('Add new <b>[_1]-based</b> access control for portfolio file: <b>[_2]</b>',$newitem,$env{'form.currentpath'}.$env{'form.selectfile'}).'<br /><br />');
                 $firstitem = $totalnew;
@@ -1056,7 +1064,7 @@
 		
     if ($scope eq 'guest') {	
         $record->{'password'} = $env{'form.password'};
-    } elsif (($scope eq 'course') || ($scope eq 'group')) {
+    } elsif ($scope eq 'course') {
         $record->{'domain'} = $env{'form.crsdom_'.$num};
 	$record->{'number'} = $env{'form.crsnum_'.$num};
         my @role_ids;
@@ -1138,19 +1146,18 @@
 }
 
 sub access_setting_table {
-    my ($r,$access_controls) = @_;
+    my ($r,$url,$filename,$access_controls,$action) = @_;
     my ($public,$publictext);
-    $publictext = &mt('Off');
+    $publictext ='Off';
     my ($guest,$guesttext);
-    $guesttext = &mt('Off');
+    $guesttext = 'Off';
     my @courses = ();
-    my @groups = ();
     my @domains = ();
     my @users = ();
     my $now = time;
     my $then = $now + (60*60*24*180); # six months approx.
     my ($num,$scope,$publicnum,$guestnum);
-    my (%acl_count,%end,%start);
+    my (%acl_count,%end,%start,%conditionals);
     foreach my $key (sort(keys(%{$access_controls}))) {
         ($num,$scope,$end{$key},$start{$key}) = &unpack_acc_key($key);
         if ($scope eq 'public') {
@@ -1161,19 +1168,34 @@
             $guest=$key;
             $guestnum = $num;  
             $guesttext = &acl_status($start{$key},$end{$key},$now);
-        } elsif ($scope eq 'course') {
-            push(@courses,$key);
-        } elsif ($scope eq 'group') {
-            push(@groups,$key);
-        } elsif ($scope eq 'domains') {
-            push(@domains,$key);
-        } elsif ($scope eq 'users') {
-            push(@users,$key);
+        } else {
+            $conditionals{$scope}{$key} = $$access_controls{$key};
+            if ($scope eq 'course') {
+                push(@courses,$key);
+            } elsif ($scope eq 'domains') {
+                push(@domains,$key);
+            } elsif ($scope eq 'users') {
+                push(@users,$key);
+            }
         }
         $acl_count{$scope} ++;
     }
     $r->print('<table border="0"><tr><td valign="top">');
-    $r->print('<h3>'.&mt('Public access:').' '.$publictext.'</h3>');
+    if ($action eq 'chgaccess') {
+        &standard_settings($r,$now,$then,$url,$filename,\%acl_count,\%start,
+                           \%end,$public,$publicnum,$publictext,$guest,$guestnum,
+                           $guesttext,$access_controls,%conditionals);
+    } else {
+        &condition_setting($r,$access_controls,$now,$then,\%acl_count,
+                           \@domains,\@users,\@courses);
+    }
+    $r->print('</td></tr></table>');
+}
+
+sub standard_settings {
+    my ($r,$now,$then,$url,$filename,$acl_count,$start,$end,$public,$publicnum,
+      $publictext,$guest,$guestnum,$guesttext,$access_controls,%conditionals)=@_;
+    $r->print('<h3>'.&mt('Public access: [_1]',$publictext).'</h3>');
     $r->print(&Apache::loncommon::start_data_table());
     $r->print(&Apache::loncommon::start_data_table_header_row());
     $r->print('<th>'.&mt('Action').'</th><th>'.&mt('Dates available').'</th>');
@@ -1181,7 +1203,7 @@
     $r->print(&Apache::loncommon::start_data_table_row());
     if ($public) {
         $r->print('<td>'.&actionbox('old',$publicnum,'public').'</td><td>'.
-                  &dateboxes($publicnum,$start{$public},$end{$public}).'</td>');
+             &dateboxes($publicnum,$start->{$public},$end->{$public}).'</td>');
     } else {
         $r->print('<td>'.&actionbox('new','0','public').'</td><td>'.
                   &dateboxes('0',$now,$then).'</td>');
@@ -1189,7 +1211,7 @@
     $r->print(&Apache::loncommon::end_data_table_row());
     $r->print(&Apache::loncommon::end_data_table());
     $r->print('</td><td width="40">&nbsp;</td><td valign="top">');
-    $r->print('<h3>'.&mt('Passphrase-protected access:').' '.$guesttext.'</h3>');
+    $r->print('<h3>'.&mt('Passphrase-protected access: [_1]',$guesttext).'</h3>');
     $r->print(&Apache::loncommon::start_data_table());
     $r->print(&Apache::loncommon::start_data_table_header_row());
     $r->print('<th>'.&mt('Action').'</th><th>'.&mt('Dates available').
@@ -1200,7 +1222,7 @@
     if ($guest) {
         $passwd = $$access_controls{$guest}{'password'};
         $r->print('<td>'.&actionbox('old',$guestnum,'guest').'</td><td>'.
-                  &dateboxes($guestnum,$start{$guest},$end{$guest}).'</td>');
+              &dateboxes($guestnum,$start->{$guest},$end->{$guest}).'</td>');
     } else {
         $r->print('<td>'.&actionbox('new','1','guest').'</td><td>'.
                   &dateboxes('1',$now,$then).'</td>');
@@ -1209,36 +1231,75 @@
               $passwd.'" /></td>');
     $r->print(&Apache::loncommon::end_data_table_row());
     $r->print(&Apache::loncommon::end_data_table());
-    $r->print('</td></tr><tr><td colspan="3">&nbsp;</td></tr><tr><td valign="top">');
-    &access_element($r,'domains',\%acl_count,\@domains,$access_controls,$now,$then);
+    $r->print('</td></tr><tr><td colspan="3">&nbsp;</td></tr>'.
+              '<tr><td colspan="3">');
+    my $numconditionals = 0;
+    my $conditionstext;
+    my %cond_status;
+    foreach my $scope ('domains','users','course') {
+        $numconditionals += $acl_count->{$scope}; 
+        if ($acl_count->{$scope} > 0) {
+            if ($conditionstext ne 'Active') { 
+                foreach my $key (keys(%{$conditionals{$scope}})) {
+                    $conditionstext = &acl_status($start->{$key},$end->{$key},$now);
+                    if ($conditionstext eq 'Active') {
+                       last;
+                    }
+                }
+            }
+        }
+    }
+    if ($conditionstext eq '') {
+        $conditionstext = 'Off';
+    }
+    my %anchor_fields = (
+            'access' => $env{'form.selectfile'},
+            'action' => 'chgconditions',
+            'currentpath' => $env{'form.currentpath'},
+        );
+    $r->print('<h3>'.&mt('Conditional access: [_1]',$conditionstext).'</h3>');
+    if ($numconditionals > 0) {
+        my $count = 1;
+        my $chg = 'none';
+        $r->print(&mt('You have previously set [_1] conditional access controls.',$numconditionals).' '.&make_anchor($url,\%anchor_fields,&mt('Change Conditions')).'<br /><br />');
+        $r->print(&Apache::loncommon::start_data_table());
+        $r->print(&Apache::loncommon::start_data_table_header_row());
+        $r->print('<th>'.&mt('Access control').'</th><th>'.&mt('Dates available').
+                  '</th><th>'.&mt('Additional information').'</th>');
+        $r->print(&Apache::loncommon::end_data_table_header_row());
+        &build_access_summary($r,$count,$chg,%conditionals);
+        $r->print(&Apache::loncommon::end_data_table());
+    } else {
+        $r->print(&make_anchor($url,\%anchor_fields,&mt('Add conditional access')).' '.&mt('based on domain, username, or course affiliation.'));
+    }
+}
+
+sub condition_setting {
+    my ($r,$access_controls,$now,$then,$acl_count,$domains,$users,$courses) = @_;
+    $r->print('<tr><td valign="top">');
+    &access_element($r,'domains',$acl_count,$domains,$access_controls,$now,$then);
     $r->print('</td><td>&nbsp;</td><td valign="top">');
-    &access_element($r,'users',\%acl_count,\@users,$access_controls,$now,$then);
+    &access_element($r,'users',$acl_count,$users,$access_controls,$now,$then);
     $r->print('</td></tr><tr><td colspan="3"></td></tr><tr>');
-    if (@courses > 0 || @groups > 0) {
+    if ($acl_count->{course} > 0) {
         $r->print('<td colspan="3" valign="top">');
     } else {
         $r->print('<td valign="top">');
     }
-    &access_element($r,'course',\%acl_count,\@courses,$access_controls,$now,$then);
+    &access_element($r,'course',$acl_count,$courses,$access_controls,$now,$then);
     $r->print('</td>');
-    if (@courses > 0 || @groups > 0) {
-        $r->print('</tr><tr><td colspan="3">&nbsp;</td></tr><tr><td colspan="3" valign="top">');
-    } else {
-        $r->print('<td>&nbsp;</td><td valign="top">');
-    }
-    &access_element($r,'group',\%acl_count,\@groups,$access_controls,$now,$then);
     $r->print('</td></tr></table>');
 }
 
 sub acl_status {
     my ($start,$end,$now) = @_;
     if ($start > $now) {
-        return &mt('Inactive');
+        return 'Inactive';
     }
     if ($end && $end<$now) {
-        return &mt('Inactive');
+        return 'Inactive';
     }
-    return &mt('Active');
+    return 'Active';
 }
 
 sub access_element {
@@ -1273,7 +1334,7 @@
         $r->print(&Apache::loncommon::start_data_table_header_row());
         $r->print('<th>'.&mt('Action?').'</th><th>'.&mt($uctype).'</th><th>'.
               &mt('Dates available').'</th>');
-        if (($type eq 'course') || ($type eq 'group')) {
+        if ($type eq 'course') {
             $r->print('<th>'.&mt('Allowed [_1] member affiliations',$type).
                       '</th>');
             $colspan ++;
@@ -1283,7 +1344,7 @@
         $r->print(&Apache::loncommon::end_data_table_header_row());
         foreach my $key (@{$items}) {
 	    $r->print(&Apache::loncommon::start_data_table_row());
-            if (($type eq 'course') || ($type eq 'group')) {
+            if ($type eq 'course') {
                 &course_row($r,$status,$type,$key,$access_controls,$now,$then);
             } elsif ($type eq 'domains') {
                 &domains_row($r,$status,$key,\@all_doms,$access_controls,$now,
@@ -1360,10 +1421,6 @@
     }
     my $js = &Apache::loncommon::coursebrowser_javascript($defdom)
 	.&course_js();
-    my $crsgrptext = 'Groups';
-    if ($type eq 'group') {
-        $crsgrptext = 'Teams';
-    }
     my $uctype = $type;
     $uctype =~ s/^(\w)/uc($1)/e;
     my ($num,$scope,$end,$start) = &set_identifiers($status,$item,$now,$then,
@@ -1380,7 +1437,7 @@
     $r->print('<td><table><tr>');
     $r->print('<th>'.&mt('Action').'</th><th>'.&mt('Roles').'</th><th>'.
               &mt('Access').'</th><th>'.&mt('Sections').'</th><th>'.
-              &mt($crsgrptext).'</th></tr>');
+              &mt('Groups').'</th></tr>');
     if ($status eq 'old') {
         my $max_id = 0;
         foreach my $role_id (sort(keys(%{$content->{'roles'}}))) {
@@ -1450,7 +1507,12 @@
     my ($status,$num,$scope) = @_;
     my $output = '<span style="white-space: nowrap"><label>';
     if ($status eq 'new') {
-        $output .= '<input type="checkbox" name="activate" value="'.$num.'" />'.
+        my $checkstate;
+        if ($scope eq 'domains' || $scope eq 'users' || $scope eq 'course') {
+            $checkstate = 'checked="checked"';
+        }
+        $output .= '<input type="checkbox" name="activate" value="'.$num.'" '.
+                   $checkstate.'  />'.
         &mt('Activate');
     } else {
         $output .= '<input type="checkbox" name="delete" value="'.$num.
@@ -1578,10 +1640,6 @@
     my $cnum = $env{'form.cnum'};
     my $type = $env{'form.type'};
     my $addindex = $env{'form.setroles'};
-    my $grouptitle = 'Groups';
-    if ($type eq 'Group') {
-         $grouptitle = 'Teams';
-    } 
     my $role_selects = &role_selectors(1,1,'new',$type,undef,'rolepicker');
     $r->print(<<"END_SCRIPT");
 <script type="text/javascript">
@@ -1602,7 +1660,7 @@
 </script>
 END_SCRIPT
     $r->print(&mt('Select roles, course status, section(s) and group(s) for users who will be able to access the portfolio file.'));
-    $r->print('<form name="rolepicker" action="/adm/portfolio" method="post"><table><tr><th>'.&mt('Roles').'</th><th>'.&mt('[_1] status',$type).'</th><th>'.&mt('Sections').'</th><th>'.&mt($grouptitle).'</th></tr><tr>'.$role_selects.'</tr></table><br /><input type="button" name="rolepickbutton" value="Save selections" onclick="setRoles()" />');
+    $r->print('<form name="rolepicker" action="/adm/portfolio" method="post"><table><tr><th>'.&mt('Roles').'</th><th>'.&mt('[_1] status',$type).'</th><th>'.&mt('Sections').'</th><th>'.&mt('Groups').'</th></tr><tr>'.$role_selects.'</tr></table><br /><input type="button" name="rolepickbutton" value="Save selections" onclick="setRoles()" />');
     return;
 }
 
@@ -2088,9 +2146,12 @@
         }
     } elsif ($env{'form.access'}) {
         $env{'form.selectfile'} = $env{'form.access'};
-        $env{'form.action'} = 'chgaccess';
-        &display_access($r,$url,$group,$can_setacl,$port_path);
-    } elsif ($env{'form.action'} eq 'chgaccess') {
+        if (!defined($env{'form.action'})) { 
+            $env{'form.action'} = 'chgaccess';
+        }
+        &display_access($r,$url,$group,$can_setacl,$port_path,$env{'form.action'});
+    } elsif (($env{'form.action'} eq 'chgaccess') || 
+             ($env{'form.action'} eq 'chgconditions')) {
         if ($can_setacl) {
             &update_access($r,$url,$group,$port_path);
         } else {

--raeburn1162760933--