Annotation of loncom/interface/loncommon.pm, revision 1.585
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.585 ! raeburn 4: # $Id: loncommon.pm,v 1.584 2007/09/11 23:36:46 albertel Exp $
1.10 albertel 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: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.139 matthew 64: use HTML::Entities;
1.334 albertel 65: use Apache::lonhtmlcommon();
66: use Apache::loncoursedata();
1.344 albertel 67: use Apache::lontexconvert();
1.444 albertel 68: use Apache::lonclonecourse();
1.479 albertel 69: use LONCAPA qw(:DEFAULT :match);
1.117 www 70:
1.517 raeburn 71: # ---------------------------------------------- Designs
72: use vars qw(%defaultdesign);
73:
1.22 www 74: my $readit;
75:
1.517 raeburn 76:
1.157 matthew 77: ##
78: ## Global Variables
79: ##
1.46 matthew 80:
1.20 www 81: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 82: my %language;
1.124 www 83: my %supported_language;
1.12 harris41 84: my %cprtag;
1.192 taceyjo1 85: my %scprtag;
1.351 www 86: my %fe; my %fd; my %fm;
1.41 ng 87: my %category_extensions;
1.12 harris41 88:
1.46 matthew 89: # ---------------------------------------------- Thesaurus variables
1.144 matthew 90: #
91: # %Keywords:
92: # A hash used by &keyword to determine if a word is considered a keyword.
93: # $thesaurus_db_file
94: # Scalar containing the full path to the thesaurus database.
1.46 matthew 95:
96: my %Keywords;
97: my $thesaurus_db_file;
98:
1.144 matthew 99: #
100: # Initialize values from language.tab, copyright.tab, filetypes.tab,
101: # thesaurus.tab, and filecategories.tab.
102: #
1.18 www 103: BEGIN {
1.46 matthew 104: # Variable initialization
105: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
106: #
1.22 www 107: unless ($readit) {
1.12 harris41 108: # ------------------------------------------------------------------- languages
109: {
1.158 raeburn 110: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
111: '/language.tab';
112: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 113: while (my $line = <$fh>) {
114: next if ($line=~/^\#/);
115: chomp($line);
116: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 117: $language{$key}=$val.' - '.$enc;
118: if ($sup) {
119: $supported_language{$key}=$sup;
120: }
121: }
122: close($fh);
123: }
1.12 harris41 124: }
125: # ------------------------------------------------------------------ copyrights
126: {
1.158 raeburn 127: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
128: '/copyright.tab';
129: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 130: while (my $line = <$fh>) {
131: next if ($line=~/^\#/);
132: chomp($line);
133: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 134: $cprtag{$key}=$val;
135: }
136: close($fh);
137: }
1.12 harris41 138: }
1.351 www 139: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 140: {
141: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
142: '/source_copyright.tab';
143: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 144: while (my $line = <$fh>) {
145: next if ($line =~ /^\#/);
146: chomp($line);
147: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 148: $scprtag{$key}=$val;
149: }
150: close($fh);
151: }
152: }
1.63 www 153:
1.517 raeburn 154: # -------------------------------------------------------------- default domain designs
1.63 www 155: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 156: my $designfile = $designdir.'/default.tab';
157: if ( open (my $fh,"<$designfile") ) {
158: while (my $line = <$fh>) {
159: next if ($line =~ /^\#/);
160: chomp($line);
161: my ($key,$val)=(split(/\=/,$line));
162: if ($val) { $defaultdesign{$key}=$val; }
163: }
164: close($fh);
1.63 www 165: }
166:
1.15 harris41 167: # ------------------------------------------------------------- file categories
168: {
1.158 raeburn 169: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
170: '/filecategories.tab';
171: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 172: while (my $line = <$fh>) {
173: next if ($line =~ /^\#/);
174: chomp($line);
175: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 176: push @{$category_extensions{lc($category)}},$extension;
177: }
178: close($fh);
179: }
180:
1.15 harris41 181: }
1.12 harris41 182: # ------------------------------------------------------------------ file types
183: {
1.158 raeburn 184: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
185: '/filetypes.tab';
186: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 187: while (my $line = <$fh>) {
188: next if ($line =~ /^\#/);
189: chomp($line);
190: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 191: if ($descr ne '') {
192: $fe{$ending}=lc($emb);
193: $fd{$ending}=$descr;
1.351 www 194: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 195: }
196: }
197: close($fh);
198: }
1.12 harris41 199: }
1.22 www 200: &Apache::lonnet::logthis(
1.46 matthew 201: "<font color=yellow>INFO: Read file types</font>");
1.22 www 202: $readit=1;
1.46 matthew 203: } # end of unless($readit)
1.32 matthew 204:
205: }
1.112 bowersj2 206:
1.42 matthew 207: ###############################################################
208: ## HTML and Javascript Helper Functions ##
209: ###############################################################
210:
211: =pod
212:
1.112 bowersj2 213: =head1 HTML and Javascript Functions
1.42 matthew 214:
1.112 bowersj2 215: =over 4
216:
217: =item * browser_and_searcher_javascript ()
218:
219: X<browsing, javascript>X<searching, javascript>Returns a string
220: containing javascript with two functions, C<openbrowser> and
221: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
222: tags.
1.42 matthew 223:
1.112 bowersj2 224: =item * openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 225:
226: inputs: formname, elementname, only, omit
227:
228: formname and elementname indicate the name of the html form and name of
229: the element that the results of the browsing selection are to be placed in.
230:
231: Specifying 'only' will restrict the browser to displaying only files
1.185 www 232: with the given extension. Can be a comma separated list.
1.42 matthew 233:
234: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 235: with the given extension. Can be a comma separated list.
1.42 matthew 236:
1.112 bowersj2 237: =item * opensearcher(formname, elementname) [javascript]
1.42 matthew 238:
239: Inputs: formname, elementname
240:
241: formname and elementname specify the name of the html form and the name
242: of the element the selection from the search results will be placed in.
1.542 raeburn 243:
1.42 matthew 244: =cut
245:
246: sub browser_and_searcher_javascript {
1.199 albertel 247: my ($mode)=@_;
248: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 249: my $resurl=&escape_single(&lastresurl());
1.42 matthew 250: return <<END;
1.219 albertel 251: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 252: var editbrowser = null;
1.135 albertel 253: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 254: var url = '$resurl/?';
1.42 matthew 255: if (editbrowser == null) {
256: url += 'launch=1&';
257: }
258: url += 'catalogmode=interactive&';
1.199 albertel 259: url += 'mode=$mode&';
1.42 matthew 260: url += 'form=' + formname + '&';
261: if (only != null) {
262: url += 'only=' + only + '&';
1.217 albertel 263: } else {
264: url += 'only=&';
265: }
1.42 matthew 266: if (omit != null) {
267: url += 'omit=' + omit + '&';
1.217 albertel 268: } else {
269: url += 'omit=&';
270: }
1.135 albertel 271: if (titleelement != null) {
272: url += 'titleelement=' + titleelement + '&';
1.217 albertel 273: } else {
274: url += 'titleelement=&';
275: }
1.42 matthew 276: url += 'element=' + elementname + '';
277: var title = 'Browser';
1.435 albertel 278: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 279: options += ',width=700,height=600';
280: editbrowser = open(url,title,options,'1');
281: editbrowser.focus();
282: }
283: var editsearcher;
1.135 albertel 284: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 285: var url = '/adm/searchcat?';
286: if (editsearcher == null) {
287: url += 'launch=1&';
288: }
289: url += 'catalogmode=interactive&';
1.199 albertel 290: url += 'mode=$mode&';
1.42 matthew 291: url += 'form=' + formname + '&';
1.135 albertel 292: if (titleelement != null) {
293: url += 'titleelement=' + titleelement + '&';
1.217 albertel 294: } else {
295: url += 'titleelement=&';
296: }
1.42 matthew 297: url += 'element=' + elementname + '';
298: var title = 'Search';
1.435 albertel 299: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 300: options += ',width=700,height=600';
301: editsearcher = open(url,title,options,'1');
302: editsearcher.focus();
303: }
1.219 albertel 304: // END LON-CAPA Internal -->
1.42 matthew 305: END
1.170 www 306: }
307:
308: sub lastresurl {
1.258 albertel 309: if ($env{'environment.lastresurl'}) {
310: return $env{'environment.lastresurl'}
1.170 www 311: } else {
312: return '/res';
313: }
314: }
315:
316: sub storeresurl {
317: my $resurl=&Apache::lonnet::clutter(shift);
318: unless ($resurl=~/^\/res/) { return 0; }
319: $resurl=~s/\/$//;
320: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
321: &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
322: return 1;
1.42 matthew 323: }
324:
1.74 www 325: sub studentbrowser_javascript {
1.111 www 326: unless (
1.258 albertel 327: (($env{'request.course.id'}) &&
1.302 albertel 328: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
329: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
330: '/'.$env{'request.course.sec'})
331: ))
1.258 albertel 332: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 333: ) { return ''; }
1.74 www 334: return (<<'ENDSTDBRW');
335: <script type="text/javascript" language="Javascript" >
336: var stdeditbrowser;
1.558 albertel 337: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 338: var url = '/adm/pickstudent?';
339: var filter;
1.558 albertel 340: if (!ignorefilter) {
341: eval('filter=document.'+formname+'.'+uname+'.value;');
342: }
1.74 www 343: if (filter != null) {
344: if (filter != '') {
345: url += 'filter='+filter+'&';
346: }
347: }
348: url += 'form=' + formname + '&unameelement='+uname+
349: '&udomelement='+udom;
1.111 www 350: if (roleflag) { url+="&roles=1"; }
1.102 www 351: var title = 'Student_Browser';
1.74 www 352: var options = 'scrollbars=1,resizable=1,menubar=0';
353: options += ',width=700,height=600';
354: stdeditbrowser = open(url,title,options,'1');
355: stdeditbrowser.focus();
356: }
357: </script>
358: ENDSTDBRW
359: }
1.42 matthew 360:
1.74 www 361: sub selectstudent_link {
1.111 www 362: my ($form,$unameele,$udomele)=@_;
1.258 albertel 363: if ($env{'request.course.id'}) {
1.302 albertel 364: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
365: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
366: '/'.$env{'request.course.sec'})) {
1.111 www 367: return '';
368: }
369: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.558 albertel 370: '","'.$udomele.'","","1");'."'>".&mt('Select User')."</a>";
1.74 www 371: }
1.258 albertel 372: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 373: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 374: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 375: }
376: return '';
1.91 www 377: }
378:
379: sub coursebrowser_javascript {
1.468 raeburn 380: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 381: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 382: my $output = '
1.538 albertel 383: <script type="text/javascript">
1.468 raeburn 384: var stdeditbrowser;'."\n";
385: $output .= <<"ENDSTDBRW";
1.377 raeburn 386: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 387: var url = '/adm/pickcourse?';
1.468 raeburn 388: var domainfilter = '';
389: var formid = getFormIdByName(formname);
390: if (formid > -1) {
391: var domid = getIndexByName(formid,udom);
392: if (domid > -1) {
393: if (document.forms[formid].elements[domid].type == 'select-one') {
394: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
395: }
396: if (document.forms[formid].elements[domid].type == 'hidden') {
397: domainfilter=document.forms[formid].elements[domid].value;
398: }
399: }
1.91 www 400: }
1.128 albertel 401: if (domainfilter != null) {
402: if (domainfilter != '') {
403: url += 'domainfilter='+domainfilter+'&';
404: }
405: }
1.91 www 406: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 407: '&cdomelement='+udom+
408: '&cnameelement='+desc;
1.468 raeburn 409: if (extra_element !=null && extra_element != '') {
410: if (formname == 'rolechoice') {
411: url += '&roleelement='+extra_element;
412: if (domainfilter == null || domainfilter == '') {
413: url += '&domainfilter='+extra_element;
414: }
1.234 raeburn 415: }
1.468 raeburn 416: else {
417: if (formname == 'portform') {
418: url += '&setroles='+extra_element;
419: }
420: }
1.230 raeburn 421: }
1.293 raeburn 422: if (multflag !=null && multflag != '') {
423: url += '&multiple='+multflag;
424: }
1.377 raeburn 425: if (crstype == 'Course/Group') {
426: if (formname == 'cu') {
427: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
428: if (crstype == "") {
429: alert("$crs_or_grp_alert");
430: return;
431: }
432: }
433: }
434: if (crstype !=null && crstype != '') {
435: url += '&type='+crstype;
436: }
1.102 www 437: var title = 'Course_Browser';
1.91 www 438: var options = 'scrollbars=1,resizable=1,menubar=0';
439: options += ',width=700,height=600';
440: stdeditbrowser = open(url,title,options,'1');
441: stdeditbrowser.focus();
442: }
1.468 raeburn 443:
444: function getFormIdByName(formname) {
445: for (var i=0;i<document.forms.length;i++) {
446: if (document.forms[i].name == formname) {
447: return i;
448: }
449: }
450: return -1;
451: }
452:
453: function getIndexByName(formid,item) {
454: for (var i=0;i<document.forms[formid].elements.length;i++) {
455: if (document.forms[formid].elements[i].name == item) {
456: return i;
457: }
458: }
459: return -1;
460: }
1.91 www 461: ENDSTDBRW
1.468 raeburn 462: if ($sec_element ne '') {
463: $output .= &setsec_javascript($sec_element,$formname);
464: }
465: $output .= '
466: </script>';
467: return $output;
468: }
469:
470: sub setsec_javascript {
471: my ($sec_element,$formname) = @_;
472: my $setsections = qq|
473: function setSect(sectionlist) {
474: var sectionsArray = sectionlist.split(",");
475: var numSections = sectionsArray.length;
476: document.$formname.$sec_element.length = 0;
477: if (numSections == 0) {
478: document.$formname.$sec_element.multiple=false;
479: document.$formname.$sec_element.size=1;
480: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
481: } else {
482: if (numSections == 1) {
483: document.$formname.$sec_element.multiple=false;
484: document.$formname.$sec_element.size=1;
485: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
486: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
487: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
488: } else {
489: for (var i=0; i<numSections; i++) {
490: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
491: }
492: document.$formname.$sec_element.multiple=true
493: if (numSections < 3) {
494: document.$formname.$sec_element.size=numSections;
495: } else {
496: document.$formname.$sec_element.size=3;
497: }
498: document.$formname.$sec_element.options[0].selected = false
499: }
500: }
1.91 www 501: }
1.468 raeburn 502: |;
503: return $setsections;
504: }
505:
1.91 www 506:
507: sub selectcourse_link {
1.377 raeburn 508: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 509: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
510: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 511: }
1.42 matthew 512:
1.273 raeburn 513: sub check_uncheck_jscript {
514: my $jscript = <<"ENDSCRT";
515: function checkAll(field) {
516: if (field.length > 0) {
517: for (i = 0; i < field.length; i++) {
518: field[i].checked = true ;
519: }
520: } else {
521: field.checked = true
522: }
523: }
524:
525: function uncheckAll(field) {
526: if (field.length > 0) {
527: for (i = 0; i < field.length; i++) {
528: field[i].checked = false ;
1.543 albertel 529: }
530: } else {
1.273 raeburn 531: field.checked = false ;
532: }
533: }
534: ENDSCRT
535: return $jscript;
536: }
537:
538:
1.42 matthew 539: =pod
1.36 matthew 540:
1.112 bowersj2 541: =item * linked_select_forms(...)
1.36 matthew 542:
543: linked_select_forms returns a string containing a <script></script> block
544: and html for two <select> menus. The select menus will be linked in that
545: changing the value of the first menu will result in new values being placed
546: in the second menu. The values in the select menu will appear in alphabetical
547: order.
548:
549: linked_select_forms takes the following ordered inputs:
550:
551: =over 4
552:
1.112 bowersj2 553: =item * $formname, the name of the <form> tag
1.36 matthew 554:
1.112 bowersj2 555: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 556:
1.112 bowersj2 557: =item * $firstdefault, the default value for the first menu
1.36 matthew 558:
1.112 bowersj2 559: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 560:
1.112 bowersj2 561: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 562:
1.112 bowersj2 563: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 564:
1.41 ng 565: =back
566:
1.36 matthew 567: Below is an example of such a hash. Only the 'text', 'default', and
568: 'select2' keys must appear as stated. keys(%menu) are the possible
569: values for the first select menu. The text that coincides with the
1.41 ng 570: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 571: and text for the second menu are given in the hash pointed to by
572: $menu{$choice1}->{'select2'}.
573:
1.112 bowersj2 574: my %menu = ( A1 => { text =>"Choice A1" ,
575: default => "B3",
576: select2 => {
577: B1 => "Choice B1",
578: B2 => "Choice B2",
579: B3 => "Choice B3",
580: B4 => "Choice B4"
581: }
582: },
583: A2 => { text =>"Choice A2" ,
584: default => "C2",
585: select2 => {
586: C1 => "Choice C1",
587: C2 => "Choice C2",
588: C3 => "Choice C3"
589: }
590: },
591: A3 => { text =>"Choice A3" ,
592: default => "D6",
593: select2 => {
594: D1 => "Choice D1",
595: D2 => "Choice D2",
596: D3 => "Choice D3",
597: D4 => "Choice D4",
598: D5 => "Choice D5",
599: D6 => "Choice D6",
600: D7 => "Choice D7"
601: }
602: }
603: );
1.36 matthew 604:
605: =cut
606:
607: sub linked_select_forms {
608: my ($formname,
609: $middletext,
610: $firstdefault,
611: $firstselectname,
612: $secondselectname,
613: $hashref
614: ) = @_;
615: my $second = "document.$formname.$secondselectname";
616: my $first = "document.$formname.$firstselectname";
617: # output the javascript to do the changing
618: my $result = '';
1.219 albertel 619: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 620: $result.="var select2data = new Object();\n";
621: $" = '","';
622: my $debug = '';
623: foreach my $s1 (sort(keys(%$hashref))) {
624: $result.="select2data.d_$s1 = new Object();\n";
625: $result.="select2data.d_$s1.def = new String('".
626: $hashref->{$s1}->{'default'}."');\n";
627: $result.="select2data.d_$s1.values = new Array(";
628: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
629: $result.="\"@s2values\");\n";
630: $result.="select2data.d_$s1.texts = new Array(";
631: my @s2texts;
632: foreach my $value (@s2values) {
633: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
634: }
635: $result.="\"@s2texts\");\n";
636: }
637: $"=' ';
638: $result.= <<"END";
639:
640: function select1_changed() {
641: // Determine new choice
642: var newvalue = "d_" + $first.value;
643: // update select2
644: var values = select2data[newvalue].values;
645: var texts = select2data[newvalue].texts;
646: var select2def = select2data[newvalue].def;
647: var i;
648: // out with the old
649: for (i = 0; i < $second.options.length; i++) {
650: $second.options[i] = null;
651: }
652: // in with the nuclear
653: for (i=0;i<values.length; i++) {
654: $second.options[i] = new Option(values[i]);
1.143 matthew 655: $second.options[i].value = values[i];
1.36 matthew 656: $second.options[i].text = texts[i];
657: if (values[i] == select2def) {
658: $second.options[i].selected = true;
659: }
660: }
661: }
662: </script>
663: END
664: # output the initial values for the selection lists
665: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
666: foreach my $value (sort(keys(%$hashref))) {
667: $result.=" <option value=\"$value\" ";
1.253 albertel 668: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 669: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 670: }
671: $result .= "</select>\n";
672: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
673: $result .= $middletext;
674: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
675: my $seconddefault = $hashref->{$firstdefault}->{'default'};
676: foreach my $value (sort(keys(%select2))) {
677: $result.=" <option value=\"$value\" ";
1.253 albertel 678: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 679: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 680: }
681: $result .= "</select>\n";
682: # return $debug;
683: return $result;
684: } # end of sub linked_select_forms {
685:
1.45 matthew 686: =pod
1.44 bowersj2 687:
1.112 bowersj2 688: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44 bowersj2 689:
1.112 bowersj2 690: Returns a string corresponding to an HTML link to the given help
691: $topic, where $topic corresponds to the name of a .tex file in
692: /home/httpd/html/adm/help/tex, with underscores replaced by
693: spaces.
694:
695: $text will optionally be linked to the same topic, allowing you to
696: link text in addition to the graphic. If you do not want to link
697: text, but wish to specify one of the later parameters, pass an
698: empty string.
699:
700: $stayOnPage is a value that will be interpreted as a boolean. If true,
701: the link will not open a new window. If false, the link will open
702: a new window using Javascript. (Default is false.)
703:
704: $width and $height are optional numerical parameters that will
705: override the width and height of the popped up window, which may
706: be useful for certain help topics with big pictures included.
1.44 bowersj2 707:
708: =cut
709:
710: sub help_open_topic {
1.48 bowersj2 711: my ($topic, $text, $stayOnPage, $width, $height) = @_;
712: $text = "" if (not defined $text);
1.44 bowersj2 713: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 714: if ($env{'browser.interface'} eq 'textual') {
1.79 www 715: $stayOnPage=1;
716: }
1.44 bowersj2 717: $width = 350 if (not defined $width);
718: $height = 400 if (not defined $height);
719: my $filename = $topic;
720: $filename =~ s/ /_/g;
721:
1.48 bowersj2 722: my $template = "";
723: my $link;
1.572 banghart 724:
1.159 www 725: $topic=~s/\W/\_/g;
1.44 bowersj2 726:
1.572 banghart 727: if (!$stayOnPage) {
1.72 bowersj2 728: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 729: } else {
1.48 bowersj2 730: $link = "/adm/help/${filename}.hlp";
731: }
732:
733: # Add the text
1.572 banghart 734: if ($text ne "") {
1.77 www 735: $template .=
1.572 banghart 736: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
737: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 738: }
739:
740: # Add the graphic
1.179 matthew 741: my $title = &mt('Online Help');
1.215 albertel 742: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48 bowersj2 743: $template .= <<"ENDTEMPLATE";
1.436 albertel 744: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 745: ENDTEMPLATE
1.78 www 746: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 747: return $template;
748:
1.106 bowersj2 749: }
750:
751: # This is a quicky function for Latex cheatsheet editing, since it
752: # appears in at least four places
753: sub helpLatexCheatsheet {
754: my $other = shift;
755: my $addOther = '';
756: if ($other) {
757: $addOther = Apache::loncommon::help_open_topic($other, shift,
758: undef, undef, 600) .
759: '</td><td>';
760: }
761: return '<table><tr><td>'.
762: $addOther .
763: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
764: undef,undef,600)
765: .'</td><td>'.
766: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
767: undef,undef,600)
768: .'</td></tr></table>';
1.172 www 769: }
770:
1.430 albertel 771: sub general_help {
772: my $helptopic='Student_Intro';
773: if ($env{'request.role'}=~/^(ca|au)/) {
774: $helptopic='Authoring_Intro';
775: } elsif ($env{'request.role'}=~/^cc/) {
776: $helptopic='Course_Coordination_Intro';
777: }
778: return $helptopic;
779: }
780:
781: sub update_help_link {
782: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
783: my $origurl = $ENV{'REQUEST_URI'};
784: $origurl=~s|^/~|/priv/|;
785: my $timestamp = time;
786: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
787: $$datum = &escape($$datum);
788: }
789:
790: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
791: my $output .= <<"ENDOUTPUT";
792: <script type="text/javascript">
793: banner_link = '$banner_link';
794: </script>
795: ENDOUTPUT
796: return $output;
797: }
798:
799: # now just updates the help link and generates a blue icon
1.193 raeburn 800: sub help_open_menu {
1.430 albertel 801: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 802: = @_;
1.430 albertel 803: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 804: # only use pop-up help (stayOnPage == 0)
1.552 banghart 805: # if environment.remote is on (using remote control UI)
1.572 banghart 806: if ($env{'browser.interface'} eq 'textual' ||
807: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 808: $stayOnPage=1;
1.430 albertel 809: }
810: my $output;
811: if ($component_help) {
812: if (!$text) {
813: $output=&help_open_topic($component_help,undef,$stayOnPage,
814: $width,$height);
815: } else {
816: my $help_text;
817: $help_text=&unescape($topic);
818: $output='<table><tr><td>'.
819: &help_open_topic($component_help,$help_text,$stayOnPage,
820: $width,$height).'</td></tr></table>';
821: }
822: }
823: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
824: return $output.$banner_link;
825: }
826:
827: sub top_nav_help {
828: my ($text) = @_;
1.436 albertel 829: $text = &mt($text);
1.572 banghart 830: my $stay_on_page =
1.436 albertel 831: ($env{'browser.interface'} eq 'textual' ||
832: $env{'environment.remote'} eq 'off' );
1.572 banghart 833: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 834: : "javascript:helpMenu('open')";
1.572 banghart 835: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 836:
1.201 raeburn 837: my $title = &mt('Get help');
1.436 albertel 838:
839: return <<"END";
840: $banner_link
841: <a href="$link" title="$title">$text</a>
842: END
843: }
844:
845: sub help_menu_js {
846: my ($text) = @_;
847:
848: my $stayOnPage =
849: ($env{'browser.interface'} eq 'textual' ||
850: $env{'environment.remote'} eq 'off' );
851:
852: my $width = 620;
853: my $height = 600;
1.430 albertel 854: my $helptopic=&general_help();
855: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 856: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 857: my $start_page =
858: &Apache::loncommon::start_page('Help Menu', undef,
859: {'frameset' => 1,
860: 'js_ready' => 1,
861: 'add_entries' => {
862: 'border' => '0',
1.579 raeburn 863: 'rows' => "110,*",},});
1.331 albertel 864: my $end_page =
865: &Apache::loncommon::end_page({'frameset' => 1,
866: 'js_ready' => 1,});
867:
1.436 albertel 868: my $template .= <<"ENDTEMPLATE";
869: <script type="text/javascript">
1.253 albertel 870: // <!-- BEGIN LON-CAPA Internal
871: // <![CDATA[
1.430 albertel 872: var banner_link = '';
1.243 raeburn 873: function helpMenu(target) {
874: var caller = this;
875: if (target == 'open') {
876: var newWindow = null;
877: try {
1.262 albertel 878: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 879: }
880: catch(error) {
881: writeHelp(caller);
882: return;
883: }
884: if (newWindow) {
885: caller = newWindow;
886: }
1.193 raeburn 887: }
1.243 raeburn 888: writeHelp(caller);
889: return;
890: }
891: function writeHelp(caller) {
1.430 albertel 892: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 893: caller.document.close()
894: caller.focus()
1.193 raeburn 895: }
1.253 albertel 896: // ]]>
1.219 albertel 897: // END LON-CAPA Internal -->
1.436 albertel 898: </script>
1.193 raeburn 899: ENDTEMPLATE
900: return $template;
901: }
902:
1.172 www 903: sub help_open_bug {
904: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 905: unless ($env{'user.adv'}) { return ''; }
1.172 www 906: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
907: $text = "" if (not defined $text);
908: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 909: if ($env{'browser.interface'} eq 'textual' ||
910: $env{'environment.remote'} eq 'off' ) {
1.172 www 911: $stayOnPage=1;
912: }
1.184 albertel 913: $width = 600 if (not defined $width);
914: $height = 600 if (not defined $height);
1.172 www 915:
916: $topic=~s/\W+/\+/g;
917: my $link='';
918: my $template='';
1.379 albertel 919: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
920: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 921: if (!$stayOnPage)
922: {
923: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
924: }
925: else
926: {
927: $link = $url;
928: }
929: # Add the text
930: if ($text ne "")
931: {
932: $template .=
933: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 934: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 935: }
936:
937: # Add the graphic
1.179 matthew 938: my $title = &mt('Report a Bug');
1.215 albertel 939: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 940: $template .= <<"ENDTEMPLATE";
1.436 albertel 941: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 942: ENDTEMPLATE
943: if ($text ne '') { $template.='</td></tr></table>' };
944: return $template;
945:
946: }
947:
948: sub help_open_faq {
949: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 950: unless ($env{'user.adv'}) { return ''; }
1.172 www 951: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
952: $text = "" if (not defined $text);
953: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 954: if ($env{'browser.interface'} eq 'textual' ||
955: $env{'environment.remote'} eq 'off' ) {
1.172 www 956: $stayOnPage=1;
957: }
958: $width = 350 if (not defined $width);
959: $height = 400 if (not defined $height);
960:
961: $topic=~s/\W+/\+/g;
962: my $link='';
963: my $template='';
964: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
965: if (!$stayOnPage)
966: {
967: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
968: }
969: else
970: {
971: $link = $url;
972: }
973:
974: # Add the text
975: if ($text ne "")
976: {
977: $template .=
1.173 www 978: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 979: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 980: }
981:
982: # Add the graphic
1.179 matthew 983: my $title = &mt('View the FAQ');
1.215 albertel 984: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 985: $template .= <<"ENDTEMPLATE";
1.436 albertel 986: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 987: ENDTEMPLATE
988: if ($text ne '') { $template.='</td></tr></table>' };
989: return $template;
990:
1.44 bowersj2 991: }
1.37 matthew 992:
1.180 matthew 993: ###############################################################
994: ###############################################################
995:
1.45 matthew 996: =pod
997:
1.256 matthew 998: =item * change_content_javascript():
999:
1000: This and the next function allow you to create small sections of an
1001: otherwise static HTML page that you can update on the fly with
1002: Javascript, even in Netscape 4.
1003:
1004: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1005: must be written to the HTML page once. It will prove the Javascript
1006: function "change(name, content)". Calling the change function with the
1007: name of the section
1008: you want to update, matching the name passed to C<changable_area>, and
1009: the new content you want to put in there, will put the content into
1010: that area.
1011:
1012: B<Note>: Netscape 4 only reserves enough space for the changable area
1013: to contain room for the original contents. You need to "make space"
1014: for whatever changes you wish to make, and be B<sure> to check your
1015: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1016: it's adequate for updating a one-line status display, but little more.
1017: This script will set the space to 100% width, so you only need to
1018: worry about height in Netscape 4.
1019:
1020: Modern browsers are much less limiting, and if you can commit to the
1021: user not using Netscape 4, this feature may be used freely with
1022: pretty much any HTML.
1023:
1024: =cut
1025:
1026: sub change_content_javascript {
1027: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1028: if ($env{'browser.type'} eq 'netscape' &&
1029: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1030: return (<<NETSCAPE4);
1031: function change(name, content) {
1032: doc = document.layers[name+"___escape"].layers[0].document;
1033: doc.open();
1034: doc.write(content);
1035: doc.close();
1036: }
1037: NETSCAPE4
1038: } else {
1039: # Otherwise, we need to use semi-standards-compliant code
1040: # (technically, "innerHTML" isn't standard but the equivalent
1041: # is really scary, and every useful browser supports it
1042: return (<<DOMBASED);
1043: function change(name, content) {
1044: element = document.getElementById(name);
1045: element.innerHTML = content;
1046: }
1047: DOMBASED
1048: }
1049: }
1050:
1051: =pod
1052:
1053: =item * changable_area($name, $origContent):
1054:
1055: This provides a "changable area" that can be modified on the fly via
1056: the Javascript code provided in C<change_content_javascript>. $name is
1057: the name you will use to reference the area later; do not repeat the
1058: same name on a given HTML page more then once. $origContent is what
1059: the area will originally contain, which can be left blank.
1060:
1061: =cut
1062:
1063: sub changable_area {
1064: my ($name, $origContent) = @_;
1065:
1.258 albertel 1066: if ($env{'browser.type'} eq 'netscape' &&
1067: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1068: # If this is netscape 4, we need to use the Layer tag
1069: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1070: } else {
1071: return "<span id='$name'>$origContent</span>";
1072: }
1073: }
1074:
1075: =pod
1076:
1.565 albertel 1077: =item * resize_textarea_js
1078:
1079: emits the needed javascript to resize a textarea to be as big as possible
1080:
1081: creates a function resize_textrea that takes two IDs first should be
1082: the id of the element to resize, second should be the id of a div that
1083: surrounds everything that comes after the textarea, this routine needs
1084: to be attached to the <body> for the onload and onresize events.
1085:
1086:
1087: =cut
1088:
1089: sub resize_textarea_js {
1090: return <<"RESIZE";
1091: <script type="text/javascript">
1092: var Geometry = {};
1093: function init_geometry() {
1094: if (Geometry.init) { return };
1095: Geometry.init=1;
1096: if (window.innerHeight) {
1097: Geometry.getViewportHeight = function() { return window.innerHeight; };
1098: }
1099: else if (document.documentElement && document.documentElement.clientHeight) {
1100: Geometry.getViewportHeight =
1101: function() { return document.documentElement.clientHeight; };
1102: }
1103: else if (document.body.clientHeight) {
1104: Geometry.getViewportHeight =
1105: function() { return document.body.clientHeight; };
1106: }
1107: }
1108:
1109: function resize_textarea(textarea_id,bottom_id) {
1110: init_geometry();
1111: var textarea = document.getElementById(textarea_id);
1112: //alert(textarea);
1113:
1114: var textarea_top = textarea.offsetTop;
1115: var textarea_height = textarea.offsetHeight;
1116: var bottom = document.getElementById(bottom_id);
1117: var bottom_top = bottom.offsetTop;
1118: var bottom_height = bottom.offsetHeight;
1119: var window_height = Geometry.getViewportHeight();
1120: var fudge = 23;
1121: var new_height = window_height-fudge-textarea_top-bottom_height;
1122: if (new_height < 300) {
1123: new_height = 300;
1124: }
1125: textarea.style.height=new_height+'px';
1126: }
1127: </script>
1128: RESIZE
1129:
1130: }
1131:
1132: =pod
1133:
1.256 matthew 1134: =back
1.542 raeburn 1135:
1.256 matthew 1136: =head1 Excel and CSV file utility routines
1137:
1138: =over 4
1139:
1140: =cut
1141:
1142: ###############################################################
1143: ###############################################################
1144:
1145: =pod
1146:
1.112 bowersj2 1147: =item * csv_translate($text)
1.37 matthew 1148:
1.185 www 1149: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1150: format.
1151:
1152: =cut
1153:
1.180 matthew 1154: ###############################################################
1155: ###############################################################
1.37 matthew 1156: sub csv_translate {
1157: my $text = shift;
1158: $text =~ s/\"/\"\"/g;
1.209 albertel 1159: $text =~ s/\n/ /g;
1.37 matthew 1160: return $text;
1161: }
1.180 matthew 1162:
1163: ###############################################################
1164: ###############################################################
1165:
1166: =pod
1167:
1168: =item * define_excel_formats
1169:
1170: Define some commonly used Excel cell formats.
1171:
1172: Currently supported formats:
1173:
1174: =over 4
1175:
1176: =item header
1177:
1178: =item bold
1179:
1180: =item h1
1181:
1182: =item h2
1183:
1184: =item h3
1185:
1.256 matthew 1186: =item h4
1187:
1188: =item i
1189:
1.180 matthew 1190: =item date
1191:
1192: =back
1193:
1194: Inputs: $workbook
1195:
1196: Returns: $format, a hash reference.
1197:
1198: =cut
1199:
1200: ###############################################################
1201: ###############################################################
1202: sub define_excel_formats {
1203: my ($workbook) = @_;
1204: my $format;
1205: $format->{'header'} = $workbook->add_format(bold => 1,
1206: bottom => 1,
1207: align => 'center');
1208: $format->{'bold'} = $workbook->add_format(bold=>1);
1209: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1210: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1211: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1212: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1213: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1214: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1215: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1216: return $format;
1217: }
1218:
1219: ###############################################################
1220: ###############################################################
1.113 bowersj2 1221:
1222: =pod
1223:
1.256 matthew 1224: =item * create_workbook
1.255 matthew 1225:
1226: Create an Excel worksheet. If it fails, output message on the
1227: request object and return undefs.
1228:
1229: Inputs: Apache request object
1230:
1231: Returns (undef) on failure,
1232: Excel worksheet object, scalar with filename, and formats
1233: from &Apache::loncommon::define_excel_formats on success
1234:
1235: =cut
1236:
1237: ###############################################################
1238: ###############################################################
1239: sub create_workbook {
1240: my ($r) = @_;
1241: #
1242: # Create the excel spreadsheet
1243: my $filename = '/prtspool/'.
1.258 albertel 1244: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1245: time.'_'.rand(1000000000).'.xls';
1246: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1247: if (! defined($workbook)) {
1248: $r->log_error("Error creating excel spreadsheet $filename: $!");
1249: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1250: "This error has been logged. ".
1251: "Please alert your LON-CAPA administrator").
1252: '</p>');
1253: return (undef);
1254: }
1255: #
1256: $workbook->set_tempdir('/home/httpd/perl/tmp');
1257: #
1258: my $format = &Apache::loncommon::define_excel_formats($workbook);
1259: return ($workbook,$filename,$format);
1260: }
1261:
1262: ###############################################################
1263: ###############################################################
1264:
1265: =pod
1266:
1.256 matthew 1267: =item * create_text_file
1.113 bowersj2 1268:
1.542 raeburn 1269: Create a file to write to and eventually make available to the user.
1.256 matthew 1270: If file creation fails, outputs an error message on the request object and
1271: return undefs.
1.113 bowersj2 1272:
1.256 matthew 1273: Inputs: Apache request object, and file suffix
1.113 bowersj2 1274:
1.256 matthew 1275: Returns (undef) on failure,
1276: Filehandle and filename on success.
1.113 bowersj2 1277:
1278: =cut
1279:
1.256 matthew 1280: ###############################################################
1281: ###############################################################
1282: sub create_text_file {
1283: my ($r,$suffix) = @_;
1284: if (! defined($suffix)) { $suffix = 'txt'; };
1285: my $fh;
1286: my $filename = '/prtspool/'.
1.258 albertel 1287: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1288: time.'_'.rand(1000000000).'.'.$suffix;
1289: $fh = Apache::File->new('>/home/httpd'.$filename);
1290: if (! defined($fh)) {
1291: $r->log_error("Couldn't open $filename for output $!");
1292: $r->print("Problems occured in creating the output file. ".
1293: "This error has been logged. ".
1294: "Please alert your LON-CAPA administrator.");
1.113 bowersj2 1295: }
1.256 matthew 1296: return ($fh,$filename)
1.113 bowersj2 1297: }
1298:
1299:
1.256 matthew 1300: =pod
1.113 bowersj2 1301:
1302: =back
1303:
1304: =cut
1.37 matthew 1305:
1306: ###############################################################
1.33 matthew 1307: ## Home server <option> list generating code ##
1308: ###############################################################
1.35 matthew 1309:
1.169 www 1310: # ------------------------------------------
1311:
1312: sub domain_select {
1313: my ($name,$value,$multiple)=@_;
1314: my %domains=map {
1.514 albertel 1315: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1316: } &Apache::lonnet::all_domains();
1.169 www 1317: if ($multiple) {
1318: $domains{''}=&mt('Any domain');
1.550 albertel 1319: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1320: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1321: } else {
1.550 albertel 1322: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1323: return &select_form($name,$value,%domains);
1324: }
1325: }
1326:
1.282 albertel 1327: #-------------------------------------------
1328:
1329: =pod
1330:
1.519 raeburn 1331: =head1 Routines for form select boxes
1332:
1333: =over 4
1334:
1335: =cut
1336:
1.287 albertel 1337: =item * multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1338:
1339: Returns a string containing a <select> element int multiple mode
1340:
1341:
1342: Args:
1343: $name - name of the <select> element
1.506 raeburn 1344: $value - scalar or array ref of values that should already be selected
1.282 albertel 1345: $size - number of rows long the select element is
1.283 albertel 1346: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1347: (shown text should already have been &mt())
1.506 raeburn 1348: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1349:
1.282 albertel 1350: =cut
1351:
1352: #-------------------------------------------
1.169 www 1353: sub multiple_select_form {
1.284 albertel 1354: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1355: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1356: my $output='';
1.191 matthew 1357: if (! defined($size)) {
1358: $size = 4;
1.283 albertel 1359: if (scalar(keys(%$hash))<4) {
1360: $size = scalar(keys(%$hash));
1.191 matthew 1361: }
1362: }
1.169 www 1363: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501 banghart 1364: my @order;
1.506 raeburn 1365: if (ref($order) eq 'ARRAY') {
1366: @order = @{$order};
1367: } else {
1368: @order = sort(keys(%$hash));
1.501 banghart 1369: }
1370: if (exists($$hash{'select_form_order'})) {
1371: @order = @{$$hash{'select_form_order'}};
1372: }
1373:
1.284 albertel 1374: foreach my $key (@order) {
1.356 albertel 1375: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1376: $output.='selected="selected" ' if ($selected{$key});
1377: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1378: }
1379: $output.="</select>\n";
1380: return $output;
1381: }
1382:
1.88 www 1383: #-------------------------------------------
1384:
1385: =pod
1386:
1.112 bowersj2 1387: =item * select_form($defdom,$name,%hash)
1.88 www 1388:
1389: Returns a string containing a <select name='$name' size='1'> form to
1390: allow a user to select options from a hash option_name => displayed text.
1391: See lonrights.pm for an example invocation and use.
1392:
1393: =cut
1394:
1395: #-------------------------------------------
1396: sub select_form {
1397: my ($def,$name,%hash) = @_;
1398: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1399: my @keys;
1400: if (exists($hash{'select_form_order'})) {
1401: @keys=@{$hash{'select_form_order'}};
1402: } else {
1403: @keys=sort(keys(%hash));
1404: }
1.356 albertel 1405: foreach my $key (@keys) {
1406: $selectform.=
1407: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1408: ($key eq $def ? 'selected="selected" ' : '').
1409: ">".&mt($hash{$key})."</option>\n";
1.88 www 1410: }
1411: $selectform.="</select>";
1412: return $selectform;
1413: }
1414:
1.475 www 1415: # For display filters
1416:
1417: sub display_filter {
1418: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1419: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475 www 1420: return '<nobr><label>'.&mt('Records [_1]',
1421: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1422: (&mt('all'),10,20,50,100,1000,10000))).
1.478 www 1423: '</label></nobr> <nobr>'.
1.475 www 1424: &mt('Filter [_1]',
1.477 www 1425: &select_form($env{'form.displayfilter'},
1426: 'displayfilter',
1427: ('currentfolder' => 'Current folder/page',
1428: 'containing' => 'Containing phrase',
1429: 'none' => 'None'))).
1.478 www 1430: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475 www 1431: }
1432:
1.167 www 1433: sub gradeleveldescription {
1434: my $gradelevel=shift;
1435: my %gradelevels=(0 => 'Not specified',
1436: 1 => 'Grade 1',
1437: 2 => 'Grade 2',
1438: 3 => 'Grade 3',
1439: 4 => 'Grade 4',
1440: 5 => 'Grade 5',
1441: 6 => 'Grade 6',
1442: 7 => 'Grade 7',
1443: 8 => 'Grade 8',
1444: 9 => 'Grade 9',
1445: 10 => 'Grade 10',
1446: 11 => 'Grade 11',
1447: 12 => 'Grade 12',
1448: 13 => 'Grade 13',
1449: 14 => '100 Level',
1450: 15 => '200 Level',
1451: 16 => '300 Level',
1452: 17 => '400 Level',
1453: 18 => 'Graduate Level');
1454: return &mt($gradelevels{$gradelevel});
1455: }
1456:
1.163 www 1457: sub select_level_form {
1458: my ($deflevel,$name)=@_;
1459: unless ($deflevel) { $deflevel=0; }
1.167 www 1460: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1461: for (my $i=0; $i<=18; $i++) {
1462: $selectform.="<option value=\"$i\" ".
1.253 albertel 1463: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1464: ">".&gradeleveldescription($i)."</option>\n";
1465: }
1466: $selectform.="</select>";
1467: return $selectform;
1.163 www 1468: }
1.167 www 1469:
1.35 matthew 1470: #-------------------------------------------
1471:
1.45 matthew 1472: =pod
1473:
1.563 raeburn 1474: =item * select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1475:
1476: Returns a string containing a <select name='$name' size='1'> form to
1477: allow a user to select the domain to preform an operation in.
1478: See loncreateuser.pm for an example invocation and use.
1479:
1.90 www 1480: If the $includeempty flag is set, it also includes an empty choice ("no domain
1481: selected");
1482:
1.563 raeburn 1483: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1484:
1.35 matthew 1485: =cut
1486:
1487: #-------------------------------------------
1.34 matthew 1488: sub select_dom_form {
1.563 raeburn 1489: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1490: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1491: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1492: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1493: foreach my $dom (@domains) {
1494: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1495: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1496: if ($showdomdesc) {
1497: if ($dom ne '') {
1498: my $domdesc = &Apache::lonnet::domain($dom,'description');
1499: if ($domdesc ne '') {
1500: $selectdomain .= ' ('.$domdesc.')';
1501: }
1502: }
1503: }
1504: $selectdomain .= "</option>\n";
1.34 matthew 1505: }
1506: $selectdomain.="</select>";
1507: return $selectdomain;
1508: }
1509:
1.35 matthew 1510: #-------------------------------------------
1511:
1.45 matthew 1512: =pod
1513:
1.112 bowersj2 1514: =item * home_server_option_list($domain)
1.35 matthew 1515:
1516: returns a string which contains an <option> list to be used in a
1517: <select> form input. See loncreateuser.pm for an example.
1518:
1519: =cut
1520:
1521: #-------------------------------------------
1.33 matthew 1522: sub home_server_option_list {
1523: my $domain = shift;
1.513 albertel 1524: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.33 matthew 1525: my $result = '';
1.356 albertel 1526: foreach my $hostid (sort(keys(%servers))) {
1.33 matthew 1527: $result.=
1.356 albertel 1528: '<option value="'.$hostid.'">'.
1529: $hostid.' '.$servers{$hostid}."</option>\n";
1.33 matthew 1530: }
1531: return $result;
1532: }
1.112 bowersj2 1533:
1534: =pod
1535:
1.534 albertel 1536: =back
1537:
1.112 bowersj2 1538: =cut
1.87 matthew 1539:
1540: ###############################################################
1.112 bowersj2 1541: ## Decoding User Agent ##
1.87 matthew 1542: ###############################################################
1543:
1544: =pod
1545:
1.112 bowersj2 1546: =head1 Decoding the User Agent
1547:
1548: =over 4
1549:
1550: =item * &decode_user_agent()
1.87 matthew 1551:
1552: Inputs: $r
1553:
1554: Outputs:
1555:
1556: =over 4
1557:
1.112 bowersj2 1558: =item * $httpbrowser
1.87 matthew 1559:
1.112 bowersj2 1560: =item * $clientbrowser
1.87 matthew 1561:
1.112 bowersj2 1562: =item * $clientversion
1.87 matthew 1563:
1.112 bowersj2 1564: =item * $clientmathml
1.87 matthew 1565:
1.112 bowersj2 1566: =item * $clientunicode
1.87 matthew 1567:
1.112 bowersj2 1568: =item * $clientos
1.87 matthew 1569:
1570: =back
1571:
1.157 matthew 1572: =back
1573:
1.87 matthew 1574: =cut
1575:
1576: ###############################################################
1577: ###############################################################
1578: sub decode_user_agent {
1.247 albertel 1579: my ($r)=@_;
1.87 matthew 1580: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1581: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1582: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1583: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1584: my $clientbrowser='unknown';
1585: my $clientversion='0';
1586: my $clientmathml='';
1587: my $clientunicode='0';
1588: for (my $i=0;$i<=$#browsertype;$i++) {
1589: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1590: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1591: $clientbrowser=$bname;
1592: $httpbrowser=~/$vreg/i;
1593: $clientversion=$1;
1594: $clientmathml=($clientversion>=$minv);
1595: $clientunicode=($clientversion>=$univ);
1596: }
1597: }
1598: my $clientos='unknown';
1599: if (($httpbrowser=~/linux/i) ||
1600: ($httpbrowser=~/unix/i) ||
1601: ($httpbrowser=~/ux/i) ||
1602: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1603: if (($httpbrowser=~/vax/i) ||
1604: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1605: if ($httpbrowser=~/next/i) { $clientos='next'; }
1606: if (($httpbrowser=~/mac/i) ||
1607: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1608: if ($httpbrowser=~/win/i) { $clientos='win'; }
1609: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1610: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1611: $clientunicode,$clientos,);
1612: }
1613:
1.32 matthew 1614: ###############################################################
1615: ## Authentication changing form generation subroutines ##
1616: ###############################################################
1617: ##
1618: ## All of the authform_xxxxxxx subroutines take their inputs in a
1619: ## hash, and have reasonable default values.
1620: ##
1621: ## formname = the name given in the <form> tag.
1.35 matthew 1622: #-------------------------------------------
1623:
1.45 matthew 1624: =pod
1625:
1.112 bowersj2 1626: =head1 Authentication Routines
1627:
1628: =over 4
1629:
1630: =item * authform_xxxxxx
1.35 matthew 1631:
1632: The authform_xxxxxx subroutines provide javascript and html forms which
1633: handle some of the conveniences required for authentication forms.
1634: This is not an optimal method, but it works.
1635:
1636: See loncreateuser.pm for invocation and use examples.
1637:
1638: =over 4
1639:
1.112 bowersj2 1640: =item * authform_header
1.35 matthew 1641:
1.112 bowersj2 1642: =item * authform_authorwarning
1.35 matthew 1643:
1.112 bowersj2 1644: =item * authform_nochange
1.35 matthew 1645:
1.112 bowersj2 1646: =item * authform_kerberos
1.35 matthew 1647:
1.112 bowersj2 1648: =item * authform_internal
1.35 matthew 1649:
1.112 bowersj2 1650: =item * authform_filesystem
1.35 matthew 1651:
1652: =back
1653:
1.157 matthew 1654: =back
1655:
1.35 matthew 1656: =cut
1657:
1658: #-------------------------------------------
1.32 matthew 1659: sub authform_header{
1660: my %in = (
1661: formname => 'cu',
1.80 albertel 1662: kerb_def_dom => '',
1.32 matthew 1663: @_,
1664: );
1665: $in{'formname'} = 'document.' . $in{'formname'};
1666: my $result='';
1.80 albertel 1667:
1668: #---------------------------------------------- Code for upper case translation
1669: my $Javascript_toUpperCase;
1670: unless ($in{kerb_def_dom}) {
1671: $Javascript_toUpperCase =<<"END";
1672: switch (choice) {
1673: case 'krb': currentform.elements[choicearg].value =
1674: currentform.elements[choicearg].value.toUpperCase();
1675: break;
1676: default:
1677: }
1678: END
1679: } else {
1680: $Javascript_toUpperCase = "";
1681: }
1682:
1.165 raeburn 1683: my $radioval = "'nochange'";
1.174 matthew 1684: if (exists($in{'curr_authtype'}) &&
1685: defined($in{'curr_authtype'}) &&
1686: $in{'curr_authtype'} ne '') {
1687: $radioval = "'$in{'curr_authtype'}arg'";
1688: }
1.165 raeburn 1689: my $argfield = 'null';
1690: if ( grep/^mode$/,(keys %in) ) {
1691: if ($in{'mode'} eq 'modifycourse') {
1692: if ( grep/^curr_authtype$/,(keys %in) ) {
1693: $radioval = "'$in{'curr_authtype'}'";
1694: }
1695: if ( grep/^curr_autharg$/,(keys %in) ) {
1696: unless ($in{'curr_autharg'} eq '') {
1697: $argfield = "'$in{'curr_autharg'}'";
1698: }
1699: }
1700: }
1701: }
1702:
1.32 matthew 1703: $result.=<<"END";
1704: var current = new Object();
1.165 raeburn 1705: current.radiovalue = $radioval;
1706: current.argfield = $argfield;
1.32 matthew 1707:
1708: function changed_radio(choice,currentform) {
1709: var choicearg = choice + 'arg';
1710: // If a radio button in changed, we need to change the argfield
1711: if (current.radiovalue != choice) {
1712: current.radiovalue = choice;
1713: if (current.argfield != null) {
1714: currentform.elements[current.argfield].value = '';
1715: }
1716: if (choice == 'nochange') {
1717: current.argfield = null;
1718: } else {
1719: current.argfield = choicearg;
1720: switch(choice) {
1721: case 'krb':
1722: currentform.elements[current.argfield].value =
1723: "$in{'kerb_def_dom'}";
1724: break;
1725: default:
1726: break;
1727: }
1728: }
1729: }
1730: return;
1731: }
1.22 www 1732:
1.32 matthew 1733: function changed_text(choice,currentform) {
1734: var choicearg = choice + 'arg';
1735: if (currentform.elements[choicearg].value !='') {
1.80 albertel 1736: $Javascript_toUpperCase
1.32 matthew 1737: // clear old field
1738: if ((current.argfield != choicearg) && (current.argfield != null)) {
1739: currentform.elements[current.argfield].value = '';
1740: }
1741: current.argfield = choicearg;
1742: }
1743: set_auth_radio_buttons(choice,currentform);
1744: return;
1.20 www 1745: }
1.32 matthew 1746:
1747: function set_auth_radio_buttons(newvalue,currentform) {
1748: var i=0;
1749: while (i < currentform.login.length) {
1750: if (currentform.login[i].value == newvalue) { break; }
1751: i++;
1752: }
1753: if (i == currentform.login.length) {
1754: return;
1755: }
1756: current.radiovalue = newvalue;
1757: currentform.login[i].checked = true;
1758: return;
1759: }
1760: END
1761: return $result;
1762: }
1763:
1764: sub authform_authorwarning{
1765: my $result='';
1.144 matthew 1766: $result='<i>'.
1767: &mt('As a general rule, only authors or co-authors should be '.
1768: 'filesystem authenticated '.
1769: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 1770: return $result;
1771: }
1772:
1773: sub authform_nochange{
1774: my %in = (
1775: formname => 'document.cu',
1776: kerb_def_dom => 'MSU.EDU',
1777: @_,
1778: );
1.281 albertel 1779: my $result = '<label>'.&mt('[_1] Do not change login data',
1.144 matthew 1780: '<input type="radio" name="login" value="nochange" '.
1781: 'checked="checked" onclick="'.
1.281 albertel 1782: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
1783: '</label>';
1.32 matthew 1784: return $result;
1785: }
1786:
1787: sub authform_kerberos{
1788: my %in = (
1789: formname => 'document.cu',
1790: kerb_def_dom => 'MSU.EDU',
1.80 albertel 1791: kerb_def_auth => 'krb4',
1.32 matthew 1792: @_,
1793: );
1.165 raeburn 1794: my ($check4,$check5,$krbarg);
1.80 albertel 1795: if ($in{'kerb_def_auth'} eq 'krb5') {
1796: $check5 = " checked=\"on\"";
1797: } else {
1798: $check4 = " checked=\"on\"";
1799: }
1.165 raeburn 1800: $krbarg = $in{'kerb_def_dom'};
1801:
1802: my $krbcheck = "";
1803: if ( grep/^curr_authtype$/,(keys %in) ) {
1804: if ($in{'curr_authtype'} =~ m/^krb/) {
1805: $krbcheck = " checked=\"on\"";
1806: if ( grep/^curr_autharg$/,(keys %in) ) {
1807: $krbarg = $in{'curr_autharg'};
1808: }
1809: }
1810: }
1811:
1.144 matthew 1812: my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1813: my $result .= &mt
1814: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 1815: '[_3] Version 4 [_4] Version 5 [_5]',
1816: '<label><input type="radio" name="login" value="krb" '.
1.165 raeburn 1817: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.281 albertel 1818: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 1819: 'value="'.$krbarg.'" '.
1.144 matthew 1820: 'onchange="'.$jscall.'" />',
1.281 albertel 1821: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
1822: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
1823: '</label>');
1.32 matthew 1824: return $result;
1825: }
1826:
1827: sub authform_internal{
1828: my %args = (
1829: formname => 'document.cu',
1830: kerb_def_dom => 'MSU.EDU',
1831: @_,
1832: );
1.165 raeburn 1833:
1834: my $intcheck = "";
1835: my $intarg = 'value=""';
1836: if ( grep/^curr_authtype$/,(keys %args) ) {
1837: if ($args{'curr_authtype'} eq 'int') {
1838: $intcheck = " checked=\"on\"";
1839: if ( grep/^curr_autharg$/,(keys %args) ) {
1840: $intarg = "value=\"$args{'curr_autharg'}\"";
1841: }
1842: }
1843: }
1844:
1.144 matthew 1845: my $jscall = "javascript:changed_radio('int',$args{'formname'});";
1846: my $result.=&mt
1847: ('[_1] Internally authenticated (with initial password [_2])',
1.281 albertel 1848: '<label><input type="radio" name="login" value="int" '.$intcheck.
1.165 raeburn 1849: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1850: '</label><input type="text" size="10" name="intarg" '.$intarg.
1.165 raeburn 1851: ' onchange="'.$jscall.'" />');
1.32 matthew 1852: return $result;
1853: }
1854:
1855: sub authform_local{
1856: my %in = (
1857: formname => 'document.cu',
1858: kerb_def_dom => 'MSU.EDU',
1859: @_,
1860: );
1.165 raeburn 1861:
1862: my $loccheck = "";
1863: my $locarg = 'value=""';
1864: if ( grep/^curr_authtype$/,(keys %in) ) {
1865: if ($in{'curr_authtype'} eq 'loc') {
1866: $loccheck = " checked=\"on\"";
1867: if ( grep/^curr_autharg$/,(keys %in) ) {
1868: $locarg = "value=\"$in{'curr_autharg'}\"";
1869: }
1870: }
1871: }
1872:
1.144 matthew 1873: my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160 matthew 1874: my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.281 albertel 1875: '<label><input type="radio" name="login" value="loc" '.$loccheck.
1.165 raeburn 1876: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1877: '</label><input type="text" size="10" name="locarg" '.$locarg.
1.165 raeburn 1878: ' onchange="'.$jscall.'" />');
1.32 matthew 1879: return $result;
1880: }
1881:
1882: sub authform_filesystem{
1883: my %in = (
1884: formname => 'document.cu',
1885: kerb_def_dom => 'MSU.EDU',
1886: @_,
1887: );
1.144 matthew 1888: my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
1889: my $result.= &mt
1890: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 1891: '<label><input type="radio" name="login" value="fsys" '.
1.144 matthew 1892: 'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1893: '</label><input type="text" size="10" name="fsysarg" value="" '.
1.144 matthew 1894: 'onchange="'.$jscall.'" />');
1.32 matthew 1895: return $result;
1896: }
1897:
1.80 albertel 1898: ###############################################################
1899: ## Get Authentication Defaults for Domain ##
1900: ###############################################################
1901:
1902: =pod
1903:
1.112 bowersj2 1904: =head1 Domains and Authentication
1905:
1906: Returns default authentication type and an associated argument as
1907: listed in file 'domain.tab'.
1908:
1909: =over 4
1910:
1911: =item * get_auth_defaults
1.80 albertel 1912:
1913: get_auth_defaults($target_domain) returns the default authentication
1914: type and an associated argument (initial password or a kerberos domain).
1915: These values are stored in lonTabs/domain.tab
1916:
1917: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
1918:
1919: If target_domain is not found in domain.tab, returns nothing ('').
1920:
1921: =cut
1922:
1923: #-------------------------------------------
1924: sub get_auth_defaults {
1925: my $domain=shift;
1.514 albertel 1926: return (&Apache::lonnet::domain($domain,'auth_def'),
1927: &Apache::lonnet::domain($domain,'auth_arg_def'));
1928:
1.80 albertel 1929: }
1930: ###############################################################
1931: ## End Get Authentication Defaults for Domain ##
1932: ###############################################################
1933:
1934: ###############################################################
1935: ## Get Kerberos Defaults for Domain ##
1936: ###############################################################
1937: ##
1938: ## Returns default kerberos version and an associated argument
1939: ## as listed in file domain.tab. If not listed, provides
1940: ## appropriate default domain and kerberos version.
1941: ##
1942: #-------------------------------------------
1943:
1944: =pod
1945:
1.112 bowersj2 1946: =item * get_kerberos_defaults
1.80 albertel 1947:
1948: get_kerberos_defaults($target_domain) returns the default kerberos
1949: version and domain. If not found in domain.tabs, it defaults to
1950: version 4 and the domain of the server.
1951:
1952: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
1953:
1954: =cut
1955:
1956: #-------------------------------------------
1957: sub get_kerberos_defaults {
1958: my $domain=shift;
1959: my ($krbdef,$krbdefdom) =
1960: &Apache::loncommon::get_auth_defaults($domain);
1961: unless ($krbdef =~/^krb/ && $krbdefdom) {
1962: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
1963: my $krbdefdom=$1;
1964: $krbdefdom=~tr/a-z/A-Z/;
1965: $krbdef = "krb4";
1966: }
1967: return ($krbdef,$krbdefdom);
1968: }
1.112 bowersj2 1969:
1970: =pod
1971:
1972: =back
1973:
1974: =cut
1.32 matthew 1975:
1.46 matthew 1976: ###############################################################
1977: ## Thesaurus Functions ##
1978: ###############################################################
1.20 www 1979:
1.46 matthew 1980: =pod
1.20 www 1981:
1.112 bowersj2 1982: =head1 Thesaurus Functions
1983:
1984: =over 4
1985:
1986: =item * initialize_keywords
1.46 matthew 1987:
1988: Initializes the package variable %Keywords if it is empty. Uses the
1989: package variable $thesaurus_db_file.
1990:
1991: =cut
1992:
1993: ###################################################
1994:
1995: sub initialize_keywords {
1996: return 1 if (scalar keys(%Keywords));
1997: # If we are here, %Keywords is empty, so fill it up
1998: # Make sure the file we need exists...
1999: if (! -e $thesaurus_db_file) {
2000: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2001: " failed because it does not exist");
2002: return 0;
2003: }
2004: # Set up the hash as a database
2005: my %thesaurus_db;
2006: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2007: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2008: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2009: $thesaurus_db_file);
2010: return 0;
2011: }
2012: # Get the average number of appearances of a word.
2013: my $avecount = $thesaurus_db{'average.count'};
2014: # Put keywords (those that appear > average) into %Keywords
2015: while (my ($word,$data)=each (%thesaurus_db)) {
2016: my ($count,undef) = split /:/,$data;
2017: $Keywords{$word}++ if ($count > $avecount);
2018: }
2019: untie %thesaurus_db;
2020: # Remove special values from %Keywords.
1.356 albertel 2021: foreach my $value ('total.count','average.count') {
2022: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.46 matthew 2023: }
2024: return 1;
2025: }
2026:
2027: ###################################################
2028:
2029: =pod
2030:
1.112 bowersj2 2031: =item * keyword($word)
1.46 matthew 2032:
2033: Returns true if $word is a keyword. A keyword is a word that appears more
2034: than the average number of times in the thesaurus database. Calls
2035: &initialize_keywords
2036:
2037: =cut
2038:
2039: ###################################################
1.20 www 2040:
2041: sub keyword {
1.46 matthew 2042: return if (!&initialize_keywords());
2043: my $word=lc(shift());
2044: $word=~s/\W//g;
2045: return exists($Keywords{$word});
1.20 www 2046: }
1.46 matthew 2047:
2048: ###############################################################
2049:
2050: =pod
1.20 www 2051:
1.112 bowersj2 2052: =item * get_related_words
1.46 matthew 2053:
1.160 matthew 2054: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2055: an array of words. If the keyword is not in the thesaurus, an empty array
2056: will be returned. The order of the words returned is determined by the
2057: database which holds them.
2058:
2059: Uses global $thesaurus_db_file.
2060:
2061: =cut
2062:
2063: ###############################################################
2064: sub get_related_words {
2065: my $keyword = shift;
2066: my %thesaurus_db;
2067: if (! -e $thesaurus_db_file) {
2068: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2069: "failed because the file does not exist");
2070: return ();
2071: }
2072: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2073: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2074: return ();
2075: }
2076: my @Words=();
1.429 www 2077: my $count=0;
1.46 matthew 2078: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2079: # The first element is the number of times
2080: # the word appears. We do not need it now.
1.429 www 2081: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2082: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2083: my $threshold=$mostfrequentcount/10;
2084: foreach my $possibleword (@RelatedWords) {
2085: my ($word,$wordcount)=split(/\,/,$possibleword);
2086: if ($wordcount>$threshold) {
2087: push(@Words,$word);
2088: $count++;
2089: if ($count>10) { last; }
2090: }
1.20 www 2091: }
2092: }
1.46 matthew 2093: untie %thesaurus_db;
2094: return @Words;
1.14 harris41 2095: }
1.46 matthew 2096:
1.112 bowersj2 2097: =pod
2098:
2099: =back
2100:
2101: =cut
1.61 www 2102:
2103: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2104: =pod
2105:
1.112 bowersj2 2106: =head1 User Name Functions
2107:
2108: =over 4
2109:
1.226 albertel 2110: =item * plainname($uname,$udom,$first)
1.81 albertel 2111:
1.112 bowersj2 2112: Takes a users logon name and returns it as a string in
1.226 albertel 2113: "first middle last generation" form
2114: if $first is set to 'lastname' then it returns it as
2115: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2116:
2117: =cut
1.61 www 2118:
1.295 www 2119:
1.81 albertel 2120: ###############################################################
1.61 www 2121: sub plainname {
1.226 albertel 2122: my ($uname,$udom,$first)=@_;
1.537 albertel 2123: return if (!defined($uname) || !defined($udom));
1.295 www 2124: my %names=&getnames($uname,$udom);
1.226 albertel 2125: my $name=&Apache::lonnet::format_name($names{'firstname'},
2126: $names{'middlename'},
2127: $names{'lastname'},
2128: $names{'generation'},$first);
2129: $name=~s/^\s+//;
1.62 www 2130: $name=~s/\s+$//;
2131: $name=~s/\s+/ /g;
1.353 albertel 2132: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2133: return $name;
1.61 www 2134: }
1.66 www 2135:
2136: # -------------------------------------------------------------------- Nickname
1.81 albertel 2137: =pod
2138:
1.112 bowersj2 2139: =item * nickname($uname,$udom)
1.81 albertel 2140:
2141: Gets a users name and returns it as a string as
2142:
2143: ""nickname""
1.66 www 2144:
1.81 albertel 2145: if the user has a nickname or
2146:
2147: "first middle last generation"
2148:
2149: if the user does not
2150:
2151: =cut
1.66 www 2152:
2153: sub nickname {
2154: my ($uname,$udom)=@_;
1.537 albertel 2155: return if (!defined($uname) || !defined($udom));
1.295 www 2156: my %names=&getnames($uname,$udom);
1.68 albertel 2157: my $name=$names{'nickname'};
1.66 www 2158: if ($name) {
2159: $name='"'.$name.'"';
2160: } else {
2161: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2162: $names{'lastname'}.' '.$names{'generation'};
2163: $name=~s/\s+$//;
2164: $name=~s/\s+/ /g;
2165: }
2166: return $name;
2167: }
2168:
1.295 www 2169: sub getnames {
2170: my ($uname,$udom)=@_;
1.537 albertel 2171: return if (!defined($uname) || !defined($udom));
1.433 albertel 2172: if ($udom eq 'public' && $uname eq 'public') {
2173: return ('lastname' => &mt('Public'));
2174: }
1.295 www 2175: my $id=$uname.':'.$udom;
2176: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2177: if ($cached) {
2178: return %{$names};
2179: } else {
2180: my %loadnames=&Apache::lonnet::get('environment',
2181: ['firstname','middlename','lastname','generation','nickname'],
2182: $udom,$uname);
2183: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2184: return %loadnames;
2185: }
2186: }
1.61 www 2187:
1.542 raeburn 2188: # -------------------------------------------------------------------- getemails
2189: =pod
2190:
2191: =item * getemails($uname,$udom)
2192:
2193: Gets a user's email information and returns it as a hash with keys:
2194: notification, critnotification, permanentemail
2195:
2196: For notification and critnotification, values are comma-separated lists
2197: of e-mail address(es); for permanentemail, value is a single e-mail address.
2198:
2199: =cut
2200:
1.466 albertel 2201: sub getemails {
2202: my ($uname,$udom)=@_;
2203: if ($udom eq 'public' && $uname eq 'public') {
2204: return;
2205: }
1.467 www 2206: if (!$udom) { $udom=$env{'user.domain'}; }
2207: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2208: my $id=$uname.':'.$udom;
2209: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2210: if ($cached) {
2211: return %{$names};
2212: } else {
2213: my %loadnames=&Apache::lonnet::get('environment',
2214: ['notification','critnotification',
2215: 'permanentemail'],
2216: $udom,$uname);
2217: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2218: return %loadnames;
2219: }
2220: }
2221:
1.551 albertel 2222: sub flush_email_cache {
2223: my ($uname,$udom)=@_;
2224: if (!$udom) { $udom =$env{'user.domain'}; }
2225: if (!$uname) { $uname=$env{'user.name'}; }
2226: return if ($udom eq 'public' && $uname eq 'public');
2227: my $id=$uname.':'.$udom;
2228: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2229: }
2230:
1.61 www 2231: # ------------------------------------------------------------------ Screenname
1.81 albertel 2232:
2233: =pod
2234:
1.112 bowersj2 2235: =item * screenname($uname,$udom)
1.81 albertel 2236:
2237: Gets a users screenname and returns it as a string
2238:
2239: =cut
1.61 www 2240:
2241: sub screenname {
2242: my ($uname,$udom)=@_;
1.258 albertel 2243: if ($uname eq $env{'user.name'} &&
2244: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2245: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2246: return $names{'screenname'};
1.62 www 2247: }
2248:
1.212 albertel 2249:
1.62 www 2250: # ------------------------------------------------------------- Message Wrapper
2251:
2252: sub messagewrapper {
1.369 www 2253: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2254: return
1.441 albertel 2255: '<a href="/adm/email?compose=individual&'.
2256: 'recname='.$username.'&recdom='.$domain.
2257: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2258: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2259: }
2260: # --------------------------------------------------------------- Notes Wrapper
2261:
2262: sub noteswrapper {
2263: my ($link,$un,$do)=@_;
2264: return
2265: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2266: }
2267: # ------------------------------------------------------------- Aboutme Wrapper
2268:
2269: sub aboutmewrapper {
1.166 www 2270: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2271: if (!defined($username) && !defined($domain)) {
2272: return;
2273: }
1.205 www 2274: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2275: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2276: }
2277:
2278: # ------------------------------------------------------------ Syllabus Wrapper
2279:
2280:
2281: sub syllabuswrapper {
1.109 matthew 2282: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2283: if ($fontcolor) {
2284: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2285: }
1.208 matthew 2286: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2287: }
1.14 harris41 2288:
1.208 matthew 2289: sub track_student_link {
1.268 albertel 2290: my ($linktext,$sname,$sdom,$target,$start) = @_;
2291: my $link ="/adm/trackstudent?";
1.208 matthew 2292: my $title = 'View recent activity';
2293: if (defined($sname) && $sname !~ /^\s*$/ &&
2294: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2295: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2296: $title .= ' of this student';
1.268 albertel 2297: }
1.208 matthew 2298: if (defined($target) && $target !~ /^\s*$/) {
2299: $target = qq{target="$target"};
2300: } else {
2301: $target = '';
2302: }
1.268 albertel 2303: if ($start) { $link.='&start='.$start; }
1.554 albertel 2304: $title = &mt($title);
2305: $linktext = &mt($linktext);
1.448 albertel 2306: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2307: &help_open_topic('View_recent_activity');
1.208 matthew 2308: }
2309:
1.508 www 2310: # ===================================================== Display a student photo
2311:
2312:
1.509 albertel 2313: sub student_image_tag {
1.508 www 2314: my ($domain,$user)=@_;
2315: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2316: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2317: return '<img src="'.$imgsrc.'" align="right" />';
2318: } else {
2319: return '';
2320: }
2321: }
2322:
1.112 bowersj2 2323: =pod
2324:
2325: =back
2326:
2327: =head1 Access .tab File Data
2328:
2329: =over 4
2330:
2331: =item * languageids()
2332:
2333: returns list of all language ids
2334:
2335: =cut
2336:
1.14 harris41 2337: sub languageids {
1.16 harris41 2338: return sort(keys(%language));
1.14 harris41 2339: }
2340:
1.112 bowersj2 2341: =pod
2342:
2343: =item * languagedescription()
2344:
2345: returns description of a specified language id
2346:
2347: =cut
2348:
1.14 harris41 2349: sub languagedescription {
1.125 www 2350: my $code=shift;
2351: return ($supported_language{$code}?'* ':'').
2352: $language{$code}.
1.126 www 2353: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2354: }
2355:
2356: sub plainlanguagedescription {
2357: my $code=shift;
2358: return $language{$code};
2359: }
2360:
2361: sub supportedlanguagecode {
2362: my $code=shift;
2363: return $supported_language{$code};
1.97 www 2364: }
2365:
1.112 bowersj2 2366: =pod
2367:
2368: =item * copyrightids()
2369:
2370: returns list of all copyrights
2371:
2372: =cut
2373:
2374: sub copyrightids {
2375: return sort(keys(%cprtag));
2376: }
2377:
2378: =pod
2379:
2380: =item * copyrightdescription()
2381:
2382: returns description of a specified copyright id
2383:
2384: =cut
2385:
2386: sub copyrightdescription {
1.166 www 2387: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2388: }
1.197 matthew 2389:
2390: =pod
2391:
1.192 taceyjo1 2392: =item * source_copyrightids()
2393:
2394: returns list of all source copyrights
2395:
2396: =cut
2397:
2398: sub source_copyrightids {
2399: return sort(keys(%scprtag));
2400: }
2401:
2402: =pod
2403:
2404: =item * source_copyrightdescription()
2405:
2406: returns description of a specified source copyright id
2407:
2408: =cut
2409:
2410: sub source_copyrightdescription {
2411: return &mt($scprtag{shift(@_)});
2412: }
1.112 bowersj2 2413:
2414: =pod
2415:
2416: =item * filecategories()
2417:
2418: returns list of all file categories
2419:
2420: =cut
2421:
2422: sub filecategories {
2423: return sort(keys(%category_extensions));
2424: }
2425:
2426: =pod
2427:
2428: =item * filecategorytypes()
2429:
2430: returns list of file types belonging to a given file
2431: category
2432:
2433: =cut
2434:
2435: sub filecategorytypes {
1.356 albertel 2436: my ($cat) = @_;
2437: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2438: }
2439:
2440: =pod
2441:
2442: =item * fileembstyle()
2443:
2444: returns embedding style for a specified file type
2445:
2446: =cut
2447:
2448: sub fileembstyle {
2449: return $fe{lc(shift(@_))};
1.169 www 2450: }
2451:
1.351 www 2452: sub filemimetype {
2453: return $fm{lc(shift(@_))};
2454: }
2455:
1.169 www 2456:
2457: sub filecategoryselect {
2458: my ($name,$value)=@_;
1.189 matthew 2459: return &select_form($value,$name,
1.169 www 2460: '' => &mt('Any category'),
2461: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2462: }
2463:
2464: =pod
2465:
2466: =item * filedescription()
2467:
2468: returns description for a specified file type
2469:
2470: =cut
2471:
2472: sub filedescription {
1.188 matthew 2473: my $file_description = $fd{lc(shift())};
2474: $file_description =~ s:([\[\]]):~$1:g;
2475: return &mt($file_description);
1.112 bowersj2 2476: }
2477:
2478: =pod
2479:
2480: =item * filedescriptionex()
2481:
2482: returns description for a specified file type with
2483: extra formatting
2484:
2485: =cut
2486:
2487: sub filedescriptionex {
2488: my $ex=shift;
1.188 matthew 2489: my $file_description = $fd{lc($ex)};
2490: $file_description =~ s:([\[\]]):~$1:g;
2491: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2492: }
2493:
2494: # End of .tab access
2495: =pod
2496:
2497: =back
2498:
2499: =cut
2500:
2501: # ------------------------------------------------------------------ File Types
2502: sub fileextensions {
2503: return sort(keys(%fe));
2504: }
2505:
1.97 www 2506: # ----------------------------------------------------------- Display Languages
2507: # returns a hash with all desired display languages
2508: #
2509:
2510: sub display_languages {
2511: my %languages=();
1.356 albertel 2512: foreach my $lang (&preferred_languages()) {
2513: $languages{$lang}=1;
1.97 www 2514: }
2515: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 2516: if ($env{'form.displaylanguage'}) {
1.356 albertel 2517: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
2518: $languages{$lang}=1;
1.97 www 2519: }
2520: }
2521: return %languages;
1.14 harris41 2522: }
2523:
1.117 www 2524: sub preferred_languages {
2525: my @languages=();
1.258 albertel 2526: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117 www 2527: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258 albertel 2528: $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177 www 2529: }
1.258 albertel 2530: if ($env{'environment.languages'}) {
1.459 albertel 2531: @languages=(@languages,
2532: split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
1.118 www 2533: }
1.583 albertel 2534: my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
1.162 www 2535: if ($browser) {
1.583 albertel 2536: my @browser =
2537: map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));
2538: push(@languages,@browser);
1.162 www 2539: }
1.514 albertel 2540: if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {
1.118 www 2541: @languages=(@languages,
1.514 albertel 2542: &Apache::lonnet::domain($env{'user.domain'},
2543: 'lang_def'));
1.118 www 2544: }
1.514 albertel 2545: if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {
1.118 www 2546: @languages=(@languages,
1.514 albertel 2547: &Apache::lonnet::domain($env{'request.role.domain'},
2548: 'lang_def'));
1.118 www 2549: }
1.514 albertel 2550: if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2551: 'lang_def')) {
1.118 www 2552: @languages=(@languages,
1.514 albertel 2553: &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2554: 'lang_def'));
1.118 www 2555: }
2556: # turn "en-ca" into "en-ca,en"
2557: my @genlanguages;
1.356 albertel 2558: foreach my $lang (@languages) {
2559: unless ($lang=~/\w/) { next; }
1.583 albertel 2560: push(@genlanguages,$lang);
1.356 albertel 2561: if ($lang=~/(\-|\_)/) {
2562: push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
1.118 www 2563: }
2564: }
1.583 albertel 2565: #uniqueify the languages list
2566: my %count;
2567: @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
1.118 www 2568: return @genlanguages;
1.117 www 2569: }
2570:
1.582 albertel 2571: sub languages {
2572: my ($possible_langs) = @_;
2573: my @preferred_langs = &preferred_languages();
2574: if (!ref($possible_langs)) {
2575: if( wantarray ) {
2576: return @preferred_langs;
2577: } else {
2578: return $preferred_langs[0];
2579: }
2580: }
2581: my %possibilities = map { $_ => 1 } (@$possible_langs);
2582: my @preferred_possibilities;
2583: foreach my $preferred_lang (@preferred_langs) {
2584: if (exists($possibilities{$preferred_lang})) {
2585: push(@preferred_possibilities, $preferred_lang);
2586: }
2587: }
2588: if( wantarray ) {
2589: return @preferred_possibilities;
2590: }
2591: return $preferred_possibilities[0];
2592: }
2593:
1.112 bowersj2 2594: ###############################################################
2595: ## Student Answer Attempts ##
2596: ###############################################################
2597:
2598: =pod
2599:
2600: =head1 Alternate Problem Views
2601:
2602: =over 4
2603:
2604: =item * get_previous_attempt($symb, $username, $domain, $course,
2605: $getattempt, $regexp, $gradesub)
2606:
2607: Return string with previous attempt on problem. Arguments:
2608:
2609: =over 4
2610:
2611: =item * $symb: Problem, including path
2612:
2613: =item * $username: username of the desired student
2614:
2615: =item * $domain: domain of the desired student
1.14 harris41 2616:
1.112 bowersj2 2617: =item * $course: Course ID
1.14 harris41 2618:
1.112 bowersj2 2619: =item * $getattempt: Leave blank for all attempts, otherwise put
2620: something
1.14 harris41 2621:
1.112 bowersj2 2622: =item * $regexp: if string matches this regexp, the string will be
2623: sent to $gradesub
1.14 harris41 2624:
1.112 bowersj2 2625: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 2626:
1.112 bowersj2 2627: =back
1.14 harris41 2628:
1.112 bowersj2 2629: The output string is a table containing all desired attempts, if any.
1.16 harris41 2630:
1.112 bowersj2 2631: =cut
1.1 albertel 2632:
2633: sub get_previous_attempt {
1.43 ng 2634: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 2635: my $prevattempts='';
1.43 ng 2636: no strict 'refs';
1.1 albertel 2637: if ($symb) {
1.3 albertel 2638: my (%returnhash)=
2639: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 2640: if ($returnhash{'version'}) {
2641: my %lasthash=();
2642: my $version;
2643: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 2644: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
2645: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 2646: }
1.1 albertel 2647: }
1.43 ng 2648: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40 ng 2649: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.356 albertel 2650: foreach my $key (sort(keys(%lasthash))) {
2651: my ($ign,@parts) = split(/\./,$key);
1.41 ng 2652: if ($#parts > 0) {
1.31 albertel 2653: my $data=$parts[-1];
2654: pop(@parts);
1.40 ng 2655: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
1.31 albertel 2656: } else {
1.41 ng 2657: if ($#parts == 0) {
2658: $prevattempts.='<th>'.$parts[0].'</th>';
2659: } else {
2660: $prevattempts.='<th>'.$ign.'</th>';
2661: }
1.31 albertel 2662: }
1.16 harris41 2663: }
1.40 ng 2664: if ($getattempt eq '') {
2665: for ($version=1;$version<=$returnhash{'version'};$version++) {
2666: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
1.356 albertel 2667: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 2668: my $value = &format_previous_attempt_value($key,
2669: $returnhash{$version.':'.$key});
2670: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 2671: }
2672: }
1.1 albertel 2673: }
1.40 ng 2674: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.356 albertel 2675: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 2676: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 2677: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 2678: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 2679: }
1.40 ng 2680: $prevattempts.='</tr></table></td></tr></table>';
1.1 albertel 2681: } else {
2682: $prevattempts='Nothing submitted - no attempts.';
2683: }
2684: } else {
2685: $prevattempts='No data.';
2686: }
1.10 albertel 2687: }
2688:
1.581 albertel 2689: sub format_previous_attempt_value {
2690: my ($key,$value) = @_;
2691: if ($key =~ /timestamp/) {
2692: $value = &Apache::lonlocal::locallocaltime($value);
2693: } elsif (ref($value) eq 'ARRAY') {
2694: $value = '('.join(', ', @{ $value }).')';
2695: } else {
2696: $value = &unescape($value);
2697: }
2698: return $value;
2699: }
2700:
2701:
1.107 albertel 2702: sub relative_to_absolute {
2703: my ($url,$output)=@_;
2704: my $parser=HTML::TokeParser->new(\$output);
2705: my $token;
2706: my $thisdir=$url;
2707: my @rlinks=();
2708: while ($token=$parser->get_token) {
2709: if ($token->[0] eq 'S') {
2710: if ($token->[1] eq 'a') {
2711: if ($token->[2]->{'href'}) {
2712: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2713: }
2714: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2715: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2716: } elsif ($token->[1] eq 'base') {
2717: $thisdir=$token->[2]->{'href'};
2718: }
2719: }
2720: }
2721: $thisdir=~s-/[^/]*$--;
1.356 albertel 2722: foreach my $link (@rlinks) {
2723: unless (($link=~/^http:\/\//i) ||
2724: ($link=~/^\//) ||
2725: ($link=~/^javascript:/i) ||
2726: ($link=~/^mailto:/i) ||
2727: ($link=~/^\#/)) {
2728: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
2729: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 2730: }
2731: }
2732: # -------------------------------------------------- Deal with Applet codebases
2733: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2734: return $output;
2735: }
2736:
1.112 bowersj2 2737: =pod
2738:
2739: =item * get_student_view
2740:
2741: show a snapshot of what student was looking at
2742:
2743: =cut
2744:
1.10 albertel 2745: sub get_student_view {
1.186 albertel 2746: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 2747: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2748: my (%form);
1.10 albertel 2749: my @elements=('symb','courseid','domain','username');
2750: foreach my $element (@elements) {
1.186 albertel 2751: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2752: }
1.186 albertel 2753: if (defined($moreenv)) {
2754: %form=(%form,%{$moreenv});
2755: }
1.236 albertel 2756: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 2757: $feedurl=&Apache::lonnet::clutter($feedurl);
1.186 albertel 2758: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 2759: $userview=~s/\<body[^\>]*\>//gi;
2760: $userview=~s/\<\/body\>//gi;
2761: $userview=~s/\<html\>//gi;
2762: $userview=~s/\<\/html\>//gi;
2763: $userview=~s/\<head\>//gi;
2764: $userview=~s/\<\/head\>//gi;
2765: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 2766: $userview=&relative_to_absolute($feedurl,$userview);
1.11 albertel 2767: return $userview;
2768: }
2769:
1.112 bowersj2 2770: =pod
2771:
2772: =item * get_student_answers()
2773:
2774: show a snapshot of how student was answering problem
2775:
2776: =cut
2777:
1.11 albertel 2778: sub get_student_answers {
1.100 sakharuk 2779: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 2780: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2781: my (%moreenv);
1.11 albertel 2782: my @elements=('symb','courseid','domain','username');
2783: foreach my $element (@elements) {
1.186 albertel 2784: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2785: }
1.186 albertel 2786: $moreenv{'grade_target'}='answer';
2787: %moreenv=(%form,%moreenv);
1.497 raeburn 2788: $feedurl = &Apache::lonnet::clutter($feedurl);
2789: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 2790: return $userview;
1.1 albertel 2791: }
1.116 albertel 2792:
2793: =pod
2794:
2795: =item * &submlink()
2796:
1.242 albertel 2797: Inputs: $text $uname $udom $symb $target
1.116 albertel 2798:
2799: Returns: A link to grades.pm such as to see the SUBM view of a student
2800:
2801: =cut
2802:
2803: ###############################################
2804: sub submlink {
1.242 albertel 2805: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 2806: if (!($uname && $udom)) {
2807: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 2808: &Apache::lonnet::whichuser($symb);
1.116 albertel 2809: if (!$symb) { $symb=$cursymb; }
2810: }
1.254 matthew 2811: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 2812: $symb=&escape($symb);
1.242 albertel 2813: if ($target) { $target="target=\"$target\""; }
2814: return '<a href="/adm/grades?&command=submission&'.
2815: 'symb='.$symb.'&student='.$uname.
2816: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2817: }
2818: ##############################################
2819:
2820: =pod
2821:
2822: =item * &pgrdlink()
2823:
2824: Inputs: $text $uname $udom $symb $target
2825:
2826: Returns: A link to grades.pm such as to see the PGRD view of a student
2827:
2828: =cut
2829:
2830: ###############################################
2831: sub pgrdlink {
2832: my $link=&submlink(@_);
2833: $link=~s/(&command=submission)/$1&showgrading=yes/;
2834: return $link;
2835: }
2836: ##############################################
2837:
2838: =pod
2839:
2840: =item * &pprmlink()
2841:
2842: Inputs: $text $uname $udom $symb $target
2843:
2844: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 2845: student and a specific resource
1.242 albertel 2846:
2847: =cut
2848:
2849: ###############################################
2850: sub pprmlink {
2851: my ($text,$uname,$udom,$symb,$target)=@_;
2852: if (!($uname && $udom)) {
2853: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 2854: &Apache::lonnet::whichuser($symb);
1.242 albertel 2855: if (!$symb) { $symb=$cursymb; }
2856: }
1.254 matthew 2857: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 2858: $symb=&escape($symb);
1.242 albertel 2859: if ($target) { $target="target=\"$target\""; }
2860: return '<a href="/adm/parmset?&command=set&'.
2861: 'symb='.$symb.'&uname='.$uname.
2862: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 2863: }
2864: ##############################################
1.37 matthew 2865:
1.112 bowersj2 2866: =pod
2867:
2868: =back
2869:
2870: =cut
2871:
1.37 matthew 2872: ###############################################
1.51 www 2873:
2874:
2875: sub timehash {
2876: my @ltime=localtime(shift);
2877: return ( 'seconds' => $ltime[0],
2878: 'minutes' => $ltime[1],
2879: 'hours' => $ltime[2],
2880: 'day' => $ltime[3],
2881: 'month' => $ltime[4]+1,
2882: 'year' => $ltime[5]+1900,
2883: 'weekday' => $ltime[6],
2884: 'dayyear' => $ltime[7]+1,
2885: 'dlsav' => $ltime[8] );
2886: }
2887:
1.370 www 2888: sub utc_string {
2889: my ($date)=@_;
1.371 www 2890: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 2891: }
2892:
1.51 www 2893: sub maketime {
2894: my %th=@_;
2895: return POSIX::mktime(
2896: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 2897: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 2898: }
2899:
2900: #########################################
1.51 www 2901:
2902: sub findallcourses {
1.482 raeburn 2903: my ($roles,$uname,$udom) = @_;
1.355 albertel 2904: my %roles;
2905: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 2906: my %courses;
1.51 www 2907: my $now=time;
1.482 raeburn 2908: if (!defined($uname)) {
2909: $uname = $env{'user.name'};
2910: }
2911: if (!defined($udom)) {
2912: $udom = $env{'user.domain'};
2913: }
2914: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
2915: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
2916: if (!%roles) {
2917: %roles = (
2918: cc => 1,
2919: in => 1,
2920: ep => 1,
2921: ta => 1,
2922: cr => 1,
2923: st => 1,
2924: );
2925: }
2926: foreach my $entry (keys(%roleshash)) {
2927: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
2928: if ($trole =~ /^cr/) {
2929: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
2930: } else {
2931: next if (!exists($roles{$trole}));
2932: }
2933: if ($tend) {
2934: next if ($tend < $now);
2935: }
2936: if ($tstart) {
2937: next if ($tstart > $now);
2938: }
2939: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
2940: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
2941: if ($secpart eq '') {
2942: ($cnum,$role) = split(/_/,$cnumpart);
2943: $sec = 'none';
2944: $realsec = '';
2945: } else {
2946: $cnum = $cnumpart;
2947: ($sec,$role) = split(/_/,$secpart);
2948: $realsec = $sec;
1.490 raeburn 2949: }
1.482 raeburn 2950: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
2951: }
2952: } else {
2953: foreach my $key (keys(%env)) {
1.483 albertel 2954: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
2955: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 2956: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
2957: next if ($role eq 'ca' || $role eq 'aa');
2958: next if (%roles && !exists($roles{$role}));
2959: my ($starttime,$endtime)=split(/\./,$env{$key});
2960: my $active=1;
2961: if ($starttime) {
2962: if ($now<$starttime) { $active=0; }
2963: }
2964: if ($endtime) {
2965: if ($now>$endtime) { $active=0; }
2966: }
2967: if ($active) {
2968: if ($sec eq '') {
2969: $sec = 'none';
2970: }
2971: $courses{$cdom.'_'.$cnum}{$sec} =
2972: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 2973: }
2974: }
1.51 www 2975: }
2976: }
1.474 raeburn 2977: return %courses;
1.51 www 2978: }
1.37 matthew 2979:
1.54 www 2980: ###############################################
1.474 raeburn 2981:
2982: sub blockcheck {
1.482 raeburn 2983: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 2984:
2985: if (!defined($udom)) {
2986: $udom = $env{'user.domain'};
2987: }
2988: if (!defined($uname)) {
2989: $uname = $env{'user.name'};
2990: }
2991:
2992: # If uname and udom are for a course, check for blocks in the course.
2993:
2994: if (&Apache::lonnet::is_course($udom,$uname)) {
2995: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 2996: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 2997: return ($startblock,$endblock);
2998: }
1.474 raeburn 2999:
1.502 raeburn 3000: my $startblock = 0;
3001: my $endblock = 0;
1.482 raeburn 3002: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3003:
1.490 raeburn 3004: # If uname is for a user, and activity is course-specific, i.e.,
3005: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3006:
1.490 raeburn 3007: if (($activity eq 'boards' || $activity eq 'chat' ||
3008: $activity eq 'groups') && ($env{'request.course.id'})) {
3009: foreach my $key (keys(%live_courses)) {
3010: if ($key ne $env{'request.course.id'}) {
3011: delete($live_courses{$key});
3012: }
3013: }
3014: }
3015:
3016: my $otheruser = 0;
3017: my %own_courses;
3018: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3019: # Resource belongs to user other than current user.
3020: $otheruser = 1;
3021: # Gather courses for current user
3022: %own_courses =
3023: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3024: }
3025:
3026: # Gather active course roles - course coordinator, instructor,
3027: # exam proctor, ta, student, or custom role.
1.474 raeburn 3028:
3029: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3030: my ($cdom,$cnum);
3031: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3032: $cdom = $env{'course.'.$course.'.domain'};
3033: $cnum = $env{'course.'.$course.'.num'};
3034: } else {
1.490 raeburn 3035: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3036: }
3037: my $no_ownblock = 0;
3038: my $no_userblock = 0;
1.533 raeburn 3039: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3040: # Check if current user has 'evb' priv for this
3041: if (defined($own_courses{$course})) {
3042: foreach my $sec (keys(%{$own_courses{$course}})) {
3043: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3044: if ($sec ne 'none') {
3045: $checkrole .= '/'.$sec;
3046: }
3047: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3048: $no_ownblock = 1;
3049: last;
3050: }
3051: }
3052: }
3053: # if they have 'evb' priv and are currently not playing student
3054: next if (($no_ownblock) &&
3055: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3056: }
1.474 raeburn 3057: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3058: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3059: if ($sec ne 'none') {
1.482 raeburn 3060: $checkrole .= '/'.$sec;
1.474 raeburn 3061: }
1.490 raeburn 3062: if ($otheruser) {
3063: # Resource belongs to user other than current user.
3064: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3065: my ($trole,$tdom,$tnum,$tsec);
3066: my $entry = $live_courses{$course}{$sec};
3067: if ($entry =~ /^cr/) {
3068: ($trole,$tdom,$tnum,$tsec) =
3069: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3070: } else {
3071: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3072: }
3073: my ($spec,$area,$trest,%allroles,%userroles);
3074: $area = '/'.$tdom.'/'.$tnum;
3075: $trest = $tnum;
3076: if ($tsec ne '') {
3077: $area .= '/'.$tsec;
3078: $trest .= '/'.$tsec;
3079: }
3080: $spec = $trole.'.'.$area;
3081: if ($trole =~ /^cr/) {
3082: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3083: $tdom,$spec,$trest,$area);
3084: } else {
3085: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3086: $tdom,$spec,$trest,$area);
3087: }
3088: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3089: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3090: if ($1) {
3091: $no_userblock = 1;
3092: last;
3093: }
3094: }
1.490 raeburn 3095: } else {
3096: # Resource belongs to current user
3097: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3098: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3099: $no_ownblock = 1;
3100: last;
3101: }
1.474 raeburn 3102: }
3103: }
3104: # if they have the evb priv and are currently not playing student
1.482 raeburn 3105: next if (($no_ownblock) &&
1.491 albertel 3106: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3107: next if ($no_userblock);
1.474 raeburn 3108:
1.490 raeburn 3109: # Retrieve blocking times and identity of blocker for course
3110: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3111:
3112: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3113: if (($start != 0) &&
3114: (($startblock == 0) || ($startblock > $start))) {
3115: $startblock = $start;
3116: }
3117: if (($end != 0) &&
3118: (($endblock == 0) || ($endblock < $end))) {
3119: $endblock = $end;
3120: }
1.490 raeburn 3121: }
3122: return ($startblock,$endblock);
3123: }
3124:
3125: sub get_blocks {
3126: my ($setters,$activity,$cdom,$cnum) = @_;
3127: my $startblock = 0;
3128: my $endblock = 0;
3129: my $course = $cdom.'_'.$cnum;
3130: $setters->{$course} = {};
3131: $setters->{$course}{'staff'} = [];
3132: $setters->{$course}{'times'} = [];
3133: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3134: foreach my $record (keys(%records)) {
3135: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3136: if ($start <= time && $end >= time) {
3137: my ($staff_name,$staff_dom,$title,$blocks) =
3138: &parse_block_record($records{$record});
3139: if ($blocks->{$activity} eq 'on') {
3140: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3141: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3142: if ( ($startblock == 0) || ($startblock > $start) ) {
3143: $startblock = $start;
1.490 raeburn 3144: }
1.491 albertel 3145: if ( ($endblock == 0) || ($endblock < $end) ) {
3146: $endblock = $end;
1.474 raeburn 3147: }
3148: }
3149: }
3150: }
3151: return ($startblock,$endblock);
3152: }
3153:
3154: sub parse_block_record {
3155: my ($record) = @_;
3156: my ($setuname,$setudom,$title,$blocks);
3157: if (ref($record) eq 'HASH') {
3158: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3159: $title = &unescape($record->{'event'});
3160: $blocks = $record->{'blocks'};
3161: } else {
3162: my @data = split(/:/,$record,3);
3163: if (scalar(@data) eq 2) {
3164: $title = $data[1];
3165: ($setuname,$setudom) = split(/@/,$data[0]);
3166: } else {
3167: ($setuname,$setudom,$title) = @data;
3168: }
3169: $blocks = { 'com' => 'on' };
3170: }
3171: return ($setuname,$setudom,$title,$blocks);
3172: }
3173:
3174: sub build_block_table {
3175: my ($startblock,$endblock,$setters) = @_;
3176: my %lt = &Apache::lonlocal::texthash(
3177: 'cacb' => 'Currently active communication blocks',
3178: 'cour' => 'Course',
3179: 'dura' => 'Duration',
3180: 'blse' => 'Block set by'
3181: );
3182: my $output;
1.476 raeburn 3183: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3184: $output .= &start_data_table();
3185: $output .= '
3186: <tr>
3187: <th>'.$lt{'cour'}.'</th>
3188: <th>'.$lt{'dura'}.'</th>
3189: <th>'.$lt{'blse'}.'</th>
3190: </tr>
3191: ';
3192: foreach my $course (keys(%{$setters})) {
3193: my %courseinfo=&Apache::lonnet::coursedescription($course);
3194: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3195: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3196: my $fullname = &plainname($uname,$udom);
3197: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3198: && $env{'user.name'} ne 'public'
3199: && $env{'user.domain'} ne 'public') {
3200: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3201: }
1.474 raeburn 3202: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3203: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3204: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3205: $output .= &Apache::loncommon::start_data_table_row().
3206: '<td>'.$courseinfo{'description'}.'</td>'.
3207: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3208: '<td>'.$fullname.'</td>'.
1.474 raeburn 3209: &Apache::loncommon::end_data_table_row();
3210: }
3211: }
3212: $output .= &end_data_table();
3213: }
3214:
1.490 raeburn 3215: sub blocking_status {
3216: my ($activity,$uname,$udom) = @_;
3217: my %setters;
3218: my ($blocked,$output,$ownitem,$is_course);
3219: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3220: if ($startblock && $endblock) {
3221: $blocked = 1;
3222: if (wantarray) {
3223: my $category;
3224: if ($activity eq 'boards') {
3225: $category = 'Discussion posts in this course';
3226: } elsif ($activity eq 'blogs') {
3227: $category = 'Blogs';
3228: } elsif ($activity eq 'port') {
3229: if (defined($uname) && defined($udom)) {
3230: if ($uname eq $env{'user.name'} &&
3231: $udom eq $env{'user.domain'}) {
3232: $ownitem = 1;
3233: }
3234: }
3235: $is_course = &Apache::lonnet::is_course($udom,$uname);
3236: if ($ownitem) {
3237: $category = 'Your portfolio files';
3238: } elsif ($is_course) {
3239: my $coursedesc;
3240: foreach my $course (keys(%setters)) {
3241: my %courseinfo =
3242: &Apache::lonnet::coursedescription($course);
3243: $coursedesc = $courseinfo{'description'};
3244: }
3245: $category = "Group files in the course '$coursedesc'";
3246: } else {
3247: $category = 'Portfolio files belonging to ';
3248: if ($env{'user.name'} eq 'public' &&
3249: $env{'user.domain'} eq 'public') {
3250: $category .= &plainname($uname,$udom);
3251: } else {
3252: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3253: }
3254: }
3255: } elsif ($activity eq 'groups') {
3256: $category = 'Groups in this course';
3257: }
3258: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3259: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3260: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3261: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3262: $output .= &build_block_table($startblock,$endblock,\%setters);
3263: }
3264: }
3265: }
3266: if (wantarray) {
3267: return ($blocked,$output);
3268: } else {
3269: return $blocked;
3270: }
3271: }
3272:
1.60 matthew 3273: ###############################################
3274:
3275: =pod
3276:
1.112 bowersj2 3277: =head1 Domain Template Functions
3278:
3279: =over 4
3280:
3281: =item * &determinedomain()
1.60 matthew 3282:
3283: Inputs: $domain (usually will be undef)
3284:
1.63 www 3285: Returns: Determines which domain should be used for designs
1.60 matthew 3286:
3287: =cut
1.54 www 3288:
1.60 matthew 3289: ###############################################
1.63 www 3290: sub determinedomain {
3291: my $domain=shift;
1.531 albertel 3292: if (! $domain) {
1.60 matthew 3293: # Determine domain if we have not been given one
3294: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3295: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3296: if ($env{'request.role.domain'}) {
3297: $domain=$env{'request.role.domain'};
1.60 matthew 3298: }
3299: }
1.63 www 3300: return $domain;
3301: }
3302: ###############################################
1.517 raeburn 3303:
1.518 albertel 3304: sub devalidate_domconfig_cache {
3305: my ($udom)=@_;
3306: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3307: }
3308:
3309: # ---------------------- Get domain configuration for a domain
3310: sub get_domainconf {
3311: my ($udom) = @_;
3312: my $cachetime=1800;
3313: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3314: if (defined($cached)) { return %{$result}; }
3315:
3316: my %domconfig = &Apache::lonnet::get_dom('configuration',
3317: ['login','rolecolors'],$udom);
3318: my %designhash;
3319: if (keys(%domconfig) > 0) {
3320: if (ref($domconfig{'login'}) eq 'HASH') {
3321: foreach my $key (keys(%{$domconfig{'login'}})) {
3322: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3323: }
3324: }
3325: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
3326: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3327: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3328: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3329: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3330: }
3331: }
3332: }
3333: }
3334: } else {
3335: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3336: my $designfile = $designdir.'/'.$udom.'.tab';
3337: if (-e $designfile) {
3338: if ( open (my $fh,"<$designfile") ) {
3339: while (my $line = <$fh>) {
3340: next if ($line =~ /^\#/);
3341: chomp($line);
3342: my ($key,$val)=(split(/\=/,$line));
3343: if ($val) { $designhash{$udom.'.'.$key}=$val; }
3344: }
3345: close($fh);
3346: }
3347: }
3348: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
1.519 raeburn 3349: $designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
1.518 albertel 3350: }
3351: }
3352: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3353: $cachetime);
3354: return %designhash;
3355: }
3356:
1.63 www 3357: =pod
3358:
1.112 bowersj2 3359: =item * &domainlogo()
1.63 www 3360:
3361: Inputs: $domain (usually will be undef)
3362:
3363: Returns: A link to a domain logo, if the domain logo exists.
3364: If the domain logo does not exist, a description of the domain.
3365:
3366: =cut
1.112 bowersj2 3367:
1.63 www 3368: ###############################################
3369: sub domainlogo {
1.517 raeburn 3370: my $domain = &determinedomain(shift);
1.518 albertel 3371: my %designhash = &get_domainconf($domain);
1.517 raeburn 3372: # See if there is a logo
3373: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3374: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3375: if ($imgsrc =~ m{^/(adm|res)/}) {
3376: if ($imgsrc =~ m{^/res/}) {
3377: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3378: &Apache::lonnet::repcopy($local_name);
3379: }
3380: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3381: }
3382: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3383: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3384: return &Apache::lonnet::domain($domain,'description');
1.59 www 3385: } else {
1.60 matthew 3386: return '';
1.59 www 3387: }
3388: }
1.63 www 3389: ##############################################
3390:
3391: =pod
3392:
1.112 bowersj2 3393: =item * &designparm()
1.63 www 3394:
3395: Inputs: $which parameter; $domain (usually will be undef)
3396:
3397: Returns: value of designparamter $which
3398:
3399: =cut
1.112 bowersj2 3400:
1.397 albertel 3401:
1.400 albertel 3402: ##############################################
1.397 albertel 3403: sub designparm {
3404: my ($which,$domain)=@_;
1.258 albertel 3405: if ($env{'browser.blackwhite'} eq 'on') {
1.110 www 3406: if ($which=~/\.(font|alink|vlink|link)$/) {
3407: return '#000000';
3408: }
3409: if ($which=~/\.(pgbg|sidebg)$/) {
3410: return '#FFFFFF';
3411: }
3412: if ($which=~/\.tabbg$/) {
3413: return '#CCCCCC';
3414: }
3415: }
1.397 albertel 3416: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 3417: return $env{'environment.color.'.$which};
1.96 www 3418: }
1.63 www 3419: $domain=&determinedomain($domain);
1.518 albertel 3420: my %domdesign = &get_domainconf($domain);
1.520 raeburn 3421: my $output;
1.517 raeburn 3422: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 3423: $output = $domdesign{$domain.'.'.$which};
1.63 www 3424: } else {
1.520 raeburn 3425: $output = $defaultdesign{$which};
3426: }
3427: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
3428: ($which =~ /login\.(img|logo|domlogo)/)) {
1.538 albertel 3429: if ($output =~ m{^/(adm|res)/}) {
3430: if ($output =~ m{^/res/}) {
3431: my $local_name = &Apache::lonnet::filelocation('',$output);
3432: &Apache::lonnet::repcopy($local_name);
3433: }
1.520 raeburn 3434: $output = &lonhttpdurl($output);
3435: }
1.63 www 3436: }
1.520 raeburn 3437: return $output;
1.63 www 3438: }
1.59 www 3439:
1.60 matthew 3440: ###############################################
3441: ###############################################
3442:
3443: =pod
3444:
1.112 bowersj2 3445: =back
3446:
1.549 albertel 3447: =head1 HTML Helpers
1.112 bowersj2 3448:
3449: =over 4
3450:
3451: =item * &bodytag()
1.60 matthew 3452:
3453: Returns a uniform header for LON-CAPA web pages.
3454:
3455: Inputs:
3456:
1.112 bowersj2 3457: =over 4
3458:
3459: =item * $title, A title to be displayed on the page.
3460:
3461: =item * $function, the current role (can be undef).
3462:
3463: =item * $addentries, extra parameters for the <body> tag.
3464:
3465: =item * $bodyonly, if defined, only return the <body> tag.
3466:
3467: =item * $domain, if defined, force a given domain.
3468:
3469: =item * $forcereg, if page should register as content page (relevant for
1.86 www 3470: text interface only)
1.60 matthew 3471:
1.326 albertel 3472: =item * $customtitle, alternate text to use instead of $title
3473: in the title box that appears, this text
3474: is not auto translated like the $title is
1.309 albertel 3475:
3476: =item * $notopbar, if true, keep the 'what is this' info but remove the
3477: navigational links
1.317 albertel 3478:
1.338 albertel 3479: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
3480:
3481: =item * $notitle, if true keep the nav controls, but remove the title bar
3482:
1.361 albertel 3483: =item * $no_inline_link, if true and in remote mode, don't show the
3484: 'Switch To Inline Menu' link
3485:
1.460 albertel 3486: =item * $args, optional argument valid values are
3487: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 3488: inherit_jsmath -> when creating popup window in a page,
3489: should it have jsmath forced on by the
3490: current page
1.460 albertel 3491:
1.112 bowersj2 3492: =back
3493:
1.60 matthew 3494: Returns: A uniform header for LON-CAPA web pages.
3495: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
3496: If $bodyonly is undef or zero, an html string containing a <body> tag and
3497: other decorations will be returned.
3498:
3499: =cut
3500:
1.54 www 3501: sub bodytag {
1.309 albertel 3502: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 3503: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 3504:
1.460 albertel 3505: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 3506:
1.183 matthew 3507: $function = &get_users_function() if (!$function);
1.339 albertel 3508: my $img = &designparm($function.'.img',$domain);
3509: my $font = &designparm($function.'.font',$domain);
3510: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
3511:
3512: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 3513: 'bgcolor' => $pgbg,
1.339 albertel 3514: 'text' => $font,
3515: 'alink' => &designparm($function.'.alink',$domain),
3516: 'vlink' => &designparm($function.'.vlink',$domain),
3517: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 3518: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 3519:
1.63 www 3520: # role and realm
1.378 raeburn 3521: my ($role,$realm) = split(/\./,$env{'request.role'},2);
3522: if ($role eq 'ca') {
1.479 albertel 3523: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 3524: $realm = &plainname($rname,$rdom);
1.378 raeburn 3525: }
1.55 www 3526: # realm
1.258 albertel 3527: if ($env{'request.course.id'}) {
1.378 raeburn 3528: if ($env{'request.role'} !~ /^cr/) {
3529: $role = &Apache::lonnet::plaintext($role,&course_type());
3530: }
1.359 albertel 3531: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 3532: } else {
3533: $role = &Apache::lonnet::plaintext($role);
1.54 www 3534: }
1.433 albertel 3535:
1.359 albertel 3536: if (!$realm) { $realm=' '; }
1.55 www 3537: # Set messages
1.60 matthew 3538: my $messages=&domainlogo($domain);
1.330 albertel 3539:
1.438 albertel 3540: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 3541:
1.101 www 3542: # construct main body tag
1.359 albertel 3543: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 3544: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 3545:
1.530 albertel 3546: if ($bodyonly) {
1.60 matthew 3547: return $bodytag;
1.258 albertel 3548: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 3549: # Accessibility
1.224 raeburn 3550:
1.337 albertel 3551: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 3552: if (!$notitle) {
1.337 albertel 3553: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
3554: }
3555: return $bodytag;
1.359 albertel 3556: }
3557:
1.410 albertel 3558: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 3559: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3560: undef($role);
1.434 albertel 3561: } else {
3562: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 3563: }
1.359 albertel 3564:
3565: my $roleinfo=(<<ENDROLE);
3566: <td class="LC_title_bar_who">
3567: <div class="LC_title_bar_name">
1.410 albertel 3568: $name
1.361 albertel 3569:
1.359 albertel 3570: </div>
3571: <div class="LC_title_bar_role">
1.361 albertel 3572: $role
1.359 albertel 3573: </div>
3574: <div class="LC_title_bar_realm">
1.361 albertel 3575: $realm
1.359 albertel 3576: </div>
1.206 albertel 3577: </td>
3578: ENDROLE
1.235 raeburn 3579:
1.359 albertel 3580: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
3581: if ($customtitle) {
3582: $titleinfo = $customtitle;
3583: }
3584: #
3585: # Extra info if you are the DC
3586: my $dc_info = '';
3587: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
3588: $env{'course.'.$env{'request.course.id'}.
3589: '.domain'}.'/'})) {
3590: my $cid = $env{'request.course.id'};
3591: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 3592: $dc_info =~ s/\s+$//;
1.359 albertel 3593: $dc_info = '('.$dc_info.')';
3594: }
3595:
3596: if ($env{'environment.remote'} eq 'off') {
3597: # No Remote
1.258 albertel 3598: if ($env{'request.state'} eq 'construct') {
1.359 albertel 3599: $forcereg=1;
3600: }
3601:
3602: if (!$customtitle && $env{'request.state'} eq 'construct') {
3603: # this is for resources; directories have customtitle, and crumbs
3604: # and select recent are created in lonpubdir.pm
1.229 albertel 3605: my ($uname,$thisdisfn)=
1.258 albertel 3606: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 3607: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
3608: $formaction=~s/\/+/\//g;
3609:
1.359 albertel 3610: my $parentpath = '';
3611: my $lastitem = '';
3612: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
3613: $parentpath = $1;
3614: $lastitem = $2;
3615: } else {
3616: $lastitem = $thisdisfn;
3617: }
3618: $titleinfo =
1.401 albertel 3619: &Apache::loncommon::help_open_menu('','',3,'Authoring').
1.359 albertel 3620: '<b>Construction Space</b>: '.
3621: '<form name="dirs" method="post" action="'.$formaction
3622: .'" target="_top"><tt><b>'
3623: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
3624: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
3625: .'</form>'
3626: .&Apache::lonmenu::constspaceform();
1.235 raeburn 3627: }
1.359 albertel 3628:
1.337 albertel 3629: my $titletable;
1.338 albertel 3630: if (!$notitle) {
1.337 albertel 3631: $titletable =
1.359 albertel 3632: '<table id="LC_title_bar">'.
3633: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
3634: '</tr></table>';
1.337 albertel 3635: }
1.359 albertel 3636: if ($notopbar) {
3637: $bodytag .= $titletable;
3638: } else {
3639: if ($env{'request.state'} eq 'construct') {
1.337 albertel 3640: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
3641: $titletable);
1.272 raeburn 3642: } else {
1.336 albertel 3643: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 3644: $titletable;
1.272 raeburn 3645: }
1.235 raeburn 3646: }
3647: return $bodytag;
1.94 www 3648: }
1.95 www 3649:
1.93 www 3650: #
1.95 www 3651: # Top frame rendering, Remote is up
1.93 www 3652: #
1.359 albertel 3653:
1.517 raeburn 3654: my $imgsrc = $img;
3655: if ($img =~ /^\/adm/) {
1.575 albertel 3656: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 3657: }
3658: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 3659:
1.305 www 3660: # Explicit link to get inline menu
1.361 albertel 3661: my $menu= ($no_inline_link?''
3662: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 3663: #
1.338 albertel 3664: if ($notitle) {
1.337 albertel 3665: return $bodytag;
3666: }
1.94 www 3667: return(<<ENDBODY);
1.60 matthew 3668: $bodytag
1.359 albertel 3669: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 3670: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 3671: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 3672: </tr>
1.359 albertel 3673: <tr><td>$titleinfo $dc_info $menu</td>
3674: $roleinfo
1.368 albertel 3675: </tr>
1.356 albertel 3676: </table>
1.54 www 3677: ENDBODY
1.182 matthew 3678: }
3679:
1.330 albertel 3680: sub make_attr_string {
3681: my ($register,$attr_ref) = @_;
3682:
3683: if ($attr_ref && !ref($attr_ref)) {
3684: die("addentries Must be a hash ref ".
3685: join(':',caller(1))." ".
3686: join(':',caller(0))." ");
3687: }
3688:
3689: if ($register) {
1.339 albertel 3690: my ($on_load,$on_unload);
3691: foreach my $key (keys(%{$attr_ref})) {
3692: if (lc($key) eq 'onload') {
3693: $on_load.=$attr_ref->{$key}.';';
3694: delete($attr_ref->{$key});
3695:
3696: } elsif (lc($key) eq 'onunload') {
3697: $on_unload.=$attr_ref->{$key}.';';
3698: delete($attr_ref->{$key});
3699: }
3700: }
3701: $attr_ref->{'onload'} =
3702: &Apache::lonmenu::loadevents(). $on_load;
3703: $attr_ref->{'onunload'}=
3704: &Apache::lonmenu::unloadevents().$on_unload;
3705: }
3706:
3707: # Accessibility font enhance
3708: if ($env{'browser.fontenhance'} eq 'on') {
3709: my $style;
3710: foreach my $key (keys(%{$attr_ref})) {
3711: if (lc($key) eq 'style') {
3712: $style.=$attr_ref->{$key}.';';
3713: delete($attr_ref->{$key});
3714: }
3715: }
3716: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 3717: }
1.339 albertel 3718:
3719: if ($env{'browser.blackwhite'} eq 'on') {
3720: delete($attr_ref->{'font'});
3721: delete($attr_ref->{'link'});
3722: delete($attr_ref->{'alink'});
3723: delete($attr_ref->{'vlink'});
3724: delete($attr_ref->{'bgcolor'});
3725: delete($attr_ref->{'background'});
3726: }
3727:
1.330 albertel 3728: my $attr_string;
3729: foreach my $attr (keys(%$attr_ref)) {
3730: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
3731: }
3732: return $attr_string;
3733: }
3734:
3735:
1.182 matthew 3736: ###############################################
1.251 albertel 3737: ###############################################
3738:
3739: =pod
3740:
3741: =item * &endbodytag()
3742:
3743: Returns a uniform footer for LON-CAPA web pages.
3744:
1.306 albertel 3745: Inputs: none
1.251 albertel 3746:
3747: =cut
3748:
3749: sub endbodytag {
3750: my $endbodytag='</body>';
1.269 albertel 3751: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 3752: if ( exists( $env{'internal.head.redirect'} ) ) {
3753: $endbodytag=
3754: "<br /><a href=\"$env{'internal.head.redirect'}\">".
3755: &mt('Continue').'</a>'.
3756: $endbodytag;
3757: }
1.251 albertel 3758: return $endbodytag;
3759: }
3760:
1.352 albertel 3761: =pod
3762:
3763: =item * &standard_css()
3764:
3765: Returns a style sheet
3766:
3767: Inputs: (all optional)
3768: domain -> force to color decorate a page for a specific
3769: domain
3770: function -> force usage of a specific rolish color scheme
3771: bgcolor -> override the default page bgcolor
3772:
3773: =cut
3774:
1.343 albertel 3775: sub standard_css {
1.345 albertel 3776: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 3777: $function = &get_users_function() if (!$function);
3778: my $img = &designparm($function.'.img', $domain);
3779: my $tabbg = &designparm($function.'.tabbg', $domain);
3780: my $font = &designparm($function.'.font', $domain);
1.345 albertel 3781: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 3782: my $pgbg_or_bgcolor =
3783: $bgcolor ||
1.352 albertel 3784: &designparm($function.'.pgbg', $domain);
1.382 albertel 3785: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 3786: my $alink = &designparm($function.'.alink', $domain);
3787: my $vlink = &designparm($function.'.vlink', $domain);
3788: my $link = &designparm($function.'.link', $domain);
3789:
3790: my $sans = 'Arial,Helvetica,sans-serif';
1.395 albertel 3791: my $mono = 'monospace';
1.352 albertel 3792: my $data_table_head = $tabbg;
3793: my $data_table_light = '#EEEEEE';
1.470 banghart 3794: my $data_table_dark = '#DDDDDD';
3795: my $data_table_darker = '#CCCCCC';
1.349 albertel 3796: my $data_table_highlight = '#FFFF00';
1.352 albertel 3797: my $mail_new = '#FFBB77';
3798: my $mail_new_hover = '#DD9955';
3799: my $mail_read = '#BBBB77';
3800: my $mail_read_hover = '#999944';
3801: my $mail_replied = '#AAAA88';
3802: my $mail_replied_hover = '#888855';
3803: my $mail_other = '#99BBBB';
3804: my $mail_other_hover = '#669999';
1.391 albertel 3805: my $table_header = '#DDDDDD';
1.489 raeburn 3806: my $feedback_link_bg = '#BBBBBB';
1.392 albertel 3807:
3808: my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
3809: : '0px 3px 0px 4px';
1.448 albertel 3810:
1.523 albertel 3811:
1.343 albertel 3812: return <<END;
1.345 albertel 3813: h1, h2, h3, th { font-family: $sans }
1.343 albertel 3814: a:focus { color: red; background: yellow }
1.510 albertel 3815: table.thinborder,
1.523 albertel 3816:
1.510 albertel 3817: table.thinborder tr th {
3818: border-style: solid;
3819: border-width: 1px;
3820: background: $tabbg;
3821: }
1.523 albertel 3822: table.thinborder tr td {
1.510 albertel 3823: border-style: solid;
3824: border-width: 1px
3825: }
1.426 albertel 3826:
1.343 albertel 3827: form, .inline { display: inline; }
3828: .center { text-align: center; }
1.395 albertel 3829: .LC_filename {font-family: $mono;}
1.350 albertel 3830: .LC_error {
3831: color: red;
3832: font-size: larger;
3833: }
1.457 albertel 3834: .LC_warning,
3835: .LC_diff_removed {
1.394 albertel 3836: color: red;
3837: }
1.532 albertel 3838:
3839: .LC_info,
1.457 albertel 3840: .LC_success,
3841: .LC_diff_added {
1.350 albertel 3842: color: green;
3843: }
1.543 albertel 3844: .LC_unknown {
3845: color: yellow;
3846: }
3847:
1.440 albertel 3848: .LC_icon {
3849: border: 0px;
3850: }
1.539 albertel 3851: .LC_indexer_icon {
3852: border: 0px;
3853: height: 22px;
3854: }
1.543 albertel 3855: .LC_docs_spacer {
3856: width: 25px;
3857: height: 1px;
3858: border: 0px;
3859: }
1.346 albertel 3860:
1.532 albertel 3861: .LC_internal_info {
3862: color: #999;
3863: }
3864:
1.458 albertel 3865: table.LC_pastsubmission {
3866: border: 1px solid black;
3867: margin: 2px;
3868: }
3869:
1.392 albertel 3870: table#LC_top_nav, table#LC_menubuttons {
1.345 albertel 3871: width: 100%;
3872: background: $pgbg;
1.392 albertel 3873: border: 2px;
1.402 albertel 3874: border-collapse: separate;
1.403 albertel 3875: padding: 0px;
1.345 albertel 3876: }
1.392 albertel 3877:
1.409 albertel 3878: table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,
1.393 albertel 3879: table#LC_title_bar.LC_with_remote {
1.359 albertel 3880: width: 100%;
1.392 albertel 3881: border-color: $pgbg;
3882: border-style: solid;
3883: border-width: $border;
3884:
1.379 albertel 3885: background: $pgbg;
3886: font-family: $sans;
1.392 albertel 3887: border-collapse: collapse;
1.403 albertel 3888: padding: 0px;
1.359 albertel 3889: }
1.392 albertel 3890:
1.409 albertel 3891: table.LC_docs_path {
3892: width: 100%;
3893: border: 0;
3894: background: $pgbg;
3895: font-family: $sans;
3896: border-collapse: collapse;
3897: padding: 0px;
3898: }
3899:
1.359 albertel 3900: table#LC_title_bar td {
3901: background: $tabbg;
3902: }
3903: table#LC_title_bar td.LC_title_bar_who {
3904: background: $tabbg;
3905: color: $font;
1.427 albertel 3906: font: small $sans;
1.359 albertel 3907: text-align: right;
3908: }
1.469 banghart 3909: span.LC_metadata {
3910: font-family: $sans;
3911: }
1.359 albertel 3912: span.LC_title_bar_title {
1.416 albertel 3913: font: bold x-large $sans;
1.359 albertel 3914: }
3915: table#LC_title_bar td.LC_title_bar_domain_logo {
3916: background: $sidebg;
3917: text-align: right;
1.368 albertel 3918: padding: 0px;
3919: }
3920: table#LC_title_bar td.LC_title_bar_role_logo {
3921: background: $sidebg;
3922: padding: 0px;
1.359 albertel 3923: }
3924:
1.346 albertel 3925: table#LC_menubuttons_mainmenu {
1.526 www 3926: width: 100%;
1.346 albertel 3927: border: 0px;
3928: border-spacing: 1px;
1.372 albertel 3929: padding: 0px 1px;
1.346 albertel 3930: margin: 0px;
3931: border-collapse: separate;
3932: }
3933: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
3934: border: 0px;
3935: }
1.345 albertel 3936: table#LC_top_nav td {
3937: background: $tabbg;
1.392 albertel 3938: border: 0px;
1.407 albertel 3939: font-size: small;
1.345 albertel 3940: }
3941: table#LC_top_nav td a, div#LC_top_nav a {
3942: color: $font;
3943: font-family: $sans;
3944: }
1.364 albertel 3945: table#LC_top_nav td.LC_top_nav_logo {
3946: background: $tabbg;
1.432 albertel 3947: text-align: left;
1.408 albertel 3948: white-space: nowrap;
1.432 albertel 3949: width: 31px;
1.408 albertel 3950: }
3951: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 3952: border: 0px;
1.408 albertel 3953: vertical-align: bottom;
1.364 albertel 3954: }
1.432 albertel 3955: table#LC_top_nav td.LC_top_nav_exit,
3956: table#LC_top_nav td.LC_top_nav_help {
3957: width: 2.0em;
3958: }
1.442 albertel 3959: table#LC_top_nav td.LC_top_nav_login {
3960: width: 4.0em;
3961: text-align: center;
3962: }
1.409 albertel 3963: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 3964: background: $tabbg;
3965: color: $font;
3966: font-family: $sans;
1.358 albertel 3967: font-size: smaller;
1.357 albertel 3968: }
1.411 albertel 3969: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 3970: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 3971: background: $tabbg;
3972: color: $font;
3973: font-family: $sans;
3974: font-size: larger;
3975: text-align: right;
3976: }
1.383 albertel 3977: td.LC_table_cell_checkbox {
3978: text-align: center;
3979: }
3980:
1.522 albertel 3981: table#LC_mainmenu td.LC_mainmenu_column {
3982: vertical-align: top;
3983: }
3984:
1.346 albertel 3985: .LC_menubuttons_inline_text {
3986: color: $font;
3987: font-family: $sans;
3988: font-size: smaller;
3989: }
3990:
1.526 www 3991: .LC_menubuttons_link {
3992: text-decoration: none;
3993: }
3994:
1.522 albertel 3995: .LC_menubuttons_category {
1.521 www 3996: color: $font;
1.526 www 3997: background: $pgbg;
1.521 www 3998: font-family: $sans;
3999: font-size: larger;
4000: font-weight: bold;
4001: }
4002:
1.346 albertel 4003: td.LC_menubuttons_text {
1.526 www 4004: width: 90%;
1.346 albertel 4005: color: $font;
4006: font-family: $sans;
4007: }
1.526 www 4008:
1.346 albertel 4009: td.LC_menubuttons_img {
4010: }
1.526 www 4011:
1.346 albertel 4012: .LC_current_location {
4013: font-family: $sans;
4014: background: $tabbg;
4015: }
4016: .LC_new_mail {
4017: font-family: $sans;
4018: font-weight: bold;
4019: }
1.347 albertel 4020:
1.526 www 4021: .LC_rolesmenu_is {
4022: font-family: $sans;
4023: }
4024:
4025: .LC_rolesmenu_selected {
4026: font-family: $sans;
4027: }
4028:
4029: .LC_rolesmenu_future {
4030: font-family: $sans;
4031: }
4032:
4033:
4034: .LC_rolesmenu_will {
4035: font-family: $sans;
4036: }
4037:
4038: .LC_rolesmenu_will_not {
4039: font-family: $sans;
4040: }
4041:
4042: .LC_rolesmenu_expired {
4043: font-family: $sans;
4044: }
4045:
4046: .LC_rolesinfo {
4047: font-family: $sans;
4048: }
4049:
1.527 www 4050: .LC_dropadd_labeltext {
4051: font-family: $sans;
4052: text-align: right;
4053: }
4054:
4055: .LC_preferences_labeltext {
4056: font-family: $sans;
4057: text-align: right;
4058: }
4059:
1.440 albertel 4060: table.LC_aboutme_port {
4061: border: 0px;
4062: border-collapse: collapse;
4063: border-spacing: 0px;
4064: }
1.349 albertel 4065: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4066: border: 1px solid #000000;
1.402 albertel 4067: border-collapse: separate;
1.426 albertel 4068: border-spacing: 1px;
1.347 albertel 4069: }
1.422 albertel 4070: .LC_data_table_dense {
4071: font-size: small;
4072: }
1.507 raeburn 4073: table.LC_nested_outer {
4074: border: 1px solid #000000;
4075: border-collapse: separate;
4076: border-spacing: 0px;
4077: width: 100%;
4078: }
4079: table.LC_nested {
4080: border: 0px;
4081: border-collapse: separate;
4082: border-spacing: 0px;
4083: width: 100%;
4084: }
1.523 albertel 4085: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4086: table.LC_prior_tries tr th {
1.349 albertel 4087: font-weight: bold;
4088: background-color: $data_table_head;
1.421 albertel 4089: font-size: smaller;
1.347 albertel 4090: }
1.440 albertel 4091: table.LC_data_table tr td,
4092: table.LC_aboutme_port tr td {
1.349 albertel 4093: background-color: $data_table_light;
1.425 albertel 4094: padding: 2px;
1.347 albertel 4095: }
1.440 albertel 4096: table.LC_data_table tr.LC_even_row td,
4097: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4098: background-color: $data_table_dark;
1.347 albertel 4099: }
1.425 albertel 4100: table.LC_data_table tr.LC_data_table_highlight td {
4101: background-color: $data_table_darker;
4102: }
1.451 albertel 4103: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4104: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4105: background-color: #FFFFFF;
1.421 albertel 4106: font-weight: bold;
4107: font-style: italic;
4108: text-align: center;
4109: padding: 8px;
1.347 albertel 4110: }
1.507 raeburn 4111: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4112: padding: 4ex
4113: }
1.507 raeburn 4114: table.LC_nested_outer tr th {
4115: font-weight: bold;
4116: background-color: $data_table_head;
4117: font-size: smaller;
4118: border-bottom: 1px solid #000000;
4119: }
4120: table.LC_nested_outer tr td.LC_subheader {
4121: background-color: $data_table_head;
4122: font-weight: bold;
4123: font-size: small;
4124: border-bottom: 1px solid #000000;
4125: text-align: right;
1.451 albertel 4126: }
1.507 raeburn 4127: table.LC_nested tr.LC_info_row td {
1.451 albertel 4128: background-color: #CCC;
4129: font-weight: bold;
4130: font-size: small;
1.507 raeburn 4131: text-align: center;
4132: }
4133: table.LC_nested tr.LC_info_row td.LC_left_item {
4134: text-align: left;
1.451 albertel 4135: }
1.507 raeburn 4136: table.LC_nested td {
1.451 albertel 4137: background-color: #FFF;
4138: font-size: small;
1.507 raeburn 4139: }
4140: table.LC_nested_outer tr th.LC_right_item,
4141: table.LC_nested tr.LC_info_row td.LC_right_item,
4142: table.LC_nested tr.LC_odd_row td.LC_right_item,
4143: table.LC_nested tr td.LC_right_item {
1.451 albertel 4144: text-align: right;
4145: }
4146:
1.507 raeburn 4147: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4148: background-color: #EEE;
4149: }
4150:
1.473 raeburn 4151: table.LC_createuser {
4152: }
4153:
4154: table.LC_createuser tr.LC_section_row td {
4155: font-size: smaller;
4156: }
4157:
4158: table.LC_createuser tr.LC_info_row td {
4159: background-color: #CCC;
4160: font-weight: bold;
4161: text-align: center;
4162: }
4163:
1.349 albertel 4164: table.LC_calendar {
4165: border: 1px solid #000000;
4166: border-collapse: collapse;
4167: }
4168: table.LC_calendar_pickdate {
4169: font-size: xx-small;
4170: }
4171: table.LC_calendar tr td {
4172: border: 1px solid #000000;
4173: vertical-align: top;
4174: }
4175: table.LC_calendar tr td.LC_calendar_day_empty {
4176: background-color: $data_table_dark;
4177: }
4178: table.LC_calendar tr td.LC_calendar_day_current {
4179: background-color: $data_table_highlight;
4180: }
4181:
4182: table.LC_mail_list tr.LC_mail_new {
4183: background-color: $mail_new;
4184: }
4185: table.LC_mail_list tr.LC_mail_new:hover {
4186: background-color: $mail_new_hover;
4187: }
4188: table.LC_mail_list tr.LC_mail_read {
4189: background-color: $mail_read;
4190: }
4191: table.LC_mail_list tr.LC_mail_read:hover {
4192: background-color: $mail_read_hover;
4193: }
4194: table.LC_mail_list tr.LC_mail_replied {
4195: background-color: $mail_replied;
4196: }
4197: table.LC_mail_list tr.LC_mail_replied:hover {
4198: background-color: $mail_replied_hover;
4199: }
4200: table.LC_mail_list tr.LC_mail_other {
4201: background-color: $mail_other;
4202: }
4203: table.LC_mail_list tr.LC_mail_other:hover {
4204: background-color: $mail_other_hover;
4205: }
1.494 raeburn 4206: table.LC_mail_list tr.LC_mail_even {
4207: }
4208: table.LC_mail_list tr.LC_mail_odd {
4209: }
4210:
1.385 albertel 4211:
1.386 albertel 4212: table#LC_portfolio_actions {
4213: width: auto;
4214: background: $pgbg;
4215: border: 0px;
4216: border-spacing: 2px 2px;
4217: padding: 0px;
4218: margin: 0px;
4219: border-collapse: separate;
4220: }
4221: table#LC_portfolio_actions td.LC_label {
4222: background: $tabbg;
4223: text-align: right;
4224: }
4225: table#LC_portfolio_actions td.LC_value {
4226: background: $tabbg;
4227: }
1.385 albertel 4228:
1.391 albertel 4229: table#LC_cstr_controls {
4230: width: 100%;
4231: border-collapse: collapse;
4232: }
4233: table#LC_cstr_controls tr td {
4234: border: 4px solid $pgbg;
4235: padding: 4px;
4236: text-align: center;
4237: background: $tabbg;
4238: }
4239: table#LC_cstr_controls tr th {
4240: border: 4px solid $pgbg;
4241: background: $table_header;
4242: text-align: center;
4243: font-family: $sans;
4244: font-size: smaller;
4245: }
4246:
1.389 albertel 4247: table#LC_browser {
4248:
4249: }
4250: table#LC_browser tr th {
1.391 albertel 4251: background: $table_header;
1.389 albertel 4252: }
1.390 albertel 4253: table#LC_browser tr td {
4254: padding: 2px;
4255: }
1.389 albertel 4256: table#LC_browser tr.LC_browser_file,
4257: table#LC_browser tr.LC_browser_file_published {
4258: background: #CCFF88;
4259: }
4260: table#LC_browser tr.LC_browser_file_locked,
4261: table#LC_browser tr.LC_browser_file_unpublished {
4262: background: #FFAA99;
1.387 albertel 4263: }
1.389 albertel 4264: table#LC_browser tr.LC_browser_file_obsolete {
4265: background: #AAAAAA;
1.387 albertel 4266: }
1.455 albertel 4267: table#LC_browser tr.LC_browser_file_modified,
4268: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 4269: background: #FFFF77;
1.387 albertel 4270: }
1.389 albertel 4271: table#LC_browser tr.LC_browser_folder {
4272: background: #CCCCFF;
1.387 albertel 4273: }
1.388 albertel 4274: span.LC_current_location {
4275: font-size: x-large;
4276: background: $pgbg;
4277: }
1.387 albertel 4278:
1.395 albertel 4279: span.LC_parm_menu_item {
4280: font-size: larger;
4281: font-family: $sans;
4282: }
4283: span.LC_parm_scope_all {
4284: color: red;
4285: }
4286: span.LC_parm_scope_folder {
4287: color: green;
4288: }
4289: span.LC_parm_scope_resource {
4290: color: orange;
4291: }
4292: span.LC_parm_part {
4293: color: blue;
4294: }
4295: span.LC_parm_folder, span.LC_parm_symb {
4296: font-size: x-small;
4297: font-family: $mono;
4298: color: #AAAAAA;
4299: }
4300:
1.396 albertel 4301: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4302: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4303: border: 1px solid black;
4304: border-collapse: collapse;
4305: }
4306: table.LC_parm_overview_restrictions td {
4307: border-width: 1px 4px 1px 4px;
4308: border-style: solid;
4309: border-color: $pgbg;
4310: text-align: center;
4311: }
4312: table.LC_parm_overview_restrictions th {
4313: background: $tabbg;
4314: border-width: 1px 4px 1px 4px;
4315: border-style: solid;
4316: border-color: $pgbg;
4317: }
1.398 albertel 4318: table#LC_helpmenu {
4319: border: 0px;
4320: height: 55px;
4321: border-spacing: 0px;
4322: }
4323:
4324: table#LC_helpmenu fieldset legend {
4325: font-size: larger;
4326: font-weight: bold;
4327: }
1.397 albertel 4328: table#LC_helpmenu_links {
4329: width: 100%;
4330: border: 1px solid black;
4331: background: $pgbg;
4332: padding: 0px;
4333: border-spacing: 1px;
4334: }
4335: table#LC_helpmenu_links tr td {
4336: padding: 1px;
4337: background: $tabbg;
1.399 albertel 4338: text-align: center;
4339: font-weight: bold;
1.397 albertel 4340: }
1.396 albertel 4341:
1.397 albertel 4342: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4343: table#LC_helpmenu_links a:active {
4344: text-decoration: none;
4345: color: $font;
4346: }
4347: table#LC_helpmenu_links a:hover {
4348: text-decoration: underline;
4349: color: $vlink;
4350: }
1.396 albertel 4351:
1.417 albertel 4352: .LC_chrt_popup_exists {
4353: border: 1px solid #339933;
4354: margin: -1px;
4355: }
4356: .LC_chrt_popup_up {
4357: border: 1px solid yellow;
4358: margin: -1px;
4359: }
4360: .LC_chrt_popup {
4361: border: 1px solid #8888FF;
4362: background: #CCCCFF;
4363: }
1.421 albertel 4364: table.LC_pick_box {
4365: border-collapse: separate;
4366: background: white;
4367: border: 1px solid black;
4368: border-spacing: 1px;
4369: }
4370: table.LC_pick_box td.LC_pick_box_title {
4371: background: $tabbg;
4372: font-weight: bold;
4373: text-align: right;
4374: width: 184px;
4375: padding: 8px;
4376: }
1.579 raeburn 4377: table.LC_pick_box td.LC_pick_box_value {
4378: text-align: left;
4379: padding: 8px;
4380: }
4381: table.LC_pick_box td.LC_pick_box_select {
4382: text-align: left;
4383: padding: 8px;
4384: }
1.424 albertel 4385: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 4386: padding: 0px;
4387: height: 1px;
4388: background: black;
4389: }
4390: table.LC_pick_box td.LC_pick_box_submit {
4391: text-align: right;
4392: }
1.579 raeburn 4393: table.LC_pick_box td.LC_evenrow_value {
4394: text-align: left;
4395: padding: 8px;
4396: background-color: $data_table_light;
4397: }
4398: table.LC_pick_box td.LC_oddrow_value {
4399: text-align: left;
4400: padding: 8px;
4401: background-color: $data_table_light;
4402: }
4403: table.LC_helpform_receipt {
4404: width: 620px;
4405: border-collapse: separate;
4406: background: white;
4407: border: 1px solid black;
4408: border-spacing: 1px;
4409: }
4410: table.LC_helpform_receipt td.LC_pick_box_title {
4411: background: $tabbg;
4412: font-weight: bold;
4413: text-align: right;
4414: width: 184px;
4415: padding: 8px;
4416: }
4417: table.LC_helpform_receipt td.LC_evenrow_value {
4418: text-align: left;
4419: padding: 8px;
4420: background-color: $data_table_light;
4421: }
4422: table.LC_helpform_receipt td.LC_oddrow_value {
4423: text-align: left;
4424: padding: 8px;
4425: background-color: $data_table_light;
4426: }
4427: table.LC_helpform_receipt td.LC_pick_box_separator {
4428: padding: 0px;
4429: height: 1px;
4430: background: black;
4431: }
4432: span.LC_helpform_receipt_cat {
4433: font-weight: bold;
4434: }
1.424 albertel 4435: table.LC_group_priv_box {
4436: background: white;
4437: border: 1px solid black;
4438: border-spacing: 1px;
4439: }
4440: table.LC_group_priv_box td.LC_pick_box_title {
4441: background: $tabbg;
4442: font-weight: bold;
4443: text-align: right;
4444: width: 184px;
4445: }
4446: table.LC_group_priv_box td.LC_groups_fixed {
4447: background: $data_table_light;
4448: text-align: center;
4449: }
4450: table.LC_group_priv_box td.LC_groups_optional {
4451: background: $data_table_dark;
4452: text-align: center;
4453: }
4454: table.LC_group_priv_box td.LC_groups_functionality {
4455: background: $data_table_darker;
4456: text-align: center;
4457: font-weight: bold;
4458: }
4459: table.LC_group_priv td {
4460: text-align: left;
4461: padding: 0px;
4462: }
4463:
1.421 albertel 4464: table.LC_notify_front_page {
4465: background: white;
4466: border: 1px solid black;
4467: padding: 8px;
4468: }
4469: table.LC_notify_front_page td {
4470: padding: 8px;
4471: }
1.424 albertel 4472: .LC_navbuttons {
4473: margin: 2ex 0ex 2ex 0ex;
4474: }
1.423 albertel 4475: .LC_topic_bar {
4476: font-family: $sans;
4477: font-weight: bold;
4478: width: 100%;
4479: background: $tabbg;
4480: vertical-align: middle;
4481: margin: 2ex 0ex 2ex 0ex;
4482: }
4483: .LC_topic_bar span {
4484: vertical-align: middle;
4485: }
4486: .LC_topic_bar img {
4487: vertical-align: bottom;
4488: }
4489: table.LC_course_group_status {
4490: margin: 20px;
4491: }
4492: table.LC_status_selector td {
4493: vertical-align: top;
4494: text-align: center;
1.424 albertel 4495: padding: 4px;
4496: }
4497: table.LC_descriptive_input td.LC_description {
4498: vertical-align: top;
4499: text-align: right;
4500: font-weight: bold;
1.423 albertel 4501: }
1.489 raeburn 4502: table.LC_feedback_link {
4503: background: $feedback_link_bg;
4504: }
4505: span.LC_feedback_link {
4506: background: $feedback_link_bg;
4507: font-size: larger;
4508: }
1.421 albertel 4509:
1.515 albertel 4510: table.LC_prior_tries {
1.524 albertel 4511: border: 1px solid #000000;
4512: border-collapse: separate;
4513: border-spacing: 1px;
1.515 albertel 4514: }
1.523 albertel 4515:
1.515 albertel 4516: table.LC_prior_tries td {
1.524 albertel 4517: padding: 2px;
1.515 albertel 4518: }
1.523 albertel 4519:
4520: .LC_answer_correct {
4521: background: #AAFFAA;
4522: color: black;
4523: }
4524: .LC_answer_charged_try {
4525: background: #FFAAAA ! important;
4526: color: black;
4527: }
4528: .LC_answer_not_charged_try,
4529: .LC_answer_no_grade,
4530: .LC_answer_late {
4531: background: #FFFFAA;
4532: color: black;
4533: }
4534: .LC_answer_previous {
4535: background: #AAAAFF;
4536: color: black;
4537: }
4538: .LC_answer_no_message {
4539: background: #FFFFFF;
4540: color: black;
4541: }
4542: .LC_answer_unknown {
4543: background: orange;
4544: color: black;
4545: }
4546:
4547:
1.529 albertel 4548: span.LC_prior_numerical,
4549: span.LC_prior_string,
4550: span.LC_prior_custom,
4551: span.LC_prior_reaction,
4552: span.LC_prior_math {
1.523 albertel 4553: font-family: monospace;
4554: white-space: pre;
4555: }
4556:
1.525 albertel 4557: span.LC_prior_string {
4558: font-family: monospace;
4559: white-space: pre;
4560: }
4561:
1.523 albertel 4562: table.LC_prior_option {
4563: width: 100%;
4564: border-collapse: collapse;
4565: }
1.528 albertel 4566: table.LC_prior_rank, table.LC_prior_match {
4567: border-collapse: collapse;
4568: }
4569: table.LC_prior_option tr td,
4570: table.LC_prior_rank tr td,
4571: table.LC_prior_match tr td {
1.524 albertel 4572: border: 1px solid #000000;
1.515 albertel 4573: }
4574:
1.519 raeburn 4575: span.LC_nobreak {
1.544 albertel 4576: white-space: nowrap;
1.519 raeburn 4577: }
4578:
1.576 raeburn 4579: span.LC_cusr_emph {
4580: font-style: italic;
4581: }
4582:
1.545 albertel 4583: table.LC_docs_documents {
4584: background: #BBBBBB;
1.547 albertel 4585: border-width: 0px;
1.545 albertel 4586: border-collapse: collapse;
4587: }
4588:
4589: table.LC_docs_documents td.LC_docs_document {
4590: border: 2px solid black;
4591: padding: 4px;
4592: }
4593:
4594: .LC_docs_course_commands div {
4595: float: left;
4596: border: 4px solid #AAAAAA;
4597: padding: 4px;
4598: background: #DDDDCC;
4599: }
4600:
4601: .LC_docs_entry_move {
4602: border: 0px;
4603: border-collapse: collapse;
1.544 albertel 4604: }
4605:
1.545 albertel 4606: .LC_docs_entry_move td {
4607: border: 2px solid #BBBBBB;
4608: background: #DDDDDD;
4609: }
4610:
4611: .LC_docs_editor td.LC_docs_entry_commands {
4612: background: #DDDDDD;
4613: font-size: x-small;
4614: }
1.544 albertel 4615: .LC_docs_copy {
1.545 albertel 4616: color: #000099;
1.544 albertel 4617: }
4618: .LC_docs_cut {
1.545 albertel 4619: color: #550044;
1.544 albertel 4620: }
4621: .LC_docs_rename {
1.545 albertel 4622: color: #009900;
1.544 albertel 4623: }
4624: .LC_docs_remove {
1.545 albertel 4625: color: #990000;
4626: }
4627:
1.547 albertel 4628: .LC_docs_reinit_warn,
4629: .LC_docs_ext_edit {
4630: font-size: x-small;
4631: }
4632:
1.545 albertel 4633: .LC_docs_editor td.LC_docs_entry_title,
4634: .LC_docs_editor td.LC_docs_entry_icon {
4635: background: #FFFFBB;
4636: }
4637: .LC_docs_editor td.LC_docs_entry_parameter {
4638: background: #BBBBFF;
4639: font-size: x-small;
4640: white-space: nowrap;
4641: }
4642:
4643: table.LC_docs_adddocs td,
4644: table.LC_docs_adddocs th {
4645: border: 1px solid #BBBBBB;
4646: padding: 4px;
4647: background: #DDDDDD;
1.543 albertel 4648: }
4649:
1.584 albertel 4650: table.LC_sty_begin {
4651: background: #BBFFBB;
4652: }
4653: table.LC_sty_end {
4654: background: #FFBBBB;
4655: }
4656:
1.343 albertel 4657: END
4658: }
4659:
1.306 albertel 4660: =pod
4661:
4662: =item * &headtag()
4663:
4664: Returns a uniform footer for LON-CAPA web pages.
4665:
1.307 albertel 4666: Inputs: $title - optional title for the head
4667: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 4668: $args - optional arguments
1.319 albertel 4669: force_register - if is true call registerurl so the remote is
4670: informed
1.415 albertel 4671: redirect -> array ref of
4672: 1- seconds before redirect occurs
4673: 2- url to redirect to
4674: 3- whether the side effect should occur
1.315 albertel 4675: (side effect of setting
4676: $env{'internal.head.redirect'} to the url
4677: redirected too)
1.352 albertel 4678: domain -> force to color decorate a page for a specific
4679: domain
4680: function -> force usage of a specific rolish color scheme
4681: bgcolor -> override the default page bgcolor
1.460 albertel 4682: no_auto_mt_title
4683: -> prevent &mt()ing the title arg
1.464 albertel 4684:
1.306 albertel 4685: =cut
4686:
4687: sub headtag {
1.313 albertel 4688: my ($title,$head_extra,$args) = @_;
1.306 albertel 4689:
1.363 albertel 4690: my $function = $args->{'function'} || &get_users_function();
4691: my $domain = $args->{'domain'} || &determinedomain();
4692: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 4693: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 4694: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 4695: #time(),
1.418 albertel 4696: $env{'environment.color.timestamp'},
1.363 albertel 4697: $function,$domain,$bgcolor);
4698:
1.369 www 4699: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 4700:
1.308 albertel 4701: my $result =
4702: '<head>'.
1.461 albertel 4703: &font_settings();
1.319 albertel 4704:
1.461 albertel 4705: if (!$args->{'frameset'}) {
4706: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
4707: }
1.319 albertel 4708: if ($args->{'force_register'}) {
4709: $result .= &Apache::lonmenu::registerurl(1);
4710: }
1.436 albertel 4711: if (!$args->{'no_nav_bar'}
4712: && !$args->{'only_body'}
4713: && !$args->{'frameset'}) {
4714: $result .= &help_menu_js();
4715: }
1.319 albertel 4716:
1.314 albertel 4717: if (ref($args->{'redirect'})) {
1.414 albertel 4718: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 4719: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 4720: if (!$inhibit_continue) {
4721: $env{'internal.head.redirect'} = $url;
4722: }
1.313 albertel 4723: $result.=<<ADDMETA
4724: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 4725: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 4726: ADDMETA
4727: }
1.306 albertel 4728: if (!defined($title)) {
4729: $title = 'The LearningOnline Network with CAPA';
4730: }
1.460 albertel 4731: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
4732: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 4733: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
4734: .$head_extra;
1.306 albertel 4735: return $result;
4736: }
4737:
4738: =pod
4739:
1.340 albertel 4740: =item * &font_settings()
4741:
4742: Returns neccessary <meta> to set the proper encoding
4743:
4744: Inputs: none
4745:
4746: =cut
4747:
4748: sub font_settings {
4749: my $headerstring='';
4750: if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
4751: $headerstring.=
4752: '<meta Content-Type="text/html; charset=x-mac-roman" />';
4753: } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
4754: $headerstring.=
4755: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
4756: }
4757: return $headerstring;
4758: }
4759:
1.341 albertel 4760: =pod
4761:
4762: =item * &xml_begin()
4763:
4764: Returns the needed doctype and <html>
4765:
4766: Inputs: none
4767:
4768: =cut
4769:
4770: sub xml_begin {
4771: my $output='';
4772:
1.342 albertel 4773: &Apache::lonhtmlcommon::init_htmlareafields();
4774:
1.341 albertel 4775: if ($env{'browser.mathml'}) {
4776: $output='<?xml version="1.0"?>'
4777: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
4778: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
4779:
4780: # .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" [<!ENTITY mathns "http://www.w3.org/1998/Math/MathML">] >'
4781: .'<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">'
4782: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
4783: .'xmlns="http://www.w3.org/1999/xhtml">';
4784: } else {
4785: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
4786: }
4787: return $output;
4788: }
1.340 albertel 4789:
4790: =pod
4791:
1.306 albertel 4792: =item * &endheadtag()
4793:
4794: Returns a uniform </head> for LON-CAPA web pages.
4795:
4796: Inputs: none
4797:
4798: =cut
4799:
4800: sub endheadtag {
4801: return '</head>';
4802: }
4803:
4804: =pod
4805:
4806: =item * &head()
4807:
4808: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
4809:
4810: Inputs: $title - optional title for the page
1.307 albertel 4811: $head_extra - optional extra HTML to put inside the <head>
1.405 albertel 4812:
1.306 albertel 4813: =cut
4814:
4815: sub head {
1.325 albertel 4816: my ($title,$head_extra,$args) = @_;
4817: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 4818: }
4819:
4820: =pod
4821:
4822: =item * &start_page()
4823:
4824: Returns a complete <html> .. <body> section for LON-CAPA web pages.
4825:
4826: Inputs: $title - optional title for the page
4827: $head_extra - optional extra HTML to incude inside the <head>
1.315 albertel 4828: $args - additional optional args supported are:
1.317 albertel 4829: only_body -> is true will set &bodytag() onlybodytag
4830: arg on
4831: no_nav_bar -> is true will set &bodytag() notopbar arg on
4832: add_entries -> additional attributes to add to the <body>
4833: domain -> force to color decorate a page for a
4834: specific domain
4835: function -> force usage of a specific rolish color
4836: scheme
4837: redirect -> see &headtag()
4838: bgcolor -> override the default page bg color
4839: js_ready -> return a string ready for being used in
4840: a javascript writeln
1.320 albertel 4841: html_encode -> return a string ready for being used in
4842: a html attribute
1.317 albertel 4843: force_register -> if is true will turn on the &bodytag()
4844: $forcereg arg
1.326 albertel 4845: body_title -> alternate text to use instead of $title
4846: in the title box that appears, this text
4847: is not auto translated like the $title is
1.330 albertel 4848: frameset -> if true will start with a <frameset>
4849: rather than <body>
1.338 albertel 4850: no_title -> if true the title bar won't be shown
4851: skip_phases -> hash ref of
4852: head -> skip the <html><head> generation
4853: body -> skip all <body> generation
1.337 albertel 4854:
1.361 albertel 4855: no_inline_link -> if true and in remote mode, don't show the
4856: 'Switch To Inline Menu' link
4857:
1.460 albertel 4858: no_auto_mt_title -> prevent &mt()ing the title arg
4859:
1.562 albertel 4860: inherit_jsmath -> when creating popup window in a page,
4861: should it have jsmath forced on by the
4862: current page
4863:
1.306 albertel 4864: =cut
4865:
4866: sub start_page {
1.309 albertel 4867: my ($title,$head_extra,$args) = @_;
1.318 albertel 4868: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 4869: my %head_args;
1.352 albertel 4870: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 4871: 'bgcolor','frameset','no_nav_bar','only_body',
4872: 'no_auto_mt_title') {
1.319 albertel 4873: if (defined($args->{$arg})) {
1.324 raeburn 4874: $head_args{$arg} = $args->{$arg};
1.319 albertel 4875: }
1.313 albertel 4876: }
1.319 albertel 4877:
1.315 albertel 4878: $env{'internal.start_page'}++;
1.338 albertel 4879: my $result;
4880: if (! exists($args->{'skip_phases'}{'head'}) ) {
4881: $result.=
1.341 albertel 4882: &xml_begin().
1.338 albertel 4883: &headtag($title,$head_extra,\%head_args).&endheadtag();
4884: }
4885:
4886: if (! exists($args->{'skip_phases'}{'body'}) ) {
4887: if ($args->{'frameset'}) {
4888: my $attr_string = &make_attr_string($args->{'force_register'},
4889: $args->{'add_entries'});
4890: $result .= "\n<frameset $attr_string>\n";
4891: } else {
4892: $result .=
4893: &bodytag($title,
4894: $args->{'function'}, $args->{'add_entries'},
4895: $args->{'only_body'}, $args->{'domain'},
4896: $args->{'force_register'}, $args->{'body_title'},
4897: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 4898: $args->{'no_title'}, $args->{'no_inline_link'},
4899: $args);
1.338 albertel 4900: }
1.330 albertel 4901: }
1.338 albertel 4902:
1.315 albertel 4903: if ($args->{'js_ready'}) {
1.317 albertel 4904: $result = &js_ready($result);
1.315 albertel 4905: }
1.320 albertel 4906: if ($args->{'html_encode'}) {
4907: $result = &html_encode($result);
4908: }
1.315 albertel 4909: return $result;
1.306 albertel 4910: }
4911:
1.330 albertel 4912:
1.306 albertel 4913: =pod
4914:
4915: =item * &head()
4916:
4917: Returns a complete </body></html> section for LON-CAPA web pages.
4918:
1.315 albertel 4919: Inputs: $args - additional optional args supported are:
4920: js_ready -> return a string ready for being used in
4921: a javascript writeln
1.320 albertel 4922: html_encode -> return a string ready for being used in
4923: a html attribute
1.330 albertel 4924: frameset -> if true will start with a <frameset>
4925: rather than <body>
1.493 albertel 4926: dicsussion -> if true will get discussion from
4927: lonxml::xmlend
4928: (you can pass the target and parser arguments
4929: through optional 'target' and 'parser' args
4930: to this routine)
1.306 albertel 4931:
4932: =cut
4933:
4934: sub end_page {
1.315 albertel 4935: my ($args) = @_;
4936: $env{'internal.end_page'}++;
1.330 albertel 4937: my $result;
1.335 albertel 4938: if ($args->{'discussion'}) {
4939: my ($target,$parser);
4940: if (ref($args->{'discussion'})) {
4941: ($target,$parser) =($args->{'discussion'}{'target'},
4942: $args->{'discussion'}{'parser'});
4943: }
4944: $result .= &Apache::lonxml::xmlend($target,$parser);
4945: }
4946:
1.330 albertel 4947: if ($args->{'frameset'}) {
4948: $result .= '</frameset>';
4949: } else {
4950: $result .= &endbodytag();
4951: }
4952: $result .= "\n</html>";
4953:
1.315 albertel 4954: if ($args->{'js_ready'}) {
1.317 albertel 4955: $result = &js_ready($result);
1.315 albertel 4956: }
1.335 albertel 4957:
1.320 albertel 4958: if ($args->{'html_encode'}) {
4959: $result = &html_encode($result);
4960: }
1.335 albertel 4961:
1.315 albertel 4962: return $result;
4963: }
4964:
1.320 albertel 4965: sub html_encode {
4966: my ($result) = @_;
4967:
1.322 albertel 4968: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 4969:
4970: return $result;
4971: }
1.317 albertel 4972: sub js_ready {
4973: my ($result) = @_;
4974:
1.323 albertel 4975: $result =~ s/[\n\r]/ /xmsg;
4976: $result =~ s/\\/\\\\/xmsg;
4977: $result =~ s/'/\\'/xmsg;
1.372 albertel 4978: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 4979:
4980: return $result;
4981: }
4982:
1.315 albertel 4983: sub validate_page {
4984: if ( exists($env{'internal.start_page'})
1.316 albertel 4985: && $env{'internal.start_page'} > 1) {
4986: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 4987: $env{'internal.start_page'}.' '.
1.316 albertel 4988: $ENV{'request.filename'});
1.315 albertel 4989: }
4990: if ( exists($env{'internal.end_page'})
1.316 albertel 4991: && $env{'internal.end_page'} > 1) {
4992: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 4993: $env{'internal.end_page'}.' '.
1.316 albertel 4994: $env{'request.filename'});
1.315 albertel 4995: }
4996: if ( exists($env{'internal.start_page'})
4997: && ! exists($env{'internal.end_page'})) {
1.316 albertel 4998: &Apache::lonnet::logthis('start_page called without end_page '.
4999: $env{'request.filename'});
1.315 albertel 5000: }
5001: if ( ! exists($env{'internal.start_page'})
5002: && exists($env{'internal.end_page'})) {
1.316 albertel 5003: &Apache::lonnet::logthis('end_page called without start_page'.
5004: $env{'request.filename'});
1.315 albertel 5005: }
1.306 albertel 5006: }
1.315 albertel 5007:
1.318 albertel 5008: sub simple_error_page {
5009: my ($r,$title,$msg) = @_;
5010: my $page =
5011: &Apache::loncommon::start_page($title).
5012: &mt($msg).
5013: &Apache::loncommon::end_page();
5014: if (ref($r)) {
5015: $r->print($page);
1.327 albertel 5016: return;
1.318 albertel 5017: }
5018: return $page;
5019: }
1.347 albertel 5020:
5021: {
5022: my $row_count;
5023: sub start_data_table {
1.422 albertel 5024: my ($add_class) = @_;
5025: my $css_class = (join(' ','LC_data_table',$add_class));
1.347 albertel 5026: undef($row_count);
1.422 albertel 5027: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 5028: }
5029:
5030: sub end_data_table {
5031: undef($row_count);
1.389 albertel 5032: return '</table>'."\n";;
1.347 albertel 5033: }
5034:
5035: sub start_data_table_row {
1.422 albertel 5036: my ($add_class) = @_;
1.347 albertel 5037: $row_count++;
1.422 albertel 5038: my $css_class = ($row_count % 2)?'':'LC_even_row';
1.428 albertel 5039: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 5040: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 5041: }
1.471 banghart 5042:
5043: sub continue_data_table_row {
5044: my ($add_class) = @_;
5045: my $css_class = ($row_count % 2)?'':'LC_even_row';
5046: $css_class = (join(' ',$css_class,$add_class));
5047: return '<tr class="'.$css_class.'">'."\n";;
5048: }
1.347 albertel 5049:
5050: sub end_data_table_row {
1.389 albertel 5051: return '</tr>'."\n";;
1.347 albertel 5052: }
1.367 www 5053:
1.421 albertel 5054: sub start_data_table_empty_row {
5055: $row_count++;
5056: return '<tr class="LC_empty_row" >'."\n";;
5057: }
5058:
5059: sub end_data_table_empty_row {
5060: return '</tr>'."\n";;
5061: }
5062:
1.367 www 5063: sub start_data_table_header_row {
1.389 albertel 5064: return '<tr class="LC_header_row">'."\n";;
1.367 www 5065: }
5066:
5067: sub end_data_table_header_row {
1.389 albertel 5068: return '</tr>'."\n";;
1.367 www 5069: }
1.347 albertel 5070: }
5071:
1.548 albertel 5072: =pod
5073:
5074: =item * &inhibit_menu_check($arg)
5075:
5076: Checks for a inhibitmenu state and generates output to preserve it
5077:
5078: Inputs: $arg - can be any of
5079: - undef - in which case the return value is a string
5080: to add into arguments list of a uri
5081: - 'input' - in which case the return value is a HTML
5082: <form> <input> field of type hidden to
5083: preserve the value
5084: - a url - in which case the return value is the url with
5085: the neccesary cgi args added to preserve the
5086: inhibitmenu state
5087: - a ref to a url - no return value, but the string is
5088: updated to include the neccessary cgi
5089: args to preserve the inhibitmenu state
5090:
5091: =cut
5092:
5093: sub inhibit_menu_check {
5094: my ($arg) = @_;
5095: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5096: if ($arg eq 'input') {
5097: if ($env{'form.inhibitmenu'}) {
5098: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
5099: } else {
5100: return
5101: }
5102: }
5103: if ($env{'form.inhibitmenu'}) {
5104: if (ref($arg)) {
5105: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5106: } elsif ($arg eq '') {
5107: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
5108: } else {
5109: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5110: }
5111: }
5112: if (!ref($arg)) {
5113: return $arg;
5114: }
5115: }
5116:
1.251 albertel 5117: ###############################################
1.182 matthew 5118:
5119: =pod
5120:
1.549 albertel 5121: =back
5122:
5123: =head1 User Information Routines
5124:
5125: =over 4
5126:
1.405 albertel 5127: =item * &get_users_function()
1.182 matthew 5128:
5129: Used by &bodytag to determine the current users primary role.
5130: Returns either 'student','coordinator','admin', or 'author'.
5131:
5132: =cut
5133:
5134: ###############################################
5135: sub get_users_function {
5136: my $function = 'student';
1.258 albertel 5137: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 5138: $function='coordinator';
5139: }
1.258 albertel 5140: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 5141: $function='admin';
5142: }
1.258 albertel 5143: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 5144: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
5145: $function='author';
5146: }
5147: return $function;
1.54 www 5148: }
1.99 www 5149:
5150: ###############################################
5151:
1.233 raeburn 5152: =pod
5153:
1.542 raeburn 5154: =item * &check_user_status()
1.274 raeburn 5155:
5156: Determines current status of supplied role for a
5157: specific user. Roles can be active, previous or future.
5158:
5159: Inputs:
5160: user's domain, user's username, course's domain,
1.375 raeburn 5161: course's number, optional section ID.
1.274 raeburn 5162:
5163: Outputs:
5164: role status: active, previous or future.
5165:
5166: =cut
5167:
5168: sub check_user_status {
1.412 raeburn 5169: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 5170: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
5171: my @uroles = keys %userinfo;
5172: my $srchstr;
5173: my $active_chk = 'none';
1.412 raeburn 5174: my $now = time;
1.274 raeburn 5175: if (@uroles > 0) {
1.412 raeburn 5176: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 5177: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
5178: } else {
1.412 raeburn 5179: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
5180: }
5181: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 5182: my $role_end = 0;
5183: my $role_start = 0;
5184: $active_chk = 'active';
1.412 raeburn 5185: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
5186: $role_end = $1;
5187: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
5188: $role_start = $1;
1.274 raeburn 5189: }
5190: }
5191: if ($role_start > 0) {
1.412 raeburn 5192: if ($now < $role_start) {
1.274 raeburn 5193: $active_chk = 'future';
5194: }
5195: }
5196: if ($role_end > 0) {
1.412 raeburn 5197: if ($now > $role_end) {
1.274 raeburn 5198: $active_chk = 'previous';
5199: }
5200: }
5201: }
5202: }
5203: return $active_chk;
5204: }
5205:
5206: ###############################################
5207:
5208: =pod
5209:
1.405 albertel 5210: =item * &get_sections()
1.233 raeburn 5211:
5212: Determines all the sections for a course including
5213: sections with students and sections containing other roles.
1.419 raeburn 5214: Incoming parameters:
5215:
5216: 1. domain
5217: 2. course number
5218: 3. reference to array containing roles for which sections should
5219: be gathered (optional).
5220: 4. reference to array containing status types for which sections
5221: should be gathered (optional).
5222:
5223: If the third argument is undefined, sections are gathered for any role.
5224: If the fourth argument is undefined, sections are gathered for any status.
5225: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 5226:
1.374 raeburn 5227: Returns section hash (keys are section IDs, values are
5228: number of users in each section), subject to the
1.419 raeburn 5229: optional roles filter, optional status filter
1.233 raeburn 5230:
5231: =cut
5232:
5233: ###############################################
5234: sub get_sections {
1.419 raeburn 5235: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 5236: if (!defined($cdom) || !defined($cnum)) {
5237: my $cid = $env{'request.course.id'};
5238:
5239: return if (!defined($cid));
5240:
5241: $cdom = $env{'course.'.$cid.'.domain'};
5242: $cnum = $env{'course.'.$cid.'.num'};
5243: }
5244:
5245: my %sectioncount;
1.419 raeburn 5246: my $now = time;
1.240 albertel 5247:
1.366 albertel 5248: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 5249: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 5250: my $sec_index = &Apache::loncoursedata::CL_SECTION();
5251: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 5252: my $start_index = &Apache::loncoursedata::CL_START();
5253: my $end_index = &Apache::loncoursedata::CL_END();
5254: my $status;
1.366 albertel 5255: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 5256: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
5257: $data->[$status_index],
5258: $data->[$start_index],
5259: $data->[$end_index]);
5260: if ($stu_status eq 'Active') {
5261: $status = 'active';
5262: } elsif ($end < $now) {
5263: $status = 'previous';
5264: } elsif ($start > $now) {
5265: $status = 'future';
5266: }
5267: if ($section ne '-1' && $section !~ /^\s*$/) {
5268: if ((!defined($possible_status)) || (($status ne '') &&
5269: (grep/^\Q$status\E$/,@{$possible_status}))) {
5270: $sectioncount{$section}++;
5271: }
1.240 albertel 5272: }
5273: }
5274: }
5275: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5276: foreach my $user (sort(keys(%courseroles))) {
5277: if ($user !~ /^(\w{2})/) { next; }
5278: my ($role) = ($user =~ /^(\w{2})/);
5279: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 5280: my ($section,$status);
1.240 albertel 5281: if ($role eq 'cr' &&
5282: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
5283: $section=$1;
5284: }
5285: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
5286: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 5287: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
5288: if ($end == -1 && $start == -1) {
5289: next; #deleted role
5290: }
5291: if (!defined($possible_status)) {
5292: $sectioncount{$section}++;
5293: } else {
5294: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
5295: $status = 'active';
5296: } elsif ($end < $now) {
5297: $status = 'future';
5298: } elsif ($start > $now) {
5299: $status = 'previous';
5300: }
5301: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
5302: $sectioncount{$section}++;
5303: }
5304: }
1.233 raeburn 5305: }
1.366 albertel 5306: return %sectioncount;
1.233 raeburn 5307: }
5308:
1.274 raeburn 5309: ###############################################
1.294 raeburn 5310:
5311: =pod
1.405 albertel 5312:
5313: =item * &get_course_users()
5314:
1.275 raeburn 5315: Retrieves usernames:domains for users in the specified course
5316: with specific role(s), and access status.
5317:
5318: Incoming parameters:
1.277 albertel 5319: 1. course domain
5320: 2. course number
5321: 3. access status: users must have - either active,
1.275 raeburn 5322: previous, future, or all.
1.277 albertel 5323: 4. reference to array of permissible roles
1.288 raeburn 5324: 5. reference to array of section restrictions (optional)
5325: 6. reference to results object (hash of hashes).
5326: 7. reference to optional userdata hash
1.275 raeburn 5327: Keys of top level hash are roles.
5328: Keys of inner hashes are username:domain, with
5329: values set to access type.
1.288 raeburn 5330: Optional userdata hash returns an array with arguments in the
5331: same order as loncoursedata::get_classlist() for student data.
5332:
5333: Entries for end, start, section and status are blank because
5334: of the possibility of multiple values for non-student roles.
5335:
1.275 raeburn 5336: =cut
1.405 albertel 5337:
1.275 raeburn 5338: ###############################################
1.405 albertel 5339:
1.275 raeburn 5340: sub get_course_users {
1.288 raeburn 5341: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
5342: my %idx = ();
1.419 raeburn 5343: my %seclists;
1.288 raeburn 5344:
5345: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
5346: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
5347: $idx{end} = &Apache::loncoursedata::CL_END();
5348: $idx{start} = &Apache::loncoursedata::CL_START();
5349: $idx{id} = &Apache::loncoursedata::CL_ID();
5350: $idx{section} = &Apache::loncoursedata::CL_SECTION();
5351: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
5352: $idx{status} = &Apache::loncoursedata::CL_STATUS();
5353:
1.290 albertel 5354: if (grep(/^st$/,@{$roles})) {
1.276 albertel 5355: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 5356: my $now = time;
1.277 albertel 5357: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 5358: my $match = 0;
1.412 raeburn 5359: my $secmatch = 0;
1.419 raeburn 5360: my $section = $$classlist{$student}[$idx{section}];
5361: if ($section eq '') {
5362: $section = 'none';
5363: }
1.291 albertel 5364: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5365: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5366: $secmatch = 1;
5367: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 5368: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5369: $secmatch = 1;
5370: }
5371: } else {
1.419 raeburn 5372: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 5373: $secmatch = 1;
5374: }
1.290 albertel 5375: }
1.412 raeburn 5376: if (!$secmatch) {
5377: next;
5378: }
1.419 raeburn 5379: }
1.420 albertel 5380: push(@{$seclists{$student}},$section);
1.275 raeburn 5381: if (defined($$types{'active'})) {
1.288 raeburn 5382: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 5383: push(@{$$users{st}{$student}},'active');
1.288 raeburn 5384: $match = 1;
1.275 raeburn 5385: }
5386: }
5387: if (defined($$types{'previous'})) {
1.288 raeburn 5388: if ($$classlist{$student}[$idx{end}] <= $now) {
1.275 raeburn 5389: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 5390: $match = 1;
1.275 raeburn 5391: }
5392: }
5393: if (defined($$types{'future'})) {
1.288 raeburn 5394: if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
1.275 raeburn 5395: push(@{$$users{st}{$student}},'future');
1.288 raeburn 5396: $match = 1;
1.275 raeburn 5397: }
5398: }
1.412 raeburn 5399: if ($match && ref($userdata) eq 'HASH') {
1.288 raeburn 5400: $$userdata{$student} = $$classlist{$student};
5401: }
1.275 raeburn 5402: }
5403: }
1.412 raeburn 5404: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 5405: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5406: my $now = time;
5407: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 5408: my $match = 0;
1.412 raeburn 5409: my $secmatch = 0;
1.439 raeburn 5410: my $status;
1.412 raeburn 5411: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 5412: $user =~ s/:$//;
1.439 raeburn 5413: my ($end,$start) = split(/:/,$coursepersonnel{$person});
5414: if ($end == -1 || $start == -1) {
5415: next;
5416: }
5417: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
5418: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 5419: my ($uname,$udom) = split(/:/,$user);
5420: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5421: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5422: $secmatch = 1;
5423: } elsif ($usec eq '') {
1.420 albertel 5424: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5425: $secmatch = 1;
5426: }
5427: } else {
5428: if (grep(/^\Q$usec\E$/,@{$sections})) {
5429: $secmatch = 1;
5430: }
5431: }
5432: if (!$secmatch) {
5433: next;
5434: }
1.288 raeburn 5435: }
1.419 raeburn 5436: if ($usec eq '') {
5437: $usec = 'none';
5438: }
1.275 raeburn 5439: if ($uname ne '' && $udom ne '') {
1.503 raeburn 5440: if ($end > 0 && $end < $now) {
1.439 raeburn 5441: $status = 'previous';
5442: } elsif ($start > $now) {
5443: $status = 'future';
5444: } else {
5445: $status = 'active';
5446: }
1.277 albertel 5447: foreach my $type (keys(%{$types})) {
1.275 raeburn 5448: if ($status eq $type) {
1.420 albertel 5449: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 5450: push(@{$$users{$role}{$user}},$type);
5451: }
1.288 raeburn 5452: $match = 1;
5453: }
5454: }
1.419 raeburn 5455: if (($match) && (ref($userdata) eq 'HASH')) {
5456: if (!exists($$userdata{$uname.':'.$udom})) {
5457: &get_user_info($udom,$uname,\%idx,$userdata);
5458: }
1.420 albertel 5459: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 5460: push(@{$seclists{$uname.':'.$udom}},$usec);
5461: }
1.275 raeburn 5462: }
5463: }
5464: }
5465: }
1.290 albertel 5466: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 5467: if ((defined($cdom)) && (defined($cnum))) {
5468: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
5469: if ( defined($csettings{'internal.courseowner'}) ) {
5470: my $owner = $csettings{'internal.courseowner'};
1.439 raeburn 5471: if ($owner !~ /^[^:]+:[^:]+$/) {
5472: $owner = $owner.':'.$cdom;
5473: }
5474: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 5475: if (defined($userdata) &&
5476: !exists($$userdata{$owner.':'.$cdom})) {
5477: &get_user_info($cdom,$owner,\%idx,$userdata);
1.420 albertel 5478: if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
1.419 raeburn 5479: push(@{$seclists{$owner.':'.$cdom}},'none');
5480: }
1.290 albertel 5481: }
1.279 raeburn 5482: }
5483: }
5484: }
1.419 raeburn 5485: foreach my $user (keys(%seclists)) {
5486: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
5487: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
5488: }
1.275 raeburn 5489: }
5490: return;
5491: }
5492:
1.288 raeburn 5493: sub get_user_info {
5494: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 5495: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
5496: &plainname($uname,$udom,'lastname');
1.291 albertel 5497: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 5498: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.288 raeburn 5499: return;
5500: }
1.275 raeburn 5501:
1.472 raeburn 5502: ###############################################
5503:
5504: =pod
5505:
5506: =item * &get_user_quota()
5507:
5508: Retrieves quota assigned for storage of portfolio files for a user
5509:
5510: Incoming parameters:
5511: 1. user's username
5512: 2. user's domain
5513:
5514: Returns:
1.536 raeburn 5515: 1. Disk quota (in Mb) assigned to student.
5516: 2. (Optional) Type of setting: custom or default
5517: (individually assigned or default for user's
5518: institutional status).
5519: 3. (Optional) - User's institutional status (e.g., faculty, staff
5520: or student - types as defined in localenroll::inst_usertypes
5521: for user's domain, which determines default quota for user.
5522: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 5523:
5524: If a value has been stored in the user's environment,
1.536 raeburn 5525: it will return that, otherwise it returns the maximal default
5526: defined for the user's instituional status(es) in the domain.
1.472 raeburn 5527:
5528: =cut
5529:
5530: ###############################################
5531:
5532:
5533: sub get_user_quota {
5534: my ($uname,$udom) = @_;
1.536 raeburn 5535: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 5536: if (!defined($udom)) {
5537: $udom = $env{'user.domain'};
5538: }
5539: if (!defined($uname)) {
5540: $uname = $env{'user.name'};
5541: }
5542: if (($udom eq '' || $uname eq '') ||
5543: ($udom eq 'public') && ($uname eq 'public')) {
5544: $quota = 0;
1.536 raeburn 5545: $quotatype = 'default';
5546: $defquota = 0;
1.472 raeburn 5547: } else {
1.536 raeburn 5548: my $inststatus;
1.472 raeburn 5549: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
5550: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 5551: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 5552: } else {
1.536 raeburn 5553: my %userenv =
5554: &Apache::lonnet::get('environment',['portfolioquota',
5555: 'inststatus'],$udom,$uname);
1.472 raeburn 5556: my ($tmp) = keys(%userenv);
5557: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5558: $quota = $userenv{'portfolioquota'};
1.536 raeburn 5559: $inststatus = $userenv{'inststatus'};
1.472 raeburn 5560: } else {
5561: undef(%userenv);
5562: }
5563: }
1.536 raeburn 5564: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 5565: if ($quota eq '') {
1.536 raeburn 5566: $quota = $defquota;
5567: $quotatype = 'default';
5568: } else {
5569: $quotatype = 'custom';
1.472 raeburn 5570: }
5571: }
1.536 raeburn 5572: if (wantarray) {
5573: return ($quota,$quotatype,$settingstatus,$defquota);
5574: } else {
5575: return $quota;
5576: }
1.472 raeburn 5577: }
5578:
5579: ###############################################
5580:
5581: =pod
5582:
5583: =item * &default_quota()
5584:
1.536 raeburn 5585: Retrieves default quota assigned for storage of user portfolio files,
5586: given an (optional) user's institutional status.
1.472 raeburn 5587:
5588: Incoming parameters:
5589: 1. domain
1.536 raeburn 5590: 2. (Optional) institutional status(es). This is a : separated list of
5591: status types (e.g., faculty, staff, student etc.)
5592: which apply to the user for whom the default is being retrieved.
5593: If the institutional status string in undefined, the domain
5594: default quota will be returned.
1.472 raeburn 5595:
5596: Returns:
5597: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 5598: 2. (Optional) institutional type which determined the value of the
5599: default quota.
1.472 raeburn 5600:
5601: If a value has been stored in the domain's configuration db,
5602: it will return that, otherwise it returns 20 (for backwards
5603: compatibility with domains which have not set up a configuration
5604: db file; the original statically defined portfolio quota was 20 Mb).
5605:
1.536 raeburn 5606: If the user's status includes multiple types (e.g., staff and student),
5607: the largest default quota which applies to the user determines the
5608: default quota returned.
5609:
1.472 raeburn 5610: =cut
5611:
5612: ###############################################
5613:
5614:
5615: sub default_quota {
1.536 raeburn 5616: my ($udom,$inststatus) = @_;
5617: my ($defquota,$settingstatus);
5618: my %quotahash = &Apache::lonnet::get_dom('configuration',
5619: ['quota'],$udom);
5620: if (ref($quotahash{'quota'}) eq 'HASH') {
5621: if ($inststatus ne '') {
5622: my @statuses = split(/:/,$inststatus);
5623: foreach my $item (@statuses) {
5624: if ($quotahash{'quota'}{$item} ne '') {
5625: if ($defquota eq '') {
5626: $defquota = $quotahash{'quota'}{$item};
5627: $settingstatus = $item;
5628: } elsif ($quotahash{'quota'}{$item} > $defquota) {
5629: $defquota = $quotahash{'quota'}{$item};
5630: $settingstatus = $item;
5631: }
5632: }
5633: }
5634: }
5635: if ($defquota eq '') {
5636: $defquota = $quotahash{'quota'}{'default'};
5637: $settingstatus = 'default';
5638: }
5639: } else {
5640: $settingstatus = 'default';
5641: $defquota = 20;
5642: }
5643: if (wantarray) {
5644: return ($defquota,$settingstatus);
1.472 raeburn 5645: } else {
1.536 raeburn 5646: return $defquota;
1.472 raeburn 5647: }
5648: }
5649:
1.384 raeburn 5650: sub get_secgrprole_info {
5651: my ($cdom,$cnum,$needroles,$type) = @_;
5652: my %sections_count = &get_sections($cdom,$cnum);
5653: my @sections = (sort {$a <=> $b} keys(%sections_count));
5654: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
5655: my @groups = sort(keys(%curr_groups));
5656: my $allroles = [];
5657: my $rolehash;
5658: my $accesshash = {
5659: active => 'Currently has access',
5660: future => 'Will have future access',
5661: previous => 'Previously had access',
5662: };
5663: if ($needroles) {
5664: $rolehash = {'all' => 'all'};
1.385 albertel 5665: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5666: if (&Apache::lonnet::error(%user_roles)) {
5667: undef(%user_roles);
5668: }
5669: foreach my $item (keys(%user_roles)) {
1.384 raeburn 5670: my ($role)=split(/\:/,$item,2);
5671: if ($role eq 'cr') { next; }
5672: if ($role =~ /^cr/) {
5673: $$rolehash{$role} = (split('/',$role))[3];
5674: } else {
5675: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
5676: }
5677: }
5678: foreach my $key (sort(keys(%{$rolehash}))) {
5679: push(@{$allroles},$key);
5680: }
5681: push (@{$allroles},'st');
5682: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
5683: }
5684: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
5685: }
5686:
1.555 raeburn 5687: sub user_picker {
1.570 raeburn 5688: my ($dom,$srch,$forcenewuser,$caller) = @_;
1.555 raeburn 5689: my $currdom = $dom;
5690: my %curr_selected = (
5691: srchin => 'dom',
1.580 raeburn 5692: srchby => 'lastname',
1.555 raeburn 5693: );
5694: my $srchterm;
5695: if (ref($srch) eq 'HASH') {
5696: if ($srch->{'srchby'} ne '') {
5697: $curr_selected{'srchby'} = $srch->{'srchby'};
5698: }
5699: if ($srch->{'srchin'} ne '') {
5700: $curr_selected{'srchin'} = $srch->{'srchin'};
5701: }
5702: if ($srch->{'srchtype'} ne '') {
5703: $curr_selected{'srchtype'} = $srch->{'srchtype'};
5704: }
5705: if ($srch->{'srchdomain'} ne '') {
5706: $currdom = $srch->{'srchdomain'};
5707: }
5708: $srchterm = $srch->{'srchterm'};
5709: }
5710: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 5711: 'usr' => 'Search criteria',
1.563 raeburn 5712: 'doma' => 'Domain/institution to search',
1.558 albertel 5713: 'uname' => 'username',
5714: 'lastname' => 'last name',
1.555 raeburn 5715: 'lastfirst' => 'last name, first name',
1.558 albertel 5716: 'crs' => 'in this course',
1.576 raeburn 5717: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 5718: 'alc' => 'all LON-CAPA',
1.573 raeburn 5719: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 5720: 'exact' => 'is',
5721: 'contains' => 'contains',
1.569 raeburn 5722: 'begins' => 'begins with',
1.571 raeburn 5723: 'youm' => "You must include some text to search for.",
5724: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
5725: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
5726: 'yomc' => "You must choose a domain when using an institutional directory search.",
5727: 'ymcd' => "You must choose a domain when using a domain search.",
5728: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
5729: 'whse' => "When searching by last,first you must include at least one character in the first name.",
5730: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 5731: );
1.563 raeburn 5732: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
5733: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 5734:
5735: my @srchins = ('crs','dom','alc','instd');
5736:
5737: foreach my $option (@srchins) {
5738: # FIXME 'alc' option unavailable until
5739: # loncreateuser::print_user_query_page()
5740: # has been completed.
5741: next if ($option eq 'alc');
5742: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 5743: if ($curr_selected{'srchin'} eq $option) {
5744: $srchinsel .= '
5745: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5746: } else {
5747: $srchinsel .= '
5748: <option value="'.$option.'">'.$lt{$option}.'</option>';
5749: }
1.555 raeburn 5750: }
1.563 raeburn 5751: $srchinsel .= "\n </select>\n";
1.555 raeburn 5752:
5753: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 5754: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 5755: if ($curr_selected{'srchby'} eq $option) {
5756: $srchbysel .= '
5757: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5758: } else {
5759: $srchbysel .= '
5760: <option value="'.$option.'">'.$lt{$option}.'</option>';
5761: }
5762: }
5763: $srchbysel .= "\n </select>\n";
5764:
5765: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 5766: foreach my $option ('begins','contains','exact') {
1.555 raeburn 5767: if ($curr_selected{'srchtype'} eq $option) {
5768: $srchtypesel .= '
5769: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5770: } else {
5771: $srchtypesel .= '
5772: <option value="'.$option.'">'.$lt{$option}.'</option>';
5773: }
5774: }
5775: $srchtypesel .= "\n </select>\n";
5776:
1.558 albertel 5777: my ($newuserscript,$new_user_create);
1.556 raeburn 5778:
5779: if ($forcenewuser) {
1.576 raeburn 5780: if (ref($srch) eq 'HASH') {
5781: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
5782: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
5783: }
5784: }
5785:
1.556 raeburn 5786: $newuserscript = <<"ENDSCRIPT";
5787:
1.570 raeburn 5788: function setSearch(createnew,callingForm) {
1.556 raeburn 5789: if (createnew == 1) {
1.570 raeburn 5790: for (var i=0; i<callingForm.srchby.length; i++) {
5791: if (callingForm.srchby.options[i].value == 'uname') {
5792: callingForm.srchby.selectedIndex = i;
1.556 raeburn 5793: }
5794: }
1.570 raeburn 5795: for (var i=0; i<callingForm.srchin.length; i++) {
5796: if ( callingForm.srchin.options[i].value == 'dom') {
5797: callingForm.srchin.selectedIndex = i;
1.556 raeburn 5798: }
5799: }
1.570 raeburn 5800: for (var i=0; i<callingForm.srchtype.length; i++) {
5801: if (callingForm.srchtype.options[i].value == 'exact') {
5802: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 5803: }
5804: }
1.570 raeburn 5805: for (var i=0; i<callingForm.srchdomain.length; i++) {
5806: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
5807: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 5808: }
5809: }
5810: }
5811: }
5812: ENDSCRIPT
1.558 albertel 5813:
1.556 raeburn 5814: }
5815:
1.555 raeburn 5816: my $output = <<"END_BLOCK";
1.556 raeburn 5817: <script type="text/javascript">
1.570 raeburn 5818: function validateEntry(callingForm) {
1.558 albertel 5819:
1.556 raeburn 5820: var checkok = 1;
1.558 albertel 5821: var srchin;
1.570 raeburn 5822: for (var i=0; i<callingForm.srchin.length; i++) {
5823: if ( callingForm.srchin[i].checked ) {
5824: srchin = callingForm.srchin[i].value;
1.558 albertel 5825: }
5826: }
5827:
1.570 raeburn 5828: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
5829: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
5830: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
5831: var srchterm = callingForm.srchterm.value;
5832: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 5833: var msg = "";
5834:
5835: if (srchterm == "") {
5836: checkok = 0;
1.571 raeburn 5837: msg += "$lt{'youm'}\\n";
1.556 raeburn 5838: }
5839:
1.569 raeburn 5840: if (srchtype== 'begins') {
5841: if (srchterm.length < 2) {
5842: checkok = 0;
1.571 raeburn 5843: msg += "$lt{'thte'}\\n";
1.569 raeburn 5844: }
5845: }
5846:
1.556 raeburn 5847: if (srchtype== 'contains') {
5848: if (srchterm.length < 3) {
5849: checkok = 0;
1.571 raeburn 5850: msg += "$lt{'thet'}\\n";
1.556 raeburn 5851: }
5852: }
5853: if (srchin == 'instd') {
5854: if (srchdomain == '') {
5855: checkok = 0;
1.571 raeburn 5856: msg += "$lt{'yomc'}\\n";
1.556 raeburn 5857: }
5858: }
5859: if (srchin == 'dom') {
5860: if (srchdomain == '') {
5861: checkok = 0;
1.571 raeburn 5862: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 5863: }
5864: }
5865: if (srchby == 'lastfirst') {
5866: if (srchterm.indexOf(",") == -1) {
5867: checkok = 0;
1.571 raeburn 5868: msg += "$lt{'whus'}\\n";
1.556 raeburn 5869: }
5870: if (srchterm.indexOf(",") == srchterm.length -1) {
5871: checkok = 0;
1.571 raeburn 5872: msg += "$lt{'whse'}\\n";
1.556 raeburn 5873: }
5874: }
5875: if (checkok == 0) {
1.571 raeburn 5876: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 5877: return;
5878: }
5879: if (checkok == 1) {
1.570 raeburn 5880: callingForm.submit();
1.556 raeburn 5881: }
5882: }
5883:
5884: $newuserscript
5885:
5886: </script>
1.558 albertel 5887:
5888: $new_user_create
5889:
1.555 raeburn 5890: <table>
1.558 albertel 5891: <tr>
1.573 raeburn 5892: <td>$lt{'doma'}:</td>
5893: <td>$domform</td>
5894: </td>
5895: </tr>
5896: <tr>
5897: <td>$lt{'usr'}:</td>
1.563 raeburn 5898: <td>$srchbysel
5899: $srchtypesel
5900: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 5901: $srchinsel
1.563 raeburn 5902: </td>
5903: </tr>
1.555 raeburn 5904: </table>
5905: <br />
5906: END_BLOCK
1.558 albertel 5907:
1.555 raeburn 5908: return $output;
5909: }
5910:
1.585 ! raeburn 5911: sub username_rule_check {
! 5912: my ($srch,$caller) = @_;
! 5913: my ($response,@curr_rules,%inst_results,$rulematch);
! 5914: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($srch->{'srchdomain'});
! 5915: if (ref($srch) eq 'HASH') {
! 5916: (my $inst_response,%inst_results) =
! 5917: &Apache::lonnet::get_instuser($srch->{'srchdomain'},
! 5918: $srch->{'srchterm'});
! 5919: my %domconfig = &Apache::lonnet::get_dom('configuration',
! 5920: ['usercreation'],$srch->{'srchdomain'});
! 5921: if (ref($domconfig{'usercreation'}) eq 'HASH') {
! 5922: if (ref($domconfig{'usercreation'}{'username_rule'}) eq 'ARRAY') {
! 5923: @curr_rules = @{$domconfig{'usercreation'}{'username_rule'}};
! 5924: }
! 5925: }
! 5926: if (@curr_rules > 0) {
! 5927: my $domdesc = &Apache::lonnet::domain($srch->{'srchdomain'},'description');
! 5928: my $instuser_reqd;
! 5929: my %rule_check = &Apache::lonnet::inst_rulecheck($srch->{'srchdomain'},$srch->{'srchterm'},\@curr_rules);
! 5930: foreach my $rule (@curr_rules) {
! 5931: if ($rule_check{$rule}) {
! 5932: $rulematch = $rule;
! 5933: if ($inst_response eq 'ok') {
! 5934: if (keys(%inst_results) == 0) {
! 5935: if ($caller eq 'new') {
! 5936: $response = &mt('The username you chose matches the format of usernames defined for <span class="LC_cusr_emph">[_1]</span>, but the user does not exist in the institutional directory.',$domdesc).'<br />'.&mt("You must choose a username with a different format -- one that will not conflict with 'official' institutional usernames.");
! 5937: }
! 5938: }
! 5939: }
! 5940: last;
! 5941: }
! 5942: }
! 5943: if ($response) {
! 5944: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
! 5945: if (@{$ruleorder} > 0) {
! 5946: $response .= '<br />'.&mt('Usernames with the following format(s) may <span class="LC_cusr_emph">only</span> be used for verified users at [_1]:',$domdesc).' <ul>';
! 5947: foreach my $rule (@{$ruleorder}) {
! 5948: if (grep(/^\Q$rule\E$/,@curr_rules)) {
! 5949: if (ref($rules->{$rule}) eq 'HASH') {
! 5950: $response .= '<li>'.$rules->{$rule}{'name'}.': '.
! 5951: $rules->{$rule}{'desc'}.'</li>';
! 5952: }
! 5953: }
! 5954: }
! 5955: }
! 5956: $response .= '</ul>';
! 5957: }
! 5958: }
! 5959: }
! 5960: }
! 5961: return ($response,$rulematch,$rules,%inst_results);
! 5962: }
! 5963:
1.112 bowersj2 5964: =pod
5965:
1.549 albertel 5966: =back
5967:
5968: =head1 HTTP Helpers
5969:
5970: =over 4
5971:
1.112 bowersj2 5972: =item * get_unprocessed_cgi($query,$possible_names)
5973:
1.258 albertel 5974: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 5975: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 5976: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 5977:
5978: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
5979: $possible_names is an ref to an array of form element names. As an example:
5980: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 5981: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 5982:
5983: =cut
1.1 albertel 5984:
1.6 albertel 5985: sub get_unprocessed_cgi {
1.25 albertel 5986: my ($query,$possible_names)= @_;
1.26 matthew 5987: # $Apache::lonxml::debug=1;
1.356 albertel 5988: foreach my $pair (split(/&/,$query)) {
5989: my ($name, $value) = split(/=/,$pair);
1.369 www 5990: $name = &unescape($name);
1.25 albertel 5991: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
5992: $value =~ tr/+/ /;
5993: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 5994: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 5995: }
1.16 harris41 5996: }
1.6 albertel 5997: }
5998:
1.112 bowersj2 5999: =pod
6000:
6001: =item * cacheheader()
6002:
6003: returns cache-controlling header code
6004:
6005: =cut
6006:
1.7 albertel 6007: sub cacheheader {
1.258 albertel 6008: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 6009: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
6010: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 6011: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
6012: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 6013: return $output;
1.7 albertel 6014: }
6015:
1.112 bowersj2 6016: =pod
6017:
6018: =item * no_cache($r)
6019:
6020: specifies header code to not have cache
6021:
6022: =cut
6023:
1.9 albertel 6024: sub no_cache {
1.216 albertel 6025: my ($r) = @_;
6026: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 6027: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 6028: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
6029: $r->no_cache(1);
6030: $r->header_out("Expires" => $date);
6031: $r->header_out("Pragma" => "no-cache");
1.123 www 6032: }
6033:
6034: sub content_type {
1.181 albertel 6035: my ($r,$type,$charset) = @_;
1.299 foxr 6036: if ($r) {
6037: # Note that printout.pl calls this with undef for $r.
6038: &no_cache($r);
6039: }
1.258 albertel 6040: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 6041: unless ($charset) {
6042: $charset=&Apache::lonlocal::current_encoding;
6043: }
6044: if ($charset) { $type.='; charset='.$charset; }
6045: if ($r) {
6046: $r->content_type($type);
6047: } else {
6048: print("Content-type: $type\n\n");
6049: }
1.9 albertel 6050: }
1.25 albertel 6051:
1.112 bowersj2 6052: =pod
6053:
6054: =item * add_to_env($name,$value)
6055:
1.258 albertel 6056: adds $name to the %env hash with value
1.112 bowersj2 6057: $value, if $name already exists, the entry is converted to an array
6058: reference and $value is added to the array.
6059:
6060: =cut
6061:
1.25 albertel 6062: sub add_to_env {
6063: my ($name,$value)=@_;
1.258 albertel 6064: if (defined($env{$name})) {
6065: if (ref($env{$name})) {
1.25 albertel 6066: #already have multiple values
1.258 albertel 6067: push(@{ $env{$name} },$value);
1.25 albertel 6068: } else {
6069: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 6070: my $first=$env{$name};
6071: undef($env{$name});
6072: push(@{ $env{$name} },$first,$value);
1.25 albertel 6073: }
6074: } else {
1.258 albertel 6075: $env{$name}=$value;
1.25 albertel 6076: }
1.31 albertel 6077: }
1.149 albertel 6078:
6079: =pod
6080:
6081: =item * get_env_multiple($name)
6082:
1.258 albertel 6083: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 6084: values may be defined and end up as an array ref.
6085:
6086: returns an array of values
6087:
6088: =cut
6089:
6090: sub get_env_multiple {
6091: my ($name) = @_;
6092: my @values;
1.258 albertel 6093: if (defined($env{$name})) {
1.149 albertel 6094: # exists is it an array
1.258 albertel 6095: if (ref($env{$name})) {
6096: @values=@{ $env{$name} };
1.149 albertel 6097: } else {
1.258 albertel 6098: $values[0]=$env{$name};
1.149 albertel 6099: }
6100: }
6101: return(@values);
6102: }
6103:
1.31 albertel 6104:
1.41 ng 6105: =pod
1.45 matthew 6106:
1.464 albertel 6107: =back
1.41 ng 6108:
1.112 bowersj2 6109: =head1 CSV Upload/Handling functions
1.38 albertel 6110:
1.41 ng 6111: =over 4
6112:
1.112 bowersj2 6113: =item * upfile_store($r)
1.41 ng 6114:
6115: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 6116: needs $env{'form.upfile'}
1.41 ng 6117: returns $datatoken to be put into hidden field
6118:
6119: =cut
1.31 albertel 6120:
6121: sub upfile_store {
6122: my $r=shift;
1.258 albertel 6123: $env{'form.upfile'}=~s/\r/\n/gs;
6124: $env{'form.upfile'}=~s/\f/\n/gs;
6125: $env{'form.upfile'}=~s/\n+/\n/gs;
6126: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 6127:
1.258 albertel 6128: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
6129: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 6130: {
1.158 raeburn 6131: my $datafile = $r->dir_config('lonDaemons').
6132: '/tmp/'.$datatoken.'.tmp';
6133: if ( open(my $fh,">$datafile") ) {
1.258 albertel 6134: print $fh $env{'form.upfile'};
1.158 raeburn 6135: close($fh);
6136: }
1.31 albertel 6137: }
6138: return $datatoken;
6139: }
6140:
1.56 matthew 6141: =pod
6142:
1.112 bowersj2 6143: =item * load_tmp_file($r)
1.41 ng 6144:
6145: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 6146: needs $env{'form.datatoken'},
6147: sets $env{'form.upfile'} to the contents of the file
1.41 ng 6148:
6149: =cut
1.31 albertel 6150:
6151: sub load_tmp_file {
6152: my $r=shift;
6153: my @studentdata=();
6154: {
1.158 raeburn 6155: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 6156: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 6157: if ( open(my $fh,"<$studentfile") ) {
6158: @studentdata=<$fh>;
6159: close($fh);
6160: }
1.31 albertel 6161: }
1.258 albertel 6162: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 6163: }
6164:
1.56 matthew 6165: =pod
6166:
1.112 bowersj2 6167: =item * upfile_record_sep()
1.41 ng 6168:
6169: Separate uploaded file into records
6170: returns array of records,
1.258 albertel 6171: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 6172:
6173: =cut
1.31 albertel 6174:
6175: sub upfile_record_sep {
1.258 albertel 6176: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 6177: } else {
1.248 albertel 6178: my @records;
1.258 albertel 6179: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 6180: if ($line=~/^\s*$/) { next; }
6181: push(@records,$line);
6182: }
6183: return @records;
1.31 albertel 6184: }
6185: }
6186:
1.56 matthew 6187: =pod
6188:
1.112 bowersj2 6189: =item * record_sep($record)
1.41 ng 6190:
1.258 albertel 6191: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 6192:
6193: =cut
6194:
1.263 www 6195: sub takeleft {
6196: my $index=shift;
6197: return substr('0000'.$index,-4,4);
6198: }
6199:
1.31 albertel 6200: sub record_sep {
6201: my $record=shift;
6202: my %components=();
1.258 albertel 6203: if ($env{'form.upfiletype'} eq 'xml') {
6204: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 6205: my $i=0;
1.356 albertel 6206: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 6207: $field=~s/^(\"|\')//;
6208: $field=~s/(\"|\')$//;
1.263 www 6209: $components{&takeleft($i)}=$field;
1.31 albertel 6210: $i++;
6211: }
1.258 albertel 6212: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 6213: my $i=0;
1.356 albertel 6214: foreach my $field (split(/\t/,$record)) {
1.31 albertel 6215: $field=~s/^(\"|\')//;
6216: $field=~s/(\"|\')$//;
1.263 www 6217: $components{&takeleft($i)}=$field;
1.31 albertel 6218: $i++;
6219: }
6220: } else {
1.561 www 6221: my $separator=',';
1.480 banghart 6222: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 6223: $separator=';';
1.480 banghart 6224: }
1.31 albertel 6225: my $i=0;
1.561 www 6226: # the character we are looking for to indicate the end of a quote or a record
6227: my $looking_for=$separator;
6228: # do not add the characters to the fields
6229: my $ignore=0;
6230: # we just encountered a separator (or the beginning of the record)
6231: my $just_found_separator=1;
6232: # store the field we are working on here
6233: my $field='';
6234: # work our way through all characters in record
6235: foreach my $character ($record=~/(.)/g) {
6236: if ($character eq $looking_for) {
6237: if ($character ne $separator) {
6238: # Found the end of a quote, again looking for separator
6239: $looking_for=$separator;
6240: $ignore=1;
6241: } else {
6242: # Found a separator, store away what we got
6243: $components{&takeleft($i)}=$field;
6244: $i++;
6245: $just_found_separator=1;
6246: $ignore=0;
6247: $field='';
6248: }
6249: next;
6250: }
6251: # single or double quotation marks after a separator indicate beginning of a quote
6252: # we are now looking for the end of the quote and need to ignore separators
6253: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
6254: $looking_for=$character;
6255: next;
6256: }
6257: # ignore would be true after we reached the end of a quote
6258: if ($ignore) { next; }
6259: if (($just_found_separator) && ($character=~/\s/)) { next; }
6260: $field.=$character;
6261: $just_found_separator=0;
1.31 albertel 6262: }
1.561 www 6263: # catch the very last entry, since we never encountered the separator
6264: $components{&takeleft($i)}=$field;
1.31 albertel 6265: }
6266: return %components;
6267: }
6268:
1.144 matthew 6269: ######################################################
6270: ######################################################
6271:
1.56 matthew 6272: =pod
6273:
1.112 bowersj2 6274: =item * upfile_select_html()
1.41 ng 6275:
1.144 matthew 6276: Return HTML code to select a file from the users machine and specify
6277: the file type.
1.41 ng 6278:
6279: =cut
6280:
1.144 matthew 6281: ######################################################
6282: ######################################################
1.31 albertel 6283: sub upfile_select_html {
1.144 matthew 6284: my %Types = (
6285: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 6286: semisv => &mt('Semicolon separated values'),
1.144 matthew 6287: space => &mt('Space separated'),
6288: tab => &mt('Tabulator separated'),
6289: # xml => &mt('HTML/XML'),
6290: );
6291: my $Str = '<input type="file" name="upfile" size="50" />'.
6292: '<br />Type: <select name="upfiletype">';
6293: foreach my $type (sort(keys(%Types))) {
6294: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
6295: }
6296: $Str .= "</select>\n";
6297: return $Str;
1.31 albertel 6298: }
6299:
1.301 albertel 6300: sub get_samples {
6301: my ($records,$toget) = @_;
6302: my @samples=({});
6303: my $got=0;
6304: foreach my $rec (@$records) {
6305: my %temp = &record_sep($rec);
6306: if (! grep(/\S/, values(%temp))) { next; }
6307: if (%temp) {
6308: $samples[$got]=\%temp;
6309: $got++;
6310: if ($got == $toget) { last; }
6311: }
6312: }
6313: return \@samples;
6314: }
6315:
1.144 matthew 6316: ######################################################
6317: ######################################################
6318:
1.56 matthew 6319: =pod
6320:
1.112 bowersj2 6321: =item * csv_print_samples($r,$records)
1.41 ng 6322:
6323: Prints a table of sample values from each column uploaded $r is an
6324: Apache Request ref, $records is an arrayref from
6325: &Apache::loncommon::upfile_record_sep
6326:
6327: =cut
6328:
1.144 matthew 6329: ######################################################
6330: ######################################################
1.31 albertel 6331: sub csv_print_samples {
6332: my ($r,$records) = @_;
1.301 albertel 6333: my $samples = &get_samples($records,3);
6334:
1.144 matthew 6335: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
1.356 albertel 6336: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6337: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.31 albertel 6338: $r->print('</tr>');
1.301 albertel 6339: foreach my $hash (@$samples) {
1.31 albertel 6340: $r->print('<tr>');
1.356 albertel 6341: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 6342: $r->print('<td>');
1.356 albertel 6343: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 6344: $r->print('</td>');
6345: }
6346: $r->print('</tr>');
6347: }
6348: $r->print('</tr></table><br />'."\n");
6349: }
6350:
1.144 matthew 6351: ######################################################
6352: ######################################################
6353:
1.56 matthew 6354: =pod
6355:
1.112 bowersj2 6356: =item * csv_print_select_table($r,$records,$d)
1.41 ng 6357:
6358: Prints a table to create associations between values and table columns.
1.144 matthew 6359:
1.41 ng 6360: $r is an Apache Request ref,
6361: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 6362: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 6363:
6364: =cut
6365:
1.144 matthew 6366: ######################################################
6367: ######################################################
1.31 albertel 6368: sub csv_print_select_table {
6369: my ($r,$records,$d) = @_;
1.301 albertel 6370: my $i=0;
6371: my $samples = &get_samples($records,1);
1.144 matthew 6372: $r->print(&mt('Associate columns with student attributes.')."\n".
6373: '<table border="2"><tr>'.
6374: '<th>'.&mt('Attribute').'</th>'.
6375: '<th>'.&mt('Column').'</th></tr>'."\n");
1.356 albertel 6376: foreach my $array_ref (@$d) {
6377: my ($value,$display,$defaultcol)=@{ $array_ref };
1.31 albertel 6378: $r->print('<tr><td>'.$display.'</td>');
6379:
6380: $r->print('<td><select name=f'.$i.
1.32 matthew 6381: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 6382: $r->print('<option value="none"></option>');
1.356 albertel 6383: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6384: $r->print('<option value="'.$sample.'"'.
6385: ($sample eq $defaultcol ? ' selected="selected" ' : '').
6386: '>Column '.($sample+1).'</option>');
1.31 albertel 6387: }
6388: $r->print('</select></td></tr>'."\n");
6389: $i++;
6390: }
6391: $i--;
6392: return $i;
6393: }
1.56 matthew 6394:
1.144 matthew 6395: ######################################################
6396: ######################################################
6397:
1.56 matthew 6398: =pod
1.31 albertel 6399:
1.112 bowersj2 6400: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 6401:
6402: Prints a table of sample values from the upload and can make associate samples to internal names.
6403:
6404: $r is an Apache Request ref,
6405: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
6406: $d is an array of 2 element arrays (internal name, displayed name)
6407:
6408: =cut
6409:
1.144 matthew 6410: ######################################################
6411: ######################################################
1.31 albertel 6412: sub csv_samples_select_table {
6413: my ($r,$records,$d) = @_;
6414: my $i=0;
1.144 matthew 6415: #
1.301 albertel 6416: my $samples = &get_samples($records,3);
1.144 matthew 6417: $r->print('<table border=2><tr><th>'.
6418: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.301 albertel 6419:
6420: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.144 matthew 6421: $r->print('<tr><td><select name="f'.$i.'"'.
1.32 matthew 6422: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 6423: foreach my $option (@$d) {
6424: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 6425: $r->print('<option value="'.$value.'"'.
1.253 albertel 6426: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 6427: $display.'</option>');
1.31 albertel 6428: }
6429: $r->print('</select></td><td>');
1.301 albertel 6430: foreach my $line (0..2) {
6431: if (defined($samples->[$line]{$key})) {
6432: $r->print($samples->[$line]{$key}."<br />\n");
6433: }
6434: }
1.31 albertel 6435: $r->print('</td></tr>');
6436: $i++;
6437: }
6438: $i--;
6439: return($i);
1.115 matthew 6440: }
6441:
1.144 matthew 6442: ######################################################
6443: ######################################################
6444:
1.115 matthew 6445: =pod
6446:
6447: =item clean_excel_name($name)
6448:
6449: Returns a replacement for $name which does not contain any illegal characters.
6450:
6451: =cut
6452:
1.144 matthew 6453: ######################################################
6454: ######################################################
1.115 matthew 6455: sub clean_excel_name {
6456: my ($name) = @_;
6457: $name =~ s/[:\*\?\/\\]//g;
6458: if (length($name) > 31) {
6459: $name = substr($name,0,31);
6460: }
6461: return $name;
1.25 albertel 6462: }
1.84 albertel 6463:
1.85 albertel 6464: =pod
6465:
1.112 bowersj2 6466: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 6467:
6468: Returns either 1 or undef
6469:
6470: 1 if the part is to be hidden, undef if it is to be shown
6471:
6472: Arguments are:
6473:
6474: $id the id of the part to be checked
6475: $symb, optional the symb of the resource to check
6476: $udom, optional the domain of the user to check for
6477: $uname, optional the username of the user to check for
6478:
6479: =cut
1.84 albertel 6480:
6481: sub check_if_partid_hidden {
6482: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 6483: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 6484: $symb,$udom,$uname);
1.141 albertel 6485: my $truth=1;
6486: #if the string starts with !, then the list is the list to show not hide
6487: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 6488: my @hiddenlist=split(/,/,$hiddenparts);
6489: foreach my $checkid (@hiddenlist) {
1.141 albertel 6490: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 6491: }
1.141 albertel 6492: return !$truth;
1.84 albertel 6493: }
1.127 matthew 6494:
1.138 matthew 6495:
6496: ############################################################
6497: ############################################################
6498:
6499: =pod
6500:
1.157 matthew 6501: =back
6502:
1.138 matthew 6503: =head1 cgi-bin script and graphing routines
6504:
1.157 matthew 6505: =over 4
6506:
1.138 matthew 6507: =item get_cgi_id
6508:
6509: Inputs: none
6510:
6511: Returns an id which can be used to pass environment variables
6512: to various cgi-bin scripts. These environment variables will
6513: be removed from the users environment after a given time by
6514: the routine &Apache::lonnet::transfer_profile_to_env.
6515:
6516: =cut
6517:
6518: ############################################################
6519: ############################################################
1.152 albertel 6520: my $uniq=0;
1.136 matthew 6521: sub get_cgi_id {
1.154 albertel 6522: $uniq=($uniq+1)%100000;
1.280 albertel 6523: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 6524: }
6525:
1.127 matthew 6526: ############################################################
6527: ############################################################
6528:
6529: =pod
6530:
1.134 matthew 6531: =item DrawBarGraph
1.127 matthew 6532:
1.138 matthew 6533: Facilitates the plotting of data in a (stacked) bar graph.
6534: Puts plot definition data into the users environment in order for
6535: graph.png to plot it. Returns an <img> tag for the plot.
6536: The bars on the plot are labeled '1','2',...,'n'.
6537:
6538: Inputs:
6539:
6540: =over 4
6541:
6542: =item $Title: string, the title of the plot
6543:
6544: =item $xlabel: string, text describing the X-axis of the plot
6545:
6546: =item $ylabel: string, text describing the Y-axis of the plot
6547:
6548: =item $Max: scalar, the maximum Y value to use in the plot
6549: If $Max is < any data point, the graph will not be rendered.
6550:
1.140 matthew 6551: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 6552: they are plotted. If undefined, default values will be used.
6553:
1.178 matthew 6554: =item $labels: array ref holding the labels to use on the x-axis for the bars.
6555:
1.138 matthew 6556: =item @Values: An array of array references. Each array reference holds data
6557: to be plotted in a stacked bar chart.
6558:
1.239 matthew 6559: =item If the final element of @Values is a hash reference the key/value
6560: pairs will be added to the graph definition.
6561:
1.138 matthew 6562: =back
6563:
6564: Returns:
6565:
6566: An <img> tag which references graph.png and the appropriate identifying
6567: information for the plot.
6568:
1.127 matthew 6569: =cut
6570:
6571: ############################################################
6572: ############################################################
1.134 matthew 6573: sub DrawBarGraph {
1.178 matthew 6574: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 6575: #
6576: if (! defined($colors)) {
6577: $colors = ['#33ff00',
6578: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
6579: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
6580: ];
6581: }
1.228 matthew 6582: my $extra_settings = {};
6583: if (ref($Values[-1]) eq 'HASH') {
6584: $extra_settings = pop(@Values);
6585: }
1.127 matthew 6586: #
1.136 matthew 6587: my $identifier = &get_cgi_id();
6588: my $id = 'cgi.'.$identifier;
1.129 matthew 6589: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 6590: return '';
6591: }
1.225 matthew 6592: #
6593: my @Labels;
6594: if (defined($labels)) {
6595: @Labels = @$labels;
6596: } else {
6597: for (my $i=0;$i<@{$Values[0]};$i++) {
6598: push (@Labels,$i+1);
6599: }
6600: }
6601: #
1.129 matthew 6602: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 6603: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 6604: my %ValuesHash;
6605: my $NumSets=1;
6606: foreach my $array (@Values) {
6607: next if (! ref($array));
1.136 matthew 6608: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 6609: join(',',@$array);
1.129 matthew 6610: }
1.127 matthew 6611: #
1.136 matthew 6612: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 6613: if ($NumBars < 3) {
6614: $width = 120+$NumBars*32;
1.220 matthew 6615: $xskip = 1;
1.225 matthew 6616: $bar_width = 30;
6617: } elsif ($NumBars < 5) {
6618: $width = 120+$NumBars*20;
6619: $xskip = 1;
6620: $bar_width = 20;
1.220 matthew 6621: } elsif ($NumBars < 10) {
1.136 matthew 6622: $width = 120+$NumBars*15;
6623: $xskip = 1;
6624: $bar_width = 15;
6625: } elsif ($NumBars <= 25) {
6626: $width = 120+$NumBars*11;
6627: $xskip = 5;
6628: $bar_width = 8;
6629: } elsif ($NumBars <= 50) {
6630: $width = 120+$NumBars*8;
6631: $xskip = 5;
6632: $bar_width = 4;
6633: } else {
6634: $width = 120+$NumBars*8;
6635: $xskip = 5;
6636: $bar_width = 4;
6637: }
6638: #
1.137 matthew 6639: $Max = 1 if ($Max < 1);
6640: if ( int($Max) < $Max ) {
6641: $Max++;
6642: $Max = int($Max);
6643: }
1.127 matthew 6644: $Title = '' if (! defined($Title));
6645: $xlabel = '' if (! defined($xlabel));
6646: $ylabel = '' if (! defined($ylabel));
1.369 www 6647: $ValuesHash{$id.'.title'} = &escape($Title);
6648: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
6649: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 6650: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 6651: $ValuesHash{$id.'.NumBars'} = $NumBars;
6652: $ValuesHash{$id.'.NumSets'} = $NumSets;
6653: $ValuesHash{$id.'.PlotType'} = 'bar';
6654: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6655: $ValuesHash{$id.'.height'} = $height;
6656: $ValuesHash{$id.'.width'} = $width;
6657: $ValuesHash{$id.'.xskip'} = $xskip;
6658: $ValuesHash{$id.'.bar_width'} = $bar_width;
6659: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 6660: #
1.228 matthew 6661: # Deal with other parameters
6662: while (my ($key,$value) = each(%$extra_settings)) {
6663: $ValuesHash{$id.'.'.$key} = $value;
6664: }
6665: #
1.137 matthew 6666: &Apache::lonnet::appenv(%ValuesHash);
6667: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6668: }
6669:
6670: ############################################################
6671: ############################################################
6672:
6673: =pod
6674:
6675: =item DrawXYGraph
6676:
1.138 matthew 6677: Facilitates the plotting of data in an XY graph.
6678: Puts plot definition data into the users environment in order for
6679: graph.png to plot it. Returns an <img> tag for the plot.
6680:
6681: Inputs:
6682:
6683: =over 4
6684:
6685: =item $Title: string, the title of the plot
6686:
6687: =item $xlabel: string, text describing the X-axis of the plot
6688:
6689: =item $ylabel: string, text describing the Y-axis of the plot
6690:
6691: =item $Max: scalar, the maximum Y value to use in the plot
6692: If $Max is < any data point, the graph will not be rendered.
6693:
6694: =item $colors: Array ref containing the hex color codes for the data to be
6695: plotted in. If undefined, default values will be used.
6696:
6697: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
6698:
6699: =item $Ydata: Array ref containing Array refs.
1.185 www 6700: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 6701:
6702: =item %Values: hash indicating or overriding any default values which are
6703: passed to graph.png.
6704: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
6705:
6706: =back
6707:
6708: Returns:
6709:
6710: An <img> tag which references graph.png and the appropriate identifying
6711: information for the plot.
6712:
1.137 matthew 6713: =cut
6714:
6715: ############################################################
6716: ############################################################
6717: sub DrawXYGraph {
6718: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
6719: #
6720: # Create the identifier for the graph
6721: my $identifier = &get_cgi_id();
6722: my $id = 'cgi.'.$identifier;
6723: #
6724: $Title = '' if (! defined($Title));
6725: $xlabel = '' if (! defined($xlabel));
6726: $ylabel = '' if (! defined($ylabel));
6727: my %ValuesHash =
6728: (
1.369 www 6729: $id.'.title' => &escape($Title),
6730: $id.'.xlabel' => &escape($xlabel),
6731: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 6732: $id.'.y_max_value'=> $Max,
6733: $id.'.labels' => join(',',@$Xlabels),
6734: $id.'.PlotType' => 'XY',
6735: );
6736: #
6737: if (defined($colors) && ref($colors) eq 'ARRAY') {
6738: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6739: }
6740: #
6741: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
6742: return '';
6743: }
6744: my $NumSets=1;
1.138 matthew 6745: foreach my $array (@{$Ydata}){
1.137 matthew 6746: next if (! ref($array));
6747: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
6748: }
1.138 matthew 6749: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 6750: #
6751: # Deal with other parameters
6752: while (my ($key,$value) = each(%Values)) {
6753: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 6754: }
6755: #
1.136 matthew 6756: &Apache::lonnet::appenv(%ValuesHash);
6757: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6758: }
6759:
6760: ############################################################
6761: ############################################################
6762:
6763: =pod
6764:
1.138 matthew 6765: =item DrawXYYGraph
6766:
6767: Facilitates the plotting of data in an XY graph with two Y axes.
6768: Puts plot definition data into the users environment in order for
6769: graph.png to plot it. Returns an <img> tag for the plot.
6770:
6771: Inputs:
6772:
6773: =over 4
6774:
6775: =item $Title: string, the title of the plot
6776:
6777: =item $xlabel: string, text describing the X-axis of the plot
6778:
6779: =item $ylabel: string, text describing the Y-axis of the plot
6780:
6781: =item $colors: Array ref containing the hex color codes for the data to be
6782: plotted in. If undefined, default values will be used.
6783:
6784: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
6785:
6786: =item $Ydata1: The first data set
6787:
6788: =item $Min1: The minimum value of the left Y-axis
6789:
6790: =item $Max1: The maximum value of the left Y-axis
6791:
6792: =item $Ydata2: The second data set
6793:
6794: =item $Min2: The minimum value of the right Y-axis
6795:
6796: =item $Max2: The maximum value of the left Y-axis
6797:
6798: =item %Values: hash indicating or overriding any default values which are
6799: passed to graph.png.
6800: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
6801:
6802: =back
6803:
6804: Returns:
6805:
6806: An <img> tag which references graph.png and the appropriate identifying
6807: information for the plot.
1.136 matthew 6808:
6809: =cut
6810:
6811: ############################################################
6812: ############################################################
1.137 matthew 6813: sub DrawXYYGraph {
6814: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
6815: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 6816: #
6817: # Create the identifier for the graph
6818: my $identifier = &get_cgi_id();
6819: my $id = 'cgi.'.$identifier;
6820: #
6821: $Title = '' if (! defined($Title));
6822: $xlabel = '' if (! defined($xlabel));
6823: $ylabel = '' if (! defined($ylabel));
6824: my %ValuesHash =
6825: (
1.369 www 6826: $id.'.title' => &escape($Title),
6827: $id.'.xlabel' => &escape($xlabel),
6828: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 6829: $id.'.labels' => join(',',@$Xlabels),
6830: $id.'.PlotType' => 'XY',
6831: $id.'.NumSets' => 2,
1.137 matthew 6832: $id.'.two_axes' => 1,
6833: $id.'.y1_max_value' => $Max1,
6834: $id.'.y1_min_value' => $Min1,
6835: $id.'.y2_max_value' => $Max2,
6836: $id.'.y2_min_value' => $Min2,
1.136 matthew 6837: );
6838: #
1.137 matthew 6839: if (defined($colors) && ref($colors) eq 'ARRAY') {
6840: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6841: }
6842: #
6843: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
6844: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 6845: return '';
6846: }
6847: my $NumSets=1;
1.137 matthew 6848: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 6849: next if (! ref($array));
6850: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 6851: }
6852: #
6853: # Deal with other parameters
6854: while (my ($key,$value) = each(%Values)) {
6855: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 6856: }
6857: #
6858: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 6859: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 6860: }
6861:
6862: ############################################################
6863: ############################################################
6864:
6865: =pod
6866:
1.157 matthew 6867: =back
6868:
1.139 matthew 6869: =head1 Statistics helper routines?
6870:
6871: Bad place for them but what the hell.
6872:
1.157 matthew 6873: =over 4
6874:
1.139 matthew 6875: =item &chartlink
6876:
6877: Returns a link to the chart for a specific student.
6878:
6879: Inputs:
6880:
6881: =over 4
6882:
6883: =item $linktext: The text of the link
6884:
6885: =item $sname: The students username
6886:
6887: =item $sdomain: The students domain
6888:
6889: =back
6890:
1.157 matthew 6891: =back
6892:
1.139 matthew 6893: =cut
6894:
6895: ############################################################
6896: ############################################################
6897: sub chartlink {
6898: my ($linktext, $sname, $sdomain) = @_;
6899: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 6900: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 6901: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 6902: '">'.$linktext.'</a>';
1.153 matthew 6903: }
6904:
6905: #######################################################
6906: #######################################################
6907:
6908: =pod
6909:
6910: =head1 Course Environment Routines
1.157 matthew 6911:
6912: =over 4
1.153 matthew 6913:
6914: =item &restore_course_settings
6915:
6916: =item &store_course_settings
6917:
6918: Restores/Store indicated form parameters from the course environment.
6919: Will not overwrite existing values of the form parameters.
6920:
6921: Inputs:
6922: a scalar describing the data (e.g. 'chart', 'problem_analysis')
6923:
6924: a hash ref describing the data to be stored. For example:
6925:
6926: %Save_Parameters = ('Status' => 'scalar',
6927: 'chartoutputmode' => 'scalar',
6928: 'chartoutputdata' => 'scalar',
6929: 'Section' => 'array',
1.373 raeburn 6930: 'Group' => 'array',
1.153 matthew 6931: 'StudentData' => 'array',
6932: 'Maps' => 'array');
6933:
6934: Returns: both routines return nothing
6935:
6936: =cut
6937:
6938: #######################################################
6939: #######################################################
6940: sub store_course_settings {
1.496 albertel 6941: return &store_settings($env{'request.course.id'},@_);
6942: }
6943:
6944: sub store_settings {
1.153 matthew 6945: # save to the environment
6946: # appenv the same items, just to be safe
1.300 albertel 6947: my $udom = $env{'user.domain'};
6948: my $uname = $env{'user.name'};
1.496 albertel 6949: my ($context,$prefix,$Settings) = @_;
1.153 matthew 6950: my %SaveHash;
6951: my %AppHash;
6952: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 6953: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 6954: my $envname = 'environment.'.$basename;
1.258 albertel 6955: if (exists($env{'form.'.$setting})) {
1.153 matthew 6956: # Save this value away
6957: if ($type eq 'scalar' &&
1.258 albertel 6958: (! exists($env{$envname}) ||
6959: $env{$envname} ne $env{'form.'.$setting})) {
6960: $SaveHash{$basename} = $env{'form.'.$setting};
6961: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 6962: } elsif ($type eq 'array') {
6963: my $stored_form;
1.258 albertel 6964: if (ref($env{'form.'.$setting})) {
1.153 matthew 6965: $stored_form = join(',',
6966: map {
1.369 www 6967: &escape($_);
1.258 albertel 6968: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 6969: } else {
6970: $stored_form =
1.369 www 6971: &escape($env{'form.'.$setting});
1.153 matthew 6972: }
6973: # Determine if the array contents are the same.
1.258 albertel 6974: if ($stored_form ne $env{$envname}) {
1.153 matthew 6975: $SaveHash{$basename} = $stored_form;
6976: $AppHash{$envname} = $stored_form;
6977: }
6978: }
6979: }
6980: }
6981: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 6982: $udom,$uname);
1.153 matthew 6983: if ($put_result !~ /^(ok|delayed)/) {
6984: &Apache::lonnet::logthis('unable to save form parameters, '.
6985: 'got error:'.$put_result);
6986: }
6987: # Make sure these settings stick around in this session, too
6988: &Apache::lonnet::appenv(%AppHash);
6989: return;
6990: }
6991:
6992: sub restore_course_settings {
1.499 albertel 6993: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 6994: }
6995:
6996: sub restore_settings {
6997: my ($context,$prefix,$Settings) = @_;
1.153 matthew 6998: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 6999: next if (exists($env{'form.'.$setting}));
1.496 albertel 7000: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 7001: '.'.$setting;
1.258 albertel 7002: if (exists($env{$envname})) {
1.153 matthew 7003: if ($type eq 'scalar') {
1.258 albertel 7004: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 7005: } elsif ($type eq 'array') {
1.258 albertel 7006: $env{'form.'.$setting} = [
1.153 matthew 7007: map {
1.369 www 7008: &unescape($_);
1.258 albertel 7009: } split(',',$env{$envname})
1.153 matthew 7010: ];
7011: }
7012: }
7013: }
1.127 matthew 7014: }
7015:
7016: ############################################################
7017: ############################################################
1.154 albertel 7018:
1.443 albertel 7019: sub commit_customrole {
7020: my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
7021: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
7022: ($start?', '.&mt('starting').' '.localtime($start):'').
7023: ($end?', ending '.localtime($end):'').': <b>'.
7024: &Apache::lonnet::assigncustomrole(
7025: $udom,$uname,$url,$three,$four,$five,$end,$start).
7026: '</b><br />';
7027: return $output;
7028: }
7029:
7030: sub commit_standardrole {
1.541 raeburn 7031: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
7032: my ($output,$logmsg,$linefeed);
7033: if ($context eq 'auto') {
7034: $linefeed = "\n";
7035: } else {
7036: $linefeed = "<br />\n";
7037: }
1.443 albertel 7038: if ($three eq 'st') {
1.541 raeburn 7039: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
7040: $one,$two,$sec,$context);
7041: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
7042: ($result eq 'unknown_course')) {
1.443 albertel 7043: $output = "Error: $result\n";
7044: } else {
1.541 raeburn 7045: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 7046: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 7047: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
7048: if ($context eq 'auto') {
7049: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
7050: } else {
7051: $output .= '<b>'.$result.'</b>'.$linefeed.
7052: &mt('Add to classlist').': <b>ok</b>';
7053: }
7054: $output .= $linefeed;
1.443 albertel 7055: }
7056: } else {
7057: $output = &mt('Assigning').' '.$three.' in '.$url.
7058: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 7059: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
7060: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);
7061: if ($context eq 'auto') {
7062: $output .= $result.$linefeed;
7063: } else {
7064: $output .= '<b>'.$result.'</b>'.$linefeed;
7065: }
1.443 albertel 7066: }
7067: return $output;
7068: }
7069:
7070: sub commit_studentrole {
1.541 raeburn 7071: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
7072: my ($result,$linefeed);
7073: if ($context eq 'auto') {
7074: $linefeed = "\n";
7075: } else {
7076: $linefeed = '<br />'."\n";
7077: }
1.443 albertel 7078: if (defined($one) && defined($two)) {
7079: my $cid=$one.'_'.$two;
7080: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
7081: my $secchange = 0;
7082: my $expire_role_result;
7083: my $modify_section_result;
7084: unless ($oldsec eq '-1') {
7085: unless ($sec eq $oldsec) {
7086: $secchange = 1;
7087: my $uurl='/'.$cid;
7088: $uurl=~s/\_/\//g;
7089: if ($oldsec) {
7090: $uurl.='/'.$oldsec;
7091: }
7092: $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);
7093: $result = $expire_role_result;
7094: }
7095: }
7096: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
7097: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
7098: if ($modify_section_result =~ /^ok/) {
7099: if ($secchange == 1) {
7100: $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;
7101: } elsif ($oldsec eq '-1') {
7102: $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;
7103: } else {
7104: $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;
7105: }
7106: } else {
7107: $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;
7108: }
7109: $result = $modify_section_result;
7110: } elsif ($secchange == 1) {
7111: $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;
7112: }
7113: } else {
7114: $$logmsg .= "Incomplete course id defined. Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";
7115: $result = "error: incomplete course id\n";
7116: }
7117: return $result;
7118: }
7119:
7120: ############################################################
7121: ############################################################
7122:
1.566 albertel 7123: sub check_clone {
1.578 raeburn 7124: my ($args,$linefeed) = @_;
1.566 albertel 7125: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
7126: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
7127: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
7128: my $clonemsg;
7129: my $can_clone = 0;
7130:
7131: if ($clonehome eq 'no_host') {
1.578 raeburn 7132: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
1.566 albertel 7133: } else {
7134: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 7135: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 7136: $can_clone = 1;
7137: } else {
7138: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
7139: $args->{'clonedomain'},$args->{'clonecourse'});
7140: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 7141: if (grep(/^\*$/,@cloners)) {
7142: $can_clone = 1;
7143: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
7144: $can_clone = 1;
7145: } else {
7146: my %roleshash =
7147: &Apache::lonnet::get_my_roles($args->{'ccuname'},
7148: $args->{'ccdomain'},
7149: 'userroles',['active'],['cc'],
7150: [$args->{'clonedomain'}]);
7151: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
7152: $can_clone = 1;
7153: } else {
7154: $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
7155: }
1.566 albertel 7156: }
1.578 raeburn 7157: }
1.566 albertel 7158: }
7159: return ($can_clone, $clonemsg, $cloneid, $clonehome);
7160: }
7161:
1.444 albertel 7162: sub construct_course {
1.541 raeburn 7163: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 7164: my $outcome;
1.541 raeburn 7165: my $linefeed = '<br />'."\n";
7166: if ($context eq 'auto') {
7167: $linefeed = "\n";
7168: }
1.566 albertel 7169:
7170: #
7171: # Are we cloning?
7172: #
7173: my ($can_clone, $clonemsg, $cloneid, $clonehome);
7174: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 7175: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 7176: if ($context ne 'auto') {
1.578 raeburn 7177: if ($clonemsg ne '') {
7178: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
7179: }
1.566 albertel 7180: }
7181: $outcome .= $clonemsg.$linefeed;
7182:
7183: if (!$can_clone) {
7184: return (0,$outcome);
7185: }
7186: }
7187:
1.444 albertel 7188: #
7189: # Open course
7190: #
7191: my $crstype = lc($args->{'crstype'});
7192: my %cenv=();
7193: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
7194: $args->{'cdescr'},
7195: $args->{'curl'},
7196: $args->{'course_home'},
7197: $args->{'nonstandard'},
7198: $args->{'crscode'},
7199: $args->{'ccuname'}.':'.
7200: $args->{'ccdomain'},
7201: $args->{'crstype'});
7202:
7203: # Note: The testing routines depend on this being output; see
7204: # Utils::Course. This needs to at least be output as a comment
7205: # if anyone ever decides to not show this, and Utils::Course::new
7206: # will need to be suitably modified.
1.541 raeburn 7207: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 7208: #
7209: # Check if created correctly
7210: #
1.479 albertel 7211: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 7212: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 7213: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 7214:
1.444 albertel 7215: #
1.566 albertel 7216: # Do the cloning
7217: #
7218: if ($can_clone && $cloneid) {
7219: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
7220: if ($context ne 'auto') {
7221: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
7222: }
7223: $outcome .= $clonemsg.$linefeed;
7224: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 7225: # Copy all files
1.566 albertel 7226: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
1.444 albertel 7227: # Restore URL
1.566 albertel 7228: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 7229: # Restore title
1.566 albertel 7230: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 7231: # restore grading mode
1.566 albertel 7232: if (defined($oldcenv{'grading'})) {
7233: $cenv{'grading'}=$oldcenv{'grading'};
7234: }
1.444 albertel 7235: # Mark as cloned
1.566 albertel 7236: $cenv{'clonedfrom'}=$cloneid;
7237: delete($cenv{'default_enrollment_start_date'});
7238: delete($cenv{'default_enrollment_end_date'});
1.444 albertel 7239: }
1.566 albertel 7240:
1.444 albertel 7241: #
7242: # Set environment (will override cloned, if existing)
7243: #
7244: my @sections = ();
7245: my @xlists = ();
7246: if ($args->{'crstype'}) {
7247: $cenv{'type'}=$args->{'crstype'};
7248: }
7249: if ($args->{'crsid'}) {
7250: $cenv{'courseid'}=$args->{'crsid'};
7251: }
7252: if ($args->{'crscode'}) {
7253: $cenv{'internal.coursecode'}=$args->{'crscode'};
7254: }
7255: if ($args->{'crsquota'} ne '') {
7256: $cenv{'internal.coursequota'}=$args->{'crsquota'};
7257: } else {
7258: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
7259: }
7260: if ($args->{'ccuname'}) {
7261: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
7262: ':'.$args->{'ccdomain'};
7263: } else {
7264: $cenv{'internal.courseowner'} = $args->{'curruser'};
7265: }
7266:
7267: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
7268: if ($args->{'crssections'}) {
7269: $cenv{'internal.sectionnums'} = '';
7270: if ($args->{'crssections'} =~ m/,/) {
7271: @sections = split/,/,$args->{'crssections'};
7272: } else {
7273: $sections[0] = $args->{'crssections'};
7274: }
7275: if (@sections > 0) {
7276: foreach my $item (@sections) {
7277: my ($sec,$gp) = split/:/,$item;
7278: my $class = $args->{'crscode'}.$sec;
7279: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
7280: $cenv{'internal.sectionnums'} .= $item.',';
7281: unless ($addcheck eq 'ok') {
7282: push @badclasses, $class;
7283: }
7284: }
7285: $cenv{'internal.sectionnums'} =~ s/,$//;
7286: }
7287: }
7288: # do not hide course coordinator from staff listing,
7289: # even if privileged
7290: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7291: # add crosslistings
7292: if ($args->{'crsxlist'}) {
7293: $cenv{'internal.crosslistings'}='';
7294: if ($args->{'crsxlist'} =~ m/,/) {
7295: @xlists = split/,/,$args->{'crsxlist'};
7296: } else {
7297: $xlists[0] = $args->{'crsxlist'};
7298: }
7299: if (@xlists > 0) {
7300: foreach my $item (@xlists) {
7301: my ($xl,$gp) = split/:/,$item;
7302: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
7303: $cenv{'internal.crosslistings'} .= $item.',';
7304: unless ($addcheck eq 'ok') {
7305: push @badclasses, $xl;
7306: }
7307: }
7308: $cenv{'internal.crosslistings'} =~ s/,$//;
7309: }
7310: }
7311: if ($args->{'autoadds'}) {
7312: $cenv{'internal.autoadds'}=$args->{'autoadds'};
7313: }
7314: if ($args->{'autodrops'}) {
7315: $cenv{'internal.autodrops'}=$args->{'autodrops'};
7316: }
7317: # check for notification of enrollment changes
7318: my @notified = ();
7319: if ($args->{'notify_owner'}) {
7320: if ($args->{'ccuname'} ne '') {
7321: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
7322: }
7323: }
7324: if ($args->{'notify_dc'}) {
7325: if ($uname ne '') {
7326: push(@notified,$uname.'@'.$udom);
7327: }
7328: }
7329: if (@notified > 0) {
7330: my $notifylist;
7331: if (@notified > 1) {
7332: $notifylist = join(',',@notified);
7333: } else {
7334: $notifylist = $notified[0];
7335: }
7336: $cenv{'internal.notifylist'} = $notifylist;
7337: }
7338: if (@badclasses > 0) {
7339: my %lt=&Apache::lonlocal::texthash(
7340: 'tclb' => 'The courses listed below were included as sections or crosslistings affiliated with your new LON-CAPA course. However, if automated course roster updates are enabled for this class, these particular sections/crosslistings will not contribute towards enrollment, because the user identified as the course owner for this LON-CAPA course',
7341: 'dnhr' => 'does not have rights to access enrollment in these classes',
7342: 'adby' => 'as determined by the policies of your institution on access to official classlists'
7343: );
1.541 raeburn 7344: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
7345: ' ('.$lt{'adby'}.')';
7346: if ($context eq 'auto') {
7347: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 7348: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 7349: foreach my $item (@badclasses) {
7350: if ($context eq 'auto') {
7351: $outcome .= " - $item\n";
7352: } else {
7353: $outcome .= "<li>$item</li>\n";
7354: }
7355: }
7356: if ($context eq 'auto') {
7357: $outcome .= $linefeed;
7358: } else {
1.566 albertel 7359: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 7360: }
7361: }
1.444 albertel 7362: }
7363: if ($args->{'no_end_date'}) {
7364: $args->{'endaccess'} = 0;
7365: }
7366: $cenv{'internal.autostart'}=$args->{'enrollstart'};
7367: $cenv{'internal.autoend'}=$args->{'enrollend'};
7368: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
7369: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
7370: if ($args->{'showphotos'}) {
7371: $cenv{'internal.showphotos'}=$args->{'showphotos'};
7372: }
7373: $cenv{'internal.authtype'} = $args->{'authtype'};
7374: $cenv{'internal.autharg'} = $args->{'autharg'};
7375: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
7376: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 7377: my $krb_msg = &mt('As you did not include the default Kerberos domain to be used for authentication in this class, the institutional data used by the automated enrollment process must include the Kerberos domain for each new student');
7378: if ($context eq 'auto') {
7379: $outcome .= $krb_msg;
7380: } else {
1.566 albertel 7381: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 7382: }
7383: $outcome .= $linefeed;
1.444 albertel 7384: }
7385: }
7386: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
7387: if ($args->{'setpolicy'}) {
7388: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7389: }
7390: if ($args->{'setcontent'}) {
7391: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7392: }
7393: }
7394: if ($args->{'reshome'}) {
7395: $cenv{'reshome'}=$args->{'reshome'}.'/';
7396: $cenv{'reshome'}=~s/\/+$/\//;
7397: }
7398: #
7399: # course has keyed access
7400: #
7401: if ($args->{'setkeys'}) {
7402: $cenv{'keyaccess'}='yes';
7403: }
7404: # if specified, key authority is not course, but user
7405: # only active if keyaccess is yes
7406: if ($args->{'keyauth'}) {
1.487 albertel 7407: my ($user,$domain) = split(':',$args->{'keyauth'});
7408: $user = &LONCAPA::clean_username($user);
7409: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 7410: if ($user ne '' && $domain ne '') {
1.487 albertel 7411: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 7412: }
7413: }
7414:
7415: if ($args->{'disresdis'}) {
7416: $cenv{'pch.roles.denied'}='st';
7417: }
7418: if ($args->{'disablechat'}) {
7419: $cenv{'plc.roles.denied'}='st';
7420: }
7421:
7422: # Record we've not yet viewed the Course Initialization Helper for this
7423: # course
7424: $cenv{'course.helper.not.run'} = 1;
7425: #
7426: # Use new Randomseed
7427: #
7428: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
7429: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
7430: #
7431: # The encryption code and receipt prefix for this course
7432: #
7433: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
7434: $cenv{'internal.encpref'}=100+int(9*rand(99));
7435: #
7436: # By default, use standard grading
7437: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
7438:
1.541 raeburn 7439: $outcome .= $linefeed.&mt('Setting environment').': '.
7440: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 7441: #
7442: # Open all assignments
7443: #
7444: if ($args->{'openall'}) {
7445: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
7446: my %storecontent = ($storeunder => time,
7447: $storeunder.'.type' => 'date_start');
7448:
7449: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 7450: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 7451: }
7452: #
7453: # Set first page
7454: #
7455: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
7456: || ($cloneid)) {
1.445 albertel 7457: use LONCAPA::map;
1.444 albertel 7458: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 7459:
7460: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
7461: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
7462:
1.444 albertel 7463: $outcome .= ($fatal?$errtext:'read ok').' - ';
7464: my $title; my $url;
7465: if ($args->{'firstres'} eq 'syl') {
7466: $title='Syllabus';
7467: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
7468: } else {
7469: $title='Navigate Contents';
7470: $url='/adm/navmaps';
7471: }
1.445 albertel 7472:
7473: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
7474: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
7475:
7476: if ($errtext) { $fatal=2; }
1.541 raeburn 7477: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 7478: }
1.566 albertel 7479:
7480: return (1,$outcome);
1.444 albertel 7481: }
7482:
7483: ############################################################
7484: ############################################################
7485:
1.378 raeburn 7486: sub course_type {
7487: my ($cid) = @_;
7488: if (!defined($cid)) {
7489: $cid = $env{'request.course.id'};
7490: }
1.404 albertel 7491: if (defined($env{'course.'.$cid.'.type'})) {
7492: return $env{'course.'.$cid.'.type'};
1.378 raeburn 7493: } else {
7494: return 'Course';
1.377 raeburn 7495: }
7496: }
1.156 albertel 7497:
1.406 raeburn 7498: sub group_term {
7499: my $crstype = &course_type();
7500: my %names = (
7501: 'Course' => 'group',
7502: 'Group' => 'team',
7503: );
7504: return $names{$crstype};
7505: }
7506:
1.156 albertel 7507: sub icon {
7508: my ($file)=@_;
1.505 albertel 7509: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 7510: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 7511: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 7512: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
7513: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
7514: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
7515: $curfext.".gif") {
7516: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
7517: $curfext.".gif";
7518: }
7519: }
1.249 albertel 7520: return &lonhttpdurl($iconname);
1.154 albertel 7521: }
1.84 albertel 7522:
1.575 albertel 7523: sub lonhttpd_port {
1.215 albertel 7524: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
7525: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
1.574 albertel 7526: # IE doesn't like a secure page getting images from a non-secure
7527: # port (when logging we haven't parsed the browser type so default
7528: # back to secure
7529: if ((!exists($env{'browser.type'}) || $env{'browser.type'} eq 'explorer')
7530: && $ENV{'SERVER_PORT'} == 443) {
1.575 albertel 7531: return 443;
7532: }
7533: return $lonhttpd_port;
7534:
7535: }
7536:
7537: sub lonhttpdurl {
7538: my ($url)=@_;
7539:
7540: my $lonhttpd_port = &lonhttpd_port();
7541: if ($lonhttpd_port == 443) {
1.574 albertel 7542: return 'https://'.$ENV{'SERVER_NAME'}.$url;
7543: }
1.215 albertel 7544: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
7545: }
7546:
1.213 albertel 7547: sub connection_aborted {
7548: my ($r)=@_;
7549: $r->print(" ");$r->rflush();
7550: my $c = $r->connection;
7551: return $c->aborted();
7552: }
7553:
1.221 foxr 7554: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 7555: # strings as 'strings'.
7556: sub escape_single {
1.221 foxr 7557: my ($input) = @_;
1.223 albertel 7558: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 7559: $input =~ s/\'/\\\'/g; # Esacpe the 's....
7560: return $input;
7561: }
1.223 albertel 7562:
1.222 foxr 7563: # Same as escape_single, but escape's "'s This
7564: # can be used for "strings"
7565: sub escape_double {
7566: my ($input) = @_;
7567: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
7568: $input =~ s/\"/\\\"/g; # Esacpe the "s....
7569: return $input;
7570: }
1.223 albertel 7571:
1.222 foxr 7572: # Escapes the last element of a full URL.
7573: sub escape_url {
7574: my ($url) = @_;
1.238 raeburn 7575: my @urlslices = split(/\//, $url,-1);
1.369 www 7576: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 7577: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 7578: }
1.462 albertel 7579:
7580: # -------------------------------------------------------- Initliaze user login
7581: sub init_user_environment {
1.463 albertel 7582: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 7583: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
7584:
7585: my $public=($username eq 'public' && $domain eq 'public');
7586:
7587: # See if old ID present, if so, remove
7588:
7589: my ($filename,$cookie,$userroles);
7590: my $now=time;
7591:
7592: if ($public) {
7593: my $max_public=100;
7594: my $oldest;
7595: my $oldest_time=0;
7596: for(my $next=1;$next<=$max_public;$next++) {
7597: if (-e $lonids."/publicuser_$next.id") {
7598: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
7599: if ($mtime<$oldest_time || !$oldest_time) {
7600: $oldest_time=$mtime;
7601: $oldest=$next;
7602: }
7603: } else {
7604: $cookie="publicuser_$next";
7605: last;
7606: }
7607: }
7608: if (!$cookie) { $cookie="publicuser_$oldest"; }
7609: } else {
1.463 albertel 7610: # if this isn't a robot, kill any existing non-robot sessions
7611: if (!$args->{'robot'}) {
7612: opendir(DIR,$lonids);
7613: while ($filename=readdir(DIR)) {
7614: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
7615: unlink($lonids.'/'.$filename);
7616: }
1.462 albertel 7617: }
1.463 albertel 7618: closedir(DIR);
1.462 albertel 7619: }
7620: # Give them a new cookie
1.463 albertel 7621: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
7622: : $now);
7623: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 7624:
7625: # Initialize roles
7626:
7627: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
7628: }
7629: # ------------------------------------ Check browser type and MathML capability
7630:
7631: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
7632: $clientunicode,$clientos) = &decode_user_agent($r);
7633:
7634: # -------------------------------------- Any accessibility options to remember?
7635: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
7636: foreach my $option ('imagesuppress','appletsuppress',
7637: 'embedsuppress','fontenhance','blackwhite') {
7638: if ($form->{$option} eq 'true') {
7639: &Apache::lonnet::put('environment',{$option => 'on'},
7640: $domain,$username);
7641: } else {
7642: &Apache::lonnet::del('environment',[$option],
7643: $domain,$username);
7644: }
7645: }
7646: }
7647: # ------------------------------------------------------------- Get environment
7648:
7649: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
7650: my ($tmp) = keys(%userenv);
7651: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7652: # default remote control to off
7653: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
7654: } else {
7655: undef(%userenv);
7656: }
7657: if (($userenv{'interface'}) && (!$form->{'interface'})) {
7658: $form->{'interface'}=$userenv{'interface'};
7659: }
7660: $env{'environment.remote'}=$userenv{'remote'};
7661: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
7662:
7663: # --------------- Do not trust query string to be put directly into environment
7664: foreach my $option ('imagesuppress','appletsuppress',
7665: 'embedsuppress','fontenhance','blackwhite',
7666: 'interface','localpath','localres') {
7667: $form->{$option}=~s/[\n\r\=]//gs;
7668: }
7669: # --------------------------------------------------------- Write first profile
7670:
7671: {
7672: my %initial_env =
7673: ("user.name" => $username,
7674: "user.domain" => $domain,
7675: "user.home" => $authhost,
7676: "browser.type" => $clientbrowser,
7677: "browser.version" => $clientversion,
7678: "browser.mathml" => $clientmathml,
7679: "browser.unicode" => $clientunicode,
7680: "browser.os" => $clientos,
7681: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
7682: "request.course.fn" => '',
7683: "request.course.uri" => '',
7684: "request.course.sec" => '',
7685: "request.role" => 'cm',
7686: "request.role.adv" => $env{'user.adv'},
7687: "request.host" => $ENV{'REMOTE_ADDR'},);
7688:
7689: if ($form->{'localpath'}) {
7690: $initial_env{"browser.localpath"} = $form->{'localpath'};
7691: $initial_env{"browser.localres"} = $form->{'localres'};
7692: }
7693:
7694: if ($public) {
7695: $initial_env{"environment.remote"} = "off";
7696: }
7697: if ($form->{'interface'}) {
7698: $form->{'interface'}=~s/\W//gs;
7699: $initial_env{"browser.interface"} = $form->{'interface'};
7700: $env{'browser.interface'}=$form->{'interface'};
7701: foreach my $option ('imagesuppress','appletsuppress',
7702: 'embedsuppress','fontenhance','blackwhite') {
7703: if (($form->{$option} eq 'true') ||
7704: ($userenv{$option} eq 'on')) {
7705: $initial_env{"browser.$option"} = "on";
7706: }
7707: }
7708: }
7709:
7710: $env{'user.environment'} = "$lonids/$cookie.id";
7711:
7712: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
7713: &GDBM_WRCREAT(),0640)) {
7714: &_add_to_env(\%disk_env,\%initial_env);
7715: &_add_to_env(\%disk_env,\%userenv,'environment.');
7716: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 7717: if (ref($args->{'extra_env'})) {
7718: &_add_to_env(\%disk_env,$args->{'extra_env'});
7719: }
1.462 albertel 7720: untie(%disk_env);
7721: } else {
7722: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
7723: 'Could not create environment storage in lonauth: '.$!.'</font>');
7724: return 'error: '.$!;
7725: }
7726: }
7727: $env{'request.role'}='cm';
7728: $env{'request.role.adv'}=$env{'user.adv'};
7729: $env{'browser.type'}=$clientbrowser;
7730:
7731: return $cookie;
7732:
7733: }
7734:
7735: sub _add_to_env {
7736: my ($idf,$env_data,$prefix) = @_;
7737: while (my ($key,$value) = each(%$env_data)) {
7738: $idf->{$prefix.$key} = $value;
7739: $env{$prefix.$key} = $value;
7740: }
7741: }
7742:
7743:
1.41 ng 7744: =pod
7745:
7746: =back
7747:
1.112 bowersj2 7748: =cut
1.41 ng 7749:
1.112 bowersj2 7750: 1;
7751: __END__;
1.41 ng 7752:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to loncommon.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / interface