Annotation of loncom/interface/loncommon.pm, revision 1.582
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.582 ! albertel 4: # $Id: loncommon.pm,v 1.581 2007/09/10 23:03:38 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.162 www 2534: my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
2535: if ($browser) {
2536: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
2537: }
1.514 albertel 2538: if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {
1.118 www 2539: @languages=(@languages,
1.514 albertel 2540: &Apache::lonnet::domain($env{'user.domain'},
2541: 'lang_def'));
1.118 www 2542: }
1.514 albertel 2543: if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {
1.118 www 2544: @languages=(@languages,
1.514 albertel 2545: &Apache::lonnet::domain($env{'request.role.domain'},
2546: 'lang_def'));
1.118 www 2547: }
1.514 albertel 2548: if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2549: 'lang_def')) {
1.118 www 2550: @languages=(@languages,
1.514 albertel 2551: &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2552: 'lang_def'));
1.118 www 2553: }
2554: # turn "en-ca" into "en-ca,en"
2555: my @genlanguages;
1.356 albertel 2556: foreach my $lang (@languages) {
2557: unless ($lang=~/\w/) { next; }
2558: push (@genlanguages,$lang);
2559: if ($lang=~/(\-|\_)/) {
2560: push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
1.118 www 2561: }
2562: }
2563: return @genlanguages;
1.117 www 2564: }
2565:
1.582 ! albertel 2566: sub languages {
! 2567: my ($possible_langs) = @_;
! 2568: my @preferred_langs = &preferred_languages();
! 2569: if (!ref($possible_langs)) {
! 2570: if( wantarray ) {
! 2571: return @preferred_langs;
! 2572: } else {
! 2573: return $preferred_langs[0];
! 2574: }
! 2575: }
! 2576: my %possibilities = map { $_ => 1 } (@$possible_langs);
! 2577: my @preferred_possibilities;
! 2578: foreach my $preferred_lang (@preferred_langs) {
! 2579: if (exists($possibilities{$preferred_lang})) {
! 2580: push(@preferred_possibilities, $preferred_lang);
! 2581: }
! 2582: }
! 2583: if( wantarray ) {
! 2584: return @preferred_possibilities;
! 2585: }
! 2586: return $preferred_possibilities[0];
! 2587: }
! 2588:
1.112 bowersj2 2589: ###############################################################
2590: ## Student Answer Attempts ##
2591: ###############################################################
2592:
2593: =pod
2594:
2595: =head1 Alternate Problem Views
2596:
2597: =over 4
2598:
2599: =item * get_previous_attempt($symb, $username, $domain, $course,
2600: $getattempt, $regexp, $gradesub)
2601:
2602: Return string with previous attempt on problem. Arguments:
2603:
2604: =over 4
2605:
2606: =item * $symb: Problem, including path
2607:
2608: =item * $username: username of the desired student
2609:
2610: =item * $domain: domain of the desired student
1.14 harris41 2611:
1.112 bowersj2 2612: =item * $course: Course ID
1.14 harris41 2613:
1.112 bowersj2 2614: =item * $getattempt: Leave blank for all attempts, otherwise put
2615: something
1.14 harris41 2616:
1.112 bowersj2 2617: =item * $regexp: if string matches this regexp, the string will be
2618: sent to $gradesub
1.14 harris41 2619:
1.112 bowersj2 2620: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 2621:
1.112 bowersj2 2622: =back
1.14 harris41 2623:
1.112 bowersj2 2624: The output string is a table containing all desired attempts, if any.
1.16 harris41 2625:
1.112 bowersj2 2626: =cut
1.1 albertel 2627:
2628: sub get_previous_attempt {
1.43 ng 2629: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 2630: my $prevattempts='';
1.43 ng 2631: no strict 'refs';
1.1 albertel 2632: if ($symb) {
1.3 albertel 2633: my (%returnhash)=
2634: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 2635: if ($returnhash{'version'}) {
2636: my %lasthash=();
2637: my $version;
2638: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 2639: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
2640: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 2641: }
1.1 albertel 2642: }
1.43 ng 2643: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40 ng 2644: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.356 albertel 2645: foreach my $key (sort(keys(%lasthash))) {
2646: my ($ign,@parts) = split(/\./,$key);
1.41 ng 2647: if ($#parts > 0) {
1.31 albertel 2648: my $data=$parts[-1];
2649: pop(@parts);
1.40 ng 2650: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
1.31 albertel 2651: } else {
1.41 ng 2652: if ($#parts == 0) {
2653: $prevattempts.='<th>'.$parts[0].'</th>';
2654: } else {
2655: $prevattempts.='<th>'.$ign.'</th>';
2656: }
1.31 albertel 2657: }
1.16 harris41 2658: }
1.40 ng 2659: if ($getattempt eq '') {
2660: for ($version=1;$version<=$returnhash{'version'};$version++) {
2661: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
1.356 albertel 2662: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 2663: my $value = &format_previous_attempt_value($key,
2664: $returnhash{$version.':'.$key});
2665: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 2666: }
2667: }
1.1 albertel 2668: }
1.40 ng 2669: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.356 albertel 2670: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 2671: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 2672: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 2673: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 2674: }
1.40 ng 2675: $prevattempts.='</tr></table></td></tr></table>';
1.1 albertel 2676: } else {
2677: $prevattempts='Nothing submitted - no attempts.';
2678: }
2679: } else {
2680: $prevattempts='No data.';
2681: }
1.10 albertel 2682: }
2683:
1.581 albertel 2684: sub format_previous_attempt_value {
2685: my ($key,$value) = @_;
2686: if ($key =~ /timestamp/) {
2687: $value = &Apache::lonlocal::locallocaltime($value);
2688: } elsif (ref($value) eq 'ARRAY') {
2689: $value = '('.join(', ', @{ $value }).')';
2690: } else {
2691: $value = &unescape($value);
2692: }
2693: return $value;
2694: }
2695:
2696:
1.107 albertel 2697: sub relative_to_absolute {
2698: my ($url,$output)=@_;
2699: my $parser=HTML::TokeParser->new(\$output);
2700: my $token;
2701: my $thisdir=$url;
2702: my @rlinks=();
2703: while ($token=$parser->get_token) {
2704: if ($token->[0] eq 'S') {
2705: if ($token->[1] eq 'a') {
2706: if ($token->[2]->{'href'}) {
2707: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2708: }
2709: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2710: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2711: } elsif ($token->[1] eq 'base') {
2712: $thisdir=$token->[2]->{'href'};
2713: }
2714: }
2715: }
2716: $thisdir=~s-/[^/]*$--;
1.356 albertel 2717: foreach my $link (@rlinks) {
2718: unless (($link=~/^http:\/\//i) ||
2719: ($link=~/^\//) ||
2720: ($link=~/^javascript:/i) ||
2721: ($link=~/^mailto:/i) ||
2722: ($link=~/^\#/)) {
2723: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
2724: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 2725: }
2726: }
2727: # -------------------------------------------------- Deal with Applet codebases
2728: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2729: return $output;
2730: }
2731:
1.112 bowersj2 2732: =pod
2733:
2734: =item * get_student_view
2735:
2736: show a snapshot of what student was looking at
2737:
2738: =cut
2739:
1.10 albertel 2740: sub get_student_view {
1.186 albertel 2741: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 2742: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2743: my (%form);
1.10 albertel 2744: my @elements=('symb','courseid','domain','username');
2745: foreach my $element (@elements) {
1.186 albertel 2746: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2747: }
1.186 albertel 2748: if (defined($moreenv)) {
2749: %form=(%form,%{$moreenv});
2750: }
1.236 albertel 2751: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 2752: $feedurl=&Apache::lonnet::clutter($feedurl);
1.186 albertel 2753: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 2754: $userview=~s/\<body[^\>]*\>//gi;
2755: $userview=~s/\<\/body\>//gi;
2756: $userview=~s/\<html\>//gi;
2757: $userview=~s/\<\/html\>//gi;
2758: $userview=~s/\<head\>//gi;
2759: $userview=~s/\<\/head\>//gi;
2760: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 2761: $userview=&relative_to_absolute($feedurl,$userview);
1.11 albertel 2762: return $userview;
2763: }
2764:
1.112 bowersj2 2765: =pod
2766:
2767: =item * get_student_answers()
2768:
2769: show a snapshot of how student was answering problem
2770:
2771: =cut
2772:
1.11 albertel 2773: sub get_student_answers {
1.100 sakharuk 2774: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 2775: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2776: my (%moreenv);
1.11 albertel 2777: my @elements=('symb','courseid','domain','username');
2778: foreach my $element (@elements) {
1.186 albertel 2779: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2780: }
1.186 albertel 2781: $moreenv{'grade_target'}='answer';
2782: %moreenv=(%form,%moreenv);
1.497 raeburn 2783: $feedurl = &Apache::lonnet::clutter($feedurl);
2784: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 2785: return $userview;
1.1 albertel 2786: }
1.116 albertel 2787:
2788: =pod
2789:
2790: =item * &submlink()
2791:
1.242 albertel 2792: Inputs: $text $uname $udom $symb $target
1.116 albertel 2793:
2794: Returns: A link to grades.pm such as to see the SUBM view of a student
2795:
2796: =cut
2797:
2798: ###############################################
2799: sub submlink {
1.242 albertel 2800: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 2801: if (!($uname && $udom)) {
2802: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 2803: &Apache::lonnet::whichuser($symb);
1.116 albertel 2804: if (!$symb) { $symb=$cursymb; }
2805: }
1.254 matthew 2806: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 2807: $symb=&escape($symb);
1.242 albertel 2808: if ($target) { $target="target=\"$target\""; }
2809: return '<a href="/adm/grades?&command=submission&'.
2810: 'symb='.$symb.'&student='.$uname.
2811: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2812: }
2813: ##############################################
2814:
2815: =pod
2816:
2817: =item * &pgrdlink()
2818:
2819: Inputs: $text $uname $udom $symb $target
2820:
2821: Returns: A link to grades.pm such as to see the PGRD view of a student
2822:
2823: =cut
2824:
2825: ###############################################
2826: sub pgrdlink {
2827: my $link=&submlink(@_);
2828: $link=~s/(&command=submission)/$1&showgrading=yes/;
2829: return $link;
2830: }
2831: ##############################################
2832:
2833: =pod
2834:
2835: =item * &pprmlink()
2836:
2837: Inputs: $text $uname $udom $symb $target
2838:
2839: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 2840: student and a specific resource
1.242 albertel 2841:
2842: =cut
2843:
2844: ###############################################
2845: sub pprmlink {
2846: my ($text,$uname,$udom,$symb,$target)=@_;
2847: if (!($uname && $udom)) {
2848: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 2849: &Apache::lonnet::whichuser($symb);
1.242 albertel 2850: if (!$symb) { $symb=$cursymb; }
2851: }
1.254 matthew 2852: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 2853: $symb=&escape($symb);
1.242 albertel 2854: if ($target) { $target="target=\"$target\""; }
2855: return '<a href="/adm/parmset?&command=set&'.
2856: 'symb='.$symb.'&uname='.$uname.
2857: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 2858: }
2859: ##############################################
1.37 matthew 2860:
1.112 bowersj2 2861: =pod
2862:
2863: =back
2864:
2865: =cut
2866:
1.37 matthew 2867: ###############################################
1.51 www 2868:
2869:
2870: sub timehash {
2871: my @ltime=localtime(shift);
2872: return ( 'seconds' => $ltime[0],
2873: 'minutes' => $ltime[1],
2874: 'hours' => $ltime[2],
2875: 'day' => $ltime[3],
2876: 'month' => $ltime[4]+1,
2877: 'year' => $ltime[5]+1900,
2878: 'weekday' => $ltime[6],
2879: 'dayyear' => $ltime[7]+1,
2880: 'dlsav' => $ltime[8] );
2881: }
2882:
1.370 www 2883: sub utc_string {
2884: my ($date)=@_;
1.371 www 2885: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 2886: }
2887:
1.51 www 2888: sub maketime {
2889: my %th=@_;
2890: return POSIX::mktime(
2891: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 2892: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 2893: }
2894:
2895: #########################################
1.51 www 2896:
2897: sub findallcourses {
1.482 raeburn 2898: my ($roles,$uname,$udom) = @_;
1.355 albertel 2899: my %roles;
2900: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 2901: my %courses;
1.51 www 2902: my $now=time;
1.482 raeburn 2903: if (!defined($uname)) {
2904: $uname = $env{'user.name'};
2905: }
2906: if (!defined($udom)) {
2907: $udom = $env{'user.domain'};
2908: }
2909: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
2910: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
2911: if (!%roles) {
2912: %roles = (
2913: cc => 1,
2914: in => 1,
2915: ep => 1,
2916: ta => 1,
2917: cr => 1,
2918: st => 1,
2919: );
2920: }
2921: foreach my $entry (keys(%roleshash)) {
2922: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
2923: if ($trole =~ /^cr/) {
2924: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
2925: } else {
2926: next if (!exists($roles{$trole}));
2927: }
2928: if ($tend) {
2929: next if ($tend < $now);
2930: }
2931: if ($tstart) {
2932: next if ($tstart > $now);
2933: }
2934: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
2935: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
2936: if ($secpart eq '') {
2937: ($cnum,$role) = split(/_/,$cnumpart);
2938: $sec = 'none';
2939: $realsec = '';
2940: } else {
2941: $cnum = $cnumpart;
2942: ($sec,$role) = split(/_/,$secpart);
2943: $realsec = $sec;
1.490 raeburn 2944: }
1.482 raeburn 2945: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
2946: }
2947: } else {
2948: foreach my $key (keys(%env)) {
1.483 albertel 2949: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
2950: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 2951: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
2952: next if ($role eq 'ca' || $role eq 'aa');
2953: next if (%roles && !exists($roles{$role}));
2954: my ($starttime,$endtime)=split(/\./,$env{$key});
2955: my $active=1;
2956: if ($starttime) {
2957: if ($now<$starttime) { $active=0; }
2958: }
2959: if ($endtime) {
2960: if ($now>$endtime) { $active=0; }
2961: }
2962: if ($active) {
2963: if ($sec eq '') {
2964: $sec = 'none';
2965: }
2966: $courses{$cdom.'_'.$cnum}{$sec} =
2967: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 2968: }
2969: }
1.51 www 2970: }
2971: }
1.474 raeburn 2972: return %courses;
1.51 www 2973: }
1.37 matthew 2974:
1.54 www 2975: ###############################################
1.474 raeburn 2976:
2977: sub blockcheck {
1.482 raeburn 2978: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 2979:
2980: if (!defined($udom)) {
2981: $udom = $env{'user.domain'};
2982: }
2983: if (!defined($uname)) {
2984: $uname = $env{'user.name'};
2985: }
2986:
2987: # If uname and udom are for a course, check for blocks in the course.
2988:
2989: if (&Apache::lonnet::is_course($udom,$uname)) {
2990: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 2991: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 2992: return ($startblock,$endblock);
2993: }
1.474 raeburn 2994:
1.502 raeburn 2995: my $startblock = 0;
2996: my $endblock = 0;
1.482 raeburn 2997: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 2998:
1.490 raeburn 2999: # If uname is for a user, and activity is course-specific, i.e.,
3000: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3001:
1.490 raeburn 3002: if (($activity eq 'boards' || $activity eq 'chat' ||
3003: $activity eq 'groups') && ($env{'request.course.id'})) {
3004: foreach my $key (keys(%live_courses)) {
3005: if ($key ne $env{'request.course.id'}) {
3006: delete($live_courses{$key});
3007: }
3008: }
3009: }
3010:
3011: my $otheruser = 0;
3012: my %own_courses;
3013: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3014: # Resource belongs to user other than current user.
3015: $otheruser = 1;
3016: # Gather courses for current user
3017: %own_courses =
3018: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3019: }
3020:
3021: # Gather active course roles - course coordinator, instructor,
3022: # exam proctor, ta, student, or custom role.
1.474 raeburn 3023:
3024: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3025: my ($cdom,$cnum);
3026: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3027: $cdom = $env{'course.'.$course.'.domain'};
3028: $cnum = $env{'course.'.$course.'.num'};
3029: } else {
1.490 raeburn 3030: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3031: }
3032: my $no_ownblock = 0;
3033: my $no_userblock = 0;
1.533 raeburn 3034: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3035: # Check if current user has 'evb' priv for this
3036: if (defined($own_courses{$course})) {
3037: foreach my $sec (keys(%{$own_courses{$course}})) {
3038: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3039: if ($sec ne 'none') {
3040: $checkrole .= '/'.$sec;
3041: }
3042: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3043: $no_ownblock = 1;
3044: last;
3045: }
3046: }
3047: }
3048: # if they have 'evb' priv and are currently not playing student
3049: next if (($no_ownblock) &&
3050: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3051: }
1.474 raeburn 3052: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3053: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3054: if ($sec ne 'none') {
1.482 raeburn 3055: $checkrole .= '/'.$sec;
1.474 raeburn 3056: }
1.490 raeburn 3057: if ($otheruser) {
3058: # Resource belongs to user other than current user.
3059: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3060: my ($trole,$tdom,$tnum,$tsec);
3061: my $entry = $live_courses{$course}{$sec};
3062: if ($entry =~ /^cr/) {
3063: ($trole,$tdom,$tnum,$tsec) =
3064: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3065: } else {
3066: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3067: }
3068: my ($spec,$area,$trest,%allroles,%userroles);
3069: $area = '/'.$tdom.'/'.$tnum;
3070: $trest = $tnum;
3071: if ($tsec ne '') {
3072: $area .= '/'.$tsec;
3073: $trest .= '/'.$tsec;
3074: }
3075: $spec = $trole.'.'.$area;
3076: if ($trole =~ /^cr/) {
3077: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3078: $tdom,$spec,$trest,$area);
3079: } else {
3080: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3081: $tdom,$spec,$trest,$area);
3082: }
3083: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3084: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3085: if ($1) {
3086: $no_userblock = 1;
3087: last;
3088: }
3089: }
1.490 raeburn 3090: } else {
3091: # Resource belongs to current user
3092: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3093: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3094: $no_ownblock = 1;
3095: last;
3096: }
1.474 raeburn 3097: }
3098: }
3099: # if they have the evb priv and are currently not playing student
1.482 raeburn 3100: next if (($no_ownblock) &&
1.491 albertel 3101: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3102: next if ($no_userblock);
1.474 raeburn 3103:
1.490 raeburn 3104: # Retrieve blocking times and identity of blocker for course
3105: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3106:
3107: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3108: if (($start != 0) &&
3109: (($startblock == 0) || ($startblock > $start))) {
3110: $startblock = $start;
3111: }
3112: if (($end != 0) &&
3113: (($endblock == 0) || ($endblock < $end))) {
3114: $endblock = $end;
3115: }
1.490 raeburn 3116: }
3117: return ($startblock,$endblock);
3118: }
3119:
3120: sub get_blocks {
3121: my ($setters,$activity,$cdom,$cnum) = @_;
3122: my $startblock = 0;
3123: my $endblock = 0;
3124: my $course = $cdom.'_'.$cnum;
3125: $setters->{$course} = {};
3126: $setters->{$course}{'staff'} = [];
3127: $setters->{$course}{'times'} = [];
3128: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3129: foreach my $record (keys(%records)) {
3130: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3131: if ($start <= time && $end >= time) {
3132: my ($staff_name,$staff_dom,$title,$blocks) =
3133: &parse_block_record($records{$record});
3134: if ($blocks->{$activity} eq 'on') {
3135: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3136: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3137: if ( ($startblock == 0) || ($startblock > $start) ) {
3138: $startblock = $start;
1.490 raeburn 3139: }
1.491 albertel 3140: if ( ($endblock == 0) || ($endblock < $end) ) {
3141: $endblock = $end;
1.474 raeburn 3142: }
3143: }
3144: }
3145: }
3146: return ($startblock,$endblock);
3147: }
3148:
3149: sub parse_block_record {
3150: my ($record) = @_;
3151: my ($setuname,$setudom,$title,$blocks);
3152: if (ref($record) eq 'HASH') {
3153: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3154: $title = &unescape($record->{'event'});
3155: $blocks = $record->{'blocks'};
3156: } else {
3157: my @data = split(/:/,$record,3);
3158: if (scalar(@data) eq 2) {
3159: $title = $data[1];
3160: ($setuname,$setudom) = split(/@/,$data[0]);
3161: } else {
3162: ($setuname,$setudom,$title) = @data;
3163: }
3164: $blocks = { 'com' => 'on' };
3165: }
3166: return ($setuname,$setudom,$title,$blocks);
3167: }
3168:
3169: sub build_block_table {
3170: my ($startblock,$endblock,$setters) = @_;
3171: my %lt = &Apache::lonlocal::texthash(
3172: 'cacb' => 'Currently active communication blocks',
3173: 'cour' => 'Course',
3174: 'dura' => 'Duration',
3175: 'blse' => 'Block set by'
3176: );
3177: my $output;
1.476 raeburn 3178: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3179: $output .= &start_data_table();
3180: $output .= '
3181: <tr>
3182: <th>'.$lt{'cour'}.'</th>
3183: <th>'.$lt{'dura'}.'</th>
3184: <th>'.$lt{'blse'}.'</th>
3185: </tr>
3186: ';
3187: foreach my $course (keys(%{$setters})) {
3188: my %courseinfo=&Apache::lonnet::coursedescription($course);
3189: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3190: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3191: my $fullname = &plainname($uname,$udom);
3192: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3193: && $env{'user.name'} ne 'public'
3194: && $env{'user.domain'} ne 'public') {
3195: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3196: }
1.474 raeburn 3197: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3198: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3199: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3200: $output .= &Apache::loncommon::start_data_table_row().
3201: '<td>'.$courseinfo{'description'}.'</td>'.
3202: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3203: '<td>'.$fullname.'</td>'.
1.474 raeburn 3204: &Apache::loncommon::end_data_table_row();
3205: }
3206: }
3207: $output .= &end_data_table();
3208: }
3209:
1.490 raeburn 3210: sub blocking_status {
3211: my ($activity,$uname,$udom) = @_;
3212: my %setters;
3213: my ($blocked,$output,$ownitem,$is_course);
3214: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3215: if ($startblock && $endblock) {
3216: $blocked = 1;
3217: if (wantarray) {
3218: my $category;
3219: if ($activity eq 'boards') {
3220: $category = 'Discussion posts in this course';
3221: } elsif ($activity eq 'blogs') {
3222: $category = 'Blogs';
3223: } elsif ($activity eq 'port') {
3224: if (defined($uname) && defined($udom)) {
3225: if ($uname eq $env{'user.name'} &&
3226: $udom eq $env{'user.domain'}) {
3227: $ownitem = 1;
3228: }
3229: }
3230: $is_course = &Apache::lonnet::is_course($udom,$uname);
3231: if ($ownitem) {
3232: $category = 'Your portfolio files';
3233: } elsif ($is_course) {
3234: my $coursedesc;
3235: foreach my $course (keys(%setters)) {
3236: my %courseinfo =
3237: &Apache::lonnet::coursedescription($course);
3238: $coursedesc = $courseinfo{'description'};
3239: }
3240: $category = "Group files in the course '$coursedesc'";
3241: } else {
3242: $category = 'Portfolio files belonging to ';
3243: if ($env{'user.name'} eq 'public' &&
3244: $env{'user.domain'} eq 'public') {
3245: $category .= &plainname($uname,$udom);
3246: } else {
3247: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3248: }
3249: }
3250: } elsif ($activity eq 'groups') {
3251: $category = 'Groups in this course';
3252: }
3253: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3254: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3255: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3256: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3257: $output .= &build_block_table($startblock,$endblock,\%setters);
3258: }
3259: }
3260: }
3261: if (wantarray) {
3262: return ($blocked,$output);
3263: } else {
3264: return $blocked;
3265: }
3266: }
3267:
1.60 matthew 3268: ###############################################
3269:
3270: =pod
3271:
1.112 bowersj2 3272: =head1 Domain Template Functions
3273:
3274: =over 4
3275:
3276: =item * &determinedomain()
1.60 matthew 3277:
3278: Inputs: $domain (usually will be undef)
3279:
1.63 www 3280: Returns: Determines which domain should be used for designs
1.60 matthew 3281:
3282: =cut
1.54 www 3283:
1.60 matthew 3284: ###############################################
1.63 www 3285: sub determinedomain {
3286: my $domain=shift;
1.531 albertel 3287: if (! $domain) {
1.60 matthew 3288: # Determine domain if we have not been given one
3289: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3290: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3291: if ($env{'request.role.domain'}) {
3292: $domain=$env{'request.role.domain'};
1.60 matthew 3293: }
3294: }
1.63 www 3295: return $domain;
3296: }
3297: ###############################################
1.517 raeburn 3298:
1.518 albertel 3299: sub devalidate_domconfig_cache {
3300: my ($udom)=@_;
3301: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3302: }
3303:
3304: # ---------------------- Get domain configuration for a domain
3305: sub get_domainconf {
3306: my ($udom) = @_;
3307: my $cachetime=1800;
3308: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3309: if (defined($cached)) { return %{$result}; }
3310:
3311: my %domconfig = &Apache::lonnet::get_dom('configuration',
3312: ['login','rolecolors'],$udom);
3313: my %designhash;
3314: if (keys(%domconfig) > 0) {
3315: if (ref($domconfig{'login'}) eq 'HASH') {
3316: foreach my $key (keys(%{$domconfig{'login'}})) {
3317: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3318: }
3319: }
3320: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
3321: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3322: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3323: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3324: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3325: }
3326: }
3327: }
3328: }
3329: } else {
3330: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3331: my $designfile = $designdir.'/'.$udom.'.tab';
3332: if (-e $designfile) {
3333: if ( open (my $fh,"<$designfile") ) {
3334: while (my $line = <$fh>) {
3335: next if ($line =~ /^\#/);
3336: chomp($line);
3337: my ($key,$val)=(split(/\=/,$line));
3338: if ($val) { $designhash{$udom.'.'.$key}=$val; }
3339: }
3340: close($fh);
3341: }
3342: }
3343: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
1.519 raeburn 3344: $designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
1.518 albertel 3345: }
3346: }
3347: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3348: $cachetime);
3349: return %designhash;
3350: }
3351:
1.63 www 3352: =pod
3353:
1.112 bowersj2 3354: =item * &domainlogo()
1.63 www 3355:
3356: Inputs: $domain (usually will be undef)
3357:
3358: Returns: A link to a domain logo, if the domain logo exists.
3359: If the domain logo does not exist, a description of the domain.
3360:
3361: =cut
1.112 bowersj2 3362:
1.63 www 3363: ###############################################
3364: sub domainlogo {
1.517 raeburn 3365: my $domain = &determinedomain(shift);
1.518 albertel 3366: my %designhash = &get_domainconf($domain);
1.517 raeburn 3367: # See if there is a logo
3368: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3369: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3370: if ($imgsrc =~ m{^/(adm|res)/}) {
3371: if ($imgsrc =~ m{^/res/}) {
3372: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3373: &Apache::lonnet::repcopy($local_name);
3374: }
3375: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3376: }
3377: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3378: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3379: return &Apache::lonnet::domain($domain,'description');
1.59 www 3380: } else {
1.60 matthew 3381: return '';
1.59 www 3382: }
3383: }
1.63 www 3384: ##############################################
3385:
3386: =pod
3387:
1.112 bowersj2 3388: =item * &designparm()
1.63 www 3389:
3390: Inputs: $which parameter; $domain (usually will be undef)
3391:
3392: Returns: value of designparamter $which
3393:
3394: =cut
1.112 bowersj2 3395:
1.397 albertel 3396:
1.400 albertel 3397: ##############################################
1.397 albertel 3398: sub designparm {
3399: my ($which,$domain)=@_;
1.258 albertel 3400: if ($env{'browser.blackwhite'} eq 'on') {
1.110 www 3401: if ($which=~/\.(font|alink|vlink|link)$/) {
3402: return '#000000';
3403: }
3404: if ($which=~/\.(pgbg|sidebg)$/) {
3405: return '#FFFFFF';
3406: }
3407: if ($which=~/\.tabbg$/) {
3408: return '#CCCCCC';
3409: }
3410: }
1.397 albertel 3411: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 3412: return $env{'environment.color.'.$which};
1.96 www 3413: }
1.63 www 3414: $domain=&determinedomain($domain);
1.518 albertel 3415: my %domdesign = &get_domainconf($domain);
1.520 raeburn 3416: my $output;
1.517 raeburn 3417: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 3418: $output = $domdesign{$domain.'.'.$which};
1.63 www 3419: } else {
1.520 raeburn 3420: $output = $defaultdesign{$which};
3421: }
3422: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
3423: ($which =~ /login\.(img|logo|domlogo)/)) {
1.538 albertel 3424: if ($output =~ m{^/(adm|res)/}) {
3425: if ($output =~ m{^/res/}) {
3426: my $local_name = &Apache::lonnet::filelocation('',$output);
3427: &Apache::lonnet::repcopy($local_name);
3428: }
1.520 raeburn 3429: $output = &lonhttpdurl($output);
3430: }
1.63 www 3431: }
1.520 raeburn 3432: return $output;
1.63 www 3433: }
1.59 www 3434:
1.60 matthew 3435: ###############################################
3436: ###############################################
3437:
3438: =pod
3439:
1.112 bowersj2 3440: =back
3441:
1.549 albertel 3442: =head1 HTML Helpers
1.112 bowersj2 3443:
3444: =over 4
3445:
3446: =item * &bodytag()
1.60 matthew 3447:
3448: Returns a uniform header for LON-CAPA web pages.
3449:
3450: Inputs:
3451:
1.112 bowersj2 3452: =over 4
3453:
3454: =item * $title, A title to be displayed on the page.
3455:
3456: =item * $function, the current role (can be undef).
3457:
3458: =item * $addentries, extra parameters for the <body> tag.
3459:
3460: =item * $bodyonly, if defined, only return the <body> tag.
3461:
3462: =item * $domain, if defined, force a given domain.
3463:
3464: =item * $forcereg, if page should register as content page (relevant for
1.86 www 3465: text interface only)
1.60 matthew 3466:
1.326 albertel 3467: =item * $customtitle, alternate text to use instead of $title
3468: in the title box that appears, this text
3469: is not auto translated like the $title is
1.309 albertel 3470:
3471: =item * $notopbar, if true, keep the 'what is this' info but remove the
3472: navigational links
1.317 albertel 3473:
1.338 albertel 3474: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
3475:
3476: =item * $notitle, if true keep the nav controls, but remove the title bar
3477:
1.361 albertel 3478: =item * $no_inline_link, if true and in remote mode, don't show the
3479: 'Switch To Inline Menu' link
3480:
1.460 albertel 3481: =item * $args, optional argument valid values are
3482: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 3483: inherit_jsmath -> when creating popup window in a page,
3484: should it have jsmath forced on by the
3485: current page
1.460 albertel 3486:
1.112 bowersj2 3487: =back
3488:
1.60 matthew 3489: Returns: A uniform header for LON-CAPA web pages.
3490: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
3491: If $bodyonly is undef or zero, an html string containing a <body> tag and
3492: other decorations will be returned.
3493:
3494: =cut
3495:
1.54 www 3496: sub bodytag {
1.309 albertel 3497: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 3498: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 3499:
1.460 albertel 3500: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 3501:
1.183 matthew 3502: $function = &get_users_function() if (!$function);
1.339 albertel 3503: my $img = &designparm($function.'.img',$domain);
3504: my $font = &designparm($function.'.font',$domain);
3505: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
3506:
3507: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 3508: 'bgcolor' => $pgbg,
1.339 albertel 3509: 'text' => $font,
3510: 'alink' => &designparm($function.'.alink',$domain),
3511: 'vlink' => &designparm($function.'.vlink',$domain),
3512: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 3513: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 3514:
1.63 www 3515: # role and realm
1.378 raeburn 3516: my ($role,$realm) = split(/\./,$env{'request.role'},2);
3517: if ($role eq 'ca') {
1.479 albertel 3518: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 3519: $realm = &plainname($rname,$rdom);
1.378 raeburn 3520: }
1.55 www 3521: # realm
1.258 albertel 3522: if ($env{'request.course.id'}) {
1.378 raeburn 3523: if ($env{'request.role'} !~ /^cr/) {
3524: $role = &Apache::lonnet::plaintext($role,&course_type());
3525: }
1.359 albertel 3526: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 3527: } else {
3528: $role = &Apache::lonnet::plaintext($role);
1.54 www 3529: }
1.433 albertel 3530:
1.359 albertel 3531: if (!$realm) { $realm=' '; }
1.55 www 3532: # Set messages
1.60 matthew 3533: my $messages=&domainlogo($domain);
1.330 albertel 3534:
1.438 albertel 3535: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 3536:
1.101 www 3537: # construct main body tag
1.359 albertel 3538: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 3539: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 3540:
1.530 albertel 3541: if ($bodyonly) {
1.60 matthew 3542: return $bodytag;
1.258 albertel 3543: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 3544: # Accessibility
1.224 raeburn 3545:
1.337 albertel 3546: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 3547: if (!$notitle) {
1.337 albertel 3548: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
3549: }
3550: return $bodytag;
1.359 albertel 3551: }
3552:
1.410 albertel 3553: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 3554: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3555: undef($role);
1.434 albertel 3556: } else {
3557: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 3558: }
1.359 albertel 3559:
3560: my $roleinfo=(<<ENDROLE);
3561: <td class="LC_title_bar_who">
3562: <div class="LC_title_bar_name">
1.410 albertel 3563: $name
1.361 albertel 3564:
1.359 albertel 3565: </div>
3566: <div class="LC_title_bar_role">
1.361 albertel 3567: $role
1.359 albertel 3568: </div>
3569: <div class="LC_title_bar_realm">
1.361 albertel 3570: $realm
1.359 albertel 3571: </div>
1.206 albertel 3572: </td>
3573: ENDROLE
1.235 raeburn 3574:
1.359 albertel 3575: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
3576: if ($customtitle) {
3577: $titleinfo = $customtitle;
3578: }
3579: #
3580: # Extra info if you are the DC
3581: my $dc_info = '';
3582: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
3583: $env{'course.'.$env{'request.course.id'}.
3584: '.domain'}.'/'})) {
3585: my $cid = $env{'request.course.id'};
3586: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 3587: $dc_info =~ s/\s+$//;
1.359 albertel 3588: $dc_info = '('.$dc_info.')';
3589: }
3590:
3591: if ($env{'environment.remote'} eq 'off') {
3592: # No Remote
1.258 albertel 3593: if ($env{'request.state'} eq 'construct') {
1.359 albertel 3594: $forcereg=1;
3595: }
3596:
3597: if (!$customtitle && $env{'request.state'} eq 'construct') {
3598: # this is for resources; directories have customtitle, and crumbs
3599: # and select recent are created in lonpubdir.pm
1.229 albertel 3600: my ($uname,$thisdisfn)=
1.258 albertel 3601: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 3602: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
3603: $formaction=~s/\/+/\//g;
3604:
1.359 albertel 3605: my $parentpath = '';
3606: my $lastitem = '';
3607: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
3608: $parentpath = $1;
3609: $lastitem = $2;
3610: } else {
3611: $lastitem = $thisdisfn;
3612: }
3613: $titleinfo =
1.401 albertel 3614: &Apache::loncommon::help_open_menu('','',3,'Authoring').
1.359 albertel 3615: '<b>Construction Space</b>: '.
3616: '<form name="dirs" method="post" action="'.$formaction
3617: .'" target="_top"><tt><b>'
3618: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
3619: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
3620: .'</form>'
3621: .&Apache::lonmenu::constspaceform();
1.235 raeburn 3622: }
1.359 albertel 3623:
1.337 albertel 3624: my $titletable;
1.338 albertel 3625: if (!$notitle) {
1.337 albertel 3626: $titletable =
1.359 albertel 3627: '<table id="LC_title_bar">'.
3628: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
3629: '</tr></table>';
1.337 albertel 3630: }
1.359 albertel 3631: if ($notopbar) {
3632: $bodytag .= $titletable;
3633: } else {
3634: if ($env{'request.state'} eq 'construct') {
1.337 albertel 3635: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
3636: $titletable);
1.272 raeburn 3637: } else {
1.336 albertel 3638: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 3639: $titletable;
1.272 raeburn 3640: }
1.235 raeburn 3641: }
3642: return $bodytag;
1.94 www 3643: }
1.95 www 3644:
1.93 www 3645: #
1.95 www 3646: # Top frame rendering, Remote is up
1.93 www 3647: #
1.359 albertel 3648:
1.517 raeburn 3649: my $imgsrc = $img;
3650: if ($img =~ /^\/adm/) {
1.575 albertel 3651: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 3652: }
3653: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 3654:
1.305 www 3655: # Explicit link to get inline menu
1.361 albertel 3656: my $menu= ($no_inline_link?''
3657: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 3658: #
1.338 albertel 3659: if ($notitle) {
1.337 albertel 3660: return $bodytag;
3661: }
1.94 www 3662: return(<<ENDBODY);
1.60 matthew 3663: $bodytag
1.359 albertel 3664: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 3665: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 3666: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 3667: </tr>
1.359 albertel 3668: <tr><td>$titleinfo $dc_info $menu</td>
3669: $roleinfo
1.368 albertel 3670: </tr>
1.356 albertel 3671: </table>
1.54 www 3672: ENDBODY
1.182 matthew 3673: }
3674:
1.330 albertel 3675: sub make_attr_string {
3676: my ($register,$attr_ref) = @_;
3677:
3678: if ($attr_ref && !ref($attr_ref)) {
3679: die("addentries Must be a hash ref ".
3680: join(':',caller(1))." ".
3681: join(':',caller(0))." ");
3682: }
3683:
3684: if ($register) {
1.339 albertel 3685: my ($on_load,$on_unload);
3686: foreach my $key (keys(%{$attr_ref})) {
3687: if (lc($key) eq 'onload') {
3688: $on_load.=$attr_ref->{$key}.';';
3689: delete($attr_ref->{$key});
3690:
3691: } elsif (lc($key) eq 'onunload') {
3692: $on_unload.=$attr_ref->{$key}.';';
3693: delete($attr_ref->{$key});
3694: }
3695: }
3696: $attr_ref->{'onload'} =
3697: &Apache::lonmenu::loadevents(). $on_load;
3698: $attr_ref->{'onunload'}=
3699: &Apache::lonmenu::unloadevents().$on_unload;
3700: }
3701:
3702: # Accessibility font enhance
3703: if ($env{'browser.fontenhance'} eq 'on') {
3704: my $style;
3705: foreach my $key (keys(%{$attr_ref})) {
3706: if (lc($key) eq 'style') {
3707: $style.=$attr_ref->{$key}.';';
3708: delete($attr_ref->{$key});
3709: }
3710: }
3711: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 3712: }
1.339 albertel 3713:
3714: if ($env{'browser.blackwhite'} eq 'on') {
3715: delete($attr_ref->{'font'});
3716: delete($attr_ref->{'link'});
3717: delete($attr_ref->{'alink'});
3718: delete($attr_ref->{'vlink'});
3719: delete($attr_ref->{'bgcolor'});
3720: delete($attr_ref->{'background'});
3721: }
3722:
1.330 albertel 3723: my $attr_string;
3724: foreach my $attr (keys(%$attr_ref)) {
3725: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
3726: }
3727: return $attr_string;
3728: }
3729:
3730:
1.182 matthew 3731: ###############################################
1.251 albertel 3732: ###############################################
3733:
3734: =pod
3735:
3736: =item * &endbodytag()
3737:
3738: Returns a uniform footer for LON-CAPA web pages.
3739:
1.306 albertel 3740: Inputs: none
1.251 albertel 3741:
3742: =cut
3743:
3744: sub endbodytag {
3745: my $endbodytag='</body>';
1.269 albertel 3746: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 3747: if ( exists( $env{'internal.head.redirect'} ) ) {
3748: $endbodytag=
3749: "<br /><a href=\"$env{'internal.head.redirect'}\">".
3750: &mt('Continue').'</a>'.
3751: $endbodytag;
3752: }
1.251 albertel 3753: return $endbodytag;
3754: }
3755:
1.352 albertel 3756: =pod
3757:
3758: =item * &standard_css()
3759:
3760: Returns a style sheet
3761:
3762: Inputs: (all optional)
3763: domain -> force to color decorate a page for a specific
3764: domain
3765: function -> force usage of a specific rolish color scheme
3766: bgcolor -> override the default page bgcolor
3767:
3768: =cut
3769:
1.343 albertel 3770: sub standard_css {
1.345 albertel 3771: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 3772: $function = &get_users_function() if (!$function);
3773: my $img = &designparm($function.'.img', $domain);
3774: my $tabbg = &designparm($function.'.tabbg', $domain);
3775: my $font = &designparm($function.'.font', $domain);
1.345 albertel 3776: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 3777: my $pgbg_or_bgcolor =
3778: $bgcolor ||
1.352 albertel 3779: &designparm($function.'.pgbg', $domain);
1.382 albertel 3780: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 3781: my $alink = &designparm($function.'.alink', $domain);
3782: my $vlink = &designparm($function.'.vlink', $domain);
3783: my $link = &designparm($function.'.link', $domain);
3784:
3785: my $sans = 'Arial,Helvetica,sans-serif';
1.395 albertel 3786: my $mono = 'monospace';
1.352 albertel 3787: my $data_table_head = $tabbg;
3788: my $data_table_light = '#EEEEEE';
1.470 banghart 3789: my $data_table_dark = '#DDDDDD';
3790: my $data_table_darker = '#CCCCCC';
1.349 albertel 3791: my $data_table_highlight = '#FFFF00';
1.352 albertel 3792: my $mail_new = '#FFBB77';
3793: my $mail_new_hover = '#DD9955';
3794: my $mail_read = '#BBBB77';
3795: my $mail_read_hover = '#999944';
3796: my $mail_replied = '#AAAA88';
3797: my $mail_replied_hover = '#888855';
3798: my $mail_other = '#99BBBB';
3799: my $mail_other_hover = '#669999';
1.391 albertel 3800: my $table_header = '#DDDDDD';
1.489 raeburn 3801: my $feedback_link_bg = '#BBBBBB';
1.392 albertel 3802:
3803: my $border = ($env{'browser.type'} eq 'explorer') ? '0px 2px 0px 2px'
3804: : '0px 3px 0px 4px';
1.448 albertel 3805:
1.523 albertel 3806:
1.343 albertel 3807: return <<END;
1.345 albertel 3808: h1, h2, h3, th { font-family: $sans }
1.343 albertel 3809: a:focus { color: red; background: yellow }
1.510 albertel 3810: table.thinborder,
1.523 albertel 3811:
1.510 albertel 3812: table.thinborder tr th {
3813: border-style: solid;
3814: border-width: 1px;
3815: background: $tabbg;
3816: }
1.523 albertel 3817: table.thinborder tr td {
1.510 albertel 3818: border-style: solid;
3819: border-width: 1px
3820: }
1.426 albertel 3821:
1.343 albertel 3822: form, .inline { display: inline; }
3823: .center { text-align: center; }
1.395 albertel 3824: .LC_filename {font-family: $mono;}
1.350 albertel 3825: .LC_error {
3826: color: red;
3827: font-size: larger;
3828: }
1.457 albertel 3829: .LC_warning,
3830: .LC_diff_removed {
1.394 albertel 3831: color: red;
3832: }
1.532 albertel 3833:
3834: .LC_info,
1.457 albertel 3835: .LC_success,
3836: .LC_diff_added {
1.350 albertel 3837: color: green;
3838: }
1.543 albertel 3839: .LC_unknown {
3840: color: yellow;
3841: }
3842:
1.440 albertel 3843: .LC_icon {
3844: border: 0px;
3845: }
1.539 albertel 3846: .LC_indexer_icon {
3847: border: 0px;
3848: height: 22px;
3849: }
1.543 albertel 3850: .LC_docs_spacer {
3851: width: 25px;
3852: height: 1px;
3853: border: 0px;
3854: }
1.346 albertel 3855:
1.532 albertel 3856: .LC_internal_info {
3857: color: #999;
3858: }
3859:
1.458 albertel 3860: table.LC_pastsubmission {
3861: border: 1px solid black;
3862: margin: 2px;
3863: }
3864:
1.392 albertel 3865: table#LC_top_nav, table#LC_menubuttons {
1.345 albertel 3866: width: 100%;
3867: background: $pgbg;
1.392 albertel 3868: border: 2px;
1.402 albertel 3869: border-collapse: separate;
1.403 albertel 3870: padding: 0px;
1.345 albertel 3871: }
1.392 albertel 3872:
1.409 albertel 3873: table#LC_title_bar, table.LC_breadcrumbs, table#LC_nav_location,
1.393 albertel 3874: table#LC_title_bar.LC_with_remote {
1.359 albertel 3875: width: 100%;
1.392 albertel 3876: border-color: $pgbg;
3877: border-style: solid;
3878: border-width: $border;
3879:
1.379 albertel 3880: background: $pgbg;
3881: font-family: $sans;
1.392 albertel 3882: border-collapse: collapse;
1.403 albertel 3883: padding: 0px;
1.359 albertel 3884: }
1.392 albertel 3885:
1.409 albertel 3886: table.LC_docs_path {
3887: width: 100%;
3888: border: 0;
3889: background: $pgbg;
3890: font-family: $sans;
3891: border-collapse: collapse;
3892: padding: 0px;
3893: }
3894:
1.359 albertel 3895: table#LC_title_bar td {
3896: background: $tabbg;
3897: }
3898: table#LC_title_bar td.LC_title_bar_who {
3899: background: $tabbg;
3900: color: $font;
1.427 albertel 3901: font: small $sans;
1.359 albertel 3902: text-align: right;
3903: }
1.469 banghart 3904: span.LC_metadata {
3905: font-family: $sans;
3906: }
1.359 albertel 3907: span.LC_title_bar_title {
1.416 albertel 3908: font: bold x-large $sans;
1.359 albertel 3909: }
3910: table#LC_title_bar td.LC_title_bar_domain_logo {
3911: background: $sidebg;
3912: text-align: right;
1.368 albertel 3913: padding: 0px;
3914: }
3915: table#LC_title_bar td.LC_title_bar_role_logo {
3916: background: $sidebg;
3917: padding: 0px;
1.359 albertel 3918: }
3919:
1.346 albertel 3920: table#LC_menubuttons_mainmenu {
1.526 www 3921: width: 100%;
1.346 albertel 3922: border: 0px;
3923: border-spacing: 1px;
1.372 albertel 3924: padding: 0px 1px;
1.346 albertel 3925: margin: 0px;
3926: border-collapse: separate;
3927: }
3928: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
3929: border: 0px;
3930: }
1.345 albertel 3931: table#LC_top_nav td {
3932: background: $tabbg;
1.392 albertel 3933: border: 0px;
1.407 albertel 3934: font-size: small;
1.345 albertel 3935: }
3936: table#LC_top_nav td a, div#LC_top_nav a {
3937: color: $font;
3938: font-family: $sans;
3939: }
1.364 albertel 3940: table#LC_top_nav td.LC_top_nav_logo {
3941: background: $tabbg;
1.432 albertel 3942: text-align: left;
1.408 albertel 3943: white-space: nowrap;
1.432 albertel 3944: width: 31px;
1.408 albertel 3945: }
3946: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 3947: border: 0px;
1.408 albertel 3948: vertical-align: bottom;
1.364 albertel 3949: }
1.432 albertel 3950: table#LC_top_nav td.LC_top_nav_exit,
3951: table#LC_top_nav td.LC_top_nav_help {
3952: width: 2.0em;
3953: }
1.442 albertel 3954: table#LC_top_nav td.LC_top_nav_login {
3955: width: 4.0em;
3956: text-align: center;
3957: }
1.409 albertel 3958: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 3959: background: $tabbg;
3960: color: $font;
3961: font-family: $sans;
1.358 albertel 3962: font-size: smaller;
1.357 albertel 3963: }
1.411 albertel 3964: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 3965: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 3966: background: $tabbg;
3967: color: $font;
3968: font-family: $sans;
3969: font-size: larger;
3970: text-align: right;
3971: }
1.383 albertel 3972: td.LC_table_cell_checkbox {
3973: text-align: center;
3974: }
3975:
1.522 albertel 3976: table#LC_mainmenu td.LC_mainmenu_column {
3977: vertical-align: top;
3978: }
3979:
1.346 albertel 3980: .LC_menubuttons_inline_text {
3981: color: $font;
3982: font-family: $sans;
3983: font-size: smaller;
3984: }
3985:
1.526 www 3986: .LC_menubuttons_link {
3987: text-decoration: none;
3988: }
3989:
1.522 albertel 3990: .LC_menubuttons_category {
1.521 www 3991: color: $font;
1.526 www 3992: background: $pgbg;
1.521 www 3993: font-family: $sans;
3994: font-size: larger;
3995: font-weight: bold;
3996: }
3997:
1.346 albertel 3998: td.LC_menubuttons_text {
1.526 www 3999: width: 90%;
1.346 albertel 4000: color: $font;
4001: font-family: $sans;
4002: }
1.526 www 4003:
1.346 albertel 4004: td.LC_menubuttons_img {
4005: }
1.526 www 4006:
1.346 albertel 4007: .LC_current_location {
4008: font-family: $sans;
4009: background: $tabbg;
4010: }
4011: .LC_new_mail {
4012: font-family: $sans;
4013: font-weight: bold;
4014: }
1.347 albertel 4015:
1.526 www 4016: .LC_rolesmenu_is {
4017: font-family: $sans;
4018: }
4019:
4020: .LC_rolesmenu_selected {
4021: font-family: $sans;
4022: }
4023:
4024: .LC_rolesmenu_future {
4025: font-family: $sans;
4026: }
4027:
4028:
4029: .LC_rolesmenu_will {
4030: font-family: $sans;
4031: }
4032:
4033: .LC_rolesmenu_will_not {
4034: font-family: $sans;
4035: }
4036:
4037: .LC_rolesmenu_expired {
4038: font-family: $sans;
4039: }
4040:
4041: .LC_rolesinfo {
4042: font-family: $sans;
4043: }
4044:
1.527 www 4045: .LC_dropadd_labeltext {
4046: font-family: $sans;
4047: text-align: right;
4048: }
4049:
4050: .LC_preferences_labeltext {
4051: font-family: $sans;
4052: text-align: right;
4053: }
4054:
1.440 albertel 4055: table.LC_aboutme_port {
4056: border: 0px;
4057: border-collapse: collapse;
4058: border-spacing: 0px;
4059: }
1.349 albertel 4060: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4061: border: 1px solid #000000;
1.402 albertel 4062: border-collapse: separate;
1.426 albertel 4063: border-spacing: 1px;
1.347 albertel 4064: }
1.422 albertel 4065: .LC_data_table_dense {
4066: font-size: small;
4067: }
1.507 raeburn 4068: table.LC_nested_outer {
4069: border: 1px solid #000000;
4070: border-collapse: separate;
4071: border-spacing: 0px;
4072: width: 100%;
4073: }
4074: table.LC_nested {
4075: border: 0px;
4076: border-collapse: separate;
4077: border-spacing: 0px;
4078: width: 100%;
4079: }
1.523 albertel 4080: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4081: table.LC_prior_tries tr th {
1.349 albertel 4082: font-weight: bold;
4083: background-color: $data_table_head;
1.421 albertel 4084: font-size: smaller;
1.347 albertel 4085: }
1.440 albertel 4086: table.LC_data_table tr td,
4087: table.LC_aboutme_port tr td {
1.349 albertel 4088: background-color: $data_table_light;
1.425 albertel 4089: padding: 2px;
1.347 albertel 4090: }
1.440 albertel 4091: table.LC_data_table tr.LC_even_row td,
4092: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4093: background-color: $data_table_dark;
1.347 albertel 4094: }
1.425 albertel 4095: table.LC_data_table tr.LC_data_table_highlight td {
4096: background-color: $data_table_darker;
4097: }
1.451 albertel 4098: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4099: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4100: background-color: #FFFFFF;
1.421 albertel 4101: font-weight: bold;
4102: font-style: italic;
4103: text-align: center;
4104: padding: 8px;
1.347 albertel 4105: }
1.507 raeburn 4106: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4107: padding: 4ex
4108: }
1.507 raeburn 4109: table.LC_nested_outer tr th {
4110: font-weight: bold;
4111: background-color: $data_table_head;
4112: font-size: smaller;
4113: border-bottom: 1px solid #000000;
4114: }
4115: table.LC_nested_outer tr td.LC_subheader {
4116: background-color: $data_table_head;
4117: font-weight: bold;
4118: font-size: small;
4119: border-bottom: 1px solid #000000;
4120: text-align: right;
1.451 albertel 4121: }
1.507 raeburn 4122: table.LC_nested tr.LC_info_row td {
1.451 albertel 4123: background-color: #CCC;
4124: font-weight: bold;
4125: font-size: small;
1.507 raeburn 4126: text-align: center;
4127: }
4128: table.LC_nested tr.LC_info_row td.LC_left_item {
4129: text-align: left;
1.451 albertel 4130: }
1.507 raeburn 4131: table.LC_nested td {
1.451 albertel 4132: background-color: #FFF;
4133: font-size: small;
1.507 raeburn 4134: }
4135: table.LC_nested_outer tr th.LC_right_item,
4136: table.LC_nested tr.LC_info_row td.LC_right_item,
4137: table.LC_nested tr.LC_odd_row td.LC_right_item,
4138: table.LC_nested tr td.LC_right_item {
1.451 albertel 4139: text-align: right;
4140: }
4141:
1.507 raeburn 4142: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4143: background-color: #EEE;
4144: }
4145:
1.473 raeburn 4146: table.LC_createuser {
4147: }
4148:
4149: table.LC_createuser tr.LC_section_row td {
4150: font-size: smaller;
4151: }
4152:
4153: table.LC_createuser tr.LC_info_row td {
4154: background-color: #CCC;
4155: font-weight: bold;
4156: text-align: center;
4157: }
4158:
1.349 albertel 4159: table.LC_calendar {
4160: border: 1px solid #000000;
4161: border-collapse: collapse;
4162: }
4163: table.LC_calendar_pickdate {
4164: font-size: xx-small;
4165: }
4166: table.LC_calendar tr td {
4167: border: 1px solid #000000;
4168: vertical-align: top;
4169: }
4170: table.LC_calendar tr td.LC_calendar_day_empty {
4171: background-color: $data_table_dark;
4172: }
4173: table.LC_calendar tr td.LC_calendar_day_current {
4174: background-color: $data_table_highlight;
4175: }
4176:
4177: table.LC_mail_list tr.LC_mail_new {
4178: background-color: $mail_new;
4179: }
4180: table.LC_mail_list tr.LC_mail_new:hover {
4181: background-color: $mail_new_hover;
4182: }
4183: table.LC_mail_list tr.LC_mail_read {
4184: background-color: $mail_read;
4185: }
4186: table.LC_mail_list tr.LC_mail_read:hover {
4187: background-color: $mail_read_hover;
4188: }
4189: table.LC_mail_list tr.LC_mail_replied {
4190: background-color: $mail_replied;
4191: }
4192: table.LC_mail_list tr.LC_mail_replied:hover {
4193: background-color: $mail_replied_hover;
4194: }
4195: table.LC_mail_list tr.LC_mail_other {
4196: background-color: $mail_other;
4197: }
4198: table.LC_mail_list tr.LC_mail_other:hover {
4199: background-color: $mail_other_hover;
4200: }
1.494 raeburn 4201: table.LC_mail_list tr.LC_mail_even {
4202: }
4203: table.LC_mail_list tr.LC_mail_odd {
4204: }
4205:
1.385 albertel 4206:
1.386 albertel 4207: table#LC_portfolio_actions {
4208: width: auto;
4209: background: $pgbg;
4210: border: 0px;
4211: border-spacing: 2px 2px;
4212: padding: 0px;
4213: margin: 0px;
4214: border-collapse: separate;
4215: }
4216: table#LC_portfolio_actions td.LC_label {
4217: background: $tabbg;
4218: text-align: right;
4219: }
4220: table#LC_portfolio_actions td.LC_value {
4221: background: $tabbg;
4222: }
1.385 albertel 4223:
1.391 albertel 4224: table#LC_cstr_controls {
4225: width: 100%;
4226: border-collapse: collapse;
4227: }
4228: table#LC_cstr_controls tr td {
4229: border: 4px solid $pgbg;
4230: padding: 4px;
4231: text-align: center;
4232: background: $tabbg;
4233: }
4234: table#LC_cstr_controls tr th {
4235: border: 4px solid $pgbg;
4236: background: $table_header;
4237: text-align: center;
4238: font-family: $sans;
4239: font-size: smaller;
4240: }
4241:
1.389 albertel 4242: table#LC_browser {
4243:
4244: }
4245: table#LC_browser tr th {
1.391 albertel 4246: background: $table_header;
1.389 albertel 4247: }
1.390 albertel 4248: table#LC_browser tr td {
4249: padding: 2px;
4250: }
1.389 albertel 4251: table#LC_browser tr.LC_browser_file,
4252: table#LC_browser tr.LC_browser_file_published {
4253: background: #CCFF88;
4254: }
4255: table#LC_browser tr.LC_browser_file_locked,
4256: table#LC_browser tr.LC_browser_file_unpublished {
4257: background: #FFAA99;
1.387 albertel 4258: }
1.389 albertel 4259: table#LC_browser tr.LC_browser_file_obsolete {
4260: background: #AAAAAA;
1.387 albertel 4261: }
1.455 albertel 4262: table#LC_browser tr.LC_browser_file_modified,
4263: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 4264: background: #FFFF77;
1.387 albertel 4265: }
1.389 albertel 4266: table#LC_browser tr.LC_browser_folder {
4267: background: #CCCCFF;
1.387 albertel 4268: }
1.388 albertel 4269: span.LC_current_location {
4270: font-size: x-large;
4271: background: $pgbg;
4272: }
1.387 albertel 4273:
1.395 albertel 4274: span.LC_parm_menu_item {
4275: font-size: larger;
4276: font-family: $sans;
4277: }
4278: span.LC_parm_scope_all {
4279: color: red;
4280: }
4281: span.LC_parm_scope_folder {
4282: color: green;
4283: }
4284: span.LC_parm_scope_resource {
4285: color: orange;
4286: }
4287: span.LC_parm_part {
4288: color: blue;
4289: }
4290: span.LC_parm_folder, span.LC_parm_symb {
4291: font-size: x-small;
4292: font-family: $mono;
4293: color: #AAAAAA;
4294: }
4295:
1.396 albertel 4296: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4297: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4298: border: 1px solid black;
4299: border-collapse: collapse;
4300: }
4301: table.LC_parm_overview_restrictions td {
4302: border-width: 1px 4px 1px 4px;
4303: border-style: solid;
4304: border-color: $pgbg;
4305: text-align: center;
4306: }
4307: table.LC_parm_overview_restrictions th {
4308: background: $tabbg;
4309: border-width: 1px 4px 1px 4px;
4310: border-style: solid;
4311: border-color: $pgbg;
4312: }
1.398 albertel 4313: table#LC_helpmenu {
4314: border: 0px;
4315: height: 55px;
4316: border-spacing: 0px;
4317: }
4318:
4319: table#LC_helpmenu fieldset legend {
4320: font-size: larger;
4321: font-weight: bold;
4322: }
1.397 albertel 4323: table#LC_helpmenu_links {
4324: width: 100%;
4325: border: 1px solid black;
4326: background: $pgbg;
4327: padding: 0px;
4328: border-spacing: 1px;
4329: }
4330: table#LC_helpmenu_links tr td {
4331: padding: 1px;
4332: background: $tabbg;
1.399 albertel 4333: text-align: center;
4334: font-weight: bold;
1.397 albertel 4335: }
1.396 albertel 4336:
1.397 albertel 4337: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4338: table#LC_helpmenu_links a:active {
4339: text-decoration: none;
4340: color: $font;
4341: }
4342: table#LC_helpmenu_links a:hover {
4343: text-decoration: underline;
4344: color: $vlink;
4345: }
1.396 albertel 4346:
1.417 albertel 4347: .LC_chrt_popup_exists {
4348: border: 1px solid #339933;
4349: margin: -1px;
4350: }
4351: .LC_chrt_popup_up {
4352: border: 1px solid yellow;
4353: margin: -1px;
4354: }
4355: .LC_chrt_popup {
4356: border: 1px solid #8888FF;
4357: background: #CCCCFF;
4358: }
1.421 albertel 4359: table.LC_pick_box {
4360: border-collapse: separate;
4361: background: white;
4362: border: 1px solid black;
4363: border-spacing: 1px;
4364: }
4365: table.LC_pick_box td.LC_pick_box_title {
4366: background: $tabbg;
4367: font-weight: bold;
4368: text-align: right;
4369: width: 184px;
4370: padding: 8px;
4371: }
1.579 raeburn 4372: table.LC_pick_box td.LC_pick_box_value {
4373: text-align: left;
4374: padding: 8px;
4375: }
4376: table.LC_pick_box td.LC_pick_box_select {
4377: text-align: left;
4378: padding: 8px;
4379: }
1.424 albertel 4380: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 4381: padding: 0px;
4382: height: 1px;
4383: background: black;
4384: }
4385: table.LC_pick_box td.LC_pick_box_submit {
4386: text-align: right;
4387: }
1.579 raeburn 4388: table.LC_pick_box td.LC_evenrow_value {
4389: text-align: left;
4390: padding: 8px;
4391: background-color: $data_table_light;
4392: }
4393: table.LC_pick_box td.LC_oddrow_value {
4394: text-align: left;
4395: padding: 8px;
4396: background-color: $data_table_light;
4397: }
4398: table.LC_helpform_receipt {
4399: width: 620px;
4400: border-collapse: separate;
4401: background: white;
4402: border: 1px solid black;
4403: border-spacing: 1px;
4404: }
4405: table.LC_helpform_receipt td.LC_pick_box_title {
4406: background: $tabbg;
4407: font-weight: bold;
4408: text-align: right;
4409: width: 184px;
4410: padding: 8px;
4411: }
4412: table.LC_helpform_receipt td.LC_evenrow_value {
4413: text-align: left;
4414: padding: 8px;
4415: background-color: $data_table_light;
4416: }
4417: table.LC_helpform_receipt td.LC_oddrow_value {
4418: text-align: left;
4419: padding: 8px;
4420: background-color: $data_table_light;
4421: }
4422: table.LC_helpform_receipt td.LC_pick_box_separator {
4423: padding: 0px;
4424: height: 1px;
4425: background: black;
4426: }
4427: span.LC_helpform_receipt_cat {
4428: font-weight: bold;
4429: }
1.424 albertel 4430: table.LC_group_priv_box {
4431: background: white;
4432: border: 1px solid black;
4433: border-spacing: 1px;
4434: }
4435: table.LC_group_priv_box td.LC_pick_box_title {
4436: background: $tabbg;
4437: font-weight: bold;
4438: text-align: right;
4439: width: 184px;
4440: }
4441: table.LC_group_priv_box td.LC_groups_fixed {
4442: background: $data_table_light;
4443: text-align: center;
4444: }
4445: table.LC_group_priv_box td.LC_groups_optional {
4446: background: $data_table_dark;
4447: text-align: center;
4448: }
4449: table.LC_group_priv_box td.LC_groups_functionality {
4450: background: $data_table_darker;
4451: text-align: center;
4452: font-weight: bold;
4453: }
4454: table.LC_group_priv td {
4455: text-align: left;
4456: padding: 0px;
4457: }
4458:
1.421 albertel 4459: table.LC_notify_front_page {
4460: background: white;
4461: border: 1px solid black;
4462: padding: 8px;
4463: }
4464: table.LC_notify_front_page td {
4465: padding: 8px;
4466: }
1.424 albertel 4467: .LC_navbuttons {
4468: margin: 2ex 0ex 2ex 0ex;
4469: }
1.423 albertel 4470: .LC_topic_bar {
4471: font-family: $sans;
4472: font-weight: bold;
4473: width: 100%;
4474: background: $tabbg;
4475: vertical-align: middle;
4476: margin: 2ex 0ex 2ex 0ex;
4477: }
4478: .LC_topic_bar span {
4479: vertical-align: middle;
4480: }
4481: .LC_topic_bar img {
4482: vertical-align: bottom;
4483: }
4484: table.LC_course_group_status {
4485: margin: 20px;
4486: }
4487: table.LC_status_selector td {
4488: vertical-align: top;
4489: text-align: center;
1.424 albertel 4490: padding: 4px;
4491: }
4492: table.LC_descriptive_input td.LC_description {
4493: vertical-align: top;
4494: text-align: right;
4495: font-weight: bold;
1.423 albertel 4496: }
1.489 raeburn 4497: table.LC_feedback_link {
4498: background: $feedback_link_bg;
4499: }
4500: span.LC_feedback_link {
4501: background: $feedback_link_bg;
4502: font-size: larger;
4503: }
1.421 albertel 4504:
1.515 albertel 4505: table.LC_prior_tries {
1.524 albertel 4506: border: 1px solid #000000;
4507: border-collapse: separate;
4508: border-spacing: 1px;
1.515 albertel 4509: }
1.523 albertel 4510:
1.515 albertel 4511: table.LC_prior_tries td {
1.524 albertel 4512: padding: 2px;
1.515 albertel 4513: }
1.523 albertel 4514:
4515: .LC_answer_correct {
4516: background: #AAFFAA;
4517: color: black;
4518: }
4519: .LC_answer_charged_try {
4520: background: #FFAAAA ! important;
4521: color: black;
4522: }
4523: .LC_answer_not_charged_try,
4524: .LC_answer_no_grade,
4525: .LC_answer_late {
4526: background: #FFFFAA;
4527: color: black;
4528: }
4529: .LC_answer_previous {
4530: background: #AAAAFF;
4531: color: black;
4532: }
4533: .LC_answer_no_message {
4534: background: #FFFFFF;
4535: color: black;
4536: }
4537: .LC_answer_unknown {
4538: background: orange;
4539: color: black;
4540: }
4541:
4542:
1.529 albertel 4543: span.LC_prior_numerical,
4544: span.LC_prior_string,
4545: span.LC_prior_custom,
4546: span.LC_prior_reaction,
4547: span.LC_prior_math {
1.523 albertel 4548: font-family: monospace;
4549: white-space: pre;
4550: }
4551:
1.525 albertel 4552: span.LC_prior_string {
4553: font-family: monospace;
4554: white-space: pre;
4555: }
4556:
1.523 albertel 4557: table.LC_prior_option {
4558: width: 100%;
4559: border-collapse: collapse;
4560: }
1.528 albertel 4561: table.LC_prior_rank, table.LC_prior_match {
4562: border-collapse: collapse;
4563: }
4564: table.LC_prior_option tr td,
4565: table.LC_prior_rank tr td,
4566: table.LC_prior_match tr td {
1.524 albertel 4567: border: 1px solid #000000;
1.515 albertel 4568: }
4569:
1.519 raeburn 4570: span.LC_nobreak {
1.544 albertel 4571: white-space: nowrap;
1.519 raeburn 4572: }
4573:
1.576 raeburn 4574: span.LC_cusr_emph {
4575: font-style: italic;
4576: }
4577:
1.545 albertel 4578: table.LC_docs_documents {
4579: background: #BBBBBB;
1.547 albertel 4580: border-width: 0px;
1.545 albertel 4581: border-collapse: collapse;
4582: }
4583:
4584: table.LC_docs_documents td.LC_docs_document {
4585: border: 2px solid black;
4586: padding: 4px;
4587: }
4588:
4589: .LC_docs_course_commands div {
4590: float: left;
4591: border: 4px solid #AAAAAA;
4592: padding: 4px;
4593: background: #DDDDCC;
4594: }
4595:
4596: .LC_docs_entry_move {
4597: border: 0px;
4598: border-collapse: collapse;
1.544 albertel 4599: }
4600:
1.545 albertel 4601: .LC_docs_entry_move td {
4602: border: 2px solid #BBBBBB;
4603: background: #DDDDDD;
4604: }
4605:
4606: .LC_docs_editor td.LC_docs_entry_commands {
4607: background: #DDDDDD;
4608: font-size: x-small;
4609: }
1.544 albertel 4610: .LC_docs_copy {
1.545 albertel 4611: color: #000099;
1.544 albertel 4612: }
4613: .LC_docs_cut {
1.545 albertel 4614: color: #550044;
1.544 albertel 4615: }
4616: .LC_docs_rename {
1.545 albertel 4617: color: #009900;
1.544 albertel 4618: }
4619: .LC_docs_remove {
1.545 albertel 4620: color: #990000;
4621: }
4622:
1.547 albertel 4623: .LC_docs_reinit_warn,
4624: .LC_docs_ext_edit {
4625: font-size: x-small;
4626: }
4627:
1.545 albertel 4628: .LC_docs_editor td.LC_docs_entry_title,
4629: .LC_docs_editor td.LC_docs_entry_icon {
4630: background: #FFFFBB;
4631: }
4632: .LC_docs_editor td.LC_docs_entry_parameter {
4633: background: #BBBBFF;
4634: font-size: x-small;
4635: white-space: nowrap;
4636: }
4637:
4638: table.LC_docs_adddocs td,
4639: table.LC_docs_adddocs th {
4640: border: 1px solid #BBBBBB;
4641: padding: 4px;
4642: background: #DDDDDD;
1.543 albertel 4643: }
4644:
1.343 albertel 4645: END
4646: }
4647:
1.306 albertel 4648: =pod
4649:
4650: =item * &headtag()
4651:
4652: Returns a uniform footer for LON-CAPA web pages.
4653:
1.307 albertel 4654: Inputs: $title - optional title for the head
4655: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 4656: $args - optional arguments
1.319 albertel 4657: force_register - if is true call registerurl so the remote is
4658: informed
1.415 albertel 4659: redirect -> array ref of
4660: 1- seconds before redirect occurs
4661: 2- url to redirect to
4662: 3- whether the side effect should occur
1.315 albertel 4663: (side effect of setting
4664: $env{'internal.head.redirect'} to the url
4665: redirected too)
1.352 albertel 4666: domain -> force to color decorate a page for a specific
4667: domain
4668: function -> force usage of a specific rolish color scheme
4669: bgcolor -> override the default page bgcolor
1.460 albertel 4670: no_auto_mt_title
4671: -> prevent &mt()ing the title arg
1.464 albertel 4672:
1.306 albertel 4673: =cut
4674:
4675: sub headtag {
1.313 albertel 4676: my ($title,$head_extra,$args) = @_;
1.306 albertel 4677:
1.363 albertel 4678: my $function = $args->{'function'} || &get_users_function();
4679: my $domain = $args->{'domain'} || &determinedomain();
4680: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 4681: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 4682: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 4683: #time(),
1.418 albertel 4684: $env{'environment.color.timestamp'},
1.363 albertel 4685: $function,$domain,$bgcolor);
4686:
1.369 www 4687: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 4688:
1.308 albertel 4689: my $result =
4690: '<head>'.
1.461 albertel 4691: &font_settings();
1.319 albertel 4692:
1.461 albertel 4693: if (!$args->{'frameset'}) {
4694: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
4695: }
1.319 albertel 4696: if ($args->{'force_register'}) {
4697: $result .= &Apache::lonmenu::registerurl(1);
4698: }
1.436 albertel 4699: if (!$args->{'no_nav_bar'}
4700: && !$args->{'only_body'}
4701: && !$args->{'frameset'}) {
4702: $result .= &help_menu_js();
4703: }
1.319 albertel 4704:
1.314 albertel 4705: if (ref($args->{'redirect'})) {
1.414 albertel 4706: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 4707: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 4708: if (!$inhibit_continue) {
4709: $env{'internal.head.redirect'} = $url;
4710: }
1.313 albertel 4711: $result.=<<ADDMETA
4712: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 4713: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 4714: ADDMETA
4715: }
1.306 albertel 4716: if (!defined($title)) {
4717: $title = 'The LearningOnline Network with CAPA';
4718: }
1.460 albertel 4719: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
4720: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 4721: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
4722: .$head_extra;
1.306 albertel 4723: return $result;
4724: }
4725:
4726: =pod
4727:
1.340 albertel 4728: =item * &font_settings()
4729:
4730: Returns neccessary <meta> to set the proper encoding
4731:
4732: Inputs: none
4733:
4734: =cut
4735:
4736: sub font_settings {
4737: my $headerstring='';
4738: if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
4739: $headerstring.=
4740: '<meta Content-Type="text/html; charset=x-mac-roman" />';
4741: } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
4742: $headerstring.=
4743: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
4744: }
4745: return $headerstring;
4746: }
4747:
1.341 albertel 4748: =pod
4749:
4750: =item * &xml_begin()
4751:
4752: Returns the needed doctype and <html>
4753:
4754: Inputs: none
4755:
4756: =cut
4757:
4758: sub xml_begin {
4759: my $output='';
4760:
1.342 albertel 4761: &Apache::lonhtmlcommon::init_htmlareafields();
4762:
1.341 albertel 4763: if ($env{'browser.mathml'}) {
4764: $output='<?xml version="1.0"?>'
4765: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
4766: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
4767:
4768: # .'<!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">] >'
4769: .'<!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">'
4770: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
4771: .'xmlns="http://www.w3.org/1999/xhtml">';
4772: } else {
4773: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
4774: }
4775: return $output;
4776: }
1.340 albertel 4777:
4778: =pod
4779:
1.306 albertel 4780: =item * &endheadtag()
4781:
4782: Returns a uniform </head> for LON-CAPA web pages.
4783:
4784: Inputs: none
4785:
4786: =cut
4787:
4788: sub endheadtag {
4789: return '</head>';
4790: }
4791:
4792: =pod
4793:
4794: =item * &head()
4795:
4796: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
4797:
4798: Inputs: $title - optional title for the page
1.307 albertel 4799: $head_extra - optional extra HTML to put inside the <head>
1.405 albertel 4800:
1.306 albertel 4801: =cut
4802:
4803: sub head {
1.325 albertel 4804: my ($title,$head_extra,$args) = @_;
4805: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 4806: }
4807:
4808: =pod
4809:
4810: =item * &start_page()
4811:
4812: Returns a complete <html> .. <body> section for LON-CAPA web pages.
4813:
4814: Inputs: $title - optional title for the page
4815: $head_extra - optional extra HTML to incude inside the <head>
1.315 albertel 4816: $args - additional optional args supported are:
1.317 albertel 4817: only_body -> is true will set &bodytag() onlybodytag
4818: arg on
4819: no_nav_bar -> is true will set &bodytag() notopbar arg on
4820: add_entries -> additional attributes to add to the <body>
4821: domain -> force to color decorate a page for a
4822: specific domain
4823: function -> force usage of a specific rolish color
4824: scheme
4825: redirect -> see &headtag()
4826: bgcolor -> override the default page bg color
4827: js_ready -> return a string ready for being used in
4828: a javascript writeln
1.320 albertel 4829: html_encode -> return a string ready for being used in
4830: a html attribute
1.317 albertel 4831: force_register -> if is true will turn on the &bodytag()
4832: $forcereg arg
1.326 albertel 4833: body_title -> alternate text to use instead of $title
4834: in the title box that appears, this text
4835: is not auto translated like the $title is
1.330 albertel 4836: frameset -> if true will start with a <frameset>
4837: rather than <body>
1.338 albertel 4838: no_title -> if true the title bar won't be shown
4839: skip_phases -> hash ref of
4840: head -> skip the <html><head> generation
4841: body -> skip all <body> generation
1.337 albertel 4842:
1.361 albertel 4843: no_inline_link -> if true and in remote mode, don't show the
4844: 'Switch To Inline Menu' link
4845:
1.460 albertel 4846: no_auto_mt_title -> prevent &mt()ing the title arg
4847:
1.562 albertel 4848: inherit_jsmath -> when creating popup window in a page,
4849: should it have jsmath forced on by the
4850: current page
4851:
1.306 albertel 4852: =cut
4853:
4854: sub start_page {
1.309 albertel 4855: my ($title,$head_extra,$args) = @_;
1.318 albertel 4856: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 4857: my %head_args;
1.352 albertel 4858: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 4859: 'bgcolor','frameset','no_nav_bar','only_body',
4860: 'no_auto_mt_title') {
1.319 albertel 4861: if (defined($args->{$arg})) {
1.324 raeburn 4862: $head_args{$arg} = $args->{$arg};
1.319 albertel 4863: }
1.313 albertel 4864: }
1.319 albertel 4865:
1.315 albertel 4866: $env{'internal.start_page'}++;
1.338 albertel 4867: my $result;
4868: if (! exists($args->{'skip_phases'}{'head'}) ) {
4869: $result.=
1.341 albertel 4870: &xml_begin().
1.338 albertel 4871: &headtag($title,$head_extra,\%head_args).&endheadtag();
4872: }
4873:
4874: if (! exists($args->{'skip_phases'}{'body'}) ) {
4875: if ($args->{'frameset'}) {
4876: my $attr_string = &make_attr_string($args->{'force_register'},
4877: $args->{'add_entries'});
4878: $result .= "\n<frameset $attr_string>\n";
4879: } else {
4880: $result .=
4881: &bodytag($title,
4882: $args->{'function'}, $args->{'add_entries'},
4883: $args->{'only_body'}, $args->{'domain'},
4884: $args->{'force_register'}, $args->{'body_title'},
4885: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 4886: $args->{'no_title'}, $args->{'no_inline_link'},
4887: $args);
1.338 albertel 4888: }
1.330 albertel 4889: }
1.338 albertel 4890:
1.315 albertel 4891: if ($args->{'js_ready'}) {
1.317 albertel 4892: $result = &js_ready($result);
1.315 albertel 4893: }
1.320 albertel 4894: if ($args->{'html_encode'}) {
4895: $result = &html_encode($result);
4896: }
1.315 albertel 4897: return $result;
1.306 albertel 4898: }
4899:
1.330 albertel 4900:
1.306 albertel 4901: =pod
4902:
4903: =item * &head()
4904:
4905: Returns a complete </body></html> section for LON-CAPA web pages.
4906:
1.315 albertel 4907: Inputs: $args - additional optional args supported are:
4908: js_ready -> return a string ready for being used in
4909: a javascript writeln
1.320 albertel 4910: html_encode -> return a string ready for being used in
4911: a html attribute
1.330 albertel 4912: frameset -> if true will start with a <frameset>
4913: rather than <body>
1.493 albertel 4914: dicsussion -> if true will get discussion from
4915: lonxml::xmlend
4916: (you can pass the target and parser arguments
4917: through optional 'target' and 'parser' args
4918: to this routine)
1.306 albertel 4919:
4920: =cut
4921:
4922: sub end_page {
1.315 albertel 4923: my ($args) = @_;
4924: $env{'internal.end_page'}++;
1.330 albertel 4925: my $result;
1.335 albertel 4926: if ($args->{'discussion'}) {
4927: my ($target,$parser);
4928: if (ref($args->{'discussion'})) {
4929: ($target,$parser) =($args->{'discussion'}{'target'},
4930: $args->{'discussion'}{'parser'});
4931: }
4932: $result .= &Apache::lonxml::xmlend($target,$parser);
4933: }
4934:
1.330 albertel 4935: if ($args->{'frameset'}) {
4936: $result .= '</frameset>';
4937: } else {
4938: $result .= &endbodytag();
4939: }
4940: $result .= "\n</html>";
4941:
1.315 albertel 4942: if ($args->{'js_ready'}) {
1.317 albertel 4943: $result = &js_ready($result);
1.315 albertel 4944: }
1.335 albertel 4945:
1.320 albertel 4946: if ($args->{'html_encode'}) {
4947: $result = &html_encode($result);
4948: }
1.335 albertel 4949:
1.315 albertel 4950: return $result;
4951: }
4952:
1.320 albertel 4953: sub html_encode {
4954: my ($result) = @_;
4955:
1.322 albertel 4956: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 4957:
4958: return $result;
4959: }
1.317 albertel 4960: sub js_ready {
4961: my ($result) = @_;
4962:
1.323 albertel 4963: $result =~ s/[\n\r]/ /xmsg;
4964: $result =~ s/\\/\\\\/xmsg;
4965: $result =~ s/'/\\'/xmsg;
1.372 albertel 4966: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 4967:
4968: return $result;
4969: }
4970:
1.315 albertel 4971: sub validate_page {
4972: if ( exists($env{'internal.start_page'})
1.316 albertel 4973: && $env{'internal.start_page'} > 1) {
4974: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 4975: $env{'internal.start_page'}.' '.
1.316 albertel 4976: $ENV{'request.filename'});
1.315 albertel 4977: }
4978: if ( exists($env{'internal.end_page'})
1.316 albertel 4979: && $env{'internal.end_page'} > 1) {
4980: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 4981: $env{'internal.end_page'}.' '.
1.316 albertel 4982: $env{'request.filename'});
1.315 albertel 4983: }
4984: if ( exists($env{'internal.start_page'})
4985: && ! exists($env{'internal.end_page'})) {
1.316 albertel 4986: &Apache::lonnet::logthis('start_page called without end_page '.
4987: $env{'request.filename'});
1.315 albertel 4988: }
4989: if ( ! exists($env{'internal.start_page'})
4990: && exists($env{'internal.end_page'})) {
1.316 albertel 4991: &Apache::lonnet::logthis('end_page called without start_page'.
4992: $env{'request.filename'});
1.315 albertel 4993: }
1.306 albertel 4994: }
1.315 albertel 4995:
1.318 albertel 4996: sub simple_error_page {
4997: my ($r,$title,$msg) = @_;
4998: my $page =
4999: &Apache::loncommon::start_page($title).
5000: &mt($msg).
5001: &Apache::loncommon::end_page();
5002: if (ref($r)) {
5003: $r->print($page);
1.327 albertel 5004: return;
1.318 albertel 5005: }
5006: return $page;
5007: }
1.347 albertel 5008:
5009: {
5010: my $row_count;
5011: sub start_data_table {
1.422 albertel 5012: my ($add_class) = @_;
5013: my $css_class = (join(' ','LC_data_table',$add_class));
1.347 albertel 5014: undef($row_count);
1.422 albertel 5015: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 5016: }
5017:
5018: sub end_data_table {
5019: undef($row_count);
1.389 albertel 5020: return '</table>'."\n";;
1.347 albertel 5021: }
5022:
5023: sub start_data_table_row {
1.422 albertel 5024: my ($add_class) = @_;
1.347 albertel 5025: $row_count++;
1.422 albertel 5026: my $css_class = ($row_count % 2)?'':'LC_even_row';
1.428 albertel 5027: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 5028: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 5029: }
1.471 banghart 5030:
5031: sub continue_data_table_row {
5032: my ($add_class) = @_;
5033: my $css_class = ($row_count % 2)?'':'LC_even_row';
5034: $css_class = (join(' ',$css_class,$add_class));
5035: return '<tr class="'.$css_class.'">'."\n";;
5036: }
1.347 albertel 5037:
5038: sub end_data_table_row {
1.389 albertel 5039: return '</tr>'."\n";;
1.347 albertel 5040: }
1.367 www 5041:
1.421 albertel 5042: sub start_data_table_empty_row {
5043: $row_count++;
5044: return '<tr class="LC_empty_row" >'."\n";;
5045: }
5046:
5047: sub end_data_table_empty_row {
5048: return '</tr>'."\n";;
5049: }
5050:
1.367 www 5051: sub start_data_table_header_row {
1.389 albertel 5052: return '<tr class="LC_header_row">'."\n";;
1.367 www 5053: }
5054:
5055: sub end_data_table_header_row {
1.389 albertel 5056: return '</tr>'."\n";;
1.367 www 5057: }
1.347 albertel 5058: }
5059:
1.548 albertel 5060: =pod
5061:
5062: =item * &inhibit_menu_check($arg)
5063:
5064: Checks for a inhibitmenu state and generates output to preserve it
5065:
5066: Inputs: $arg - can be any of
5067: - undef - in which case the return value is a string
5068: to add into arguments list of a uri
5069: - 'input' - in which case the return value is a HTML
5070: <form> <input> field of type hidden to
5071: preserve the value
5072: - a url - in which case the return value is the url with
5073: the neccesary cgi args added to preserve the
5074: inhibitmenu state
5075: - a ref to a url - no return value, but the string is
5076: updated to include the neccessary cgi
5077: args to preserve the inhibitmenu state
5078:
5079: =cut
5080:
5081: sub inhibit_menu_check {
5082: my ($arg) = @_;
5083: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5084: if ($arg eq 'input') {
5085: if ($env{'form.inhibitmenu'}) {
5086: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
5087: } else {
5088: return
5089: }
5090: }
5091: if ($env{'form.inhibitmenu'}) {
5092: if (ref($arg)) {
5093: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5094: } elsif ($arg eq '') {
5095: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
5096: } else {
5097: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5098: }
5099: }
5100: if (!ref($arg)) {
5101: return $arg;
5102: }
5103: }
5104:
1.251 albertel 5105: ###############################################
1.182 matthew 5106:
5107: =pod
5108:
1.549 albertel 5109: =back
5110:
5111: =head1 User Information Routines
5112:
5113: =over 4
5114:
1.405 albertel 5115: =item * &get_users_function()
1.182 matthew 5116:
5117: Used by &bodytag to determine the current users primary role.
5118: Returns either 'student','coordinator','admin', or 'author'.
5119:
5120: =cut
5121:
5122: ###############################################
5123: sub get_users_function {
5124: my $function = 'student';
1.258 albertel 5125: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 5126: $function='coordinator';
5127: }
1.258 albertel 5128: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 5129: $function='admin';
5130: }
1.258 albertel 5131: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 5132: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
5133: $function='author';
5134: }
5135: return $function;
1.54 www 5136: }
1.99 www 5137:
5138: ###############################################
5139:
1.233 raeburn 5140: =pod
5141:
1.542 raeburn 5142: =item * &check_user_status()
1.274 raeburn 5143:
5144: Determines current status of supplied role for a
5145: specific user. Roles can be active, previous or future.
5146:
5147: Inputs:
5148: user's domain, user's username, course's domain,
1.375 raeburn 5149: course's number, optional section ID.
1.274 raeburn 5150:
5151: Outputs:
5152: role status: active, previous or future.
5153:
5154: =cut
5155:
5156: sub check_user_status {
1.412 raeburn 5157: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 5158: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
5159: my @uroles = keys %userinfo;
5160: my $srchstr;
5161: my $active_chk = 'none';
1.412 raeburn 5162: my $now = time;
1.274 raeburn 5163: if (@uroles > 0) {
1.412 raeburn 5164: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 5165: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
5166: } else {
1.412 raeburn 5167: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
5168: }
5169: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 5170: my $role_end = 0;
5171: my $role_start = 0;
5172: $active_chk = 'active';
1.412 raeburn 5173: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
5174: $role_end = $1;
5175: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
5176: $role_start = $1;
1.274 raeburn 5177: }
5178: }
5179: if ($role_start > 0) {
1.412 raeburn 5180: if ($now < $role_start) {
1.274 raeburn 5181: $active_chk = 'future';
5182: }
5183: }
5184: if ($role_end > 0) {
1.412 raeburn 5185: if ($now > $role_end) {
1.274 raeburn 5186: $active_chk = 'previous';
5187: }
5188: }
5189: }
5190: }
5191: return $active_chk;
5192: }
5193:
5194: ###############################################
5195:
5196: =pod
5197:
1.405 albertel 5198: =item * &get_sections()
1.233 raeburn 5199:
5200: Determines all the sections for a course including
5201: sections with students and sections containing other roles.
1.419 raeburn 5202: Incoming parameters:
5203:
5204: 1. domain
5205: 2. course number
5206: 3. reference to array containing roles for which sections should
5207: be gathered (optional).
5208: 4. reference to array containing status types for which sections
5209: should be gathered (optional).
5210:
5211: If the third argument is undefined, sections are gathered for any role.
5212: If the fourth argument is undefined, sections are gathered for any status.
5213: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 5214:
1.374 raeburn 5215: Returns section hash (keys are section IDs, values are
5216: number of users in each section), subject to the
1.419 raeburn 5217: optional roles filter, optional status filter
1.233 raeburn 5218:
5219: =cut
5220:
5221: ###############################################
5222: sub get_sections {
1.419 raeburn 5223: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 5224: if (!defined($cdom) || !defined($cnum)) {
5225: my $cid = $env{'request.course.id'};
5226:
5227: return if (!defined($cid));
5228:
5229: $cdom = $env{'course.'.$cid.'.domain'};
5230: $cnum = $env{'course.'.$cid.'.num'};
5231: }
5232:
5233: my %sectioncount;
1.419 raeburn 5234: my $now = time;
1.240 albertel 5235:
1.366 albertel 5236: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 5237: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 5238: my $sec_index = &Apache::loncoursedata::CL_SECTION();
5239: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 5240: my $start_index = &Apache::loncoursedata::CL_START();
5241: my $end_index = &Apache::loncoursedata::CL_END();
5242: my $status;
1.366 albertel 5243: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 5244: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
5245: $data->[$status_index],
5246: $data->[$start_index],
5247: $data->[$end_index]);
5248: if ($stu_status eq 'Active') {
5249: $status = 'active';
5250: } elsif ($end < $now) {
5251: $status = 'previous';
5252: } elsif ($start > $now) {
5253: $status = 'future';
5254: }
5255: if ($section ne '-1' && $section !~ /^\s*$/) {
5256: if ((!defined($possible_status)) || (($status ne '') &&
5257: (grep/^\Q$status\E$/,@{$possible_status}))) {
5258: $sectioncount{$section}++;
5259: }
1.240 albertel 5260: }
5261: }
5262: }
5263: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5264: foreach my $user (sort(keys(%courseroles))) {
5265: if ($user !~ /^(\w{2})/) { next; }
5266: my ($role) = ($user =~ /^(\w{2})/);
5267: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 5268: my ($section,$status);
1.240 albertel 5269: if ($role eq 'cr' &&
5270: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
5271: $section=$1;
5272: }
5273: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
5274: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 5275: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
5276: if ($end == -1 && $start == -1) {
5277: next; #deleted role
5278: }
5279: if (!defined($possible_status)) {
5280: $sectioncount{$section}++;
5281: } else {
5282: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
5283: $status = 'active';
5284: } elsif ($end < $now) {
5285: $status = 'future';
5286: } elsif ($start > $now) {
5287: $status = 'previous';
5288: }
5289: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
5290: $sectioncount{$section}++;
5291: }
5292: }
1.233 raeburn 5293: }
1.366 albertel 5294: return %sectioncount;
1.233 raeburn 5295: }
5296:
1.274 raeburn 5297: ###############################################
1.294 raeburn 5298:
5299: =pod
1.405 albertel 5300:
5301: =item * &get_course_users()
5302:
1.275 raeburn 5303: Retrieves usernames:domains for users in the specified course
5304: with specific role(s), and access status.
5305:
5306: Incoming parameters:
1.277 albertel 5307: 1. course domain
5308: 2. course number
5309: 3. access status: users must have - either active,
1.275 raeburn 5310: previous, future, or all.
1.277 albertel 5311: 4. reference to array of permissible roles
1.288 raeburn 5312: 5. reference to array of section restrictions (optional)
5313: 6. reference to results object (hash of hashes).
5314: 7. reference to optional userdata hash
1.275 raeburn 5315: Keys of top level hash are roles.
5316: Keys of inner hashes are username:domain, with
5317: values set to access type.
1.288 raeburn 5318: Optional userdata hash returns an array with arguments in the
5319: same order as loncoursedata::get_classlist() for student data.
5320:
5321: Entries for end, start, section and status are blank because
5322: of the possibility of multiple values for non-student roles.
5323:
1.275 raeburn 5324: =cut
1.405 albertel 5325:
1.275 raeburn 5326: ###############################################
1.405 albertel 5327:
1.275 raeburn 5328: sub get_course_users {
1.288 raeburn 5329: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
5330: my %idx = ();
1.419 raeburn 5331: my %seclists;
1.288 raeburn 5332:
5333: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
5334: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
5335: $idx{end} = &Apache::loncoursedata::CL_END();
5336: $idx{start} = &Apache::loncoursedata::CL_START();
5337: $idx{id} = &Apache::loncoursedata::CL_ID();
5338: $idx{section} = &Apache::loncoursedata::CL_SECTION();
5339: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
5340: $idx{status} = &Apache::loncoursedata::CL_STATUS();
5341:
1.290 albertel 5342: if (grep(/^st$/,@{$roles})) {
1.276 albertel 5343: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 5344: my $now = time;
1.277 albertel 5345: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 5346: my $match = 0;
1.412 raeburn 5347: my $secmatch = 0;
1.419 raeburn 5348: my $section = $$classlist{$student}[$idx{section}];
5349: if ($section eq '') {
5350: $section = 'none';
5351: }
1.291 albertel 5352: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5353: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5354: $secmatch = 1;
5355: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 5356: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5357: $secmatch = 1;
5358: }
5359: } else {
1.419 raeburn 5360: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 5361: $secmatch = 1;
5362: }
1.290 albertel 5363: }
1.412 raeburn 5364: if (!$secmatch) {
5365: next;
5366: }
1.419 raeburn 5367: }
1.420 albertel 5368: push(@{$seclists{$student}},$section);
1.275 raeburn 5369: if (defined($$types{'active'})) {
1.288 raeburn 5370: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 5371: push(@{$$users{st}{$student}},'active');
1.288 raeburn 5372: $match = 1;
1.275 raeburn 5373: }
5374: }
5375: if (defined($$types{'previous'})) {
1.288 raeburn 5376: if ($$classlist{$student}[$idx{end}] <= $now) {
1.275 raeburn 5377: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 5378: $match = 1;
1.275 raeburn 5379: }
5380: }
5381: if (defined($$types{'future'})) {
1.288 raeburn 5382: if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
1.275 raeburn 5383: push(@{$$users{st}{$student}},'future');
1.288 raeburn 5384: $match = 1;
1.275 raeburn 5385: }
5386: }
1.412 raeburn 5387: if ($match && ref($userdata) eq 'HASH') {
1.288 raeburn 5388: $$userdata{$student} = $$classlist{$student};
5389: }
1.275 raeburn 5390: }
5391: }
1.412 raeburn 5392: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 5393: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5394: my $now = time;
5395: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 5396: my $match = 0;
1.412 raeburn 5397: my $secmatch = 0;
1.439 raeburn 5398: my $status;
1.412 raeburn 5399: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 5400: $user =~ s/:$//;
1.439 raeburn 5401: my ($end,$start) = split(/:/,$coursepersonnel{$person});
5402: if ($end == -1 || $start == -1) {
5403: next;
5404: }
5405: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
5406: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 5407: my ($uname,$udom) = split(/:/,$user);
5408: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5409: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5410: $secmatch = 1;
5411: } elsif ($usec eq '') {
1.420 albertel 5412: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5413: $secmatch = 1;
5414: }
5415: } else {
5416: if (grep(/^\Q$usec\E$/,@{$sections})) {
5417: $secmatch = 1;
5418: }
5419: }
5420: if (!$secmatch) {
5421: next;
5422: }
1.288 raeburn 5423: }
1.419 raeburn 5424: if ($usec eq '') {
5425: $usec = 'none';
5426: }
1.275 raeburn 5427: if ($uname ne '' && $udom ne '') {
1.503 raeburn 5428: if ($end > 0 && $end < $now) {
1.439 raeburn 5429: $status = 'previous';
5430: } elsif ($start > $now) {
5431: $status = 'future';
5432: } else {
5433: $status = 'active';
5434: }
1.277 albertel 5435: foreach my $type (keys(%{$types})) {
1.275 raeburn 5436: if ($status eq $type) {
1.420 albertel 5437: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 5438: push(@{$$users{$role}{$user}},$type);
5439: }
1.288 raeburn 5440: $match = 1;
5441: }
5442: }
1.419 raeburn 5443: if (($match) && (ref($userdata) eq 'HASH')) {
5444: if (!exists($$userdata{$uname.':'.$udom})) {
5445: &get_user_info($udom,$uname,\%idx,$userdata);
5446: }
1.420 albertel 5447: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 5448: push(@{$seclists{$uname.':'.$udom}},$usec);
5449: }
1.275 raeburn 5450: }
5451: }
5452: }
5453: }
1.290 albertel 5454: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 5455: if ((defined($cdom)) && (defined($cnum))) {
5456: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
5457: if ( defined($csettings{'internal.courseowner'}) ) {
5458: my $owner = $csettings{'internal.courseowner'};
1.439 raeburn 5459: if ($owner !~ /^[^:]+:[^:]+$/) {
5460: $owner = $owner.':'.$cdom;
5461: }
5462: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 5463: if (defined($userdata) &&
5464: !exists($$userdata{$owner.':'.$cdom})) {
5465: &get_user_info($cdom,$owner,\%idx,$userdata);
1.420 albertel 5466: if (!grep(/^none$/,@{$seclists{$owner.':'.$cdom}})) {
1.419 raeburn 5467: push(@{$seclists{$owner.':'.$cdom}},'none');
5468: }
1.290 albertel 5469: }
1.279 raeburn 5470: }
5471: }
5472: }
1.419 raeburn 5473: foreach my $user (keys(%seclists)) {
5474: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
5475: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
5476: }
1.275 raeburn 5477: }
5478: return;
5479: }
5480:
1.288 raeburn 5481: sub get_user_info {
5482: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 5483: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
5484: &plainname($uname,$udom,'lastname');
1.291 albertel 5485: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 5486: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.288 raeburn 5487: return;
5488: }
1.275 raeburn 5489:
1.472 raeburn 5490: ###############################################
5491:
5492: =pod
5493:
5494: =item * &get_user_quota()
5495:
5496: Retrieves quota assigned for storage of portfolio files for a user
5497:
5498: Incoming parameters:
5499: 1. user's username
5500: 2. user's domain
5501:
5502: Returns:
1.536 raeburn 5503: 1. Disk quota (in Mb) assigned to student.
5504: 2. (Optional) Type of setting: custom or default
5505: (individually assigned or default for user's
5506: institutional status).
5507: 3. (Optional) - User's institutional status (e.g., faculty, staff
5508: or student - types as defined in localenroll::inst_usertypes
5509: for user's domain, which determines default quota for user.
5510: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 5511:
5512: If a value has been stored in the user's environment,
1.536 raeburn 5513: it will return that, otherwise it returns the maximal default
5514: defined for the user's instituional status(es) in the domain.
1.472 raeburn 5515:
5516: =cut
5517:
5518: ###############################################
5519:
5520:
5521: sub get_user_quota {
5522: my ($uname,$udom) = @_;
1.536 raeburn 5523: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 5524: if (!defined($udom)) {
5525: $udom = $env{'user.domain'};
5526: }
5527: if (!defined($uname)) {
5528: $uname = $env{'user.name'};
5529: }
5530: if (($udom eq '' || $uname eq '') ||
5531: ($udom eq 'public') && ($uname eq 'public')) {
5532: $quota = 0;
1.536 raeburn 5533: $quotatype = 'default';
5534: $defquota = 0;
1.472 raeburn 5535: } else {
1.536 raeburn 5536: my $inststatus;
1.472 raeburn 5537: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
5538: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 5539: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 5540: } else {
1.536 raeburn 5541: my %userenv =
5542: &Apache::lonnet::get('environment',['portfolioquota',
5543: 'inststatus'],$udom,$uname);
1.472 raeburn 5544: my ($tmp) = keys(%userenv);
5545: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
5546: $quota = $userenv{'portfolioquota'};
1.536 raeburn 5547: $inststatus = $userenv{'inststatus'};
1.472 raeburn 5548: } else {
5549: undef(%userenv);
5550: }
5551: }
1.536 raeburn 5552: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 5553: if ($quota eq '') {
1.536 raeburn 5554: $quota = $defquota;
5555: $quotatype = 'default';
5556: } else {
5557: $quotatype = 'custom';
1.472 raeburn 5558: }
5559: }
1.536 raeburn 5560: if (wantarray) {
5561: return ($quota,$quotatype,$settingstatus,$defquota);
5562: } else {
5563: return $quota;
5564: }
1.472 raeburn 5565: }
5566:
5567: ###############################################
5568:
5569: =pod
5570:
5571: =item * &default_quota()
5572:
1.536 raeburn 5573: Retrieves default quota assigned for storage of user portfolio files,
5574: given an (optional) user's institutional status.
1.472 raeburn 5575:
5576: Incoming parameters:
5577: 1. domain
1.536 raeburn 5578: 2. (Optional) institutional status(es). This is a : separated list of
5579: status types (e.g., faculty, staff, student etc.)
5580: which apply to the user for whom the default is being retrieved.
5581: If the institutional status string in undefined, the domain
5582: default quota will be returned.
1.472 raeburn 5583:
5584: Returns:
5585: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 5586: 2. (Optional) institutional type which determined the value of the
5587: default quota.
1.472 raeburn 5588:
5589: If a value has been stored in the domain's configuration db,
5590: it will return that, otherwise it returns 20 (for backwards
5591: compatibility with domains which have not set up a configuration
5592: db file; the original statically defined portfolio quota was 20 Mb).
5593:
1.536 raeburn 5594: If the user's status includes multiple types (e.g., staff and student),
5595: the largest default quota which applies to the user determines the
5596: default quota returned.
5597:
1.472 raeburn 5598: =cut
5599:
5600: ###############################################
5601:
5602:
5603: sub default_quota {
1.536 raeburn 5604: my ($udom,$inststatus) = @_;
5605: my ($defquota,$settingstatus);
5606: my %quotahash = &Apache::lonnet::get_dom('configuration',
5607: ['quota'],$udom);
5608: if (ref($quotahash{'quota'}) eq 'HASH') {
5609: if ($inststatus ne '') {
5610: my @statuses = split(/:/,$inststatus);
5611: foreach my $item (@statuses) {
5612: if ($quotahash{'quota'}{$item} ne '') {
5613: if ($defquota eq '') {
5614: $defquota = $quotahash{'quota'}{$item};
5615: $settingstatus = $item;
5616: } elsif ($quotahash{'quota'}{$item} > $defquota) {
5617: $defquota = $quotahash{'quota'}{$item};
5618: $settingstatus = $item;
5619: }
5620: }
5621: }
5622: }
5623: if ($defquota eq '') {
5624: $defquota = $quotahash{'quota'}{'default'};
5625: $settingstatus = 'default';
5626: }
5627: } else {
5628: $settingstatus = 'default';
5629: $defquota = 20;
5630: }
5631: if (wantarray) {
5632: return ($defquota,$settingstatus);
1.472 raeburn 5633: } else {
1.536 raeburn 5634: return $defquota;
1.472 raeburn 5635: }
5636: }
5637:
1.384 raeburn 5638: sub get_secgrprole_info {
5639: my ($cdom,$cnum,$needroles,$type) = @_;
5640: my %sections_count = &get_sections($cdom,$cnum);
5641: my @sections = (sort {$a <=> $b} keys(%sections_count));
5642: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
5643: my @groups = sort(keys(%curr_groups));
5644: my $allroles = [];
5645: my $rolehash;
5646: my $accesshash = {
5647: active => 'Currently has access',
5648: future => 'Will have future access',
5649: previous => 'Previously had access',
5650: };
5651: if ($needroles) {
5652: $rolehash = {'all' => 'all'};
1.385 albertel 5653: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5654: if (&Apache::lonnet::error(%user_roles)) {
5655: undef(%user_roles);
5656: }
5657: foreach my $item (keys(%user_roles)) {
1.384 raeburn 5658: my ($role)=split(/\:/,$item,2);
5659: if ($role eq 'cr') { next; }
5660: if ($role =~ /^cr/) {
5661: $$rolehash{$role} = (split('/',$role))[3];
5662: } else {
5663: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
5664: }
5665: }
5666: foreach my $key (sort(keys(%{$rolehash}))) {
5667: push(@{$allroles},$key);
5668: }
5669: push (@{$allroles},'st');
5670: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
5671: }
5672: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
5673: }
5674:
1.555 raeburn 5675: sub user_picker {
1.570 raeburn 5676: my ($dom,$srch,$forcenewuser,$caller) = @_;
1.555 raeburn 5677: my $currdom = $dom;
5678: my %curr_selected = (
5679: srchin => 'dom',
1.580 raeburn 5680: srchby => 'lastname',
1.555 raeburn 5681: );
5682: my $srchterm;
5683: if (ref($srch) eq 'HASH') {
5684: if ($srch->{'srchby'} ne '') {
5685: $curr_selected{'srchby'} = $srch->{'srchby'};
5686: }
5687: if ($srch->{'srchin'} ne '') {
5688: $curr_selected{'srchin'} = $srch->{'srchin'};
5689: }
5690: if ($srch->{'srchtype'} ne '') {
5691: $curr_selected{'srchtype'} = $srch->{'srchtype'};
5692: }
5693: if ($srch->{'srchdomain'} ne '') {
5694: $currdom = $srch->{'srchdomain'};
5695: }
5696: $srchterm = $srch->{'srchterm'};
5697: }
5698: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 5699: 'usr' => 'Search criteria',
1.563 raeburn 5700: 'doma' => 'Domain/institution to search',
1.558 albertel 5701: 'uname' => 'username',
5702: 'lastname' => 'last name',
1.555 raeburn 5703: 'lastfirst' => 'last name, first name',
1.558 albertel 5704: 'crs' => 'in this course',
1.576 raeburn 5705: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 5706: 'alc' => 'all LON-CAPA',
1.573 raeburn 5707: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 5708: 'exact' => 'is',
5709: 'contains' => 'contains',
1.569 raeburn 5710: 'begins' => 'begins with',
1.571 raeburn 5711: 'youm' => "You must include some text to search for.",
5712: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
5713: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
5714: 'yomc' => "You must choose a domain when using an institutional directory search.",
5715: 'ymcd' => "You must choose a domain when using a domain search.",
5716: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
5717: 'whse' => "When searching by last,first you must include at least one character in the first name.",
5718: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 5719: );
1.563 raeburn 5720: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
5721: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 5722:
5723: my @srchins = ('crs','dom','alc','instd');
5724:
5725: foreach my $option (@srchins) {
5726: # FIXME 'alc' option unavailable until
5727: # loncreateuser::print_user_query_page()
5728: # has been completed.
5729: next if ($option eq 'alc');
5730: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 5731: if ($curr_selected{'srchin'} eq $option) {
5732: $srchinsel .= '
5733: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5734: } else {
5735: $srchinsel .= '
5736: <option value="'.$option.'">'.$lt{$option}.'</option>';
5737: }
1.555 raeburn 5738: }
1.563 raeburn 5739: $srchinsel .= "\n </select>\n";
1.555 raeburn 5740:
5741: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 5742: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 5743: if ($curr_selected{'srchby'} eq $option) {
5744: $srchbysel .= '
5745: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5746: } else {
5747: $srchbysel .= '
5748: <option value="'.$option.'">'.$lt{$option}.'</option>';
5749: }
5750: }
5751: $srchbysel .= "\n </select>\n";
5752:
5753: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 5754: foreach my $option ('begins','contains','exact') {
1.555 raeburn 5755: if ($curr_selected{'srchtype'} eq $option) {
5756: $srchtypesel .= '
5757: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
5758: } else {
5759: $srchtypesel .= '
5760: <option value="'.$option.'">'.$lt{$option}.'</option>';
5761: }
5762: }
5763: $srchtypesel .= "\n </select>\n";
5764:
1.558 albertel 5765: my ($newuserscript,$new_user_create);
1.556 raeburn 5766:
5767: if ($forcenewuser) {
1.576 raeburn 5768: if (ref($srch) eq 'HASH') {
5769: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
5770: $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>';
5771: }
5772: }
5773:
1.556 raeburn 5774: $newuserscript = <<"ENDSCRIPT";
5775:
1.570 raeburn 5776: function setSearch(createnew,callingForm) {
1.556 raeburn 5777: if (createnew == 1) {
1.570 raeburn 5778: for (var i=0; i<callingForm.srchby.length; i++) {
5779: if (callingForm.srchby.options[i].value == 'uname') {
5780: callingForm.srchby.selectedIndex = i;
1.556 raeburn 5781: }
5782: }
1.570 raeburn 5783: for (var i=0; i<callingForm.srchin.length; i++) {
5784: if ( callingForm.srchin.options[i].value == 'dom') {
5785: callingForm.srchin.selectedIndex = i;
1.556 raeburn 5786: }
5787: }
1.570 raeburn 5788: for (var i=0; i<callingForm.srchtype.length; i++) {
5789: if (callingForm.srchtype.options[i].value == 'exact') {
5790: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 5791: }
5792: }
1.570 raeburn 5793: for (var i=0; i<callingForm.srchdomain.length; i++) {
5794: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
5795: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 5796: }
5797: }
5798: }
5799: }
5800: ENDSCRIPT
1.558 albertel 5801:
1.556 raeburn 5802: }
5803:
1.555 raeburn 5804: my $output = <<"END_BLOCK";
1.556 raeburn 5805: <script type="text/javascript">
1.570 raeburn 5806: function validateEntry(callingForm) {
1.558 albertel 5807:
1.556 raeburn 5808: var checkok = 1;
1.558 albertel 5809: var srchin;
1.570 raeburn 5810: for (var i=0; i<callingForm.srchin.length; i++) {
5811: if ( callingForm.srchin[i].checked ) {
5812: srchin = callingForm.srchin[i].value;
1.558 albertel 5813: }
5814: }
5815:
1.570 raeburn 5816: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
5817: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
5818: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
5819: var srchterm = callingForm.srchterm.value;
5820: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 5821: var msg = "";
5822:
5823: if (srchterm == "") {
5824: checkok = 0;
1.571 raeburn 5825: msg += "$lt{'youm'}\\n";
1.556 raeburn 5826: }
5827:
1.569 raeburn 5828: if (srchtype== 'begins') {
5829: if (srchterm.length < 2) {
5830: checkok = 0;
1.571 raeburn 5831: msg += "$lt{'thte'}\\n";
1.569 raeburn 5832: }
5833: }
5834:
1.556 raeburn 5835: if (srchtype== 'contains') {
5836: if (srchterm.length < 3) {
5837: checkok = 0;
1.571 raeburn 5838: msg += "$lt{'thet'}\\n";
1.556 raeburn 5839: }
5840: }
5841: if (srchin == 'instd') {
5842: if (srchdomain == '') {
5843: checkok = 0;
1.571 raeburn 5844: msg += "$lt{'yomc'}\\n";
1.556 raeburn 5845: }
5846: }
5847: if (srchin == 'dom') {
5848: if (srchdomain == '') {
5849: checkok = 0;
1.571 raeburn 5850: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 5851: }
5852: }
5853: if (srchby == 'lastfirst') {
5854: if (srchterm.indexOf(",") == -1) {
5855: checkok = 0;
1.571 raeburn 5856: msg += "$lt{'whus'}\\n";
1.556 raeburn 5857: }
5858: if (srchterm.indexOf(",") == srchterm.length -1) {
5859: checkok = 0;
1.571 raeburn 5860: msg += "$lt{'whse'}\\n";
1.556 raeburn 5861: }
5862: }
5863: if (checkok == 0) {
1.571 raeburn 5864: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 5865: return;
5866: }
5867: if (checkok == 1) {
1.570 raeburn 5868: callingForm.submit();
1.556 raeburn 5869: }
5870: }
5871:
5872: $newuserscript
5873:
5874: </script>
1.558 albertel 5875:
5876: $new_user_create
5877:
1.555 raeburn 5878: <table>
1.558 albertel 5879: <tr>
1.573 raeburn 5880: <td>$lt{'doma'}:</td>
5881: <td>$domform</td>
5882: </td>
5883: </tr>
5884: <tr>
5885: <td>$lt{'usr'}:</td>
1.563 raeburn 5886: <td>$srchbysel
5887: $srchtypesel
5888: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 5889: $srchinsel
1.563 raeburn 5890: </td>
5891: </tr>
1.555 raeburn 5892: </table>
5893: <br />
5894: END_BLOCK
1.558 albertel 5895:
1.555 raeburn 5896: return $output;
5897: }
5898:
1.112 bowersj2 5899: =pod
5900:
1.549 albertel 5901: =back
5902:
5903: =head1 HTTP Helpers
5904:
5905: =over 4
5906:
1.112 bowersj2 5907: =item * get_unprocessed_cgi($query,$possible_names)
5908:
1.258 albertel 5909: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 5910: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 5911: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 5912:
5913: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
5914: $possible_names is an ref to an array of form element names. As an example:
5915: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 5916: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 5917:
5918: =cut
1.1 albertel 5919:
1.6 albertel 5920: sub get_unprocessed_cgi {
1.25 albertel 5921: my ($query,$possible_names)= @_;
1.26 matthew 5922: # $Apache::lonxml::debug=1;
1.356 albertel 5923: foreach my $pair (split(/&/,$query)) {
5924: my ($name, $value) = split(/=/,$pair);
1.369 www 5925: $name = &unescape($name);
1.25 albertel 5926: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
5927: $value =~ tr/+/ /;
5928: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 5929: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 5930: }
1.16 harris41 5931: }
1.6 albertel 5932: }
5933:
1.112 bowersj2 5934: =pod
5935:
5936: =item * cacheheader()
5937:
5938: returns cache-controlling header code
5939:
5940: =cut
5941:
1.7 albertel 5942: sub cacheheader {
1.258 albertel 5943: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 5944: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
5945: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 5946: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
5947: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 5948: return $output;
1.7 albertel 5949: }
5950:
1.112 bowersj2 5951: =pod
5952:
5953: =item * no_cache($r)
5954:
5955: specifies header code to not have cache
5956:
5957: =cut
5958:
1.9 albertel 5959: sub no_cache {
1.216 albertel 5960: my ($r) = @_;
5961: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 5962: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 5963: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
5964: $r->no_cache(1);
5965: $r->header_out("Expires" => $date);
5966: $r->header_out("Pragma" => "no-cache");
1.123 www 5967: }
5968:
5969: sub content_type {
1.181 albertel 5970: my ($r,$type,$charset) = @_;
1.299 foxr 5971: if ($r) {
5972: # Note that printout.pl calls this with undef for $r.
5973: &no_cache($r);
5974: }
1.258 albertel 5975: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 5976: unless ($charset) {
5977: $charset=&Apache::lonlocal::current_encoding;
5978: }
5979: if ($charset) { $type.='; charset='.$charset; }
5980: if ($r) {
5981: $r->content_type($type);
5982: } else {
5983: print("Content-type: $type\n\n");
5984: }
1.9 albertel 5985: }
1.25 albertel 5986:
1.112 bowersj2 5987: =pod
5988:
5989: =item * add_to_env($name,$value)
5990:
1.258 albertel 5991: adds $name to the %env hash with value
1.112 bowersj2 5992: $value, if $name already exists, the entry is converted to an array
5993: reference and $value is added to the array.
5994:
5995: =cut
5996:
1.25 albertel 5997: sub add_to_env {
5998: my ($name,$value)=@_;
1.258 albertel 5999: if (defined($env{$name})) {
6000: if (ref($env{$name})) {
1.25 albertel 6001: #already have multiple values
1.258 albertel 6002: push(@{ $env{$name} },$value);
1.25 albertel 6003: } else {
6004: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 6005: my $first=$env{$name};
6006: undef($env{$name});
6007: push(@{ $env{$name} },$first,$value);
1.25 albertel 6008: }
6009: } else {
1.258 albertel 6010: $env{$name}=$value;
1.25 albertel 6011: }
1.31 albertel 6012: }
1.149 albertel 6013:
6014: =pod
6015:
6016: =item * get_env_multiple($name)
6017:
1.258 albertel 6018: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 6019: values may be defined and end up as an array ref.
6020:
6021: returns an array of values
6022:
6023: =cut
6024:
6025: sub get_env_multiple {
6026: my ($name) = @_;
6027: my @values;
1.258 albertel 6028: if (defined($env{$name})) {
1.149 albertel 6029: # exists is it an array
1.258 albertel 6030: if (ref($env{$name})) {
6031: @values=@{ $env{$name} };
1.149 albertel 6032: } else {
1.258 albertel 6033: $values[0]=$env{$name};
1.149 albertel 6034: }
6035: }
6036: return(@values);
6037: }
6038:
1.31 albertel 6039:
1.41 ng 6040: =pod
1.45 matthew 6041:
1.464 albertel 6042: =back
1.41 ng 6043:
1.112 bowersj2 6044: =head1 CSV Upload/Handling functions
1.38 albertel 6045:
1.41 ng 6046: =over 4
6047:
1.112 bowersj2 6048: =item * upfile_store($r)
1.41 ng 6049:
6050: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 6051: needs $env{'form.upfile'}
1.41 ng 6052: returns $datatoken to be put into hidden field
6053:
6054: =cut
1.31 albertel 6055:
6056: sub upfile_store {
6057: my $r=shift;
1.258 albertel 6058: $env{'form.upfile'}=~s/\r/\n/gs;
6059: $env{'form.upfile'}=~s/\f/\n/gs;
6060: $env{'form.upfile'}=~s/\n+/\n/gs;
6061: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 6062:
1.258 albertel 6063: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
6064: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 6065: {
1.158 raeburn 6066: my $datafile = $r->dir_config('lonDaemons').
6067: '/tmp/'.$datatoken.'.tmp';
6068: if ( open(my $fh,">$datafile") ) {
1.258 albertel 6069: print $fh $env{'form.upfile'};
1.158 raeburn 6070: close($fh);
6071: }
1.31 albertel 6072: }
6073: return $datatoken;
6074: }
6075:
1.56 matthew 6076: =pod
6077:
1.112 bowersj2 6078: =item * load_tmp_file($r)
1.41 ng 6079:
6080: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 6081: needs $env{'form.datatoken'},
6082: sets $env{'form.upfile'} to the contents of the file
1.41 ng 6083:
6084: =cut
1.31 albertel 6085:
6086: sub load_tmp_file {
6087: my $r=shift;
6088: my @studentdata=();
6089: {
1.158 raeburn 6090: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 6091: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 6092: if ( open(my $fh,"<$studentfile") ) {
6093: @studentdata=<$fh>;
6094: close($fh);
6095: }
1.31 albertel 6096: }
1.258 albertel 6097: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 6098: }
6099:
1.56 matthew 6100: =pod
6101:
1.112 bowersj2 6102: =item * upfile_record_sep()
1.41 ng 6103:
6104: Separate uploaded file into records
6105: returns array of records,
1.258 albertel 6106: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 6107:
6108: =cut
1.31 albertel 6109:
6110: sub upfile_record_sep {
1.258 albertel 6111: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 6112: } else {
1.248 albertel 6113: my @records;
1.258 albertel 6114: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 6115: if ($line=~/^\s*$/) { next; }
6116: push(@records,$line);
6117: }
6118: return @records;
1.31 albertel 6119: }
6120: }
6121:
1.56 matthew 6122: =pod
6123:
1.112 bowersj2 6124: =item * record_sep($record)
1.41 ng 6125:
1.258 albertel 6126: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 6127:
6128: =cut
6129:
1.263 www 6130: sub takeleft {
6131: my $index=shift;
6132: return substr('0000'.$index,-4,4);
6133: }
6134:
1.31 albertel 6135: sub record_sep {
6136: my $record=shift;
6137: my %components=();
1.258 albertel 6138: if ($env{'form.upfiletype'} eq 'xml') {
6139: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 6140: my $i=0;
1.356 albertel 6141: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 6142: $field=~s/^(\"|\')//;
6143: $field=~s/(\"|\')$//;
1.263 www 6144: $components{&takeleft($i)}=$field;
1.31 albertel 6145: $i++;
6146: }
1.258 albertel 6147: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 6148: my $i=0;
1.356 albertel 6149: foreach my $field (split(/\t/,$record)) {
1.31 albertel 6150: $field=~s/^(\"|\')//;
6151: $field=~s/(\"|\')$//;
1.263 www 6152: $components{&takeleft($i)}=$field;
1.31 albertel 6153: $i++;
6154: }
6155: } else {
1.561 www 6156: my $separator=',';
1.480 banghart 6157: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 6158: $separator=';';
1.480 banghart 6159: }
1.31 albertel 6160: my $i=0;
1.561 www 6161: # the character we are looking for to indicate the end of a quote or a record
6162: my $looking_for=$separator;
6163: # do not add the characters to the fields
6164: my $ignore=0;
6165: # we just encountered a separator (or the beginning of the record)
6166: my $just_found_separator=1;
6167: # store the field we are working on here
6168: my $field='';
6169: # work our way through all characters in record
6170: foreach my $character ($record=~/(.)/g) {
6171: if ($character eq $looking_for) {
6172: if ($character ne $separator) {
6173: # Found the end of a quote, again looking for separator
6174: $looking_for=$separator;
6175: $ignore=1;
6176: } else {
6177: # Found a separator, store away what we got
6178: $components{&takeleft($i)}=$field;
6179: $i++;
6180: $just_found_separator=1;
6181: $ignore=0;
6182: $field='';
6183: }
6184: next;
6185: }
6186: # single or double quotation marks after a separator indicate beginning of a quote
6187: # we are now looking for the end of the quote and need to ignore separators
6188: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
6189: $looking_for=$character;
6190: next;
6191: }
6192: # ignore would be true after we reached the end of a quote
6193: if ($ignore) { next; }
6194: if (($just_found_separator) && ($character=~/\s/)) { next; }
6195: $field.=$character;
6196: $just_found_separator=0;
1.31 albertel 6197: }
1.561 www 6198: # catch the very last entry, since we never encountered the separator
6199: $components{&takeleft($i)}=$field;
1.31 albertel 6200: }
6201: return %components;
6202: }
6203:
1.144 matthew 6204: ######################################################
6205: ######################################################
6206:
1.56 matthew 6207: =pod
6208:
1.112 bowersj2 6209: =item * upfile_select_html()
1.41 ng 6210:
1.144 matthew 6211: Return HTML code to select a file from the users machine and specify
6212: the file type.
1.41 ng 6213:
6214: =cut
6215:
1.144 matthew 6216: ######################################################
6217: ######################################################
1.31 albertel 6218: sub upfile_select_html {
1.144 matthew 6219: my %Types = (
6220: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 6221: semisv => &mt('Semicolon separated values'),
1.144 matthew 6222: space => &mt('Space separated'),
6223: tab => &mt('Tabulator separated'),
6224: # xml => &mt('HTML/XML'),
6225: );
6226: my $Str = '<input type="file" name="upfile" size="50" />'.
6227: '<br />Type: <select name="upfiletype">';
6228: foreach my $type (sort(keys(%Types))) {
6229: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
6230: }
6231: $Str .= "</select>\n";
6232: return $Str;
1.31 albertel 6233: }
6234:
1.301 albertel 6235: sub get_samples {
6236: my ($records,$toget) = @_;
6237: my @samples=({});
6238: my $got=0;
6239: foreach my $rec (@$records) {
6240: my %temp = &record_sep($rec);
6241: if (! grep(/\S/, values(%temp))) { next; }
6242: if (%temp) {
6243: $samples[$got]=\%temp;
6244: $got++;
6245: if ($got == $toget) { last; }
6246: }
6247: }
6248: return \@samples;
6249: }
6250:
1.144 matthew 6251: ######################################################
6252: ######################################################
6253:
1.56 matthew 6254: =pod
6255:
1.112 bowersj2 6256: =item * csv_print_samples($r,$records)
1.41 ng 6257:
6258: Prints a table of sample values from each column uploaded $r is an
6259: Apache Request ref, $records is an arrayref from
6260: &Apache::loncommon::upfile_record_sep
6261:
6262: =cut
6263:
1.144 matthew 6264: ######################################################
6265: ######################################################
1.31 albertel 6266: sub csv_print_samples {
6267: my ($r,$records) = @_;
1.301 albertel 6268: my $samples = &get_samples($records,3);
6269:
1.144 matthew 6270: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
1.356 albertel 6271: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6272: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.31 albertel 6273: $r->print('</tr>');
1.301 albertel 6274: foreach my $hash (@$samples) {
1.31 albertel 6275: $r->print('<tr>');
1.356 albertel 6276: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 6277: $r->print('<td>');
1.356 albertel 6278: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 6279: $r->print('</td>');
6280: }
6281: $r->print('</tr>');
6282: }
6283: $r->print('</tr></table><br />'."\n");
6284: }
6285:
1.144 matthew 6286: ######################################################
6287: ######################################################
6288:
1.56 matthew 6289: =pod
6290:
1.112 bowersj2 6291: =item * csv_print_select_table($r,$records,$d)
1.41 ng 6292:
6293: Prints a table to create associations between values and table columns.
1.144 matthew 6294:
1.41 ng 6295: $r is an Apache Request ref,
6296: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 6297: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 6298:
6299: =cut
6300:
1.144 matthew 6301: ######################################################
6302: ######################################################
1.31 albertel 6303: sub csv_print_select_table {
6304: my ($r,$records,$d) = @_;
1.301 albertel 6305: my $i=0;
6306: my $samples = &get_samples($records,1);
1.144 matthew 6307: $r->print(&mt('Associate columns with student attributes.')."\n".
6308: '<table border="2"><tr>'.
6309: '<th>'.&mt('Attribute').'</th>'.
6310: '<th>'.&mt('Column').'</th></tr>'."\n");
1.356 albertel 6311: foreach my $array_ref (@$d) {
6312: my ($value,$display,$defaultcol)=@{ $array_ref };
1.31 albertel 6313: $r->print('<tr><td>'.$display.'</td>');
6314:
6315: $r->print('<td><select name=f'.$i.
1.32 matthew 6316: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 6317: $r->print('<option value="none"></option>');
1.356 albertel 6318: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
6319: $r->print('<option value="'.$sample.'"'.
6320: ($sample eq $defaultcol ? ' selected="selected" ' : '').
6321: '>Column '.($sample+1).'</option>');
1.31 albertel 6322: }
6323: $r->print('</select></td></tr>'."\n");
6324: $i++;
6325: }
6326: $i--;
6327: return $i;
6328: }
1.56 matthew 6329:
1.144 matthew 6330: ######################################################
6331: ######################################################
6332:
1.56 matthew 6333: =pod
1.31 albertel 6334:
1.112 bowersj2 6335: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 6336:
6337: Prints a table of sample values from the upload and can make associate samples to internal names.
6338:
6339: $r is an Apache Request ref,
6340: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
6341: $d is an array of 2 element arrays (internal name, displayed name)
6342:
6343: =cut
6344:
1.144 matthew 6345: ######################################################
6346: ######################################################
1.31 albertel 6347: sub csv_samples_select_table {
6348: my ($r,$records,$d) = @_;
6349: my $i=0;
1.144 matthew 6350: #
1.301 albertel 6351: my $samples = &get_samples($records,3);
1.144 matthew 6352: $r->print('<table border=2><tr><th>'.
6353: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.301 albertel 6354:
6355: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.144 matthew 6356: $r->print('<tr><td><select name="f'.$i.'"'.
1.32 matthew 6357: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 6358: foreach my $option (@$d) {
6359: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 6360: $r->print('<option value="'.$value.'"'.
1.253 albertel 6361: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 6362: $display.'</option>');
1.31 albertel 6363: }
6364: $r->print('</select></td><td>');
1.301 albertel 6365: foreach my $line (0..2) {
6366: if (defined($samples->[$line]{$key})) {
6367: $r->print($samples->[$line]{$key}."<br />\n");
6368: }
6369: }
1.31 albertel 6370: $r->print('</td></tr>');
6371: $i++;
6372: }
6373: $i--;
6374: return($i);
1.115 matthew 6375: }
6376:
1.144 matthew 6377: ######################################################
6378: ######################################################
6379:
1.115 matthew 6380: =pod
6381:
6382: =item clean_excel_name($name)
6383:
6384: Returns a replacement for $name which does not contain any illegal characters.
6385:
6386: =cut
6387:
1.144 matthew 6388: ######################################################
6389: ######################################################
1.115 matthew 6390: sub clean_excel_name {
6391: my ($name) = @_;
6392: $name =~ s/[:\*\?\/\\]//g;
6393: if (length($name) > 31) {
6394: $name = substr($name,0,31);
6395: }
6396: return $name;
1.25 albertel 6397: }
1.84 albertel 6398:
1.85 albertel 6399: =pod
6400:
1.112 bowersj2 6401: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 6402:
6403: Returns either 1 or undef
6404:
6405: 1 if the part is to be hidden, undef if it is to be shown
6406:
6407: Arguments are:
6408:
6409: $id the id of the part to be checked
6410: $symb, optional the symb of the resource to check
6411: $udom, optional the domain of the user to check for
6412: $uname, optional the username of the user to check for
6413:
6414: =cut
1.84 albertel 6415:
6416: sub check_if_partid_hidden {
6417: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 6418: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 6419: $symb,$udom,$uname);
1.141 albertel 6420: my $truth=1;
6421: #if the string starts with !, then the list is the list to show not hide
6422: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 6423: my @hiddenlist=split(/,/,$hiddenparts);
6424: foreach my $checkid (@hiddenlist) {
1.141 albertel 6425: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 6426: }
1.141 albertel 6427: return !$truth;
1.84 albertel 6428: }
1.127 matthew 6429:
1.138 matthew 6430:
6431: ############################################################
6432: ############################################################
6433:
6434: =pod
6435:
1.157 matthew 6436: =back
6437:
1.138 matthew 6438: =head1 cgi-bin script and graphing routines
6439:
1.157 matthew 6440: =over 4
6441:
1.138 matthew 6442: =item get_cgi_id
6443:
6444: Inputs: none
6445:
6446: Returns an id which can be used to pass environment variables
6447: to various cgi-bin scripts. These environment variables will
6448: be removed from the users environment after a given time by
6449: the routine &Apache::lonnet::transfer_profile_to_env.
6450:
6451: =cut
6452:
6453: ############################################################
6454: ############################################################
1.152 albertel 6455: my $uniq=0;
1.136 matthew 6456: sub get_cgi_id {
1.154 albertel 6457: $uniq=($uniq+1)%100000;
1.280 albertel 6458: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 6459: }
6460:
1.127 matthew 6461: ############################################################
6462: ############################################################
6463:
6464: =pod
6465:
1.134 matthew 6466: =item DrawBarGraph
1.127 matthew 6467:
1.138 matthew 6468: Facilitates the plotting of data in a (stacked) bar graph.
6469: Puts plot definition data into the users environment in order for
6470: graph.png to plot it. Returns an <img> tag for the plot.
6471: The bars on the plot are labeled '1','2',...,'n'.
6472:
6473: Inputs:
6474:
6475: =over 4
6476:
6477: =item $Title: string, the title of the plot
6478:
6479: =item $xlabel: string, text describing the X-axis of the plot
6480:
6481: =item $ylabel: string, text describing the Y-axis of the plot
6482:
6483: =item $Max: scalar, the maximum Y value to use in the plot
6484: If $Max is < any data point, the graph will not be rendered.
6485:
1.140 matthew 6486: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 6487: they are plotted. If undefined, default values will be used.
6488:
1.178 matthew 6489: =item $labels: array ref holding the labels to use on the x-axis for the bars.
6490:
1.138 matthew 6491: =item @Values: An array of array references. Each array reference holds data
6492: to be plotted in a stacked bar chart.
6493:
1.239 matthew 6494: =item If the final element of @Values is a hash reference the key/value
6495: pairs will be added to the graph definition.
6496:
1.138 matthew 6497: =back
6498:
6499: Returns:
6500:
6501: An <img> tag which references graph.png and the appropriate identifying
6502: information for the plot.
6503:
1.127 matthew 6504: =cut
6505:
6506: ############################################################
6507: ############################################################
1.134 matthew 6508: sub DrawBarGraph {
1.178 matthew 6509: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 6510: #
6511: if (! defined($colors)) {
6512: $colors = ['#33ff00',
6513: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
6514: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
6515: ];
6516: }
1.228 matthew 6517: my $extra_settings = {};
6518: if (ref($Values[-1]) eq 'HASH') {
6519: $extra_settings = pop(@Values);
6520: }
1.127 matthew 6521: #
1.136 matthew 6522: my $identifier = &get_cgi_id();
6523: my $id = 'cgi.'.$identifier;
1.129 matthew 6524: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 6525: return '';
6526: }
1.225 matthew 6527: #
6528: my @Labels;
6529: if (defined($labels)) {
6530: @Labels = @$labels;
6531: } else {
6532: for (my $i=0;$i<@{$Values[0]};$i++) {
6533: push (@Labels,$i+1);
6534: }
6535: }
6536: #
1.129 matthew 6537: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 6538: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 6539: my %ValuesHash;
6540: my $NumSets=1;
6541: foreach my $array (@Values) {
6542: next if (! ref($array));
1.136 matthew 6543: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 6544: join(',',@$array);
1.129 matthew 6545: }
1.127 matthew 6546: #
1.136 matthew 6547: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 6548: if ($NumBars < 3) {
6549: $width = 120+$NumBars*32;
1.220 matthew 6550: $xskip = 1;
1.225 matthew 6551: $bar_width = 30;
6552: } elsif ($NumBars < 5) {
6553: $width = 120+$NumBars*20;
6554: $xskip = 1;
6555: $bar_width = 20;
1.220 matthew 6556: } elsif ($NumBars < 10) {
1.136 matthew 6557: $width = 120+$NumBars*15;
6558: $xskip = 1;
6559: $bar_width = 15;
6560: } elsif ($NumBars <= 25) {
6561: $width = 120+$NumBars*11;
6562: $xskip = 5;
6563: $bar_width = 8;
6564: } elsif ($NumBars <= 50) {
6565: $width = 120+$NumBars*8;
6566: $xskip = 5;
6567: $bar_width = 4;
6568: } else {
6569: $width = 120+$NumBars*8;
6570: $xskip = 5;
6571: $bar_width = 4;
6572: }
6573: #
1.137 matthew 6574: $Max = 1 if ($Max < 1);
6575: if ( int($Max) < $Max ) {
6576: $Max++;
6577: $Max = int($Max);
6578: }
1.127 matthew 6579: $Title = '' if (! defined($Title));
6580: $xlabel = '' if (! defined($xlabel));
6581: $ylabel = '' if (! defined($ylabel));
1.369 www 6582: $ValuesHash{$id.'.title'} = &escape($Title);
6583: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
6584: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 6585: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 6586: $ValuesHash{$id.'.NumBars'} = $NumBars;
6587: $ValuesHash{$id.'.NumSets'} = $NumSets;
6588: $ValuesHash{$id.'.PlotType'} = 'bar';
6589: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6590: $ValuesHash{$id.'.height'} = $height;
6591: $ValuesHash{$id.'.width'} = $width;
6592: $ValuesHash{$id.'.xskip'} = $xskip;
6593: $ValuesHash{$id.'.bar_width'} = $bar_width;
6594: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 6595: #
1.228 matthew 6596: # Deal with other parameters
6597: while (my ($key,$value) = each(%$extra_settings)) {
6598: $ValuesHash{$id.'.'.$key} = $value;
6599: }
6600: #
1.137 matthew 6601: &Apache::lonnet::appenv(%ValuesHash);
6602: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6603: }
6604:
6605: ############################################################
6606: ############################################################
6607:
6608: =pod
6609:
6610: =item DrawXYGraph
6611:
1.138 matthew 6612: Facilitates the plotting of data in an XY graph.
6613: Puts plot definition data into the users environment in order for
6614: graph.png to plot it. Returns an <img> tag for the plot.
6615:
6616: Inputs:
6617:
6618: =over 4
6619:
6620: =item $Title: string, the title of the plot
6621:
6622: =item $xlabel: string, text describing the X-axis of the plot
6623:
6624: =item $ylabel: string, text describing the Y-axis of the plot
6625:
6626: =item $Max: scalar, the maximum Y value to use in the plot
6627: If $Max is < any data point, the graph will not be rendered.
6628:
6629: =item $colors: Array ref containing the hex color codes for the data to be
6630: plotted in. If undefined, default values will be used.
6631:
6632: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
6633:
6634: =item $Ydata: Array ref containing Array refs.
1.185 www 6635: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 6636:
6637: =item %Values: hash indicating or overriding any default values which are
6638: passed to graph.png.
6639: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
6640:
6641: =back
6642:
6643: Returns:
6644:
6645: An <img> tag which references graph.png and the appropriate identifying
6646: information for the plot.
6647:
1.137 matthew 6648: =cut
6649:
6650: ############################################################
6651: ############################################################
6652: sub DrawXYGraph {
6653: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
6654: #
6655: # Create the identifier for the graph
6656: my $identifier = &get_cgi_id();
6657: my $id = 'cgi.'.$identifier;
6658: #
6659: $Title = '' if (! defined($Title));
6660: $xlabel = '' if (! defined($xlabel));
6661: $ylabel = '' if (! defined($ylabel));
6662: my %ValuesHash =
6663: (
1.369 www 6664: $id.'.title' => &escape($Title),
6665: $id.'.xlabel' => &escape($xlabel),
6666: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 6667: $id.'.y_max_value'=> $Max,
6668: $id.'.labels' => join(',',@$Xlabels),
6669: $id.'.PlotType' => 'XY',
6670: );
6671: #
6672: if (defined($colors) && ref($colors) eq 'ARRAY') {
6673: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6674: }
6675: #
6676: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
6677: return '';
6678: }
6679: my $NumSets=1;
1.138 matthew 6680: foreach my $array (@{$Ydata}){
1.137 matthew 6681: next if (! ref($array));
6682: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
6683: }
1.138 matthew 6684: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 6685: #
6686: # Deal with other parameters
6687: while (my ($key,$value) = each(%Values)) {
6688: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 6689: }
6690: #
1.136 matthew 6691: &Apache::lonnet::appenv(%ValuesHash);
6692: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
6693: }
6694:
6695: ############################################################
6696: ############################################################
6697:
6698: =pod
6699:
1.138 matthew 6700: =item DrawXYYGraph
6701:
6702: Facilitates the plotting of data in an XY graph with two Y axes.
6703: Puts plot definition data into the users environment in order for
6704: graph.png to plot it. Returns an <img> tag for the plot.
6705:
6706: Inputs:
6707:
6708: =over 4
6709:
6710: =item $Title: string, the title of the plot
6711:
6712: =item $xlabel: string, text describing the X-axis of the plot
6713:
6714: =item $ylabel: string, text describing the Y-axis of the plot
6715:
6716: =item $colors: Array ref containing the hex color codes for the data to be
6717: plotted in. If undefined, default values will be used.
6718:
6719: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
6720:
6721: =item $Ydata1: The first data set
6722:
6723: =item $Min1: The minimum value of the left Y-axis
6724:
6725: =item $Max1: The maximum value of the left Y-axis
6726:
6727: =item $Ydata2: The second data set
6728:
6729: =item $Min2: The minimum value of the right Y-axis
6730:
6731: =item $Max2: The maximum value of the left Y-axis
6732:
6733: =item %Values: hash indicating or overriding any default values which are
6734: passed to graph.png.
6735: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
6736:
6737: =back
6738:
6739: Returns:
6740:
6741: An <img> tag which references graph.png and the appropriate identifying
6742: information for the plot.
1.136 matthew 6743:
6744: =cut
6745:
6746: ############################################################
6747: ############################################################
1.137 matthew 6748: sub DrawXYYGraph {
6749: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
6750: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 6751: #
6752: # Create the identifier for the graph
6753: my $identifier = &get_cgi_id();
6754: my $id = 'cgi.'.$identifier;
6755: #
6756: $Title = '' if (! defined($Title));
6757: $xlabel = '' if (! defined($xlabel));
6758: $ylabel = '' if (! defined($ylabel));
6759: my %ValuesHash =
6760: (
1.369 www 6761: $id.'.title' => &escape($Title),
6762: $id.'.xlabel' => &escape($xlabel),
6763: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 6764: $id.'.labels' => join(',',@$Xlabels),
6765: $id.'.PlotType' => 'XY',
6766: $id.'.NumSets' => 2,
1.137 matthew 6767: $id.'.two_axes' => 1,
6768: $id.'.y1_max_value' => $Max1,
6769: $id.'.y1_min_value' => $Min1,
6770: $id.'.y2_max_value' => $Max2,
6771: $id.'.y2_min_value' => $Min2,
1.136 matthew 6772: );
6773: #
1.137 matthew 6774: if (defined($colors) && ref($colors) eq 'ARRAY') {
6775: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
6776: }
6777: #
6778: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
6779: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 6780: return '';
6781: }
6782: my $NumSets=1;
1.137 matthew 6783: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 6784: next if (! ref($array));
6785: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 6786: }
6787: #
6788: # Deal with other parameters
6789: while (my ($key,$value) = each(%Values)) {
6790: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 6791: }
6792: #
6793: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 6794: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 6795: }
6796:
6797: ############################################################
6798: ############################################################
6799:
6800: =pod
6801:
1.157 matthew 6802: =back
6803:
1.139 matthew 6804: =head1 Statistics helper routines?
6805:
6806: Bad place for them but what the hell.
6807:
1.157 matthew 6808: =over 4
6809:
1.139 matthew 6810: =item &chartlink
6811:
6812: Returns a link to the chart for a specific student.
6813:
6814: Inputs:
6815:
6816: =over 4
6817:
6818: =item $linktext: The text of the link
6819:
6820: =item $sname: The students username
6821:
6822: =item $sdomain: The students domain
6823:
6824: =back
6825:
1.157 matthew 6826: =back
6827:
1.139 matthew 6828: =cut
6829:
6830: ############################################################
6831: ############################################################
6832: sub chartlink {
6833: my ($linktext, $sname, $sdomain) = @_;
6834: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 6835: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 6836: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 6837: '">'.$linktext.'</a>';
1.153 matthew 6838: }
6839:
6840: #######################################################
6841: #######################################################
6842:
6843: =pod
6844:
6845: =head1 Course Environment Routines
1.157 matthew 6846:
6847: =over 4
1.153 matthew 6848:
6849: =item &restore_course_settings
6850:
6851: =item &store_course_settings
6852:
6853: Restores/Store indicated form parameters from the course environment.
6854: Will not overwrite existing values of the form parameters.
6855:
6856: Inputs:
6857: a scalar describing the data (e.g. 'chart', 'problem_analysis')
6858:
6859: a hash ref describing the data to be stored. For example:
6860:
6861: %Save_Parameters = ('Status' => 'scalar',
6862: 'chartoutputmode' => 'scalar',
6863: 'chartoutputdata' => 'scalar',
6864: 'Section' => 'array',
1.373 raeburn 6865: 'Group' => 'array',
1.153 matthew 6866: 'StudentData' => 'array',
6867: 'Maps' => 'array');
6868:
6869: Returns: both routines return nothing
6870:
6871: =cut
6872:
6873: #######################################################
6874: #######################################################
6875: sub store_course_settings {
1.496 albertel 6876: return &store_settings($env{'request.course.id'},@_);
6877: }
6878:
6879: sub store_settings {
1.153 matthew 6880: # save to the environment
6881: # appenv the same items, just to be safe
1.300 albertel 6882: my $udom = $env{'user.domain'};
6883: my $uname = $env{'user.name'};
1.496 albertel 6884: my ($context,$prefix,$Settings) = @_;
1.153 matthew 6885: my %SaveHash;
6886: my %AppHash;
6887: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 6888: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 6889: my $envname = 'environment.'.$basename;
1.258 albertel 6890: if (exists($env{'form.'.$setting})) {
1.153 matthew 6891: # Save this value away
6892: if ($type eq 'scalar' &&
1.258 albertel 6893: (! exists($env{$envname}) ||
6894: $env{$envname} ne $env{'form.'.$setting})) {
6895: $SaveHash{$basename} = $env{'form.'.$setting};
6896: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 6897: } elsif ($type eq 'array') {
6898: my $stored_form;
1.258 albertel 6899: if (ref($env{'form.'.$setting})) {
1.153 matthew 6900: $stored_form = join(',',
6901: map {
1.369 www 6902: &escape($_);
1.258 albertel 6903: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 6904: } else {
6905: $stored_form =
1.369 www 6906: &escape($env{'form.'.$setting});
1.153 matthew 6907: }
6908: # Determine if the array contents are the same.
1.258 albertel 6909: if ($stored_form ne $env{$envname}) {
1.153 matthew 6910: $SaveHash{$basename} = $stored_form;
6911: $AppHash{$envname} = $stored_form;
6912: }
6913: }
6914: }
6915: }
6916: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 6917: $udom,$uname);
1.153 matthew 6918: if ($put_result !~ /^(ok|delayed)/) {
6919: &Apache::lonnet::logthis('unable to save form parameters, '.
6920: 'got error:'.$put_result);
6921: }
6922: # Make sure these settings stick around in this session, too
6923: &Apache::lonnet::appenv(%AppHash);
6924: return;
6925: }
6926:
6927: sub restore_course_settings {
1.499 albertel 6928: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 6929: }
6930:
6931: sub restore_settings {
6932: my ($context,$prefix,$Settings) = @_;
1.153 matthew 6933: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 6934: next if (exists($env{'form.'.$setting}));
1.496 albertel 6935: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 6936: '.'.$setting;
1.258 albertel 6937: if (exists($env{$envname})) {
1.153 matthew 6938: if ($type eq 'scalar') {
1.258 albertel 6939: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 6940: } elsif ($type eq 'array') {
1.258 albertel 6941: $env{'form.'.$setting} = [
1.153 matthew 6942: map {
1.369 www 6943: &unescape($_);
1.258 albertel 6944: } split(',',$env{$envname})
1.153 matthew 6945: ];
6946: }
6947: }
6948: }
1.127 matthew 6949: }
6950:
6951: ############################################################
6952: ############################################################
1.154 albertel 6953:
1.443 albertel 6954: sub commit_customrole {
6955: my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
6956: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.'@'.$three.' in '.$url.
6957: ($start?', '.&mt('starting').' '.localtime($start):'').
6958: ($end?', ending '.localtime($end):'').': <b>'.
6959: &Apache::lonnet::assigncustomrole(
6960: $udom,$uname,$url,$three,$four,$five,$end,$start).
6961: '</b><br />';
6962: return $output;
6963: }
6964:
6965: sub commit_standardrole {
1.541 raeburn 6966: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
6967: my ($output,$logmsg,$linefeed);
6968: if ($context eq 'auto') {
6969: $linefeed = "\n";
6970: } else {
6971: $linefeed = "<br />\n";
6972: }
1.443 albertel 6973: if ($three eq 'st') {
1.541 raeburn 6974: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
6975: $one,$two,$sec,$context);
6976: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
6977: ($result eq 'unknown_course')) {
1.443 albertel 6978: $output = "Error: $result\n";
6979: } else {
1.541 raeburn 6980: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 6981: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 6982: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
6983: if ($context eq 'auto') {
6984: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
6985: } else {
6986: $output .= '<b>'.$result.'</b>'.$linefeed.
6987: &mt('Add to classlist').': <b>ok</b>';
6988: }
6989: $output .= $linefeed;
1.443 albertel 6990: }
6991: } else {
6992: $output = &mt('Assigning').' '.$three.' in '.$url.
6993: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 6994: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
6995: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);
6996: if ($context eq 'auto') {
6997: $output .= $result.$linefeed;
6998: } else {
6999: $output .= '<b>'.$result.'</b>'.$linefeed;
7000: }
1.443 albertel 7001: }
7002: return $output;
7003: }
7004:
7005: sub commit_studentrole {
1.541 raeburn 7006: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
7007: my ($result,$linefeed);
7008: if ($context eq 'auto') {
7009: $linefeed = "\n";
7010: } else {
7011: $linefeed = '<br />'."\n";
7012: }
1.443 albertel 7013: if (defined($one) && defined($two)) {
7014: my $cid=$one.'_'.$two;
7015: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
7016: my $secchange = 0;
7017: my $expire_role_result;
7018: my $modify_section_result;
7019: unless ($oldsec eq '-1') {
7020: unless ($sec eq $oldsec) {
7021: $secchange = 1;
7022: my $uurl='/'.$cid;
7023: $uurl=~s/\_/\//g;
7024: if ($oldsec) {
7025: $uurl.='/'.$oldsec;
7026: }
7027: $expire_role_result = &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',time);
7028: $result = $expire_role_result;
7029: }
7030: }
7031: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
7032: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
7033: if ($modify_section_result =~ /^ok/) {
7034: if ($secchange == 1) {
7035: $$logmsg .= "Section for $uname switched from old section: $oldsec to new section: $sec".$linefeed;
7036: } elsif ($oldsec eq '-1') {
7037: $$logmsg .= "New student role for $uname in section $sec in course $cid".$linefeed;
7038: } else {
7039: $$logmsg .= "Student $uname assigned to unchanged section $sec in course $cid".$linefeed;
7040: }
7041: } else {
7042: $$logmsg .= "Error when attempting section change for $uname from old section $oldsec to new section: $sec in course $cid -error: $modify_section_result".$linefeed;
7043: }
7044: $result = $modify_section_result;
7045: } elsif ($secchange == 1) {
7046: $$logmsg .= "Error when attempting to expire role for $uname in old section $oldsec in course $cid -error: $expire_role_result".$linefeed;
7047: }
7048: } else {
7049: $$logmsg .= "Incomplete course id defined. Addition of user $uname from domain $udom to course $one\_$two, section $sec not completed.$linefeed";
7050: $result = "error: incomplete course id\n";
7051: }
7052: return $result;
7053: }
7054:
7055: ############################################################
7056: ############################################################
7057:
1.566 albertel 7058: sub check_clone {
1.578 raeburn 7059: my ($args,$linefeed) = @_;
1.566 albertel 7060: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
7061: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
7062: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
7063: my $clonemsg;
7064: my $can_clone = 0;
7065:
7066: if ($clonehome eq 'no_host') {
1.578 raeburn 7067: $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 7068: } else {
7069: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 7070: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 7071: $can_clone = 1;
7072: } else {
7073: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
7074: $args->{'clonedomain'},$args->{'clonecourse'});
7075: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 7076: if (grep(/^\*$/,@cloners)) {
7077: $can_clone = 1;
7078: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
7079: $can_clone = 1;
7080: } else {
7081: my %roleshash =
7082: &Apache::lonnet::get_my_roles($args->{'ccuname'},
7083: $args->{'ccdomain'},
7084: 'userroles',['active'],['cc'],
7085: [$args->{'clonedomain'}]);
7086: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
7087: $can_clone = 1;
7088: } else {
7089: $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'});
7090: }
1.566 albertel 7091: }
1.578 raeburn 7092: }
1.566 albertel 7093: }
7094: return ($can_clone, $clonemsg, $cloneid, $clonehome);
7095: }
7096:
1.444 albertel 7097: sub construct_course {
1.541 raeburn 7098: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 7099: my $outcome;
1.541 raeburn 7100: my $linefeed = '<br />'."\n";
7101: if ($context eq 'auto') {
7102: $linefeed = "\n";
7103: }
1.566 albertel 7104:
7105: #
7106: # Are we cloning?
7107: #
7108: my ($can_clone, $clonemsg, $cloneid, $clonehome);
7109: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 7110: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 7111: if ($context ne 'auto') {
1.578 raeburn 7112: if ($clonemsg ne '') {
7113: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
7114: }
1.566 albertel 7115: }
7116: $outcome .= $clonemsg.$linefeed;
7117:
7118: if (!$can_clone) {
7119: return (0,$outcome);
7120: }
7121: }
7122:
1.444 albertel 7123: #
7124: # Open course
7125: #
7126: my $crstype = lc($args->{'crstype'});
7127: my %cenv=();
7128: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
7129: $args->{'cdescr'},
7130: $args->{'curl'},
7131: $args->{'course_home'},
7132: $args->{'nonstandard'},
7133: $args->{'crscode'},
7134: $args->{'ccuname'}.':'.
7135: $args->{'ccdomain'},
7136: $args->{'crstype'});
7137:
7138: # Note: The testing routines depend on this being output; see
7139: # Utils::Course. This needs to at least be output as a comment
7140: # if anyone ever decides to not show this, and Utils::Course::new
7141: # will need to be suitably modified.
1.541 raeburn 7142: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 7143: #
7144: # Check if created correctly
7145: #
1.479 albertel 7146: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 7147: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 7148: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 7149:
1.444 albertel 7150: #
1.566 albertel 7151: # Do the cloning
7152: #
7153: if ($can_clone && $cloneid) {
7154: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
7155: if ($context ne 'auto') {
7156: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
7157: }
7158: $outcome .= $clonemsg.$linefeed;
7159: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 7160: # Copy all files
1.566 albertel 7161: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
1.444 albertel 7162: # Restore URL
1.566 albertel 7163: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 7164: # Restore title
1.566 albertel 7165: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 7166: # restore grading mode
1.566 albertel 7167: if (defined($oldcenv{'grading'})) {
7168: $cenv{'grading'}=$oldcenv{'grading'};
7169: }
1.444 albertel 7170: # Mark as cloned
1.566 albertel 7171: $cenv{'clonedfrom'}=$cloneid;
7172: delete($cenv{'default_enrollment_start_date'});
7173: delete($cenv{'default_enrollment_end_date'});
1.444 albertel 7174: }
1.566 albertel 7175:
1.444 albertel 7176: #
7177: # Set environment (will override cloned, if existing)
7178: #
7179: my @sections = ();
7180: my @xlists = ();
7181: if ($args->{'crstype'}) {
7182: $cenv{'type'}=$args->{'crstype'};
7183: }
7184: if ($args->{'crsid'}) {
7185: $cenv{'courseid'}=$args->{'crsid'};
7186: }
7187: if ($args->{'crscode'}) {
7188: $cenv{'internal.coursecode'}=$args->{'crscode'};
7189: }
7190: if ($args->{'crsquota'} ne '') {
7191: $cenv{'internal.coursequota'}=$args->{'crsquota'};
7192: } else {
7193: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
7194: }
7195: if ($args->{'ccuname'}) {
7196: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
7197: ':'.$args->{'ccdomain'};
7198: } else {
7199: $cenv{'internal.courseowner'} = $args->{'curruser'};
7200: }
7201:
7202: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
7203: if ($args->{'crssections'}) {
7204: $cenv{'internal.sectionnums'} = '';
7205: if ($args->{'crssections'} =~ m/,/) {
7206: @sections = split/,/,$args->{'crssections'};
7207: } else {
7208: $sections[0] = $args->{'crssections'};
7209: }
7210: if (@sections > 0) {
7211: foreach my $item (@sections) {
7212: my ($sec,$gp) = split/:/,$item;
7213: my $class = $args->{'crscode'}.$sec;
7214: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
7215: $cenv{'internal.sectionnums'} .= $item.',';
7216: unless ($addcheck eq 'ok') {
7217: push @badclasses, $class;
7218: }
7219: }
7220: $cenv{'internal.sectionnums'} =~ s/,$//;
7221: }
7222: }
7223: # do not hide course coordinator from staff listing,
7224: # even if privileged
7225: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7226: # add crosslistings
7227: if ($args->{'crsxlist'}) {
7228: $cenv{'internal.crosslistings'}='';
7229: if ($args->{'crsxlist'} =~ m/,/) {
7230: @xlists = split/,/,$args->{'crsxlist'};
7231: } else {
7232: $xlists[0] = $args->{'crsxlist'};
7233: }
7234: if (@xlists > 0) {
7235: foreach my $item (@xlists) {
7236: my ($xl,$gp) = split/:/,$item;
7237: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
7238: $cenv{'internal.crosslistings'} .= $item.',';
7239: unless ($addcheck eq 'ok') {
7240: push @badclasses, $xl;
7241: }
7242: }
7243: $cenv{'internal.crosslistings'} =~ s/,$//;
7244: }
7245: }
7246: if ($args->{'autoadds'}) {
7247: $cenv{'internal.autoadds'}=$args->{'autoadds'};
7248: }
7249: if ($args->{'autodrops'}) {
7250: $cenv{'internal.autodrops'}=$args->{'autodrops'};
7251: }
7252: # check for notification of enrollment changes
7253: my @notified = ();
7254: if ($args->{'notify_owner'}) {
7255: if ($args->{'ccuname'} ne '') {
7256: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
7257: }
7258: }
7259: if ($args->{'notify_dc'}) {
7260: if ($uname ne '') {
7261: push(@notified,$uname.'@'.$udom);
7262: }
7263: }
7264: if (@notified > 0) {
7265: my $notifylist;
7266: if (@notified > 1) {
7267: $notifylist = join(',',@notified);
7268: } else {
7269: $notifylist = $notified[0];
7270: }
7271: $cenv{'internal.notifylist'} = $notifylist;
7272: }
7273: if (@badclasses > 0) {
7274: my %lt=&Apache::lonlocal::texthash(
7275: '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',
7276: 'dnhr' => 'does not have rights to access enrollment in these classes',
7277: 'adby' => 'as determined by the policies of your institution on access to official classlists'
7278: );
1.541 raeburn 7279: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
7280: ' ('.$lt{'adby'}.')';
7281: if ($context eq 'auto') {
7282: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 7283: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 7284: foreach my $item (@badclasses) {
7285: if ($context eq 'auto') {
7286: $outcome .= " - $item\n";
7287: } else {
7288: $outcome .= "<li>$item</li>\n";
7289: }
7290: }
7291: if ($context eq 'auto') {
7292: $outcome .= $linefeed;
7293: } else {
1.566 albertel 7294: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 7295: }
7296: }
1.444 albertel 7297: }
7298: if ($args->{'no_end_date'}) {
7299: $args->{'endaccess'} = 0;
7300: }
7301: $cenv{'internal.autostart'}=$args->{'enrollstart'};
7302: $cenv{'internal.autoend'}=$args->{'enrollend'};
7303: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
7304: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
7305: if ($args->{'showphotos'}) {
7306: $cenv{'internal.showphotos'}=$args->{'showphotos'};
7307: }
7308: $cenv{'internal.authtype'} = $args->{'authtype'};
7309: $cenv{'internal.autharg'} = $args->{'autharg'};
7310: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
7311: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 7312: 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');
7313: if ($context eq 'auto') {
7314: $outcome .= $krb_msg;
7315: } else {
1.566 albertel 7316: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 7317: }
7318: $outcome .= $linefeed;
1.444 albertel 7319: }
7320: }
7321: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
7322: if ($args->{'setpolicy'}) {
7323: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7324: }
7325: if ($args->{'setcontent'}) {
7326: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
7327: }
7328: }
7329: if ($args->{'reshome'}) {
7330: $cenv{'reshome'}=$args->{'reshome'}.'/';
7331: $cenv{'reshome'}=~s/\/+$/\//;
7332: }
7333: #
7334: # course has keyed access
7335: #
7336: if ($args->{'setkeys'}) {
7337: $cenv{'keyaccess'}='yes';
7338: }
7339: # if specified, key authority is not course, but user
7340: # only active if keyaccess is yes
7341: if ($args->{'keyauth'}) {
1.487 albertel 7342: my ($user,$domain) = split(':',$args->{'keyauth'});
7343: $user = &LONCAPA::clean_username($user);
7344: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 7345: if ($user ne '' && $domain ne '') {
1.487 albertel 7346: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 7347: }
7348: }
7349:
7350: if ($args->{'disresdis'}) {
7351: $cenv{'pch.roles.denied'}='st';
7352: }
7353: if ($args->{'disablechat'}) {
7354: $cenv{'plc.roles.denied'}='st';
7355: }
7356:
7357: # Record we've not yet viewed the Course Initialization Helper for this
7358: # course
7359: $cenv{'course.helper.not.run'} = 1;
7360: #
7361: # Use new Randomseed
7362: #
7363: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
7364: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
7365: #
7366: # The encryption code and receipt prefix for this course
7367: #
7368: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
7369: $cenv{'internal.encpref'}=100+int(9*rand(99));
7370: #
7371: # By default, use standard grading
7372: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
7373:
1.541 raeburn 7374: $outcome .= $linefeed.&mt('Setting environment').': '.
7375: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 7376: #
7377: # Open all assignments
7378: #
7379: if ($args->{'openall'}) {
7380: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
7381: my %storecontent = ($storeunder => time,
7382: $storeunder.'.type' => 'date_start');
7383:
7384: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 7385: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 7386: }
7387: #
7388: # Set first page
7389: #
7390: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
7391: || ($cloneid)) {
1.445 albertel 7392: use LONCAPA::map;
1.444 albertel 7393: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 7394:
7395: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
7396: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
7397:
1.444 albertel 7398: $outcome .= ($fatal?$errtext:'read ok').' - ';
7399: my $title; my $url;
7400: if ($args->{'firstres'} eq 'syl') {
7401: $title='Syllabus';
7402: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
7403: } else {
7404: $title='Navigate Contents';
7405: $url='/adm/navmaps';
7406: }
1.445 albertel 7407:
7408: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
7409: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
7410:
7411: if ($errtext) { $fatal=2; }
1.541 raeburn 7412: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 7413: }
1.566 albertel 7414:
7415: return (1,$outcome);
1.444 albertel 7416: }
7417:
7418: ############################################################
7419: ############################################################
7420:
1.378 raeburn 7421: sub course_type {
7422: my ($cid) = @_;
7423: if (!defined($cid)) {
7424: $cid = $env{'request.course.id'};
7425: }
1.404 albertel 7426: if (defined($env{'course.'.$cid.'.type'})) {
7427: return $env{'course.'.$cid.'.type'};
1.378 raeburn 7428: } else {
7429: return 'Course';
1.377 raeburn 7430: }
7431: }
1.156 albertel 7432:
1.406 raeburn 7433: sub group_term {
7434: my $crstype = &course_type();
7435: my %names = (
7436: 'Course' => 'group',
7437: 'Group' => 'team',
7438: );
7439: return $names{$crstype};
7440: }
7441:
1.156 albertel 7442: sub icon {
7443: my ($file)=@_;
1.505 albertel 7444: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 7445: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 7446: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 7447: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
7448: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
7449: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
7450: $curfext.".gif") {
7451: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
7452: $curfext.".gif";
7453: }
7454: }
1.249 albertel 7455: return &lonhttpdurl($iconname);
1.154 albertel 7456: }
1.84 albertel 7457:
1.575 albertel 7458: sub lonhttpd_port {
1.215 albertel 7459: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
7460: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
1.574 albertel 7461: # IE doesn't like a secure page getting images from a non-secure
7462: # port (when logging we haven't parsed the browser type so default
7463: # back to secure
7464: if ((!exists($env{'browser.type'}) || $env{'browser.type'} eq 'explorer')
7465: && $ENV{'SERVER_PORT'} == 443) {
1.575 albertel 7466: return 443;
7467: }
7468: return $lonhttpd_port;
7469:
7470: }
7471:
7472: sub lonhttpdurl {
7473: my ($url)=@_;
7474:
7475: my $lonhttpd_port = &lonhttpd_port();
7476: if ($lonhttpd_port == 443) {
1.574 albertel 7477: return 'https://'.$ENV{'SERVER_NAME'}.$url;
7478: }
1.215 albertel 7479: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
7480: }
7481:
1.213 albertel 7482: sub connection_aborted {
7483: my ($r)=@_;
7484: $r->print(" ");$r->rflush();
7485: my $c = $r->connection;
7486: return $c->aborted();
7487: }
7488:
1.221 foxr 7489: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 7490: # strings as 'strings'.
7491: sub escape_single {
1.221 foxr 7492: my ($input) = @_;
1.223 albertel 7493: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 7494: $input =~ s/\'/\\\'/g; # Esacpe the 's....
7495: return $input;
7496: }
1.223 albertel 7497:
1.222 foxr 7498: # Same as escape_single, but escape's "'s This
7499: # can be used for "strings"
7500: sub escape_double {
7501: my ($input) = @_;
7502: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
7503: $input =~ s/\"/\\\"/g; # Esacpe the "s....
7504: return $input;
7505: }
1.223 albertel 7506:
1.222 foxr 7507: # Escapes the last element of a full URL.
7508: sub escape_url {
7509: my ($url) = @_;
1.238 raeburn 7510: my @urlslices = split(/\//, $url,-1);
1.369 www 7511: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 7512: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 7513: }
1.462 albertel 7514:
7515: # -------------------------------------------------------- Initliaze user login
7516: sub init_user_environment {
1.463 albertel 7517: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 7518: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
7519:
7520: my $public=($username eq 'public' && $domain eq 'public');
7521:
7522: # See if old ID present, if so, remove
7523:
7524: my ($filename,$cookie,$userroles);
7525: my $now=time;
7526:
7527: if ($public) {
7528: my $max_public=100;
7529: my $oldest;
7530: my $oldest_time=0;
7531: for(my $next=1;$next<=$max_public;$next++) {
7532: if (-e $lonids."/publicuser_$next.id") {
7533: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
7534: if ($mtime<$oldest_time || !$oldest_time) {
7535: $oldest_time=$mtime;
7536: $oldest=$next;
7537: }
7538: } else {
7539: $cookie="publicuser_$next";
7540: last;
7541: }
7542: }
7543: if (!$cookie) { $cookie="publicuser_$oldest"; }
7544: } else {
1.463 albertel 7545: # if this isn't a robot, kill any existing non-robot sessions
7546: if (!$args->{'robot'}) {
7547: opendir(DIR,$lonids);
7548: while ($filename=readdir(DIR)) {
7549: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
7550: unlink($lonids.'/'.$filename);
7551: }
1.462 albertel 7552: }
1.463 albertel 7553: closedir(DIR);
1.462 albertel 7554: }
7555: # Give them a new cookie
1.463 albertel 7556: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
7557: : $now);
7558: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 7559:
7560: # Initialize roles
7561:
7562: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
7563: }
7564: # ------------------------------------ Check browser type and MathML capability
7565:
7566: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
7567: $clientunicode,$clientos) = &decode_user_agent($r);
7568:
7569: # -------------------------------------- Any accessibility options to remember?
7570: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
7571: foreach my $option ('imagesuppress','appletsuppress',
7572: 'embedsuppress','fontenhance','blackwhite') {
7573: if ($form->{$option} eq 'true') {
7574: &Apache::lonnet::put('environment',{$option => 'on'},
7575: $domain,$username);
7576: } else {
7577: &Apache::lonnet::del('environment',[$option],
7578: $domain,$username);
7579: }
7580: }
7581: }
7582: # ------------------------------------------------------------- Get environment
7583:
7584: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
7585: my ($tmp) = keys(%userenv);
7586: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
7587: # default remote control to off
7588: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
7589: } else {
7590: undef(%userenv);
7591: }
7592: if (($userenv{'interface'}) && (!$form->{'interface'})) {
7593: $form->{'interface'}=$userenv{'interface'};
7594: }
7595: $env{'environment.remote'}=$userenv{'remote'};
7596: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
7597:
7598: # --------------- Do not trust query string to be put directly into environment
7599: foreach my $option ('imagesuppress','appletsuppress',
7600: 'embedsuppress','fontenhance','blackwhite',
7601: 'interface','localpath','localres') {
7602: $form->{$option}=~s/[\n\r\=]//gs;
7603: }
7604: # --------------------------------------------------------- Write first profile
7605:
7606: {
7607: my %initial_env =
7608: ("user.name" => $username,
7609: "user.domain" => $domain,
7610: "user.home" => $authhost,
7611: "browser.type" => $clientbrowser,
7612: "browser.version" => $clientversion,
7613: "browser.mathml" => $clientmathml,
7614: "browser.unicode" => $clientunicode,
7615: "browser.os" => $clientos,
7616: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
7617: "request.course.fn" => '',
7618: "request.course.uri" => '',
7619: "request.course.sec" => '',
7620: "request.role" => 'cm',
7621: "request.role.adv" => $env{'user.adv'},
7622: "request.host" => $ENV{'REMOTE_ADDR'},);
7623:
7624: if ($form->{'localpath'}) {
7625: $initial_env{"browser.localpath"} = $form->{'localpath'};
7626: $initial_env{"browser.localres"} = $form->{'localres'};
7627: }
7628:
7629: if ($public) {
7630: $initial_env{"environment.remote"} = "off";
7631: }
7632: if ($form->{'interface'}) {
7633: $form->{'interface'}=~s/\W//gs;
7634: $initial_env{"browser.interface"} = $form->{'interface'};
7635: $env{'browser.interface'}=$form->{'interface'};
7636: foreach my $option ('imagesuppress','appletsuppress',
7637: 'embedsuppress','fontenhance','blackwhite') {
7638: if (($form->{$option} eq 'true') ||
7639: ($userenv{$option} eq 'on')) {
7640: $initial_env{"browser.$option"} = "on";
7641: }
7642: }
7643: }
7644:
7645: $env{'user.environment'} = "$lonids/$cookie.id";
7646:
7647: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
7648: &GDBM_WRCREAT(),0640)) {
7649: &_add_to_env(\%disk_env,\%initial_env);
7650: &_add_to_env(\%disk_env,\%userenv,'environment.');
7651: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 7652: if (ref($args->{'extra_env'})) {
7653: &_add_to_env(\%disk_env,$args->{'extra_env'});
7654: }
1.462 albertel 7655: untie(%disk_env);
7656: } else {
7657: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
7658: 'Could not create environment storage in lonauth: '.$!.'</font>');
7659: return 'error: '.$!;
7660: }
7661: }
7662: $env{'request.role'}='cm';
7663: $env{'request.role.adv'}=$env{'user.adv'};
7664: $env{'browser.type'}=$clientbrowser;
7665:
7666: return $cookie;
7667:
7668: }
7669:
7670: sub _add_to_env {
7671: my ($idf,$env_data,$prefix) = @_;
7672: while (my ($key,$value) = each(%$env_data)) {
7673: $idf->{$prefix.$key} = $value;
7674: $env{$prefix.$key} = $value;
7675: }
7676: }
7677:
7678:
1.41 ng 7679: =pod
7680:
7681: =back
7682:
1.112 bowersj2 7683: =cut
1.41 ng 7684:
1.112 bowersj2 7685: 1;
7686: __END__;
1.41 ng 7687:
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