Annotation of loncom/interface/loncommon.pm, revision 1.253
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.253 ! albertel 4: # $Id: loncommon.pm,v 1.252 2005/02/25 05:54:01 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.22 www 58: use Apache::lonnet();
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.99 www 61: use Apache::Constants qw(:common :http :methods);
1.82 www 62: use Apache::lonmenu();
1.117 www 63: use Apache::lonlocal;
1.139 matthew 64: use HTML::Entities;
1.117 www 65:
1.22 www 66: my $readit;
67:
1.157 matthew 68: ##
69: ## Global Variables
70: ##
1.46 matthew 71:
1.20 www 72: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 73: my %language;
1.124 www 74: my %supported_language;
1.12 harris41 75: my %cprtag;
1.192 taceyjo1 76: my %scprtag;
1.12 harris41 77: my %fe; my %fd;
1.41 ng 78: my %category_extensions;
1.12 harris41 79:
1.63 www 80: # ---------------------------------------------- Designs
81:
82: my %designhash;
83:
1.46 matthew 84: # ---------------------------------------------- Thesaurus variables
1.144 matthew 85: #
86: # %Keywords:
87: # A hash used by &keyword to determine if a word is considered a keyword.
88: # $thesaurus_db_file
89: # Scalar containing the full path to the thesaurus database.
1.46 matthew 90:
91: my %Keywords;
92: my $thesaurus_db_file;
93:
1.144 matthew 94: #
95: # Initialize values from language.tab, copyright.tab, filetypes.tab,
96: # thesaurus.tab, and filecategories.tab.
97: #
1.18 www 98: BEGIN {
1.46 matthew 99: # Variable initialization
100: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
101: #
1.22 www 102: unless ($readit) {
1.12 harris41 103: # ------------------------------------------------------------------- languages
104: {
1.158 raeburn 105: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
106: '/language.tab';
107: if ( open(my $fh,"<$langtabfile") ) {
108: while (<$fh>) {
109: next if /^\#/;
110: chomp;
111: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$_));
112: $language{$key}=$val.' - '.$enc;
113: if ($sup) {
114: $supported_language{$key}=$sup;
115: }
116: }
117: close($fh);
118: }
1.12 harris41 119: }
120: # ------------------------------------------------------------------ copyrights
121: {
1.158 raeburn 122: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
123: '/copyright.tab';
124: if ( open (my $fh,"<$copyrightfile") ) {
125: while (<$fh>) {
126: next if /^\#/;
127: chomp;
128: my ($key,$val)=(split(/\s+/,$_,2));
129: $cprtag{$key}=$val;
130: }
131: close($fh);
132: }
1.12 harris41 133: }
1.192 taceyjo1 134: # ------------------------------------------------------------------ source copyrights
135: {
136: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
137: '/source_copyright.tab';
138: if ( open (my $fh,"<$sourcecopyrightfile") ) {
139: while (<$fh>) {
140: next if /^\#/;
141: chomp;
142: my ($key,$val)=(split(/\s+/,$_,2));
143: $scprtag{$key}=$val;
144: }
145: close($fh);
146: }
147: }
1.63 www 148:
149: # -------------------------------------------------------------- domain designs
150:
151: my $filename;
152: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
153: opendir(DIR,$designdir);
154: while ($filename=readdir(DIR)) {
155: my ($domain)=($filename=~/^(\w+)\./);
156: {
1.158 raeburn 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: }
1.63 www 167: }
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 {
314: if ($ENV{'environment.lastresurl'}) {
315: return $ENV{'environment.lastresurl'}
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 (
332: (($ENV{'request.course.id'}) &&
333: (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})))
334: || ($ENV{'request.role'}=~/^(au|dc|su)/)
335: ) { return ''; }
1.74 www 336: return (<<'ENDSTDBRW');
337: <script type="text/javascript" language="Javascript" >
338: var stdeditbrowser;
1.111 www 339: function openstdbrowser(formname,uname,udom,roleflag) {
1.74 www 340: var url = '/adm/pickstudent?';
341: var filter;
342: eval('filter=document.'+formname+'.'+uname+'.value;');
343: if (filter != null) {
344: if (filter != '') {
345: url += 'filter='+filter+'&';
346: }
347: }
348: url += 'form=' + formname + '&unameelement='+uname+
349: '&udomelement='+udom;
1.111 www 350: if (roleflag) { url+="&roles=1"; }
1.102 www 351: var title = 'Student_Browser';
1.74 www 352: var options = 'scrollbars=1,resizable=1,menubar=0';
353: options += ',width=700,height=600';
354: stdeditbrowser = open(url,title,options,'1');
355: stdeditbrowser.focus();
356: }
357: </script>
358: ENDSTDBRW
359: }
1.42 matthew 360:
1.74 www 361: sub selectstudent_link {
1.111 www 362: my ($form,$unameele,$udomele)=@_;
363: if ($ENV{'request.course.id'}) {
364: unless (&Apache::lonnet::allowed('srm',$ENV{'request.course.id'})) {
365: return '';
366: }
367: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 368: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 369: }
1.111 www 370: if ($ENV{'request.role'}=~/^(au|dc|su)/) {
371: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 372: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 373: }
374: return '';
1.91 www 375: }
376:
377: sub coursebrowser_javascript {
1.234 raeburn 378: my ($domainfilter)=@_;
1.128 albertel 379: return (<<ENDSTDBRW);
1.91 www 380: <script type="text/javascript" language="Javascript" >
381: var stdeditbrowser;
1.234 raeburn 382: function opencrsbrowser(formname,uname,udom,desc,extra_element) {
1.91 www 383: var url = '/adm/pickcourse?';
384: var filter;
385: if (filter != null) {
386: if (filter != '') {
387: url += 'filter='+filter+'&';
388: }
389: }
1.128 albertel 390: var domainfilter='$domainfilter';
391: if (domainfilter != null) {
392: if (domainfilter != '') {
393: url += 'domainfilter='+domainfilter+'&';
394: }
395: }
1.91 www 396: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 397: '&cdomelement='+udom+
398: '&cnameelement='+desc;
1.234 raeburn 399: if (extra_element !=null && extra_element != '' && formname == 'rolechoice') {
400: url += '&roleelement='+extra_element;
401: if (domainfilter == null || domainfilter == '') {
402: url += '&domainfilter='+extra_element;
403: }
1.230 raeburn 404: }
1.102 www 405: var title = 'Course_Browser';
1.91 www 406: var options = 'scrollbars=1,resizable=1,menubar=0';
407: options += ',width=700,height=600';
408: stdeditbrowser = open(url,title,options,'1');
409: stdeditbrowser.focus();
410: }
411: </script>
412: ENDSTDBRW
413: }
414:
415: sub selectcourse_link {
1.234 raeburn 416: my ($form,$unameele,$udomele,$desc,$extra_element)=@_;
1.91 www 417: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
1.234 raeburn 418: '","'.$udomele.'","'.$desc.'","'.$extra_element.'");'."'>".&mt('Select Course')."</a>";
1.74 www 419: }
1.42 matthew 420:
421: =pod
1.36 matthew 422:
1.112 bowersj2 423: =item * linked_select_forms(...)
1.36 matthew 424:
425: linked_select_forms returns a string containing a <script></script> block
426: and html for two <select> menus. The select menus will be linked in that
427: changing the value of the first menu will result in new values being placed
428: in the second menu. The values in the select menu will appear in alphabetical
429: order.
430:
431: linked_select_forms takes the following ordered inputs:
432:
433: =over 4
434:
1.112 bowersj2 435: =item * $formname, the name of the <form> tag
1.36 matthew 436:
1.112 bowersj2 437: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 438:
1.112 bowersj2 439: =item * $firstdefault, the default value for the first menu
1.36 matthew 440:
1.112 bowersj2 441: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 442:
1.112 bowersj2 443: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 444:
1.112 bowersj2 445: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 446:
1.41 ng 447: =back
448:
1.36 matthew 449: Below is an example of such a hash. Only the 'text', 'default', and
450: 'select2' keys must appear as stated. keys(%menu) are the possible
451: values for the first select menu. The text that coincides with the
1.41 ng 452: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 453: and text for the second menu are given in the hash pointed to by
454: $menu{$choice1}->{'select2'}.
455:
1.112 bowersj2 456: my %menu = ( A1 => { text =>"Choice A1" ,
457: default => "B3",
458: select2 => {
459: B1 => "Choice B1",
460: B2 => "Choice B2",
461: B3 => "Choice B3",
462: B4 => "Choice B4"
463: }
464: },
465: A2 => { text =>"Choice A2" ,
466: default => "C2",
467: select2 => {
468: C1 => "Choice C1",
469: C2 => "Choice C2",
470: C3 => "Choice C3"
471: }
472: },
473: A3 => { text =>"Choice A3" ,
474: default => "D6",
475: select2 => {
476: D1 => "Choice D1",
477: D2 => "Choice D2",
478: D3 => "Choice D3",
479: D4 => "Choice D4",
480: D5 => "Choice D5",
481: D6 => "Choice D6",
482: D7 => "Choice D7"
483: }
484: }
485: );
1.36 matthew 486:
487: =cut
488:
489: sub linked_select_forms {
490: my ($formname,
491: $middletext,
492: $firstdefault,
493: $firstselectname,
494: $secondselectname,
495: $hashref
496: ) = @_;
497: my $second = "document.$formname.$secondselectname";
498: my $first = "document.$formname.$firstselectname";
499: # output the javascript to do the changing
500: my $result = '';
1.219 albertel 501: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 502: $result.="var select2data = new Object();\n";
503: $" = '","';
504: my $debug = '';
505: foreach my $s1 (sort(keys(%$hashref))) {
506: $result.="select2data.d_$s1 = new Object();\n";
507: $result.="select2data.d_$s1.def = new String('".
508: $hashref->{$s1}->{'default'}."');\n";
509: $result.="select2data.d_$s1.values = new Array(";
510: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
511: $result.="\"@s2values\");\n";
512: $result.="select2data.d_$s1.texts = new Array(";
513: my @s2texts;
514: foreach my $value (@s2values) {
515: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
516: }
517: $result.="\"@s2texts\");\n";
518: }
519: $"=' ';
520: $result.= <<"END";
521:
522: function select1_changed() {
523: // Determine new choice
524: var newvalue = "d_" + $first.value;
525: // update select2
526: var values = select2data[newvalue].values;
527: var texts = select2data[newvalue].texts;
528: var select2def = select2data[newvalue].def;
529: var i;
530: // out with the old
531: for (i = 0; i < $second.options.length; i++) {
532: $second.options[i] = null;
533: }
534: // in with the nuclear
535: for (i=0;i<values.length; i++) {
536: $second.options[i] = new Option(values[i]);
1.143 matthew 537: $second.options[i].value = values[i];
1.36 matthew 538: $second.options[i].text = texts[i];
539: if (values[i] == select2def) {
540: $second.options[i].selected = true;
541: }
542: }
543: }
544: </script>
545: END
546: # output the initial values for the selection lists
547: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
548: foreach my $value (sort(keys(%$hashref))) {
549: $result.=" <option value=\"$value\" ";
1.253 ! albertel 550: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 551: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 552: }
553: $result .= "</select>\n";
554: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
555: $result .= $middletext;
556: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
557: my $seconddefault = $hashref->{$firstdefault}->{'default'};
558: foreach my $value (sort(keys(%select2))) {
559: $result.=" <option value=\"$value\" ";
1.253 ! albertel 560: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 561: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 562: }
563: $result .= "</select>\n";
564: # return $debug;
565: return $result;
566: } # end of sub linked_select_forms {
567:
1.45 matthew 568: =pod
1.44 bowersj2 569:
1.112 bowersj2 570: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44 bowersj2 571:
1.112 bowersj2 572: Returns a string corresponding to an HTML link to the given help
573: $topic, where $topic corresponds to the name of a .tex file in
574: /home/httpd/html/adm/help/tex, with underscores replaced by
575: spaces.
576:
577: $text will optionally be linked to the same topic, allowing you to
578: link text in addition to the graphic. If you do not want to link
579: text, but wish to specify one of the later parameters, pass an
580: empty string.
581:
582: $stayOnPage is a value that will be interpreted as a boolean. If true,
583: the link will not open a new window. If false, the link will open
584: a new window using Javascript. (Default is false.)
585:
586: $width and $height are optional numerical parameters that will
587: override the width and height of the popped up window, which may
588: be useful for certain help topics with big pictures included.
1.44 bowersj2 589:
590: =cut
591:
592: sub help_open_topic {
1.48 bowersj2 593: my ($topic, $text, $stayOnPage, $width, $height) = @_;
594: $text = "" if (not defined $text);
1.44 bowersj2 595: $stayOnPage = 0 if (not defined $stayOnPage);
1.108 bowersj2 596: if ($ENV{'browser.interface'} eq 'textual' ||
597: $ENV{'environment.remote'} eq 'off' ) {
1.79 www 598: $stayOnPage=1;
599: }
1.44 bowersj2 600: $width = 350 if (not defined $width);
601: $height = 400 if (not defined $height);
602: my $filename = $topic;
603: $filename =~ s/ /_/g;
604:
1.48 bowersj2 605: my $template = "";
606: my $link;
1.159 www 607:
608: $topic=~s/\W/\_/g;
1.44 bowersj2 609:
610: if (!$stayOnPage)
611: {
1.72 bowersj2 612: $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 613: }
614: else
615: {
1.48 bowersj2 616: $link = "/adm/help/${filename}.hlp";
617: }
618:
619: # Add the text
620: if ($text ne "")
621: {
1.77 www 622: $template .=
623: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.78 www 624: "<td bgcolor='#5555FF'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 625: }
626:
627: # Add the graphic
1.179 matthew 628: my $title = &mt('Online Help');
1.215 albertel 629: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48 bowersj2 630: $template .= <<"ENDTEMPLATE";
1.218 albertel 631: <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 632: ENDTEMPLATE
1.78 www 633: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 634: return $template;
635:
1.106 bowersj2 636: }
637:
638: # This is a quicky function for Latex cheatsheet editing, since it
639: # appears in at least four places
640: sub helpLatexCheatsheet {
641: my $other = shift;
642: my $addOther = '';
643: if ($other) {
644: $addOther = Apache::loncommon::help_open_topic($other, shift,
645: undef, undef, 600) .
646: '</td><td>';
647: }
648: return '<table><tr><td>'.
649: $addOther .
650: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
651: undef,undef,600)
652: .'</td><td>'.
653: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
654: undef,undef,600)
655: .'</td></tr></table>';
1.172 www 656: }
657:
1.193 raeburn 658: sub help_open_menu {
659: my ($color,$topic,$component_help,$function,$faq,$bug,$stayOnPage,$width,$height,$text) = @_;
660: $text = "" if (not defined $text);
661: $stayOnPage = 0 if (not defined $stayOnPage);
662: if ($ENV{'browser.interface'} eq 'textual' ||
663: $ENV{'environment.remote'} eq 'off' ) {
664: $stayOnPage=1;
665: }
666: $width = 620 if (not defined $width);
667: $height = 600 if (not defined $height);
668: my $link='';
1.201 raeburn 669: my $title = &mt('Get help');
1.193 raeburn 670: my $origurl = $ENV{'REQUEST_URI'};
1.227 albertel 671: $origurl=~s|^/~|/priv/|;
1.193 raeburn 672: my $timestamp = time;
673: foreach (\$color,\$function,\$topic,\$component_help,\$faq,\$bug,\$origurl) {
674: $$_ = &Apache::lonnet::escape($$_);
675: }
676:
1.195 albertel 677: if (!$stayOnPage) {
1.193 raeburn 678: $link = "javascript:helpMenu('open')";
1.195 albertel 679: } else {
1.193 raeburn 680: $link = "javascript:helpMenu('display')";
681: }
1.198 raeburn 682: 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 683: 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 684: my $template;
685: if ($text ne "") {
686: $template .=
1.211 www 687: "<table bgcolor='#773311' cellspacing='1' cellpadding='1' border='0'><tr>".
688: "<td bgcolor='#886622'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.196 albertel 689: }
1.250 albertel 690: my $html=&Apache::lonxml::xmlbegin();
1.215 albertel 691: my $helpicon=&lonhttpdurl("/adm/lonIcons/helpgateway.gif");
1.196 albertel 692: $template .= <<"ENDTEMPLATE";
1.219 albertel 693: <script type="text/javascript">
1.253 ! albertel 694: // <!-- BEGIN LON-CAPA Internal
! 695: // <![CDATA[
1.243 raeburn 696: function helpMenu(target) {
697: var caller = this;
698: if (target == 'open') {
699: var newWindow = null;
700: try {
1.250 albertel 701: newWindow = window.open("/adm/rat/empty.html","helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 702: }
703: catch(error) {
704: writeHelp(caller);
705: return;
706: }
707: if (newWindow) {
708: caller = newWindow;
709: }
1.193 raeburn 710: }
1.243 raeburn 711: writeHelp(caller);
712: return;
713: }
714: function writeHelp(caller) {
1.250 albertel 715: caller.document.write('$html<head><title>LON-CAPA Help Menu</title><meta http-equiv="pragma" content="no-cache"></head>')
1.243 raeburn 716: caller.document.write("<frameset rows='105,*' border='0'><frame name='bannerframe' src='$banner_link'><frame name='bodyframe' src='$details_link'></frameset>")
717: caller.document.write("</html>")
718: caller.document.close()
719: caller.focus()
1.193 raeburn 720: }
1.253 ! albertel 721: // ]]>
1.219 albertel 722: // END LON-CAPA Internal -->
1.193 raeburn 723: </script>
1.218 albertel 724: <a href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help Menu)" /></a>
1.193 raeburn 725: ENDTEMPLATE
1.203 albertel 726: if ($component_help) {
727: if (!$text) {
728: $template=&help_open_topic($component_help,undef,$stayOnPage,
729: $width,$height).' '.$template;
730: } else {
731: my $help_text;
732: $help_text=&Apache::lonnet::unescape($topic);
733: $template='<table><tr><td>'.
734: &help_open_topic($component_help,$help_text,$stayOnPage,
735: $width,$height).'</td><td>'.$template.
736: '</td></tr></table>';
737: }
738: }
1.196 albertel 739: if ($text ne '') { $template.='</td></tr></table>' };
1.193 raeburn 740: return $template;
741: }
742:
1.172 www 743: sub help_open_bug {
744: my ($topic, $text, $stayOnPage, $width, $height) = @_;
745: unless ($ENV{'user.adv'}) { return ''; }
746: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
747: $text = "" if (not defined $text);
748: $stayOnPage = 0 if (not defined $stayOnPage);
749: if ($ENV{'browser.interface'} eq 'textual' ||
750: $ENV{'environment.remote'} eq 'off' ) {
751: $stayOnPage=1;
752: }
1.184 albertel 753: $width = 600 if (not defined $width);
754: $height = 600 if (not defined $height);
1.172 www 755:
756: $topic=~s/\W+/\+/g;
757: my $link='';
758: my $template='';
759: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
760: &Apache::lonnet::escape($ENV{'REQUEST_URI'}).'&component='.$topic;
761: if (!$stayOnPage)
762: {
763: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
764: }
765: else
766: {
767: $link = $url;
768: }
769: # Add the text
770: if ($text ne "")
771: {
772: $template .=
773: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
774: "<td bgcolor='#FF5555'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
775: }
776:
777: # Add the graphic
1.179 matthew 778: my $title = &mt('Report a Bug');
1.215 albertel 779: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 780: $template .= <<"ENDTEMPLATE";
1.218 albertel 781: <a href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 782: ENDTEMPLATE
783: if ($text ne '') { $template.='</td></tr></table>' };
784: return $template;
785:
786: }
787:
788: sub help_open_faq {
789: my ($topic, $text, $stayOnPage, $width, $height) = @_;
790: unless ($ENV{'user.adv'}) { return ''; }
791: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
792: $text = "" if (not defined $text);
793: $stayOnPage = 0 if (not defined $stayOnPage);
794: if ($ENV{'browser.interface'} eq 'textual' ||
795: $ENV{'environment.remote'} eq 'off' ) {
796: $stayOnPage=1;
797: }
798: $width = 350 if (not defined $width);
799: $height = 400 if (not defined $height);
800:
801: $topic=~s/\W+/\+/g;
802: my $link='';
803: my $template='';
804: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
805: if (!$stayOnPage)
806: {
807: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
808: }
809: else
810: {
811: $link = $url;
812: }
813:
814: # Add the text
815: if ($text ne "")
816: {
817: $template .=
1.173 www 818: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
819: "<td bgcolor='#448844'><a href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 820: }
821:
822: # Add the graphic
1.179 matthew 823: my $title = &mt('View the FAQ');
1.215 albertel 824: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 825: $template .= <<"ENDTEMPLATE";
1.218 albertel 826: <a href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 827: ENDTEMPLATE
828: if ($text ne '') { $template.='</td></tr></table>' };
829: return $template;
830:
1.44 bowersj2 831: }
1.37 matthew 832:
1.180 matthew 833: ###############################################################
834: ###############################################################
835:
1.45 matthew 836: =pod
837:
1.112 bowersj2 838: =item * csv_translate($text)
1.37 matthew 839:
1.185 www 840: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 841: format.
842:
843: =cut
844:
1.180 matthew 845: ###############################################################
846: ###############################################################
1.37 matthew 847: sub csv_translate {
848: my $text = shift;
849: $text =~ s/\"/\"\"/g;
1.209 albertel 850: $text =~ s/\n/ /g;
1.37 matthew 851: return $text;
852: }
1.180 matthew 853:
854:
855: ###############################################################
856: ###############################################################
857:
858: =pod
859:
860: =item * define_excel_formats
861:
862: Define some commonly used Excel cell formats.
863:
864: Currently supported formats:
865:
866: =over 4
867:
868: =item header
869:
870: =item bold
871:
872: =item h1
873:
874: =item h2
875:
876: =item h3
877:
878: =item date
879:
880: =back
881:
882: Inputs: $workbook
883:
884: Returns: $format, a hash reference.
885:
886: =cut
887:
888: ###############################################################
889: ###############################################################
890: sub define_excel_formats {
891: my ($workbook) = @_;
892: my $format;
893: $format->{'header'} = $workbook->add_format(bold => 1,
894: bottom => 1,
895: align => 'center');
896: $format->{'bold'} = $workbook->add_format(bold=>1);
897: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
898: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
899: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.246 matthew 900: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 901: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 902: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 903: return $format;
904: }
905:
906: ###############################################################
907: ###############################################################
1.113 bowersj2 908:
909: =pod
910:
911: =item * change_content_javascript():
912:
913: This and the next function allow you to create small sections of an
914: otherwise static HTML page that you can update on the fly with
915: Javascript, even in Netscape 4.
916:
917: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
918: must be written to the HTML page once. It will prove the Javascript
919: function "change(name, content)". Calling the change function with the
920: name of the section
921: you want to update, matching the name passed to C<changable_area>, and
922: the new content you want to put in there, will put the content into
923: that area.
924:
925: B<Note>: Netscape 4 only reserves enough space for the changable area
926: to contain room for the original contents. You need to "make space"
927: for whatever changes you wish to make, and be B<sure> to check your
928: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
929: it's adequate for updating a one-line status display, but little more.
930: This script will set the space to 100% width, so you only need to
931: worry about height in Netscape 4.
932:
933: Modern browsers are much less limiting, and if you can commit to the
934: user not using Netscape 4, this feature may be used freely with
935: pretty much any HTML.
936:
937: =cut
938:
939: sub change_content_javascript {
940: # If we're on Netscape 4, we need to use Layer-based code
941: if ($ENV{'browser.type'} eq 'netscape' &&
942: $ENV{'browser.version'} =~ /^4\./) {
943: return (<<NETSCAPE4);
944: function change(name, content) {
945: doc = document.layers[name+"___escape"].layers[0].document;
946: doc.open();
947: doc.write(content);
948: doc.close();
949: }
950: NETSCAPE4
951: } else {
952: # Otherwise, we need to use semi-standards-compliant code
953: # (technically, "innerHTML" isn't standard but the equivalent
954: # is really scary, and every useful browser supports it
955: return (<<DOMBASED);
956: function change(name, content) {
957: element = document.getElementById(name);
958: element.innerHTML = content;
959: }
960: DOMBASED
961: }
962: }
963:
964: =pod
965:
966: =item * changable_area($name, $origContent):
967:
968: This provides a "changable area" that can be modified on the fly via
969: the Javascript code provided in C<change_content_javascript>. $name is
970: the name you will use to reference the area later; do not repeat the
971: same name on a given HTML page more then once. $origContent is what
972: the area will originally contain, which can be left blank.
973:
974: =cut
975:
976: sub changable_area {
977: my ($name, $origContent) = @_;
978:
979: if ($ENV{'browser.type'} eq 'netscape' &&
980: $ENV{'browser.version'} =~ /^4\./) {
981: # If this is netscape 4, we need to use the Layer tag
982: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
983: } else {
984: return "<span id='$name'>$origContent</span>";
985: }
986: }
987:
988: =pod
989:
990: =back
991:
992: =cut
1.37 matthew 993:
994: ###############################################################
1.33 matthew 995: ## Home server <option> list generating code ##
996: ###############################################################
1.35 matthew 997:
1.45 matthew 998: =pod
999:
1.112 bowersj2 1000: =head1 Home Server option list generating code
1001:
1002: =over 4
1003:
1004: =item * get_domains()
1.35 matthew 1005:
1006: Returns an array containing each of the domains listed in the hosts.tab
1007: file.
1008:
1009: =cut
1010:
1011: #-------------------------------------------
1.34 matthew 1012: sub get_domains {
1013: # The code below was stolen from "The Perl Cookbook", p 102, 1st ed.
1014: my @domains;
1015: my %seen;
1016: foreach (sort values(%Apache::lonnet::hostdom)) {
1.169 www 1017: push (@domains,$_) unless $seen{$_}++;
1.34 matthew 1018: }
1019: return @domains;
1020: }
1.88 www 1021:
1.169 www 1022: # ------------------------------------------
1023:
1024: sub domain_select {
1025: my ($name,$value,$multiple)=@_;
1026: my %domains=map {
1027: $_ => $_.' '.$Apache::lonnet::domaindescription{$_}
1028: } &get_domains;
1029: if ($multiple) {
1030: $domains{''}=&mt('Any domain');
1.191 matthew 1031: return &multiple_select_form($name,$value,4,%domains);
1.169 www 1032: } else {
1033: return &select_form($name,$value,%domains);
1034: }
1035: }
1036:
1037: sub multiple_select_form {
1.191 matthew 1038: my ($name,$value,$size,%hash)=@_;
1.169 www 1039: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1040: my $output='';
1.191 matthew 1041: if (! defined($size)) {
1042: $size = 4;
1043: if (scalar(keys(%hash))<4) {
1044: $size = scalar(keys(%hash));
1045: }
1046: }
1.169 www 1047: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.191 matthew 1048: foreach (sort(keys(%hash))) {
1049: $output.='<option value="'.$_.'" ';
1.253 ! albertel 1050: $output.='selected="selected" ' if ($selected{$_});
1.191 matthew 1051: $output.='>'.$hash{$_}."</option>\n";
1.169 www 1052: }
1053: $output.="</select>\n";
1054: return $output;
1055: }
1056:
1.88 www 1057: #-------------------------------------------
1058:
1059: =pod
1060:
1.112 bowersj2 1061: =item * select_form($defdom,$name,%hash)
1.88 www 1062:
1063: Returns a string containing a <select name='$name' size='1'> form to
1064: allow a user to select options from a hash option_name => displayed text.
1065: See lonrights.pm for an example invocation and use.
1066:
1067: =cut
1068:
1069: #-------------------------------------------
1070: sub select_form {
1071: my ($def,$name,%hash) = @_;
1072: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1073: my @keys;
1074: if (exists($hash{'select_form_order'})) {
1075: @keys=@{$hash{'select_form_order'}};
1076: } else {
1077: @keys=sort(keys(%hash));
1078: }
1079: foreach (@keys) {
1.88 www 1080: $selectform.="<option value=\"$_\" ".
1.253 ! albertel 1081: ($_ eq $def ? 'selected="selected" ' : '').
1.119 www 1082: ">".&mt($hash{$_})."</option>\n";
1.88 www 1083: }
1084: $selectform.="</select>";
1085: return $selectform;
1086: }
1087:
1.167 www 1088: sub gradeleveldescription {
1089: my $gradelevel=shift;
1090: my %gradelevels=(0 => 'Not specified',
1091: 1 => 'Grade 1',
1092: 2 => 'Grade 2',
1093: 3 => 'Grade 3',
1094: 4 => 'Grade 4',
1095: 5 => 'Grade 5',
1096: 6 => 'Grade 6',
1097: 7 => 'Grade 7',
1098: 8 => 'Grade 8',
1099: 9 => 'Grade 9',
1100: 10 => 'Grade 10',
1101: 11 => 'Grade 11',
1102: 12 => 'Grade 12',
1103: 13 => 'Grade 13',
1104: 14 => '100 Level',
1105: 15 => '200 Level',
1106: 16 => '300 Level',
1107: 17 => '400 Level',
1108: 18 => 'Graduate Level');
1109: return &mt($gradelevels{$gradelevel});
1110: }
1111:
1.163 www 1112: sub select_level_form {
1113: my ($deflevel,$name)=@_;
1114: unless ($deflevel) { $deflevel=0; }
1.167 www 1115: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1116: for (my $i=0; $i<=18; $i++) {
1117: $selectform.="<option value=\"$i\" ".
1.253 ! albertel 1118: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1119: ">".&gradeleveldescription($i)."</option>\n";
1120: }
1121: $selectform.="</select>";
1122: return $selectform;
1.163 www 1123: }
1.167 www 1124:
1.35 matthew 1125: #-------------------------------------------
1126:
1.45 matthew 1127: =pod
1128:
1.112 bowersj2 1129: =item * select_dom_form($defdom,$name,$includeempty)
1.35 matthew 1130:
1131: Returns a string containing a <select name='$name' size='1'> form to
1132: allow a user to select the domain to preform an operation in.
1133: See loncreateuser.pm for an example invocation and use.
1134:
1.90 www 1135: If the $includeempty flag is set, it also includes an empty choice ("no domain
1136: selected");
1137:
1.35 matthew 1138: =cut
1139:
1140: #-------------------------------------------
1.34 matthew 1141: sub select_dom_form {
1.90 www 1142: my ($defdom,$name,$includeempty) = @_;
1.34 matthew 1143: my @domains = get_domains();
1.90 www 1144: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1145: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1146: foreach (@domains) {
1147: $selectdomain.="<option value=\"$_\" ".
1.253 ! albertel 1148: ($_ eq $defdom ? 'selected="selected" ' : '').
1.34 matthew 1149: ">$_</option>\n";
1150: }
1151: $selectdomain.="</select>";
1152: return $selectdomain;
1153: }
1154:
1.35 matthew 1155: #-------------------------------------------
1156:
1.45 matthew 1157: =pod
1158:
1.112 bowersj2 1159: =item * get_library_servers($domain)
1.35 matthew 1160:
1161: Returns a hash which contains keys like '103l3' and values like
1162: 'kirk.lite.msu.edu'. All of the keys will be for machines in the
1163: given $domain.
1164:
1165: =cut
1166:
1167: #-------------------------------------------
1.52 matthew 1168: sub get_library_servers {
1.33 matthew 1169: my $domain = shift;
1.52 matthew 1170: my %library_servers;
1.33 matthew 1171: foreach (keys(%Apache::lonnet::libserv)) {
1172: if ($Apache::lonnet::hostdom{$_} eq $domain) {
1.52 matthew 1173: $library_servers{$_} = $Apache::lonnet::hostname{$_};
1.33 matthew 1174: }
1175: }
1.52 matthew 1176: return %library_servers;
1.33 matthew 1177: }
1178:
1.35 matthew 1179: #-------------------------------------------
1180:
1.45 matthew 1181: =pod
1182:
1.112 bowersj2 1183: =item * home_server_option_list($domain)
1.35 matthew 1184:
1185: returns a string which contains an <option> list to be used in a
1186: <select> form input. See loncreateuser.pm for an example.
1187:
1188: =cut
1189:
1190: #-------------------------------------------
1.33 matthew 1191: sub home_server_option_list {
1192: my $domain = shift;
1.52 matthew 1193: my %servers = &get_library_servers($domain);
1.33 matthew 1194: my $result = '';
1195: foreach (sort keys(%servers)) {
1196: $result.=
1197: '<option value="'.$_.'">'.$_.' '.$servers{$_}."</option>\n";
1198: }
1199: return $result;
1200: }
1.112 bowersj2 1201:
1202: =pod
1203:
1204: =back
1205:
1206: =cut
1.87 matthew 1207:
1208: ###############################################################
1.112 bowersj2 1209: ## Decoding User Agent ##
1.87 matthew 1210: ###############################################################
1211:
1212: =pod
1213:
1.112 bowersj2 1214: =head1 Decoding the User Agent
1215:
1216: =over 4
1217:
1218: =item * &decode_user_agent()
1.87 matthew 1219:
1220: Inputs: $r
1221:
1222: Outputs:
1223:
1224: =over 4
1225:
1.112 bowersj2 1226: =item * $httpbrowser
1.87 matthew 1227:
1.112 bowersj2 1228: =item * $clientbrowser
1.87 matthew 1229:
1.112 bowersj2 1230: =item * $clientversion
1.87 matthew 1231:
1.112 bowersj2 1232: =item * $clientmathml
1.87 matthew 1233:
1.112 bowersj2 1234: =item * $clientunicode
1.87 matthew 1235:
1.112 bowersj2 1236: =item * $clientos
1.87 matthew 1237:
1238: =back
1239:
1.157 matthew 1240: =back
1241:
1.87 matthew 1242: =cut
1243:
1244: ###############################################################
1245: ###############################################################
1246: sub decode_user_agent {
1.247 albertel 1247: my ($r)=@_;
1.87 matthew 1248: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1249: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1250: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1251: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1252: my $clientbrowser='unknown';
1253: my $clientversion='0';
1254: my $clientmathml='';
1255: my $clientunicode='0';
1256: for (my $i=0;$i<=$#browsertype;$i++) {
1257: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1258: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1259: $clientbrowser=$bname;
1260: $httpbrowser=~/$vreg/i;
1261: $clientversion=$1;
1262: $clientmathml=($clientversion>=$minv);
1263: $clientunicode=($clientversion>=$univ);
1264: }
1265: }
1266: my $clientos='unknown';
1267: if (($httpbrowser=~/linux/i) ||
1268: ($httpbrowser=~/unix/i) ||
1269: ($httpbrowser=~/ux/i) ||
1270: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1271: if (($httpbrowser=~/vax/i) ||
1272: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1273: if ($httpbrowser=~/next/i) { $clientos='next'; }
1274: if (($httpbrowser=~/mac/i) ||
1275: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1276: if ($httpbrowser=~/win/i) { $clientos='win'; }
1277: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1278: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1279: $clientunicode,$clientos,);
1280: }
1281:
1.32 matthew 1282: ###############################################################
1283: ## Authentication changing form generation subroutines ##
1284: ###############################################################
1285: ##
1286: ## All of the authform_xxxxxxx subroutines take their inputs in a
1287: ## hash, and have reasonable default values.
1288: ##
1289: ## formname = the name given in the <form> tag.
1.35 matthew 1290: #-------------------------------------------
1291:
1.45 matthew 1292: =pod
1293:
1.112 bowersj2 1294: =head1 Authentication Routines
1295:
1296: =over 4
1297:
1298: =item * authform_xxxxxx
1.35 matthew 1299:
1300: The authform_xxxxxx subroutines provide javascript and html forms which
1301: handle some of the conveniences required for authentication forms.
1302: This is not an optimal method, but it works.
1303:
1304: See loncreateuser.pm for invocation and use examples.
1305:
1306: =over 4
1307:
1.112 bowersj2 1308: =item * authform_header
1.35 matthew 1309:
1.112 bowersj2 1310: =item * authform_authorwarning
1.35 matthew 1311:
1.112 bowersj2 1312: =item * authform_nochange
1.35 matthew 1313:
1.112 bowersj2 1314: =item * authform_kerberos
1.35 matthew 1315:
1.112 bowersj2 1316: =item * authform_internal
1.35 matthew 1317:
1.112 bowersj2 1318: =item * authform_filesystem
1.35 matthew 1319:
1320: =back
1321:
1.157 matthew 1322: =back
1323:
1.35 matthew 1324: =cut
1325:
1326: #-------------------------------------------
1.32 matthew 1327: sub authform_header{
1328: my %in = (
1329: formname => 'cu',
1.80 albertel 1330: kerb_def_dom => '',
1.32 matthew 1331: @_,
1332: );
1333: $in{'formname'} = 'document.' . $in{'formname'};
1334: my $result='';
1.80 albertel 1335:
1336: #---------------------------------------------- Code for upper case translation
1337: my $Javascript_toUpperCase;
1338: unless ($in{kerb_def_dom}) {
1339: $Javascript_toUpperCase =<<"END";
1340: switch (choice) {
1341: case 'krb': currentform.elements[choicearg].value =
1342: currentform.elements[choicearg].value.toUpperCase();
1343: break;
1344: default:
1345: }
1346: END
1347: } else {
1348: $Javascript_toUpperCase = "";
1349: }
1350:
1.165 raeburn 1351: my $radioval = "'nochange'";
1.174 matthew 1352: if (exists($in{'curr_authtype'}) &&
1353: defined($in{'curr_authtype'}) &&
1354: $in{'curr_authtype'} ne '') {
1355: $radioval = "'$in{'curr_authtype'}arg'";
1356: }
1.165 raeburn 1357: my $argfield = 'null';
1358: if ( grep/^mode$/,(keys %in) ) {
1359: if ($in{'mode'} eq 'modifycourse') {
1360: if ( grep/^curr_authtype$/,(keys %in) ) {
1361: $radioval = "'$in{'curr_authtype'}'";
1362: }
1363: if ( grep/^curr_autharg$/,(keys %in) ) {
1364: unless ($in{'curr_autharg'} eq '') {
1365: $argfield = "'$in{'curr_autharg'}'";
1366: }
1367: }
1368: }
1369: }
1370:
1.32 matthew 1371: $result.=<<"END";
1372: var current = new Object();
1.165 raeburn 1373: current.radiovalue = $radioval;
1374: current.argfield = $argfield;
1.32 matthew 1375:
1376: function changed_radio(choice,currentform) {
1377: var choicearg = choice + 'arg';
1378: // If a radio button in changed, we need to change the argfield
1379: if (current.radiovalue != choice) {
1380: current.radiovalue = choice;
1381: if (current.argfield != null) {
1382: currentform.elements[current.argfield].value = '';
1383: }
1384: if (choice == 'nochange') {
1385: current.argfield = null;
1386: } else {
1387: current.argfield = choicearg;
1388: switch(choice) {
1389: case 'krb':
1390: currentform.elements[current.argfield].value =
1391: "$in{'kerb_def_dom'}";
1392: break;
1393: default:
1394: break;
1395: }
1396: }
1397: }
1398: return;
1399: }
1.22 www 1400:
1.32 matthew 1401: function changed_text(choice,currentform) {
1402: var choicearg = choice + 'arg';
1403: if (currentform.elements[choicearg].value !='') {
1.80 albertel 1404: $Javascript_toUpperCase
1.32 matthew 1405: // clear old field
1406: if ((current.argfield != choicearg) && (current.argfield != null)) {
1407: currentform.elements[current.argfield].value = '';
1408: }
1409: current.argfield = choicearg;
1410: }
1411: set_auth_radio_buttons(choice,currentform);
1412: return;
1.20 www 1413: }
1.32 matthew 1414:
1415: function set_auth_radio_buttons(newvalue,currentform) {
1416: var i=0;
1417: while (i < currentform.login.length) {
1418: if (currentform.login[i].value == newvalue) { break; }
1419: i++;
1420: }
1421: if (i == currentform.login.length) {
1422: return;
1423: }
1424: current.radiovalue = newvalue;
1425: currentform.login[i].checked = true;
1426: return;
1427: }
1428: END
1429: return $result;
1430: }
1431:
1432: sub authform_authorwarning{
1433: my $result='';
1.144 matthew 1434: $result='<i>'.
1435: &mt('As a general rule, only authors or co-authors should be '.
1436: 'filesystem authenticated '.
1437: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 1438: return $result;
1439: }
1440:
1441: sub authform_nochange{
1442: my %in = (
1443: formname => 'document.cu',
1444: kerb_def_dom => 'MSU.EDU',
1445: @_,
1446: );
1.144 matthew 1447: my $result = &mt('[_1] Do not change login data',
1448: '<input type="radio" name="login" value="nochange" '.
1449: 'checked="checked" onclick="'.
1450: "javascript:changed_radio('nochange',$in{'formname'});".'" />');
1.32 matthew 1451: return $result;
1452: }
1453:
1454: sub authform_kerberos{
1455: my %in = (
1456: formname => 'document.cu',
1457: kerb_def_dom => 'MSU.EDU',
1.80 albertel 1458: kerb_def_auth => 'krb4',
1.32 matthew 1459: @_,
1460: );
1.165 raeburn 1461: my ($check4,$check5,$krbarg);
1.80 albertel 1462: if ($in{'kerb_def_auth'} eq 'krb5') {
1463: $check5 = " checked=\"on\"";
1464: } else {
1465: $check4 = " checked=\"on\"";
1466: }
1.165 raeburn 1467: $krbarg = $in{'kerb_def_dom'};
1468:
1469: my $krbcheck = "";
1470: if ( grep/^curr_authtype$/,(keys %in) ) {
1471: if ($in{'curr_authtype'} =~ m/^krb/) {
1472: $krbcheck = " checked=\"on\"";
1473: if ( grep/^curr_autharg$/,(keys %in) ) {
1474: $krbarg = $in{'curr_autharg'};
1475: }
1476: }
1477: }
1478:
1.144 matthew 1479: my $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1480: my $result .= &mt
1481: ('[_1] Kerberos authenticated with domain [_2] '.
1482: '[_3] Version 4 [_4] Version 5',
1483: '<input type="radio" name="login" value="krb" '.
1.165 raeburn 1484: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.$krbcheck.' />',
1.144 matthew 1485: '<input type="text" size="10" name="krbarg" '.
1.165 raeburn 1486: 'value="'.$krbarg.'" '.
1.144 matthew 1487: 'onchange="'.$jscall.'" />',
1488: '<input type="radio" name="krbver" value="4" '.$check4.' />',
1489: '<input type="radio" name="krbver" value="5" '.$check5.' />');
1.32 matthew 1490: return $result;
1491: }
1492:
1493: sub authform_internal{
1494: my %args = (
1495: formname => 'document.cu',
1496: kerb_def_dom => 'MSU.EDU',
1497: @_,
1498: );
1.165 raeburn 1499:
1500: my $intcheck = "";
1501: my $intarg = 'value=""';
1502: if ( grep/^curr_authtype$/,(keys %args) ) {
1503: if ($args{'curr_authtype'} eq 'int') {
1504: $intcheck = " checked=\"on\"";
1505: if ( grep/^curr_autharg$/,(keys %args) ) {
1506: $intarg = "value=\"$args{'curr_autharg'}\"";
1507: }
1508: }
1509: }
1510:
1.144 matthew 1511: my $jscall = "javascript:changed_radio('int',$args{'formname'});";
1512: my $result.=&mt
1513: ('[_1] Internally authenticated (with initial password [_2])',
1.165 raeburn 1514: '<input type="radio" name="login" value="int" '.$intcheck.
1515: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1516: '<input type="text" size="10" name="intarg" '.$intarg.
1517: ' onchange="'.$jscall.'" />');
1.32 matthew 1518: return $result;
1519: }
1520:
1521: sub authform_local{
1522: my %in = (
1523: formname => 'document.cu',
1524: kerb_def_dom => 'MSU.EDU',
1525: @_,
1526: );
1.165 raeburn 1527:
1528: my $loccheck = "";
1529: my $locarg = 'value=""';
1530: if ( grep/^curr_authtype$/,(keys %in) ) {
1531: if ($in{'curr_authtype'} eq 'loc') {
1532: $loccheck = " checked=\"on\"";
1533: if ( grep/^curr_autharg$/,(keys %in) ) {
1534: $locarg = "value=\"$in{'curr_autharg'}\"";
1535: }
1536: }
1537: }
1538:
1.144 matthew 1539: my $jscall = "javascript:changed_radio('loc',$in{'formname'});";
1.160 matthew 1540: my $result.=&mt('[_1] Local Authentication with argument [_2]',
1.165 raeburn 1541: '<input type="radio" name="login" value="loc" '.$loccheck.
1542: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1543: '<input type="text" size="10" name="locarg" '.$locarg.
1544: ' onchange="'.$jscall.'" />');
1.32 matthew 1545: return $result;
1546: }
1547:
1548: sub authform_filesystem{
1549: my %in = (
1550: formname => 'document.cu',
1551: kerb_def_dom => 'MSU.EDU',
1552: @_,
1553: );
1.144 matthew 1554: my $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
1555: my $result.= &mt
1556: ('[_1] Filesystem Authenticated (with initial password [_2])',
1557: '<input type="radio" name="login" value="fsys" '.
1558: 'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1559: '<input type="text" size="10" name="fsysarg" value="" '.
1560: 'onchange="'.$jscall.'" />');
1.32 matthew 1561: return $result;
1562: }
1563:
1.80 albertel 1564: ###############################################################
1565: ## Get Authentication Defaults for Domain ##
1566: ###############################################################
1567:
1568: =pod
1569:
1.112 bowersj2 1570: =head1 Domains and Authentication
1571:
1572: Returns default authentication type and an associated argument as
1573: listed in file 'domain.tab'.
1574:
1575: =over 4
1576:
1577: =item * get_auth_defaults
1.80 albertel 1578:
1579: get_auth_defaults($target_domain) returns the default authentication
1580: type and an associated argument (initial password or a kerberos domain).
1581: These values are stored in lonTabs/domain.tab
1582:
1583: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
1584:
1585: If target_domain is not found in domain.tab, returns nothing ('').
1586:
1587: =cut
1588:
1589: #-------------------------------------------
1590: sub get_auth_defaults {
1591: my $domain=shift;
1592: return ($Apache::lonnet::domain_auth_def{$domain},$Apache::lonnet::domain_auth_arg_def{$domain});
1593: }
1594: ###############################################################
1595: ## End Get Authentication Defaults for Domain ##
1596: ###############################################################
1597:
1598: ###############################################################
1599: ## Get Kerberos Defaults for Domain ##
1600: ###############################################################
1601: ##
1602: ## Returns default kerberos version and an associated argument
1603: ## as listed in file domain.tab. If not listed, provides
1604: ## appropriate default domain and kerberos version.
1605: ##
1606: #-------------------------------------------
1607:
1608: =pod
1609:
1.112 bowersj2 1610: =item * get_kerberos_defaults
1.80 albertel 1611:
1612: get_kerberos_defaults($target_domain) returns the default kerberos
1613: version and domain. If not found in domain.tabs, it defaults to
1614: version 4 and the domain of the server.
1615:
1616: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
1617:
1618: =cut
1619:
1620: #-------------------------------------------
1621: sub get_kerberos_defaults {
1622: my $domain=shift;
1623: my ($krbdef,$krbdefdom) =
1624: &Apache::loncommon::get_auth_defaults($domain);
1625: unless ($krbdef =~/^krb/ && $krbdefdom) {
1626: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
1627: my $krbdefdom=$1;
1628: $krbdefdom=~tr/a-z/A-Z/;
1629: $krbdef = "krb4";
1630: }
1631: return ($krbdef,$krbdefdom);
1632: }
1.112 bowersj2 1633:
1634: =pod
1635:
1636: =back
1637:
1638: =cut
1.32 matthew 1639:
1.46 matthew 1640: ###############################################################
1641: ## Thesaurus Functions ##
1642: ###############################################################
1.20 www 1643:
1.46 matthew 1644: =pod
1.20 www 1645:
1.112 bowersj2 1646: =head1 Thesaurus Functions
1647:
1648: =over 4
1649:
1650: =item * initialize_keywords
1.46 matthew 1651:
1652: Initializes the package variable %Keywords if it is empty. Uses the
1653: package variable $thesaurus_db_file.
1654:
1655: =cut
1656:
1657: ###################################################
1658:
1659: sub initialize_keywords {
1660: return 1 if (scalar keys(%Keywords));
1661: # If we are here, %Keywords is empty, so fill it up
1662: # Make sure the file we need exists...
1663: if (! -e $thesaurus_db_file) {
1664: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
1665: " failed because it does not exist");
1666: return 0;
1667: }
1668: # Set up the hash as a database
1669: my %thesaurus_db;
1670: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 1671: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 1672: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
1673: $thesaurus_db_file);
1674: return 0;
1675: }
1676: # Get the average number of appearances of a word.
1677: my $avecount = $thesaurus_db{'average.count'};
1678: # Put keywords (those that appear > average) into %Keywords
1679: while (my ($word,$data)=each (%thesaurus_db)) {
1680: my ($count,undef) = split /:/,$data;
1681: $Keywords{$word}++ if ($count > $avecount);
1682: }
1683: untie %thesaurus_db;
1684: # Remove special values from %Keywords.
1685: foreach ('total.count','average.count') {
1686: delete($Keywords{$_}) if (exists($Keywords{$_}));
1687: }
1688: return 1;
1689: }
1690:
1691: ###################################################
1692:
1693: =pod
1694:
1.112 bowersj2 1695: =item * keyword($word)
1.46 matthew 1696:
1697: Returns true if $word is a keyword. A keyword is a word that appears more
1698: than the average number of times in the thesaurus database. Calls
1699: &initialize_keywords
1700:
1701: =cut
1702:
1703: ###################################################
1.20 www 1704:
1705: sub keyword {
1.46 matthew 1706: return if (!&initialize_keywords());
1707: my $word=lc(shift());
1708: $word=~s/\W//g;
1709: return exists($Keywords{$word});
1.20 www 1710: }
1.46 matthew 1711:
1712: ###############################################################
1713:
1714: =pod
1.20 www 1715:
1.112 bowersj2 1716: =item * get_related_words
1.46 matthew 1717:
1.160 matthew 1718: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 1719: an array of words. If the keyword is not in the thesaurus, an empty array
1720: will be returned. The order of the words returned is determined by the
1721: database which holds them.
1722:
1723: Uses global $thesaurus_db_file.
1724:
1725: =cut
1726:
1727: ###############################################################
1728: sub get_related_words {
1729: my $keyword = shift;
1730: my %thesaurus_db;
1731: if (! -e $thesaurus_db_file) {
1732: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
1733: "failed because the file does not exist");
1734: return ();
1735: }
1736: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 1737: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 1738: return ();
1739: }
1740: my @Words=();
1741: if (exists($thesaurus_db{$keyword})) {
1742: $_ = $thesaurus_db{$keyword};
1743: (undef,@Words) = split/:/; # The first element is the number of times
1744: # the word appears. We do not need it now.
1745: for (my $i=0;$i<=$#Words;$i++) {
1746: ($Words[$i],undef)= split/\,/,$Words[$i];
1.20 www 1747: }
1748: }
1.46 matthew 1749: untie %thesaurus_db;
1750: return @Words;
1.14 harris41 1751: }
1.46 matthew 1752:
1.112 bowersj2 1753: =pod
1754:
1755: =back
1756:
1757: =cut
1.61 www 1758:
1759: # -------------------------------------------------------------- Plaintext name
1.81 albertel 1760: =pod
1761:
1.112 bowersj2 1762: =head1 User Name Functions
1763:
1764: =over 4
1765:
1.226 albertel 1766: =item * plainname($uname,$udom,$first)
1.81 albertel 1767:
1.112 bowersj2 1768: Takes a users logon name and returns it as a string in
1.226 albertel 1769: "first middle last generation" form
1770: if $first is set to 'lastname' then it returns it as
1771: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 1772:
1773: =cut
1.61 www 1774:
1.81 albertel 1775: ###############################################################
1.61 www 1776: sub plainname {
1.226 albertel 1777: my ($uname,$udom,$first)=@_;
1.61 www 1778: my %names=&Apache::lonnet::get('environment',
1779: ['firstname','middlename','lastname','generation'],
1780: $udom,$uname);
1.226 albertel 1781: my $name=&Apache::lonnet::format_name($names{'firstname'},
1782: $names{'middlename'},
1783: $names{'lastname'},
1784: $names{'generation'},$first);
1785: $name=~s/^\s+//;
1.62 www 1786: $name=~s/\s+$//;
1787: $name=~s/\s+/ /g;
1.190 albertel 1788: if ($name !~ /\S/) { $name=$uname.'@'.$udom; }
1.62 www 1789: return $name;
1.61 www 1790: }
1.66 www 1791:
1792: # -------------------------------------------------------------------- Nickname
1.81 albertel 1793: =pod
1794:
1.112 bowersj2 1795: =item * nickname($uname,$udom)
1.81 albertel 1796:
1797: Gets a users name and returns it as a string as
1798:
1799: ""nickname""
1.66 www 1800:
1.81 albertel 1801: if the user has a nickname or
1802:
1803: "first middle last generation"
1804:
1805: if the user does not
1806:
1807: =cut
1.66 www 1808:
1809: sub nickname {
1810: my ($uname,$udom)=@_;
1.212 albertel 1811: my %names;
1812: if ($uname eq $ENV{'user.name'} &&
1813: $udom eq $ENV{'user.domain'}) {
1814: %names=('nickname' => $ENV{'environment.nickname'} ,
1815: 'firstname' => $ENV{'environment.firstname'} ,
1816: 'middlename' => $ENV{'environment.middlename'},
1817: 'lastname' => $ENV{'environment.lastname'} ,
1818: 'generation' => $ENV{'environment.generation'});
1819: } else {
1820: %names=&Apache::lonnet::get('environment',
1821: ['nickname','firstname','middlename',
1822: 'lastname','generation'],$udom,$uname);
1823: }
1.68 albertel 1824: my $name=$names{'nickname'};
1.66 www 1825: if ($name) {
1826: $name='"'.$name.'"';
1827: } else {
1828: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
1829: $names{'lastname'}.' '.$names{'generation'};
1830: $name=~s/\s+$//;
1831: $name=~s/\s+/ /g;
1832: }
1833: return $name;
1834: }
1835:
1.61 www 1836:
1837: # ------------------------------------------------------------------ Screenname
1.81 albertel 1838:
1839: =pod
1840:
1.112 bowersj2 1841: =item * screenname($uname,$udom)
1.81 albertel 1842:
1843: Gets a users screenname and returns it as a string
1844:
1845: =cut
1.61 www 1846:
1847: sub screenname {
1848: my ($uname,$udom)=@_;
1.212 albertel 1849: if ($uname eq $ENV{'user.name'} &&
1850: $udom eq $ENV{'user.domain'}) {return $ENV{'environment.screenname'};}
1851: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 1852: return $names{'screenname'};
1.62 www 1853: }
1854:
1.212 albertel 1855:
1.62 www 1856: # ------------------------------------------------------------- Message Wrapper
1857:
1858: sub messagewrapper {
1.200 matthew 1859: my ($link,$username,$domain)=@_;
1.62 www 1860: return
1.200 matthew 1861: '<a href="/adm/email?compose=individual&'.
1862: 'recname='.$username.'&recdom='.$domain.'" '.
1863: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 1864: }
1865: # --------------------------------------------------------------- Notes Wrapper
1866:
1867: sub noteswrapper {
1868: my ($link,$un,$do)=@_;
1869: return
1870: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 1871: }
1872: # ------------------------------------------------------------- Aboutme Wrapper
1873:
1874: sub aboutmewrapper {
1.166 www 1875: my ($link,$username,$domain,$target)=@_;
1.205 www 1876: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.200 matthew 1877: ($target?' target="$target"':'').' title="'.&mt('View this users personal page').'">'.$link.'</a>';
1.62 www 1878: }
1879:
1880: # ------------------------------------------------------------ Syllabus Wrapper
1881:
1882:
1883: sub syllabuswrapper {
1.109 matthew 1884: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
1885: if ($fontcolor) {
1886: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
1887: }
1.208 matthew 1888: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 1889: }
1.14 harris41 1890:
1.208 matthew 1891: sub track_student_link {
1892: my ($linktext,$sname,$sdom,$target) = @_;
1893: my $link ="/adm/trackstudent";
1894: my $title = 'View recent activity';
1895: if (defined($sname) && $sname !~ /^\s*$/ &&
1896: defined($sdom) && $sdom !~ /^\s*$/) {
1897: $link .= "?selected_student=$sname:$sdom";
1898: $title .= ' of this student';
1899: }
1900: if (defined($target) && $target !~ /^\s*$/) {
1901: $target = qq{target="$target"};
1902: } else {
1903: $target = '';
1904: }
1905: return qq{<a href="$link" title="$title" $target>$linktext</a>};
1906: }
1907:
1908:
1909:
1.112 bowersj2 1910: =pod
1911:
1912: =back
1913:
1914: =head1 Access .tab File Data
1915:
1916: =over 4
1917:
1918: =item * languageids()
1919:
1920: returns list of all language ids
1921:
1922: =cut
1923:
1.14 harris41 1924: sub languageids {
1.16 harris41 1925: return sort(keys(%language));
1.14 harris41 1926: }
1927:
1.112 bowersj2 1928: =pod
1929:
1930: =item * languagedescription()
1931:
1932: returns description of a specified language id
1933:
1934: =cut
1935:
1.14 harris41 1936: sub languagedescription {
1.125 www 1937: my $code=shift;
1938: return ($supported_language{$code}?'* ':'').
1939: $language{$code}.
1.126 www 1940: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 1941: }
1942:
1943: sub plainlanguagedescription {
1944: my $code=shift;
1945: return $language{$code};
1946: }
1947:
1948: sub supportedlanguagecode {
1949: my $code=shift;
1950: return $supported_language{$code};
1.97 www 1951: }
1952:
1.112 bowersj2 1953: =pod
1954:
1955: =item * copyrightids()
1956:
1957: returns list of all copyrights
1958:
1959: =cut
1960:
1961: sub copyrightids {
1962: return sort(keys(%cprtag));
1963: }
1964:
1965: =pod
1966:
1967: =item * copyrightdescription()
1968:
1969: returns description of a specified copyright id
1970:
1971: =cut
1972:
1973: sub copyrightdescription {
1.166 www 1974: return &mt($cprtag{shift(@_)});
1.112 bowersj2 1975: }
1.197 matthew 1976:
1977: =pod
1978:
1.192 taceyjo1 1979: =item * source_copyrightids()
1980:
1981: returns list of all source copyrights
1982:
1983: =cut
1984:
1985: sub source_copyrightids {
1986: return sort(keys(%scprtag));
1987: }
1988:
1989: =pod
1990:
1991: =item * source_copyrightdescription()
1992:
1993: returns description of a specified source copyright id
1994:
1995: =cut
1996:
1997: sub source_copyrightdescription {
1998: return &mt($scprtag{shift(@_)});
1999: }
1.112 bowersj2 2000:
2001: =pod
2002:
2003: =item * filecategories()
2004:
2005: returns list of all file categories
2006:
2007: =cut
2008:
2009: sub filecategories {
2010: return sort(keys(%category_extensions));
2011: }
2012:
2013: =pod
2014:
2015: =item * filecategorytypes()
2016:
2017: returns list of file types belonging to a given file
2018: category
2019:
2020: =cut
2021:
2022: sub filecategorytypes {
2023: return @{$category_extensions{lc($_[0])}};
2024: }
2025:
2026: =pod
2027:
2028: =item * fileembstyle()
2029:
2030: returns embedding style for a specified file type
2031:
2032: =cut
2033:
2034: sub fileembstyle {
2035: return $fe{lc(shift(@_))};
1.169 www 2036: }
2037:
2038:
2039: sub filecategoryselect {
2040: my ($name,$value)=@_;
1.189 matthew 2041: return &select_form($value,$name,
1.169 www 2042: '' => &mt('Any category'),
2043: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2044: }
2045:
2046: =pod
2047:
2048: =item * filedescription()
2049:
2050: returns description for a specified file type
2051:
2052: =cut
2053:
2054: sub filedescription {
1.188 matthew 2055: my $file_description = $fd{lc(shift())};
2056: $file_description =~ s:([\[\]]):~$1:g;
2057: return &mt($file_description);
1.112 bowersj2 2058: }
2059:
2060: =pod
2061:
2062: =item * filedescriptionex()
2063:
2064: returns description for a specified file type with
2065: extra formatting
2066:
2067: =cut
2068:
2069: sub filedescriptionex {
2070: my $ex=shift;
1.188 matthew 2071: my $file_description = $fd{lc($ex)};
2072: $file_description =~ s:([\[\]]):~$1:g;
2073: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2074: }
2075:
2076: # End of .tab access
2077: =pod
2078:
2079: =back
2080:
2081: =cut
2082:
2083: # ------------------------------------------------------------------ File Types
2084: sub fileextensions {
2085: return sort(keys(%fe));
2086: }
2087:
1.97 www 2088: # ----------------------------------------------------------- Display Languages
2089: # returns a hash with all desired display languages
2090: #
2091:
2092: sub display_languages {
2093: my %languages=();
1.118 www 2094: foreach (&preferred_languages()) {
2095: $languages{$_}=1;
1.97 www 2096: }
2097: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
2098: if ($ENV{'form.displaylanguage'}) {
2099: foreach (split(/\s*(\,|\;|\:)\s*/,$ENV{'form.displaylanguage'})) {
2100: $languages{$_}=1;
2101: }
2102: }
2103: return %languages;
1.14 harris41 2104: }
2105:
1.117 www 2106: sub preferred_languages {
2107: my @languages=();
2108: if ($ENV{'course.'.$ENV{'request.course.id'}.'.languages'}) {
2109: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
2110: $ENV{'course.'.$ENV{'request.course.id'}.'.languages'}));
1.177 www 2111: }
2112: if ($ENV{'environment.languages'}) {
2113: @languages=split(/\s*(\,|\;|\:)\s*/,$ENV{'environment.languages'});
1.118 www 2114: }
1.162 www 2115: my $browser=(split(/\;/,$ENV{'HTTP_ACCEPT_LANGUAGE'}))[0];
2116: if ($browser) {
2117: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,$browser));
2118: }
1.118 www 2119: if ($Apache::lonnet::domain_lang_def{$ENV{'user.domain'}}) {
2120: @languages=(@languages,
2121: $Apache::lonnet::domain_lang_def{$ENV{'user.domain'}});
2122: }
2123: if ($Apache::lonnet::domain_lang_def{$ENV{'request.role.domain'}}) {
2124: @languages=(@languages,
2125: $Apache::lonnet::domain_lang_def{$ENV{'request.role.domain'}});
2126: }
2127: if ($Apache::lonnet::domain_lang_def{
2128: $Apache::lonnet::perlvar{'lonDefDomain'}}) {
2129: @languages=(@languages,
2130: $Apache::lonnet::domain_lang_def{
2131: $Apache::lonnet::perlvar{'lonDefDomain'}});
2132: }
2133: # turn "en-ca" into "en-ca,en"
2134: my @genlanguages;
2135: foreach (@languages) {
2136: unless ($_=~/\w/) { next; }
2137: push (@genlanguages,$_);
2138: if ($_=~/(\-|\_)/) {
2139: push (@genlanguages,(split(/(\-|\_)/,$_))[0]);
2140: }
2141: }
2142: return @genlanguages;
1.117 www 2143: }
2144:
1.112 bowersj2 2145: ###############################################################
2146: ## Student Answer Attempts ##
2147: ###############################################################
2148:
2149: =pod
2150:
2151: =head1 Alternate Problem Views
2152:
2153: =over 4
2154:
2155: =item * get_previous_attempt($symb, $username, $domain, $course,
2156: $getattempt, $regexp, $gradesub)
2157:
2158: Return string with previous attempt on problem. Arguments:
2159:
2160: =over 4
2161:
2162: =item * $symb: Problem, including path
2163:
2164: =item * $username: username of the desired student
2165:
2166: =item * $domain: domain of the desired student
1.14 harris41 2167:
1.112 bowersj2 2168: =item * $course: Course ID
1.14 harris41 2169:
1.112 bowersj2 2170: =item * $getattempt: Leave blank for all attempts, otherwise put
2171: something
1.14 harris41 2172:
1.112 bowersj2 2173: =item * $regexp: if string matches this regexp, the string will be
2174: sent to $gradesub
1.14 harris41 2175:
1.112 bowersj2 2176: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 2177:
1.112 bowersj2 2178: =back
1.14 harris41 2179:
1.112 bowersj2 2180: The output string is a table containing all desired attempts, if any.
1.16 harris41 2181:
1.112 bowersj2 2182: =cut
1.1 albertel 2183:
2184: sub get_previous_attempt {
1.43 ng 2185: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 2186: my $prevattempts='';
1.43 ng 2187: no strict 'refs';
1.1 albertel 2188: if ($symb) {
1.3 albertel 2189: my (%returnhash)=
2190: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 2191: if ($returnhash{'version'}) {
2192: my %lasthash=();
2193: my $version;
2194: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.19 harris41 2195: foreach (sort(split(/\:/,$returnhash{$version.':keys'}))) {
1.1 albertel 2196: $lasthash{$_}=$returnhash{$version.':'.$_};
1.19 harris41 2197: }
1.1 albertel 2198: }
1.43 ng 2199: $prevattempts='<table border="0" width="100%"><tr><td bgcolor="#777777">';
1.40 ng 2200: $prevattempts.='<table border="0" width="100%"><tr bgcolor="#e6ffff"><td>History</td>';
1.16 harris41 2201: foreach (sort(keys %lasthash)) {
1.31 albertel 2202: my ($ign,@parts) = split(/\./,$_);
1.41 ng 2203: if ($#parts > 0) {
1.31 albertel 2204: my $data=$parts[-1];
2205: pop(@parts);
1.40 ng 2206: $prevattempts.='<td>Part '.join('.',@parts).'<br />'.$data.' </td>';
1.31 albertel 2207: } else {
1.41 ng 2208: if ($#parts == 0) {
2209: $prevattempts.='<th>'.$parts[0].'</th>';
2210: } else {
2211: $prevattempts.='<th>'.$ign.'</th>';
2212: }
1.31 albertel 2213: }
1.16 harris41 2214: }
1.40 ng 2215: if ($getattempt eq '') {
2216: for ($version=1;$version<=$returnhash{'version'};$version++) {
2217: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Transaction '.$version.'</td>';
2218: foreach (sort(keys %lasthash)) {
2219: my $value;
2220: if ($_ =~ /timestamp/) {
2221: $value=scalar(localtime($returnhash{$version.':'.$_}));
2222: } else {
2223: $value=$returnhash{$version.':'.$_};
2224: }
1.142 albertel 2225: $prevattempts.='<td>'.&Apache::lonnet::unescape($value).' </td>';
1.40 ng 2226: }
2227: }
1.1 albertel 2228: }
1.40 ng 2229: $prevattempts.='</tr><tr bgcolor="#ffffe6"><td>Current</td>';
1.16 harris41 2230: foreach (sort(keys %lasthash)) {
1.5 albertel 2231: my $value;
2232: if ($_ =~ /timestamp/) {
2233: $value=scalar(localtime($lasthash{$_}));
2234: } else {
2235: $value=$lasthash{$_};
2236: }
1.142 albertel 2237: $value=&Apache::lonnet::unescape($value);
1.49 ng 2238: if ($_ =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 2239: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 2240: }
1.40 ng 2241: $prevattempts.='</tr></table></td></tr></table>';
1.1 albertel 2242: } else {
2243: $prevattempts='Nothing submitted - no attempts.';
2244: }
2245: } else {
2246: $prevattempts='No data.';
2247: }
1.10 albertel 2248: }
2249:
1.107 albertel 2250: sub relative_to_absolute {
2251: my ($url,$output)=@_;
2252: my $parser=HTML::TokeParser->new(\$output);
2253: my $token;
2254: my $thisdir=$url;
2255: my @rlinks=();
2256: while ($token=$parser->get_token) {
2257: if ($token->[0] eq 'S') {
2258: if ($token->[1] eq 'a') {
2259: if ($token->[2]->{'href'}) {
2260: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
2261: }
2262: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
2263: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
2264: } elsif ($token->[1] eq 'base') {
2265: $thisdir=$token->[2]->{'href'};
2266: }
2267: }
2268: }
2269: $thisdir=~s-/[^/]*$--;
2270: foreach (@rlinks) {
2271: unless (($_=~/^http:\/\//i) ||
2272: ($_=~/^\//) ||
2273: ($_=~/^javascript:/i) ||
2274: ($_=~/^mailto:/i) ||
2275: ($_=~/^\#/)) {
2276: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$_);
2277: $output=~s/(\"|\'|\=\s*)$_(\"|\'|\s|\>)/$1$newlocation$2/;
2278: }
2279: }
2280: # -------------------------------------------------- Deal with Applet codebases
2281: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
2282: return $output;
2283: }
2284:
1.112 bowersj2 2285: =pod
2286:
2287: =item * get_student_view
2288:
2289: show a snapshot of what student was looking at
2290:
2291: =cut
2292:
1.10 albertel 2293: sub get_student_view {
1.186 albertel 2294: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 2295: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2296: my (%form);
1.10 albertel 2297: my @elements=('symb','courseid','domain','username');
2298: foreach my $element (@elements) {
1.186 albertel 2299: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2300: }
1.186 albertel 2301: if (defined($moreenv)) {
2302: %form=(%form,%{$moreenv});
2303: }
1.236 albertel 2304: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 2305: $feedurl=&Apache::lonnet::clutter($feedurl);
1.186 albertel 2306: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 2307: $userview=~s/\<body[^\>]*\>//gi;
2308: $userview=~s/\<\/body\>//gi;
2309: $userview=~s/\<html\>//gi;
2310: $userview=~s/\<\/html\>//gi;
2311: $userview=~s/\<head\>//gi;
2312: $userview=~s/\<\/head\>//gi;
2313: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 2314: $userview=&relative_to_absolute($feedurl,$userview);
1.11 albertel 2315: return $userview;
2316: }
2317:
1.112 bowersj2 2318: =pod
2319:
2320: =item * get_student_answers()
2321:
2322: show a snapshot of how student was answering problem
2323:
2324: =cut
2325:
1.11 albertel 2326: sub get_student_answers {
1.100 sakharuk 2327: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 2328: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 2329: my (%moreenv);
1.11 albertel 2330: my @elements=('symb','courseid','domain','username');
2331: foreach my $element (@elements) {
1.186 albertel 2332: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 2333: }
1.186 albertel 2334: $moreenv{'grade_target'}='answer';
2335: %moreenv=(%form,%moreenv);
2336: my $userview=&Apache::lonnet::ssi('/res/'.$feedurl,%moreenv);
1.10 albertel 2337: return $userview;
1.1 albertel 2338: }
1.116 albertel 2339:
2340: =pod
2341:
2342: =item * &submlink()
2343:
1.242 albertel 2344: Inputs: $text $uname $udom $symb $target
1.116 albertel 2345:
2346: Returns: A link to grades.pm such as to see the SUBM view of a student
2347:
2348: =cut
2349:
2350: ###############################################
2351: sub submlink {
1.242 albertel 2352: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 2353: if (!($uname && $udom)) {
2354: (my $cursymb, my $courseid,$udom,$uname)=
2355: &Apache::lonxml::whichuser($symb);
2356: if (!$symb) { $symb=$cursymb; }
2357: }
2358: if (!$symb) { $symb=&symbread(); }
1.242 albertel 2359: $symb=&Apache::lonnet::escape($symb);
2360: if ($target) { $target="target=\"$target\""; }
2361: return '<a href="/adm/grades?&command=submission&'.
2362: 'symb='.$symb.'&student='.$uname.
2363: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
2364: }
2365: ##############################################
2366:
2367: =pod
2368:
2369: =item * &pgrdlink()
2370:
2371: Inputs: $text $uname $udom $symb $target
2372:
2373: Returns: A link to grades.pm such as to see the PGRD view of a student
2374:
2375: =cut
2376:
2377: ###############################################
2378: sub pgrdlink {
2379: my $link=&submlink(@_);
2380: $link=~s/(&command=submission)/$1&showgrading=yes/;
2381: return $link;
2382: }
2383: ##############################################
2384:
2385: =pod
2386:
2387: =item * &pprmlink()
2388:
2389: Inputs: $text $uname $udom $symb $target
2390:
2391: Returns: A link to parmset.pm such as to see the PPRM view of a
2392: student andn resource
2393:
2394: =cut
2395:
2396: ###############################################
2397: sub pprmlink {
2398: my ($text,$uname,$udom,$symb,$target)=@_;
2399: if (!($uname && $udom)) {
2400: (my $cursymb, my $courseid,$udom,$uname)=
2401: &Apache::lonxml::whichuser($symb);
2402: if (!$symb) { $symb=$cursymb; }
2403: }
2404: if (!$symb) { $symb=&symbread(); }
2405: $symb=&Apache::lonnet::escape($symb);
2406: if ($target) { $target="target=\"$target\""; }
2407: return '<a href="/adm/parmset?&command=set&'.
2408: 'symb='.$symb.'&uname='.$uname.
2409: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 2410: }
2411: ##############################################
1.37 matthew 2412:
1.112 bowersj2 2413: =pod
2414:
2415: =back
2416:
2417: =cut
2418:
1.37 matthew 2419: ###############################################
1.51 www 2420:
2421:
2422: sub timehash {
2423: my @ltime=localtime(shift);
2424: return ( 'seconds' => $ltime[0],
2425: 'minutes' => $ltime[1],
2426: 'hours' => $ltime[2],
2427: 'day' => $ltime[3],
2428: 'month' => $ltime[4]+1,
2429: 'year' => $ltime[5]+1900,
2430: 'weekday' => $ltime[6],
2431: 'dayyear' => $ltime[7]+1,
2432: 'dlsav' => $ltime[8] );
2433: }
2434:
2435: sub maketime {
2436: my %th=@_;
2437: return POSIX::mktime(
2438: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 2439: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 2440: }
2441:
2442: #########################################
1.51 www 2443:
2444: sub findallcourses {
2445: my %courses=();
2446: my $now=time;
2447: foreach (keys %ENV) {
2448: if ($_=~/^user\.role\.\w+\.\/(\w+)\/(\w+)/) {
2449: my ($starttime,$endtime)=$ENV{$_};
2450: my $active=1;
2451: if ($starttime) {
2452: if ($now<$starttime) { $active=0; }
2453: }
2454: if ($endtime) {
2455: if ($now>$endtime) { $active=0; }
2456: }
2457: if ($active) { $courses{$1.'_'.$2}=1; }
2458: }
2459: }
2460: return keys %courses;
2461: }
1.37 matthew 2462:
1.54 www 2463: ###############################################
1.60 matthew 2464: ###############################################
2465:
2466: =pod
2467:
1.112 bowersj2 2468: =head1 Domain Template Functions
2469:
2470: =over 4
2471:
2472: =item * &determinedomain()
1.60 matthew 2473:
2474: Inputs: $domain (usually will be undef)
2475:
1.63 www 2476: Returns: Determines which domain should be used for designs
1.60 matthew 2477:
2478: =cut
1.54 www 2479:
1.60 matthew 2480: ###############################################
1.63 www 2481: sub determinedomain {
2482: my $domain=shift;
2483: if (! $domain) {
1.60 matthew 2484: # Determine domain if we have not been given one
2485: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
2486: if ($ENV{'user.domain'}) { $domain=$ENV{'user.domain'}; }
2487: if ($ENV{'request.role.domain'}) {
2488: $domain=$ENV{'request.role.domain'};
2489: }
2490: }
1.63 www 2491: return $domain;
2492: }
2493: ###############################################
2494: =pod
2495:
1.112 bowersj2 2496: =item * &domainlogo()
1.63 www 2497:
2498: Inputs: $domain (usually will be undef)
2499:
2500: Returns: A link to a domain logo, if the domain logo exists.
2501: If the domain logo does not exist, a description of the domain.
2502:
2503: =cut
1.112 bowersj2 2504:
1.63 www 2505: ###############################################
2506: sub domainlogo {
2507: my $domain = &determinedomain(shift);
2508: # See if there is a logo
1.59 www 2509: if (-e '/home/httpd/html/adm/lonDomLogos/'.$domain.'.gif') {
1.215 albertel 2510: my $logo=&lonhttpdurl("/adm/lonDomLogos/$domain.gif");
2511: return '<img src="'.$logo.'" alt="'.$domain.'" />';
1.60 matthew 2512: } elsif(exists($Apache::lonnet::domaindescription{$domain})) {
2513: return $Apache::lonnet::domaindescription{$domain};
1.59 www 2514: } else {
1.60 matthew 2515: return '';
1.59 www 2516: }
2517: }
1.63 www 2518: ##############################################
2519:
2520: =pod
2521:
1.112 bowersj2 2522: =item * &designparm()
1.63 www 2523:
2524: Inputs: $which parameter; $domain (usually will be undef)
2525:
2526: Returns: value of designparamter $which
2527:
2528: =cut
1.112 bowersj2 2529:
1.63 www 2530: ##############################################
2531: sub designparm {
2532: my ($which,$domain)=@_;
1.110 www 2533: if ($ENV{'browser.blackwhite'} eq 'on') {
2534: if ($which=~/\.(font|alink|vlink|link)$/) {
2535: return '#000000';
2536: }
2537: if ($which=~/\.(pgbg|sidebg)$/) {
2538: return '#FFFFFF';
2539: }
2540: if ($which=~/\.tabbg$/) {
2541: return '#CCCCCC';
2542: }
2543: }
1.96 www 2544: if ($ENV{'environment.color.'.$which}) {
2545: return $ENV{'environment.color.'.$which};
2546: }
1.63 www 2547: $domain=&determinedomain($domain);
2548: if ($designhash{$domain.'.'.$which}) {
2549: return $designhash{$domain.'.'.$which};
2550: } else {
2551: return $designhash{'default.'.$which};
2552: }
2553: }
1.59 www 2554:
1.60 matthew 2555: ###############################################
2556: ###############################################
2557:
2558: =pod
2559:
1.112 bowersj2 2560: =back
2561:
2562: =head1 HTTP Helpers
2563:
2564: =over 4
2565:
2566: =item * &bodytag()
1.60 matthew 2567:
2568: Returns a uniform header for LON-CAPA web pages.
2569:
2570: Inputs:
2571:
1.112 bowersj2 2572: =over 4
2573:
2574: =item * $title, A title to be displayed on the page.
2575:
2576: =item * $function, the current role (can be undef).
2577:
2578: =item * $addentries, extra parameters for the <body> tag.
2579:
2580: =item * $bodyonly, if defined, only return the <body> tag.
2581:
2582: =item * $domain, if defined, force a given domain.
2583:
2584: =item * $forcereg, if page should register as content page (relevant for
1.86 www 2585: text interface only)
1.60 matthew 2586:
1.112 bowersj2 2587: =back
2588:
1.60 matthew 2589: Returns: A uniform header for LON-CAPA web pages.
2590: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
2591: If $bodyonly is undef or zero, an html string containing a <body> tag and
2592: other decorations will be returned.
2593:
2594: =cut
2595:
1.54 www 2596: sub bodytag {
1.224 raeburn 2597: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle)=@_;
1.117 www 2598: $title=&mt($title);
1.183 matthew 2599: $function = &get_users_function() if (!$function);
1.63 www 2600: my $img=&designparm($function.'.img',$domain);
2601: my $pgbg=&designparm($function.'.pgbg',$domain);
2602: my $tabbg=&designparm($function.'.tabbg',$domain);
2603: my $font=&designparm($function.'.font',$domain);
2604: my $link=&designparm($function.'.link',$domain);
2605: my $alink=&designparm($function.'.alink',$domain);
2606: my $vlink=&designparm($function.'.vlink',$domain);
2607: my $sidebg=&designparm($function.'.sidebg',$domain);
1.110 www 2608: # Accessibility font enhance
2609: unless ($addentries) { $addentries=''; }
1.146 www 2610: my $addstyle='';
1.110 www 2611: if ($ENV{'browser.fontenhance'} eq 'on') {
1.146 www 2612: $addstyle=' font-size: x-large;';
1.110 www 2613: }
1.63 www 2614: # role and realm
1.55 www 2615: my ($role,$realm)
2616: =&Apache::lonnet::plaintext((split(/\./,$ENV{'request.role'}))[0]);
2617: # realm
1.54 www 2618: if ($ENV{'request.course.id'}) {
1.55 www 2619: $realm=
2620: $ENV{'course.'.$ENV{'request.course.id'}.'.description'};
1.54 www 2621: }
1.55 www 2622: unless ($realm) { $realm=' '; }
2623: # Set messages
1.60 matthew 2624: my $messages=&domainlogo($domain);
1.101 www 2625: # Port for miniserver
1.83 albertel 2626: my $lonhttpdPort=$Apache::lonnet::perlvar{'lonhttpdPort'};
2627: if (!defined($lonhttpdPort)) { $lonhttpdPort='8080'; }
1.101 www 2628: # construct main body tag
1.60 matthew 2629: my $bodytag = <<END;
1.231 albertel 2630: <style type="text/css">
1.147 www 2631: h1, h2, h3, th { font-family: Arial, Helvetica, sans-serif }
1.146 www 2632: a:focus { color: red; background: yellow }
2633: </style>
1.54 www 2634: <body bgcolor="$pgbg" text="$font" alink="$alink" vlink="$vlink" link="$link"
1.151 www 2635: style="margin-top: 0px;$addstyle" $addentries>
1.60 matthew 2636: END
1.252 albertel 2637: if ($ENV{'environment.texengine'} eq 'jsMath') {
2638: $bodytag.='<script type="text/javascript">
2639: function NoFontMessage () {}
2640: </script>'."\n".
2641: '<script src="/adm/jsMath/jsMath.js"></script>'."\n";
2642: }
2643:
1.94 www 2644: my $upperleft='<img src="http://'.$ENV{'HTTP_HOST'}.':'.
1.150 matthew 2645: $lonhttpdPort.$img.'" alt="'.$function.'" />';
1.60 matthew 2646: if ($bodyonly) {
2647: return $bodytag;
1.79 www 2648: } elsif ($ENV{'browser.interface'} eq 'textual') {
1.95 www 2649: # Accessibility
1.224 raeburn 2650:
1.93 www 2651: return $bodytag.&Apache::lonmenu::menubuttons($forcereg,'web',
2652: $forcereg).
2653: '<h1>LON-CAPA: '.$title.'</h1>';
2654: } elsif ($ENV{'environment.remote'} eq 'off') {
1.95 www 2655: # No Remote
1.206 albertel 2656: my $roleinfo=(<<ENDROLE);
2657: <td bgcolor="$tabbg" align="right">
2658: <font size="2" face="Arial, Helvetica, sans-serif">
2659: $ENV{'environment.firstname'}
2660: $ENV{'environment.middlename'}
2661: $ENV{'environment.lastname'}
2662: $ENV{'environment.generation'}
2663: </font>
2664: <br />
2665: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>
2666: <br />
2667: <font size="2" face="Arial, Helvetica, sans-serif">$realm</font>
2668: </td>
2669: ENDROLE
1.224 raeburn 2670: my $titleinfo = '<font face="Arial, Helvetica, sans-serif" size="+3" color="'.
1.229 albertel 2671: $font.'"><b>'.$title.'</b></font>';
1.224 raeburn 2672: if ($customtitle) {
2673: $titleinfo = $customtitle;
1.235 raeburn 2674: }
2675:
1.229 albertel 2676: if ($ENV{'request.state'} eq 'construct') {
2677: my ($uname,$thisdisfn)=
2678: ($ENV{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
2679: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
2680: $formaction=~s/\/+/\//g;
1.237 raeburn 2681: unless ($customtitle) { #this is for resources; directories have customtitle, and crumbs and select recent are created in lonpubdir.pm
2682: my $parentpath = '';
1.241 raeburn 2683: my $lastitem = '';
2684: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
1.235 raeburn 2685: $parentpath = $1;
1.241 raeburn 2686: $lastitem = $2;
2687: } else {
2688: $lastitem = $thisdisfn;
1.235 raeburn 2689: }
2690: $titleinfo = &Apache::loncommon::help_open_menu('','','','',3,'Authoring').
2691: '<font face="Arial, Helvetica, sans-serif"><b>Construction Space</b>:</font> '.
2692: '<form name="dirs" method="post" action="'.$formaction
2693: .'" target="_top"><tt><b>'
1.241 raeburn 2694: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
1.235 raeburn 2695: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
2696: .'</form>'
2697: .&Apache::lonmenu::constspaceform();
1.229 albertel 2698:
1.235 raeburn 2699: }
2700: $forcereg=1;
2701: }
2702: my $titletable = '<table bgcolor="'.$pgbg.'" width="100%" border="0" '.
2703: 'cellspacing="3" cellpadding="3">'.
2704: '<tr><td rowspan="3" bgcolor="'.$tabbg.'">'.
2705: $titleinfo.'</td>'.$roleinfo.'</tr></table>';
2706: if ($ENV{'request.state'} eq 'construct') {
2707: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg,$titletable);
2708: } else {
2709: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,'web',$forcereg).
2710: $titletable;
2711: }
2712: return $bodytag;
1.94 www 2713: }
1.95 www 2714:
1.93 www 2715: #
1.95 www 2716: # Top frame rendering, Remote is up
1.93 www 2717: #
1.224 raeburn 2718: my $titleinfo = ' <font size="5" face="Arial, Helvetica, sans-serif"><b>'.$title.'</b></font>';
2719: if ($customtitle) {
2720: $titleinfo = $customtitle;
2721: }
1.245 matthew 2722: #
2723: # Extra info if you are the DC
2724: my $dc_info = '';
2725: if ($ENV{'user.adv'} && exists($ENV{'user.role.dc./'.
2726: $ENV{'course.'.$ENV{'request.course.id'}.
2727: '.domain'}.'/'})) {
2728: my $cid = $ENV{'request.course.id'};
2729: $dc_info.= $cid.' '.$ENV{'course.'.$cid.'.internal.coursecode'};
2730: $dc_info = '('.$dc_info.')';
2731: }
2732: #
1.94 www 2733: return(<<ENDBODY);
1.60 matthew 2734: $bodytag
1.55 www 2735: <table width="100%" cellspacing="0" border="0" cellpadding="0">
1.95 www 2736: <tr><td bgcolor="$sidebg">
1.94 www 2737: $upperleft</td>
1.95 www 2738: <td bgcolor="$sidebg" align="right">$messages </td>
1.55 www 2739: </tr>
1.54 www 2740: <tr>
1.55 www 2741: <td rowspan="3" bgcolor="$tabbg">
1.245 matthew 2742: $titleinfo $dc_info
1.146 www 2743: <td bgcolor="$tabbg" align="right">
2744: <font size="2" face="Arial, Helvetica, sans-serif">
1.54 www 2745: $ENV{'environment.firstname'}
2746: $ENV{'environment.middlename'}
2747: $ENV{'environment.lastname'}
2748: $ENV{'environment.generation'}
1.55 www 2749: </font>
1.54 www 2750: </td>
2751: </tr>
2752: <tr><td bgcolor="$tabbg" align="right">
1.146 www 2753: <font size="2" face="Arial, Helvetica, sans-serif">$role</font>
1.54 www 2754: </td></tr>
1.55 www 2755: <tr>
1.148 www 2756: <td bgcolor="$tabbg" align="right"><font size="2" face="Arial, Helvetica, sans-serif">$realm</font> </td></tr>
1.202 albertel 2757: </table><br />
1.54 www 2758: ENDBODY
1.182 matthew 2759: }
2760:
2761: ###############################################
1.251 albertel 2762: ###############################################
2763:
2764: =pod
2765:
2766: =back
2767:
2768: =head1 HTTP Helpers
2769:
2770: =over 4
2771:
2772: =item * &endbodytag()
2773:
2774: Returns a uniform footer for LON-CAPA web pages.
2775:
2776: Inputs:
2777:
2778: =over 4
2779:
2780: =back
2781:
2782: Returns: A uniform footer for LON-CAPA web pages.
2783:
2784: =cut
2785:
2786: sub endbodytag {
2787: my $endbodytag='</body>';
1.252 albertel 2788: if ($ENV{'environment.texengine'} eq 'jsMath') {
2789: $endbodytag='<script type="text/javascript">jsMath.Process()</script>'.
2790: "\n".$endbodytag;
2791: }
1.251 albertel 2792: return $endbodytag;
2793: }
2794:
2795: ###############################################
1.182 matthew 2796:
2797: =pod
2798:
2799: =item get_users_function
2800:
2801: Used by &bodytag to determine the current users primary role.
2802: Returns either 'student','coordinator','admin', or 'author'.
2803:
2804: =cut
2805:
2806: ###############################################
2807: sub get_users_function {
2808: my $function = 'student';
2809: if ($ENV{'request.role'}=~/^(cc|in|ta|ep)/) {
2810: $function='coordinator';
2811: }
2812: if ($ENV{'request.role'}=~/^(su|dc|ad|li)/) {
2813: $function='admin';
2814: }
2815: if (($ENV{'request.role'}=~/^(au|ca)/) ||
2816: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
2817: $function='author';
2818: }
2819: return $function;
1.54 www 2820: }
1.99 www 2821:
2822: ###############################################
2823:
1.233 raeburn 2824: =pod
2825:
2826: =item get_sections
2827:
2828: Determines all the sections for a course including
2829: sections with students and sections containing other roles.
2830: Incoming parameters: domain, course number, reference to
2831: section hash (keys to be section/group IDs), reference to
2832: array containing roles for which sections should be gathered
2833: (optional). If the fourth argument is undefined, sections
2834: are gathered for any role.
2835:
2836: Returns number of sections.
2837:
2838: =cut
2839:
2840: ###############################################
2841: sub get_sections {
2842: my ($cdom,$cnum,$sectioncount,$possible_roles) = @_;
1.240 albertel 2843: if (!($cdom && $cnum)) { return 0; }
1.233 raeburn 2844: my $cid = $cdom.'_'.$cnum;
2845: my $numsections = 0;
1.240 albertel 2846:
2847: if (!defined($possible_roles) || (grep/^st$/,@$possible_roles)) {
2848: my ($classlist) = &Apache::loncoursedata::get_classlist($cid,$cdom,$cnum);
2849: my $sec_index = &Apache::loncoursedata::CL_SECTION();
2850: my $status_index = &Apache::loncoursedata::CL_STATUS();
2851: while (my ($student,$data) = each %$classlist) {
2852: my ($section,$status) = ($data->[$sec_index],
2853: $data->[$status_index]);
2854: unless ($section eq '-1' || $section =~ /^\s*$/) {
2855: if (!defined($$sectioncount{$section})) { $numsections++; }
2856: $$sectioncount{$section}++;
2857: }
2858: }
2859: }
2860: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
2861: foreach my $user (sort(keys(%courseroles))) {
2862: if ($user !~ /^(\w{2})/) { next; }
2863: my ($role) = ($user =~ /^(\w{2})/);
2864: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
2865: my $section;
2866: if ($role eq 'cr' &&
2867: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
2868: $section=$1;
2869: }
2870: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
2871: if (!defined($section) || $section eq '-1') { next; }
2872: if (!defined($$sectioncount{$section})) { $numsections++; }
2873: $$sectioncount{$section}++;
1.233 raeburn 2874: }
2875: return $numsections;
2876: }
2877:
2878:
1.99 www 2879: sub get_posted_cgi {
2880: my $r=shift;
2881:
2882: my $buffer;
2883:
2884: $r->read($buffer,$r->header_in('Content-length'),0);
2885: unless ($buffer=~/^(\-+\w+)\s+Content\-Disposition\:\s*form\-data/si) {
2886: my @pairs=split(/&/,$buffer);
2887: my $pair;
2888: foreach $pair (@pairs) {
2889: my ($name,$value) = split(/=/,$pair);
2890: $value =~ tr/+/ /;
2891: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
2892: $name =~ tr/+/ /;
2893: $name =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
2894: &add_to_env("form.$name",$value);
2895: }
2896: } else {
2897: my $contentsep=$1;
2898: my @lines = split (/\n/,$buffer);
2899: my $name='';
2900: my $value='';
2901: my $fname='';
2902: my $fmime='';
2903: my $i;
2904: for ($i=0;$i<=$#lines;$i++) {
2905: if ($lines[$i]=~/^$contentsep/) {
2906: if ($name) {
2907: chomp($value);
2908: if ($fname) {
2909: $ENV{"form.$name.filename"}=$fname;
2910: $ENV{"form.$name.mimetype"}=$fmime;
2911: } else {
2912: $value=~s/\s+$//s;
2913: }
2914: &add_to_env("form.$name",$value);
2915: }
2916: if ($i<$#lines) {
2917: $i++;
2918: $lines[$i]=~
2919: /Content\-Disposition\:\s*form\-data\;\s*name\=\"([^\"]+)\"/i;
2920: $name=$1;
2921: $value='';
2922: if ($lines[$i]=~/filename\=\"([^\"]+)\"/i) {
2923: $fname=$1;
2924: if
2925: ($lines[$i+1]=~/Content\-Type\:\s*([\w\-\/]+)/i) {
2926: $fmime=$1;
2927: $i++;
2928: } else {
2929: $fmime='';
2930: }
2931: } else {
2932: $fname='';
2933: $fmime='';
2934: }
2935: $i++;
2936: }
2937: } else {
2938: $value.=$lines[$i]."\n";
2939: }
2940: }
2941: }
2942: $ENV{'request.method'}=$ENV{'REQUEST_METHOD'};
2943: $r->method_number(M_GET);
2944: $r->method('GET');
2945: $r->headers_in->unset('Content-length');
2946: }
2947:
1.112 bowersj2 2948: =pod
2949:
2950: =item * get_unprocessed_cgi($query,$possible_names)
2951:
2952: Modify the %ENV hash to contain unprocessed CGI form parameters held in
2953: $query. The parameters listed in $possible_names (an array reference),
2954: will be set in $ENV{'form.name'} if they do not already exist.
2955:
2956: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
2957: $possible_names is an ref to an array of form element names. As an example:
2958: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
2959: will result in $ENV{'form.uname'} and $ENV{'form.udom'} being set.
2960:
2961: =cut
1.1 albertel 2962:
1.6 albertel 2963: sub get_unprocessed_cgi {
1.25 albertel 2964: my ($query,$possible_names)= @_;
1.26 matthew 2965: # $Apache::lonxml::debug=1;
1.16 harris41 2966: foreach (split(/&/,$query)) {
1.6 albertel 2967: my ($name, $value) = split(/=/,$_);
1.25 albertel 2968: $name = &Apache::lonnet::unescape($name);
2969: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
2970: $value =~ tr/+/ /;
2971: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
2972: &Apache::lonxml::debug("Seting :$name: to :$value:");
1.30 albertel 2973: unless (defined($ENV{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 2974: }
1.16 harris41 2975: }
1.6 albertel 2976: }
2977:
1.112 bowersj2 2978: =pod
2979:
2980: =item * cacheheader()
2981:
2982: returns cache-controlling header code
2983:
2984: =cut
2985:
1.7 albertel 2986: sub cacheheader {
1.216 albertel 2987: unless ($ENV{'request.method'} eq 'GET') { return ''; }
2988: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
2989: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 2990: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
2991: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 2992: return $output;
1.7 albertel 2993: }
2994:
1.112 bowersj2 2995: =pod
2996:
2997: =item * no_cache($r)
2998:
2999: specifies header code to not have cache
3000:
3001: =cut
3002:
1.9 albertel 3003: sub no_cache {
1.216 albertel 3004: my ($r) = @_;
3005: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
3006: $ENV{'request.method'} ne 'GET') { return ''; }
3007: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
3008: $r->no_cache(1);
3009: $r->header_out("Expires" => $date);
3010: $r->header_out("Pragma" => "no-cache");
1.123 www 3011: }
3012:
3013: sub content_type {
1.181 albertel 3014: my ($r,$type,$charset) = @_;
1.253 ! albertel 3015: if ($ENV{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 3016: unless ($charset) {
3017: $charset=&Apache::lonlocal::current_encoding;
3018: }
3019: if ($charset) { $type.='; charset='.$charset; }
3020: if ($r) {
3021: $r->content_type($type);
3022: } else {
3023: print("Content-type: $type\n\n");
3024: }
1.9 albertel 3025: }
1.25 albertel 3026:
1.112 bowersj2 3027: =pod
3028:
3029: =item * add_to_env($name,$value)
3030:
3031: adds $name to the %ENV hash with value
3032: $value, if $name already exists, the entry is converted to an array
3033: reference and $value is added to the array.
3034:
3035: =cut
3036:
1.25 albertel 3037: sub add_to_env {
3038: my ($name,$value)=@_;
1.28 albertel 3039: if (defined($ENV{$name})) {
1.27 albertel 3040: if (ref($ENV{$name})) {
1.25 albertel 3041: #already have multiple values
3042: push(@{ $ENV{$name} },$value);
3043: } else {
3044: #first time seeing multiple values, convert hash entry to an arrayref
3045: my $first=$ENV{$name};
3046: undef($ENV{$name});
3047: push(@{ $ENV{$name} },$first,$value);
3048: }
3049: } else {
3050: $ENV{$name}=$value;
3051: }
1.31 albertel 3052: }
1.149 albertel 3053:
3054: =pod
3055:
3056: =item * get_env_multiple($name)
3057:
3058: gets $name from the %ENV hash, it seemlessly handles the cases where multiple
3059: values may be defined and end up as an array ref.
3060:
3061: returns an array of values
3062:
3063: =cut
3064:
3065: sub get_env_multiple {
3066: my ($name) = @_;
3067: my @values;
3068: if (defined($ENV{$name})) {
3069: # exists is it an array
3070: if (ref($ENV{$name})) {
3071: @values=@{ $ENV{$name} };
3072: } else {
3073: $values[0]=$ENV{$name};
3074: }
3075: }
3076: return(@values);
3077: }
3078:
1.31 albertel 3079:
1.41 ng 3080: =pod
1.45 matthew 3081:
3082: =back
1.41 ng 3083:
1.112 bowersj2 3084: =head1 CSV Upload/Handling functions
1.38 albertel 3085:
1.41 ng 3086: =over 4
3087:
1.112 bowersj2 3088: =item * upfile_store($r)
1.41 ng 3089:
3090: Store uploaded file, $r should be the HTTP Request object,
3091: needs $ENV{'form.upfile'}
3092: returns $datatoken to be put into hidden field
3093:
3094: =cut
1.31 albertel 3095:
3096: sub upfile_store {
3097: my $r=shift;
3098: $ENV{'form.upfile'}=~s/\r/\n/gs;
3099: $ENV{'form.upfile'}=~s/\f/\n/gs;
3100: $ENV{'form.upfile'}=~s/\n+/\n/gs;
3101: $ENV{'form.upfile'}=~s/\n+$//gs;
3102:
3103: my $datatoken=$ENV{'user.name'}.'_'.$ENV{'user.domain'}.
3104: '_enroll_'.$ENV{'request.course.id'}.'_'.time.'_'.$$;
3105: {
1.158 raeburn 3106: my $datafile = $r->dir_config('lonDaemons').
3107: '/tmp/'.$datatoken.'.tmp';
3108: if ( open(my $fh,">$datafile") ) {
3109: print $fh $ENV{'form.upfile'};
3110: close($fh);
3111: }
1.31 albertel 3112: }
3113: return $datatoken;
3114: }
3115:
1.56 matthew 3116: =pod
3117:
1.112 bowersj2 3118: =item * load_tmp_file($r)
1.41 ng 3119:
3120: Load uploaded file from tmp, $r should be the HTTP Request object,
3121: needs $ENV{'form.datatoken'},
3122: sets $ENV{'form.upfile'} to the contents of the file
3123:
3124: =cut
1.31 albertel 3125:
3126: sub load_tmp_file {
3127: my $r=shift;
3128: my @studentdata=();
3129: {
1.158 raeburn 3130: my $studentfile = $r->dir_config('lonDaemons').
3131: '/tmp/'.$ENV{'form.datatoken'}.'.tmp';
3132: if ( open(my $fh,"<$studentfile") ) {
3133: @studentdata=<$fh>;
3134: close($fh);
3135: }
1.31 albertel 3136: }
3137: $ENV{'form.upfile'}=join('',@studentdata);
3138: }
3139:
1.56 matthew 3140: =pod
3141:
1.112 bowersj2 3142: =item * upfile_record_sep()
1.41 ng 3143:
3144: Separate uploaded file into records
3145: returns array of records,
3146: needs $ENV{'form.upfile'} and $ENV{'form.upfiletype'}
3147:
3148: =cut
1.31 albertel 3149:
3150: sub upfile_record_sep {
3151: if ($ENV{'form.upfiletype'} eq 'xml') {
3152: } else {
1.248 albertel 3153: my @records;
3154: foreach my $line (split(/\n/,$ENV{'form.upfile'})) {
3155: if ($line=~/^\s*$/) { next; }
3156: push(@records,$line);
3157: }
3158: return @records;
1.31 albertel 3159: }
3160: }
3161:
1.56 matthew 3162: =pod
3163:
1.112 bowersj2 3164: =item * record_sep($record)
1.41 ng 3165:
3166: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $ENV{'form.upfiletype'}
3167:
3168: =cut
3169:
1.31 albertel 3170: sub record_sep {
3171: my $record=shift;
3172: my %components=();
3173: if ($ENV{'form.upfiletype'} eq 'xml') {
3174: } elsif ($ENV{'form.upfiletype'} eq 'space') {
3175: my $i=0;
3176: foreach (split(/\s+/,$record)) {
3177: my $field=$_;
3178: $field=~s/^(\"|\')//;
3179: $field=~s/(\"|\')$//;
3180: $components{$i}=$field;
3181: $i++;
3182: }
3183: } elsif ($ENV{'form.upfiletype'} eq 'tab') {
3184: my $i=0;
1.171 matthew 3185: foreach (split(/\t/,$record)) {
1.31 albertel 3186: my $field=$_;
3187: $field=~s/^(\"|\')//;
3188: $field=~s/(\"|\')$//;
3189: $components{$i}=$field;
3190: $i++;
3191: }
3192: } else {
3193: my @allfields=split(/\,/,$record);
3194: my $i=0;
3195: my $j;
3196: for ($j=0;$j<=$#allfields;$j++) {
3197: my $field=$allfields[$j];
3198: if ($field=~/^\s*(\"|\')/) {
3199: my $delimiter=$1;
3200: while (($field!~/$delimiter$/) && ($j<$#allfields)) {
3201: $j++;
3202: $field.=','.$allfields[$j];
3203: }
3204: $field=~s/^\s*$delimiter//;
3205: $field=~s/$delimiter\s*$//;
3206: }
3207: $components{$i}=$field;
3208: $i++;
3209: }
3210: }
3211: return %components;
3212: }
3213:
1.144 matthew 3214: ######################################################
3215: ######################################################
3216:
1.56 matthew 3217: =pod
3218:
1.112 bowersj2 3219: =item * upfile_select_html()
1.41 ng 3220:
1.144 matthew 3221: Return HTML code to select a file from the users machine and specify
3222: the file type.
1.41 ng 3223:
3224: =cut
3225:
1.144 matthew 3226: ######################################################
3227: ######################################################
1.31 albertel 3228: sub upfile_select_html {
1.144 matthew 3229: my %Types = (
3230: csv => &mt('CSV (comma separated values, spreadsheet)'),
3231: space => &mt('Space separated'),
3232: tab => &mt('Tabulator separated'),
3233: # xml => &mt('HTML/XML'),
3234: );
3235: my $Str = '<input type="file" name="upfile" size="50" />'.
3236: '<br />Type: <select name="upfiletype">';
3237: foreach my $type (sort(keys(%Types))) {
3238: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
3239: }
3240: $Str .= "</select>\n";
3241: return $Str;
1.31 albertel 3242: }
3243:
1.144 matthew 3244: ######################################################
3245: ######################################################
3246:
1.56 matthew 3247: =pod
3248:
1.112 bowersj2 3249: =item * csv_print_samples($r,$records)
1.41 ng 3250:
3251: Prints a table of sample values from each column uploaded $r is an
3252: Apache Request ref, $records is an arrayref from
3253: &Apache::loncommon::upfile_record_sep
3254:
3255: =cut
3256:
1.144 matthew 3257: ######################################################
3258: ######################################################
1.31 albertel 3259: sub csv_print_samples {
3260: my ($r,$records) = @_;
3261: my (%sone,%stwo,%sthree);
3262: %sone=&record_sep($$records[0]);
3263: if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
3264: if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
1.144 matthew 3265: #
3266: $r->print(&mt('Samples').'<br /><table border="2"><tr>');
3267: foreach (sort({$a <=> $b} keys(%sone))) {
3268: $r->print('<th>'.&mt('Column [_1]',($_+1)).'</th>'); }
1.31 albertel 3269: $r->print('</tr>');
3270: foreach my $hash (\%sone,\%stwo,\%sthree) {
3271: $r->print('<tr>');
3272: foreach (sort({$a <=> $b} keys(%sone))) {
3273: $r->print('<td>');
3274: if (defined($$hash{$_})) { $r->print($$hash{$_}); }
3275: $r->print('</td>');
3276: }
3277: $r->print('</tr>');
3278: }
3279: $r->print('</tr></table><br />'."\n");
3280: }
3281:
1.144 matthew 3282: ######################################################
3283: ######################################################
3284:
1.56 matthew 3285: =pod
3286:
1.112 bowersj2 3287: =item * csv_print_select_table($r,$records,$d)
1.41 ng 3288:
3289: Prints a table to create associations between values and table columns.
1.144 matthew 3290:
1.41 ng 3291: $r is an Apache Request ref,
3292: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 3293: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 3294:
3295: =cut
3296:
1.144 matthew 3297: ######################################################
3298: ######################################################
1.31 albertel 3299: sub csv_print_select_table {
3300: my ($r,$records,$d) = @_;
3301: my $i=0;my %sone;
3302: %sone=&record_sep($$records[0]);
1.144 matthew 3303: $r->print(&mt('Associate columns with student attributes.')."\n".
3304: '<table border="2"><tr>'.
3305: '<th>'.&mt('Attribute').'</th>'.
3306: '<th>'.&mt('Column').'</th></tr>'."\n");
1.31 albertel 3307: foreach (@$d) {
1.174 matthew 3308: my ($value,$display,$defaultcol)=@{ $_ };
1.31 albertel 3309: $r->print('<tr><td>'.$display.'</td>');
3310:
3311: $r->print('<td><select name=f'.$i.
1.32 matthew 3312: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 3313: $r->print('<option value="none"></option>');
3314: foreach (sort({$a <=> $b} keys(%sone))) {
1.174 matthew 3315: $r->print('<option value="'.$_.'"'.
1.253 ! albertel 3316: ($_ eq $defaultcol ? ' selected="selected" ' : '').
1.174 matthew 3317: '>Column '.($_+1).'</option>');
1.31 albertel 3318: }
3319: $r->print('</select></td></tr>'."\n");
3320: $i++;
3321: }
3322: $i--;
3323: return $i;
3324: }
1.56 matthew 3325:
1.144 matthew 3326: ######################################################
3327: ######################################################
3328:
1.56 matthew 3329: =pod
1.31 albertel 3330:
1.112 bowersj2 3331: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 3332:
3333: Prints a table of sample values from the upload and can make associate samples to internal names.
3334:
3335: $r is an Apache Request ref,
3336: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
3337: $d is an array of 2 element arrays (internal name, displayed name)
3338:
3339: =cut
3340:
1.144 matthew 3341: ######################################################
3342: ######################################################
1.31 albertel 3343: sub csv_samples_select_table {
3344: my ($r,$records,$d) = @_;
3345: my %sone; my %stwo; my %sthree;
3346: my $i=0;
1.144 matthew 3347: #
3348: $r->print('<table border=2><tr><th>'.
3349: &mt('Field').'</th><th>'.&mt('Samples').'</th></tr>');
1.31 albertel 3350: %sone=&record_sep($$records[0]);
3351: if (defined($$records[1])) {%stwo=&record_sep($$records[1]);}
3352: if (defined($$records[2])) {%sthree=&record_sep($$records[2]);}
1.144 matthew 3353: #
1.31 albertel 3354: foreach (sort keys %sone) {
1.144 matthew 3355: $r->print('<tr><td><select name="f'.$i.'"'.
1.32 matthew 3356: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 3357: foreach (@$d) {
1.174 matthew 3358: my ($value,$display,$defaultcol)=@{ $_ };
3359: $r->print('<option value="'.$value.'"'.
1.253 ! albertel 3360: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 3361: $display.'</option>');
1.31 albertel 3362: }
3363: $r->print('</select></td><td>');
3364: if (defined($sone{$_})) { $r->print($sone{$_}."</br>\n"); }
3365: if (defined($stwo{$_})) { $r->print($stwo{$_}."</br>\n"); }
3366: if (defined($sthree{$_})) { $r->print($sthree{$_}."</br>\n"); }
3367: $r->print('</td></tr>');
3368: $i++;
3369: }
3370: $i--;
3371: return($i);
1.115 matthew 3372: }
3373:
1.144 matthew 3374: ######################################################
3375: ######################################################
3376:
1.115 matthew 3377: =pod
3378:
3379: =item clean_excel_name($name)
3380:
3381: Returns a replacement for $name which does not contain any illegal characters.
3382:
3383: =cut
3384:
1.144 matthew 3385: ######################################################
3386: ######################################################
1.115 matthew 3387: sub clean_excel_name {
3388: my ($name) = @_;
3389: $name =~ s/[:\*\?\/\\]//g;
3390: if (length($name) > 31) {
3391: $name = substr($name,0,31);
3392: }
3393: return $name;
1.25 albertel 3394: }
1.84 albertel 3395:
1.85 albertel 3396: =pod
3397:
1.112 bowersj2 3398: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 3399:
3400: Returns either 1 or undef
3401:
3402: 1 if the part is to be hidden, undef if it is to be shown
3403:
3404: Arguments are:
3405:
3406: $id the id of the part to be checked
3407: $symb, optional the symb of the resource to check
3408: $udom, optional the domain of the user to check for
3409: $uname, optional the username of the user to check for
3410:
3411: =cut
1.84 albertel 3412:
3413: sub check_if_partid_hidden {
3414: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 3415: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 3416: $symb,$udom,$uname);
1.141 albertel 3417: my $truth=1;
3418: #if the string starts with !, then the list is the list to show not hide
3419: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 3420: my @hiddenlist=split(/,/,$hiddenparts);
3421: foreach my $checkid (@hiddenlist) {
1.141 albertel 3422: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 3423: }
1.141 albertel 3424: return !$truth;
1.84 albertel 3425: }
1.127 matthew 3426:
1.138 matthew 3427:
3428: ############################################################
3429: ############################################################
3430:
3431: =pod
3432:
1.157 matthew 3433: =back
3434:
1.138 matthew 3435: =head1 cgi-bin script and graphing routines
3436:
1.157 matthew 3437: =over 4
3438:
1.138 matthew 3439: =item get_cgi_id
3440:
3441: Inputs: none
3442:
3443: Returns an id which can be used to pass environment variables
3444: to various cgi-bin scripts. These environment variables will
3445: be removed from the users environment after a given time by
3446: the routine &Apache::lonnet::transfer_profile_to_env.
3447:
3448: =cut
3449:
3450: ############################################################
3451: ############################################################
1.152 albertel 3452: my $uniq=0;
1.136 matthew 3453: sub get_cgi_id {
1.154 albertel 3454: $uniq=($uniq+1)%100000;
1.152 albertel 3455: return (time.'_'.$uniq);
1.136 matthew 3456: }
3457:
1.127 matthew 3458: ############################################################
3459: ############################################################
3460:
3461: =pod
3462:
1.134 matthew 3463: =item DrawBarGraph
1.127 matthew 3464:
1.138 matthew 3465: Facilitates the plotting of data in a (stacked) bar graph.
3466: Puts plot definition data into the users environment in order for
3467: graph.png to plot it. Returns an <img> tag for the plot.
3468: The bars on the plot are labeled '1','2',...,'n'.
3469:
3470: Inputs:
3471:
3472: =over 4
3473:
3474: =item $Title: string, the title of the plot
3475:
3476: =item $xlabel: string, text describing the X-axis of the plot
3477:
3478: =item $ylabel: string, text describing the Y-axis of the plot
3479:
3480: =item $Max: scalar, the maximum Y value to use in the plot
3481: If $Max is < any data point, the graph will not be rendered.
3482:
1.140 matthew 3483: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 3484: they are plotted. If undefined, default values will be used.
3485:
1.178 matthew 3486: =item $labels: array ref holding the labels to use on the x-axis for the bars.
3487:
1.138 matthew 3488: =item @Values: An array of array references. Each array reference holds data
3489: to be plotted in a stacked bar chart.
3490:
1.239 matthew 3491: =item If the final element of @Values is a hash reference the key/value
3492: pairs will be added to the graph definition.
3493:
1.138 matthew 3494: =back
3495:
3496: Returns:
3497:
3498: An <img> tag which references graph.png and the appropriate identifying
3499: information for the plot.
3500:
1.127 matthew 3501: =cut
3502:
3503: ############################################################
3504: ############################################################
1.134 matthew 3505: sub DrawBarGraph {
1.178 matthew 3506: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 3507: #
3508: if (! defined($colors)) {
3509: $colors = ['#33ff00',
3510: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
3511: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
3512: ];
3513: }
1.228 matthew 3514: my $extra_settings = {};
3515: if (ref($Values[-1]) eq 'HASH') {
3516: $extra_settings = pop(@Values);
3517: }
1.127 matthew 3518: #
1.136 matthew 3519: my $identifier = &get_cgi_id();
3520: my $id = 'cgi.'.$identifier;
1.129 matthew 3521: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 3522: return '';
3523: }
1.225 matthew 3524: #
3525: my @Labels;
3526: if (defined($labels)) {
3527: @Labels = @$labels;
3528: } else {
3529: for (my $i=0;$i<@{$Values[0]};$i++) {
3530: push (@Labels,$i+1);
3531: }
3532: }
3533: #
1.129 matthew 3534: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 3535: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 3536: my %ValuesHash;
3537: my $NumSets=1;
3538: foreach my $array (@Values) {
3539: next if (! ref($array));
1.136 matthew 3540: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 3541: join(',',@$array);
1.129 matthew 3542: }
1.127 matthew 3543: #
1.136 matthew 3544: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 3545: if ($NumBars < 3) {
3546: $width = 120+$NumBars*32;
1.220 matthew 3547: $xskip = 1;
1.225 matthew 3548: $bar_width = 30;
3549: } elsif ($NumBars < 5) {
3550: $width = 120+$NumBars*20;
3551: $xskip = 1;
3552: $bar_width = 20;
1.220 matthew 3553: } elsif ($NumBars < 10) {
1.136 matthew 3554: $width = 120+$NumBars*15;
3555: $xskip = 1;
3556: $bar_width = 15;
3557: } elsif ($NumBars <= 25) {
3558: $width = 120+$NumBars*11;
3559: $xskip = 5;
3560: $bar_width = 8;
3561: } elsif ($NumBars <= 50) {
3562: $width = 120+$NumBars*8;
3563: $xskip = 5;
3564: $bar_width = 4;
3565: } else {
3566: $width = 120+$NumBars*8;
3567: $xskip = 5;
3568: $bar_width = 4;
3569: }
3570: #
1.137 matthew 3571: $Max = 1 if ($Max < 1);
3572: if ( int($Max) < $Max ) {
3573: $Max++;
3574: $Max = int($Max);
3575: }
1.127 matthew 3576: $Title = '' if (! defined($Title));
3577: $xlabel = '' if (! defined($xlabel));
3578: $ylabel = '' if (! defined($ylabel));
1.136 matthew 3579: $ValuesHash{$id.'.title'} = &Apache::lonnet::escape($Title);
3580: $ValuesHash{$id.'.xlabel'} = &Apache::lonnet::escape($xlabel);
3581: $ValuesHash{$id.'.ylabel'} = &Apache::lonnet::escape($ylabel);
1.137 matthew 3582: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 3583: $ValuesHash{$id.'.NumBars'} = $NumBars;
3584: $ValuesHash{$id.'.NumSets'} = $NumSets;
3585: $ValuesHash{$id.'.PlotType'} = 'bar';
3586: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
3587: $ValuesHash{$id.'.height'} = $height;
3588: $ValuesHash{$id.'.width'} = $width;
3589: $ValuesHash{$id.'.xskip'} = $xskip;
3590: $ValuesHash{$id.'.bar_width'} = $bar_width;
3591: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 3592: #
1.228 matthew 3593: # Deal with other parameters
3594: while (my ($key,$value) = each(%$extra_settings)) {
3595: $ValuesHash{$id.'.'.$key} = $value;
3596: }
3597: #
1.137 matthew 3598: &Apache::lonnet::appenv(%ValuesHash);
3599: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
3600: }
3601:
3602: ############################################################
3603: ############################################################
3604:
3605: =pod
3606:
3607: =item DrawXYGraph
3608:
1.138 matthew 3609: Facilitates the plotting of data in an XY graph.
3610: Puts plot definition data into the users environment in order for
3611: graph.png to plot it. Returns an <img> tag for the plot.
3612:
3613: Inputs:
3614:
3615: =over 4
3616:
3617: =item $Title: string, the title of the plot
3618:
3619: =item $xlabel: string, text describing the X-axis of the plot
3620:
3621: =item $ylabel: string, text describing the Y-axis of the plot
3622:
3623: =item $Max: scalar, the maximum Y value to use in the plot
3624: If $Max is < any data point, the graph will not be rendered.
3625:
3626: =item $colors: Array ref containing the hex color codes for the data to be
3627: plotted in. If undefined, default values will be used.
3628:
3629: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
3630:
3631: =item $Ydata: Array ref containing Array refs.
1.185 www 3632: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 3633:
3634: =item %Values: hash indicating or overriding any default values which are
3635: passed to graph.png.
3636: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
3637:
3638: =back
3639:
3640: Returns:
3641:
3642: An <img> tag which references graph.png and the appropriate identifying
3643: information for the plot.
3644:
1.137 matthew 3645: =cut
3646:
3647: ############################################################
3648: ############################################################
3649: sub DrawXYGraph {
3650: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
3651: #
3652: # Create the identifier for the graph
3653: my $identifier = &get_cgi_id();
3654: my $id = 'cgi.'.$identifier;
3655: #
3656: $Title = '' if (! defined($Title));
3657: $xlabel = '' if (! defined($xlabel));
3658: $ylabel = '' if (! defined($ylabel));
3659: my %ValuesHash =
3660: (
3661: $id.'.title' => &Apache::lonnet::escape($Title),
3662: $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
3663: $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
3664: $id.'.y_max_value'=> $Max,
3665: $id.'.labels' => join(',',@$Xlabels),
3666: $id.'.PlotType' => 'XY',
3667: );
3668: #
3669: if (defined($colors) && ref($colors) eq 'ARRAY') {
3670: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
3671: }
3672: #
3673: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
3674: return '';
3675: }
3676: my $NumSets=1;
1.138 matthew 3677: foreach my $array (@{$Ydata}){
1.137 matthew 3678: next if (! ref($array));
3679: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
3680: }
1.138 matthew 3681: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 3682: #
3683: # Deal with other parameters
3684: while (my ($key,$value) = each(%Values)) {
3685: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 3686: }
3687: #
1.136 matthew 3688: &Apache::lonnet::appenv(%ValuesHash);
3689: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
3690: }
3691:
3692: ############################################################
3693: ############################################################
3694:
3695: =pod
3696:
1.138 matthew 3697: =item DrawXYYGraph
3698:
3699: Facilitates the plotting of data in an XY graph with two Y axes.
3700: Puts plot definition data into the users environment in order for
3701: graph.png to plot it. Returns an <img> tag for the plot.
3702:
3703: Inputs:
3704:
3705: =over 4
3706:
3707: =item $Title: string, the title of the plot
3708:
3709: =item $xlabel: string, text describing the X-axis of the plot
3710:
3711: =item $ylabel: string, text describing the Y-axis of the plot
3712:
3713: =item $colors: Array ref containing the hex color codes for the data to be
3714: plotted in. If undefined, default values will be used.
3715:
3716: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
3717:
3718: =item $Ydata1: The first data set
3719:
3720: =item $Min1: The minimum value of the left Y-axis
3721:
3722: =item $Max1: The maximum value of the left Y-axis
3723:
3724: =item $Ydata2: The second data set
3725:
3726: =item $Min2: The minimum value of the right Y-axis
3727:
3728: =item $Max2: The maximum value of the left Y-axis
3729:
3730: =item %Values: hash indicating or overriding any default values which are
3731: passed to graph.png.
3732: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
3733:
3734: =back
3735:
3736: Returns:
3737:
3738: An <img> tag which references graph.png and the appropriate identifying
3739: information for the plot.
1.136 matthew 3740:
3741: =cut
3742:
3743: ############################################################
3744: ############################################################
1.137 matthew 3745: sub DrawXYYGraph {
3746: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
3747: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 3748: #
3749: # Create the identifier for the graph
3750: my $identifier = &get_cgi_id();
3751: my $id = 'cgi.'.$identifier;
3752: #
3753: $Title = '' if (! defined($Title));
3754: $xlabel = '' if (! defined($xlabel));
3755: $ylabel = '' if (! defined($ylabel));
3756: my %ValuesHash =
3757: (
3758: $id.'.title' => &Apache::lonnet::escape($Title),
3759: $id.'.xlabel' => &Apache::lonnet::escape($xlabel),
3760: $id.'.ylabel' => &Apache::lonnet::escape($ylabel),
3761: $id.'.labels' => join(',',@$Xlabels),
3762: $id.'.PlotType' => 'XY',
3763: $id.'.NumSets' => 2,
1.137 matthew 3764: $id.'.two_axes' => 1,
3765: $id.'.y1_max_value' => $Max1,
3766: $id.'.y1_min_value' => $Min1,
3767: $id.'.y2_max_value' => $Max2,
3768: $id.'.y2_min_value' => $Min2,
1.136 matthew 3769: );
3770: #
1.137 matthew 3771: if (defined($colors) && ref($colors) eq 'ARRAY') {
3772: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
3773: }
3774: #
3775: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
3776: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 3777: return '';
3778: }
3779: my $NumSets=1;
1.137 matthew 3780: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 3781: next if (! ref($array));
3782: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 3783: }
3784: #
3785: # Deal with other parameters
3786: while (my ($key,$value) = each(%Values)) {
3787: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 3788: }
3789: #
3790: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 3791: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 3792: }
3793:
3794: ############################################################
3795: ############################################################
3796:
3797: =pod
3798:
1.157 matthew 3799: =back
3800:
1.139 matthew 3801: =head1 Statistics helper routines?
3802:
3803: Bad place for them but what the hell.
3804:
1.157 matthew 3805: =over 4
3806:
1.139 matthew 3807: =item &chartlink
3808:
3809: Returns a link to the chart for a specific student.
3810:
3811: Inputs:
3812:
3813: =over 4
3814:
3815: =item $linktext: The text of the link
3816:
3817: =item $sname: The students username
3818:
3819: =item $sdomain: The students domain
3820:
3821: =back
3822:
1.157 matthew 3823: =back
3824:
1.139 matthew 3825: =cut
3826:
3827: ############################################################
3828: ############################################################
3829: sub chartlink {
3830: my ($linktext, $sname, $sdomain) = @_;
3831: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.219 albertel 3832: '&SelectedStudent='.&Apache::lonnet::escape($sname.':'.$sdomain).
3833: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 3834: '">'.$linktext.'</a>';
1.153 matthew 3835: }
3836:
3837: #######################################################
3838: #######################################################
3839:
3840: =pod
3841:
3842: =head1 Course Environment Routines
1.157 matthew 3843:
3844: =over 4
1.153 matthew 3845:
3846: =item &restore_course_settings
3847:
3848: =item &store_course_settings
3849:
3850: Restores/Store indicated form parameters from the course environment.
3851: Will not overwrite existing values of the form parameters.
3852:
3853: Inputs:
3854: a scalar describing the data (e.g. 'chart', 'problem_analysis')
3855:
3856: a hash ref describing the data to be stored. For example:
3857:
3858: %Save_Parameters = ('Status' => 'scalar',
3859: 'chartoutputmode' => 'scalar',
3860: 'chartoutputdata' => 'scalar',
3861: 'Section' => 'array',
3862: 'StudentData' => 'array',
3863: 'Maps' => 'array');
3864:
3865: Returns: both routines return nothing
3866:
3867: =cut
3868:
3869: #######################################################
3870: #######################################################
3871: sub store_course_settings {
3872: # save to the environment
3873: # appenv the same items, just to be safe
3874: my $courseid = $ENV{'request.course.id'};
3875: my $coursedom = $ENV{'course.'.$courseid.'.domain'};
3876: my ($prefix,$Settings) = @_;
3877: my %SaveHash;
3878: my %AppHash;
3879: while (my ($setting,$type) = each(%$Settings)) {
1.176 albertel 3880: my $basename = 'internal.'.$prefix.'.'.$setting;
1.153 matthew 3881: my $envname = 'course.'.$courseid.'.'.$basename;
3882: if (exists($ENV{'form.'.$setting})) {
3883: # Save this value away
3884: if ($type eq 'scalar' &&
3885: (! exists($ENV{$envname}) ||
3886: $ENV{$envname} ne $ENV{'form.'.$setting})) {
3887: $SaveHash{$basename} = $ENV{'form.'.$setting};
3888: $AppHash{$envname} = $ENV{'form.'.$setting};
3889: } elsif ($type eq 'array') {
3890: my $stored_form;
3891: if (ref($ENV{'form.'.$setting})) {
3892: $stored_form = join(',',
3893: map {
3894: &Apache::lonnet::escape($_);
3895: } sort(@{$ENV{'form.'.$setting}}));
3896: } else {
3897: $stored_form =
3898: &Apache::lonnet::escape($ENV{'form.'.$setting});
3899: }
3900: # Determine if the array contents are the same.
3901: if ($stored_form ne $ENV{$envname}) {
3902: $SaveHash{$basename} = $stored_form;
3903: $AppHash{$envname} = $stored_form;
3904: }
3905: }
3906: }
3907: }
3908: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
3909: $coursedom,
3910: $ENV{'course.'.$courseid.'.num'});
3911: if ($put_result !~ /^(ok|delayed)/) {
3912: &Apache::lonnet::logthis('unable to save form parameters, '.
3913: 'got error:'.$put_result);
3914: }
3915: # Make sure these settings stick around in this session, too
3916: &Apache::lonnet::appenv(%AppHash);
3917: return;
3918: }
3919:
3920: sub restore_course_settings {
3921: my $courseid = $ENV{'request.course.id'};
3922: my ($prefix,$Settings) = @_;
3923: while (my ($setting,$type) = each(%$Settings)) {
3924: next if (exists($ENV{'form.'.$setting}));
1.176 albertel 3925: my $envname = 'course.'.$courseid.'.internal.'.$prefix.
1.153 matthew 3926: '.'.$setting;
3927: if (exists($ENV{$envname})) {
3928: if ($type eq 'scalar') {
3929: $ENV{'form.'.$setting} = $ENV{$envname};
3930: } elsif ($type eq 'array') {
3931: $ENV{'form.'.$setting} = [
3932: map {
3933: &Apache::lonnet::unescape($_);
3934: } split(',',$ENV{$envname})
3935: ];
3936: }
3937: }
3938: }
1.127 matthew 3939: }
3940:
3941: ############################################################
3942: ############################################################
1.154 albertel 3943:
3944: sub propath {
3945: my ($udom,$uname)=@_;
3946: $udom=~s/\W//g;
3947: $uname=~s/\W//g;
3948: my $subdir=$uname.'__';
3949: $subdir =~ s/(.)(.)(.).*/$1\/$2\/$3/;
3950: my $proname="$Apache::lonnet::perlvar{'lonUsersDir'}/$udom/$subdir/$uname";
3951: return $proname;
1.156 albertel 3952: }
3953:
3954: sub icon {
3955: my ($file)=@_;
1.168 albertel 3956: my $curfext = (split(/\./,$file))[-1];
3957: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 3958: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 3959: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
3960: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
3961: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
3962: $curfext.".gif") {
3963: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
3964: $curfext.".gif";
3965: }
3966: }
1.249 albertel 3967: return &lonhttpdurl($iconname);
1.154 albertel 3968: }
1.84 albertel 3969:
1.215 albertel 3970: sub lonhttpdurl {
3971: my ($url)=@_;
3972: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
3973: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
3974: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
3975: }
3976:
1.213 albertel 3977: sub connection_aborted {
3978: my ($r)=@_;
3979: $r->print(" ");$r->rflush();
3980: my $c = $r->connection;
3981: return $c->aborted();
3982: }
3983:
1.221 foxr 3984: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 3985: # strings as 'strings'.
3986: sub escape_single {
1.221 foxr 3987: my ($input) = @_;
1.223 albertel 3988: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 3989: $input =~ s/\'/\\\'/g; # Esacpe the 's....
3990: return $input;
3991: }
1.223 albertel 3992:
1.222 foxr 3993: # Same as escape_single, but escape's "'s This
3994: # can be used for "strings"
3995: sub escape_double {
3996: my ($input) = @_;
3997: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
3998: $input =~ s/\"/\\\"/g; # Esacpe the "s....
3999: return $input;
4000: }
1.223 albertel 4001:
1.222 foxr 4002: # Escapes the last element of a full URL.
4003: sub escape_url {
4004: my ($url) = @_;
1.238 raeburn 4005: my @urlslices = split(/\//, $url,-1);
1.223 albertel 4006: my $lastitem = &Apache::lonnet::escape(pop(@urlslices));
4007: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 4008: }
1.41 ng 4009: =pod
4010:
4011: =back
4012:
1.112 bowersj2 4013: =cut
1.41 ng 4014:
1.112 bowersj2 4015: 1;
4016: __END__;
1.41 ng 4017:
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