Annotation of loncom/interface/lonconfigsettings.pm, revision 1.22

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

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