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