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