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