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

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

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