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