Annotation of loncom/publisher/lonrights.pm, revision 1.36

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>