1: # The LearningOnline Network with CAPA
2: # Handler to set domain-wide configuration settings
3: #
4: # $Id: lonconfigsettings.pm,v 1.21.4.11 2019/08/27 20:43:52 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,$instcode,$dom) = @_;
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: my $onload;
180: if (grep(/^coursedefaults$/,@actions)) {
181: $onload = "toggleDisplay(document.display,'cloneinstcode');".
182: "toggleDisplay(document.display,'credits');".
183: "toggleDisplay(document.display,'studentsubmission');";
184: }
185: if (grep(/^selfcreation$/,@actions)) {
186: my $prefix = 'cancreate_emailverified';
187: my $customclass = 'LC_selfcreate_email';
188: my $classprefix = 'LC_canmodify_emailusername_';
189: my $optionsprefix = 'LC_options_emailusername_';
190: $onload .= "toggleRows(document.display,'cancreate_email','selfassign','$customclass','$classprefix','$optionsprefix');";
191: my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
192: my $hascustom;
193: my ($emailrules,$emailruleorder) = &Apache::lonnet::inst_userrules($dom,'email');
194: if (ref($emailrules) eq 'HASH') {
195: if (keys(%{$emailrules}) > 0) {
196: $hascustom = 'cancreate_emailrule';
197: }
198: }
199: my @posstypes;
200: if (ref($types) eq 'ARRAY') {
201: @posstypes = @{$types};
202: push(@posstypes,'default');
203: foreach my $type (@posstypes) {
204: $onload .= "toggleEmailOptions(document.display,'cancreate_emailoptions','$hascustom',".
205: "'cancreate_emaildomain','$type');";
206: }
207: } else {
208: $onload .= "toggleEmailOptions(document.display,'cancreate_emailoptions','$hascustom',".
209: "'cancreate_emaildomain','default');";
210: }
211: }
212: if (grep(/^contacts$/,@actions)) {
213: my $customclass = 'LC_helpdesk_override';
214: my $optionsprefix = 'LC_options_helpdesk_';
215: $onload .= "toggleHelpdeskRow(document.display,'overrides','$customclass','$optionsprefix');";
216: }
217: if (grep(/^scantron$/,@actions)) {
218: $onload .= "toggleScantron('document.display');";
219: }
220: if ($onload) {
221: my %loaditems = (
222: 'onload' => $onload,
223: );
224: $additem = {'add_entries' => \%loaditems,};
225: }
226: } elsif ($context eq 'course') {
227: if (grep(/^courseinfo$/,@actions)) {
228: if (@code_order) {
229: $additem = {
230: add_entries => {'onload' => "courseSet('','load');toggleCloners(document.display.cloners_instcode);"},
231: };
232: }
233: }
234: }
235: }
236: $r->print(&Apache::loncommon::start_page($pagetitle,$js,$additem));
237: $r->print(&Apache::lonhtmlcommon::breadcrumbs($brcrumtitle));
238: $r->print('
239: <form name="parmform" action="">
240: <input type="hidden" name="pres_marker" />
241: <input type="hidden" name="pres_type" />
242: <input type="hidden" name="pres_value" />
243: </form>
244: ');
245: $r->print('<form method="post" name="'.$phase.'" action="'.$action.'"'.
246: ' enctype="multipart/form-data">');
247: return;
248: }
249:
250: sub print_footer {
251: my ($r,$phase,$newphase,$button_text,$actions,$container,$parm_permission) = @_;
252: $button_text = &mt($button_text);
253: $r->print('<input type="hidden" name="phase" value="" />');
254: if (defined($env{'form.origin'})) {
255: $r->print('<input type="hidden" name="origin" value="'.$env{'form.origin'}.'" />'."\n");
256: }
257: if (($phase eq 'display') || ($phase eq 'process')) {
258: if (ref($actions) eq 'ARRAY') {
259: foreach my $item (@{$actions}) {
260: $r->print('<input type="hidden" name="actions" value="'.$item.'" />'."\n");
261: }
262: }
263: }
264: my $dest='"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
265: if ($phase eq 'process') {
266: $r->print(
267: &Apache::lonhtmlcommon::actionbox(
268: ['<a href='.$dest.'>'.$button_text.'</a>']));
269: } else {
270: my $onclick;
271: if ($phase eq 'display') {
272: $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
273: } else {
274: $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
275: }
276: my $showbutton = 1;
277: if (ref($parm_permission) eq 'HASH') {
278: unless (($parm_permission->{'process'}) || ($newphase eq 'display')) {
279: $showbutton = 0;
280: }
281: }
282: if ($showbutton) {
283: $r->print('<p><input type="button" name="store" value="'.
284: $button_text.'" onclick='.$onclick.' /></p>');
285: }
286: }
287: if ($phase eq 'process') {
288: $r->print('</form>');
289: $r->print(&Apache::loncommon::end_page());
290: }
291: return;
292: }
293:
294: sub make_changes {
295: my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$roles,
296: $allitems,$container,$parm_permission) = @_;
297: my %brcrumtext = &get_crumb_text();
298: my @actions = &Apache::loncommon::get_env_multiple('form.actions');
299: my ($numchanged,%changes,%disallowed);
300: &Apache::lonhtmlcommon::add_breadcrumb
301: ({href=>"javascript:changePage(document.$phase,'display')",
302: text=>$brcrumtext{$context}},
303: {href=>"javascript:changePage(document.$phase,'$phase')",
304: text=>"Updated"});
305: &print_header($r,$phase,$context,undef,$container);
306: my ($crstype,%lastact);
307: if ($context eq 'course') {
308: $crstype = &Apache::loncommon::course_type();
309: }
310: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') &&
311: (ref($prefs) eq 'HASH')) {
312: foreach my $item (@{$prefs_order}) {
313: if (grep(/^\Q$item\E$/,@actions)) {
314: if ($context eq 'domain') {
315: $r->print('<h3>'.&mt($prefs->{$item}{'text'}).'</h3>'.
316: &Apache::domainprefs::process_changes($r,$dom,
317: $confname,$item,$roles,$values,\%lastact));
318: } else {
319: $changes{$item} = {};
320: &Apache::courseprefs::process_changes($dom,$item,$values,
321: $prefs->{$item},$changes{$item},
322: $allitems,\%disallowed,$crstype);
323: if (keys(%{$changes{$item}}) > 0) {
324: $numchanged ++;
325: }
326: }
327: }
328: }
329: }
330: if ($context eq 'course') {
331: if ($numchanged) {
332: my $message = &Apache::courseprefs::store_changes($dom,$confname,$prefs_order,\@actions,
333: $prefs,$values,\%changes,$crstype);
334: $r->print(&Apache::loncommon::confirmwrapper($message));
335: } else {
336: if ($crstype eq 'Community') {
337: $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to community configuration.")));
338: } else {
339: $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to course configuration.")));
340: }
341: }
342: if (keys(%disallowed) > 0) {
343: $r->print('<p>');
344: foreach my $item ('cloners','rolenames','feedback','discussion','localization') {
345: if (ref($disallowed{$item}) eq 'HASH') {
346: if (keys(%{$disallowed{$item}}) > 0) {
347: $r->print(&Apache::courseprefs::display_disallowed($item,$disallowed{$item},
348: $prefs,$crstype));
349: }
350: }
351: }
352: $r->print('</p>');
353: }
354: }
355: $r->print('<p>');
356: my $footer_text = 'Back to configuration display';
357: if ($context eq 'course') {
358: $footer_text = 'Back to display/edit settings';
359: }
360: &print_footer($r,$phase,'display',$footer_text,\@actions,$container,$parm_permission);
361: $r->print('</p>');
362: return \%lastact;
363: }
364:
365: sub display_settings {
366: my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$jscript,
367: $allitems,$crstype,$container,$parm_permission) = @_;
368: my %brcrumtext = &get_crumb_text();
369: my @actions = &Apache::loncommon::get_env_multiple('form.actions');
370: &Apache::lonhtmlcommon::add_breadcrumb
371: ({href=>"javascript:changePage(document.$phase,'display')",
372: text=>"Display/Edit Settings"});
373: my $instcode;
374: if (ref($values) eq 'HASH') {
375: $instcode = $values->{'internal.coursecode'};
376: }
377: &print_header($r,$phase,$context,$jscript,$container,$instcode,$dom);
378: my $divwidth = 900;
379: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && (ref($values) eq 'HASH')) {
380: if (@actions > 0) {
381: my $rowsum = 0;
382: my (%output,%rowtotal,@items);
383: foreach my $item (@{$prefs_order}) {
384: if (grep(/^\Q$item\E$/,@actions)) {
385: push(@items,$item);
386: if ($context eq 'domain') {
387: my $settings;
388: if (ref($values) eq 'HASH') {
389: $settings = $values->{$item};
390: }
391: if ($item eq 'usersessions') {
392: $r->print('<script type="text/javascript">'."\n".
393: '// <![CDATA['."\n".
394: &Apache::loncommon::check_uncheck_jscript()."\n".
395: '// ]]>'."\n".
396: '</script>'."\n");
397: } elsif ($item eq 'selfcreation') {
398: if (ref($values) eq 'HASH') {
399: $settings = $values->{'usercreation'};
400: }
401: } elsif ($item eq 'defaults') {
402: if (ref($values->{'inststatus'}) eq 'HASH') {
403: if (ref($values->{'defaults'}) eq 'HASH') {
404: $settings = {%{$values->{'inststatus'}},%{$values->{'defaults'}}};
405: } else {
406: $settings = $values->{'inststatus'};
407: }
408: } else {
409: my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
410: my $inststatus = {
411: inststatustypes => $usertypes,
412: inststatusorder => $types,
413: inststatusguest => [],
414: };
415: if (ref($values->{defaults}) eq 'HASH') {
416: $settings = {%{$inststatus},%{$values->{'defaults'}}};
417: } else {
418: $settings = $inststatus;
419: }
420: }
421: }
422: ($output{$item},$rowtotal{$item}) =
423: &Apache::domainprefs::print_config_box($r,$dom,$confname,
424: $phase,$item,$prefs->{$item},$settings);
425: } else {
426: ($output{$item},$rowtotal{$item}) =
427: &Apache::courseprefs::print_config_box($r,$dom,$phase,
428: $item,$prefs->{$item},$values,$allitems,$crstype,$parm_permission);
429: }
430: $rowsum += $rowtotal{$item};
431: }
432: }
433: $r->print('<div id="prefs" style="max-width:'.$divwidth.'px;margin: 10px auto 10px auto;">');
434: for (my $i=0; $i<@items; $i++) {
435: $r->print($output{$items[$i]});
436: }
437: $r->print('</div>');
438: $r->print(&print_footer($r,$phase,'process','Save Changes',\@actions,$container,$parm_permission));
439: } else {
440: $r->print('<input type="hidden" name="phase" value="" />'.
441: '<span class="LC_error">'.&mt('No settings chosen').
442: '</span>');
443: }
444: $r->print('</form>');
445: }
446: $r->print(&Apache::loncommon::end_page());
447: return;
448: }
449:
450: sub display_choices {
451: my ($r,$phase,$context,$prefs_order,$prefs,$container,$parm_permission) = @_;
452: if ($phase eq '') {
453: $phase = 'pickactions';
454: }
455: my %helphash;
456: &print_header($r,$phase,$context,undef,$container);
457: $r->print('<script type="text/javascript">'."\n".
458: '// <![CDATA['."\n".
459: &Apache::loncommon::check_uncheck_jscript()."\n".
460: '// ]]>'."\n".
461: '</script>'."\n");
462: my $heading = &mt('Settings to display/modify');
463: if (ref($parm_permission) eq 'HASH') {
464: unless ($parm_permission->{'process'}) {
465: $heading = &mt('Settings to display');
466: }
467: }
468: $r->print('<h3>'.$heading.'</h3>'.
469: '<div><input type="button" value="'.&mt('check all').'" '.
470: 'onclick="javascript:checkAll(document.pickactions.actions)"'.
471: ' />'.(' 'x2).
472: '<input type="button" value="'.&mt('uncheck all').'" '.
473: 'onclick="javascript:uncheckAll(document.pickactions.actions)" />'.
474: "\n".
475: '</div><div class="LC_left_float">');
476: my ($numitems,$maxincol,$firstthird,$secondthird,$seconddiv,$thirddiv,$count);
477: if (ref($prefs_order) eq 'ARRAY') {
478: $numitems = @{$prefs_order};
479: }
480: my $numcols = 3;
481: $maxincol = int($numitems/$numcols);
482: if ($numitems%$numcols) {
483: $maxincol ++;
484: }
485: $firstthird = $maxincol;
486: $secondthird = $firstthird + $maxincol;
487: $count = 0;
488: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH')) {
489: foreach my $item (@{$prefs_order}) {
490: $r->print('<h4>'.
491: &Apache::loncommon::help_open_topic($prefs->{$item}->{'help'}).
492: '<label><input type="checkbox" name="actions" value="'.$item.
493: '" /> '.&mt($prefs->{$item}->{'text'}).'</label></h4>');
494: $count ++;
495: if ((!$seconddiv) && ($count >= $firstthird)) {
496: $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
497: $seconddiv = 1;
498: }
499: if ((!$thirddiv) && ($count >= $secondthird)) {
500: $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
501: $thirddiv = 1;
502: }
503: }
504: $r->print('</div><br clear="all" />');
505: }
506: $r->print(&print_footer($r,$phase,'display','Display',undef,$container,$parm_permission));
507: $r->print('</form>');
508: $r->print(&Apache::loncommon::end_page());
509: return;
510: }
511:
512: sub color_pick_js {
513: my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
514: my $output = <<"ENDCOL";
515:
516: $pjump_def
517:
518: function psub() {
519: modalWindow.close();
520: if (document.parmform.pres_marker.value!='') {
521: if (document.parmform.pres_type.value!='') {
522: eval('document.display.'+
523: document.parmform.pres_marker.value+
524: '.value=document.parmform.pres_value.value;');
525: }
526: } else {
527: document.parmform.pres_value.value='';
528: document.parmform.pres_marker.value='';
529: }
530: }
531:
532: function get_id (span_id) {
533: if (document.getElementById) {
534: return document.getElementById(span_id);
535: }
536: if (document.all) {
537: return document.all[span_id];
538: }
539: return false;
540: }
541:
542: function colchg_span (span_id_str,new_color_item) {
543: var span_ref = get_id(span_id_str);
544: if (span_ref.style) { span_ref = span_ref.style; }
545: span_ref.background = new_color_item.value;
546: span_ref.backgroundColor = new_color_item.value;
547: span_ref.bgColor = new_color_item.value;
548: }
549:
550: ENDCOL
551: return $output;
552: }
553:
554: sub get_crumb_text {
555: my %brcrumbtext = (
556: domain => 'Domain Settings',
557: course => 'Display/Edit Settings',
558: );
559: return %brcrumbtext;
560: }
561:
562: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>