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