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