1: # The LearningOnline Network with CAPA
2: # Handler to set domain-wide configuration settings
3: #
4: # $Id: lonconfigsettings.pm,v 1.47 2020/09/17 00:35:04 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: use Apache::courseclassifier();
40: use LONCAPA qw(:DEFAULT :match);
41:
42: sub print_header {
43: my ($r,$phase,$context,$jscript,$container,$instcode,$dom,$values) = @_;
44: my ($pagetitle,$brcrumtitle,$action,$call_category_check,$instcode_check,
45: $crstype,@actions,@code_order);
46: if ($phase eq 'display') {
47: @actions = &Apache::loncommon::get_env_multiple('form.actions');
48: }
49: if ($context eq 'domain') {
50: ($pagetitle, $brcrumtitle) = ('View/Modify Domain Settings','View/Modify Domain Settings');
51: $action = '/adm/domainprefs';
52: if ($phase eq 'display') {
53: if (grep(/^coursecategories$/,@actions)) {
54: $call_category_check = qq|
55: if (formname == document.display) {
56: if (!categoryCheck(formname)) {
57: return;
58: }
59: }
60: |;
61: }
62: }
63: } else {
64: $crstype = &Apache::loncommon::course_type();
65: if ($crstype eq 'Community') {
66: ($pagetitle,$brcrumtitle) = ('Community Configuration','Community Configuration');
67: } else {
68: ($pagetitle,$brcrumtitle) = ('Course Configuration','Course Configuration');
69: }
70: $action = '/adm/courseprefs';
71: if ($phase eq 'display') {
72: if (grep(/^courseinfo$/,@actions)) {
73: my %codedefaults;
74: &Apache::lonnet::auto_instcode_defaults($env{'request.role.domain'},\%codedefaults,
75: \@code_order);
76: if (@code_order) {
77: my $noinstcodestr = &mt('You indicated cloning based on category, but did not select any categories.');
78: &js_escape(\$noinstcodestr);
79: $instcode_check = <<"ENDSCRIPT";
80: if (formname == document.display) {
81: if (formname.cloners_instcode.length) {
82: for (var j=0; j<formname.cloners_instcode.length; j++) {
83: if (formname.cloners_instcode[j].checked) {
84: if (formname.cloners_instcode[j].value == 1) {
85: var codes;
86: if (document.getElementsByClassName) {
87: codes = document.getElementsByClassName('LC_cloners_instcodes');
88: } else {
89: codes = getElementsByClassName(document.body,'LC_cloners_instcodes');
90: }
91: if (codes.length) {
92: var gotcode = 0;
93: for (var i=0; i<codes.length; i++) {
94: if (codes[i].selectedIndex != 0) {
95: gotcode = 1;
96: break;
97: }
98: }
99: if (!gotcode) {
100: for (var k=0; k<formname.cloners_instcode.length; k++) {
101: if (formname.cloners_instcode[k].value == 0) {
102: formname.cloners_instcode[k].checked = true;
103: }
104: }
105: toggleCloners(document.display.cloners_instcode);
106: alert('$noinstcodestr');
107: return false;
108: }
109: }
110: }
111: }
112: }
113: }
114: }
115:
116: ENDSCRIPT
117: }
118: }
119: }
120: }
121: my $alert = &mt('You must select at least one functionality type to display.');
122: &js_escape(\$alert);
123: my $js = '
124: <script type="text/javascript">
125: // <![CDATA[
126:
127: function changePage(formname,newphase) {
128: formname.phase.value = newphase;
129: numchecked = 0;
130: if (formname == document.pickactions) {
131: if (formname.actions.length > 0) {
132: for (var i = 0; i<formname.actions.length; i++) {
133: if (formname.actions[i].checked) {
134: numchecked ++;
135: }
136: }
137: } else {
138: if (formname.actions.checked) {
139: numchecked ++;
140: }
141: }
142: if (numchecked > 0) {
143: formname.submit();
144: } else {
145: alert("'.$alert.'");
146: return;
147: }
148: }
149: '.$instcode_check.$call_category_check.'
150: formname.submit();
151: }'."\n";
152: if ($phase eq 'pickactions') {
153: $js .= &Apache::lonhtmlcommon::color_picker();
154: $js .=
155: &Apache::lonhtmlcommon::set_form_elements({actions => 'checkbox'})."\n";
156: } elsif ($phase eq 'display') {
157: $js .= &Apache::lonhtmlcommon::color_picker();
158: $js .= &color_pick_js()."\n";
159: }
160: $js .= &Apache::loncommon::viewport_size_js().'
161:
162: // ]]>
163: </script>
164: ';
165: if ($jscript) {
166: $js .= "
167:
168: $jscript
169:
170: ";
171: }
172: my $additem;
173: if ($phase eq 'pickactions') {
174: my %loaditems = (
175: 'onload' => "setFormElements(document.pickactions);",
176: );
177: $additem = {'add_entries' => \%loaditems,};
178: } elsif ($phase eq 'display') {
179: if ($context eq 'domain') {
180: my $onload;
181: if (grep(/^coursedefaults$/,@actions)) {
182: $onload = "toggleDisplay(document.display,'cloneinstcode');".
183: "toggleDisplay(document.display,'credits');".
184: "toggleDisplay(document.display,'studentsubmission');";
185: }
186: if (grep(/^selfcreation$/,@actions)) {
187: my $prefix = 'cancreate_emailverified';
188: my $customclass = 'LC_selfcreate_email';
189: my $classprefix = 'LC_canmodify_emailusername_';
190: my $optionsprefix = 'LC_options_emailusername_';
191: $onload .= "toggleRows(document.display,'cancreate_email','selfassign','$customclass','$classprefix','$optionsprefix');";
192: my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
193: my $hascustom;
194: my ($emailrules,$emailruleorder) = &Apache::lonnet::inst_userrules($dom,'email');
195: if (ref($emailrules) eq 'HASH') {
196: if (keys(%{$emailrules}) > 0) {
197: $hascustom = 'cancreate_emailrule';
198: }
199: }
200: my @posstypes;
201: if (ref($types) eq 'ARRAY') {
202: @posstypes = @{$types};
203: push(@posstypes,'default');
204: foreach my $type (@posstypes) {
205: $onload .= "toggleEmailOptions(document.display,'cancreate_emailoptions','$hascustom',".
206: "'cancreate_emaildomain','$type');";
207: }
208: } else {
209: $onload .= "toggleEmailOptions(document.display,'cancreate_emailoptions','$hascustom',".
210: "'cancreate_emaildomain','default');";
211: }
212: }
213: if (grep(/^contacts$/,@actions)) {
214: my $customclass = 'LC_helpdesk_override';
215: my $optionsprefix = 'LC_options_helpdesk_';
216: $onload .= "toggleHelpdeskRow(document.display,'overrides','$customclass','$optionsprefix');";
217: }
218: if (grep(/^lti$/,@actions)) {
219: $onload .= "toggleLTI(document.display,'user','add');".
220: "toggleLTI(document.display,'crs','add');".
221: "toggleLTI(document.display,'sec','add');".
222: "toggleLTI(document.display,'lcauth','add');".
223: "toggleLTI(document.display,'lcmenu','add');".
224: "toggleLTI(document.display,'passback','add');".
225: "toggleLTI(document.display,'callback','add');";
226: if (ref($values) eq 'HASH') {
227: if (ref($values->{'lti'}) eq 'HASH') {
228: my $numlti = scalar(keys(%{$values->{'lti'}}));
229: for (my $i=0; $i<$numlti; $i++) {
230: $onload .= "toggleLTI(document.display,'user','$i');".
231: "toggleLTI(document.display,'crs','$i');".
232: "toggleLTI(document.display,'sec','$i');".
233: "toggleLTI(document.display,'lcauth','$i');".
234: "toggleLTI(document.display,'lcmenu','$i');".
235: "toggleLTI(document.display,'passback','$i');".
236: "toggleLTI(document.display,'callback','$i');";
237: }
238: }
239: }
240: }
241: if (grep(/^ltitools$/,@actions)) {
242: $onload .= "toggleLTITools(document.display,'passback','add');".
243: "toggleLTITools(document.display,'roster','add');".
244: "toggleLTITools(document.display,'user','add');";
245: if (ref($values) eq 'HASH') {
246: if (ref($values->{'ltitools'}) eq 'HASH') {
247: my $numltitools = scalar(keys(%{$values->{'ltitools'}}));
248: for (my $i=0; $i<$numltitools; $i++) {
249: $onload .= "toggleLTITools(document.display,'passback','$i');".
250: "toggleLTITools(document.display,'roster','$i');".
251: "toggleLTITools(document.display,'user','$i');";
252: }
253: }
254: }
255: }
256: if (grep(/^proctoring$/,@actions)) {
257: $onload .= "toggleProctoring(document.display,'proctorio');".
258: "toggleProctoring(document.display,'examity');";
259: }
260: if (grep(/^scantron$/,@actions)) {
261: $onload .= "toggleScantron('document.display');";
262: }
263: if ($onload) {
264: my %loaditems = (
265: 'onload' => $onload,
266: );
267: $additem = {'add_entries' => \%loaditems,};
268: }
269: } elsif ($context eq 'course') {
270: if (grep(/^courseinfo$/,@actions)) {
271: if (@code_order) {
272: $additem = {
273: add_entries => {'onload' => "courseSet('','load');toggleCloners(document.display.cloners_instcode);"},
274: };
275: }
276: }
277: }
278: }
279: $r->print(&Apache::loncommon::start_page($pagetitle,$js,$additem));
280: $r->print(&Apache::lonhtmlcommon::breadcrumbs($brcrumtitle));
281: $r->print('
282: <form name="parmform" action="">
283: <input type="hidden" name="pres_marker" />
284: <input type="hidden" name="pres_type" />
285: <input type="hidden" name="pres_value" />
286: </form>
287: ');
288: if ($container) {
289: &Apache::lonparmset::startSettingsScreen($r,$container,$crstype);
290: }
291: $r->print('<form method="post" name="'.$phase.'" action="'.$action.'"'.
292: ' enctype="multipart/form-data">');
293: return;
294: }
295:
296: sub print_footer {
297: my ($r,$phase,$newphase,$button_text,$actions,$container,$parm_permission) = @_;
298: $button_text = &mt($button_text);
299: $r->print('<input type="hidden" name="phase" value="" />');
300: if (defined($env{'form.origin'})) {
301: $r->print('<input type="hidden" name="origin" value="'.$env{'form.origin'}.'" />'."\n");
302: }
303: if (($phase eq 'display') || ($phase eq 'process')) {
304: if (ref($actions) eq 'ARRAY') {
305: foreach my $item (@{$actions}) {
306: $r->print('<input type="hidden" name="actions" value="'.$item.'" />'."\n");
307: }
308: }
309: }
310: my $dest='"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
311: if ($phase eq 'process') {
312: $r->print(
313: &Apache::lonhtmlcommon::actionbox(
314: ['<a href='.$dest.'>'.$button_text.'</a>']));
315: } else {
316: my $onclick;
317: if ($phase eq 'display') {
318: $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
319: } else {
320: $onclick = '"javascript:changePage(document.'.$phase.','."'$newphase'".')"';
321: }
322: my $showbutton = 1;
323: if (ref($parm_permission) eq 'HASH') {
324: unless (($parm_permission->{'process'}) || ($newphase eq 'display')) {
325: $showbutton = 0;
326: }
327: }
328: if ($showbutton) {
329: $r->print('<p><input type="button" name="store" value="'.
330: $button_text.'" onclick='.$onclick.' /></p>');
331: }
332: }
333: if ($phase eq 'process') {
334: $r->print('</form>');
335: if ($container) {
336: &Apache::lonparmset::endSettingsScreen($r);
337: }
338: $r->print(&Apache::loncommon::end_page());
339: }
340: return;
341: }
342:
343: sub make_changes {
344: my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$roles,
345: $allitems,$container,$parm_permission) = @_;
346: my %brcrumtext = &get_crumb_text();
347: my @actions = &Apache::loncommon::get_env_multiple('form.actions');
348: my ($numchanged,%changes,%disallowed);
349: &Apache::lonhtmlcommon::add_breadcrumb
350: ({href=>"javascript:changePage(document.$phase,'display')",
351: text=>$brcrumtext{$context}},
352: {href=>"javascript:changePage(document.$phase,'$phase')",
353: text=>"Updated"});
354: &print_header($r,$phase,$context,undef,$container);
355: my ($crstype,%lastact);
356: if ($context eq 'course') {
357: $crstype = &Apache::loncommon::course_type();
358: }
359: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') &&
360: (ref($prefs) eq 'HASH')) {
361: foreach my $item (@{$prefs_order}) {
362: if (grep(/^\Q$item\E$/,@actions)) {
363: if ($context eq 'domain') {
364: $r->print('<h3>'.&mt($prefs->{$item}{'text'}).'</h3>'.
365: &Apache::domainprefs::process_changes($r,$dom,
366: $confname,$item,$roles,$values,\%lastact));
367: } else {
368: $changes{$item} = {};
369: &Apache::courseprefs::process_changes($dom,$item,$values,
370: $prefs->{$item},$changes{$item},
371: $allitems,\%disallowed,$crstype);
372: if (keys(%{$changes{$item}}) > 0) {
373: $numchanged ++;
374: }
375: }
376: }
377: }
378: }
379: if ($context eq 'course') {
380: if ($numchanged) {
381: my $message = &Apache::courseprefs::store_changes($dom,$confname,$prefs_order,\@actions,
382: $prefs,$values,\%changes,$crstype);
383: $r->print(&Apache::loncommon::confirmwrapper($message));
384: } else {
385: if ($crstype eq 'Community') {
386: $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to community configuration.")));
387: } else {
388: $r->print(&Apache::loncommon::confirmwrapper(&mt("No changes made to course configuration.")));
389: }
390: }
391: if (keys(%disallowed) > 0) {
392: $r->print('<p>');
393: foreach my $item ('cloners','rolenames','feedback','discussion','localization') {
394: if (ref($disallowed{$item}) eq 'HASH') {
395: if (keys(%{$disallowed{$item}}) > 0) {
396: $r->print(&Apache::courseprefs::display_disallowed($item,$disallowed{$item},
397: $prefs,$crstype));
398: }
399: }
400: }
401: $r->print('</p>');
402: }
403: }
404: $r->print('<p>');
405: my $footer_text = 'Back to configuration display';
406: if ($context eq 'course') {
407: $footer_text = 'Back to display/edit settings';
408: }
409: &print_footer($r,$phase,'display',$footer_text,\@actions,$container,$parm_permission);
410: $r->print('</p>');
411: return \%lastact;
412: }
413:
414: sub display_settings {
415: my ($r,$dom,$phase,$context,$prefs_order,$prefs,$values,$confname,$jscript,
416: $allitems,$crstype,$container,$parm_permission) = @_;
417: my %brcrumtext = &get_crumb_text();
418: my @actions = &Apache::loncommon::get_env_multiple('form.actions');
419: &Apache::lonhtmlcommon::add_breadcrumb
420: ({href=>"javascript:changePage(document.$phase,'display')",
421: text=>"Display/Edit Settings"});
422: my $instcode;
423: if (ref($values) eq 'HASH') {
424: $instcode = $values->{'internal.coursecode'};
425: }
426: &print_header($r,$phase,$context,$jscript,$container,$instcode,$dom,$values);
427: my $divwidth = 900;
428: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH') && (ref($values) eq 'HASH')) {
429: if (@actions > 0) {
430: my $rowsum = 0;
431: my (%output,%rowtotal,@items,$got_check_uncheck);
432: foreach my $item (@{$prefs_order}) {
433: if (grep(/^\Q$item\E$/,@actions)) {
434: push(@items,$item);
435: if ($context eq 'domain') {
436: my $settings;
437: if (ref($values) eq 'HASH') {
438: $settings = $values->{$item};
439: }
440: if (($item eq 'usersessions') || ($item eq 'ssl')) {
441: unless ($got_check_uncheck) {
442: $r->print('<script type="text/javascript">'."\n".
443: '// <![CDATA['."\n".
444: &Apache::loncommon::check_uncheck_jscript()."\n".
445: '// ]]>'."\n".
446: '</script>'."\n");
447: $got_check_uncheck = 1;
448: }
449: } elsif ($item eq 'selfcreation') {
450: if (ref($values) eq 'HASH') {
451: $settings = $values->{'usercreation'};
452: }
453: } elsif ($item eq 'defaults') {
454: if (ref($values->{'inststatus'}) eq 'HASH') {
455: if (ref($values->{'defaults'}) eq 'HASH') {
456: $settings = {%{$values->{'inststatus'}},%{$values->{'defaults'}}};
457: } else {
458: $settings = $values->{'inststatus'};
459: }
460: } else {
461: my ($othertitle,$usertypes,$types) = &Apache::loncommon::sorted_inst_types($dom);
462: my $inststatus = {
463: inststatustypes => $usertypes,
464: inststatusorder => $types,
465: inststatusguest => [],
466: };
467: if (ref($values->{defaults}) eq 'HASH') {
468: $settings = {%{$inststatus},%{$values->{'defaults'}}};
469: } else {
470: $settings = $inststatus;
471: }
472: }
473: }
474: ($output{$item},$rowtotal{$item}) =
475: &Apache::domainprefs::print_config_box($r,$dom,$confname,
476: $phase,$item,$prefs->{$item},$settings);
477: } else {
478: ($output{$item},$rowtotal{$item}) =
479: &Apache::courseprefs::print_config_box($r,$dom,$phase,
480: $item,$prefs->{$item},$values,$allitems,$crstype,$parm_permission);
481: }
482: $rowsum += $rowtotal{$item};
483: }
484: }
485: $r->print('<div id="prefs" style="max-width:'.$divwidth.'px;margin: 10px auto 10px auto;">');
486: for (my $i=0; $i<@items; $i++) {
487: $r->print($output{$items[$i]});
488: }
489: $r->print('</div>');
490: $r->print(&print_footer($r,$phase,'process','Save Changes',\@actions,$container,$parm_permission));
491: } else {
492: $r->print('<input type="hidden" name="phase" value="" />'.
493: '<span class="LC_error">'.&mt('No settings chosen').
494: '</span>');
495: }
496: $r->print('</form>');
497: }
498: if ($container) {
499: &Apache::lonparmset::endSettingsScreen($r);
500: }
501: $r->print(&Apache::loncommon::end_page());
502: return;
503: }
504:
505: sub display_choices {
506: my ($r,$phase,$context,$prefs_order,$prefs,$container,$parm_permission) = @_;
507: if ($phase eq '') {
508: $phase = 'pickactions';
509: }
510: my %helphash;
511: &print_header($r,$phase,$context,undef,$container);
512: $r->print('<script type="text/javascript">'."\n".
513: '// <![CDATA['."\n".
514: &Apache::loncommon::check_uncheck_jscript()."\n".
515: '// ]]>'."\n".
516: '</script>'."\n");
517: my $heading = &mt('Settings to display/modify');
518: if (ref($parm_permission) eq 'HASH') {
519: unless ($parm_permission->{'process'}) {
520: $heading = &mt('Settings to display');
521: }
522: }
523: $r->print('<h3>'.$heading.'</h3>'.
524: '<div><input type="button" value="'.&mt('check all').'" '.
525: 'onclick="javascript:checkAll(document.pickactions.actions)"'.
526: ' />'.(' 'x2).
527: '<input type="button" value="'.&mt('uncheck all').'" '.
528: 'onclick="javascript:uncheckAll(document.pickactions.actions)" />'.
529: "\n".
530: '</div><div class="LC_left_float">');
531: my ($numitems,$maxincol,$firstthird,$secondthird,$seconddiv,$thirddiv,$count);
532: if (ref($prefs_order) eq 'ARRAY') {
533: $numitems = @{$prefs_order};
534: }
535: my $numcols = 3;
536: $maxincol = int($numitems/$numcols);
537: if ($numitems%$numcols) {
538: $maxincol ++;
539: }
540: $firstthird = $maxincol;
541: $secondthird = $firstthird + $maxincol;
542: $count = 0;
543: if ((ref($prefs_order) eq 'ARRAY') && (ref($prefs) eq 'HASH')) {
544: foreach my $item (@{$prefs_order}) {
545: $r->print('<h4>'.
546: &Apache::loncommon::help_open_topic($prefs->{$item}->{'help'}).
547: '<label><input type="checkbox" name="actions" value="'.$item.
548: '" /> '.&mt($prefs->{$item}->{'text'}).'</label></h4>');
549: $count ++;
550: if ((!$seconddiv) && ($count >= $firstthird)) {
551: $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
552: $seconddiv = 1;
553: }
554: if ((!$thirddiv) && ($count >= $secondthird)) {
555: $r->print('</div>'."\n".'<div class="LC_left_float">'."\n");
556: $thirddiv = 1;
557: }
558: }
559: $r->print('</div><br clear="all" />');
560: }
561: $r->print(&print_footer($r,$phase,'display','Display',undef,$container,$parm_permission));
562: $r->print('</form>');
563: if ($container) {
564: &Apache::lonparmset::endSettingsScreen($r);
565: }
566: $r->print(&Apache::loncommon::end_page());
567: return;
568: }
569:
570: sub color_pick_js {
571: my $pjump_def = &Apache::lonhtmlcommon::pjump_javascript_definition();
572: my $output = <<"ENDCOL";
573:
574: $pjump_def
575:
576: function psub() {
577: modalWindow.close();
578: if (document.parmform.pres_marker.value!='') {
579: if (document.parmform.pres_type.value!='') {
580: eval('document.display.'+
581: document.parmform.pres_marker.value+
582: '.value=document.parmform.pres_value.value;');
583: }
584: } else {
585: document.parmform.pres_value.value='';
586: document.parmform.pres_marker.value='';
587: }
588: }
589:
590: function get_id (span_id) {
591: if (document.getElementById) {
592: return document.getElementById(span_id);
593: }
594: if (document.all) {
595: return document.all[span_id];
596: }
597: return false;
598: }
599:
600: function colchg_span (span_id_str,new_color_item) {
601: var span_ref = get_id(span_id_str);
602: if (span_ref.style) { span_ref = span_ref.style; }
603: span_ref.background = new_color_item.value;
604: span_ref.backgroundColor = new_color_item.value;
605: span_ref.bgColor = new_color_item.value;
606: }
607:
608: ENDCOL
609: return $output;
610: }
611:
612: sub get_crumb_text {
613: my %brcrumbtext = (
614: domain => 'Domain Settings',
615: course => 'Display/Edit Settings',
616: );
617: return %brcrumbtext;
618: }
619:
620: 1;
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonconfigsettings.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface