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