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