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