Return to lonconfigsettings.pm CVS log

Up to [LON-CAPA] / loncom / interface

- Bug 6646
  - Domain Configuration for self-creation of accounts moved to its own
    separate panel (keep storage of settings in existing locations in
    configuration.db , i.e., usercreation and usermodification.
  - Additional option for self-created accounts which use an e-mail address
    as username -- queue for approval by Domain Coordinator.
  - Can specify which DC(s) should be notified if user account requests are
    added to the queue.
  - Can specify what information the user needs to provide in addition to
    an e-mail address when requesting creation of an account.

    1: # The LearningOnline Network with CAPA
    2: # Handler to set domain-wide configuration settings
    3: #
    4: # $Id: lonconfigsettings.pm,v 1.28 2014/02/12 20:37:42 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::lonparmset();
   39: 
   40: sub print_header {
   41:     my ($r,$phase,$context,$jscript,$container) = @_;
   42:     my ($pagetitle,$brcrumtitle,$action,$call_category_check,$crstype);
   43:     if ($context eq 'domain') {
   44:         ($pagetitle, $brcrumtitle) = ('View/Modify Domain Settings','View/Modify Domain Settings');
   45:         $action = '/adm/domainprefs';
   46:         if ($phase eq 'display') {
   47:             my @actions = &Apache::loncommon::get_env_multiple('form.actions');
   48:             if (grep(/^coursecategories$/,@actions)) {
   49:                 $call_category_check = qq|
   50:     if (formname == document.display) {
   51:         if (!categoryCheck(formname)) {
   52:             return;
   53:         }
   54:     }
   55: |;
   56:             }
   57:         }
   58:     } else {
   59:         $crstype = &Apache::loncommon::course_type();
   60:         if ($crstype eq 'Community') {
   61:             ($pagetitle,$brcrumtitle) = ('Community Configuration','Community Configuration');
   62:         } else {
   63:             ($pagetitle,$brcrumtitle) = ('Course Configuration','Course Configuration');
   64:         }
   65:         $action = '/adm/courseprefs';
   66:     }
   67:     my $alert = &mt('You must select at least one functionality type to display.');
   68:     my $js = '
   69: <script type="text/javascript">
   70: // <![CDATA[
   71: 
   72: function changePage(formname,newphase) {
   73:     formname.phase.value = newphase;
   74:     numchecked = 0;
   75:     if (formname == document.pickactions) {
   76:         if (formname.actions.length > 0) {
   77:             for (var i = 0; i<formname.actions.length; i++) {
   78:                 if (formname.actions[i].checked) {
   79:                     numchecked ++;
   80:                 }
   81:             }
   82:         } else {
   83:             if (formname.actions.checked) {
   84:                 numchecked ++;
   85:             }
   86:         }
   87:         if (numchecked > 0) {
   88:             formname.submit();
   89:         } else {
   90:             alert("'.$alert.'");
   91:             return;
   92:         }
   93:     }
   94:     '.$call_category_check.'
   95:     formname.submit();
   96: }'."\n";
   97:     if ($phase eq 'pickactions') {
   98: 	$js .= &Apache::lonhtmlcommon::color_picker();
   99:         $js .=
  100:             &Apache::lonhtmlcommon::set_form_elements({actions => 'checkbox'})."\n";
  101:     } elsif ($phase eq 'display') {
  102: 	$js .= &Apache::lonhtmlcommon::color_picker();
  103:         $js .= &color_pick_js()."\n";
  104:     }
  105:     $js .= &Apache::loncommon::viewport_size_js().'
  106: 
  107: // ]]>
  108: </script>
  109: ';
  110:     if ($jscript) {
  111:         $js .= "
  112: 
  113: $jscript
  114: 
  115: ";
  116:     }
  117:     my $additem;
  118:     if ($phase eq 'pickactions') {
  119:         my %loaditems = (
  120:                     'onload' => "setFormElements(document.pickactions);",
  121:                         );
  122:         $additem = {'add_entries' => \%loaditems,};
  123:     }
  124:     $r->print(&Apache::loncommon::start_page($pagetitle,$js,$additem));
  125:     $r->print(&Apache::lonhtmlcommon::breadcrumbs($brcrumtitle));
  126:     $r->print('
  127: <form name="parmform" action="">
  128: <input type="hidden" name="pres_marker" />
  129: <input type="hidden" name="pres_type" />
  130: <input type="hidden" name="pres_value" />
  131: </form>
  132: ');
  133:     if ($container) {
  134:        &Apache::lonparmset::startSettingsScreen($r,$container,$crstype);
  135:     }
  136:     $r->print('<form method="post" name="'.$phase.'" action="'.$action.'"'.
  137:               ' enctype="multipart/form-data">');
  138:     return;
  139: }
  140: 
  141: sub print_footer {
  142:     my ($r,$phase,$newphase,$button_text,$actions,$container) = @_;
  143:     $button_text = &mt($button_text);
  144:     $r->print('<input type="hidden" name="phase" value="" />');
  145:     if (defined($env{'form.origin'})) {
  146:         $r->print('<input type="hidden" name="origin" value="'.$env{'form.origin'}.'" />'."\n");
  147:     }
  148:     if (($phase eq 'display') || ($phase eq 'process')) {
  149:         if (ref($actions) eq 'ARRAY') {
  150:             foreach my $item (@{$actions}) {
  151:                 $r->print('<input type="hidden" name="actions" value="'.$item.'" />'."\n");
  152:             }
  153:         }
  154:     }
  155:     my $dest='"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
  156:     if ($phase eq 'process') {
  157:         $r->print(
  158:             &Apache::lonhtmlcommon::actionbox(
  159:                 ['<a href='.$dest.'>'.$button_text.'</a>']));
  160:     } else {
  161:         my $onclick;
  162:         if ($phase eq 'display') {
  163:             $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
  164:         } else {
  165:             $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
  166:         }
  167:         $r->print('<p><input type="button" name="store" value="'.
  168:                   $button_text.'" onclick='.$onclick.' /></p>');
  169:     }
  170:     if ($phase eq 'process') {
  171:         $r->print('</form>');
  172:         if ($container) {
  173:            &Apache::lonparmset::endSettingsScreen($r);
  174:         }
  175:         $r->print(&Apache::loncommon::end_page());
  176:     }
  177:     return;
  178: }
  179: 
  180: sub make_changes {
  181:     my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$roles,$allitems,$container) = @_;
  182:     my %brcrumtext = &get_crumb_text();
  183:     my @actions = &Apache::loncommon::get_env_multiple('form.actions');
  184:     my ($numchanged,%changes,%disallowed);
  185:     &Apache::lonhtmlcommon::add_breadcrumb
  186:       ({href=>"javascript:changePage(document.$phase,'display')",
  187:         text=>$brcrumtext{$context}},
  188:        {href=>"javascript:changePage(document.$phase,'$phase')",
  189:         text=>"Updated"});
  190:     &print_header($r,$phase,$context,undef,$container);
  191:     my ($crstype,%lastact);
  192:     if ($context eq 'course') {
  193:         $crstype = &Apache::loncommon::course_type();
  194:     }
  195:     if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && 
  196:         (ref($prefs) eq 'HASH')) {
  197:         foreach my $item (@{$prefs_order}) {
  198:             if (grep(/^\Q$item\E$/,@actions)) {
  199:                 if ($context eq 'domain') {
  200:                     $r->print('<h3>'.&mt($prefs->{$item}{'text'}).'</h3>'.
  201:                               &Apache::domainprefs::process_changes($r,$dom,
  202:                                           $confname,$item,$roles,$values,\%lastact));
  203:                 } else {
  204:                     $changes{$item} = {};
  205:                     &Apache::courseprefs::process_changes($dom,$item,$values,
  206:                                                           $prefs->{$item},$changes{$item},
  207:                                                           $allitems,\%disallowed,$crstype);
  208:                     if (keys(%{$changes{$item}}) > 0) {
  209:                         $numchanged ++;
  210:                     }
  211:                 }
  212:             }
  213:         }
  214:     }
  215:     if ($context eq 'course') {
  216:         if ($numchanged) {
  217:             my $message = &Apache::courseprefs::store_changes($dom,$confname,$prefs_order,\@actions,
  218:                                                           $prefs,$values,\%changes,$crstype);
  219:             $r->print(&Apache::loncommon::confirmwrapper($message));
  220:         } else {
  221:             if ($crstype eq 'Community') {
  222:                 $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to community configuration.")));
  223:             } else {
  224:                 $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to course configuration.")));
  225:             }
  226:         }
  227:         if (keys(%disallowed) > 0) {
  228:             $r->print('<p>');
  229:             foreach my $item ('cloners','rolenames','feedback','discussion','localization') {
  230:                 if (ref($disallowed{$item}) eq 'HASH') {
  231:                     if (keys(%{$disallowed{$item}}) > 0) {
  232:                         $r->print(&Apache::courseprefs::display_disallowed($item,$disallowed{$item},
  233:                                                                            $prefs,$crstype));
  234:                     }
  235:                 }
  236:             }
  237:             $r->print('</p>');
  238:         }
  239:     }
  240:     $r->print('<p>');
  241:     my $footer_text = 'Back to configuration display';
  242:     if ($context eq 'course') {
  243:         $footer_text = 'Back to display/edit settings'; 
  244:     }
  245:     &print_footer($r,$phase,'display',$footer_text,\@actions,$container);
  246:     $r->print('</p>');
  247:     return \%lastact;
  248: }
  249: 
  250: sub display_settings {
  251:     my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$jscript,
  252:         $allitems,$crstype,$container) = @_;
  253:     my %brcrumtext = &get_crumb_text();
  254:     my @actions = &Apache::loncommon::get_env_multiple('form.actions');
  255:     &Apache::lonhtmlcommon::add_breadcrumb
  256:         ({href=>"javascript:changePage(document.$phase,'display')",
  257:           text=>"Display/Edit Settings"});
  258:     &print_header($r,$phase,$context,$jscript,$container);
  259:     my $divwidth = 900;
  260:     if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && (ref($values) eq 'HASH')) { 
  261:         if (@actions > 0) {
  262:             my $rowsum = 0;
  263:             my (%output,%rowtotal,@items);
  264:             foreach my $item (@{$prefs_order}) {
  265:                 if (grep(/^\Q$item\E$/,@actions)) {
  266:                     push(@items,$item);
  267:                     if ($context eq 'domain') {
  268:                         my $settings = $values->{$item}; 
  269:                         if ($item eq 'usersessions') {
  270:                             $r->print('<script type="text/javascript">'."\n".
  271:                                       '// <![CDATA['."\n".
  272:                                       &Apache::loncommon::check_uncheck_jscript()."\n".
  273:                                       '// ]]>'."\n".
  274:                                       '</script>'."\n");
  275:                         } elsif ($item eq 'selfcreation') {
  276:                             $settings = $values->{'usercreation'};
  277:                         }
  278:                         ($output{$item},$rowtotal{$item}) =
  279:                             &Apache::domainprefs::print_config_box($r,$dom,$confname,
  280:                                 $phase,$item,$prefs->{$item},$settings);
  281:                     } else {
  282:                         ($output{$item},$rowtotal{$item}) =
  283:                             &Apache::courseprefs::print_config_box($r,$dom,$phase,
  284:                                 $item,$prefs->{$item},$values,$allitems,$crstype);
  285:                     }
  286:                     $rowsum += $rowtotal{$item};
  287:                 }
  288:             }
  289:             $r->print('<div id="prefs" style="max-width:'.$divwidth.'px;margin: 10px auto 10px auto;">');
  290:             for (my $i=0; $i<@items; $i++) {
  291:                 $r->print($output{$items[$i]});
  292:             }
  293:             $r->print('</div>');
  294:             $r->print(&print_footer($r,$phase,'process','Save Changes',\@actions,$container));
  295:         } else {
  296:             $r->print('<input type="hidden" name="phase" value="" />'.
  297:                       '<span class="LC_error">'.&mt('No settings chosen').
  298:                       '</span>');
  299:         }
  300:         $r->print('</form>');
  301:     }
  302:     if ($container) {
  303:         &Apache::lonparmset::endSettingsScreen($r);
  304:     }
  305:     $r->print(&Apache::loncommon::end_page());
  306:     return;
  307: }
  308: 
  309: sub display_choices {
  310:     my ($r,$phase,$context,$prefs_order,$prefs,$container) = @_;
  311:     if ($phase eq '') {
  312:         $phase = 'pickactions';
  313:     }
  314:     my %helphash;
  315:     &print_header($r,$phase,$context,undef,$container);
  316:     $r->print('<script type="text/javascript">'."\n".
  317:               '// <![CDATA['."\n".
  318:               &Apache::loncommon::check_uncheck_jscript()."\n".
  319:               '// ]]>'."\n".
  320:               '</script>'."\n");
  321:     $r->print('<h3>'.&mt('Settings to display/modify').'</h3>'.
  322:               '<div><input type="button" value="'.&mt('check all').'" '.
  323:               'onclick="javascript:checkAll(document.pickactions.actions)"'.
  324:               ' />'.('&nbsp;'x2).
  325:               '<input type="button" value="'.&mt('uncheck all').'" '.
  326:               'onclick="javascript:uncheckAll(document.pickactions.actions)" />'.
  327:               "\n".
  328:               '</div><div class="LC_left_float">');
  329:     my ($numitems,$maxincol,$firstthird,$secondthird,$seconddiv,$thirddiv,$count);
  330:     if (ref($prefs_order) eq 'ARRAY') {
  331:         $numitems = @{$prefs_order};
  332:     }
  333:     my $numcols = 3;
  334:     $maxincol = int($numitems/$numcols);
  335:     if ($numitems%$numcols) {
  336:         $maxincol ++;
  337:     }
  338:     $firstthird = $maxincol;
  339:     $secondthird = $firstthird + $maxincol;
  340:     $count = 0;
  341:     if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH')) {
  342:         foreach my $item (@{$prefs_order}) {
  343:             $r->print('<h4>'.
  344:                       &Apache::loncommon::help_open_topic($prefs->{$item}->{'help'}).
  345:                       '<label><input type="checkbox" name="actions" value="'.$item.
  346:                       '" />&nbsp;'.&mt($prefs->{$item}->{'text'}).'</label></h4>');
  347:             $count ++;
  348:             if ((!$seconddiv) && ($count >= $firstthird)) {
  349:                 $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
  350:                 $seconddiv = 1;
  351:             }
  352:             if ((!$thirddiv) && ($count >= $secondthird)) {
  353:                 $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
  354:                 $thirddiv = 1;
  355:             }
  356:         }
  357:         $r->print('</div><br clear="all" />');
  358:     }
  359:     $r->print(&print_footer($r,$phase,'display','Display',undef,$container));
  360:     $r->print('</form>');
  361:     if ($container) {
  362:         &Apache::lonparmset::endSettingsScreen($r);
  363:     }
  364:     $r->print(&Apache::loncommon::end_page());
  365:     return;
  366: }
  367: 
  368: sub color_pick_js {
  369:     my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
  370:     my $output = <<"ENDCOL";
  371: 
  372:     $pjump_def
  373: 
  374:     function psub() {
  375:         modalWindow.close();
  376:         if (document.parmform.pres_marker.value!='') {
  377:             if (document.parmform.pres_type.value!='') {
  378:                 eval('document.display.'+
  379:                      document.parmform.pres_marker.value+
  380:                      '.value=document.parmform.pres_value.value;');
  381:             }
  382:         } else {
  383:             document.parmform.pres_value.value='';
  384:             document.parmform.pres_marker.value='';
  385:         }
  386:     }
  387: 
  388:     function get_id (span_id) {
  389:         if (document.getElementById) {
  390:             return document.getElementById(span_id);
  391:         }
  392:         if (document.all) {
  393:             return document.all[span_id];
  394:         }
  395:         return false;
  396:     }
  397: 
  398:     function colchg_span (span_id_str,new_color_item) {
  399:         var span_ref = get_id(span_id_str);
  400:         if (span_ref.style) { span_ref = span_ref.style; }
  401:         span_ref.background = new_color_item.value;
  402:         span_ref.backgroundColor = new_color_item.value;
  403:         span_ref.bgColor = new_color_item.value;
  404:     }
  405: 
  406: ENDCOL
  407:     return $output;
  408: }
  409: 
  410: sub get_crumb_text {
  411:     my %brcrumbtext = (
  412:                        domain => 'Domain Settings',
  413:                        course => 'Display/Edit Settings',
  414:                      );
  415:     return %brcrumbtext;
  416: }
  417: 
  418: 1;