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