Annotation of loncom/interface/loncommon.pm, revision 1.327
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.327 ! albertel 4: # $Id: loncommon.pm,v 1.326 2006/04/06 20:52:58 albertel Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.117 www 62: use Apache::lonlocal;
1.139 matthew 63: use HTML::Entities;
1.117 www 64:
1.22 www 65: my $readit;
66:
1.157 matthew 67: ##
68: ## Global Variables
69: ##
1.46 matthew 70:
1.20 www 71: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 72: my %language;
1.124 www 73: my %supported_language;
1.12 harris41 74: my %cprtag;
1.192 taceyjo1 75: my %scprtag;
1.12 harris41 76: my %fe; my %fd;
1.41 ng 77: my %category_extensions;
1.12 harris41 78:
1.63 www 79: # ---------------------------------------------- Designs
80:
81: my %designhash;
82:
1.46 matthew 83: # ---------------------------------------------- Thesaurus variables
1.144 matthew 84: #
85: # %Keywords:
86: # A hash used by &keyword to determine if a word is considered a keyword.
87: # $thesaurus_db_file
88: # Scalar containing the full path to the thesaurus database.
1.46 matthew 89:
90: my %Keywords;
91: my $thesaurus_db_file;
92:
1.144 matthew 93: #
94: # Initialize values from language.tab, copyright.tab, filetypes.tab,
95: # thesaurus.tab, and filecategories.tab.
96: #
1.18 www 97: BEGIN {
1.46 matthew 98: # Variable initialization
99: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
100: #
1.22 www 101: unless ($readit) {
1.12 harris41 102: # ------------------------------------------------------------------- languages
103: {
1.158 raeburn 104: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
105: '/language.tab';
106: if ( open(my $fh,"<$langtabfile") ) {
107: while (<$fh>) {
108: next if /^\#/;
109: chomp;
110: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_));
111: $language{$key}=$val.' - '.$enc;
112: if ($sup) {
113: $supported_language{$key}=$sup;
114: }
115: }
116: close($fh);
117: }
1.12 harris41 118: }
119: # ------------------------------------------------------------------ copyrights
120: {
1.158 raeburn 121: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
122: '/copyright.tab';
123: if ( open (my $fh,"<$copyrightfile") ) {
124: while (<$fh>) {
125: next if /^\#/;
126: chomp;
127: my ($key,$val)=(split(/\s+/,$_,2));
128: $cprtag{$key}=$val;
129: }
130: close($fh);
131: }
1.12 harris41 132: }
1.192 taceyjo1 133: # ------------------------------------------------------------------ source copyrights
134: {
135: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
136: '/source_copyright.tab';
137: if ( open (my $fh,"<$sourcecopyrightfile") ) {
138: while (<$fh>) {
139: next if /^\#/;
140: chomp;
141: my ($key,$val)=(split(/\s+/,$_,2));
142: $scprtag{$key}=$val;
143: }
144: close($fh);
145: }
146: }
1.63 www 147:
148: # -------------------------------------------------------------- domain designs
149:
150: my $filename;
151: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
152: opendir(DIR,$designdir);
153: while ($filename=readdir(DIR)) {
1.271 albertel 154: if ($filename!~/\.tab$/) { next; }
1.63 www 155: my ($domain)=($filename=~/^(\w+)\./);
1.271 albertel 156: {
157: my $designfile = $designdir.'/'.$filename;
158: if ( open (my $fh,"<$designfile") ) {
159: while (<$fh>) {
160: next if /^\#/;
161: chomp;
162: my ($key,$val)=(split(/\=/,$_));
163: if ($val) { $designhash{$domain.'.'.$key}=$val; }
164: }
165: close($fh);
166: }
167: }
1.63 www 168:
169: }
170: closedir(DIR);
171:
172:
1.15 harris41 173: # ------------------------------------------------------------- file categories
174: {
1.158 raeburn 175: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
176: '/filecategories.tab';
177: if ( open (my $fh,"<$categoryfile") ) {
178: while (<$fh>) {
179: next if /^\#/;
180: chomp;
181: my ($extension,$category)=(split(/\s+/,$_,2));
182: push @{$category_extensions{lc($category)}},$extension;
183: }
184: close($fh);
185: }
186:
1.15 harris41 187: }
1.12 harris41 188: # ------------------------------------------------------------------ file types
189: {
1.158 raeburn 190: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
191: '/filetypes.tab';
192: if ( open (my $fh,"<$typesfile") ) {
1.16 harris41 193: while (<$fh>) {
1.158 raeburn 194: next if (/^\#/);
195: chomp;
196: my ($ending,$emb,$descr)=split(/\s+/,$_,3);
197: if ($descr ne '') {
198: $fe{$ending}=lc($emb);
199: $fd{$ending}=$descr;
200: }
201: }
202: close($fh);
203: }
1.12 harris41 204: }
1.22 www 205: &Apache::lonnet::logthis(
1.46 matthew 206: "<font color=yellow>INFO: Read file types</font>");
1.22 www 207: $readit=1;
1.46 matthew 208: } # end of unless($readit)
1.32 matthew 209:
210: }
1.112 bowersj2 211:
1.42 matthew 212: ###############################################################
213: ## HTML and Javascript Helper Functions ##
214: ###############################################################
215:
216: =pod
217:
1.112 bowersj2 218: =head1 HTML and Javascript Functions
1.42 matthew 219:
1.112 bowersj2 220: =over 4
221:
222: =item * browser_and_searcher_javascript ()
223:
224: X<browsing, javascript>X<searching, javascript>Returns a string
225: containing javascript with two functions, C<openbrowser> and
226: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
227: tags.
1.42 matthew 228:
1.112 bowersj2 229: =item * openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 230:
231: inputs: formname, elementname, only, omit
232:
233: formname and elementname indicate the name of the html form and name of
234: the element that the results of the browsing selection are to be placed in.
235:
236: Specifying 'only' will restrict the browser to displaying only files
1.185 www 237: with the given extension. Can be a comma separated list.
1.42 matthew 238:
239: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 240: with the given extension. Can be a comma separated list.
1.42 matthew 241:
1.112 bowersj2 242: =item * opensearcher(formname, elementname) [javascript]
1.42 matthew 243:
244: Inputs: formname, elementname
245:
246: formname and elementname specify the name of the html form and the name
247: of the element the selection from the search results will be placed in.
248:
249: =cut
250:
251: sub browser_and_searcher_javascript {
1.199 albertel 252: my ($mode)=@_;
253: if (!defined($mode)) { $mode='edit'; }
1.170 www 254: my $resurl=&lastresurl();
1.42 matthew 255: return <<END;
1.219 albertel 256: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 257: var editbrowser = null;
1.135 albertel 258: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 259: var url = '$resurl/?';
1.42 matthew 260: if (editbrowser == null) {
261: url += 'launch=1&';
262: }
263: url += 'catalogmode=interactive&';
1.199 albertel 264: url += 'mode=$mode&';
1.42 matthew 265: url += 'form=' + formname + '&';
266: if (only != null) {
267: url += 'only=' + only + '&';
1.217 albertel 268: } else {
269: url += 'only=&';
270: }
1.42 matthew 271: if (omit != null) {
272: url += 'omit=' + omit + '&';
1.217 albertel 273: } else {
274: url += 'omit=&';
275: }
1.135 albertel 276: if (titleelement != null) {
277: url += 'titleelement=' + titleelement + '&';
1.217 albertel 278: } else {
279: url += 'titleelement=&';
280: }
1.42 matthew 281: url += 'element=' + elementname + '';
282: var title = 'Browser';
1.217 albertel 283: var options = 'scrollbars=1,resizable=1,menubar=1,location=1';
1.42 matthew 284: options += ',width=700,height=600';
285: editbrowser = open(url,title,options,'1');
286: editbrowser.focus();
287: }
288: var editsearcher;
1.135 albertel 289: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 290: var url = '/adm/searchcat?';
291: if (editsearcher == null) {
292: url += 'launch=1&';
293: }
294: url += 'catalogmode=interactive&';
1.199 albertel 295: url += 'mode=$mode&';
1.42 matthew 296: url += 'form=' + formname + '&';
1.135 albertel 297: if (titleelement != null) {
298: url += 'titleelement=' + titleelement + '&';
1.217 albertel 299: } else {
300: url += 'titleelement=&';
301: }
1.42 matthew 302: url += 'element=' + elementname + '';
303: var title = 'Search';
304: var options = 'scrollbars=1,resizable=1,menubar=0';
305: options += ',width=700,height=600';
306: editsearcher = open(url,title,options,'1');
307: editsearcher.focus();
308: }
1.219 albertel 309: // END LON-CAPA Internal -->
1.42 matthew 310: END
1.170 www 311: }
312:
313: sub lastresurl {
1.258 albertel 314: if ($env{'environment.lastresurl'}) {
315: return $env{'environment.lastresurl'}
1.170 www 316: } else {
317: return '/res';
318: }
319: }
320:
321: sub storeresurl {
322: my $resurl=&Apache::lonnet::clutter(shift);
323: unless ($resurl=~/^\/res/) { return 0; }
324: $resurl=~s/\/$//;
325: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
326: &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
327: return 1;
1.42 matthew 328: }
329:
1.74 www 330: sub studentbrowser_javascript {
1.111 www 331: unless (
1.258 albertel 332: (($env{'request.course.id'}) &&
1.302 albertel 333: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
334: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
335: '/'.$env{'request.course.sec'})
336: ))
1.258 albertel 337: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 338: ) { return ''; }
1.74 www 339: return (<<'ENDSTDBRW');
340: <script type="text/javascript" language="Javascript" >
341: var stdeditbrowser;
1.111 www 342: function openstdbrowser(formname,uname,udom,roleflag) {
1.74 www 343: var url = '/adm/pickstudent?';
344: var filter;
345: eval('filter=document.'+formname+'.'+uname+'.value;');
346: if (filter != null) {
347: if (filter != '') {
348: url += 'filter='+filter+'&';
349: }
350: }
351: url += 'form=' + formname + '&unameelement='+uname+
352: '&udomelement='+udom;
1.111 www 353: if (roleflag) { url+="&roles=1"; }
1.102 www 354: var title = 'Student_Browser';
1.74 www 355: var options = 'scrollbars=1,resizable=1,menubar=0';
356: options += ',width=700,height=600';
357: stdeditbrowser = open(url,title,options,'1');
358: stdeditbrowser.focus();
359: }
360: </script>
361: ENDSTDBRW
362: }
1.42 matthew 363:
1.74 www 364: sub selectstudent_link {
1.111 www 365: my ($form,$unameele,$udomele)=@_;
1.258 albertel 366: if ($env{'request.course.id'}) {
1.302 albertel 367: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
368: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
369: '/'.$env{'request.course.sec'})) {
1.111 www 370: return '';
371: }
372: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 373: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 374: }
1.258 albertel 375: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 376: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 377: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 378: }
379: return '';
1.91 www 380: }
381:
382: sub coursebrowser_javascript {
1.234 raeburn 383: my ($domainfilter)=@_;
1.128 albertel 384: return (<<ENDSTDBRW);
1.91 www 385: <script type="text/javascript" language="Javascript" >
386: var stdeditbrowser;
1.293 raeburn 387: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag) {
1.91 www 388: var url = '/adm/pickcourse?';
389: var filter;
390: if (filter != null) {
391: if (filter != '') {
392: url += 'filter='+filter+'&';
393: }
394: }
1.128 albertel 395: var domainfilter='$domainfilter';
396: if (domainfilter != null) {
397: if (domainfilter != '') {
398: url += 'domainfilter='+domainfilter+'&';
399: }
400: }
1.91 www 401: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 402: '&cdomelement='+udom+
403: '&cnameelement='+desc;
1.234 raeburn 404: if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
405: url += '&roleelement='+extra_element;
406: if (domainfilter == null || domainfilter == '') {
407: url += '&domainfilter='+extra_element;
408: }
1.230 raeburn 409: }
1.293 raeburn 410: if (multflag !=null && multflag != '') {
411: url += '&multiple='+multflag;
412: }
1.102 www 413: var title = 'Course_Browser';
1.91 www 414: var options = 'scrollbars=1,resizable=1,menubar=0';
415: options += ',width=700,height=600';
416: stdeditbrowser = open(url,title,options,'1');
417: stdeditbrowser.focus();
418: }
419: </script>
420: ENDSTDBRW
421: }
422:
423: sub selectcourse_link {
1.293 raeburn 424: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag)=@_;
1.91 www 425: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
1.293 raeburn 426: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'");'."'>".&mt('Select Course')."</a>";
1.74 www 427: }
1.42 matthew 428:
1.273 raeburn 429: sub check_uncheck_jscript {
430: my $jscript = <<"ENDSCRT";
431: function checkAll(field) {
432: if (field.length > 0) {
433: for (i = 0; i < field.length; i++) {
434: field[i].checked = true ;
435: }
436: } else {
437: field.checked = true
438: }
439: }
440:
441: function uncheckAll(field) {
442: if (field.length > 0) {
443: for (i = 0; i < field.length; i++) {
444: field[i].checked = false ;
445: } } else {
446: field.checked = false ;
447: }
448: }
449: ENDSCRT
450: return $jscript;
451: }
452:
453:
1.42 matthew 454: =pod
1.36 matthew 455:
1.112 bowersj2 456: =item * linked_select_forms(...)
1.36 matthew 457:
458: linked_select_forms returns a string containing a <script></script> block
459: and html for two <select> menus. The select menus will be linked in that
460: changing the value of the first menu will result in new values being placed
461: in the second menu. The values in the select menu will appear in alphabetical
462: order.
463:
464: linked_select_forms takes the following ordered inputs:
465:
466: =over 4
467:
1.112 bowersj2 468: =item * $formname, the name of the <form> tag
1.36 matthew 469:
1.112 bowersj2 470: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 471:
1.112 bowersj2 472: =item * $firstdefault, the default value for the first menu
1.36 matthew 473:
1.112 bowersj2 474: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 475:
1.112 bowersj2 476: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 477:
1.112 bowersj2 478: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 479:
1.41 ng 480: =back
481:
1.36 matthew 482: Below is an example of such a hash. Only the 'text', 'default', and
483: 'select2' keys must appear as stated. keys(%menu) are the possible
484: values for the first select menu. The text that coincides with the
1.41 ng 485: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 486: and text for the second menu are given in the hash pointed to by
487: $menu{$choice1}->{'select2'}.
488:
1.112 bowersj2 489: my %menu = ( A1 => { text =>"Choice A1" ,
490: default => "B3",
491: select2 => {
492: B1 => "Choice B1",
493: B2 => "Choice B2",
494: B3 => "Choice B3",
495: B4 => "Choice B4"
496: }
497: },
498: A2 => { text =>"Choice A2" ,
499: default => "C2",
500: select2 => {
501: C1 => "Choice C1",
502: C2 => "Choice C2",
503: C3 => "Choice C3"
504: }
505: },
506: A3 => { text =>"Choice A3" ,
507: default => "D6",
508: select2 => {
509: D1 => "Choice D1",
510: D2 => "Choice D2",
511: D3 => "Choice D3",
512: D4 => "Choice D4",
513: D5 => "Choice D5",
514: D6 => "Choice D6",
515: D7 => "Choice D7"
516: }
517: }
518: );
1.36 matthew 519:
520: =cut
521:
522: sub linked_select_forms {
523: my ($formname,
524: $middletext,
525: $firstdefault,
526: $firstselectname,
527: $secondselectname,
528: $hashref
529: ) = @_;
530: my $second = "document.$formname.$secondselectname";
531: my $first = "document.$formname.$firstselectname";
532: # output the javascript to do the changing
533: my $result = '';
1.219 albertel 534: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 535: $result.="var select2data = new Object();\n";
536: $" = '","';
537: my $debug = '';
538: foreach my $s1 (sort(keys(%$hashref))) {
539: $result.="select2data.d_$s1 = new Object();\n";
540: $result.="select2data.d_$s1.def = new String('".
541: $hashref->{$s1}->{'default'}."');\n";
542: $result.="select2data.d_$s1.values = new Array(";
543: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
544: $result.="\"@s2values\");\n";
545: $result.="select2data.d_$s1.texts = new Array(";
546: my @s2texts;
547: foreach my $value (@s2values) {
548: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
549: }
550: $result.="\"@s2texts\");\n";
551: }
552: $"=' ';
553: $result.= <<"END";
554:
555: function select1_changed() {
556: // Determine new choice
557: var newvalue = "d_" + $first.value;
558: // update select2
559: var values = select2data[newvalue].values;
560: var texts = select2data[newvalue].texts;
561: var select2def = select2data[newvalue].def;
562: var i;
563: // out with the old
564: for (i = 0; i < $second.options.length; i++) {
565: $second.options[i] = null;
566: }
567: // in with the nuclear
568: for (i=0;i<values.length; i++) {
569: $second.options[i] = new Option(values[i]);
1.143 matthew 570: $second.options[i].value = values[i];
1.36 matthew 571: $second.options[i].text = texts[i];
572: if (values[i] == select2def) {
573: $second.options[i].selected = true;
574: }
575: }
576: }
577: </script>
578: END
579: # output the initial values for the selection lists
580: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
581: foreach my $value (sort(keys(%$hashref))) {
582: $result.=" <option value=\"$value\" ";
1.253 albertel 583: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 584: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 585: }
586: $result .= "</select>\n";
587: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
588: $result .= $middletext;
589: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
590: my $seconddefault = $hashref->{$firstdefault}->{'default'};
591: foreach my $value (sort(keys(%select2))) {
592: $result.=" <option value=\"$value\" ";
1.253 albertel 593: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 594: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 595: }
596: $result .= "</select>\n";
597: # return $debug;
598: return $result;
599: } # end of sub linked_select_forms {
600:
1.45 matthew 601: =pod
1.44 bowersj2 602:
1.112 bowersj2 603: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44 bowersj2 604:
1.112 bowersj2 605: Returns a string corresponding to an HTML link to the given help
606: $topic, where $topic corresponds to the name of a .tex file in
607: /home/httpd/html/adm/help/tex, with underscores replaced by
608: spaces.
609:
610: $text will optionally be linked to the same topic, allowing you to
611: link text in addition to the graphic. If you do not want to link
612: text, but wish to specify one of the later parameters, pass an
613: empty string.
614:
615: $stayOnPage is a value that will be interpreted as a boolean. If true,
616: the link will not open a new window. If false, the link will open
617: a new window using Javascript. (Default is false.)
618:
619: $width and $height are optional numerical parameters that will
620: override the width and height of the popped up window, which may
621: be useful for certain help topics with big pictures included.
1.44 bowersj2 622:
623: =cut
624:
625: sub help_open_topic {
1.48 bowersj2 626: my ($topic, $text, $stayOnPage, $width, $height) = @_;
627: $text = "" if (not defined $text);
1.44 bowersj2 628: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 629: if ($env{'browser.interface'} eq 'textual' ||
630: $env{'environment.remote'} eq 'off' ) {
1.79 www 631: $stayOnPage=1;
632: }
1.44 bowersj2 633: $width = 350 if (not defined $width);
634: $height = 400 if (not defined $height);
635: my $filename = $topic;
636: $filename =~ s/ /_/g;
637:
1.48 bowersj2 638: my $template = "";
639: my $link;
1.159 www 640:
641: $topic=~s/\W/\_/g;
1.44 bowersj2 642:
643: if (!$stayOnPage)
644: {
1.72 bowersj2 645: $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 646: }
647: else
648: {
1.48 bowersj2 649: $link = "/adm/help/${filename}.hlp";
650: }
651:
652: # Add the text
653: if ($text ne "")
654: {
1.77 www 655: $template .=
656: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.78 www 657: "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 658: }
659:
660: # Add the graphic
1.179 matthew 661: my $title = &mt('Online Help');
1.215 albertel 662: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48 bowersj2 663: $template .= <<"ENDTEMPLATE";
1.218 albertel 664: <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 665: ENDTEMPLATE
1.78 www 666: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 667: return $template;
668:
1.106 bowersj2 669: }
670:
671: # This is a quicky function for Latex cheatsheet editing, since it
672: # appears in at least four places
673: sub helpLatexCheatsheet {
674: my $other = shift;
675: my $addOther = '';
676: if ($other) {
677: $addOther = Apache::loncommon::help_open_topic($other, shift,
678: undef, undef, 600) .
679: '</td><td>';
680: }
681: return '<table><tr><td>'.
682: $addOther .
683: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
684: undef,undef,600)
685: .'</td><td>'.
686: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
687: undef,undef,600)
688: .'</td></tr></table>';
1.172 www 689: }
690:
1.193 raeburn 691: sub help_open_menu {
692: my ($color,$topic,$component_help,$function,$faq,$bug,$stayOnPage,$width,$height,$text) = @_;
693: $text = "" if (not defined $text);
694: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 695: if ($env{'browser.interface'} eq 'textual' ||
696: $env{'environment.remote'} eq 'off' ) {
1.193 raeburn 697: $stayOnPage=1;
698: }
699: $width = 620 if (not defined $width);
700: $height = 600 if (not defined $height);
701: my $link='';
1.201 raeburn 702: my $title = &mt('Get help');
1.193 raeburn 703: my $origurl = $ENV{'REQUEST_URI'};
1.227 albertel 704: $origurl=~s|^/~|/priv/|;
1.193 raeburn 705: my $timestamp = time;
706: foreach (\$color,\$function,\$topic,\$component_help,\$faq,\$bug,\$origurl) {
707: $$_ = &Apache::lonnet::escape($$_);
708: }
1.195 albertel 709: if (!$stayOnPage) {
1.193 raeburn 710: $link = "javascript:helpMenu('open')";
1.195 albertel 711: } else {
1.193 raeburn 712: $link = "javascript:helpMenu('display')";
713: }
1.198 raeburn 714: my $banner_link = "/adm/helpmenu?page=banner&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
1.193 raeburn 715: my $details_link = "/adm/helpmenu?page=body&color=$color&function=$function&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp";
1.196 albertel 716: my $template;
717: if ($text ne "") {
718: $template .=
1.265 albertel 719: "<table bgcolor='#CC3300' cellspacing='1' cellpadding='1' border='0'><tr>".
720: "<td bgcolor='#CC6600'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.196 albertel 721: }
1.261 albertel 722: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.250 albertel 723: my $html=&Apache::lonxml::xmlbegin();
1.215 albertel 724: my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
1.196 albertel 725: $template .= <<"ENDTEMPLATE";
1.219 albertel 726: <script type="text/javascript">
1.253 albertel 727: // <!-- BEGIN LON-CAPA Internal
728: // <![CDATA[
1.243 raeburn 729: function helpMenu(target) {
730: var caller = this;
731: if (target == 'open') {
732: var newWindow = null;
733: try {
1.262 albertel 734: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 735: }
736: catch(error) {
737: writeHelp(caller);
738: return;
739: }
740: if (newWindow) {
741: caller = newWindow;
742: }
1.193 raeburn 743: }
1.243 raeburn 744: writeHelp(caller);
745: return;
746: }
747: function writeHelp(caller) {
1.264 www 748: caller.document.writeln('$html<head><title>LON-CAPA Help Menu</title><meta http-equiv="pragma" content="no-cache"></head>')
749: caller.document.writeln("<frameset rows='105,*' border='0'><frame name='bannerframe' src='$banner_link'><frame name='bodyframe' src='$details_link'></frameset>")
750: caller.document.writeln("</html>")
1.243 raeburn 751: caller.document.close()
752: caller.focus()
1.193 raeburn 753: }
1.253 albertel 754: // ]]>
1.219 albertel 755: // END LON-CAPA Internal -->
1.193 raeburn 756: </script>
1.218 albertel 757: <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help Menu)" /></a>
1.193 raeburn 758: ENDTEMPLATE
1.203 albertel 759: if ($component_help) {
760: if (!$text) {
761: $template=&help_open_topic($component_help,undef,$stayOnPage,
762: $width,$height).' '.$template;
763: } else {
764: my $help_text;
765: $help_text=&Apache::lonnet::unescape($topic);
766: $template='<table><tr><td>'.
767: &help_open_topic($component_help,$help_text,$stayOnPage,
768: $width,$height).'</td><td>'.$template.
769: '</td></tr></table>';
770: }
771: }
1.196 albertel 772: if ($text ne '') { $template.='</td></tr></table>' };
1.193 raeburn 773: return $template;
774: }
775:
1.172 www 776: sub help_open_bug {
777: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 778: unless ($env{'user.adv'}) { return ''; }
1.172 www 779: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
780: $text = "" if (not defined $text);
781: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 782: if ($env{'browser.interface'} eq 'textual' ||
783: $env{'environment.remote'} eq 'off' ) {
1.172 www 784: $stayOnPage=1;
785: }
1.184 albertel 786: $width = 600 if (not defined $width);
787: $height = 600 if (not defined $height);
1.172 www 788:
789: $topic=~s/\W+/\+/g;
790: my $link='';
791: my $template='';
792: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
793: &Apache::lonnet::escape($ENV{'REQUEST_URI'}).'&component='.$topic;
794: if (!$stayOnPage)
795: {
796: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
797: }
798: else
799: {
800: $link = $url;
801: }
802: # Add the text
803: if ($text ne "")
804: {
805: $template .=
806: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
807: "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
808: }
809:
810: # Add the graphic
1.179 matthew 811: my $title = &mt('Report a Bug');
1.215 albertel 812: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 813: $template .= <<"ENDTEMPLATE";
1.218 albertel 814: <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 815: ENDTEMPLATE
816: if ($text ne '') { $template.='</td></tr></table>' };
817: return $template;
818:
819: }
820:
821: sub help_open_faq {
822: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 823: unless ($env{'user.adv'}) { return ''; }
1.172 www 824: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
825: $text = "" if (not defined $text);
826: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 827: if ($env{'browser.interface'} eq 'textual' ||
828: $env{'environment.remote'} eq 'off' ) {
1.172 www 829: $stayOnPage=1;
830: }
831: $width = 350 if (not defined $width);
832: $height = 400 if (not defined $height);
833:
834: $topic=~s/\W+/\+/g;
835: my $link='';
836: my $template='';
837: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
838: if (!$stayOnPage)
839: {
840: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
841: }
842: else
843: {
844: $link = $url;
845: }
846:
847: # Add the text
848: if ($text ne "")
849: {
850: $template .=
1.173 www 851: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
852: "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 853: }
854:
855: # Add the graphic
1.179 matthew 856: my $title = &mt('View the FAQ');
1.215 albertel 857: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 858: $template .= <<"ENDTEMPLATE";
1.218 albertel 859: <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 860: ENDTEMPLATE
861: if ($text ne '') { $template.='</td></tr></table>' };
862: return $template;
863:
1.44 bowersj2 864: }
1.37 matthew 865:
1.180 matthew 866: ###############################################################
867: ###############################################################
868:
1.45 matthew 869: =pod
870:
1.256 matthew 871: =item * change_content_javascript():
872:
873: This and the next function allow you to create small sections of an
874: otherwise static HTML page that you can update on the fly with
875: Javascript, even in Netscape 4.
876:
877: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
878: must be written to the HTML page once. It will prove the Javascript
879: function "change(name, content)". Calling the change function with the
880: name of the section
881: you want to update, matching the name passed to C<changable_area>, and
882: the new content you want to put in there, will put the content into
883: that area.
884:
885: B<Note>: Netscape 4 only reserves enough space for the changable area
886: to contain room for the original contents. You need to "make space"
887: for whatever changes you wish to make, and be B<sure> to check your
888: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
889: it's adequate for updating a one-line status display, but little more.
890: This script will set the space to 100% width, so you only need to
891: worry about height in Netscape 4.
892:
893: Modern browsers are much less limiting, and if you can commit to the
894: user not using Netscape 4, this feature may be used freely with
895: pretty much any HTML.
896:
897: =cut
898:
899: sub change_content_javascript {
900: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 901: if ($env{'browser.type'} eq 'netscape' &&
902: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 903: return (<<NETSCAPE4);
904: function change(name, content) {
905: doc = document.layers[name+"___escape"].layers[0].document;
906: doc.open();
907: doc.write(content);
908: doc.close();
909: }
910: NETSCAPE4
911: } else {
912: # Otherwise, we need to use semi-standards-compliant code
913: # (technically, "innerHTML" isn't standard but the equivalent
914: # is really scary, and every useful browser supports it
915: return (<<DOMBASED);
916: function change(name, content) {
917: element = document.getElementById(name);
918: element.innerHTML = content;
919: }
920: DOMBASED
921: }
922: }
923:
924: =pod
925:
926: =item * changable_area($name, $origContent):
927:
928: This provides a "changable area" that can be modified on the fly via
929: the Javascript code provided in C<change_content_javascript>. $name is
930: the name you will use to reference the area later; do not repeat the
931: same name on a given HTML page more then once. $origContent is what
932: the area will originally contain, which can be left blank.
933:
934: =cut
935:
936: sub changable_area {
937: my ($name, $origContent) = @_;
938:
1.258 albertel 939: if ($env{'browser.type'} eq 'netscape' &&
940: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 941: # If this is netscape 4, we need to use the Layer tag
942: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
943: } else {
944: return "<span id='$name'>$origContent</span>";
945: }
946: }
947:
948: =pod
949:
950: =back
951:
952: =head1 Excel and CSV file utility routines
953:
954: =over 4
955:
956: =cut
957:
958: ###############################################################
959: ###############################################################
960:
961: =pod
962:
1.112 bowersj2 963: =item * csv_translate($text)
1.37 matthew 964:
1.185 www 965: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 966: format.
967:
968: =cut
969:
1.180 matthew 970: ###############################################################
971: ###############################################################
1.37 matthew 972: sub csv_translate {
973: my $text = shift;
974: $text =~ s/\"/\"\"/g;
1.209 albertel 975: $text =~ s/\n/ /g;
1.37 matthew 976: return $text;
977: }
1.180 matthew 978:
979: ###############################################################
980: ###############################################################
981:
982: =pod
983:
984: =item * define_excel_formats
985:
986: Define some commonly used Excel cell formats.
987:
988: Currently supported formats:
989:
990: =over 4
991:
992: =item header
993:
994: =item bold
995:
996: =item h1
997:
998: =item h2
999:
1000: =item h3
1001:
1.256 matthew 1002: =item h4
1003:
1004: =item i
1005:
1.180 matthew 1006: =item date
1007:
1008: =back
1009:
1010: Inputs: $workbook
1011:
1012: Returns: $format, a hash reference.
1013:
1014: =cut
1015:
1016: ###############################################################
1017: ###############################################################
1018: sub define_excel_formats {
1019: my ($workbook) = @_;
1020: my $format;
1021: $format->{'header'} = $workbook->add_format(bold => 1,
1022: bottom => 1,
1023: align => 'center');
1024: $format->{'bold'} = $workbook->add_format(bold=>1);
1025: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1026: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1027: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1028: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1029: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1030: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1031: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1032: return $format;
1033: }
1034:
1035: ###############################################################
1036: ###############################################################
1.113 bowersj2 1037:
1038: =pod
1039:
1.256 matthew 1040: =item * create_workbook
1.255 matthew 1041:
1042: Create an Excel worksheet. If it fails, output message on the
1043: request object and return undefs.
1044:
1045: Inputs: Apache request object
1046:
1047: Returns (undef) on failure,
1048: Excel worksheet object, scalar with filename, and formats
1049: from &Apache::loncommon::define_excel_formats on success
1050:
1051: =cut
1052:
1053: ###############################################################
1054: ###############################################################
1055: sub create_workbook {
1056: my ($r) = @_;
1057: #
1058: # Create the excel spreadsheet
1059: my $filename = '/prtspool/'.
1.258 albertel 1060: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1061: time.'_'.rand(1000000000).'.xls';
1062: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1063: if (! defined($workbook)) {
1064: $r->log_error("Error creating excel spreadsheet $filename: $!");
1065: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1066: "This error has been logged. ".
1067: "Please alert your LON-CAPA administrator").
1068: '</p>');
1069: return (undef);
1070: }
1071: #
1072: $workbook->set_tempdir('/home/httpd/perl/tmp');
1073: #
1074: my $format = &Apache::loncommon::define_excel_formats($workbook);
1075: return ($workbook,$filename,$format);
1076: }
1077:
1078: ###############################################################
1079: ###############################################################
1080:
1081: =pod
1082:
1.256 matthew 1083: =item * create_text_file
1.113 bowersj2 1084:
1.256 matthew 1085: Create a file to write to and eventually make available to the usre.
1086: If file creation fails, outputs an error message on the request object and
1087: return undefs.
1.113 bowersj2 1088:
1.256 matthew 1089: Inputs: Apache request object, and file suffix
1.113 bowersj2 1090:
1.256 matthew 1091: Returns (undef) on failure,
1092: Filehandle and filename on success.
1.113 bowersj2 1093:
1094: =cut
1095:
1.256 matthew 1096: ###############################################################
1097: ###############################################################
1098: sub create_text_file {
1099: my ($r,$suffix) = @_;
1100: if (! defined($suffix)) { $suffix = 'txt'; };
1101: my $fh;
1102: my $filename = '/prtspool/'.
1.258 albertel 1103: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1104: time.'_'.rand(1000000000).'.'.$suffix;
1105: $fh = Apache::File->new('>/home/httpd'.$filename);
1106: if (! defined($fh)) {
1107: $r->log_error("Couldn't open $filename for output $!");
1108: $r->print("Problems occured in creating the output file. ".
1109: "This error has been logged. ".
1110: "Please alert your LON-CAPA administrator.");
1.113 bowersj2 1111: }
1.256 matthew 1112: return ($fh,$filename)
1.113 bowersj2 1113: }
1114:
1115:
1.256 matthew 1116: =pod
1.113 bowersj2 1117:
1118: =back
1119:
1120: =cut
1.37 matthew 1121:
1122: ###############################################################
1.33 matthew 1123: ## Home server <option> list generating code ##
1124: ###############################################################
1.35 matthew 1125:
1.45 matthew 1126: =pod
1127:
1.112 bowersj2 1128: =head1 Home Server option list generating code
1129:
1130: =over 4
1131:
1132: =item * get_domains()
1.35 matthew 1133:
1134: Returns an array containing each of the domains listed in the hosts.tab
1135: file.
1136:
1137: =cut
1138:
1139: #-------------------------------------------
1.34 matthew 1140: sub get_domains {
1141: # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
1142: my @domains;
1143: my %seen;
1144: foreach (sort values(%Apache::lonnet::hostdom)) {
1.169 www 1145: push (@domains,$_) unless $seen{$_}++;
1.34 matthew 1146: }
1147: return @domains;
1148: }
1.88 www 1149:
1.169 www 1150: # ------------------------------------------
1151:
1152: sub domain_select {
1153: my ($name,$value,$multiple)=@_;
1154: my %domains=map {
1155: $_ => $_.' '.$Apache::lonnet::domaindescription{$_}
1156: } &get_domains;
1157: if ($multiple) {
1158: $domains{''}=&mt('Any domain');
1.287 albertel 1159: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1160: } else {
1161: return &select_form($name,$value,%domains);
1162: }
1163: }
1164:
1.282 albertel 1165: #-------------------------------------------
1166:
1167: =pod
1168:
1.287 albertel 1169: =item * multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1170:
1171: Returns a string containing a <select> element int multiple mode
1172:
1173:
1174: Args:
1175: $name - name of the <select> element
1176: $value - sclara or array ref of values that should already be selected
1177: $size - number of rows long the select element is
1.283 albertel 1178: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1179: (shown text should already have been &mt())
1.284 albertel 1180: $order - (optional) array ref of the order to show the elments in
1.283 albertel 1181:
1.282 albertel 1182: =cut
1183:
1184: #-------------------------------------------
1.169 www 1185: sub multiple_select_form {
1.284 albertel 1186: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1187: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1188: my $output='';
1.191 matthew 1189: if (! defined($size)) {
1190: $size = 4;
1.283 albertel 1191: if (scalar(keys(%$hash))<4) {
1192: $size = scalar(keys(%$hash));
1.191 matthew 1193: }
1194: }
1.169 www 1195: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.286 banghart 1196: my @order = ref($order) ? @$order
1.284 albertel 1197: : sort(keys(%$hash));
1198: foreach my $key (@order) {
1199: $output.='<option value="'.$key.'" ';
1200: $output.='selected="selected" ' if ($selected{$key});
1201: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1202: }
1203: $output.="</select>\n";
1204: return $output;
1205: }
1206:
1.88 www 1207: #-------------------------------------------
1208:
1209: =pod
1210:
1.112 bowersj2 1211: =item * select_form($defdom,$name,%hash)
1.88 www 1212:
1213: Returns a string containing a <select name='$name' size='1'> form to
1214: allow a user to select options from a hash option_name => displayed text.
1215: See lonrights.pm for an example invocation and use.
1216:
1217: =cut
1218:
1219: #-------------------------------------------
1220: sub select_form {
1221: my ($def,$name,%hash) = @_;
1222: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1223: my @keys;
1224: if (exists($hash{'select_form_order'})) {
1225: @keys=@{$hash{'select_form_order'}};
1226: } else {
1227: @keys=sort(keys(%hash));
1228: }
1229: foreach (@keys) {
1.88 www 1230: $selectform.="<option value=\"$_\" ".
1.253 albertel 1231: ($_ eq $def ? 'selected="selected" ' : '').
1.119 www 1232: ">".&mt($hash{$_})."</option>\n";
1.88 www 1233: }
1234: $selectform.="</select>";
1235: return $selectform;
1236: }
1237:
1.167 www 1238: sub gradeleveldescription {
1239: my $gradelevel=shift;
1240: my %gradelevels=(0 => 'Not specified',
1241: 1 => 'Grade 1',
1242: 2 => 'Grade 2',
1243: 3 => 'Grade 3',
1244: 4 => 'Grade 4',
1245: 5 => 'Grade 5',
1246: 6 => 'Grade 6',
1247: 7 => 'Grade 7',
1248: 8 => 'Grade 8',
1249: 9 => 'Grade 9',
1250: 10 => 'Grade 10',
1251: 11 => 'Grade 11',
1252: 12 => 'Grade 12',
1253: 13 => 'Grade 13',
1254: 14 => '100 Level',
1255: 15 => '200 Level',
1256: 16 => '300 Level',
1257: 17 => '400 Level',
1258: 18 => 'Graduate Level');
1259: return &mt($gradelevels{$gradelevel});
1260: }
1261:
1.163 www 1262: sub select_level_form {
1263: my ($deflevel,$name)=@_;
1264: unless ($deflevel) { $deflevel=0; }
1.167 www 1265: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1266: for (my $i=0; $i<=18; $i++) {
1267: $selectform.="<option value=\"$i\" ".
1.253 albertel 1268: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1269: ">".&gradeleveldescription($i)."</option>\n";
1270: }
1271: $selectform.="</select>";
1272: return $selectform;
1.163 www 1273: }
1.167 www 1274:
1.35 matthew 1275: #-------------------------------------------
1276:
1.45 matthew 1277: =pod
1278:
1.112 bowersj2 1279: =item * select_dom_form($defdom,$name,$includeempty)
1.35 matthew 1280:
1281: Returns a string containing a <select name='$name' size='1'> form to
1282: allow a user to select the domain to preform an operation in.
1283: See loncreateuser.pm for an example invocation and use.
1284:
1.90 www 1285: If the $includeempty flag is set, it also includes an empty choice ("no domain
1286: selected");
1287:
1.35 matthew 1288: =cut
1289:
1290: #-------------------------------------------
1.34 matthew 1291: sub select_dom_form {
1.90 www 1292: my ($defdom,$name,$includeempty) = @_;
1.34 matthew 1293: my @domains = get_domains();
1.90 www 1294: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1295: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1296: foreach (@domains) {
1297: $selectdomain.="<option value=\"$_\" ".
1.253 albertel 1298: ($_ eq $defdom ? 'selected="selected" ' : '').
1.34 matthew 1299: ">$_</option>\n";
1300: }
1301: $selectdomain.="</select>";
1302: return $selectdomain;
1303: }
1304:
1.35 matthew 1305: #-------------------------------------------
1306:
1.45 matthew 1307: =pod
1308:
1.112 bowersj2 1309: =item * get_library_servers($domain)
1.35 matthew 1310:
1311: Returns a hash which contains keys like '103l3' and values like
1312: 'kirk.lite.msu.edu'. All of the keys will be for machines in the
1313: given $domain.
1314:
1315: =cut
1316:
1317: #-------------------------------------------
1.52 matthew 1318: sub get_library_servers {
1.33 matthew 1319: my $domain = shift;
1.52 matthew 1320: my %library_servers;
1.33 matthew 1321: foreach (keys(%Apache::lonnet::libserv)) {
1322: if ($Apache::lonnet::hostdom{$_} eq $domain) {
1.52 matthew 1323: $library_servers{$_} = $Apache::lonnet::hostname{$_};
1.33 matthew 1324: }
1325: }
1.52 matthew 1326: return %library_servers;
1.33 matthew 1327: }
1328:
1.35 matthew 1329: #-------------------------------------------
1330:
1.45 matthew 1331: =pod
1332:
1.112 bowersj2 1333: =item * home_server_option_list($domain)
1.35 matthew 1334:
1335: returns a string which contains an <option> list to be used in a
1336: <select> form input. See loncreateuser.pm for an example.
1337:
1338: =cut
1339:
1340: #-------------------------------------------
1.33 matthew 1341: sub home_server_option_list {
1342: my $domain = shift;
1.52 matthew 1343: my %servers = &get_library_servers($domain);
1.33 matthew 1344: my $result = '';
1345: foreach (sort keys(%servers)) {
1346: $result.=
1347: '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";
1348: }
1349: return $result;
1350: }
1.112 bowersj2 1351:
1352: =pod
1353:
1354: =back
1355:
1356: =cut
1.87 matthew 1357:
1358: ###############################################################
1.112 bowersj2 1359: ## Decoding User Agent ##
1.87 matthew 1360: ###############################################################
1361:
1362: =pod
1363:
1.112 bowersj2 1364: =head1 Decoding the User Agent
1365:
1366: =over 4
1367:
1368: =item * &decode_user_agent()
1.87 matthew 1369:
1370: Inputs: $r
1371:
1372: Outputs:
1373:
1374: =over 4
1375:
1.112 bowersj2 1376: =item * $httpbrowser
1.87 matthew 1377:
1.112 bowersj2 1378: =item * $clientbrowser
1.87 matthew 1379:
1.112 bowersj2 1380: =item * $clientversion
1.87 matthew 1381:
1.112 bowersj2 1382: =item * $clientmathml
1.87 matthew 1383:
1.112 bowersj2 1384: =item * $clientunicode
1.87 matthew 1385:
1.112 bowersj2 1386: =item * $clientos
1.87 matthew 1387:
1388: =back
1389:
1.157 matthew 1390: =back
1391:
1.87 matthew 1392: =cut
1393:
1394: ###############################################################
1395: ###############################################################
1396: sub decode_user_agent {
1.247 albertel 1397: my ($r)=@_;
1.87 matthew 1398: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1399: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1400: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1401: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1402: my $clientbrowser='unknown';
1403: my $clientversion='0';
1404: my $clientmathml='';
1405: my $clientunicode='0';
1406: for (my $i=0;$i<=$#browsertype;$i++) {
1407: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1408: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1409: $clientbrowser=$bname;
1410: $httpbrowser=~/$vreg/i;
1411: $clientversion=$1;
1412: $clientmathml=($clientversion>=$minv);
1413: $clientunicode=($clientversion>=$univ);
1414: }
1415: }
1416: my $clientos='unknown';
1417: if (($httpbrowser=~/linux/i) ||
1418: ($httpbrowser=~/unix/i) ||
1419: ($httpbrowser=~/ux/i) ||
1420: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1421: if (($httpbrowser=~/vax/i) ||
1422: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1423: if ($httpbrowser=~/next/i) { $clientos='next'; }
1424: if (($httpbrowser=~/mac/i) ||
1425: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1426: if ($httpbrowser=~/win/i) { $clientos='win'; }
1427: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1428: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1429: $clientunicode,$clientos,);
1430: }
1431:
1.32 matthew 1432: ###############################################################
1433: ## Authentication changing form generation subroutines ##
1434: ###############################################################
1435: ##
1436: ## All of the authform_xxxxxxx subroutines take their inputs in a
1437: ## hash, and have reasonable default values.
1438: ##
1439: ## formname = the name given in the <form> tag.
1.35 matthew 1440: #-------------------------------------------
1441:
1.45 matthew 1442: =pod
1443:
1.112 bowersj2 1444: =head1 Authentication Routines
1445:
1446: =over 4
1447:
1448: =item * authform_xxxxxx
1.35 matthew 1449:
1450: The authform_xxxxxx subroutines provide javascript and html forms which
1451: handle some of the conveniences required for authentication forms.
1452: This is not an optimal method, but it works.
1453:
1454: See loncreateuser.pm for invocation and use examples.
1455:
1456: =over 4
1457:
1.112 bowersj2 1458: =item * authform_header
1.35 matthew 1459:
1.112 bowersj2 1460: =item * authform_authorwarning
1.35 matthew 1461:
1.112 bowersj2 1462: =item * authform_nochange
1.35 matthew 1463:
1.112 bowersj2 1464: =item * authform_kerberos
1.35 matthew 1465:
1.112 bowersj2 1466: =item * authform_internal
1.35 matthew 1467:
1.112 bowersj2 1468: =item * authform_filesystem
1.35 matthew 1469:
1470: =back
1471:
1.157 matthew 1472: =back
1473:
1.35 matthew 1474: =cut
1475:
1476: #-------------------------------------------
1.32 matthew 1477: sub authform_header{
1478: my %in = (
1479: formname => 'cu',
1.80 albertel 1480: kerb_def_dom => '',
1.32 matthew 1481: @_,
1482: );
1483: $in{'formname'} = 'document.' . $in{'formname'};
1484: my $result='';
1.80 albertel 1485:
1486: #---------------------------------------------- Code for upper case translation
1487: my $Javascript_toUpperCase;
1488: unless ($in{kerb_def_dom}) {
1489: $Javascript_toUpperCase =<<"END";
1490: switch (choice) {
1491: case 'krb': currentform.elements[choicearg].value =
1492: currentform.elements[choicearg].value.toUpperCase();
1493: break;
1494: default:
1495: }
1496: END
1497: } else {
1498: $Javascript_toUpperCase = "";
1499: }
1500:
1.165 raeburn 1501: my $radioval = "'nochange'";
1.174 matthew 1502: if (exists($in{'curr_authtype'}) &&
1503: defined($in{'curr_authtype'}) &&
1504: $in{'curr_authtype'} ne '') {
1505: $radioval = "'$in{'curr_authtype'}arg'";
1506: }
1.165 raeburn 1507: my $argfield = 'null';
1508: if ( grep/^mode$/,(keys %in) ) {
1509: if ($in{'mode'} eq 'modifycourse') {
1510: if ( grep/^curr_authtype$/,(keys %in) ) {
1511: $radioval = "'$in{'curr_authtype'}'";
1512: }
1513: if ( grep/^curr_autharg$/,(keys %in) ) {
1514: unless ($in{'curr_autharg'} eq '') {
1515: $argfield = "'$in{'curr_autharg'}'";
1516: }
1517: }
1518: }
1519: }
1520:
1.32 matthew 1521: $result.=<<"END";
1522: var current = new Object();
1.165 raeburn 1523: current.radiovalue = $radioval;
1524: current.argfield = $argfield;
1.32 matthew 1525:
1526: function changed_radio(choice,currentform) {
1527: var choicearg = choice + 'arg';
1528: // If a radio button in changed, we need to change the argfield
1529: if (current.radiovalue != choice) {
1530: current.radiovalue = choice;
1531: if (current.argfield != null) {
1532: currentform.elements[current.argfield].value = '';
1533: }
1534: if (choice == 'nochange') {
1535: current.argfield = null;
1536: } else {
1537: current.argfield = choicearg;
1538: switch(choice) {
1539: case 'krb':
1540: currentform.elements[current.argfield].value =
1541: "$in{'kerb_def_dom'}";
1542: break;
1543: default:
1544: break;
1545: }
1546: }
1547: }
1548: return;
1549: }
1.22 www 1550:
1.32 matthew 1551: function changed_text(choice,currentform) {
1552: var choicearg = choice + 'arg';
1553: if (currentform.elements[choicearg].value !='') {
1.80 albertel 1554: $Javascript_toUpperCase
1.32 matthew 1555: // clear old field
1556: if ((current.argfield != choicearg) && (current.argfield != null)) {
1557: currentform.elements[current.argfield].value = '';
1558: }
1559: current.argfield = choicearg;
1560: }
1561: set_auth_radio_buttons(choice,currentform);
1562: return;
1.20 www 1563: }
1.32 matthew 1564:
1565: function set_auth_radio_buttons(newvalue,currentform) {
1566: var i=0;
1567: while (i < currentform.login.length) {
1568: if (currentform.login[i].value == newvalue) { break; }
1569: i++;
1570: }
1571: if (i == currentform.login.length) {
1572: return;
1573: }
1574: current.radiovalue = newvalue;
1575: currentform.login[i].checked = true;
1576: return;
1577: }
1578: END
1579: return $result;
1580: }
1581:
1582: sub authform_authorwarning{
1583: my $result='';
1.144 matthew 1584: $result='<i>'.
1585: &mt('As a general rule, only authors or co-authors should be '.
1586: 'filesystem authenticated '.
1587: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 1588: return $result;
1589: }
1590:
1591: sub authform_nochange{
1592: my %in = (
1593: formname => 'document.cu',
1594: kerb_def_dom => 'MSU.EDU',
1595: @_,
1596: );
1.281 albertel 1597: my $result = '<label>'.&mt('[_1] Do not change login data',
1.144 matthew 1598: '<input type="radio" name="login" value="nochange" '.
1599: 'checked="checked" onclick="'.
1.281 albertel 1600: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
1601: '</label>';
1.32 matthew 1602: return $result;
1603: }
1604:
1605: sub authform_kerberos{
1606: my %in = (
1607: formname => 'document.cu',
1608: kerb_def_dom => 'MSU.EDU',
1.80 albertel 1609: kerb_def_auth => 'krb4',
1.32 matthew 1610: @_,
1611: );
1.165 raeburn 1612: my ($check4,$check5,$krbarg);
1.80 albertel 1613: if ($in{'kerb_def_auth'} eq 'krb5') {
1614: $check5 = " checked=\"on\"";
1615: } else {
1616: $check4 = " checked=\"on\"";
1617: }
1.165 raeburn 1618: $krbarg = $in{'kerb_def_dom'};
1619:
1620: my $krbcheck = "";
1621: if ( grep/^curr_authtype$/,(keys %in) ) {
1622: if ($in{'curr_authtype'} =~ m/^krb/) {
1623: $krbcheck = " checked=\"on\"";
1624: if ( grep/^curr_autharg$/,(keys %in) ) {
1625: $krbarg = $in{'curr_autharg'};
1626: }
1627: }
1628: }
1629:
1.144 matthew 1630: my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1631: my $result .= &mt
1632: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 1633: '[_3] Version 4 [_4] Version 5 [_5]',
1634: '<label><input type="radio" name="login" value="krb" '.
1.165 raeburn 1635: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.281 albertel 1636: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 1637: 'value="'.$krbarg.'" '.
1.144 matthew 1638: 'onchange="'.$jscall.'" />',
1.281 albertel 1639: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
1640: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
1641: '</label>');
1.32 matthew 1642: return $result;
1643: }
1644:
1645: sub authform_internal{
1646: my %args = (
1647: formname => 'document.cu',
1648: kerb_def_dom => 'MSU.EDU',
1649: @_,
1650: );
1.165 raeburn 1651:
1652: my $intcheck = "";
1653: my $intarg = 'value=""';
1654: if ( grep/^curr_authtype$/,(keys %args) ) {
1655: if ($args{'curr_authtype'} eq 'int') {
1656: $intcheck = " checked=\"on\"";
1657: if ( grep/^curr_autharg$/,(keys %args) ) {
1658: $intarg = "value=\"$args{'curr_autharg'}\"";
1659: }
1660: }
1661: }
1662:
1.144 matthew 1663: my $jscall = "javascript:changed_radio('int',$args{'formname'});";
1664: my $result.=&mt
1665: ('[_1] Internally authenticated (with initial password [_2])',
1.281 albertel 1666: '<label><input type="radio" name="login" value="int" '.$intcheck.
1.165 raeburn 1667: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1668: '</label><input type="text" size="10" name="intarg" '.$intarg.
1.165 raeburn 1669: ' onchange="'.$jscall.'" />');
1.32 matthew 1670: return $result;
1671: }
1672:
1673: sub authform_local{
1674: my %in = (
1675: formname => 'document.cu',
1676: kerb_def_dom => 'MSU.EDU',
1677: @_,
1678: );
1.165 raeburn 1679:
1680: my $loccheck = "";
1681: my $locarg = 'value=""';
1682: if ( grep/^curr_authtype$/,(keys %in) ) {
1683: if ($in{'curr_authtype'} eq 'loc') {
1684: $loccheck = " checked=\"on\"";
1685: if ( grep/^curr_autharg$/,(keys %in) ) {
1686: $locarg = "value=\"$in{'curr_autharg'}\"";
1687: }
1688: }
1689: }
1690:
1.144 matthew 1691: my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160 matthew 1692: my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.281 albertel 1693: '<label><input type="radio" name="login" value="loc" '.$loccheck.
1.165 raeburn 1694: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1695: '</label><input type="text" size="10" name="locarg" '.$locarg.
1.165 raeburn 1696: ' onchange="'.$jscall.'" />');
1.32 matthew 1697: return $result;
1698: }
1699:
1700: sub authform_filesystem{
1701: my %in = (
1702: formname => 'document.cu',
1703: kerb_def_dom => 'MSU.EDU',
1704: @_,
1705: );
1.144 matthew 1706: my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
1707: my $result.= &mt
1708: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 1709: '<label><input type="radio" name="login" value="fsys" '.
1.144 matthew 1710: 'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.281 albertel 1711: '</label><input type="text" size="10" name="fsysarg" value="" '.
1.144 matthew 1712: 'onchange="'.$jscall.'" />');
1.32 matthew 1713: return $result;
1714: }
1715:
1.80 albertel 1716: ###############################################################
1717: ## Get Authentication Defaults for Domain ##
1718: ###############################################################
1719:
1720: =pod
1721:
1.112 bowersj2 1722: =head1 Domains and Authentication
1723:
1724: Returns default authentication type and an associated argument as
1725: listed in file 'domain.tab'.
1726:
1727: =over 4
1728:
1729: =item * get_auth_defaults
1.80 albertel 1730:
1731: get_auth_defaults($target_domain) returns the default authentication
1732: type and an associated argument (initial password or a kerberos domain).
1733: These values are stored in lonTabs/domain.tab
1734:
1735: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
1736:
1737: If target_domain is not found in domain.tab, returns nothing ('').
1738:
1739: =cut
1740:
1741: #-------------------------------------------
1742: sub get_auth_defaults {
1743: my $domain=shift;
1744: return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
1745: }
1746: ###############################################################
1747: ## End Get Authentication Defaults for Domain ##
1748: ###############################################################
1749:
1750: ###############################################################
1751: ## Get Kerberos Defaults for Domain ##
1752: ###############################################################
1753: ##
1754: ## Returns default kerberos version and an associated argument
1755: ## as listed in file domain.tab. If not listed, provides
1756: ## appropriate default domain and kerberos version.
1757: ##
1758: #-------------------------------------------
1759:
1760: =pod
1761:
1.112 bowersj2 1762: =item * get_kerberos_defaults
1.80 albertel 1763:
1764: get_kerberos_defaults($target_domain) returns the default kerberos
1765: version and domain. If not found in domain.tabs, it defaults to
1766: version 4 and the domain of the server.
1767:
1768: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
1769:
1770: =cut
1771:
1772: #-------------------------------------------
1773: sub get_kerberos_defaults {
1774: my $domain=shift;
1775: my ($krbdef,$krbdefdom) =
1776: &Apache::loncommon::get_auth_defaults($domain);
1777: unless ($krbdef =~/^krb/ && $krbdefdom) {
1778: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
1779: my $krbdefdom=$1;
1780: $krbdefdom=~tr/a-z/A-Z/;
1781: $krbdef = "krb4";
1782: }
1783: return ($krbdef,$krbdefdom);
1784: }
1.112 bowersj2 1785:
1786: =pod
1787:
1788: =back
1789:
1790: =cut
1.32 matthew 1791:
1.46 matthew 1792: ###############################################################
1793: ## Thesaurus Functions ##
1794: ###############################################################
1.20 www 1795:
1.46 matthew 1796: =pod
1.20 www 1797:
1.112 bowersj2 1798: =head1 Thesaurus Functions
1799:
1800: =over 4
1801:
1802: =item * initialize_keywords
1.46 matthew 1803:
1804: Initializes the package variable %Keywords if it is empty. Uses the
1805: package variable $thesaurus_db_file.
1806:
1807: =cut
1808:
1809: ###################################################
1810:
1811: sub initialize_keywords {
1812: return 1 if (scalar keys(%Keywords));
1813: # If we are here, %Keywords is empty, so fill it up
1814: # Make sure the file we need exists...
1815: if (! -e $thesaurus_db_file) {
1816: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
1817: " failed because it does not exist");
1818: return 0;
1819: }
1820: # Set up the hash as a database
1821: my %thesaurus_db;
1822: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 1823: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 1824: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
1825: $thesaurus_db_file);
1826: return 0;
1827: }
1828: # Get the average number of appearances of a word.
1829: my $avecount = $thesaurus_db{'average.count'};
1830: # Put keywords (those that appear > average) into %Keywords
1831: while (my ($word,$data)=each (%thesaurus_db)) {
1832: my ($count,undef) = split /:/,$data;
1833: $Keywords{$word}++ if ($count > $avecount);
1834: }
1835: untie %thesaurus_db;
1836: # Remove special values from %Keywords.
1837: foreach ('total.count','average.count') {
1838: delete($Keywords{$_}) if (exists($Keywords{$_}));
1839: }
1840: return 1;
1841: }
1842:
1843: ###################################################
1844:
1845: =pod
1846:
1.112 bowersj2 1847: =item * keyword($word)
1.46 matthew 1848:
1849: Returns true if $word is a keyword. A keyword is a word that appears more
1850: than the average number of times in the thesaurus database. Calls
1851: &initialize_keywords
1852:
1853: =cut
1854:
1855: ###################################################
1.20 www 1856:
1857: sub keyword {
1.46 matthew 1858: return if (!&initialize_keywords());
1859: my $word=lc(shift());
1860: $word=~s/\W//g;
1861: return exists($Keywords{$word});
1.20 www 1862: }
1.46 matthew 1863:
1864: ###############################################################
1865:
1866: =pod
1.20 www 1867:
1.112 bowersj2 1868: =item * get_related_words
1.46 matthew 1869:
1.160 matthew 1870: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 1871: an array of words. If the keyword is not in the thesaurus, an empty array
1872: will be returned. The order of the words returned is determined by the
1873: database which holds them.
1874:
1875: Uses global $thesaurus_db_file.
1876:
1877: =cut
1878:
1879: ###############################################################
1880: sub get_related_words {
1881: my $keyword = shift;
1882: my %thesaurus_db;
1883: if (! -e $thesaurus_db_file) {
1884: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
1885: "failed because the file does not exist");
1886: return ();
1887: }
1888: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 1889: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 1890: return ();
1891: }
1892: my @Words=();
1893: if (exists($thesaurus_db{$keyword})) {
1894: $_ = $thesaurus_db{$keyword};
1895: (undef,@Words) = split/:/; # The first element is the number of times
1896: # the word appears. We do not need it now.
1897: for (my $i=0;$i<=$#Words;$i++) {
1898: ($Words[$i],undef)= split/\,/,$Words[$i];
1.20 www 1899: }
1900: }
1.46 matthew 1901: untie %thesaurus_db;
1902: return @Words;
1.14 harris41 1903: }
1.46 matthew 1904:
1.112 bowersj2 1905: =pod
1906:
1907: =back
1908:
1909: =cut
1.61 www 1910:
1911: # -------------------------------------------------------------- Plaintext name
1.81 albertel 1912: =pod
1913:
1.112 bowersj2 1914: =head1 User Name Functions
1915:
1916: =over 4
1917:
1.226 albertel 1918: =item * plainname($uname,$udom,$first)
1.81 albertel 1919:
1.112 bowersj2 1920: Takes a users logon name and returns it as a string in
1.226 albertel 1921: "first middle last generation" form
1922: if $first is set to 'lastname' then it returns it as
1923: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 1924:
1925: =cut
1.61 www 1926:
1.295 www 1927:
1.81 albertel 1928: ###############################################################
1.61 www 1929: sub plainname {
1.226 albertel 1930: my ($uname,$udom,$first)=@_;
1.295 www 1931: my %names=&getnames($uname,$udom);
1.226 albertel 1932: my $name=&Apache::lonnet::format_name($names{'firstname'},
1933: $names{'middlename'},
1934: $names{'lastname'},
1935: $names{'generation'},$first);
1936: $name=~s/^\s+//;
1.62 www 1937: $name=~s/\s+$//;
1938: $name=~s/\s+/ /g;
1.190 albertel 1939: if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
1.62 www 1940: return $name;
1.61 www 1941: }
1.66 www 1942:
1943: # -------------------------------------------------------------------- Nickname
1.81 albertel 1944: =pod
1945:
1.112 bowersj2 1946: =item * nickname($uname,$udom)
1.81 albertel 1947:
1948: Gets a users name and returns it as a string as
1949:
1950: ""nickname""
1.66 www 1951:
1.81 albertel 1952: if the user has a nickname or
1953:
1954: "first middle last generation"
1955:
1956: if the user does not
1957:
1958: =cut
1.66 www 1959:
1960: sub nickname {
1961: my ($uname,$udom)=@_;
1.295 www 1962: my %names=&getnames($uname,$udom);
1.68 albertel 1963: my $name=$names{'nickname'};
1.66 www 1964: if ($name) {
1965: $name='"'.$name.'"';
1966: } else {
1967: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
1968: $names{'lastname'}.' '.$names{'generation'};
1969: $name=~s/\s+$//;
1970: $name=~s/\s+/ /g;
1971: }
1972: return $name;
1973: }
1974:
1.295 www 1975: sub getnames {
1976: my ($uname,$udom)=@_;
1977: my $id=$uname.':'.$udom;
1978: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
1979: if ($cached) {
1980: return %{$names};
1981: } else {
1982: my %loadnames=&Apache::lonnet::get('environment',
1983: ['firstname','middlename','lastname','generation','nickname'],
1984: $udom,$uname);
1985: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
1986: return %loadnames;
1987: }
1988: }
1.61 www 1989:
1990: # ------------------------------------------------------------------ Screenname
1.81 albertel 1991:
1992: =pod
1993:
1.112 bowersj2 1994: =item * screenname($uname,$udom)
1.81 albertel 1995:
1996: Gets a users screenname and returns it as a string
1997:
1998: =cut
1.61 www 1999:
2000: sub screenname {
2001: my ($uname,$udom)=@_;
1.258 albertel 2002: if ($uname eq $env{'user.name'} &&
2003: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2004: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2005: return $names{'screenname'};
1.62 www 2006: }
2007:
1.212 albertel 2008:
1.62 www 2009: # ------------------------------------------------------------- Message Wrapper
2010:
2011: sub messagewrapper {
1.200 matthew 2012: my ($link,$username,$domain)=@_;
1.62 www 2013: return
1.200 matthew 2014: '<a href="/adm/email?compose=individual&'.
2015: 'recname='.$username.'&recdom='.$domain.'" '.
2016: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2017: }
2018: # --------------------------------------------------------------- Notes Wrapper
2019:
2020: sub noteswrapper {
2021: my ($link,$un,$do)=@_;
2022: return
2023: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2024: }
2025: # ------------------------------------------------------------- Aboutme Wrapper
2026:
2027: sub aboutmewrapper {
1.166 www 2028: my ($link,$username,$domain,$target)=@_;
1.205 www 2029: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.200 matthew 2030: ($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
1.62 www 2031: }
2032:
2033: # ------------------------------------------------------------ Syllabus Wrapper
2034:
2035:
2036: sub syllabuswrapper {
1.109 matthew 2037: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2038: if ($fontcolor) {
2039: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2040: }
1.208 matthew 2041: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2042: }
1.14 harris41 2043:
1.208 matthew 2044: sub track_student_link {
1.268 albertel 2045: my ($linktext,$sname,$sdom,$target,$start) = @_;
2046: my $link ="/adm/trackstudent?";
1.208 matthew 2047: my $title = 'View recent activity';
2048: if (defined($sname) && $sname !~ /^\s*$/ &&
2049: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2050: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2051: $title .= ' of this student';
1.268 albertel 2052: }
1.208 matthew 2053: if (defined($target) && $target !~ /^\s*$/) {
2054: $target = qq{target="$target"};
2055: } else {
2056: $target = '';
2057: }
1.268 albertel 2058: if ($start) { $link.='&start='.$start; }
1.208 matthew 2059: return qq{<a href="$link" title="$title" $target>$linktext</a>};
2060: }
2061:
1.112 bowersj2 2062: =pod
2063:
2064: =back
2065:
2066: =head1 Access .tab File Data
2067:
2068: =over 4
2069:
2070: =item * languageids()
2071:
2072: returns list of all language ids
2073:
2074: =cut
2075:
1.14 harris41 2076: sub languageids {
1.16 harris41 2077: return sort(keys(%language));
1.14 harris41 2078: }
2079:
1.112 bowersj2 2080: =pod
2081:
2082: =item * languagedescription()
2083:
2084: returns description of a specified language id
2085:
2086: =cut
2087:
1.14 harris41 2088: sub languagedescription {
1.125 www 2089: my $code=shift;
2090: return ($supported_language{$code}?'* ':'').
2091: $language{$code}.
1.126 www 2092: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2093: }
2094:
2095: sub plainlanguagedescription {
2096: my $code=shift;
2097: return $language{$code};
2098: }
2099:
2100: sub supportedlanguagecode {
2101: my $code=shift;
2102: return $supported_language{$code};
1.97 www 2103: }
2104:
1.112 bowersj2 2105: =pod
2106:
2107: =item * copyrightids()
2108:
2109: returns list of all copyrights
2110:
2111: =cut
2112:
2113: sub copyrightids {
2114: return sort(keys(%cprtag));
2115: }
2116:
2117: =pod
2118:
2119: =item * copyrightdescription()
2120:
2121: returns description of a specified copyright id
2122:
2123: =cut
2124:
2125: sub copyrightdescription {
1.166 www 2126: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2127: }
1.197 matthew 2128:
2129: =pod
2130:
1.192 taceyjo1 2131: =item * source_copyrightids()
2132:
2133: returns list of all source copyrights
2134:
2135: =cut
2136:
2137: sub source_copyrightids {
2138: return sort(keys(%scprtag));
2139: }
2140:
2141: =pod
2142:
2143: =item * source_copyrightdescription()
2144:
2145: returns description of a specified source copyright id
2146:
2147: =cut
2148:
2149: sub source_copyrightdescription {
2150: return &mt($scprtag{shift(@_)});
2151: }
1.112 bowersj2 2152:
2153: =pod
2154:
2155: =item * filecategories()
2156:
2157: returns list of all file categories
2158:
2159: =cut
2160:
2161: sub filecategories {
2162: return sort(keys(%category_extensions));
2163: }
2164:
2165: =pod
2166:
2167: =item * filecategorytypes()
2168:
2169: returns list of file types belonging to a given file
2170: category
2171:
2172: =cut
2173:
2174: sub filecategorytypes {
2175: return @{$category_extensions{lc($_[0])}};
2176: }
2177:
2178: =pod
2179:
2180: =item * fileembstyle()
2181:
2182: returns embedding style for a specified file type
2183:
2184: =cut
2185:
2186: sub fileembstyle {
2187: return $fe{lc(shift(@_))};
1.169 www 2188: }
2189:
2190:
2191: sub filecategoryselect {
2192: my ($name,$value)=@_;
1.189 matthew 2193: return &select_form($value,$name,
1.169 www 2194: '' => &mt('Any category'),
2195: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2196: }
2197:
2198: =pod
2199:
2200: =item * filedescription()
2201:
2202: returns description for a specified file type
2203:
2204: =cut
2205:
2206: sub filedescription {
1.188 matthew 2207: my $file_description = $fd{lc(shift())};
2208: $file_description =~ s:([\[\]]):~$1:g;
2209: return &mt($file_description);
1.112 bowersj2 2210: }
2211:
2212: =pod
2213:
2214: =item * filedescriptionex()
2215:
2216: returns description for a specified file type with
2217: extra formatting
2218:
2219: =cut
2220:
2221: sub filedescriptionex {
2222: my $ex=shift;
1.188 matthew 2223: my $file_description = $fd{lc($ex)};
2224: $file_description =~ s:([\[\]]):~$1:g;
2225: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2226: }
2227:
2228: # End of .tab access
2229: =pod
2230:
2231: =back
2232:
2233: =cut
2234:
2235: # ------------------------------------------------------------------ File Types
2236: sub fileextensions {
2237: return sort(keys(%fe));
2238: }
2239:
1.97 www 2240: # ----------------------------------------------------------- Display Languages
2241: # returns a hash with all desired display languages
2242: #
2243:
2244: sub display_languages {
2245: my %languages=();
1.118 www 2246: foreach (&preferred_languages()) {
2247: $languages{$_}=1;
1.97 www 2248: }
2249: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 2250: if ($env{'form.displaylanguage'}) {
2251: foreach (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
1.97 www 2252: $languages{$_}=1;
2253: }
2254: }
2255: return %languages;
1.14 harris41 2256: }
2257:
1.117 www 2258: sub preferred_languages {
2259: my @languages=();
1.258 albertel 2260: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117 www 2261: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258 albertel 2262: $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177 www 2263: }
1.258 albertel 2264: if ($env{'environment.languages'}) {
2265: @languages=split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'});
1.118 www 2266: }
1.162 www 2267: my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
2268: if ($browser) {
2269: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
2270: }
1.258 albertel 2271: if ($Apache::lonnet::domain_lang_def{$env{'user.domain'}}) {
1.118 www 2272: @languages=(@languages,
1.258 albertel 2273: $Apache::lonnet::domain_lang_def{$env{'user.domain'}});
1.118 www 2274: }
1.258 albertel 2275: if ($Apache::lonnet::domain_lang_def{$env{'request.role.domain'}}) {
1.118 www 2276: @languages=(@languages,
1.258 albertel 2277: $Apache::lonnet::domain_lang_def{$env{'request.role.domain'}});
1.118 www 2278: }
2279: if ($Apache::lonnet::domain_lang_def{
2280: $Apache::lonnet::perlvar{'lonDefDomain'}}) {
2281: @languages=(@languages,
2282: $Apache::lonnet::domain_lang_def{
2283: $Apache::lonnet::perlvar{'lonDefDomain'}});
2284: }
2285: # turn "en-ca" into "en-ca,en"
2286: my @genlanguages;
2287: foreach (@languages) {
2288: unless ($_=~/\w/) { next; }
2289: push (@genlanguages,$_);
2290: if ($_=~/(\-|\_)/) {
2291: push (@genlanguages,(split(/(\-|\_)/,$_))[0]);
2292: }
2293: }
2294: return @genlanguages;
1.117 www 2295: }
2296:
1.112 bowersj2 2297: ###############################################################
2298: ## Student Answer Attempts ##
2299: ###############################################################
2300:
2301: =pod
2302:
2303: =head1 Alternate Problem Views
2304:
2305: =over 4
2306:
2307: =item * get_previous_attempt($symb, $username, $domain, $course,
2308: $getattempt, $regexp, $gradesub)
2309:
2310: Return string with previous attempt on problem. Arguments:
2311:
2312: =over 4
2313:
2314: =item * $symb: Problem, including path
2315:
2316: =item * $username: username of the desired student
2317:
2318: =item * $domain: domain of the desired student
1.14 harris41 2319:
1.112 bowersj2 2320: =item * $course: Course ID
1.14 harris41 2321:
1.112 bowersj2 2322: =item * $getattempt: Leave blank for all attempts, otherwise put
2323: something
1.14 harris41 2324:
1.112 bowersj2 2325: =item * $regexp: if string matches this regexp, the string will be
2326: sent to $gradesub
1.14 harris41 2327:
1.112 bowersj2 2328: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 2329:
1.112 bowersj2 2330: =back
1.14 harris41 2331:
1.112 bowersj2 2332: The output string is a table containing all desired attempts, if any.
1.16 harris41 2333:
1.112 bowersj2 2334: =cut
1.1 albertel 2335:
2336: sub get_previous_attempt {
1.43 ng 2337: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 2338: my $prevattempts='';
1.43 ng 2339: no strict 'refs';
1.1 albertel 2340: if ($symb) {
1.3 albertel 2341: my (%returnhash)=
2342: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 2343: if ($returnhash{'version'}) {
2344: my %lasthash=();
2345: my $version;
2346: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.19 harris41 2347: foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) {
1.1 albertel 2348: $lasthash{$_}=$returnhash{$version.':'.$_};
1.19 harris41 2349: }
1.1 albertel 2350: }
1.43 ng 2351: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40 ng 2352: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.16 harris41 2353: foreach (sort(keys %lasthash)) {
1.31 albertel 2354: my ($ign,@parts) = split(/\./,$_);
1.41 ng 2355: if ($#parts > 0) {
1.31 albertel 2356: my $data=$parts[-1];
2357: pop(@parts);
1.40 ng 2358: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
1.31 albertel 2359: } else {
1.41 ng 2360: if ($#parts == 0) {
2361: $prevattempts.='<th>'.$parts[0].'</th>';
2362: } else {
2363: $prevattempts.='<th>'.$ign.'</th>';
2364: }
1.31 albertel 2365: }
1.16 harris41 2366: }
1.40 ng 2367: if ($getattempt eq '') {
2368: for ($version=1;$version<=$returnhash{'version'};$version++) {
2369: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
2370: foreach (sort(keys %lasthash)) {
2371: my $value;
2372: if ($_ =~ /timestamp/) {
2373: $value=scalar(localtime($returnhash{$version.':'.$_}));
2374: } else {
2375: $value=$returnhash{$version.':'.$_};
2376: }
1.142 albertel 2377: $prevattempts.='<td>'.&Apache::lonnet::unescape($value).' </td>';
1.40 ng 2378: }
2379: }
1.1 albertel 2380: }
1.40 ng 2381: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.16 harris41 2382: foreach (sort(keys %lasthash)) {
1.5 albertel 2383: my $value;
2384: if ($_ =~ /timestamp/) {
2385: $value=scalar(localtime($lasthash{$_}));
2386: } else {
2387: $value=$lasthash{$_};
2388: }
1.142 albertel 2389: $value=&Apache::lonnet::unescape($value);
1.49 ng 2390: if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 2391: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 2392: }
1.40 ng 2393: $prevattempts.='</tr></table></td></tr></table>';
1.1 albertel 2394: } else {
2395: $prevattempts='Nothing submitted - no attempts.';
2396: }
2397: } else {
2398: $prevattempts='No data.';
2399: }
1.10 albertel 2400: }
2401:
1.107 albertel 2402: sub relative_to_absolute {
2403: my ($url,$output)=@_;
2404: my $parser=HTML::TokeParser->new(\$output);
2405: my $token;
2406: my $thisdir=$url;
2407: my @rlinks=();
2408: while ($token=$parser->get_token) {
2409: if ($token->[0] eq 'S') {
2410: if ($token->[1] eq 'a') {
2411: if ($token->[2]->{'href'}) {
2412: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2413: }
2414: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2415: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2416: } elsif ($token->[1] eq 'base') {
2417: $thisdir=$token->[2]->{'href'};
2418: }
2419: }
2420: }
2421: $thisdir=~s-/[^/]*$--;
2422: foreach (@rlinks) {
2423: unless (($_=~/^http:\/\//i) ||
2424: ($_=~/^\//) ||
2425: ($_=~/^javascript:/i) ||
2426: ($_=~/^mailto:/i) ||
2427: ($_=~/^\#/)) {
2428: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$_);
2429: $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
2430: }
2431: }
2432: # -------------------------------------------------- Deal with Applet codebases
2433: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2434: return $output;
2435: }
2436:
1.112 bowersj2 2437: =pod
2438:
2439: =item * get_student_view
2440:
2441: show a snapshot of what student was looking at
2442:
2443: =cut
2444:
1.10 albertel 2445: sub get_student_view {
1.186 albertel 2446: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 2447: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2448: my (%form);
1.10 albertel 2449: my @elements=('symb','courseid','domain','username');
2450: foreach my $element (@elements) {
1.186 albertel 2451: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2452: }
1.186 albertel 2453: if (defined($moreenv)) {
2454: %form=(%form,%{$moreenv});
2455: }
1.236 albertel 2456: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 2457: $feedurl=&Apache::lonnet::clutter($feedurl);
1.186 albertel 2458: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 2459: $userview=~s/\<body[^\>]*\>//gi;
2460: $userview=~s/\<\/body\>//gi;
2461: $userview=~s/\<html\>//gi;
2462: $userview=~s/\<\/html\>//gi;
2463: $userview=~s/\<head\>//gi;
2464: $userview=~s/\<\/head\>//gi;
2465: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 2466: $userview=&relative_to_absolute($feedurl,$userview);
1.11 albertel 2467: return $userview;
2468: }
2469:
1.112 bowersj2 2470: =pod
2471:
2472: =item * get_student_answers()
2473:
2474: show a snapshot of how student was answering problem
2475:
2476: =cut
2477:
1.11 albertel 2478: sub get_student_answers {
1.100 sakharuk 2479: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 2480: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2481: my (%moreenv);
1.11 albertel 2482: my @elements=('symb','courseid','domain','username');
2483: foreach my $element (@elements) {
1.186 albertel 2484: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2485: }
1.186 albertel 2486: $moreenv{'grade_target'}='answer';
2487: %moreenv=(%form,%moreenv);
2488: my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
1.10 albertel 2489: return $userview;
1.1 albertel 2490: }
1.116 albertel 2491:
2492: =pod
2493:
2494: =item * &submlink()
2495:
1.242 albertel 2496: Inputs: $text $uname $udom $symb $target
1.116 albertel 2497:
2498: Returns: A link to grades.pm such as to see the SUBM view of a student
2499:
2500: =cut
2501:
2502: ###############################################
2503: sub submlink {
1.242 albertel 2504: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 2505: if (!($uname && $udom)) {
2506: (my $cursymb, my $courseid,$udom,$uname)=
2507: &Apache::lonxml::whichuser($symb);
2508: if (!$symb) { $symb=$cursymb; }
2509: }
1.254 matthew 2510: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.242 albertel 2511: $symb=&Apache::lonnet::escape($symb);
2512: if ($target) { $target="target=\"$target\""; }
2513: return '<a href="/adm/grades?&command=submission&'.
2514: 'symb='.$symb.'&student='.$uname.
2515: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2516: }
2517: ##############################################
2518:
2519: =pod
2520:
2521: =item * &pgrdlink()
2522:
2523: Inputs: $text $uname $udom $symb $target
2524:
2525: Returns: A link to grades.pm such as to see the PGRD view of a student
2526:
2527: =cut
2528:
2529: ###############################################
2530: sub pgrdlink {
2531: my $link=&submlink(@_);
2532: $link=~s/(&command=submission)/$1&showgrading=yes/;
2533: return $link;
2534: }
2535: ##############################################
2536:
2537: =pod
2538:
2539: =item * &pprmlink()
2540:
2541: Inputs: $text $uname $udom $symb $target
2542:
2543: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 2544: student and a specific resource
1.242 albertel 2545:
2546: =cut
2547:
2548: ###############################################
2549: sub pprmlink {
2550: my ($text,$uname,$udom,$symb,$target)=@_;
2551: if (!($uname && $udom)) {
2552: (my $cursymb, my $courseid,$udom,$uname)=
2553: &Apache::lonxml::whichuser($symb);
2554: if (!$symb) { $symb=$cursymb; }
2555: }
1.254 matthew 2556: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.242 albertel 2557: $symb=&Apache::lonnet::escape($symb);
2558: if ($target) { $target="target=\"$target\""; }
2559: return '<a href="/adm/parmset?&command=set&'.
2560: 'symb='.$symb.'&uname='.$uname.
2561: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 2562: }
2563: ##############################################
1.37 matthew 2564:
1.112 bowersj2 2565: =pod
2566:
2567: =back
2568:
2569: =cut
2570:
1.37 matthew 2571: ###############################################
1.51 www 2572:
2573:
2574: sub timehash {
2575: my @ltime=localtime(shift);
2576: return ( 'seconds' => $ltime[0],
2577: 'minutes' => $ltime[1],
2578: 'hours' => $ltime[2],
2579: 'day' => $ltime[3],
2580: 'month' => $ltime[4]+1,
2581: 'year' => $ltime[5]+1900,
2582: 'weekday' => $ltime[6],
2583: 'dayyear' => $ltime[7]+1,
2584: 'dlsav' => $ltime[8] );
2585: }
2586:
2587: sub maketime {
2588: my %th=@_;
2589: return POSIX::mktime(
2590: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 2591: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 2592: }
2593:
2594: #########################################
1.51 www 2595:
2596: sub findallcourses {
2597: my %courses=();
2598: my $now=time;
1.258 albertel 2599: foreach (keys %env) {
1.51 www 2600: if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
1.258 albertel 2601: my ($starttime,$endtime)=$env{$_};
1.51 www 2602: my $active=1;
2603: if ($starttime) {
2604: if ($now<$starttime) { $active=0; }
2605: }
2606: if ($endtime) {
2607: if ($now>$endtime) { $active=0; }
2608: }
2609: if ($active) { $courses{$1.'_'.$2}=1; }
2610: }
2611: }
2612: return keys %courses;
2613: }
1.37 matthew 2614:
1.54 www 2615: ###############################################
1.60 matthew 2616: ###############################################
2617:
2618: =pod
2619:
1.112 bowersj2 2620: =head1 Domain Template Functions
2621:
2622: =over 4
2623:
2624: =item * &determinedomain()
1.60 matthew 2625:
2626: Inputs: $domain (usually will be undef)
2627:
1.63 www 2628: Returns: Determines which domain should be used for designs
1.60 matthew 2629:
2630: =cut
1.54 www 2631:
1.60 matthew 2632: ###############################################
1.63 www 2633: sub determinedomain {
2634: my $domain=shift;
2635: if (! $domain) {
1.60 matthew 2636: # Determine domain if we have not been given one
2637: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 2638: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
2639: if ($env{'request.role.domain'}) {
2640: $domain=$env{'request.role.domain'};
1.60 matthew 2641: }
2642: }
1.63 www 2643: return $domain;
2644: }
2645: ###############################################
2646: =pod
2647:
1.112 bowersj2 2648: =item * &domainlogo()
1.63 www 2649:
2650: Inputs: $domain (usually will be undef)
2651:
2652: Returns: A link to a domain logo, if the domain logo exists.
2653: If the domain logo does not exist, a description of the domain.
2654:
2655: =cut
1.112 bowersj2 2656:
1.63 www 2657: ###############################################
2658: sub domainlogo {
2659: my $domain = &determinedomain(shift);
2660: # See if there is a logo
1.59 www 2661: if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
1.215 albertel 2662: my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
2663: return '<img src="'.$logo.'" alt="'.$domain.'" />';
1.60 matthew 2664: } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
2665: return $Apache::lonnet::domaindescription{$domain};
1.59 www 2666: } else {
1.60 matthew 2667: return '';
1.59 www 2668: }
2669: }
1.63 www 2670: ##############################################
2671:
2672: =pod
2673:
1.112 bowersj2 2674: =item * &designparm()
1.63 www 2675:
2676: Inputs: $which parameter; $domain (usually will be undef)
2677:
2678: Returns: value of designparamter $which
2679:
2680: =cut
1.112 bowersj2 2681:
1.63 www 2682: ##############################################
2683: sub designparm {
2684: my ($which,$domain)=@_;
1.258 albertel 2685: if ($env{'browser.blackwhite'} eq 'on') {
1.110 www 2686: if ($which=~/\.(font|alink|vlink|link)$/) {
2687: return '#000000';
2688: }
2689: if ($which=~/\.(pgbg|sidebg)$/) {
2690: return '#FFFFFF';
2691: }
2692: if ($which=~/\.tabbg$/) {
2693: return '#CCCCCC';
2694: }
2695: }
1.258 albertel 2696: if ($env{'environment.color.'.$which}) {
2697: return $env{'environment.color.'.$which};
1.96 www 2698: }
1.63 www 2699: $domain=&determinedomain($domain);
2700: if ($designhash{$domain.'.'.$which}) {
2701: return $designhash{$domain.'.'.$which};
2702: } else {
2703: return $designhash{'default.'.$which};
2704: }
2705: }
1.59 www 2706:
1.60 matthew 2707: ###############################################
2708: ###############################################
2709:
2710: =pod
2711:
1.112 bowersj2 2712: =back
2713:
2714: =head1 HTTP Helpers
2715:
2716: =over 4
2717:
2718: =item * &bodytag()
1.60 matthew 2719:
2720: Returns a uniform header for LON-CAPA web pages.
2721:
2722: Inputs:
2723:
1.112 bowersj2 2724: =over 4
2725:
2726: =item * $title, A title to be displayed on the page.
2727:
2728: =item * $function, the current role (can be undef).
2729:
2730: =item * $addentries, extra parameters for the <body> tag.
2731:
2732: =item * $bodyonly, if defined, only return the <body> tag.
2733:
2734: =item * $domain, if defined, force a given domain.
2735:
2736: =item * $forcereg, if page should register as content page (relevant for
1.86 www 2737: text interface only)
1.60 matthew 2738:
1.326 albertel 2739: =item * $customtitle, alternate text to use instead of $title
2740: in the title box that appears, this text
2741: is not auto translated like the $title is
1.309 albertel 2742:
2743: =item * $notopbar, if true, keep the 'what is this' info but remove the
2744: navigational links
1.317 albertel 2745:
2746: =item * $bgcolor, used to override the bg coor on a webpage to a specific value
2747:
1.112 bowersj2 2748: =back
2749:
1.60 matthew 2750: Returns: A uniform header for LON-CAPA web pages.
2751: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
2752: If $bodyonly is undef or zero, an html string containing a <body> tag and
2753: other decorations will be returned.
2754:
2755: =cut
2756:
1.54 www 2757: sub bodytag {
1.309 albertel 2758: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.315 albertel 2759: $notopbar,$bgcolor)=@_;
1.117 www 2760: $title=&mt($title);
1.183 matthew 2761: $function = &get_users_function() if (!$function);
1.63 www 2762: my $img=&designparm($function.'.img',$domain);
1.315 albertel 2763: my $pgbg= $bgcolor || &designparm($function.'.pgbg',$domain);
1.63 www 2764: my $tabbg=&designparm($function.'.tabbg',$domain);
2765: my $font=&designparm($function.'.font',$domain);
2766: my $link=&designparm($function.'.link',$domain);
2767: my $alink=&designparm($function.'.alink',$domain);
2768: my $vlink=&designparm($function.'.vlink',$domain);
2769: my $sidebg=&designparm($function.'.sidebg',$domain);
1.110 www 2770: # Accessibility font enhance
2771: unless ($addentries) { $addentries=''; }
1.146 www 2772: my $addstyle='';
1.258 albertel 2773: if ($env{'browser.fontenhance'} eq 'on') {
1.146 www 2774: $addstyle=' font-size: x-large;';
1.110 www 2775: }
1.63 www 2776: # role and realm
1.55 www 2777: my ($role,$realm)
1.258 albertel 2778: =&Apache::lonnet::plaintext((split(/\./,$env{'request.role'}))[0]);
1.55 www 2779: # realm
1.258 albertel 2780: if ($env{'request.course.id'}) {
1.55 www 2781: $realm=
1.258 albertel 2782: $env{'course.'.$env{'request.course.id'}.'.description'};
1.54 www 2783: }
1.55 www 2784: unless ($realm) { $realm=' '; }
2785: # Set messages
1.60 matthew 2786: my $messages=&domainlogo($domain);
1.101 www 2787: # Port for miniserver
1.83 albertel 2788: my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
2789: if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
1.101 www 2790: # construct main body tag
1.60 matthew 2791: my $bodytag = <<END;
1.231 albertel 2792: <style type="text/css">
1.147 www 2793: h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
1.146 www 2794: a:focus { color: red; background: yellow }
1.285 albertel 2795: table.thinborder { border-collapse: collapse; }
1.289 albertel 2796: table.thinborder tr th, table.thinborder tr td { border-style: solid; border-width: 1px}
2797: form, .inline { display: inline; }
1.285 albertel 2798: .center { text-align: center; }
1.304 banghart 2799: .filename {font-family: monospace;}
1.146 www 2800: </style>
1.54 www 2801: <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
1.151 www 2802: style="margin-top: 0px;$addstyle" $addentries>
1.60 matthew 2803: END
1.269 albertel 2804: &Apache::lontexconvert::jsMath_reset();
1.321 albertel 2805: if ($env{'environment.texengine'} eq 'jsMath' ||
2806: $env{'form.texengine'} eq 'jsMath' ) {
1.269 albertel 2807: $bodytag.=&Apache::lontexconvert::jsMath_header();
1.252 albertel 2808: }
2809:
1.94 www 2810: my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
1.150 matthew 2811: $lonhttpdPort.$img.'" alt="'.$function.'" />';
1.60 matthew 2812: if ($bodyonly) {
2813: return $bodytag;
1.258 albertel 2814: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 2815: # Accessibility
1.224 raeburn 2816:
1.93 www 2817: return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
2818: $forcereg).
2819: '<h1>LON-CAPA: '.$title.'</h1>';
1.258 albertel 2820: } elsif ($env{'environment.remote'} eq 'off') {
1.95 www 2821: # No Remote
1.206 albertel 2822: my $roleinfo=(<<ENDROLE);
2823: <td bgcolor="$tabbg" align="right">
2824: <font size="2" face="Arial, Helvetica, sans-serif">
1.258 albertel 2825: $env{'environment.firstname'}
2826: $env{'environment.middlename'}
2827: $env{'environment.lastname'}
2828: $env{'environment.generation'}
1.206 albertel 2829: </font>
2830: <br />
2831: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>
2832: <br />
2833: <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>
2834: </td>
2835: ENDROLE
1.224 raeburn 2836: my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.
1.229 albertel 2837: $font.'"><b>'.$title.'</b></font>';
1.224 raeburn 2838: if ($customtitle) {
2839: $titleinfo = $customtitle;
1.235 raeburn 2840: }
2841:
1.258 albertel 2842: if ($env{'request.state'} eq 'construct') {
1.229 albertel 2843: my ($uname,$thisdisfn)=
1.258 albertel 2844: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 2845: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
2846: $formaction=~s/\/+/\//g;
1.237 raeburn 2847: unless ($customtitle) { #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm
2848: my $parentpath = '';
1.241 raeburn 2849: my $lastitem = '';
2850: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
1.235 raeburn 2851: $parentpath = $1;
1.241 raeburn 2852: $lastitem = $2;
2853: } else {
2854: $lastitem = $thisdisfn;
1.235 raeburn 2855: }
2856: $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
2857: '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font> '.
2858: '<form name="dirs" method="post" action="'.$formaction
2859: .'" target="_top"><tt><b>'
1.241 raeburn 2860: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
1.235 raeburn 2861: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
2862: .'</form>'
2863: .&Apache::lonmenu::constspaceform();
1.229 albertel 2864:
1.235 raeburn 2865: }
2866: $forcereg=1;
2867: }
2868: my $titletable = '<table bgcolor="'.$pgbg.'" width="100%" border="0" '.
2869: 'cellspacing="3" cellpadding="3">'.
1.270 albertel 2870: '<tr><td bgcolor="'.$tabbg.'">'.
1.235 raeburn 2871: $titleinfo.'</td>'.$roleinfo.'</tr></table>';
1.258 albertel 2872: if ($env{'request.state'} eq 'construct') {
1.272 raeburn 2873: if ($notopbar) {
2874: $bodytag .= $titletable;
2875: } else {
2876: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg,$titletable);
2877: }
1.235 raeburn 2878: } else {
1.272 raeburn 2879: if ($notopbar) {
2880: $bodytag .= $titletable;
2881: } else {
2882: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg).
1.235 raeburn 2883: $titletable;
1.272 raeburn 2884: }
1.235 raeburn 2885: }
2886: return $bodytag;
1.94 www 2887: }
1.95 www 2888:
1.93 www 2889: #
1.95 www 2890: # Top frame rendering, Remote is up
1.93 www 2891: #
1.224 raeburn 2892: my $titleinfo = ' <font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';
2893: if ($customtitle) {
2894: $titleinfo = $customtitle;
2895: }
1.245 matthew 2896: #
2897: # Extra info if you are the DC
2898: my $dc_info = '';
1.258 albertel 2899: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
2900: $env{'course.'.$env{'request.course.id'}.
1.245 matthew 2901: '.domain'}.'/'})) {
1.258 albertel 2902: my $cid = $env{'request.course.id'};
2903: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.245 matthew 2904: $dc_info = '('.$dc_info.')';
2905: }
1.305 www 2906: # Explicit link to get inline menu
2907: my $menu='<br /><font size="2" face="Arial, Helvetica, sans-serif"> <a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a></font>';
1.245 matthew 2908: #
1.94 www 2909: return(<<ENDBODY);
1.60 matthew 2910: $bodytag
1.296 albertel 2911: <table width="100%" cellspacing="0" border="0" cellpadding="0">
1.95 www 2912: <tr><td bgcolor="$sidebg">
1.94 www 2913: $upperleft</td>
1.95 www 2914: <td bgcolor="$sidebg" align="right">$messages </td>
1.55 www 2915: </tr>
1.54 www 2916: <tr>
1.55 www 2917: <td rowspan="3" bgcolor="$tabbg">
1.305 www 2918: $titleinfo $dc_info $menu
1.257 matthew 2919: </td><td bgcolor="$tabbg" align="right">
1.146 www 2920: <font size="2" face="Arial, Helvetica, sans-serif">
1.258 albertel 2921: $env{'environment.firstname'}
2922: $env{'environment.middlename'}
2923: $env{'environment.lastname'}
2924: $env{'environment.generation'}
1.55 www 2925: </font>
1.54 www 2926: </td>
2927: </tr>
2928: <tr><td bgcolor="$tabbg" align="right">
1.146 www 2929: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>
1.54 www 2930: </td></tr>
1.55 www 2931: <tr>
1.148 www 2932: <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font> </td></tr>
1.202 albertel 2933: </table><br />
1.54 www 2934: ENDBODY
1.182 matthew 2935: }
2936:
2937: ###############################################
1.251 albertel 2938: ###############################################
2939:
2940: =pod
2941:
2942: =back
2943:
1.306 albertel 2944: =head1 HTML Helpers
1.251 albertel 2945:
2946: =over 4
2947:
2948: =item * &endbodytag()
2949:
2950: Returns a uniform footer for LON-CAPA web pages.
2951:
1.306 albertel 2952: Inputs: none
1.251 albertel 2953:
2954: =back
2955:
2956: =cut
2957:
2958: sub endbodytag {
2959: my $endbodytag='</body>';
1.269 albertel 2960: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 2961: if ( exists( $env{'internal.head.redirect'} ) ) {
2962: $endbodytag=
2963: "<br /><a href=\"$env{'internal.head.redirect'}\">".
2964: &mt('Continue').'</a>'.
2965: $endbodytag;
2966: }
1.251 albertel 2967: return $endbodytag;
2968: }
2969:
1.306 albertel 2970: =pod
2971:
2972: =over 4
2973:
2974: =item * &headtag()
2975:
2976: Returns a uniform footer for LON-CAPA web pages.
2977:
1.307 albertel 2978: Inputs: $title - optional title for the head
2979: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 2980: $args - optional arguments
1.319 albertel 2981: force_register - if is true call registerurl so the remote is
2982: informed
2983:
1.315 albertel 2984: redirect - array ref of seconds before redirect occurs
2985: url to redirect to
2986: (side effect of setting
2987: $env{'internal.head.redirect'} to the url
2988: redirected too)
1.306 albertel 2989: =back
2990:
2991: =cut
2992:
2993: sub headtag {
1.313 albertel 2994: my ($title,$head_extra,$args) = @_;
1.306 albertel 2995:
1.308 albertel 2996: my $result =
2997: '<head>'.
2998: &Apache::lonxml::fontsettings().
2999: &Apache::lonhtmlcommon::htmlareaheaders();
1.319 albertel 3000:
3001: if ($args->{'force_register'}) {
3002: $result .= &Apache::lonmenu::registerurl(1);
3003: }
3004:
1.314 albertel 3005: if (ref($args->{'redirect'})) {
3006: my ($time,$url) = @{$args->{'redirect'}};
1.315 albertel 3007: $url = &Apache::lonenc::check_encrypt($url);
3008: $env{'internal.head.redirect'} = $url;
1.313 albertel 3009: $result.=<<ADDMETA
3010: <meta http-equiv="pragma" content="no-cache" />
1.324 raeburn 3011: <meta HTTP-EQUIV="Refresh" CONTENT="$time; url=$url" />
1.313 albertel 3012: ADDMETA
3013: }
1.306 albertel 3014: if (!defined($title)) {
3015: $title = 'The LearningOnline Network with CAPA';
3016: }
3017:
1.315 albertel 3018: $result .= '<title> LON-CAPA '.&mt($title).'</title>'.$head_extra;
1.306 albertel 3019: return $result;
3020: }
3021:
3022: =pod
3023:
3024: =over 4
3025:
3026: =item * &endheadtag()
3027:
3028: Returns a uniform </head> for LON-CAPA web pages.
3029:
3030: Inputs: none
3031:
3032: =back
3033:
3034: =cut
3035:
3036: sub endheadtag {
3037: return '</head>';
3038: }
3039:
3040: =pod
3041:
3042: =over 4
3043:
3044: =item * &head()
3045:
3046: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
3047:
3048: Inputs: $title - optional title for the page
1.307 albertel 3049: $head_extra - optional extra HTML to put inside the <head>
1.306 albertel 3050: =back
3051:
3052: =cut
3053:
3054: sub head {
1.325 albertel 3055: my ($title,$head_extra,$args) = @_;
3056: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 3057: }
3058:
3059: =pod
3060:
3061: =over 4
3062:
3063: =item * &start_page()
3064:
3065: Returns a complete <html> .. <body> section for LON-CAPA web pages.
3066:
3067: Inputs: $title - optional title for the page
3068: $head_extra - optional extra HTML to incude inside the <head>
1.315 albertel 3069: $args - additional optional args supported are:
1.317 albertel 3070: only_body -> is true will set &bodytag() onlybodytag
3071: arg on
3072: no_nav_bar -> is true will set &bodytag() notopbar arg on
3073: add_entries -> additional attributes to add to the <body>
3074: domain -> force to color decorate a page for a
3075: specific domain
3076: function -> force usage of a specific rolish color
3077: scheme
3078: redirect -> see &headtag()
3079: bgcolor -> override the default page bg color
3080: js_ready -> return a string ready for being used in
3081: a javascript writeln
1.320 albertel 3082: html_encode -> return a string ready for being used in
3083: a html attribute
1.317 albertel 3084: force_register -> if is true will turn on the &bodytag()
3085: $forcereg arg
1.326 albertel 3086: body_title -> alternate text to use instead of $title
3087: in the title box that appears, this text
3088: is not auto translated like the $title is
1.306 albertel 3089:
3090: =back
3091:
3092: =cut
3093:
3094: sub start_page {
1.309 albertel 3095: my ($title,$head_extra,$args) = @_;
1.318 albertel 3096: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 3097: my %head_args;
1.319 albertel 3098: foreach my $arg ('redirect','force_register') {
3099: if (defined($args->{$arg})) {
1.324 raeburn 3100: $head_args{$arg} = $args->{$arg};
1.319 albertel 3101: }
1.313 albertel 3102: }
1.319 albertel 3103:
1.315 albertel 3104: $env{'internal.start_page'}++;
3105: my $result =
1.306 albertel 3106: &Apache::lonxml::xmlbegin().
1.313 albertel 3107: &headtag($title,$head_extra,\%head_args).&endheadtag().
1.317 albertel 3108: &bodytag($title,
3109: $args->{'function'}, $args->{'add_entries'},
3110: $args->{'only_body'}, $args->{'domain'},
1.326 albertel 3111: $args->{'force_register'}, $args->{'body_title'},
1.317 albertel 3112: $args->{'no_nav_bar'}, $args->{'bgcolor'});
1.315 albertel 3113: if ($args->{'js_ready'}) {
1.317 albertel 3114: $result = &js_ready($result);
1.315 albertel 3115: }
1.320 albertel 3116: if ($args->{'html_encode'}) {
3117: $result = &html_encode($result);
3118: }
1.315 albertel 3119: return $result;
1.306 albertel 3120: }
3121:
3122: =pod
3123:
3124: =over 4
3125:
3126: =item * &head()
3127:
3128: Returns a complete </body></html> section for LON-CAPA web pages.
3129:
1.315 albertel 3130: Inputs: $args - additional optional args supported are:
3131: js_ready -> return a string ready for being used in
3132: a javascript writeln
1.320 albertel 3133: html_encode -> return a string ready for being used in
3134: a html attribute
1.306 albertel 3135: =back
3136:
3137: =cut
3138:
3139: sub end_page {
1.315 albertel 3140: my ($args) = @_;
1.318 albertel 3141: #&Apache::lonnet::logthis("end_page ".join(':',caller(0)));
1.315 albertel 3142: $env{'internal.end_page'}++;
3143: my $result = &endbodytag()."\n</html>";
3144: if ($args->{'js_ready'}) {
1.317 albertel 3145: $result = &js_ready($result);
1.315 albertel 3146: }
1.320 albertel 3147: if ($args->{'html_encode'}) {
3148: $result = &html_encode($result);
3149: }
1.315 albertel 3150: return $result;
3151: }
3152:
1.320 albertel 3153: sub html_encode {
3154: my ($result) = @_;
3155:
1.322 albertel 3156: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 3157:
3158: return $result;
3159: }
1.317 albertel 3160: sub js_ready {
3161: my ($result) = @_;
3162:
1.323 albertel 3163: $result =~ s/[\n\r]/ /xmsg;
3164: $result =~ s/\\/\\\\/xmsg;
3165: $result =~ s/'/\\'/xmsg;
3166: $result =~ s{</script>}{</scrip'+'t>}xmsg;
1.317 albertel 3167:
3168: return $result;
3169: }
3170:
1.315 albertel 3171: sub validate_page {
3172: if ( exists($env{'internal.start_page'})
1.316 albertel 3173: && $env{'internal.start_page'} > 1) {
3174: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 3175: $env{'internal.start_page'}.' '.
1.316 albertel 3176: $ENV{'request.filename'});
1.315 albertel 3177: }
3178: if ( exists($env{'internal.end_page'})
1.316 albertel 3179: && $env{'internal.end_page'} > 1) {
3180: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 3181: $env{'internal.end_page'}.' '.
1.316 albertel 3182: $env{'request.filename'});
1.315 albertel 3183: }
3184: if ( exists($env{'internal.start_page'})
3185: && ! exists($env{'internal.end_page'})) {
1.316 albertel 3186: &Apache::lonnet::logthis('start_page called without end_page '.
3187: $env{'request.filename'});
1.315 albertel 3188: }
3189: if ( ! exists($env{'internal.start_page'})
3190: && exists($env{'internal.end_page'})) {
1.316 albertel 3191: &Apache::lonnet::logthis('end_page called without start_page'.
3192: $env{'request.filename'});
1.315 albertel 3193: }
1.306 albertel 3194: }
1.315 albertel 3195:
1.318 albertel 3196: sub simple_error_page {
3197: my ($r,$title,$msg) = @_;
3198: my $page =
3199: &Apache::loncommon::start_page($title).
3200: &mt($msg).
3201: &Apache::loncommon::end_page();
3202: if (ref($r)) {
3203: $r->print($page);
1.327 ! albertel 3204: return;
1.318 albertel 3205: }
3206: return $page;
3207: }
1.251 albertel 3208: ###############################################
1.182 matthew 3209:
3210: =pod
3211:
1.306 albertel 3212: =over 4
3213:
1.182 matthew 3214: =item get_users_function
3215:
3216: Used by &bodytag to determine the current users primary role.
3217: Returns either 'student','coordinator','admin', or 'author'.
3218:
3219: =cut
3220:
3221: ###############################################
3222: sub get_users_function {
3223: my $function = 'student';
1.258 albertel 3224: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 3225: $function='coordinator';
3226: }
1.258 albertel 3227: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 3228: $function='admin';
3229: }
1.258 albertel 3230: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 3231: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
3232: $function='author';
3233: }
3234: return $function;
1.54 www 3235: }
1.99 www 3236:
3237: ###############################################
3238:
1.233 raeburn 3239: =pod
3240:
1.274 raeburn 3241: =item check_user_status
3242:
3243: Determines current status of supplied role for a
3244: specific user. Roles can be active, previous or future.
3245:
3246: Inputs:
3247: user's domain, user's username, course's domain,
3248: course's number, optional section/group.
3249:
3250: Outputs:
3251: role status: active, previous or future.
3252:
3253: =cut
3254:
3255: sub check_user_status {
3256: my ($udom,$uname,$cdom,$crs,$role,$secgrp) = @_;
3257: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
3258: my @uroles = keys %userinfo;
3259: my $srchstr;
3260: my $active_chk = 'none';
3261: if (@uroles > 0) {
3262: if (($role eq 'cc') || ($secgrp eq '') || (!defined($secgrp))) {
3263: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
3264: } else {
3265: $srchstr = '/'.$cdom.'/'.$crs.'/'.$secgrp.'_'.$role; }
3266: if (grep/^$srchstr$/,@uroles) {
3267: my $role_end = 0;
3268: my $role_start = 0;
3269: $active_chk = 'active';
3270: if ($userinfo{$srchstr} =~ m/^($role)_(\d+)/) {
3271: $role_end = $2;
3272: if ($userinfo{$srchstr} =~ m/^($role)_($role_end)_(\d+)$/) {
3273: $role_start = $3;
3274: }
3275: }
3276: if ($role_start > 0) {
3277: if (time < $role_start) {
3278: $active_chk = 'future';
3279: }
3280: }
3281: if ($role_end > 0) {
3282: if (time > $role_end) {
3283: $active_chk = 'previous';
3284: }
3285: }
3286: }
3287: }
3288: return $active_chk;
3289: }
3290:
3291: ###############################################
3292:
3293: =pod
3294:
1.233 raeburn 3295: =item get_sections
3296:
3297: Determines all the sections for a course including
3298: sections with students and sections containing other roles.
3299: Incoming parameters: domain, course number, reference to
3300: section hash (keys to be section/group IDs), reference to
3301: array containing roles for which sections should be gathered
3302: (optional). If the fourth argument is undefined, sections
3303: are gathered for any role.
3304:
3305: Returns number of sections.
3306:
3307: =cut
3308:
3309: ###############################################
3310: sub get_sections {
3311: my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;
1.240 albertel 3312: if (!($cdom && $cnum)) { return 0; }
1.233 raeburn 3313: my $numsections = 0;
1.240 albertel 3314:
3315: if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
1.276 albertel 3316: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 3317: my $sec_index = &Apache::loncoursedata::CL_SECTION();
3318: my $status_index = &Apache::loncoursedata::CL_STATUS();
3319: while (my ($student,$data) = each %$classlist) {
3320: my ($section,$status) = ($data->[$sec_index],
3321: $data->[$status_index]);
3322: unless ($section eq '-1' || $section =~ /^\s*$/) {
3323: if (!defined($$sectioncount{$section})) { $numsections++; }
3324: $$sectioncount{$section}++;
3325: }
3326: }
3327: }
3328: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
3329: foreach my $user (sort(keys(%courseroles))) {
3330: if ($user !~ /^(\w{2})/) { next; }
3331: my ($role) = ($user =~ /^(\w{2})/);
3332: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
3333: my $section;
3334: if ($role eq 'cr' &&
3335: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
3336: $section=$1;
3337: }
3338: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
3339: if (!defined($section) || $section eq '-1') { next; }
3340: if (!defined($$sectioncount{$section})) { $numsections++; }
3341: $$sectioncount{$section}++;
1.233 raeburn 3342: }
3343: return $numsections;
3344: }
3345:
1.274 raeburn 3346: ###############################################
1.298 raeburn 3347:
3348: =pod
3349:
3350: =item coursegroups
3351:
3352: Retrieve information about groups in a course,
3353:
3354: Input:
3355: 1. Reference to hash to populate with group information.
3356: 2. Optional course domain
3357: 3. Optional course number
3358: 4. Optional group name
3359:
3360: Course domain and number will be taken from user's
3361: environment if not supplied. Optional group name will'
3362: be passed to lonnet::get_coursegroups() as a regexp to
3363: use in the call to the dump function.
3364:
3365: Output
3366: Returns number of groups in the course (subject to the
3367: optional group name filter).
3368:
3369: Side effects:
3370: Populates the referenced curr_groups hash, with key,
3371: value pairs. Keys are group names, corresponding values
3372: are scalars containing group information in XML. This
3373: can be sent to &get_group_settings() to be parsed.
3374:
3375: =cut
3376:
3377: ###############################################
3378:
3379: sub coursegroups {
3380: my ($curr_groups,$cdom,$cnum,$group) = @_;
3381: my $numgroups;
3382: if (!defined($cdom) || !defined($cnum)) {
3383: my $cid = $env{'request.course.id'};
3384: $cdom = $env{'course.'.$cid.'.domain'};
3385: $cnum = $env{'course.'.$cid.'.num'};
3386: }
3387: %{$curr_groups} = &Apache::lonnet::get_coursegroups($cdom,$cnum,$group);
3388: my ($tmp) = keys(%{$curr_groups});
3389: if ($tmp=~/^error:/) {
3390: unless ($tmp eq 'error: 2 tie(GDBM) Failed while attempting dump') {
3391: &logthis('Error retrieving groups: '.$tmp.' in '.$cnum.':'.
3392: $cdom);
3393: }
3394: $numgroups = 0;
3395: } else {
3396: $numgroups = keys(%{$curr_groups});
3397: }
3398: return $numgroups;
3399: }
3400:
3401: ###############################################
1.274 raeburn 3402:
1.275 raeburn 3403: =pod
1.294 raeburn 3404:
3405: =item get_group_settings
3406:
3407: Uses TokeParser to extract group information from the
3408: XML used to describe course groups.
3409:
3410: Input:
1.298 raeburn 3411: Scalar containing XML - as retrieved from &coursegroups().
1.294 raeburn 3412:
3413: Output:
3414: Hash containing group information as key=values for (a), and
3415: hash of hashes for (b)
3416:
3417: Keys (in two categories):
3418: (a) groupname, creator, creation, modified, startdate,enddate.
3419: Corresponding values are name of the group, creator of the group
3420: (username:domain), UNIX time for date group was created, and
3421: settings were last modified, and default start and end access
3422: times for group members.
3423:
3424: (b) functions returned in hash of hashes.
3425: Outer hash key is functions.
3426: Inner hash keys are chat,discussion,email,files,homepage,roster.
3427: Corresponding values are either on or off, depending on
1.303 raeburn 3428: whether this type of functionality is available for the group.
1.294 raeburn 3429:
3430: =cut
3431:
3432: ###############################################
3433:
3434: sub get_group_settings {
3435: my ($groupinfo)=@_;
3436: my $parser=HTML::TokeParser->new(\$groupinfo);
3437: my $token;
3438: my $tool = '';
1.303 raeburn 3439: my $role = '';
1.294 raeburn 3440: my %content=();
3441: while ($token=$parser->get_token) {
3442: if ($token->[0] eq 'S') {
3443: my $entry=$token->[1];
1.303 raeburn 3444: if ($entry eq 'functions' || $entry eq 'autosec') {
1.294 raeburn 3445: %{$content{$entry}} = ();
3446: $tool = $entry;
1.303 raeburn 3447: } elsif ($entry eq 'role') {
3448: if ($tool eq 'autosec') {
3449: $role = $token->[2]{id};
3450: }
1.294 raeburn 3451: } else {
3452: my $value=$parser->get_text('/'.$entry);
3453: if ($entry eq 'name') {
3454: if ($tool eq 'functions') {
3455: my $function = $token->[2]{id};
3456: $content{$tool}{$function} = $value;
3457: }
3458: } elsif ($entry eq 'groupname') {
3459: $content{$entry}=&Apache::lonnet::unescape($value);
1.303 raeburn 3460: } elsif (($entry eq 'roles') || ($entry eq 'types') ||
3461: ($entry eq 'sectionpick') || ($entry eq 'defpriv')) {
3462: push(@{$content{$entry}},$value);
3463: } elsif ($entry eq 'section') {
3464: if ($tool eq 'autosec' && $role ne '') {
3465: push(@{$content{$tool}{$role}},$value);
3466: }
1.294 raeburn 3467: } else {
3468: $content{$entry}=$value;
3469: }
3470: }
3471: } elsif ($token->[0] eq 'E') {
1.303 raeburn 3472: if ($token->[1] eq 'functions' || $token->[1] eq 'autosec') {
1.294 raeburn 3473: $tool = '';
1.303 raeburn 3474: } elsif ($token->[1] eq 'role') {
3475: $role = '';
1.294 raeburn 3476: }
1.303 raeburn 3477:
1.294 raeburn 3478: }
3479: }
3480: return %content;
3481: }
3482:
3483: sub check_group_access {
3484: my ($group) = @_;
3485: my $access = 1;
3486: my $now = time;
3487: my ($start,$end) = split(/\./,$env{'user.role.gr/'.$env{'request.course,id'}.'/'.$group});
3488: if (($end!=0) && ($end<$now)) { $access = 0; }
3489: if (($start!=0) && ($start>$now)) { $access=0; }
3490: return $access;
3491: }
3492:
3493: ###############################################
3494:
3495: =pod
1.275 raeburn 3496:
3497: =item get_course_users
3498:
3499: Retrieves usernames:domains for users in the specified course
3500: with specific role(s), and access status.
3501:
3502: Incoming parameters:
1.277 albertel 3503: 1. course domain
3504: 2. course number
3505: 3. access status: users must have - either active,
1.275 raeburn 3506: previous, future, or all.
1.277 albertel 3507: 4. reference to array of permissible roles
1.288 raeburn 3508: 5. reference to array of section restrictions (optional)
3509: 6. reference to results object (hash of hashes).
3510: 7. reference to optional userdata hash
1.275 raeburn 3511: Keys of top level hash are roles.
3512: Keys of inner hashes are username:domain, with
3513: values set to access type.
1.288 raeburn 3514: Optional userdata hash returns an array with arguments in the
3515: same order as loncoursedata::get_classlist() for student data.
3516:
3517: Entries for end, start, section and status are blank because
3518: of the possibility of multiple values for non-student roles.
3519:
1.275 raeburn 3520: =cut
3521:
3522: ###############################################
3523:
3524: sub get_course_users {
1.288 raeburn 3525: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata) = @_;
3526: my %idx = ();
3527:
3528: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
3529: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
3530: $idx{end} = &Apache::loncoursedata::CL_END();
3531: $idx{start} = &Apache::loncoursedata::CL_START();
3532: $idx{id} = &Apache::loncoursedata::CL_ID();
3533: $idx{section} = &Apache::loncoursedata::CL_SECTION();
3534: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
3535: $idx{status} = &Apache::loncoursedata::CL_STATUS();
3536:
1.290 albertel 3537: if (grep(/^st$/,@{$roles})) {
1.276 albertel 3538: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 3539: my $now = time;
1.277 albertel 3540: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 3541: my $match = 0;
1.291 albertel 3542: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.290 albertel 3543: unless(grep(/^\Q$$classlist{$student}[$idx{section}]\E$/,
3544: @{$sections})) {
3545: next;
3546: }
1.288 raeburn 3547: }
1.275 raeburn 3548: if (defined($$types{'active'})) {
1.288 raeburn 3549: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 3550: push(@{$$users{st}{$student}},'active');
1.288 raeburn 3551: $match = 1;
1.275 raeburn 3552: }
3553: }
3554: if (defined($$types{'previous'})) {
1.288 raeburn 3555: if ($$classlist{$student}[$idx{end}] <= $now) {
1.275 raeburn 3556: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 3557: $match = 1;
1.275 raeburn 3558: }
3559: }
3560: if (defined($$types{'future'})) {
1.288 raeburn 3561: if (($$classlist{$student}[$idx{start}] > $now) && ($$classlist{$student}[$idx{end}] > $now) || ($$classlist{$student}[$idx{end}] == 0) || ($$classlist{$student}[$idx{end}] eq '')) {
1.275 raeburn 3562: push(@{$$users{st}{$student}},'future');
1.288 raeburn 3563: $match = 1;
1.275 raeburn 3564: }
3565: }
1.288 raeburn 3566: if ($match && defined($userdata)) {
3567: $$userdata{$student} = $$classlist{$student};
3568: }
1.275 raeburn 3569: }
3570: }
3571: if ((@{$roles} > 0) && (@{$roles} ne "st")) {
3572: my @coursepersonnel = &Apache::lonnet::getkeys('nohist_userroles',$cdom,$cnum);
3573: foreach my $person (@coursepersonnel) {
1.288 raeburn 3574: my $match = 0;
1.275 raeburn 3575: my ($role,$user) = ($person =~ /^([^:]*):([^:]+:[^:]+)/);
3576: $user =~ s/:$//;
1.290 albertel 3577: if (($role) && (grep(/^\Q$role\E$/,@{$roles}))) {
1.288 raeburn 3578: my ($uname,$udom,$usec) = split(/:/,$user);
1.290 albertel 3579: if ($usec ne '' && (ref($sections) eq 'ARRAY') &&
3580: @{$sections} > 0) {
3581: unless(grep(/^\Q$usec\E$/,@{$sections})) {
3582: next;
3583: }
1.288 raeburn 3584: }
1.275 raeburn 3585: if ($uname ne '' && $udom ne '') {
3586: my $status = &check_user_status($udom,$uname,$cdom,$cnum,$role);
1.277 albertel 3587: foreach my $type (keys(%{$types})) {
1.275 raeburn 3588: if ($status eq $type) {
1.288 raeburn 3589: @{$$users{$role}{$user}} = $type;
3590: $match = 1;
3591: }
3592: }
1.290 albertel 3593: if ($match && defined($userdata) &&
3594: !exists($$userdata{$uname.':'.$udom})) {
3595: &get_user_info($udom,$uname,\%idx,$userdata);
1.275 raeburn 3596: }
3597: }
3598: }
3599: }
1.290 albertel 3600: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 3601: if ((defined($cdom)) && (defined($cnum))) {
3602: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
3603: if ( defined($csettings{'internal.courseowner'}) ) {
3604: my $owner = $csettings{'internal.courseowner'};
1.288 raeburn 3605: @{$$users{'ow'}{$owner.':'.$cdom}} = 'any';
1.290 albertel 3606: if (defined($userdata) &&
3607: !exists($$userdata{$owner.':'.$cdom})) {
3608: &get_user_info($cdom,$owner,\%idx,$userdata);
3609: }
1.279 raeburn 3610: }
3611: }
3612: }
1.275 raeburn 3613: }
3614: return;
3615: }
3616:
1.288 raeburn 3617: sub get_user_info {
3618: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 3619: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
3620: &plainname($uname,$udom,'lastname');
1.291 albertel 3621: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 3622: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.288 raeburn 3623: return;
3624: }
1.275 raeburn 3625:
3626: ###############################################
1.233 raeburn 3627:
1.99 www 3628: sub get_posted_cgi {
3629: my $r=shift;
3630:
3631: my $buffer;
1.260 albertel 3632: if ($r->header_in('Content-length')) {
3633: $r->read($buffer,$r->header_in('Content-length'),0);
3634: }
1.99 www 3635: unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
3636: my @pairs=split(/&/,$buffer);
3637: my $pair;
3638: foreach $pair (@pairs) {
3639: my ($name,$value) = split(/=/,$pair);
3640: $value =~ tr/+/ /;
3641: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3642: $name =~ tr/+/ /;
3643: $name =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
3644: &add_to_env("form.$name",$value);
3645: }
3646: } else {
3647: my $contentsep=$1;
3648: my @lines = split (/\n/,$buffer);
3649: my $name='';
3650: my $value='';
3651: my $fname='';
3652: my $fmime='';
3653: my $i;
3654: for ($i=0;$i<=$#lines;$i++) {
3655: if ($lines[$i]=~/^$contentsep/) {
3656: if ($name) {
3657: chomp($value);
3658: if ($fname) {
1.258 albertel 3659: $env{"form.$name.filename"}=$fname;
3660: $env{"form.$name.mimetype"}=$fmime;
1.99 www 3661: } else {
3662: $value=~s/\s+$//s;
3663: }
3664: &add_to_env("form.$name",$value);
3665: }
3666: if ($i<$#lines) {
3667: $i++;
3668: $lines[$i]=~
3669: /Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
3670: $name=$1;
3671: $value='';
3672: if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
3673: $fname=$1;
3674: if
3675: ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
3676: $fmime=$1;
3677: $i++;
3678: } else {
3679: $fmime='';
3680: }
3681: } else {
3682: $fname='';
3683: $fmime='';
3684: }
3685: $i++;
3686: }
3687: } else {
3688: $value.=$lines[$i]."\n";
3689: }
3690: }
3691: }
1.258 albertel 3692: $env{'request.method'}=$ENV{'REQUEST_METHOD'};
1.99 www 3693: $r->method_number(M_GET);
3694: $r->method('GET');
3695: $r->headers_in->unset('Content-length');
3696: }
3697:
1.112 bowersj2 3698: =pod
3699:
3700: =item * get_unprocessed_cgi($query,$possible_names)
3701:
1.258 albertel 3702: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 3703: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 3704: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 3705:
3706: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
3707: $possible_names is an ref to an array of form element names. As an example:
3708: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 3709: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 3710:
3711: =cut
1.1 albertel 3712:
1.6 albertel 3713: sub get_unprocessed_cgi {
1.25 albertel 3714: my ($query,$possible_names)= @_;
1.26 matthew 3715: # $Apache::lonxml::debug=1;
1.16 harris41 3716: foreach (split(/&/,$query)) {
1.6 albertel 3717: my ($name, $value) = split(/=/,$_);
1.25 albertel 3718: $name = &Apache::lonnet::unescape($name);
3719: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
3720: $value =~ tr/+/ /;
3721: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 3722: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 3723: }
1.16 harris41 3724: }
1.6 albertel 3725: }
3726:
1.112 bowersj2 3727: =pod
3728:
3729: =item * cacheheader()
3730:
3731: returns cache-controlling header code
3732:
3733: =cut
3734:
1.7 albertel 3735: sub cacheheader {
1.258 albertel 3736: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 3737: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
3738: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 3739: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
3740: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 3741: return $output;
1.7 albertel 3742: }
3743:
1.112 bowersj2 3744: =pod
3745:
3746: =item * no_cache($r)
3747:
3748: specifies header code to not have cache
3749:
3750: =cut
3751:
1.9 albertel 3752: sub no_cache {
1.216 albertel 3753: my ($r) = @_;
3754: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 3755: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 3756: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
3757: $r->no_cache(1);
3758: $r->header_out("Expires" => $date);
3759: $r->header_out("Pragma" => "no-cache");
1.123 www 3760: }
3761:
3762: sub content_type {
1.181 albertel 3763: my ($r,$type,$charset) = @_;
1.299 foxr 3764: if ($r) {
3765: # Note that printout.pl calls this with undef for $r.
3766: &no_cache($r);
3767: }
1.258 albertel 3768: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 3769: unless ($charset) {
3770: $charset=&Apache::lonlocal::current_encoding;
3771: }
3772: if ($charset) { $type.='; charset='.$charset; }
3773: if ($r) {
3774: $r->content_type($type);
3775: } else {
3776: print("Content-type: $type\n\n");
3777: }
1.9 albertel 3778: }
1.25 albertel 3779:
1.112 bowersj2 3780: =pod
3781:
3782: =item * add_to_env($name,$value)
3783:
1.258 albertel 3784: adds $name to the %env hash with value
1.112 bowersj2 3785: $value, if $name already exists, the entry is converted to an array
3786: reference and $value is added to the array.
3787:
3788: =cut
3789:
1.25 albertel 3790: sub add_to_env {
3791: my ($name,$value)=@_;
1.258 albertel 3792: if (defined($env{$name})) {
3793: if (ref($env{$name})) {
1.25 albertel 3794: #already have multiple values
1.258 albertel 3795: push(@{ $env{$name} },$value);
1.25 albertel 3796: } else {
3797: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 3798: my $first=$env{$name};
3799: undef($env{$name});
3800: push(@{ $env{$name} },$first,$value);
1.25 albertel 3801: }
3802: } else {
1.258 albertel 3803: $env{$name}=$value;
1.25 albertel 3804: }
1.31 albertel 3805: }
1.149 albertel 3806:
3807: =pod
3808:
3809: =item * get_env_multiple($name)
3810:
1.258 albertel 3811: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 3812: values may be defined and end up as an array ref.
3813:
3814: returns an array of values
3815:
3816: =cut
3817:
3818: sub get_env_multiple {
3819: my ($name) = @_;
3820: my @values;
1.258 albertel 3821: if (defined($env{$name})) {
1.149 albertel 3822: # exists is it an array
1.258 albertel 3823: if (ref($env{$name})) {
3824: @values=@{ $env{$name} };
1.149 albertel 3825: } else {
1.258 albertel 3826: $values[0]=$env{$name};
1.149 albertel 3827: }
3828: }
3829: return(@values);
3830: }
3831:
1.31 albertel 3832:
1.41 ng 3833: =pod
1.45 matthew 3834:
3835: =back
1.41 ng 3836:
1.112 bowersj2 3837: =head1 CSV Upload/Handling functions
1.38 albertel 3838:
1.41 ng 3839: =over 4
3840:
1.112 bowersj2 3841: =item * upfile_store($r)
1.41 ng 3842:
3843: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 3844: needs $env{'form.upfile'}
1.41 ng 3845: returns $datatoken to be put into hidden field
3846:
3847: =cut
1.31 albertel 3848:
3849: sub upfile_store {
3850: my $r=shift;
1.258 albertel 3851: $env{'form.upfile'}=~s/\r/\n/gs;
3852: $env{'form.upfile'}=~s/\f/\n/gs;
3853: $env{'form.upfile'}=~s/\n+/\n/gs;
3854: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 3855:
1.258 albertel 3856: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
3857: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 3858: {
1.158 raeburn 3859: my $datafile = $r->dir_config('lonDaemons').
3860: '/tmp/'.$datatoken.'.tmp';
3861: if ( open(my $fh,">$datafile") ) {
1.258 albertel 3862: print $fh $env{'form.upfile'};
1.158 raeburn 3863: close($fh);
3864: }
1.31 albertel 3865: }
3866: return $datatoken;
3867: }
3868:
1.56 matthew 3869: =pod
3870:
1.112 bowersj2 3871: =item * load_tmp_file($r)
1.41 ng 3872:
3873: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 3874: needs $env{'form.datatoken'},
3875: sets $env{'form.upfile'} to the contents of the file
1.41 ng 3876:
3877: =cut
1.31 albertel 3878:
3879: sub load_tmp_file {
3880: my $r=shift;
3881: my @studentdata=();
3882: {
1.158 raeburn 3883: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 3884: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 3885: if ( open(my $fh,"<$studentfile") ) {
3886: @studentdata=<$fh>;
3887: close($fh);
3888: }
1.31 albertel 3889: }
1.258 albertel 3890: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 3891: }
3892:
1.56 matthew 3893: =pod
3894:
1.112 bowersj2 3895: =item * upfile_record_sep()
1.41 ng 3896:
3897: Separate uploaded file into records
3898: returns array of records,
1.258 albertel 3899: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 3900:
3901: =cut
1.31 albertel 3902:
3903: sub upfile_record_sep {
1.258 albertel 3904: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 3905: } else {
1.248 albertel 3906: my @records;
1.258 albertel 3907: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 3908: if ($line=~/^\s*$/) { next; }
3909: push(@records,$line);
3910: }
3911: return @records;
1.31 albertel 3912: }
3913: }
3914:
1.56 matthew 3915: =pod
3916:
1.112 bowersj2 3917: =item * record_sep($record)
1.41 ng 3918:
1.258 albertel 3919: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 3920:
3921: =cut
3922:
1.263 www 3923: sub takeleft {
3924: my $index=shift;
3925: return substr('0000'.$index,-4,4);
3926: }
3927:
1.31 albertel 3928: sub record_sep {
3929: my $record=shift;
3930: my %components=();
1.258 albertel 3931: if ($env{'form.upfiletype'} eq 'xml') {
3932: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 3933: my $i=0;
3934: foreach (split(/\s+/,$record)) {
3935: my $field=$_;
3936: $field=~s/^(\"|\')//;
3937: $field=~s/(\"|\')$//;
1.263 www 3938: $components{&takeleft($i)}=$field;
1.31 albertel 3939: $i++;
3940: }
1.258 albertel 3941: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 3942: my $i=0;
1.171 matthew 3943: foreach (split(/\t/,$record)) {
1.31 albertel 3944: my $field=$_;
3945: $field=~s/^(\"|\')//;
3946: $field=~s/(\"|\')$//;
1.263 www 3947: $components{&takeleft($i)}=$field;
1.31 albertel 3948: $i++;
3949: }
3950: } else {
3951: my @allfields=split(/\,/,$record);
3952: my $i=0;
3953: my $j;
3954: for ($j=0;$j<=$#allfields;$j++) {
3955: my $field=$allfields[$j];
3956: if ($field=~/^\s*(\"|\')/) {
3957: my $delimiter=$1;
3958: while (($field!~/$delimiter$/) && ($j<$#allfields)) {
3959: $j++;
3960: $field.=','.$allfields[$j];
3961: }
3962: $field=~s/^\s*$delimiter//;
3963: $field=~s/$delimiter\s*$//;
3964: }
1.263 www 3965: $components{&takeleft($i)}=$field;
1.31 albertel 3966: $i++;
3967: }
3968: }
3969: return %components;
3970: }
3971:
1.144 matthew 3972: ######################################################
3973: ######################################################
3974:
1.56 matthew 3975: =pod
3976:
1.112 bowersj2 3977: =item * upfile_select_html()
1.41 ng 3978:
1.144 matthew 3979: Return HTML code to select a file from the users machine and specify
3980: the file type.
1.41 ng 3981:
3982: =cut
3983:
1.144 matthew 3984: ######################################################
3985: ######################################################
1.31 albertel 3986: sub upfile_select_html {
1.144 matthew 3987: my %Types = (
3988: csv => &mt('CSV (comma separated values, spreadsheet)'),
3989: space => &mt('Space separated'),
3990: tab => &mt('Tabulator separated'),
3991: # xml => &mt('HTML/XML'),
3992: );
3993: my $Str = '<input type="file" name="upfile" size="50" />'.
3994: '<br />Type: <select name="upfiletype">';
3995: foreach my $type (sort(keys(%Types))) {
3996: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
3997: }
3998: $Str .= "</select>\n";
3999: return $Str;
1.31 albertel 4000: }
4001:
1.301 albertel 4002: sub get_samples {
4003: my ($records,$toget) = @_;
4004: my @samples=({});
4005: my $got=0;
4006: foreach my $rec (@$records) {
4007: my %temp = &record_sep($rec);
4008: if (! grep(/\S/, values(%temp))) { next; }
4009: if (%temp) {
4010: $samples[$got]=\%temp;
4011: $got++;
4012: if ($got == $toget) { last; }
4013: }
4014: }
4015: return \@samples;
4016: }
4017:
1.144 matthew 4018: ######################################################
4019: ######################################################
4020:
1.56 matthew 4021: =pod
4022:
1.112 bowersj2 4023: =item * csv_print_samples($r,$records)
1.41 ng 4024:
4025: Prints a table of sample values from each column uploaded $r is an
4026: Apache Request ref, $records is an arrayref from
4027: &Apache::loncommon::upfile_record_sep
4028:
4029: =cut
4030:
1.144 matthew 4031: ######################################################
4032: ######################################################
1.31 albertel 4033: sub csv_print_samples {
4034: my ($r,$records) = @_;
1.301 albertel 4035: my $samples = &get_samples($records,3);
4036:
1.144 matthew 4037: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
1.301 albertel 4038: foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.144 matthew 4039: $r->print('<th>'.&mt('Column [_1]',($_+1)).'</th>'); }
1.31 albertel 4040: $r->print('</tr>');
1.301 albertel 4041: foreach my $hash (@$samples) {
1.31 albertel 4042: $r->print('<tr>');
1.301 albertel 4043: foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 4044: $r->print('<td>');
4045: if (defined($$hash{$_})) { $r->print($$hash{$_}); }
4046: $r->print('</td>');
4047: }
4048: $r->print('</tr>');
4049: }
4050: $r->print('</tr></table><br />'."\n");
4051: }
4052:
1.144 matthew 4053: ######################################################
4054: ######################################################
4055:
1.56 matthew 4056: =pod
4057:
1.112 bowersj2 4058: =item * csv_print_select_table($r,$records,$d)
1.41 ng 4059:
4060: Prints a table to create associations between values and table columns.
1.144 matthew 4061:
1.41 ng 4062: $r is an Apache Request ref,
4063: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 4064: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 4065:
4066: =cut
4067:
1.144 matthew 4068: ######################################################
4069: ######################################################
1.31 albertel 4070: sub csv_print_select_table {
4071: my ($r,$records,$d) = @_;
1.301 albertel 4072: my $i=0;
4073: my $samples = &get_samples($records,1);
1.144 matthew 4074: $r->print(&mt('Associate columns with student attributes.')."\n".
4075: '<table border="2"><tr>'.
4076: '<th>'.&mt('Attribute').'</th>'.
4077: '<th>'.&mt('Column').'</th></tr>'."\n");
1.31 albertel 4078: foreach (@$d) {
1.174 matthew 4079: my ($value,$display,$defaultcol)=@{ $_ };
1.31 albertel 4080: $r->print('<tr><td>'.$display.'</td>');
4081:
4082: $r->print('<td><select name=f'.$i.
1.32 matthew 4083: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 4084: $r->print('<option value="none"></option>');
1.301 albertel 4085: foreach (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.174 matthew 4086: $r->print('<option value="'.$_.'"'.
1.253 albertel 4087: ($_ eq $defaultcol ? ' selected="selected" ' : '').
1.174 matthew 4088: '>Column '.($_+1).'</option>');
1.31 albertel 4089: }
4090: $r->print('</select></td></tr>'."\n");
4091: $i++;
4092: }
4093: $i--;
4094: return $i;
4095: }
1.56 matthew 4096:
1.144 matthew 4097: ######################################################
4098: ######################################################
4099:
1.56 matthew 4100: =pod
1.31 albertel 4101:
1.112 bowersj2 4102: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 4103:
4104: Prints a table of sample values from the upload and can make associate samples to internal names.
4105:
4106: $r is an Apache Request ref,
4107: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
4108: $d is an array of 2 element arrays (internal name, displayed name)
4109:
4110: =cut
4111:
1.144 matthew 4112: ######################################################
4113: ######################################################
1.31 albertel 4114: sub csv_samples_select_table {
4115: my ($r,$records,$d) = @_;
4116: my $i=0;
1.144 matthew 4117: #
1.301 albertel 4118: my $samples = &get_samples($records,3);
1.144 matthew 4119: $r->print('<table border=2><tr><th>'.
4120: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.301 albertel 4121:
4122: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.144 matthew 4123: $r->print('<tr><td><select name="f'.$i.'"'.
1.32 matthew 4124: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 4125: foreach my $option (@$d) {
4126: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 4127: $r->print('<option value="'.$value.'"'.
1.253 albertel 4128: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 4129: $display.'</option>');
1.31 albertel 4130: }
4131: $r->print('</select></td><td>');
1.301 albertel 4132: foreach my $line (0..2) {
4133: if (defined($samples->[$line]{$key})) {
4134: $r->print($samples->[$line]{$key}."<br />\n");
4135: }
4136: }
1.31 albertel 4137: $r->print('</td></tr>');
4138: $i++;
4139: }
4140: $i--;
4141: return($i);
1.115 matthew 4142: }
4143:
1.144 matthew 4144: ######################################################
4145: ######################################################
4146:
1.115 matthew 4147: =pod
4148:
4149: =item clean_excel_name($name)
4150:
4151: Returns a replacement for $name which does not contain any illegal characters.
4152:
4153: =cut
4154:
1.144 matthew 4155: ######################################################
4156: ######################################################
1.115 matthew 4157: sub clean_excel_name {
4158: my ($name) = @_;
4159: $name =~ s/[:\*\?\/\\]//g;
4160: if (length($name) > 31) {
4161: $name = substr($name,0,31);
4162: }
4163: return $name;
1.25 albertel 4164: }
1.84 albertel 4165:
1.85 albertel 4166: =pod
4167:
1.112 bowersj2 4168: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 4169:
4170: Returns either 1 or undef
4171:
4172: 1 if the part is to be hidden, undef if it is to be shown
4173:
4174: Arguments are:
4175:
4176: $id the id of the part to be checked
4177: $symb, optional the symb of the resource to check
4178: $udom, optional the domain of the user to check for
4179: $uname, optional the username of the user to check for
4180:
4181: =cut
1.84 albertel 4182:
4183: sub check_if_partid_hidden {
4184: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 4185: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 4186: $symb,$udom,$uname);
1.141 albertel 4187: my $truth=1;
4188: #if the string starts with !, then the list is the list to show not hide
4189: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 4190: my @hiddenlist=split(/,/,$hiddenparts);
4191: foreach my $checkid (@hiddenlist) {
1.141 albertel 4192: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 4193: }
1.141 albertel 4194: return !$truth;
1.84 albertel 4195: }
1.127 matthew 4196:
1.138 matthew 4197:
4198: ############################################################
4199: ############################################################
4200:
4201: =pod
4202:
1.157 matthew 4203: =back
4204:
1.138 matthew 4205: =head1 cgi-bin script and graphing routines
4206:
1.157 matthew 4207: =over 4
4208:
1.138 matthew 4209: =item get_cgi_id
4210:
4211: Inputs: none
4212:
4213: Returns an id which can be used to pass environment variables
4214: to various cgi-bin scripts. These environment variables will
4215: be removed from the users environment after a given time by
4216: the routine &Apache::lonnet::transfer_profile_to_env.
4217:
4218: =cut
4219:
4220: ############################################################
4221: ############################################################
1.152 albertel 4222: my $uniq=0;
1.136 matthew 4223: sub get_cgi_id {
1.154 albertel 4224: $uniq=($uniq+1)%100000;
1.280 albertel 4225: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 4226: }
4227:
1.127 matthew 4228: ############################################################
4229: ############################################################
4230:
4231: =pod
4232:
1.134 matthew 4233: =item DrawBarGraph
1.127 matthew 4234:
1.138 matthew 4235: Facilitates the plotting of data in a (stacked) bar graph.
4236: Puts plot definition data into the users environment in order for
4237: graph.png to plot it. Returns an <img> tag for the plot.
4238: The bars on the plot are labeled '1','2',...,'n'.
4239:
4240: Inputs:
4241:
4242: =over 4
4243:
4244: =item $Title: string, the title of the plot
4245:
4246: =item $xlabel: string, text describing the X-axis of the plot
4247:
4248: =item $ylabel: string, text describing the Y-axis of the plot
4249:
4250: =item $Max: scalar, the maximum Y value to use in the plot
4251: If $Max is < any data point, the graph will not be rendered.
4252:
1.140 matthew 4253: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 4254: they are plotted. If undefined, default values will be used.
4255:
1.178 matthew 4256: =item $labels: array ref holding the labels to use on the x-axis for the bars.
4257:
1.138 matthew 4258: =item @Values: An array of array references. Each array reference holds data
4259: to be plotted in a stacked bar chart.
4260:
1.239 matthew 4261: =item If the final element of @Values is a hash reference the key/value
4262: pairs will be added to the graph definition.
4263:
1.138 matthew 4264: =back
4265:
4266: Returns:
4267:
4268: An <img> tag which references graph.png and the appropriate identifying
4269: information for the plot.
4270:
1.127 matthew 4271: =cut
4272:
4273: ############################################################
4274: ############################################################
1.134 matthew 4275: sub DrawBarGraph {
1.178 matthew 4276: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 4277: #
4278: if (! defined($colors)) {
4279: $colors = ['#33ff00',
4280: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
4281: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
4282: ];
4283: }
1.228 matthew 4284: my $extra_settings = {};
4285: if (ref($Values[-1]) eq 'HASH') {
4286: $extra_settings = pop(@Values);
4287: }
1.127 matthew 4288: #
1.136 matthew 4289: my $identifier = &get_cgi_id();
4290: my $id = 'cgi.'.$identifier;
1.129 matthew 4291: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 4292: return '';
4293: }
1.225 matthew 4294: #
4295: my @Labels;
4296: if (defined($labels)) {
4297: @Labels = @$labels;
4298: } else {
4299: for (my $i=0;$i<@{$Values[0]};$i++) {
4300: push (@Labels,$i+1);
4301: }
4302: }
4303: #
1.129 matthew 4304: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 4305: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 4306: my %ValuesHash;
4307: my $NumSets=1;
4308: foreach my $array (@Values) {
4309: next if (! ref($array));
1.136 matthew 4310: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 4311: join(',',@$array);
1.129 matthew 4312: }
1.127 matthew 4313: #
1.136 matthew 4314: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 4315: if ($NumBars < 3) {
4316: $width = 120+$NumBars*32;
1.220 matthew 4317: $xskip = 1;
1.225 matthew 4318: $bar_width = 30;
4319: } elsif ($NumBars < 5) {
4320: $width = 120+$NumBars*20;
4321: $xskip = 1;
4322: $bar_width = 20;
1.220 matthew 4323: } elsif ($NumBars < 10) {
1.136 matthew 4324: $width = 120+$NumBars*15;
4325: $xskip = 1;
4326: $bar_width = 15;
4327: } elsif ($NumBars <= 25) {
4328: $width = 120+$NumBars*11;
4329: $xskip = 5;
4330: $bar_width = 8;
4331: } elsif ($NumBars <= 50) {
4332: $width = 120+$NumBars*8;
4333: $xskip = 5;
4334: $bar_width = 4;
4335: } else {
4336: $width = 120+$NumBars*8;
4337: $xskip = 5;
4338: $bar_width = 4;
4339: }
4340: #
1.137 matthew 4341: $Max = 1 if ($Max < 1);
4342: if ( int($Max) < $Max ) {
4343: $Max++;
4344: $Max = int($Max);
4345: }
1.127 matthew 4346: $Title = '' if (! defined($Title));
4347: $xlabel = '' if (! defined($xlabel));
4348: $ylabel = '' if (! defined($ylabel));
1.136 matthew 4349: $ValuesHash{$id.'.title'} = &Apache::lonnet::escape($Title);
4350: $ValuesHash{$id.'.xlabel'} = &Apache::lonnet::escape($xlabel);
4351: $ValuesHash{$id.'.ylabel'} = &Apache::lonnet::escape($ylabel);
1.137 matthew 4352: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 4353: $ValuesHash{$id.'.NumBars'} = $NumBars;
4354: $ValuesHash{$id.'.NumSets'} = $NumSets;
4355: $ValuesHash{$id.'.PlotType'} = 'bar';
4356: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
4357: $ValuesHash{$id.'.height'} = $height;
4358: $ValuesHash{$id.'.width'} = $width;
4359: $ValuesHash{$id.'.xskip'} = $xskip;
4360: $ValuesHash{$id.'.bar_width'} = $bar_width;
4361: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 4362: #
1.228 matthew 4363: # Deal with other parameters
4364: while (my ($key,$value) = each(%$extra_settings)) {
4365: $ValuesHash{$id.'.'.$key} = $value;
4366: }
4367: #
1.137 matthew 4368: &Apache::lonnet::appenv(%ValuesHash);
4369: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
4370: }
4371:
4372: ############################################################
4373: ############################################################
4374:
4375: =pod
4376:
4377: =item DrawXYGraph
4378:
1.138 matthew 4379: Facilitates the plotting of data in an XY graph.
4380: Puts plot definition data into the users environment in order for
4381: graph.png to plot it. Returns an <img> tag for the plot.
4382:
4383: Inputs:
4384:
4385: =over 4
4386:
4387: =item $Title: string, the title of the plot
4388:
4389: =item $xlabel: string, text describing the X-axis of the plot
4390:
4391: =item $ylabel: string, text describing the Y-axis of the plot
4392:
4393: =item $Max: scalar, the maximum Y value to use in the plot
4394: If $Max is < any data point, the graph will not be rendered.
4395:
4396: =item $colors: Array ref containing the hex color codes for the data to be
4397: plotted in. If undefined, default values will be used.
4398:
4399: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
4400:
4401: =item $Ydata: Array ref containing Array refs.
1.185 www 4402: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 4403:
4404: =item %Values: hash indicating or overriding any default values which are
4405: passed to graph.png.
4406: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
4407:
4408: =back
4409:
4410: Returns:
4411:
4412: An <img> tag which references graph.png and the appropriate identifying
4413: information for the plot.
4414:
1.137 matthew 4415: =cut
4416:
4417: ############################################################
4418: ############################################################
4419: sub DrawXYGraph {
4420: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
4421: #
4422: # Create the identifier for the graph
4423: my $identifier = &get_cgi_id();
4424: my $id = 'cgi.'.$identifier;
4425: #
4426: $Title = '' if (! defined($Title));
4427: $xlabel = '' if (! defined($xlabel));
4428: $ylabel = '' if (! defined($ylabel));
4429: my %ValuesHash =
4430: (
4431: $id.'.title' => &Apache::lonnet::escape($Title),
4432: $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
4433: $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
4434: $id.'.y_max_value'=> $Max,
4435: $id.'.labels' => join(',',@$Xlabels),
4436: $id.'.PlotType' => 'XY',
4437: );
4438: #
4439: if (defined($colors) && ref($colors) eq 'ARRAY') {
4440: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
4441: }
4442: #
4443: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
4444: return '';
4445: }
4446: my $NumSets=1;
1.138 matthew 4447: foreach my $array (@{$Ydata}){
1.137 matthew 4448: next if (! ref($array));
4449: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
4450: }
1.138 matthew 4451: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 4452: #
4453: # Deal with other parameters
4454: while (my ($key,$value) = each(%Values)) {
4455: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 4456: }
4457: #
1.136 matthew 4458: &Apache::lonnet::appenv(%ValuesHash);
4459: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
4460: }
4461:
4462: ############################################################
4463: ############################################################
4464:
4465: =pod
4466:
1.138 matthew 4467: =item DrawXYYGraph
4468:
4469: Facilitates the plotting of data in an XY graph with two Y axes.
4470: Puts plot definition data into the users environment in order for
4471: graph.png to plot it. Returns an <img> tag for the plot.
4472:
4473: Inputs:
4474:
4475: =over 4
4476:
4477: =item $Title: string, the title of the plot
4478:
4479: =item $xlabel: string, text describing the X-axis of the plot
4480:
4481: =item $ylabel: string, text describing the Y-axis of the plot
4482:
4483: =item $colors: Array ref containing the hex color codes for the data to be
4484: plotted in. If undefined, default values will be used.
4485:
4486: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
4487:
4488: =item $Ydata1: The first data set
4489:
4490: =item $Min1: The minimum value of the left Y-axis
4491:
4492: =item $Max1: The maximum value of the left Y-axis
4493:
4494: =item $Ydata2: The second data set
4495:
4496: =item $Min2: The minimum value of the right Y-axis
4497:
4498: =item $Max2: The maximum value of the left Y-axis
4499:
4500: =item %Values: hash indicating or overriding any default values which are
4501: passed to graph.png.
4502: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
4503:
4504: =back
4505:
4506: Returns:
4507:
4508: An <img> tag which references graph.png and the appropriate identifying
4509: information for the plot.
1.136 matthew 4510:
4511: =cut
4512:
4513: ############################################################
4514: ############################################################
1.137 matthew 4515: sub DrawXYYGraph {
4516: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
4517: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 4518: #
4519: # Create the identifier for the graph
4520: my $identifier = &get_cgi_id();
4521: my $id = 'cgi.'.$identifier;
4522: #
4523: $Title = '' if (! defined($Title));
4524: $xlabel = '' if (! defined($xlabel));
4525: $ylabel = '' if (! defined($ylabel));
4526: my %ValuesHash =
4527: (
4528: $id.'.title' => &Apache::lonnet::escape($Title),
4529: $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
4530: $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
4531: $id.'.labels' => join(',',@$Xlabels),
4532: $id.'.PlotType' => 'XY',
4533: $id.'.NumSets' => 2,
1.137 matthew 4534: $id.'.two_axes' => 1,
4535: $id.'.y1_max_value' => $Max1,
4536: $id.'.y1_min_value' => $Min1,
4537: $id.'.y2_max_value' => $Max2,
4538: $id.'.y2_min_value' => $Min2,
1.136 matthew 4539: );
4540: #
1.137 matthew 4541: if (defined($colors) && ref($colors) eq 'ARRAY') {
4542: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
4543: }
4544: #
4545: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
4546: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 4547: return '';
4548: }
4549: my $NumSets=1;
1.137 matthew 4550: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 4551: next if (! ref($array));
4552: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 4553: }
4554: #
4555: # Deal with other parameters
4556: while (my ($key,$value) = each(%Values)) {
4557: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 4558: }
4559: #
4560: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 4561: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 4562: }
4563:
4564: ############################################################
4565: ############################################################
4566:
4567: =pod
4568:
1.157 matthew 4569: =back
4570:
1.139 matthew 4571: =head1 Statistics helper routines?
4572:
4573: Bad place for them but what the hell.
4574:
1.157 matthew 4575: =over 4
4576:
1.139 matthew 4577: =item &chartlink
4578:
4579: Returns a link to the chart for a specific student.
4580:
4581: Inputs:
4582:
4583: =over 4
4584:
4585: =item $linktext: The text of the link
4586:
4587: =item $sname: The students username
4588:
4589: =item $sdomain: The students domain
4590:
4591: =back
4592:
1.157 matthew 4593: =back
4594:
1.139 matthew 4595: =cut
4596:
4597: ############################################################
4598: ############################################################
4599: sub chartlink {
4600: my ($linktext, $sname, $sdomain) = @_;
4601: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.219 albertel 4602: '&SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).
4603: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 4604: '">'.$linktext.'</a>';
1.153 matthew 4605: }
4606:
4607: #######################################################
4608: #######################################################
4609:
4610: =pod
4611:
4612: =head1 Course Environment Routines
1.157 matthew 4613:
4614: =over 4
1.153 matthew 4615:
4616: =item &restore_course_settings
4617:
4618: =item &store_course_settings
4619:
4620: Restores/Store indicated form parameters from the course environment.
4621: Will not overwrite existing values of the form parameters.
4622:
4623: Inputs:
4624: a scalar describing the data (e.g. 'chart', 'problem_analysis')
4625:
4626: a hash ref describing the data to be stored. For example:
4627:
4628: %Save_Parameters = ('Status' => 'scalar',
4629: 'chartoutputmode' => 'scalar',
4630: 'chartoutputdata' => 'scalar',
4631: 'Section' => 'array',
4632: 'StudentData' => 'array',
4633: 'Maps' => 'array');
4634:
4635: Returns: both routines return nothing
4636:
4637: =cut
4638:
4639: #######################################################
4640: #######################################################
4641: sub store_course_settings {
4642: # save to the environment
4643: # appenv the same items, just to be safe
1.258 albertel 4644: my $courseid = $env{'request.course.id'};
1.300 albertel 4645: my $udom = $env{'user.domain'};
4646: my $uname = $env{'user.name'};
1.153 matthew 4647: my ($prefix,$Settings) = @_;
4648: my %SaveHash;
4649: my %AppHash;
4650: while (my ($setting,$type) = each(%$Settings)) {
1.300 albertel 4651: my $basename = join('.','internal',$courseid,$prefix,$setting);
4652: my $envname = 'environment.'.$basename;
1.258 albertel 4653: if (exists($env{'form.'.$setting})) {
1.153 matthew 4654: # Save this value away
4655: if ($type eq 'scalar' &&
1.258 albertel 4656: (! exists($env{$envname}) ||
4657: $env{$envname} ne $env{'form.'.$setting})) {
4658: $SaveHash{$basename} = $env{'form.'.$setting};
4659: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 4660: } elsif ($type eq 'array') {
4661: my $stored_form;
1.258 albertel 4662: if (ref($env{'form.'.$setting})) {
1.153 matthew 4663: $stored_form = join(',',
4664: map {
4665: &Apache::lonnet::escape($_);
1.258 albertel 4666: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 4667: } else {
4668: $stored_form =
1.258 albertel 4669: &Apache::lonnet::escape($env{'form.'.$setting});
1.153 matthew 4670: }
4671: # Determine if the array contents are the same.
1.258 albertel 4672: if ($stored_form ne $env{$envname}) {
1.153 matthew 4673: $SaveHash{$basename} = $stored_form;
4674: $AppHash{$envname} = $stored_form;
4675: }
4676: }
4677: }
4678: }
4679: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 4680: $udom,$uname);
1.153 matthew 4681: if ($put_result !~ /^(ok|delayed)/) {
4682: &Apache::lonnet::logthis('unable to save form parameters, '.
4683: 'got error:'.$put_result);
4684: }
4685: # Make sure these settings stick around in this session, too
4686: &Apache::lonnet::appenv(%AppHash);
4687: return;
4688: }
4689:
4690: sub restore_course_settings {
1.258 albertel 4691: my $courseid = $env{'request.course.id'};
1.153 matthew 4692: my ($prefix,$Settings) = @_;
4693: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 4694: next if (exists($env{'form.'.$setting}));
1.300 albertel 4695: my $envname = 'environment.internal.'.$courseid.'.'.$prefix.
1.153 matthew 4696: '.'.$setting;
1.258 albertel 4697: if (exists($env{$envname})) {
1.153 matthew 4698: if ($type eq 'scalar') {
1.258 albertel 4699: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 4700: } elsif ($type eq 'array') {
1.258 albertel 4701: $env{'form.'.$setting} = [
1.153 matthew 4702: map {
4703: &Apache::lonnet::unescape($_);
1.258 albertel 4704: } split(',',$env{$envname})
1.153 matthew 4705: ];
4706: }
4707: }
4708: }
1.127 matthew 4709: }
4710:
4711: ############################################################
4712: ############################################################
1.154 albertel 4713:
4714: sub propath {
4715: my ($udom,$uname)=@_;
4716: $udom=~s/\W//g;
4717: $uname=~s/\W//g;
4718: my $subdir=$uname.'__';
4719: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
4720: my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
4721: return $proname;
1.156 albertel 4722: }
4723:
4724: sub icon {
4725: my ($file)=@_;
1.168 albertel 4726: my $curfext = (split(/\./,$file))[-1];
4727: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 4728: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 4729: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
4730: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
4731: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
4732: $curfext.".gif") {
4733: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
4734: $curfext.".gif";
4735: }
4736: }
1.249 albertel 4737: return &lonhttpdurl($iconname);
1.154 albertel 4738: }
1.84 albertel 4739:
1.215 albertel 4740: sub lonhttpdurl {
4741: my ($url)=@_;
4742: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
4743: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
4744: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
4745: }
4746:
1.213 albertel 4747: sub connection_aborted {
4748: my ($r)=@_;
4749: $r->print(" ");$r->rflush();
4750: my $c = $r->connection;
4751: return $c->aborted();
4752: }
4753:
1.221 foxr 4754: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 4755: # strings as 'strings'.
4756: sub escape_single {
1.221 foxr 4757: my ($input) = @_;
1.223 albertel 4758: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 4759: $input =~ s/\'/\\\'/g; # Esacpe the 's....
4760: return $input;
4761: }
1.223 albertel 4762:
1.222 foxr 4763: # Same as escape_single, but escape's "'s This
4764: # can be used for "strings"
4765: sub escape_double {
4766: my ($input) = @_;
4767: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
4768: $input =~ s/\"/\\\"/g; # Esacpe the "s....
4769: return $input;
4770: }
1.223 albertel 4771:
1.222 foxr 4772: # Escapes the last element of a full URL.
4773: sub escape_url {
4774: my ($url) = @_;
1.238 raeburn 4775: my @urlslices = split(/\//, $url,-1);
1.223 albertel 4776: my $lastitem = &Apache::lonnet::escape(pop(@urlslices));
4777: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 4778: }
1.41 ng 4779: =pod
4780:
4781: =back
4782:
1.112 bowersj2 4783: =cut
1.41 ng 4784:
1.112 bowersj2 4785: 1;
4786: __END__;
1.41 ng 4787:
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