File:  [LON-CAPA] / loncom / interface / lonconfigsettings.pm
Revision 1.21.4.9: download - view: text, annotated - select for diffs
Sun Oct 23 21:13:51 2016 UTC (7 years, 8 months ago) by raeburn
Branches: version_2_11_X
CVS tags: version_2_11_2_uiuc, version_2_11_2_msu, version_2_11_2_educog, version_2_11_2
Diff to branchpoint 1.21: preferred, unified
- For 2.11
  - Backport 1.33

    1: # The LearningOnline Network with CAPA
    2: # Handler to set domain-wide configuration settings
    3: #
    4: # $Id: lonconfigsettings.pm,v 1.21.4.9 2016/10/23 21:13:51 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: # /home/httpd/html/adm/gpl.txt
   24: #
   25: # http://www.lon-capa.org/
   26: #
   27: #
   28: ###############################################################
   29: ##############################################################
   30: 
   31: package Apache::lonconfigsettings;
   32: 
   33: use strict;
   34: use Apache::lonnet;
   35: use Apache::loncommon();
   36: use Apache::lonhtmlcommon();
   37: use Apache::lonlocal;
   38: use Apache::courseclassifier();
   39: use LONCAPA qw(:DEFAULT :match);
   40: 
   41: sub print_header {
   42:     my ($r,$phase,$context,$jscript,$container) = @_;
   43:     my ($pagetitle,$brcrumtitle,$action,$call_category_check,$instcode_check,
   44:         $crstype,@actions,@code_order);
   45:     if ($phase eq 'display') {
   46:         @actions = &Apache::loncommon::get_env_multiple('form.actions');
   47:     }
   48:     if ($context eq 'domain') {
   49:         ($pagetitle, $brcrumtitle) = ('View/Modify Domain Settings','View/Modify Domain Settings');
   50:         $action = '/adm/domainprefs';
   51:         if ($phase eq 'display') {
   52:             if (grep(/^coursecategories$/,@actions)) {
   53:                 $call_category_check = qq|
   54:     if (formname == document.display) {
   55:         if (!categoryCheck(formname)) {
   56:             return;
   57:         }
   58:     }
   59: |;
   60:             }
   61:         }
   62:     } else {
   63:         $crstype = &Apache::loncommon::course_type();
   64:         if ($crstype eq 'Community') {
   65:             ($pagetitle,$brcrumtitle) = ('Community Configuration','Community Configuration');
   66:         } else {
   67:             ($pagetitle,$brcrumtitle) = ('Course Configuration','Course Configuration');
   68:         }
   69:         $action = '/adm/courseprefs';
   70:         if ($phase eq 'display') {
   71:             if (grep(/^courseinfo$/,@actions)) {
   72:                 my %codedefaults;
   73:                 &Apache::lonnet::auto_instcode_defaults($env{'request.role.domain'},\%codedefaults,
   74:                                                         \@code_order);
   75:                 if (@code_order) {
   76:                    my $noinstcodestr = &mt('You indicated cloning based on category, but did not select any categories.');
   77:                    &js_escape(\$noinstcodestr);
   78:                    $instcode_check = <<"ENDSCRIPT";
   79:     if (formname == document.display) {
   80:         if (formname.cloners_instcode.length) {
   81:             for (var j=0; j<formname.cloners_instcode.length; j++) {
   82:                 if (formname.cloners_instcode[j].checked) {
   83:                     if (formname.cloners_instcode[j].value == 1) {
   84:                         var codes;
   85:                         if (document.getElementsByClassName) {
   86:                             codes = document.getElementsByClassName('LC_cloners_instcodes');
   87:                         } else {
   88:                             codes = getElementsByClassName(document.body,'LC_cloners_instcodes');
   89:                         }
   90:                         if (codes.length) {
   91:                             var gotcode = 0;
   92:                             for (var i=0; i<codes.length; i++) {
   93:                                 if (codes[i].selectedIndex != 0) {
   94:                                      gotcode = 1;
   95:                                      break;
   96:                                 }
   97:                             }
   98:                             if (!gotcode) {
   99:                                 for (var k=0; k<formname.cloners_instcode.length; k++) {
  100:                                     if (formname.cloners_instcode[k].value == 0) {
  101:                                         formname.cloners_instcode[k].checked = true;
  102:                                     }
  103:                                 }
  104:                                 toggleCloners(document.display.cloners_instcode);
  105:                                 alert('$noinstcodestr');
  106:                                 return false;
  107:                             }
  108:                         }
  109:                     }
  110:                 }
  111:             }
  112:         }
  113:     }
  114: 
  115: ENDSCRIPT
  116:                 }
  117:             }
  118:         }
  119:     }
  120:     my $alert = &mt('You must select at least one functionality type to display.');
  121:     &js_escape(\$alert);
  122:     my $js = '
  123: <script type="text/javascript">
  124: // <![CDATA[
  125: 
  126: function changePage(formname,newphase) {
  127:     formname.phase.value = newphase;
  128:     numchecked = 0;
  129:     if (formname == document.pickactions) {
  130:         if (formname.actions.length > 0) {
  131:             for (var i = 0; i<formname.actions.length; i++) {
  132:                 if (formname.actions[i].checked) {
  133:                     numchecked ++;
  134:                 }
  135:             }
  136:         } else {
  137:             if (formname.actions.checked) {
  138:                 numchecked ++;
  139:             }
  140:         }
  141:         if (numchecked > 0) {
  142:             formname.submit();
  143:         } else {
  144:             alert("'.$alert.'");
  145:             return;
  146:         }
  147:     }
  148:     '.$instcode_check.$call_category_check.'
  149:     formname.submit();
  150: }'."\n";
  151:     if ($phase eq 'pickactions') {
  152:         $js .= &Apache::lonhtmlcommon::color_picker();
  153:         $js .=
  154:             &Apache::lonhtmlcommon::set_form_elements({actions => 'checkbox'})."\n";
  155:     } elsif ($phase eq 'display') {
  156:         $js .= &Apache::lonhtmlcommon::color_picker();
  157:         $js .= &color_pick_js()."\n";
  158:     }
  159:     $js .= &Apache::loncommon::viewport_size_js().'
  160: 
  161: // ]]>
  162: </script>
  163: ';
  164:     if ($jscript) {
  165:         $js .= "
  166: 
  167: $jscript
  168: 
  169: ";
  170:     }
  171:     my $additem;
  172:     if ($phase eq 'pickactions') {
  173:         my %loaditems = (
  174:                     'onload' => "setFormElements(document.pickactions);",
  175:                         );
  176:         $additem = {'add_entries' => \%loaditems,};
  177:     } elsif ($phase eq 'display') {
  178:         if ($context eq 'domain') {
  179:             if (grep(/^coursedefaults$/,@actions)) {
  180:                 my %loaditems = (
  181:                     '             onload' => "toggleDisplay(document.display,'cloneinstcode');".
  182:                                              "toggleDisplay(document.display,'credits');".
  183:                                              "toggleDisplay(document.display,'studentsubmission');",
  184:                                 );
  185:                 $additem = {'add_entries' => \%loaditems,};
  186:             }
  187:         } elsif ($context eq 'course') {
  188:             if (grep(/^courseinfo$/,@actions)) {
  189:                 if (@code_order) {
  190:                     $additem = {
  191:                                    add_entries => {'onload' => "courseSet('','load');toggleCloners(document.display.cloners_instcode);"},
  192:                                };
  193:                 }
  194:             }
  195:         }
  196:     }
  197:     $r->print(&Apache::loncommon::start_page($pagetitle,$js,$additem));
  198:     $r->print(&Apache::lonhtmlcommon::breadcrumbs($brcrumtitle));
  199:     $r->print('
  200: <form name="parmform" action="">
  201: <input type="hidden" name="pres_marker" />
  202: <input type="hidden" name="pres_type" />
  203: <input type="hidden" name="pres_value" />
  204: </form>
  205: ');
  206:     $r->print('<form method="post" name="'.$phase.'" action="'.$action.'"'.
  207:               ' enctype="multipart/form-data">');
  208:     return;
  209: }
  210: 
  211: sub print_footer {
  212:     my ($r,$phase,$newphase,$button_text,$actions,$container,$parm_permission) = @_;
  213:     $button_text = &mt($button_text);
  214:     $r->print('<input type="hidden" name="phase" value="" />');
  215:     if (defined($env{'form.origin'})) {
  216:         $r->print('<input type="hidden" name="origin" value="'.$env{'form.origin'}.'" />'."\n");
  217:     }
  218:     if (($phase eq 'display') || ($phase eq 'process')) {
  219:         if (ref($actions) eq 'ARRAY') {
  220:             foreach my $item (@{$actions}) {
  221:                 $r->print('<input type="hidden" name="actions" value="'.$item.'" />'."\n");
  222:             }
  223:         }
  224:     }
  225:     my $dest='"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
  226:     if ($phase eq 'process') {
  227:         $r->print(
  228:             &Apache::lonhtmlcommon::actionbox(
  229:                 ['<a href='.$dest.'>'.$button_text.'</a>']));
  230:     } else {
  231:         my $onclick;
  232:         if ($phase eq 'display') {
  233:             $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
  234:         } else {
  235:             $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
  236:         }
  237:         my $showbutton = 1;
  238:         if (ref($parm_permission) eq 'HASH') {
  239:             unless (($parm_permission->{'process'}) || ($newphase eq 'display')) {
  240:                 $showbutton = 0;
  241:             }
  242:         }
  243:         if ($showbutton) {
  244:             $r->print('<p><input type="button" name="store" value="'.
  245:                       $button_text.'" onclick='.$onclick.' /></p>');
  246:         }
  247:     }
  248:     if ($phase eq 'process') {
  249:         $r->print('</form>');
  250:         $r->print(&Apache::loncommon::end_page());
  251:     }
  252:     return;
  253: }
  254: 
  255: sub make_changes {
  256:     my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$roles,
  257:         $allitems,$container,$parm_permission) = @_;
  258:     my %brcrumtext = &get_crumb_text();
  259:     my @actions = &Apache::loncommon::get_env_multiple('form.actions');
  260:     my ($numchanged,%changes,%disallowed);
  261:     &Apache::lonhtmlcommon::add_breadcrumb
  262:       ({href=>"javascript:changePage(document.$phase,'display')",
  263:         text=>$brcrumtext{$context}},
  264:        {href=>"javascript:changePage(document.$phase,'$phase')",
  265:         text=>"Updated"});
  266:     &print_header($r,$phase,$context,undef,$container);
  267:     my ($crstype,%lastact);
  268:     if ($context eq 'course') {
  269:         $crstype = &Apache::loncommon::course_type();
  270:     }
  271:     if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && 
  272:         (ref($prefs) eq 'HASH')) {
  273:         foreach my $item (@{$prefs_order}) {
  274:             if (grep(/^\Q$item\E$/,@actions)) {
  275:                 if ($context eq 'domain') {
  276:                     $r->print('<h3>'.&mt($prefs->{$item}{'text'}).'</h3>'.
  277:                               &Apache::domainprefs::process_changes($r,$dom,
  278:                                           $confname,$item,$roles,$values,\%lastact));
  279:                 } else {
  280:                     $changes{$item} = {};
  281:                     &Apache::courseprefs::process_changes($dom,$item,$values,
  282:                                                           $prefs->{$item},$changes{$item},
  283:                                                           $allitems,\%disallowed,$crstype);
  284:                     if (keys(%{$changes{$item}}) > 0) {
  285:                         $numchanged ++;
  286:                     }
  287:                 }
  288:             }
  289:         }
  290:     }
  291:     if ($context eq 'course') {
  292:         if ($numchanged) {
  293:             my $message = &Apache::courseprefs::store_changes($dom,$confname,$prefs_order,\@actions,
  294:                                                           $prefs,$values,\%changes,$crstype);
  295:             $r->print(&Apache::loncommon::confirmwrapper($message));
  296:         } else {
  297:             if ($crstype eq 'Community') {
  298:                 $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to community configuration.")));
  299:             } else {
  300:                 $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to course configuration.")));
  301:             }
  302:         }
  303:         if (keys(%disallowed) > 0) {
  304:             $r->print('<p>');
  305:             foreach my $item ('cloners','rolenames','feedback','discussion','localization') {
  306:                 if (ref($disallowed{$item}) eq 'HASH') {
  307:                     if (keys(%{$disallowed{$item}}) > 0) {
  308:                         $r->print(&Apache::courseprefs::display_disallowed($item,$disallowed{$item},
  309:                                                                            $prefs,$crstype));
  310:                     }
  311:                 }
  312:             }
  313:             $r->print('</p>');
  314:         }
  315:     }
  316:     $r->print('<p>');
  317:     my $footer_text = 'Back to configuration display';
  318:     if ($context eq 'course') {
  319:         $footer_text = 'Back to display/edit settings'; 
  320:     }
  321:     &print_footer($r,$phase,'display',$footer_text,\@actions,$container,$parm_permission);
  322:     $r->print('</p>');
  323:     return \%lastact;
  324: }
  325: 
  326: sub display_settings {
  327:     my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$jscript,
  328:         $allitems,$crstype,$container,$parm_permission) = @_;
  329:     my %brcrumtext = &get_crumb_text();
  330:     my @actions = &Apache::loncommon::get_env_multiple('form.actions');
  331:     &Apache::lonhtmlcommon::add_breadcrumb
  332:         ({href=>"javascript:changePage(document.$phase,'display')",
  333:           text=>"Display/Edit Settings"});
  334:     my $instcode;
  335:     if (ref($values) eq 'HASH') {
  336:         $instcode = $values->{'internal.coursecode'};
  337:     }
  338:     &print_header($r,$phase,$context,$jscript,$container,$instcode);
  339:     my $divwidth = 900;
  340:     if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && (ref($values) eq 'HASH')) { 
  341:         if (@actions > 0) {
  342:             my $rowsum = 0;
  343:             my (%output,%rowtotal,@items);
  344:             foreach my $item (@{$prefs_order}) {
  345:                 if (grep(/^\Q$item\E$/,@actions)) {
  346:                     push(@items,$item);
  347:                     if ($context eq 'domain') {
  348:                         my $settings;
  349:                         if (ref($values) eq 'HASH') {
  350:                             $settings = $values->{$item};
  351:                         }
  352:                         if ($item eq 'usersessions') {
  353:                             $r->print('<script type="text/javascript">'."\n".
  354:                                       '// <![CDATA['."\n".
  355:                                       &Apache::loncommon::check_uncheck_jscript()."\n".
  356:                                       '// ]]>'."\n".
  357:                                       '</script>'."\n");
  358:                         } elsif ($item eq 'selfcreation') {
  359:                             if (ref($values) eq 'HASH') {
  360:                                 $settings = $values->{'usercreation'};
  361:                             }
  362:                         } elsif ($item eq 'defaults') {
  363:                             if (ref($values->{'inststatus'}) eq 'HASH') {
  364:                                 if (ref($values->{'defaults'}) eq 'HASH') {
  365:                                     $settings = {%{$values->{'inststatus'}},%{$values->{'defaults'}}};
  366:                                 } else {
  367:                                     $settings = $values->{'inststatus'};
  368:                                 }
  369:                             } else {
  370:                                 my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
  371:                                 my $inststatus = {
  372:                                                    inststatustypes => $usertypes,
  373:                                                    inststatusorder => $types,
  374:                                                    inststatusguest => [],
  375:                                                  };
  376:                                 if (ref($values->{defaults}) eq 'HASH') {
  377:                                     $settings = {%{$inststatus},%{$values->{'defaults'}}};
  378:                                 } else {
  379:                                     $settings = $inststatus;
  380:                                 }
  381:                             }
  382:                         }
  383:                         ($output{$item},$rowtotal{$item}) =
  384:                             &Apache::domainprefs::print_config_box($r,$dom,$confname,
  385:                                 $phase,$item,$prefs->{$item},$settings);
  386:                     } else {
  387:                         ($output{$item},$rowtotal{$item}) =
  388:                             &Apache::courseprefs::print_config_box($r,$dom,$phase,
  389:                                 $item,$prefs->{$item},$values,$allitems,$crstype,$parm_permission);
  390:                     }
  391:                     $rowsum += $rowtotal{$item};
  392:                 }
  393:             }
  394:             $r->print('<div id="prefs" style="max-width:'.$divwidth.'px;margin: 10px auto 10px auto;">');
  395:             for (my $i=0; $i<@items; $i++) {
  396:                 $r->print($output{$items[$i]});
  397:             }
  398:             $r->print('</div>');
  399:             $r->print(&print_footer($r,$phase,'process','Save Changes',\@actions,$container,$parm_permission));
  400:         } else {
  401:             $r->print('<input type="hidden" name="phase" value="" />'.
  402:                       '<span class="LC_error">'.&mt('No settings chosen').
  403:                       '</span>');
  404:         }
  405:         $r->print('</form>');
  406:     }
  407:     $r->print(&Apache::loncommon::end_page());
  408:     return;
  409: }
  410: 
  411: sub display_choices {
  412:     my ($r,$phase,$context,$prefs_order,$prefs,$container,$parm_permission) = @_;
  413:     if ($phase eq '') {
  414:         $phase = 'pickactions';
  415:     }
  416:     my %helphash;
  417:     &print_header($r,$phase,$context,undef,$container);
  418:     $r->print('<script type="text/javascript">'."\n".
  419:               '// <![CDATA['."\n".
  420:               &Apache::loncommon::check_uncheck_jscript()."\n".
  421:               '// ]]>'."\n".
  422:               '</script>'."\n");
  423:     my $heading = &mt('Settings to display/modify');
  424:     if (ref($parm_permission) eq 'HASH') {
  425:         unless ($parm_permission->{'process'}) {
  426:             $heading = &mt('Settings to display');
  427:         }
  428:     }
  429:     $r->print('<h3>'.$heading.'</h3>'.
  430:               '<div><input type="button" value="'.&mt('check all').'" '.
  431:               'onclick="javascript:checkAll(document.pickactions.actions)"'.
  432:               ' />'.('&nbsp;'x2).
  433:               '<input type="button" value="'.&mt('uncheck all').'" '.
  434:               'onclick="javascript:uncheckAll(document.pickactions.actions)" />'.
  435:               "\n".
  436:               '</div><div class="LC_left_float">');
  437:     my ($numitems,$maxincol,$firstthird,$secondthird,$seconddiv,$thirddiv,$count);
  438:     if (ref($prefs_order) eq 'ARRAY') {
  439:         $numitems = @{$prefs_order};
  440:     }
  441:     my $numcols = 3;
  442:     $maxincol = int($numitems/$numcols);
  443:     if ($numitems%$numcols) {
  444:         $maxincol ++;
  445:     }
  446:     $firstthird = $maxincol;
  447:     $secondthird = $firstthird + $maxincol;
  448:     $count = 0;
  449:     if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH')) {
  450:         foreach my $item (@{$prefs_order}) {
  451:             $r->print('<h4>'.
  452:                       &Apache::loncommon::help_open_topic($prefs->{$item}->{'help'}).
  453:                       '<label><input type="checkbox" name="actions" value="'.$item.
  454:                       '" />&nbsp;'.&mt($prefs->{$item}->{'text'}).'</label></h4>');
  455:             $count ++;
  456:             if ((!$seconddiv) && ($count >= $firstthird)) {
  457:                 $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
  458:                 $seconddiv = 1;
  459:             }
  460:             if ((!$thirddiv) && ($count >= $secondthird)) {
  461:                 $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
  462:                 $thirddiv = 1;
  463:             }
  464:         }
  465:         $r->print('</div><br clear="all" />');
  466:     }
  467:     $r->print(&print_footer($r,$phase,'display','Display',undef,$container,$parm_permission));
  468:     $r->print('</form>');
  469:     $r->print(&Apache::loncommon::end_page());
  470:     return;
  471: }
  472: 
  473: sub color_pick_js {
  474:     my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
  475:     my $output = <<"ENDCOL";
  476: 
  477:     $pjump_def
  478: 
  479:     function psub() {
  480:         modalWindow.close();
  481:         if (document.parmform.pres_marker.value!='') {
  482:             if (document.parmform.pres_type.value!='') {
  483:                 eval('document.display.'+
  484:                      document.parmform.pres_marker.value+
  485:                      '.value=document.parmform.pres_value.value;');
  486:             }
  487:         } else {
  488:             document.parmform.pres_value.value='';
  489:             document.parmform.pres_marker.value='';
  490:         }
  491:     }
  492: 
  493:     function get_id (span_id) {
  494:         if (document.getElementById) {
  495:             return document.getElementById(span_id);
  496:         }
  497:         if (document.all) {
  498:             return document.all[span_id];
  499:         }
  500:         return false;
  501:     }
  502: 
  503:     function colchg_span (span_id_str,new_color_item) {
  504:         var span_ref = get_id(span_id_str);
  505:         if (span_ref.style) { span_ref = span_ref.style; }
  506:         span_ref.background = new_color_item.value;
  507:         span_ref.backgroundColor = new_color_item.value;
  508:         span_ref.bgColor = new_color_item.value;
  509:     }
  510: 
  511: ENDCOL
  512:     return $output;
  513: }
  514: 
  515: sub get_crumb_text {
  516:     my %brcrumbtext = (
  517:                        domain => 'Domain Settings',
  518:                        course => 'Display/Edit Settings',
  519:                      );
  520:     return %brcrumbtext;
  521: }
  522: 
  523: 1;

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