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