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