Return to lonrights.pm CVS log

Up to [LON-CAPA] / loncom / publisher

- Replace term: "Construction Space" with "Authoring Space" for
  consistency with type of role used to access it, and action taken there.

    1: # The LearningOnline Network with CAPA
    2: # Handler to show and edit custom distribution rights
    3: #
    4: # $Id: lonrights.pm,v 1.35 2013/06/04 22:20:16 raeburn Exp $
    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: #
   28: #
   29: ###
   30: 
   31: package Apache::lonrights;
   32: 
   33: use strict;
   34: use Apache::Constants qw(:common :http);
   35: use Apache::lonnet;
   36: use Apache::loncommon();
   37: use HTML::LCParser;
   38: use Apache::File;
   39: use Apache::lonlocal;
   40: 
   41: sub handler {
   42: 
   43:   my $r=shift;
   44:   my $target = $env{'form.grade_target'};
   45:   if ($target eq 'meta') {
   46:       &Apache::loncommon::content_type($r,'text/html');
   47:       $r->send_http_header;
   48:       $env{'request.uri'}=$r->uri;
   49:       my $file = &Apache::lonnet::filelocation("",$r->uri);
   50:       my $content=&Apache::lonnet::getfile($file);
   51:       my $result=&Apache::lonxml::xmlparse(undef,'meta',$content);
   52:       $r->print($result);
   53:       return OK;
   54:   }
   55:   &Apache::loncommon::content_type($r,'text/html');
   56:   $r->send_http_header;
   57: 
   58:   # Breadcrumbs
   59:   &Apache::lonhtmlcommon::clear_breadcrumbs();
   60:   &Apache::lonhtmlcommon::add_breadcrumb({
   61:       'text'  => 'Authoring Space',
   62:       'href'  => &Apache::loncommon::authorspace($r->uri),
   63:       });
   64:   &Apache::lonhtmlcommon::add_breadcrumb({
   65:       'text'  => 'Custom Rights Editor',
   66:       'title' => 'Custom Distribution Rights Editor',
   67:       'href'  => '',});
   68: 
   69:   my $js = &Apache::loncommon::coursebrowser_javascript().
   70:       &Apache::loncommon::studentbrowser_javascript();
   71:   # Breadcrumbs are included by &start_page
   72:   $r->print(&Apache::loncommon::start_page('Custom Distribution Rights',$js)
   73:            .&Apache::loncommon::head_subbox(
   74:                 &Apache::loncommon::CSTR_pageheader())
   75:   );
   76:   $r->rflush();
   77: 
   78:   my $uri=$r->uri;
   79:   my $fn=&Apache::lonnet::filelocation('',$uri);
   80:   my $contents='';
   81:   my $constructmode=($uri=~ m{^/priv/});
   82: 
   83: # ============================================================ Modify and store
   84:   if ($constructmode && $env{'form.store'}) {
   85:       
   86:       my @newrules;
   87: 
   88: # read rules from form
   89:       foreach my $key (keys(%env)) {
   90: 	  next if ($key!~/^form\.effect\_(\d+)$/);
   91: 	  my $number=$1;
   92: 	  my %rulehash;
   93: 	  foreach my $action ('effect','type','domain','course','section','role') {
   94: 	      $rulehash{$action}=$env{'form.'.$action.'_'.$number};
   95: 	  }
   96: 	  if ($rulehash{'type'} !~ /^(user|course)$/) {
   97: 	      $rulehash{'type'} = 'course';
   98: 	  }
   99: 	  if ($rulehash{'type'} eq 'user') {
  100: 	      $rulehash{'section'}='';
  101: 	      $rulehash{'role'}='';
  102: 	  }
  103: 	  if ($rulehash{'role'} eq 'au') {
  104: 	      $rulehash{'course'}='';
  105: 	      $rulehash{'section'}='';
  106: 	  }
  107: 	  if ($rulehash{'role'} eq 'cc') {
  108: 	      $rulehash{'section'}='';
  109: 	  }
  110: 	  unless (($rulehash{'effect'} eq 'deny') ||
  111: 		  ($rulehash{'effect'} eq 'allow')) {
  112: 	      $rulehash{'effect'}='deny';
  113: 	  }
  114: 	  $rulehash{'domain'} = 
  115: 	      &LONCAPA::clean_domain($rulehash{'domain'});
  116: 	  if ($rulehash{'type'} eq 'course') {
  117: 	      $rulehash{'course'} = 
  118: 		  &LONCAPA::clean_courseid($rulehash{'course'});
  119: 	  } else {
  120: 	      $rulehash{'course'} = 
  121: 		  &LONCAPA::clean_username($rulehash{'course'});
  122: 	  }
  123: 	  $rulehash{'section'}=~s/\W//g;
  124: 	  if (!$rulehash{'domain'}) { 
  125: 	      $rulehash{'domain'}=$env{'user.domain'}; 
  126: 	  }
  127: 	  my $realm='';
  128: 	  my $separator = ($rulehash{'type'} eq 'course') ? '_' : '/';
  129: 	  if ($number) {
  130: 	      $realm=$rulehash{'domain'};
  131: 	      if ($rulehash{'course'}) {
  132: 		  $realm.=$separator.$rulehash{'course'};
  133: 	      }
  134: 	      if ($rulehash{'section'}) {
  135: 		  $realm.=$separator.$rulehash{'section'};
  136: 	      }
  137: 	  }
  138: 	  $newrules[$number]=$rulehash{'effect'}.':'.
  139: 	      $realm.':'.$rulehash{'role'}.':'.$rulehash{'type'};
  140:       }
  141: # edit actions?
  142:       foreach my $key (keys(%env)) {
  143: 	  next if ($key!~/^form\.action\_(\d+)$/);
  144: 	  my $number=$1;
  145: 	  if ($env{$key} eq 'delete') { splice(@newrules,$number,1); }
  146: 	  if (($env{$key} eq 'moveup') && ($number>1)) {
  147: 	      @newrules[$number-1,$number] = @newrules[$number,$number-1];
  148: 	  }
  149: 	  if (($env{$key} eq 'movedown') && ($number<$#newrules)) {
  150: 	      @newrules[$number+1,$number] = @newrules[$number,$number+1];
  151: 	  }
  152: 	  if ($env{$key} eq 'insertabove') {
  153: 	      splice(@newrules,$number,0,'deny');
  154: 	  }
  155: 	  if ($env{$key} eq 'insertbelow') {
  156: 	      splice(@newrules,$number+1,0,'deny');
  157: 	  }
  158:       }
  159:       
  160: # store file
  161:       my $fh=Apache::File->new('>'.$fn);
  162:       foreach (my $i=0;$i<=$#newrules;$i++) {
  163: 	  if ($newrules[$i]) {
  164: 	      my ($effect,$realm,$role,$type)=split(/\:/,$newrules[$i]);
  165: 	      print $fh
  166: 		  "<accessrule effect='$effect' realm='$realm' role='$role' type='$type' />\n";
  167: 	  }
  168:       }
  169:       $fh->close;
  170:   }
  171: # ============================================================ Read and display
  172:   unless ($constructmode) { 
  173: # =========================================== This is not in construction space
  174:       $contents=&Apache::lonnet::getfile($fn);
  175:       if ($contents==-1) { $contents=''; }
  176:   } else {
  177: # =============================================== This is in construction space
  178:       if (-e $fn) {
  179: 	  my $fh=Apache::File->new($fn);
  180:           $contents=join('',<$fh>);
  181:           $fh->close();
  182:       }
  183:       $r->print('<form name="rules" method="post" action="">');
  184:   }
  185:   unless ($contents=~/\<accessrule/s) {
  186:       $contents='<accessrule effect="deny" />';
  187:   }
  188:   my $parser=HTML::LCParser->new(\$contents);
  189:   my $token;
  190:   my $rulecounter=0;
  191:   my $colzero=&mt($constructmode?'Edit action':'Rule');
  192:   my %lt=&Apache::lonlocal::texthash(
  193: 				     'ef' => 'Effect',
  194: 				     'ty' => 'Type',
  195: 				     'do' => 'Domain',
  196: 				     'co' => 'Course / User',
  197: 				     'se' => 'Section',
  198: 				     'ro' => 'Role');
  199:   my %iconimg = ('allow' => '<img src="/adm/lonIcons/navmap.correct.gif"'
  200:                            .' alt="'.&mt('allow').'" title="'.&mt('allow').'" />',
  201:                  'deny' => '<img src="/adm/lonIcons/navmap.wrong.gif"'
  202:                            .' alt="'.&mt('deny').'" title="'.&mt('deny').'" />');
  203: # ---------------------------------------------------------- Start table output
  204:   $r->print(&Apache::loncommon::start_data_table().
  205: 	    &Apache::loncommon::start_data_table_header_row().
  206: 	    "<th>$colzero</th><th>$lt{'ef'}</th><th>$lt{'ty'}</th><th>$lt{'do'}</th>".
  207: 	    "<th>$lt{'co'}</th><th>$lt{'se'}</th><th>$lt{'ro'}</th>".
  208: 	    &Apache::loncommon::end_data_table_header_row());
  209: # --------------------------------------------------------------------- Default
  210: # Fast forward to first rule
  211:   $token=$parser->get_token;
  212:   while ($token->[1] ne 'accessrule') { $token=$parser->get_token; }
  213: # print default
  214:   $r->print(&Apache::loncommon::start_data_table_row().'<td align="right">');
  215:   if ($constructmode) {
  216:      $r->print(&Apache::loncommon::select_form('','action_0',
  217:                                   {'' => '',
  218:                                    'insertbelow' => &mt('Insert rule below')}));
  219:                                                 
  220:   } else {
  221:       $r->print('&nbsp;');
  222:   }
  223:   $r->print('</td><td>');
  224:   $r->print($iconimg{$token->[2]->{'effect'}});
  225:   if ($constructmode) {
  226:       my %lt = &Apache::lonlocal::texthash
  227:                                    ('allow' => 'allow',
  228:                                     'deny'  => 'deny');
  229:       $r->print(&Apache::loncommon::select_form
  230:                                  ($token->[2]->{'effect'},'effect_0',\%lt));
  231:   }
  232:   $r->print('</td><td colspan="5">'.&mt('Default'));
  233:   if (($token->[2]->{'realm'}) || ($token->[2]->{'role'})) {
  234:       $r->print(' - <span class="LC_error">'.&mt('Error! No default set.').
  235: 		'</span>');
  236:   }
  237:   $r->print('</td>'.&Apache::loncommon::end_data_table_row());
  238: # Additional roles
  239:   while ($token=$parser->get_token) {
  240:       if (($token->[0] eq 'S') && ($token->[1] eq 'accessrule')) {
  241:           $rulecounter++;
  242: 	  $r->print(&Apache::loncommon::start_data_table_row().
  243: 		     '<td align="right" rowspan="2">');
  244: # insert, delete, etc
  245: 	  $r->print('<span class="LC_nobreak">'.$rulecounter.'. ');
  246:           if ($constructmode) {
  247:              my %lt = &Apache::lonlocal::texthash
  248:                           (''            => '',
  249:                            'delete'      => 'Delete this rule',
  250:                            'insertabove' => 'Insert rule above',
  251:                            'insertbelow' => 'Insert rule below',
  252:                            'moveup'      => 'Move rule up',
  253:                            'movedown'    => 'Move rule down'
  254:                            );
  255: 
  256:              $r->print(&Apache::loncommon::select_form(
  257:                     '','action_'.$rulecounter,\%lt));
  258: 	  }
  259:           $r->print('</span></td>'.
  260: 		    '<td rowspan="2">');
  261: # effect
  262:           $r->print($iconimg{$token->[2]->{'effect'}});
  263:           if ($constructmode) {
  264:              my %lt = &Apache::lonlocal::texthash
  265:                              ('allow' => 'allow',
  266:                               'deny'  => 'deny');
  267:              $r->print(&Apache::loncommon::select_form
  268:                                  ($token->[2]->{'effect'},
  269:                                   'effect_'.$rulecounter,\%lt));
  270:           }
  271: 
  272: # type
  273: 	  $r->print('</td><td rowspan="2">');
  274: 	  my $type = ($token->[2]{'type'} || 'course');
  275:           if ($constructmode) {
  276:               my %lt = &Apache::lonlocal::texthash
  277:                            ('course' => 'Course',
  278:                             'user'   => 'User');
  279:               $r->print(&Apache::loncommon::select_form($type,
  280: 							'type_'.$rulecounter,\%lt));
  281:           } else {
  282:               $r->print(&mt($type));
  283:           }
  284: 
  285: # ---- realm
  286:           my $realm=$token->[2]->{'realm'};
  287:           my ($rdom,$rcourse,$rsec);
  288: 	  if ($type eq 'course') {
  289: 	      ($rdom,$rcourse,$rsec) = split(m{[/_]},$realm,3);
  290: 	      $rcourse = &LONCAPA::clean_courseid($rcourse);
  291: 	  } else {
  292: 	      ($rdom,$rcourse,$rsec) = split(m{/},$realm,3);
  293: 	      $rcourse = &LONCAPA::clean_username($rcourse);
  294: 	  }
  295:           $r->print('</td><td>');
  296: # realm domain
  297:           if ($constructmode) {
  298:               unless ($rdom) { $rdom=$env{'user.domain'}; }
  299:               $r->print(&Apache::loncommon::select_dom_form($rdom,
  300:                                                       'domain_'.$rulecounter));
  301:           } else {
  302:               $r->print($rdom);
  303:           }
  304:           $r->print('</td><td>');
  305: # realm course
  306:           if ($constructmode) {
  307:              $r->print('<input type="text" size="25" name="course_'.
  308:                        $rulecounter.'" value="'.$rcourse.'" />');
  309:           } else {
  310:               $r->print($rcourse);
  311:           }
  312: 
  313:           $r->print('</td><td rowspan="2">');
  314: # realm section
  315: 	  if ($type eq 'course') {
  316: 	      if ($constructmode) {
  317: 		  $r->print('<input type="text" size="5" name="section_'.
  318: 			    $rulecounter.'" value="'.$rsec.'" />');
  319: 	      } else {
  320: 		  $r->print($rsec);
  321: 	      }
  322: 	  }
  323: 
  324:           $r->print('</td><td rowspan="2">');
  325: # role
  326: 	  if ($type eq 'course') {
  327: 	      if ($constructmode) {
  328: 		  my %hash=('' => '');
  329: 		  foreach ('au','cc','in','ta','st') { 
  330: 		      $hash{$_}=&Apache::lonnet::plaintext($_); 
  331: 		  }
  332: 		  my $role=$token->[2]->{'role'};
  333: 		  unless ($role) { $role=''; }
  334: 		  $r->print(&Apache::loncommon::select_form(
  335: 							    $role,'role_'.$rulecounter,\%hash));
  336: 	      } else {
  337: 		  $r->print(&Apache::lonnet::plaintext($token->[2]->{'role'}));
  338: 	      }
  339: 	  }
  340: # course selection link
  341:           $r->print('</td>'.
  342: 		    &Apache::loncommon::end_data_table_row().
  343: 		    &Apache::loncommon::continue_data_table_row().
  344: 		    '<td colspan="2" align="right">');
  345: 	  if ($type eq 'course') {
  346: 	      if ($rcourse) {
  347: 		  my %descript=
  348: 		      &Apache::lonnet::coursedescription($rdom.'_'.$rcourse,
  349: 							 {'one_time' => 1});
  350: 		  $r->print($descript{'description'}.'&nbsp;&nbsp;&nbsp;');
  351: 	      }
  352: 	      if ($constructmode) {
  353: 		  $r->print(&Apache::loncommon::selectcourse_link('rules',
  354: 								  'course_'.$rulecounter,'domain_'.$rulecounter));
  355: 	      }
  356: 	  } else {
  357: 	      if ($rcourse) {
  358: 		  my $name = &Apache::loncommon::plainname($rcourse,$rdom);
  359: 		  $r->print($name.'&nbsp;&nbsp;&nbsp;');
  360: 	      }
  361: 	      if ($constructmode) {
  362: 		  $r->print(&Apache::loncommon::selectstudent_link('rules','course_'.$rulecounter,'domain_'.$rulecounter));
  363: 	      }
  364: 	  }
  365: # close row
  366: 	  $r->print('</td>'.&Apache::loncommon::end_data_table_row());
  367:      }                                       
  368:   }
  369:   $r->print(&Apache::loncommon::end_data_table());
  370: # ------------------------------------------------------------ End table output
  371:   if ($constructmode) { 
  372:      $r->print('<input type="submit" name="store" value="'.&mt('Save').'" /></form>'); 
  373:   }
  374:   $r->print(&Apache::loncommon::end_page());
  375:   return OK;  
  376: }
  377: 
  378: 
  379: 1;
  380: __END__
  381: 
  382: 
  383: 
  384: