Annotation of loncom/interface/loncommon.pm, revision 1.631
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.631 ! raeburn 4: # $Id: loncommon.pm,v 1.630 2008/01/01 20:27:29 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.139 matthew 64: use HTML::Entities;
1.334 albertel 65: use Apache::lonhtmlcommon();
66: use Apache::loncoursedata();
1.344 albertel 67: use Apache::lontexconvert();
1.444 albertel 68: use Apache::lonclonecourse();
1.479 albertel 69: use LONCAPA qw(:DEFAULT :match);
1.117 www 70:
1.517 raeburn 71: # ---------------------------------------------- Designs
72: use vars qw(%defaultdesign);
73:
1.22 www 74: my $readit;
75:
1.517 raeburn 76:
1.157 matthew 77: ##
78: ## Global Variables
79: ##
1.46 matthew 80:
1.20 www 81: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 82: my %language;
1.124 www 83: my %supported_language;
1.12 harris41 84: my %cprtag;
1.192 taceyjo1 85: my %scprtag;
1.351 www 86: my %fe; my %fd; my %fm;
1.41 ng 87: my %category_extensions;
1.12 harris41 88:
1.46 matthew 89: # ---------------------------------------------- Thesaurus variables
1.144 matthew 90: #
91: # %Keywords:
92: # A hash used by &keyword to determine if a word is considered a keyword.
93: # $thesaurus_db_file
94: # Scalar containing the full path to the thesaurus database.
1.46 matthew 95:
96: my %Keywords;
97: my $thesaurus_db_file;
98:
1.144 matthew 99: #
100: # Initialize values from language.tab, copyright.tab, filetypes.tab,
101: # thesaurus.tab, and filecategories.tab.
102: #
1.18 www 103: BEGIN {
1.46 matthew 104: # Variable initialization
105: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
106: #
1.22 www 107: unless ($readit) {
1.12 harris41 108: # ------------------------------------------------------------------- languages
109: {
1.158 raeburn 110: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
111: '/language.tab';
112: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 113: while (my $line = <$fh>) {
114: next if ($line=~/^\#/);
115: chomp($line);
116: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 117: $language{$key}=$val.' - '.$enc;
118: if ($sup) {
119: $supported_language{$key}=$sup;
120: }
121: }
122: close($fh);
123: }
1.12 harris41 124: }
125: # ------------------------------------------------------------------ copyrights
126: {
1.158 raeburn 127: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
128: '/copyright.tab';
129: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 130: while (my $line = <$fh>) {
131: next if ($line=~/^\#/);
132: chomp($line);
133: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 134: $cprtag{$key}=$val;
135: }
136: close($fh);
137: }
1.12 harris41 138: }
1.351 www 139: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 140: {
141: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
142: '/source_copyright.tab';
143: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 144: while (my $line = <$fh>) {
145: next if ($line =~ /^\#/);
146: chomp($line);
147: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 148: $scprtag{$key}=$val;
149: }
150: close($fh);
151: }
152: }
1.63 www 153:
1.517 raeburn 154: # -------------------------------------------------------------- default domain designs
1.63 www 155: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 156: my $designfile = $designdir.'/default.tab';
157: if ( open (my $fh,"<$designfile") ) {
158: while (my $line = <$fh>) {
159: next if ($line =~ /^\#/);
160: chomp($line);
161: my ($key,$val)=(split(/\=/,$line));
162: if ($val) { $defaultdesign{$key}=$val; }
163: }
164: close($fh);
1.63 www 165: }
166:
1.15 harris41 167: # ------------------------------------------------------------- file categories
168: {
1.158 raeburn 169: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
170: '/filecategories.tab';
171: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 172: while (my $line = <$fh>) {
173: next if ($line =~ /^\#/);
174: chomp($line);
175: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 176: push @{$category_extensions{lc($category)}},$extension;
177: }
178: close($fh);
179: }
180:
1.15 harris41 181: }
1.12 harris41 182: # ------------------------------------------------------------------ file types
183: {
1.158 raeburn 184: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
185: '/filetypes.tab';
186: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 187: while (my $line = <$fh>) {
188: next if ($line =~ /^\#/);
189: chomp($line);
190: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 191: if ($descr ne '') {
192: $fe{$ending}=lc($emb);
193: $fd{$ending}=$descr;
1.351 www 194: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 195: }
196: }
197: close($fh);
198: }
1.12 harris41 199: }
1.22 www 200: &Apache::lonnet::logthis(
1.46 matthew 201: "<font color=yellow>INFO: Read file types</font>");
1.22 www 202: $readit=1;
1.46 matthew 203: } # end of unless($readit)
1.32 matthew 204:
205: }
1.112 bowersj2 206:
1.42 matthew 207: ###############################################################
208: ## HTML and Javascript Helper Functions ##
209: ###############################################################
210:
211: =pod
212:
1.112 bowersj2 213: =head1 HTML and Javascript Functions
1.42 matthew 214:
1.112 bowersj2 215: =over 4
216:
217: =item * browser_and_searcher_javascript ()
218:
219: X<browsing, javascript>X<searching, javascript>Returns a string
220: containing javascript with two functions, C<openbrowser> and
221: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
222: tags.
1.42 matthew 223:
1.112 bowersj2 224: =item * openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 225:
226: inputs: formname, elementname, only, omit
227:
228: formname and elementname indicate the name of the html form and name of
229: the element that the results of the browsing selection are to be placed in.
230:
231: Specifying 'only' will restrict the browser to displaying only files
1.185 www 232: with the given extension. Can be a comma separated list.
1.42 matthew 233:
234: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 235: with the given extension. Can be a comma separated list.
1.42 matthew 236:
1.112 bowersj2 237: =item * opensearcher(formname, elementname) [javascript]
1.42 matthew 238:
239: Inputs: formname, elementname
240:
241: formname and elementname specify the name of the html form and the name
242: of the element the selection from the search results will be placed in.
1.542 raeburn 243:
1.42 matthew 244: =cut
245:
246: sub browser_and_searcher_javascript {
1.199 albertel 247: my ($mode)=@_;
248: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 249: my $resurl=&escape_single(&lastresurl());
1.42 matthew 250: return <<END;
1.219 albertel 251: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 252: var editbrowser = null;
1.135 albertel 253: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 254: var url = '$resurl/?';
1.42 matthew 255: if (editbrowser == null) {
256: url += 'launch=1&';
257: }
258: url += 'catalogmode=interactive&';
1.199 albertel 259: url += 'mode=$mode&';
1.611 albertel 260: url += 'inhibitmenu=yes&';
1.42 matthew 261: url += 'form=' + formname + '&';
262: if (only != null) {
263: url += 'only=' + only + '&';
1.217 albertel 264: } else {
265: url += 'only=&';
266: }
1.42 matthew 267: if (omit != null) {
268: url += 'omit=' + omit + '&';
1.217 albertel 269: } else {
270: url += 'omit=&';
271: }
1.135 albertel 272: if (titleelement != null) {
273: url += 'titleelement=' + titleelement + '&';
1.217 albertel 274: } else {
275: url += 'titleelement=&';
276: }
1.42 matthew 277: url += 'element=' + elementname + '';
278: var title = 'Browser';
1.435 albertel 279: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 280: options += ',width=700,height=600';
281: editbrowser = open(url,title,options,'1');
282: editbrowser.focus();
283: }
284: var editsearcher;
1.135 albertel 285: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 286: var url = '/adm/searchcat?';
287: if (editsearcher == null) {
288: url += 'launch=1&';
289: }
290: url += 'catalogmode=interactive&';
1.199 albertel 291: url += 'mode=$mode&';
1.42 matthew 292: url += 'form=' + formname + '&';
1.135 albertel 293: if (titleelement != null) {
294: url += 'titleelement=' + titleelement + '&';
1.217 albertel 295: } else {
296: url += 'titleelement=&';
297: }
1.42 matthew 298: url += 'element=' + elementname + '';
299: var title = 'Search';
1.435 albertel 300: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 301: options += ',width=700,height=600';
302: editsearcher = open(url,title,options,'1');
303: editsearcher.focus();
304: }
1.219 albertel 305: // END LON-CAPA Internal -->
1.42 matthew 306: END
1.170 www 307: }
308:
309: sub lastresurl {
1.258 albertel 310: if ($env{'environment.lastresurl'}) {
311: return $env{'environment.lastresurl'}
1.170 www 312: } else {
313: return '/res';
314: }
315: }
316:
317: sub storeresurl {
318: my $resurl=&Apache::lonnet::clutter(shift);
319: unless ($resurl=~/^\/res/) { return 0; }
320: $resurl=~s/\/$//;
321: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
322: &Apache::lonnet::appenv('environment.lastresurl' => $resurl);
323: return 1;
1.42 matthew 324: }
325:
1.74 www 326: sub studentbrowser_javascript {
1.111 www 327: unless (
1.258 albertel 328: (($env{'request.course.id'}) &&
1.302 albertel 329: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
330: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
331: '/'.$env{'request.course.sec'})
332: ))
1.258 albertel 333: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 334: ) { return ''; }
1.74 www 335: return (<<'ENDSTDBRW');
336: <script type="text/javascript" language="Javascript" >
337: var stdeditbrowser;
1.558 albertel 338: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 339: var url = '/adm/pickstudent?';
340: var filter;
1.558 albertel 341: if (!ignorefilter) {
342: eval('filter=document.'+formname+'.'+uname+'.value;');
343: }
1.74 www 344: if (filter != null) {
345: if (filter != '') {
346: url += 'filter='+filter+'&';
347: }
348: }
349: url += 'form=' + formname + '&unameelement='+uname+
350: '&udomelement='+udom;
1.111 www 351: if (roleflag) { url+="&roles=1"; }
1.102 www 352: var title = 'Student_Browser';
1.74 www 353: var options = 'scrollbars=1,resizable=1,menubar=0';
354: options += ',width=700,height=600';
355: stdeditbrowser = open(url,title,options,'1');
356: stdeditbrowser.focus();
357: }
358: </script>
359: ENDSTDBRW
360: }
1.42 matthew 361:
1.74 www 362: sub selectstudent_link {
1.111 www 363: my ($form,$unameele,$udomele)=@_;
1.258 albertel 364: if ($env{'request.course.id'}) {
1.302 albertel 365: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
366: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
367: '/'.$env{'request.course.sec'})) {
1.111 www 368: return '';
369: }
370: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 371: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 372: }
1.258 albertel 373: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 374: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 375: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 376: }
377: return '';
1.91 www 378: }
379:
380: sub coursebrowser_javascript {
1.468 raeburn 381: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 382: 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 383: my $output = '
1.538 albertel 384: <script type="text/javascript">
1.468 raeburn 385: var stdeditbrowser;'."\n";
386: $output .= <<"ENDSTDBRW";
1.377 raeburn 387: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 388: var url = '/adm/pickcourse?';
1.468 raeburn 389: var domainfilter = '';
390: var formid = getFormIdByName(formname);
391: if (formid > -1) {
392: var domid = getIndexByName(formid,udom);
393: if (domid > -1) {
394: if (document.forms[formid].elements[domid].type == 'select-one') {
395: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
396: }
397: if (document.forms[formid].elements[domid].type == 'hidden') {
398: domainfilter=document.forms[formid].elements[domid].value;
399: }
400: }
1.91 www 401: }
1.128 albertel 402: if (domainfilter != null) {
403: if (domainfilter != '') {
404: url += 'domainfilter='+domainfilter+'&';
405: }
406: }
1.91 www 407: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 408: '&cdomelement='+udom+
409: '&cnameelement='+desc;
1.468 raeburn 410: if (extra_element !=null && extra_element != '') {
1.594 raeburn 411: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 412: url += '&roleelement='+extra_element;
413: if (domainfilter == null || domainfilter == '') {
414: url += '&domainfilter='+extra_element;
415: }
1.234 raeburn 416: }
1.468 raeburn 417: else {
418: if (formname == 'portform') {
419: url += '&setroles='+extra_element;
420: }
421: }
1.230 raeburn 422: }
1.293 raeburn 423: if (multflag !=null && multflag != '') {
424: url += '&multiple='+multflag;
425: }
1.377 raeburn 426: if (crstype == 'Course/Group') {
427: if (formname == 'cu') {
428: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
429: if (crstype == "") {
430: alert("$crs_or_grp_alert");
431: return;
432: }
433: }
434: }
435: if (crstype !=null && crstype != '') {
436: url += '&type='+crstype;
437: }
1.102 www 438: var title = 'Course_Browser';
1.91 www 439: var options = 'scrollbars=1,resizable=1,menubar=0';
440: options += ',width=700,height=600';
441: stdeditbrowser = open(url,title,options,'1');
442: stdeditbrowser.focus();
443: }
1.468 raeburn 444:
445: function getFormIdByName(formname) {
446: for (var i=0;i<document.forms.length;i++) {
447: if (document.forms[i].name == formname) {
448: return i;
449: }
450: }
451: return -1;
452: }
453:
454: function getIndexByName(formid,item) {
455: for (var i=0;i<document.forms[formid].elements.length;i++) {
456: if (document.forms[formid].elements[i].name == item) {
457: return i;
458: }
459: }
460: return -1;
461: }
1.91 www 462: ENDSTDBRW
1.468 raeburn 463: if ($sec_element ne '') {
464: $output .= &setsec_javascript($sec_element,$formname);
465: }
466: $output .= '
467: </script>';
468: return $output;
469: }
470:
471: sub setsec_javascript {
472: my ($sec_element,$formname) = @_;
473: my $setsections = qq|
474: function setSect(sectionlist) {
1.629 raeburn 475: var sectionsArray = new Array();
476: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
477: sectionsArray = sectionlist.split(",");
478: }
1.468 raeburn 479: var numSections = sectionsArray.length;
480: document.$formname.$sec_element.length = 0;
481: if (numSections == 0) {
482: document.$formname.$sec_element.multiple=false;
483: document.$formname.$sec_element.size=1;
484: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
485: } else {
486: if (numSections == 1) {
487: document.$formname.$sec_element.multiple=false;
488: document.$formname.$sec_element.size=1;
489: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
490: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
491: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
492: } else {
493: for (var i=0; i<numSections; i++) {
494: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
495: }
496: document.$formname.$sec_element.multiple=true
497: if (numSections < 3) {
498: document.$formname.$sec_element.size=numSections;
499: } else {
500: document.$formname.$sec_element.size=3;
501: }
502: document.$formname.$sec_element.options[0].selected = false
503: }
504: }
1.91 www 505: }
1.468 raeburn 506: |;
507: return $setsections;
508: }
509:
1.91 www 510:
511: sub selectcourse_link {
1.377 raeburn 512: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 513: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
514: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 515: }
1.42 matthew 516:
1.273 raeburn 517: sub check_uncheck_jscript {
518: my $jscript = <<"ENDSCRT";
519: function checkAll(field) {
520: if (field.length > 0) {
521: for (i = 0; i < field.length; i++) {
522: field[i].checked = true ;
523: }
524: } else {
525: field.checked = true
526: }
527: }
528:
529: function uncheckAll(field) {
530: if (field.length > 0) {
531: for (i = 0; i < field.length; i++) {
532: field[i].checked = false ;
1.543 albertel 533: }
534: } else {
1.273 raeburn 535: field.checked = false ;
536: }
537: }
538: ENDSCRT
539: return $jscript;
540: }
541:
542:
1.42 matthew 543: =pod
1.36 matthew 544:
1.112 bowersj2 545: =item * linked_select_forms(...)
1.36 matthew 546:
547: linked_select_forms returns a string containing a <script></script> block
548: and html for two <select> menus. The select menus will be linked in that
549: changing the value of the first menu will result in new values being placed
550: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 551: order unless a defined order is provided.
1.36 matthew 552:
553: linked_select_forms takes the following ordered inputs:
554:
555: =over 4
556:
1.112 bowersj2 557: =item * $formname, the name of the <form> tag
1.36 matthew 558:
1.112 bowersj2 559: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 560:
1.112 bowersj2 561: =item * $firstdefault, the default value for the first menu
1.36 matthew 562:
1.112 bowersj2 563: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 564:
1.112 bowersj2 565: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 566:
1.112 bowersj2 567: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 568:
1.609 raeburn 569: =item * $menuorder, the order of values in the first menu
570:
1.41 ng 571: =back
572:
1.36 matthew 573: Below is an example of such a hash. Only the 'text', 'default', and
574: 'select2' keys must appear as stated. keys(%menu) are the possible
575: values for the first select menu. The text that coincides with the
1.41 ng 576: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 577: and text for the second menu are given in the hash pointed to by
578: $menu{$choice1}->{'select2'}.
579:
1.112 bowersj2 580: my %menu = ( A1 => { text =>"Choice A1" ,
581: default => "B3",
582: select2 => {
583: B1 => "Choice B1",
584: B2 => "Choice B2",
585: B3 => "Choice B3",
586: B4 => "Choice B4"
1.609 raeburn 587: },
588: order => ['B4','B3','B1','B2'],
1.112 bowersj2 589: },
590: A2 => { text =>"Choice A2" ,
591: default => "C2",
592: select2 => {
593: C1 => "Choice C1",
594: C2 => "Choice C2",
595: C3 => "Choice C3"
1.609 raeburn 596: },
597: order => ['C2','C1','C3'],
1.112 bowersj2 598: },
599: A3 => { text =>"Choice A3" ,
600: default => "D6",
601: select2 => {
602: D1 => "Choice D1",
603: D2 => "Choice D2",
604: D3 => "Choice D3",
605: D4 => "Choice D4",
606: D5 => "Choice D5",
607: D6 => "Choice D6",
608: D7 => "Choice D7"
1.609 raeburn 609: },
610: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 611: }
612: );
1.36 matthew 613:
614: =cut
615:
616: sub linked_select_forms {
617: my ($formname,
618: $middletext,
619: $firstdefault,
620: $firstselectname,
621: $secondselectname,
1.609 raeburn 622: $hashref,
623: $menuorder,
1.36 matthew 624: ) = @_;
625: my $second = "document.$formname.$secondselectname";
626: my $first = "document.$formname.$firstselectname";
627: # output the javascript to do the changing
628: my $result = '';
1.219 albertel 629: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 630: $result.="var select2data = new Object();\n";
631: $" = '","';
632: my $debug = '';
633: foreach my $s1 (sort(keys(%$hashref))) {
634: $result.="select2data.d_$s1 = new Object();\n";
635: $result.="select2data.d_$s1.def = new String('".
636: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 637: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 638: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 639: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
640: @s2values = @{$hashref->{$s1}->{'order'}};
641: }
1.36 matthew 642: $result.="\"@s2values\");\n";
643: $result.="select2data.d_$s1.texts = new Array(";
644: my @s2texts;
645: foreach my $value (@s2values) {
646: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
647: }
648: $result.="\"@s2texts\");\n";
649: }
650: $"=' ';
651: $result.= <<"END";
652:
653: function select1_changed() {
654: // Determine new choice
655: var newvalue = "d_" + $first.value;
656: // update select2
657: var values = select2data[newvalue].values;
658: var texts = select2data[newvalue].texts;
659: var select2def = select2data[newvalue].def;
660: var i;
661: // out with the old
662: for (i = 0; i < $second.options.length; i++) {
663: $second.options[i] = null;
664: }
665: // in with the nuclear
666: for (i=0;i<values.length; i++) {
667: $second.options[i] = new Option(values[i]);
1.143 matthew 668: $second.options[i].value = values[i];
1.36 matthew 669: $second.options[i].text = texts[i];
670: if (values[i] == select2def) {
671: $second.options[i].selected = true;
672: }
673: }
674: }
675: </script>
676: END
677: # output the initial values for the selection lists
678: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 679: my @order = sort(keys(%{$hashref}));
680: if (ref($menuorder) eq 'ARRAY') {
681: @order = @{$menuorder};
682: }
683: foreach my $value (@order) {
1.36 matthew 684: $result.=" <option value=\"$value\" ";
1.253 albertel 685: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 686: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 687: }
688: $result .= "</select>\n";
689: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
690: $result .= $middletext;
691: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
692: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 693:
694: my @secondorder = sort(keys(%select2));
695: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
696: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
697: }
698: foreach my $value (@secondorder) {
1.36 matthew 699: $result.=" <option value=\"$value\" ";
1.253 albertel 700: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 701: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 702: }
703: $result .= "</select>\n";
704: # return $debug;
705: return $result;
706: } # end of sub linked_select_forms {
707:
1.45 matthew 708: =pod
1.44 bowersj2 709:
1.112 bowersj2 710: =item * help_open_topic($topic, $text, $stayOnPage, $width, $height)
1.44 bowersj2 711:
1.112 bowersj2 712: Returns a string corresponding to an HTML link to the given help
713: $topic, where $topic corresponds to the name of a .tex file in
714: /home/httpd/html/adm/help/tex, with underscores replaced by
715: spaces.
716:
717: $text will optionally be linked to the same topic, allowing you to
718: link text in addition to the graphic. If you do not want to link
719: text, but wish to specify one of the later parameters, pass an
720: empty string.
721:
722: $stayOnPage is a value that will be interpreted as a boolean. If true,
723: the link will not open a new window. If false, the link will open
724: a new window using Javascript. (Default is false.)
725:
726: $width and $height are optional numerical parameters that will
727: override the width and height of the popped up window, which may
728: be useful for certain help topics with big pictures included.
1.44 bowersj2 729:
730: =cut
731:
732: sub help_open_topic {
1.48 bowersj2 733: my ($topic, $text, $stayOnPage, $width, $height) = @_;
734: $text = "" if (not defined $text);
1.44 bowersj2 735: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 736: if ($env{'browser.interface'} eq 'textual') {
1.79 www 737: $stayOnPage=1;
738: }
1.44 bowersj2 739: $width = 350 if (not defined $width);
740: $height = 400 if (not defined $height);
741: my $filename = $topic;
742: $filename =~ s/ /_/g;
743:
1.48 bowersj2 744: my $template = "";
745: my $link;
1.572 banghart 746:
1.159 www 747: $topic=~s/\W/\_/g;
1.44 bowersj2 748:
1.572 banghart 749: if (!$stayOnPage) {
1.72 bowersj2 750: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 751: } else {
1.48 bowersj2 752: $link = "/adm/help/${filename}.hlp";
753: }
754:
755: # Add the text
1.572 banghart 756: if ($text ne "") {
1.77 www 757: $template .=
1.572 banghart 758: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
759: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 760: }
761:
762: # Add the graphic
1.179 matthew 763: my $title = &mt('Online Help');
1.215 albertel 764: my $helpicon=&lonhttpdurl("/adm/help/gif/smallHelp.gif");
1.48 bowersj2 765: $template .= <<"ENDTEMPLATE";
1.436 albertel 766: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 767: ENDTEMPLATE
1.78 www 768: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 769: return $template;
770:
1.106 bowersj2 771: }
772:
773: # This is a quicky function for Latex cheatsheet editing, since it
774: # appears in at least four places
775: sub helpLatexCheatsheet {
776: my $other = shift;
777: my $addOther = '';
778: if ($other) {
779: $addOther = Apache::loncommon::help_open_topic($other, shift,
780: undef, undef, 600) .
781: '</td><td>';
782: }
783: return '<table><tr><td>'.
784: $addOther .
785: &Apache::loncommon::help_open_topic("Greek_Symbols",'Greek Symbols',
786: undef,undef,600)
787: .'</td><td>'.
788: &Apache::loncommon::help_open_topic("Other_Symbols",'Other Symbols',
789: undef,undef,600)
790: .'</td></tr></table>';
1.172 www 791: }
792:
1.430 albertel 793: sub general_help {
794: my $helptopic='Student_Intro';
795: if ($env{'request.role'}=~/^(ca|au)/) {
796: $helptopic='Authoring_Intro';
797: } elsif ($env{'request.role'}=~/^cc/) {
798: $helptopic='Course_Coordination_Intro';
799: }
800: return $helptopic;
801: }
802:
803: sub update_help_link {
804: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
805: my $origurl = $ENV{'REQUEST_URI'};
806: $origurl=~s|^/~|/priv/|;
807: my $timestamp = time;
808: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
809: $$datum = &escape($$datum);
810: }
811:
812: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
813: my $output .= <<"ENDOUTPUT";
814: <script type="text/javascript">
815: banner_link = '$banner_link';
816: </script>
817: ENDOUTPUT
818: return $output;
819: }
820:
821: # now just updates the help link and generates a blue icon
1.193 raeburn 822: sub help_open_menu {
1.430 albertel 823: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 824: = @_;
1.430 albertel 825: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 826: # only use pop-up help (stayOnPage == 0)
1.552 banghart 827: # if environment.remote is on (using remote control UI)
1.572 banghart 828: if ($env{'browser.interface'} eq 'textual' ||
829: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 830: $stayOnPage=1;
1.430 albertel 831: }
832: my $output;
833: if ($component_help) {
834: if (!$text) {
835: $output=&help_open_topic($component_help,undef,$stayOnPage,
836: $width,$height);
837: } else {
838: my $help_text;
839: $help_text=&unescape($topic);
840: $output='<table><tr><td>'.
841: &help_open_topic($component_help,$help_text,$stayOnPage,
842: $width,$height).'</td></tr></table>';
843: }
844: }
845: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
846: return $output.$banner_link;
847: }
848:
849: sub top_nav_help {
850: my ($text) = @_;
1.436 albertel 851: $text = &mt($text);
1.572 banghart 852: my $stay_on_page =
1.436 albertel 853: ($env{'browser.interface'} eq 'textual' ||
854: $env{'environment.remote'} eq 'off' );
1.572 banghart 855: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 856: : "javascript:helpMenu('open')";
1.572 banghart 857: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 858:
1.201 raeburn 859: my $title = &mt('Get help');
1.436 albertel 860:
861: return <<"END";
862: $banner_link
863: <a href="$link" title="$title">$text</a>
864: END
865: }
866:
867: sub help_menu_js {
868: my ($text) = @_;
869:
870: my $stayOnPage =
871: ($env{'browser.interface'} eq 'textual' ||
872: $env{'environment.remote'} eq 'off' );
873:
874: my $width = 620;
875: my $height = 600;
1.430 albertel 876: my $helptopic=&general_help();
877: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 878: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 879: my $start_page =
880: &Apache::loncommon::start_page('Help Menu', undef,
881: {'frameset' => 1,
882: 'js_ready' => 1,
883: 'add_entries' => {
884: 'border' => '0',
1.579 raeburn 885: 'rows' => "110,*",},});
1.331 albertel 886: my $end_page =
887: &Apache::loncommon::end_page({'frameset' => 1,
888: 'js_ready' => 1,});
889:
1.436 albertel 890: my $template .= <<"ENDTEMPLATE";
891: <script type="text/javascript">
1.253 albertel 892: // <!-- BEGIN LON-CAPA Internal
893: // <![CDATA[
1.430 albertel 894: var banner_link = '';
1.243 raeburn 895: function helpMenu(target) {
896: var caller = this;
897: if (target == 'open') {
898: var newWindow = null;
899: try {
1.262 albertel 900: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 901: }
902: catch(error) {
903: writeHelp(caller);
904: return;
905: }
906: if (newWindow) {
907: caller = newWindow;
908: }
1.193 raeburn 909: }
1.243 raeburn 910: writeHelp(caller);
911: return;
912: }
913: function writeHelp(caller) {
1.430 albertel 914: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 915: caller.document.close()
916: caller.focus()
1.193 raeburn 917: }
1.253 albertel 918: // ]]>
1.219 albertel 919: // END LON-CAPA Internal -->
1.436 albertel 920: </script>
1.193 raeburn 921: ENDTEMPLATE
922: return $template;
923: }
924:
1.172 www 925: sub help_open_bug {
926: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 927: unless ($env{'user.adv'}) { return ''; }
1.172 www 928: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
929: $text = "" if (not defined $text);
930: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 931: if ($env{'browser.interface'} eq 'textual' ||
932: $env{'environment.remote'} eq 'off' ) {
1.172 www 933: $stayOnPage=1;
934: }
1.184 albertel 935: $width = 600 if (not defined $width);
936: $height = 600 if (not defined $height);
1.172 www 937:
938: $topic=~s/\W+/\+/g;
939: my $link='';
940: my $template='';
1.379 albertel 941: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
942: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 943: if (!$stayOnPage)
944: {
945: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
946: }
947: else
948: {
949: $link = $url;
950: }
951: # Add the text
952: if ($text ne "")
953: {
954: $template .=
955: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 956: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 957: }
958:
959: # Add the graphic
1.179 matthew 960: my $title = &mt('Report a Bug');
1.215 albertel 961: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 962: $template .= <<"ENDTEMPLATE";
1.436 albertel 963: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 964: ENDTEMPLATE
965: if ($text ne '') { $template.='</td></tr></table>' };
966: return $template;
967:
968: }
969:
970: sub help_open_faq {
971: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 972: unless ($env{'user.adv'}) { return ''; }
1.172 www 973: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
974: $text = "" if (not defined $text);
975: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 976: if ($env{'browser.interface'} eq 'textual' ||
977: $env{'environment.remote'} eq 'off' ) {
1.172 www 978: $stayOnPage=1;
979: }
980: $width = 350 if (not defined $width);
981: $height = 400 if (not defined $height);
982:
983: $topic=~s/\W+/\+/g;
984: my $link='';
985: my $template='';
986: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
987: if (!$stayOnPage)
988: {
989: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
990: }
991: else
992: {
993: $link = $url;
994: }
995:
996: # Add the text
997: if ($text ne "")
998: {
999: $template .=
1.173 www 1000: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 1001: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 1002: }
1003:
1004: # Add the graphic
1.179 matthew 1005: my $title = &mt('View the FAQ');
1.215 albertel 1006: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1007: $template .= <<"ENDTEMPLATE";
1.436 albertel 1008: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1009: ENDTEMPLATE
1010: if ($text ne '') { $template.='</td></tr></table>' };
1011: return $template;
1012:
1.44 bowersj2 1013: }
1.37 matthew 1014:
1.180 matthew 1015: ###############################################################
1016: ###############################################################
1017:
1.45 matthew 1018: =pod
1019:
1.256 matthew 1020: =item * change_content_javascript():
1021:
1022: This and the next function allow you to create small sections of an
1023: otherwise static HTML page that you can update on the fly with
1024: Javascript, even in Netscape 4.
1025:
1026: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1027: must be written to the HTML page once. It will prove the Javascript
1028: function "change(name, content)". Calling the change function with the
1029: name of the section
1030: you want to update, matching the name passed to C<changable_area>, and
1031: the new content you want to put in there, will put the content into
1032: that area.
1033:
1034: B<Note>: Netscape 4 only reserves enough space for the changable area
1035: to contain room for the original contents. You need to "make space"
1036: for whatever changes you wish to make, and be B<sure> to check your
1037: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1038: it's adequate for updating a one-line status display, but little more.
1039: This script will set the space to 100% width, so you only need to
1040: worry about height in Netscape 4.
1041:
1042: Modern browsers are much less limiting, and if you can commit to the
1043: user not using Netscape 4, this feature may be used freely with
1044: pretty much any HTML.
1045:
1046: =cut
1047:
1048: sub change_content_javascript {
1049: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1050: if ($env{'browser.type'} eq 'netscape' &&
1051: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1052: return (<<NETSCAPE4);
1053: function change(name, content) {
1054: doc = document.layers[name+"___escape"].layers[0].document;
1055: doc.open();
1056: doc.write(content);
1057: doc.close();
1058: }
1059: NETSCAPE4
1060: } else {
1061: # Otherwise, we need to use semi-standards-compliant code
1062: # (technically, "innerHTML" isn't standard but the equivalent
1063: # is really scary, and every useful browser supports it
1064: return (<<DOMBASED);
1065: function change(name, content) {
1066: element = document.getElementById(name);
1067: element.innerHTML = content;
1068: }
1069: DOMBASED
1070: }
1071: }
1072:
1073: =pod
1074:
1075: =item * changable_area($name, $origContent):
1076:
1077: This provides a "changable area" that can be modified on the fly via
1078: the Javascript code provided in C<change_content_javascript>. $name is
1079: the name you will use to reference the area later; do not repeat the
1080: same name on a given HTML page more then once. $origContent is what
1081: the area will originally contain, which can be left blank.
1082:
1083: =cut
1084:
1085: sub changable_area {
1086: my ($name, $origContent) = @_;
1087:
1.258 albertel 1088: if ($env{'browser.type'} eq 'netscape' &&
1089: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1090: # If this is netscape 4, we need to use the Layer tag
1091: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1092: } else {
1093: return "<span id='$name'>$origContent</span>";
1094: }
1095: }
1096:
1097: =pod
1098:
1.590 raeburn 1099: =item * viewport_geometry_js {
1100:
1101: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1102:
1103: =cut
1104:
1105:
1106: sub viewport_geometry_js {
1107: return <<"GEOMETRY";
1108: var Geometry = {};
1109: function init_geometry() {
1110: if (Geometry.init) { return };
1111: Geometry.init=1;
1112: if (window.innerHeight) {
1113: Geometry.getViewportHeight = function() { return window.innerHeight; };
1114: Geometry.getViewportWidth = function() { return window.innerWidth; };
1115: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1116: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1117: }
1118: else if (document.documentElement && document.documentElement.clientHeight) {
1119: Geometry.getViewportHeight =
1120: function() { return document.documentElement.clientHeight; };
1121: Geometry.getViewportWidth =
1122: function() { return document.documentElement.clientWidth; };
1123:
1124: Geometry.getHorizontalScroll =
1125: function() { return document.documentElement.scrollLeft; };
1126: Geometry.getVerticalScroll =
1127: function() { return document.documentElement.scrollTop; };
1128: }
1129: else if (document.body.clientHeight) {
1130: Geometry.getViewportHeight =
1131: function() { return document.body.clientHeight; };
1132: Geometry.getViewportWidth =
1133: function() { return document.body.clientWidth; };
1134: Geometry.getHorizontalScroll =
1135: function() { return document.body.scrollLeft; };
1136: Geometry.getVerticalScroll =
1137: function() { return document.body.scrollTop; };
1138: }
1139: }
1140:
1141: GEOMETRY
1142: }
1143:
1144: =pod
1145:
1146: =item * viewport_size_js {
1147:
1148: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1149:
1150: =cut
1151:
1152: sub viewport_size_js {
1153: my $geometry = &viewport_geometry_js();
1154: return <<"DIMS";
1155:
1156: $geometry
1157:
1158: function getViewportDims(width,height) {
1159: init_geometry();
1160: width.value = Geometry.getViewportWidth();
1161: height.value = Geometry.getViewportHeight();
1162: return;
1163: }
1164:
1165: DIMS
1166: }
1167:
1168: =pod
1169:
1.565 albertel 1170: =item * resize_textarea_js
1171:
1172: emits the needed javascript to resize a textarea to be as big as possible
1173:
1174: creates a function resize_textrea that takes two IDs first should be
1175: the id of the element to resize, second should be the id of a div that
1176: surrounds everything that comes after the textarea, this routine needs
1177: to be attached to the <body> for the onload and onresize events.
1178:
1179:
1180: =cut
1181:
1182: sub resize_textarea_js {
1.590 raeburn 1183: my $geometry = &viewport_geometry_js();
1.565 albertel 1184: return <<"RESIZE";
1185: <script type="text/javascript">
1.590 raeburn 1186: $geometry
1.565 albertel 1187:
1.588 albertel 1188: function getX(element) {
1189: var x = 0;
1190: while (element) {
1191: x += element.offsetLeft;
1192: element = element.offsetParent;
1193: }
1194: return x;
1195: }
1196: function getY(element) {
1197: var y = 0;
1198: while (element) {
1199: y += element.offsetTop;
1200: element = element.offsetParent;
1201: }
1202: return y;
1203: }
1204:
1205:
1.565 albertel 1206: function resize_textarea(textarea_id,bottom_id) {
1207: init_geometry();
1208: var textarea = document.getElementById(textarea_id);
1209: //alert(textarea);
1210:
1.588 albertel 1211: var textarea_top = getY(textarea);
1.565 albertel 1212: var textarea_height = textarea.offsetHeight;
1213: var bottom = document.getElementById(bottom_id);
1.588 albertel 1214: var bottom_top = getY(bottom);
1.565 albertel 1215: var bottom_height = bottom.offsetHeight;
1216: var window_height = Geometry.getViewportHeight();
1.588 albertel 1217: var fudge = 23;
1.565 albertel 1218: var new_height = window_height-fudge-textarea_top-bottom_height;
1219: if (new_height < 300) {
1220: new_height = 300;
1221: }
1222: textarea.style.height=new_height+'px';
1223: }
1224: </script>
1225: RESIZE
1226:
1227: }
1228:
1229: =pod
1230:
1.256 matthew 1231: =back
1.542 raeburn 1232:
1.256 matthew 1233: =head1 Excel and CSV file utility routines
1234:
1235: =over 4
1236:
1237: =cut
1238:
1239: ###############################################################
1240: ###############################################################
1241:
1242: =pod
1243:
1.112 bowersj2 1244: =item * csv_translate($text)
1.37 matthew 1245:
1.185 www 1246: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1247: format.
1248:
1249: =cut
1250:
1.180 matthew 1251: ###############################################################
1252: ###############################################################
1.37 matthew 1253: sub csv_translate {
1254: my $text = shift;
1255: $text =~ s/\"/\"\"/g;
1.209 albertel 1256: $text =~ s/\n/ /g;
1.37 matthew 1257: return $text;
1258: }
1.180 matthew 1259:
1260: ###############################################################
1261: ###############################################################
1262:
1263: =pod
1264:
1265: =item * define_excel_formats
1266:
1267: Define some commonly used Excel cell formats.
1268:
1269: Currently supported formats:
1270:
1271: =over 4
1272:
1273: =item header
1274:
1275: =item bold
1276:
1277: =item h1
1278:
1279: =item h2
1280:
1281: =item h3
1282:
1.256 matthew 1283: =item h4
1284:
1285: =item i
1286:
1.180 matthew 1287: =item date
1288:
1289: =back
1290:
1291: Inputs: $workbook
1292:
1293: Returns: $format, a hash reference.
1294:
1295: =cut
1296:
1297: ###############################################################
1298: ###############################################################
1299: sub define_excel_formats {
1300: my ($workbook) = @_;
1301: my $format;
1302: $format->{'header'} = $workbook->add_format(bold => 1,
1303: bottom => 1,
1304: align => 'center');
1305: $format->{'bold'} = $workbook->add_format(bold=>1);
1306: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1307: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1308: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1309: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1310: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1311: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1312: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1313: return $format;
1314: }
1315:
1316: ###############################################################
1317: ###############################################################
1.113 bowersj2 1318:
1319: =pod
1320:
1.256 matthew 1321: =item * create_workbook
1.255 matthew 1322:
1323: Create an Excel worksheet. If it fails, output message on the
1324: request object and return undefs.
1325:
1326: Inputs: Apache request object
1327:
1328: Returns (undef) on failure,
1329: Excel worksheet object, scalar with filename, and formats
1330: from &Apache::loncommon::define_excel_formats on success
1331:
1332: =cut
1333:
1334: ###############################################################
1335: ###############################################################
1336: sub create_workbook {
1337: my ($r) = @_;
1338: #
1339: # Create the excel spreadsheet
1340: my $filename = '/prtspool/'.
1.258 albertel 1341: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1342: time.'_'.rand(1000000000).'.xls';
1343: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1344: if (! defined($workbook)) {
1345: $r->log_error("Error creating excel spreadsheet $filename: $!");
1346: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1347: "This error has been logged. ".
1348: "Please alert your LON-CAPA administrator").
1349: '</p>');
1350: return (undef);
1351: }
1352: #
1353: $workbook->set_tempdir('/home/httpd/perl/tmp');
1354: #
1355: my $format = &Apache::loncommon::define_excel_formats($workbook);
1356: return ($workbook,$filename,$format);
1357: }
1358:
1359: ###############################################################
1360: ###############################################################
1361:
1362: =pod
1363:
1.256 matthew 1364: =item * create_text_file
1.113 bowersj2 1365:
1.542 raeburn 1366: Create a file to write to and eventually make available to the user.
1.256 matthew 1367: If file creation fails, outputs an error message on the request object and
1368: return undefs.
1.113 bowersj2 1369:
1.256 matthew 1370: Inputs: Apache request object, and file suffix
1.113 bowersj2 1371:
1.256 matthew 1372: Returns (undef) on failure,
1373: Filehandle and filename on success.
1.113 bowersj2 1374:
1375: =cut
1376:
1.256 matthew 1377: ###############################################################
1378: ###############################################################
1379: sub create_text_file {
1380: my ($r,$suffix) = @_;
1381: if (! defined($suffix)) { $suffix = 'txt'; };
1382: my $fh;
1383: my $filename = '/prtspool/'.
1.258 albertel 1384: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1385: time.'_'.rand(1000000000).'.'.$suffix;
1386: $fh = Apache::File->new('>/home/httpd'.$filename);
1387: if (! defined($fh)) {
1388: $r->log_error("Couldn't open $filename for output $!");
1389: $r->print("Problems occured in creating the output file. ".
1390: "This error has been logged. ".
1391: "Please alert your LON-CAPA administrator.");
1.113 bowersj2 1392: }
1.256 matthew 1393: return ($fh,$filename)
1.113 bowersj2 1394: }
1395:
1396:
1.256 matthew 1397: =pod
1.113 bowersj2 1398:
1399: =back
1400:
1401: =cut
1.37 matthew 1402:
1403: ###############################################################
1.33 matthew 1404: ## Home server <option> list generating code ##
1405: ###############################################################
1.35 matthew 1406:
1.169 www 1407: # ------------------------------------------
1408:
1409: sub domain_select {
1410: my ($name,$value,$multiple)=@_;
1411: my %domains=map {
1.514 albertel 1412: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1413: } &Apache::lonnet::all_domains();
1.169 www 1414: if ($multiple) {
1415: $domains{''}=&mt('Any domain');
1.550 albertel 1416: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1417: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1418: } else {
1.550 albertel 1419: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1420: return &select_form($name,$value,%domains);
1421: }
1422: }
1423:
1.282 albertel 1424: #-------------------------------------------
1425:
1426: =pod
1427:
1.519 raeburn 1428: =head1 Routines for form select boxes
1429:
1430: =over 4
1431:
1.287 albertel 1432: =item * multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1433:
1434: Returns a string containing a <select> element int multiple mode
1435:
1436:
1437: Args:
1438: $name - name of the <select> element
1.506 raeburn 1439: $value - scalar or array ref of values that should already be selected
1.282 albertel 1440: $size - number of rows long the select element is
1.283 albertel 1441: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1442: (shown text should already have been &mt())
1.506 raeburn 1443: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1444:
1.282 albertel 1445: =cut
1446:
1447: #-------------------------------------------
1.169 www 1448: sub multiple_select_form {
1.284 albertel 1449: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1450: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1451: my $output='';
1.191 matthew 1452: if (! defined($size)) {
1453: $size = 4;
1.283 albertel 1454: if (scalar(keys(%$hash))<4) {
1455: $size = scalar(keys(%$hash));
1.191 matthew 1456: }
1457: }
1.169 www 1458: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501 banghart 1459: my @order;
1.506 raeburn 1460: if (ref($order) eq 'ARRAY') {
1461: @order = @{$order};
1462: } else {
1463: @order = sort(keys(%$hash));
1.501 banghart 1464: }
1465: if (exists($$hash{'select_form_order'})) {
1466: @order = @{$$hash{'select_form_order'}};
1467: }
1468:
1.284 albertel 1469: foreach my $key (@order) {
1.356 albertel 1470: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1471: $output.='selected="selected" ' if ($selected{$key});
1472: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1473: }
1474: $output.="</select>\n";
1475: return $output;
1476: }
1477:
1.88 www 1478: #-------------------------------------------
1479:
1480: =pod
1481:
1.112 bowersj2 1482: =item * select_form($defdom,$name,%hash)
1.88 www 1483:
1484: Returns a string containing a <select name='$name' size='1'> form to
1485: allow a user to select options from a hash option_name => displayed text.
1486: See lonrights.pm for an example invocation and use.
1487:
1488: =cut
1489:
1490: #-------------------------------------------
1491: sub select_form {
1492: my ($def,$name,%hash) = @_;
1493: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1494: my @keys;
1495: if (exists($hash{'select_form_order'})) {
1496: @keys=@{$hash{'select_form_order'}};
1497: } else {
1498: @keys=sort(keys(%hash));
1499: }
1.356 albertel 1500: foreach my $key (@keys) {
1501: $selectform.=
1502: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1503: ($key eq $def ? 'selected="selected" ' : '').
1504: ">".&mt($hash{$key})."</option>\n";
1.88 www 1505: }
1506: $selectform.="</select>";
1507: return $selectform;
1508: }
1509:
1.475 www 1510: # For display filters
1511:
1512: sub display_filter {
1513: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1514: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475 www 1515: return '<nobr><label>'.&mt('Records [_1]',
1516: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1517: (&mt('all'),10,20,50,100,1000,10000))).
1.478 www 1518: '</label></nobr> <nobr>'.
1.475 www 1519: &mt('Filter [_1]',
1.477 www 1520: &select_form($env{'form.displayfilter'},
1521: 'displayfilter',
1522: ('currentfolder' => 'Current folder/page',
1523: 'containing' => 'Containing phrase',
1524: 'none' => 'None'))).
1.478 www 1525: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475 www 1526: }
1527:
1.167 www 1528: sub gradeleveldescription {
1529: my $gradelevel=shift;
1530: my %gradelevels=(0 => 'Not specified',
1531: 1 => 'Grade 1',
1532: 2 => 'Grade 2',
1533: 3 => 'Grade 3',
1534: 4 => 'Grade 4',
1535: 5 => 'Grade 5',
1536: 6 => 'Grade 6',
1537: 7 => 'Grade 7',
1538: 8 => 'Grade 8',
1539: 9 => 'Grade 9',
1540: 10 => 'Grade 10',
1541: 11 => 'Grade 11',
1542: 12 => 'Grade 12',
1543: 13 => 'Grade 13',
1544: 14 => '100 Level',
1545: 15 => '200 Level',
1546: 16 => '300 Level',
1547: 17 => '400 Level',
1548: 18 => 'Graduate Level');
1549: return &mt($gradelevels{$gradelevel});
1550: }
1551:
1.163 www 1552: sub select_level_form {
1553: my ($deflevel,$name)=@_;
1554: unless ($deflevel) { $deflevel=0; }
1.167 www 1555: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1556: for (my $i=0; $i<=18; $i++) {
1557: $selectform.="<option value=\"$i\" ".
1.253 albertel 1558: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1559: ">".&gradeleveldescription($i)."</option>\n";
1560: }
1561: $selectform.="</select>";
1562: return $selectform;
1.163 www 1563: }
1.167 www 1564:
1.35 matthew 1565: #-------------------------------------------
1566:
1.45 matthew 1567: =pod
1568:
1.563 raeburn 1569: =item * select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1570:
1571: Returns a string containing a <select name='$name' size='1'> form to
1572: allow a user to select the domain to preform an operation in.
1573: See loncreateuser.pm for an example invocation and use.
1574:
1.90 www 1575: If the $includeempty flag is set, it also includes an empty choice ("no domain
1576: selected");
1577:
1.563 raeburn 1578: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1579:
1.35 matthew 1580: =cut
1581:
1582: #-------------------------------------------
1.34 matthew 1583: sub select_dom_form {
1.563 raeburn 1584: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1585: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1586: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1587: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1588: foreach my $dom (@domains) {
1589: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1590: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1591: if ($showdomdesc) {
1592: if ($dom ne '') {
1593: my $domdesc = &Apache::lonnet::domain($dom,'description');
1594: if ($domdesc ne '') {
1595: $selectdomain .= ' ('.$domdesc.')';
1596: }
1597: }
1598: }
1599: $selectdomain .= "</option>\n";
1.34 matthew 1600: }
1601: $selectdomain.="</select>";
1602: return $selectdomain;
1603: }
1604:
1.35 matthew 1605: #-------------------------------------------
1606:
1.45 matthew 1607: =pod
1608:
1.586 raeburn 1609: =item * home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1610:
1.586 raeburn 1611: input: 4 arguments (two required, two optional) -
1612: $domain - domain of new user
1613: $name - name of form element
1614: $default - Value of 'default' causes a default item to be first
1615: option, and selected by default.
1616: $hide - Value of 'hide' causes hiding of the name of the server,
1617: if 1 server found, or default, if 0 found.
1.594 raeburn 1618: output: returns 2 items:
1.586 raeburn 1619: (a) form element which contains either:
1620: (i) <select name="$name">
1621: <option value="$hostid1">$hostid $servers{$hostid}</option>
1622: <option value="$hostid2">$hostid $servers{$hostid}</option>
1623: </select>
1624: form item if there are multiple library servers in $domain, or
1625: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1626: if there is only one library server in $domain.
1627:
1628: (b) number of library servers found.
1629:
1630: See loncreateuser.pm for example of use.
1.35 matthew 1631:
1632: =cut
1633:
1634: #-------------------------------------------
1.586 raeburn 1635: sub home_server_form_item {
1636: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1637: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1638: my $result;
1639: my $numlib = keys(%servers);
1640: if ($numlib > 1) {
1641: $result .= '<select name="'.$name.'" />'."\n";
1642: if ($default) {
1643: $result .= '<option value="default" selected>'.&mt('default').
1644: '</option>'."\n";
1645: }
1646: foreach my $hostid (sort(keys(%servers))) {
1647: $result.= '<option value="'.$hostid.'">'.
1648: $hostid.' '.$servers{$hostid}."</option>\n";
1649: }
1650: $result .= '</select>'."\n";
1651: } elsif ($numlib == 1) {
1652: my $hostid;
1653: foreach my $item (keys(%servers)) {
1654: $hostid = $item;
1655: }
1656: $result .= '<input type="hidden" name="'.$name.'" value="'.
1657: $hostid.'" />';
1658: if (!$hide) {
1659: $result .= $hostid.' '.$servers{$hostid};
1660: }
1661: $result .= "\n";
1662: } elsif ($default) {
1663: $result .= '<input type="hidden" name="'.$name.
1664: '" value="default" />';
1665: if (!$hide) {
1666: $result .= &mt('default');
1667: }
1668: $result .= "\n";
1.33 matthew 1669: }
1.586 raeburn 1670: return ($result,$numlib);
1.33 matthew 1671: }
1.112 bowersj2 1672:
1673: =pod
1674:
1.534 albertel 1675: =back
1676:
1.112 bowersj2 1677: =cut
1.87 matthew 1678:
1679: ###############################################################
1.112 bowersj2 1680: ## Decoding User Agent ##
1.87 matthew 1681: ###############################################################
1682:
1683: =pod
1684:
1.112 bowersj2 1685: =head1 Decoding the User Agent
1686:
1687: =over 4
1688:
1689: =item * &decode_user_agent()
1.87 matthew 1690:
1691: Inputs: $r
1692:
1693: Outputs:
1694:
1695: =over 4
1696:
1.112 bowersj2 1697: =item * $httpbrowser
1.87 matthew 1698:
1.112 bowersj2 1699: =item * $clientbrowser
1.87 matthew 1700:
1.112 bowersj2 1701: =item * $clientversion
1.87 matthew 1702:
1.112 bowersj2 1703: =item * $clientmathml
1.87 matthew 1704:
1.112 bowersj2 1705: =item * $clientunicode
1.87 matthew 1706:
1.112 bowersj2 1707: =item * $clientos
1.87 matthew 1708:
1709: =back
1710:
1.157 matthew 1711: =back
1712:
1.87 matthew 1713: =cut
1714:
1715: ###############################################################
1716: ###############################################################
1717: sub decode_user_agent {
1.247 albertel 1718: my ($r)=@_;
1.87 matthew 1719: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1720: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1721: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1722: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1723: my $clientbrowser='unknown';
1724: my $clientversion='0';
1725: my $clientmathml='';
1726: my $clientunicode='0';
1727: for (my $i=0;$i<=$#browsertype;$i++) {
1728: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1729: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1730: $clientbrowser=$bname;
1731: $httpbrowser=~/$vreg/i;
1732: $clientversion=$1;
1733: $clientmathml=($clientversion>=$minv);
1734: $clientunicode=($clientversion>=$univ);
1735: }
1736: }
1737: my $clientos='unknown';
1738: if (($httpbrowser=~/linux/i) ||
1739: ($httpbrowser=~/unix/i) ||
1740: ($httpbrowser=~/ux/i) ||
1741: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1742: if (($httpbrowser=~/vax/i) ||
1743: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1744: if ($httpbrowser=~/next/i) { $clientos='next'; }
1745: if (($httpbrowser=~/mac/i) ||
1746: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1747: if ($httpbrowser=~/win/i) { $clientos='win'; }
1748: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1749: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1750: $clientunicode,$clientos,);
1751: }
1752:
1.32 matthew 1753: ###############################################################
1754: ## Authentication changing form generation subroutines ##
1755: ###############################################################
1756: ##
1757: ## All of the authform_xxxxxxx subroutines take their inputs in a
1758: ## hash, and have reasonable default values.
1759: ##
1760: ## formname = the name given in the <form> tag.
1.35 matthew 1761: #-------------------------------------------
1762:
1.45 matthew 1763: =pod
1764:
1.112 bowersj2 1765: =head1 Authentication Routines
1766:
1767: =over 4
1768:
1769: =item * authform_xxxxxx
1.35 matthew 1770:
1771: The authform_xxxxxx subroutines provide javascript and html forms which
1772: handle some of the conveniences required for authentication forms.
1773: This is not an optimal method, but it works.
1774:
1775: See loncreateuser.pm for invocation and use examples.
1776:
1777: =over 4
1778:
1.112 bowersj2 1779: =item * authform_header
1.35 matthew 1780:
1.112 bowersj2 1781: =item * authform_authorwarning
1.35 matthew 1782:
1.112 bowersj2 1783: =item * authform_nochange
1.35 matthew 1784:
1.112 bowersj2 1785: =item * authform_kerberos
1.35 matthew 1786:
1.112 bowersj2 1787: =item * authform_internal
1.35 matthew 1788:
1.112 bowersj2 1789: =item * authform_filesystem
1.35 matthew 1790:
1791: =back
1792:
1.157 matthew 1793: =back
1794:
1.35 matthew 1795: =cut
1796:
1797: #-------------------------------------------
1.32 matthew 1798: sub authform_header{
1799: my %in = (
1800: formname => 'cu',
1.80 albertel 1801: kerb_def_dom => '',
1.32 matthew 1802: @_,
1803: );
1804: $in{'formname'} = 'document.' . $in{'formname'};
1805: my $result='';
1.80 albertel 1806:
1807: #---------------------------------------------- Code for upper case translation
1808: my $Javascript_toUpperCase;
1809: unless ($in{kerb_def_dom}) {
1810: $Javascript_toUpperCase =<<"END";
1811: switch (choice) {
1812: case 'krb': currentform.elements[choicearg].value =
1813: currentform.elements[choicearg].value.toUpperCase();
1814: break;
1815: default:
1816: }
1817: END
1818: } else {
1819: $Javascript_toUpperCase = "";
1820: }
1821:
1.165 raeburn 1822: my $radioval = "'nochange'";
1.591 raeburn 1823: if (defined($in{'curr_authtype'})) {
1824: if ($in{'curr_authtype'} ne '') {
1825: $radioval = "'".$in{'curr_authtype'}."arg'";
1826: }
1.174 matthew 1827: }
1.165 raeburn 1828: my $argfield = 'null';
1.591 raeburn 1829: if (defined($in{'mode'})) {
1.165 raeburn 1830: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 1831: if (defined($in{'curr_autharg'})) {
1832: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 1833: $argfield = "'$in{'curr_autharg'}'";
1834: }
1835: }
1836: }
1837: }
1838:
1.32 matthew 1839: $result.=<<"END";
1840: var current = new Object();
1.165 raeburn 1841: current.radiovalue = $radioval;
1842: current.argfield = $argfield;
1.32 matthew 1843:
1844: function changed_radio(choice,currentform) {
1845: var choicearg = choice + 'arg';
1846: // If a radio button in changed, we need to change the argfield
1847: if (current.radiovalue != choice) {
1848: current.radiovalue = choice;
1849: if (current.argfield != null) {
1850: currentform.elements[current.argfield].value = '';
1851: }
1852: if (choice == 'nochange') {
1853: current.argfield = null;
1854: } else {
1855: current.argfield = choicearg;
1856: switch(choice) {
1857: case 'krb':
1858: currentform.elements[current.argfield].value =
1859: "$in{'kerb_def_dom'}";
1860: break;
1861: default:
1862: break;
1863: }
1864: }
1865: }
1866: return;
1867: }
1.22 www 1868:
1.32 matthew 1869: function changed_text(choice,currentform) {
1870: var choicearg = choice + 'arg';
1871: if (currentform.elements[choicearg].value !='') {
1.80 albertel 1872: $Javascript_toUpperCase
1.32 matthew 1873: // clear old field
1874: if ((current.argfield != choicearg) && (current.argfield != null)) {
1875: currentform.elements[current.argfield].value = '';
1876: }
1877: current.argfield = choicearg;
1878: }
1879: set_auth_radio_buttons(choice,currentform);
1880: return;
1.20 www 1881: }
1.32 matthew 1882:
1883: function set_auth_radio_buttons(newvalue,currentform) {
1884: var i=0;
1885: while (i < currentform.login.length) {
1886: if (currentform.login[i].value == newvalue) { break; }
1887: i++;
1888: }
1889: if (i == currentform.login.length) {
1890: return;
1891: }
1892: current.radiovalue = newvalue;
1893: currentform.login[i].checked = true;
1894: return;
1895: }
1896: END
1897: return $result;
1898: }
1899:
1900: sub authform_authorwarning{
1901: my $result='';
1.144 matthew 1902: $result='<i>'.
1903: &mt('As a general rule, only authors or co-authors should be '.
1904: 'filesystem authenticated '.
1905: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 1906: return $result;
1907: }
1908:
1909: sub authform_nochange{
1910: my %in = (
1911: formname => 'document.cu',
1912: kerb_def_dom => 'MSU.EDU',
1913: @_,
1914: );
1.586 raeburn 1915: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1916: my $result;
1917: if (keys(%can_assign) == 0) {
1918: $result = &mt('Under you current role you are not permitted to change login settings for this user');
1919: } else {
1920: $result = '<label>'.&mt('[_1] Do not change login data',
1921: '<input type="radio" name="login" value="nochange" '.
1922: 'checked="checked" onclick="'.
1.281 albertel 1923: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
1924: '</label>';
1.586 raeburn 1925: }
1.32 matthew 1926: return $result;
1927: }
1928:
1.591 raeburn 1929: sub authform_kerberos {
1.32 matthew 1930: my %in = (
1931: formname => 'document.cu',
1932: kerb_def_dom => 'MSU.EDU',
1.80 albertel 1933: kerb_def_auth => 'krb4',
1.32 matthew 1934: @_,
1935: );
1.586 raeburn 1936: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
1937: $autharg,$jscall);
1938: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 1939: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 1940: $check5 = ' checked="on"';
1.80 albertel 1941: } else {
1.586 raeburn 1942: $check4 = ' checked="on"';
1.80 albertel 1943: }
1.165 raeburn 1944: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 1945: if (defined($in{'curr_authtype'})) {
1946: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 1947: $krbcheck = ' checked="on"';
1.623 raeburn 1948: if (defined($in{'mode'})) {
1949: if ($in{'mode'} eq 'modifyuser') {
1950: $krbcheck = '';
1951: }
1952: }
1.591 raeburn 1953: if (defined($in{'curr_kerb_ver'})) {
1954: if ($in{'curr_krb_ver'} eq '5') {
1955: $check5 = ' checked="on"';
1956: $check4 = '';
1957: } else {
1958: $check4 = ' checked="on"';
1959: $check5 = '';
1960: }
1.586 raeburn 1961: }
1.591 raeburn 1962: if (defined($in{'curr_autharg'})) {
1.165 raeburn 1963: $krbarg = $in{'curr_autharg'};
1964: }
1.586 raeburn 1965: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 1966: if (defined($in{'curr_autharg'})) {
1.586 raeburn 1967: $result =
1968: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
1969: $in{'curr_autharg'},$krbver);
1970: } else {
1971: $result =
1972: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
1973: }
1974: return $result;
1975: }
1976: }
1977: } else {
1978: if ($authnum == 1) {
1979: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 1980: }
1981: }
1.586 raeburn 1982: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1983: return;
1.587 raeburn 1984: } elsif ($authtype eq '') {
1.591 raeburn 1985: if (defined($in{'mode'})) {
1.587 raeburn 1986: if ($in{'mode'} eq 'modifycourse') {
1987: if ($authnum == 1) {
1988: $authtype = '<input type="hidden" name="login" value="krb">';
1989: }
1990: }
1991: }
1.586 raeburn 1992: }
1993: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
1994: if ($authtype eq '') {
1995: $authtype = '<input type="radio" name="login" value="krb" '.
1996: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
1997: $krbcheck.' />';
1998: }
1999: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2000: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2001: $in{'curr_authtype'} eq 'krb5') ||
2002: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2003: $in{'curr_authtype'} eq 'krb4')) {
2004: $result .= &mt
1.144 matthew 2005: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2006: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2007: '<label>'.$authtype,
1.281 albertel 2008: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2009: 'value="'.$krbarg.'" '.
1.144 matthew 2010: 'onchange="'.$jscall.'" />',
1.281 albertel 2011: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2012: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2013: '</label>');
1.586 raeburn 2014: } elsif ($can_assign{'krb4'}) {
2015: $result .= &mt
2016: ('[_1] Kerberos authenticated with domain [_2] '.
2017: '[_3] Version 4 [_4]',
2018: '<label>'.$authtype,
2019: '</label><input type="text" size="10" name="krbarg" '.
2020: 'value="'.$krbarg.'" '.
2021: 'onchange="'.$jscall.'" />',
2022: '<label><input type="hidden" name="krbver" value="4" />',
2023: '</label>');
2024: } elsif ($can_assign{'krb5'}) {
2025: $result .= &mt
2026: ('[_1] Kerberos authenticated with domain [_2] '.
2027: '[_3] Version 5 [_4]',
2028: '<label>'.$authtype,
2029: '</label><input type="text" size="10" name="krbarg" '.
2030: 'value="'.$krbarg.'" '.
2031: 'onchange="'.$jscall.'" />',
2032: '<label><input type="hidden" name="krbver" value="5" />',
2033: '</label>');
2034: }
1.32 matthew 2035: return $result;
2036: }
2037:
2038: sub authform_internal{
1.586 raeburn 2039: my %in = (
1.32 matthew 2040: formname => 'document.cu',
2041: kerb_def_dom => 'MSU.EDU',
2042: @_,
2043: );
1.586 raeburn 2044: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2045: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2046: if (defined($in{'curr_authtype'})) {
2047: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2048: if ($can_assign{'int'}) {
2049: $intcheck = 'checked="on" ';
1.623 raeburn 2050: if (defined($in{'mode'})) {
2051: if ($in{'mode'} eq 'modifyuser') {
2052: $intcheck = '';
2053: }
2054: }
1.591 raeburn 2055: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2056: $intarg = $in{'curr_autharg'};
2057: }
2058: } else {
2059: $result = &mt('Currently internally authenticated.');
2060: return $result;
1.165 raeburn 2061: }
2062: }
1.586 raeburn 2063: } else {
2064: if ($authnum == 1) {
2065: $authtype = '<input type="hidden" name="login" value="int">';
2066: }
2067: }
2068: if (!$can_assign{'int'}) {
2069: return;
1.587 raeburn 2070: } elsif ($authtype eq '') {
1.591 raeburn 2071: if (defined($in{'mode'})) {
1.587 raeburn 2072: if ($in{'mode'} eq 'modifycourse') {
2073: if ($authnum == 1) {
2074: $authtype = '<input type="hidden" name="login" value="int">';
2075: }
2076: }
2077: }
1.165 raeburn 2078: }
1.586 raeburn 2079: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2080: if ($authtype eq '') {
2081: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2082: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2083: }
1.605 bisitz 2084: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2085: $intarg.'" onchange="'.$jscall.'" />';
2086: $result = &mt
1.144 matthew 2087: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2088: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2089: $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2090: return $result;
2091: }
2092:
2093: sub authform_local{
2094: my %in = (
2095: formname => 'document.cu',
2096: kerb_def_dom => 'MSU.EDU',
2097: @_,
2098: );
1.586 raeburn 2099: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2100: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2101: if (defined($in{'curr_authtype'})) {
2102: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2103: if ($can_assign{'loc'}) {
2104: $loccheck = 'checked="on" ';
1.623 raeburn 2105: if (defined($in{'mode'})) {
2106: if ($in{'mode'} eq 'modifyuser') {
2107: $loccheck = '';
2108: }
2109: }
1.591 raeburn 2110: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2111: $locarg = $in{'curr_autharg'};
2112: }
2113: } else {
2114: $result = &mt('Currently using local (institutional) authentication.');
2115: return $result;
1.165 raeburn 2116: }
2117: }
1.586 raeburn 2118: } else {
2119: if ($authnum == 1) {
2120: $authtype = '<input type="hidden" name="login" value="loc">';
2121: }
2122: }
2123: if (!$can_assign{'loc'}) {
2124: return;
1.587 raeburn 2125: } elsif ($authtype eq '') {
1.591 raeburn 2126: if (defined($in{'mode'})) {
1.587 raeburn 2127: if ($in{'mode'} eq 'modifycourse') {
2128: if ($authnum == 1) {
2129: $authtype = '<input type="hidden" name="login" value="loc">';
2130: }
2131: }
2132: }
1.165 raeburn 2133: }
1.586 raeburn 2134: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2135: if ($authtype eq '') {
2136: $authtype = '<input type="radio" name="login" value="loc" '.
2137: $loccheck.' onchange="'.$jscall.'" onclick="'.
2138: $jscall.'" />';
2139: }
2140: $autharg = '<input type="text" size="10" name="locarg" value="'.
2141: $locarg.'" onchange="'.$jscall.'" />';
2142: $result = &mt('[_1] Local Authentication with argument [_2]',
2143: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2144: return $result;
2145: }
2146:
2147: sub authform_filesystem{
2148: my %in = (
2149: formname => 'document.cu',
2150: kerb_def_dom => 'MSU.EDU',
2151: @_,
2152: );
1.586 raeburn 2153: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2154: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2155: if (defined($in{'curr_authtype'})) {
2156: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2157: if ($can_assign{'fsys'}) {
2158: $fsyscheck = 'checked="on" ';
1.623 raeburn 2159: if (defined($in{'mode'})) {
2160: if ($in{'mode'} eq 'modifyuser') {
2161: $fsyscheck = '';
2162: }
2163: }
1.586 raeburn 2164: } else {
2165: $result = &mt('Currently Filesystem Authenticated.');
2166: return $result;
2167: }
2168: }
2169: } else {
2170: if ($authnum == 1) {
2171: $authtype = '<input type="hidden" name="login" value="fsys">';
2172: }
2173: }
2174: if (!$can_assign{'fsys'}) {
2175: return;
1.587 raeburn 2176: } elsif ($authtype eq '') {
1.591 raeburn 2177: if (defined($in{'mode'})) {
1.587 raeburn 2178: if ($in{'mode'} eq 'modifycourse') {
2179: if ($authnum == 1) {
2180: $authtype = '<input type="hidden" name="login" value="fsys">';
2181: }
2182: }
2183: }
1.586 raeburn 2184: }
2185: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2186: if ($authtype eq '') {
2187: $authtype = '<input type="radio" name="login" value="fsys" '.
2188: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2189: $jscall.'" />';
2190: }
2191: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2192: ' onchange="'.$jscall.'" />';
2193: $result = &mt
1.144 matthew 2194: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2195: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2196: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2197: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2198: 'onchange="'.$jscall.'" />');
1.32 matthew 2199: return $result;
2200: }
2201:
1.586 raeburn 2202: sub get_assignable_auth {
2203: my ($dom) = @_;
2204: if ($dom eq '') {
2205: $dom = $env{'request.role.domain'};
2206: }
2207: my %can_assign = (
2208: krb4 => 1,
2209: krb5 => 1,
2210: int => 1,
2211: loc => 1,
2212: );
2213: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2214: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2215: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2216: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2217: my $context;
2218: if ($env{'request.role'} =~ /^au/) {
2219: $context = 'author';
2220: } elsif ($env{'request.role'} =~ /^dc/) {
2221: $context = 'domain';
2222: } elsif ($env{'request.course.id'}) {
2223: $context = 'course';
2224: }
2225: if ($context) {
2226: if (ref($authhash->{$context}) eq 'HASH') {
2227: %can_assign = %{$authhash->{$context}};
2228: }
2229: }
2230: }
2231: }
2232: my $authnum = 0;
2233: foreach my $key (keys(%can_assign)) {
2234: if ($can_assign{$key}) {
2235: $authnum ++;
2236: }
2237: }
2238: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2239: $authnum --;
2240: }
2241: return ($authnum,%can_assign);
2242: }
2243:
1.80 albertel 2244: ###############################################################
2245: ## Get Authentication Defaults for Domain ##
2246: ###############################################################
2247:
2248: =pod
2249:
1.112 bowersj2 2250: =head1 Domains and Authentication
2251:
2252: Returns default authentication type and an associated argument as
2253: listed in file 'domain.tab'.
2254:
2255: =over 4
2256:
2257: =item * get_auth_defaults
1.80 albertel 2258:
2259: get_auth_defaults($target_domain) returns the default authentication
2260: type and an associated argument (initial password or a kerberos domain).
2261: These values are stored in lonTabs/domain.tab
2262:
2263: ($def_auth, $def_arg) = &get_auth_defaults($target_domain);
2264:
2265: If target_domain is not found in domain.tab, returns nothing ('').
2266:
2267: =cut
2268:
2269: #-------------------------------------------
2270: sub get_auth_defaults {
2271: my $domain=shift;
1.514 albertel 2272: return (&Apache::lonnet::domain($domain,'auth_def'),
2273: &Apache::lonnet::domain($domain,'auth_arg_def'));
2274:
1.80 albertel 2275: }
2276: ###############################################################
2277: ## End Get Authentication Defaults for Domain ##
2278: ###############################################################
2279:
2280: ###############################################################
2281: ## Get Kerberos Defaults for Domain ##
2282: ###############################################################
2283: ##
2284: ## Returns default kerberos version and an associated argument
2285: ## as listed in file domain.tab. If not listed, provides
2286: ## appropriate default domain and kerberos version.
2287: ##
2288: #-------------------------------------------
2289:
2290: =pod
2291:
1.112 bowersj2 2292: =item * get_kerberos_defaults
1.80 albertel 2293:
2294: get_kerberos_defaults($target_domain) returns the default kerberos
2295: version and domain. If not found in domain.tabs, it defaults to
2296: version 4 and the domain of the server.
2297:
2298: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2299:
2300: =cut
2301:
2302: #-------------------------------------------
2303: sub get_kerberos_defaults {
2304: my $domain=shift;
2305: my ($krbdef,$krbdefdom) =
2306: &Apache::loncommon::get_auth_defaults($domain);
2307: unless ($krbdef =~/^krb/ && $krbdefdom) {
2308: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2309: my $krbdefdom=$1;
2310: $krbdefdom=~tr/a-z/A-Z/;
2311: $krbdef = "krb4";
2312: }
2313: return ($krbdef,$krbdefdom);
2314: }
1.112 bowersj2 2315:
2316: =pod
2317:
2318: =back
2319:
2320: =cut
1.32 matthew 2321:
1.46 matthew 2322: ###############################################################
2323: ## Thesaurus Functions ##
2324: ###############################################################
1.20 www 2325:
1.46 matthew 2326: =pod
1.20 www 2327:
1.112 bowersj2 2328: =head1 Thesaurus Functions
2329:
2330: =over 4
2331:
2332: =item * initialize_keywords
1.46 matthew 2333:
2334: Initializes the package variable %Keywords if it is empty. Uses the
2335: package variable $thesaurus_db_file.
2336:
2337: =cut
2338:
2339: ###################################################
2340:
2341: sub initialize_keywords {
2342: return 1 if (scalar keys(%Keywords));
2343: # If we are here, %Keywords is empty, so fill it up
2344: # Make sure the file we need exists...
2345: if (! -e $thesaurus_db_file) {
2346: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2347: " failed because it does not exist");
2348: return 0;
2349: }
2350: # Set up the hash as a database
2351: my %thesaurus_db;
2352: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2353: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2354: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2355: $thesaurus_db_file);
2356: return 0;
2357: }
2358: # Get the average number of appearances of a word.
2359: my $avecount = $thesaurus_db{'average.count'};
2360: # Put keywords (those that appear > average) into %Keywords
2361: while (my ($word,$data)=each (%thesaurus_db)) {
2362: my ($count,undef) = split /:/,$data;
2363: $Keywords{$word}++ if ($count > $avecount);
2364: }
2365: untie %thesaurus_db;
2366: # Remove special values from %Keywords.
1.356 albertel 2367: foreach my $value ('total.count','average.count') {
2368: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2369: }
1.46 matthew 2370: return 1;
2371: }
2372:
2373: ###################################################
2374:
2375: =pod
2376:
1.112 bowersj2 2377: =item * keyword($word)
1.46 matthew 2378:
2379: Returns true if $word is a keyword. A keyword is a word that appears more
2380: than the average number of times in the thesaurus database. Calls
2381: &initialize_keywords
2382:
2383: =cut
2384:
2385: ###################################################
1.20 www 2386:
2387: sub keyword {
1.46 matthew 2388: return if (!&initialize_keywords());
2389: my $word=lc(shift());
2390: $word=~s/\W//g;
2391: return exists($Keywords{$word});
1.20 www 2392: }
1.46 matthew 2393:
2394: ###############################################################
2395:
2396: =pod
1.20 www 2397:
1.112 bowersj2 2398: =item * get_related_words
1.46 matthew 2399:
1.160 matthew 2400: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2401: an array of words. If the keyword is not in the thesaurus, an empty array
2402: will be returned. The order of the words returned is determined by the
2403: database which holds them.
2404:
2405: Uses global $thesaurus_db_file.
2406:
2407: =cut
2408:
2409: ###############################################################
2410: sub get_related_words {
2411: my $keyword = shift;
2412: my %thesaurus_db;
2413: if (! -e $thesaurus_db_file) {
2414: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2415: "failed because the file does not exist");
2416: return ();
2417: }
2418: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2419: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2420: return ();
2421: }
2422: my @Words=();
1.429 www 2423: my $count=0;
1.46 matthew 2424: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2425: # The first element is the number of times
2426: # the word appears. We do not need it now.
1.429 www 2427: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2428: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2429: my $threshold=$mostfrequentcount/10;
2430: foreach my $possibleword (@RelatedWords) {
2431: my ($word,$wordcount)=split(/\,/,$possibleword);
2432: if ($wordcount>$threshold) {
2433: push(@Words,$word);
2434: $count++;
2435: if ($count>10) { last; }
2436: }
1.20 www 2437: }
2438: }
1.46 matthew 2439: untie %thesaurus_db;
2440: return @Words;
1.14 harris41 2441: }
1.46 matthew 2442:
1.112 bowersj2 2443: =pod
2444:
2445: =back
2446:
2447: =cut
1.61 www 2448:
2449: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2450: =pod
2451:
1.112 bowersj2 2452: =head1 User Name Functions
2453:
2454: =over 4
2455:
1.226 albertel 2456: =item * plainname($uname,$udom,$first)
1.81 albertel 2457:
1.112 bowersj2 2458: Takes a users logon name and returns it as a string in
1.226 albertel 2459: "first middle last generation" form
2460: if $first is set to 'lastname' then it returns it as
2461: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2462:
2463: =cut
1.61 www 2464:
1.295 www 2465:
1.81 albertel 2466: ###############################################################
1.61 www 2467: sub plainname {
1.226 albertel 2468: my ($uname,$udom,$first)=@_;
1.537 albertel 2469: return if (!defined($uname) || !defined($udom));
1.295 www 2470: my %names=&getnames($uname,$udom);
1.226 albertel 2471: my $name=&Apache::lonnet::format_name($names{'firstname'},
2472: $names{'middlename'},
2473: $names{'lastname'},
2474: $names{'generation'},$first);
2475: $name=~s/^\s+//;
1.62 www 2476: $name=~s/\s+$//;
2477: $name=~s/\s+/ /g;
1.353 albertel 2478: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2479: return $name;
1.61 www 2480: }
1.66 www 2481:
2482: # -------------------------------------------------------------------- Nickname
1.81 albertel 2483: =pod
2484:
1.112 bowersj2 2485: =item * nickname($uname,$udom)
1.81 albertel 2486:
2487: Gets a users name and returns it as a string as
2488:
2489: ""nickname""
1.66 www 2490:
1.81 albertel 2491: if the user has a nickname or
2492:
2493: "first middle last generation"
2494:
2495: if the user does not
2496:
2497: =cut
1.66 www 2498:
2499: sub nickname {
2500: my ($uname,$udom)=@_;
1.537 albertel 2501: return if (!defined($uname) || !defined($udom));
1.295 www 2502: my %names=&getnames($uname,$udom);
1.68 albertel 2503: my $name=$names{'nickname'};
1.66 www 2504: if ($name) {
2505: $name='"'.$name.'"';
2506: } else {
2507: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2508: $names{'lastname'}.' '.$names{'generation'};
2509: $name=~s/\s+$//;
2510: $name=~s/\s+/ /g;
2511: }
2512: return $name;
2513: }
2514:
1.295 www 2515: sub getnames {
2516: my ($uname,$udom)=@_;
1.537 albertel 2517: return if (!defined($uname) || !defined($udom));
1.433 albertel 2518: if ($udom eq 'public' && $uname eq 'public') {
2519: return ('lastname' => &mt('Public'));
2520: }
1.295 www 2521: my $id=$uname.':'.$udom;
2522: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2523: if ($cached) {
2524: return %{$names};
2525: } else {
2526: my %loadnames=&Apache::lonnet::get('environment',
2527: ['firstname','middlename','lastname','generation','nickname'],
2528: $udom,$uname);
2529: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2530: return %loadnames;
2531: }
2532: }
1.61 www 2533:
1.542 raeburn 2534: # -------------------------------------------------------------------- getemails
2535: =pod
2536:
2537: =item * getemails($uname,$udom)
2538:
2539: Gets a user's email information and returns it as a hash with keys:
2540: notification, critnotification, permanentemail
2541:
2542: For notification and critnotification, values are comma-separated lists
2543: of e-mail address(es); for permanentemail, value is a single e-mail address.
2544:
2545: =cut
2546:
1.466 albertel 2547: sub getemails {
2548: my ($uname,$udom)=@_;
2549: if ($udom eq 'public' && $uname eq 'public') {
2550: return;
2551: }
1.467 www 2552: if (!$udom) { $udom=$env{'user.domain'}; }
2553: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2554: my $id=$uname.':'.$udom;
2555: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2556: if ($cached) {
2557: return %{$names};
2558: } else {
2559: my %loadnames=&Apache::lonnet::get('environment',
2560: ['notification','critnotification',
2561: 'permanentemail'],
2562: $udom,$uname);
2563: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2564: return %loadnames;
2565: }
2566: }
2567:
1.551 albertel 2568: sub flush_email_cache {
2569: my ($uname,$udom)=@_;
2570: if (!$udom) { $udom =$env{'user.domain'}; }
2571: if (!$uname) { $uname=$env{'user.name'}; }
2572: return if ($udom eq 'public' && $uname eq 'public');
2573: my $id=$uname.':'.$udom;
2574: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2575: }
2576:
1.61 www 2577: # ------------------------------------------------------------------ Screenname
1.81 albertel 2578:
2579: =pod
2580:
1.112 bowersj2 2581: =item * screenname($uname,$udom)
1.81 albertel 2582:
2583: Gets a users screenname and returns it as a string
2584:
2585: =cut
1.61 www 2586:
2587: sub screenname {
2588: my ($uname,$udom)=@_;
1.258 albertel 2589: if ($uname eq $env{'user.name'} &&
2590: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2591: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2592: return $names{'screenname'};
1.62 www 2593: }
2594:
1.212 albertel 2595:
1.62 www 2596: # ------------------------------------------------------------- Message Wrapper
2597:
2598: sub messagewrapper {
1.369 www 2599: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2600: return
1.441 albertel 2601: '<a href="/adm/email?compose=individual&'.
2602: 'recname='.$username.'&recdom='.$domain.
2603: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2604: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2605: }
2606: # --------------------------------------------------------------- Notes Wrapper
2607:
2608: sub noteswrapper {
2609: my ($link,$un,$do)=@_;
2610: return
2611: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2612: }
2613: # ------------------------------------------------------------- Aboutme Wrapper
2614:
2615: sub aboutmewrapper {
1.166 www 2616: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2617: if (!defined($username) && !defined($domain)) {
2618: return;
2619: }
1.205 www 2620: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2621: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2622: }
2623:
2624: # ------------------------------------------------------------ Syllabus Wrapper
2625:
2626:
2627: sub syllabuswrapper {
1.109 matthew 2628: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2629: if ($fontcolor) {
2630: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2631: }
1.208 matthew 2632: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2633: }
1.14 harris41 2634:
1.208 matthew 2635: sub track_student_link {
1.268 albertel 2636: my ($linktext,$sname,$sdom,$target,$start) = @_;
2637: my $link ="/adm/trackstudent?";
1.208 matthew 2638: my $title = 'View recent activity';
2639: if (defined($sname) && $sname !~ /^\s*$/ &&
2640: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2641: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2642: $title .= ' of this student';
1.268 albertel 2643: }
1.208 matthew 2644: if (defined($target) && $target !~ /^\s*$/) {
2645: $target = qq{target="$target"};
2646: } else {
2647: $target = '';
2648: }
1.268 albertel 2649: if ($start) { $link.='&start='.$start; }
1.554 albertel 2650: $title = &mt($title);
2651: $linktext = &mt($linktext);
1.448 albertel 2652: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2653: &help_open_topic('View_recent_activity');
1.208 matthew 2654: }
2655:
1.508 www 2656: # ===================================================== Display a student photo
2657:
2658:
1.509 albertel 2659: sub student_image_tag {
1.508 www 2660: my ($domain,$user)=@_;
2661: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2662: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2663: return '<img src="'.$imgsrc.'" align="right" />';
2664: } else {
2665: return '';
2666: }
2667: }
2668:
1.112 bowersj2 2669: =pod
2670:
2671: =back
2672:
2673: =head1 Access .tab File Data
2674:
2675: =over 4
2676:
2677: =item * languageids()
2678:
2679: returns list of all language ids
2680:
2681: =cut
2682:
1.14 harris41 2683: sub languageids {
1.16 harris41 2684: return sort(keys(%language));
1.14 harris41 2685: }
2686:
1.112 bowersj2 2687: =pod
2688:
2689: =item * languagedescription()
2690:
2691: returns description of a specified language id
2692:
2693: =cut
2694:
1.14 harris41 2695: sub languagedescription {
1.125 www 2696: my $code=shift;
2697: return ($supported_language{$code}?'* ':'').
2698: $language{$code}.
1.126 www 2699: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2700: }
2701:
2702: sub plainlanguagedescription {
2703: my $code=shift;
2704: return $language{$code};
2705: }
2706:
2707: sub supportedlanguagecode {
2708: my $code=shift;
2709: return $supported_language{$code};
1.97 www 2710: }
2711:
1.112 bowersj2 2712: =pod
2713:
2714: =item * copyrightids()
2715:
2716: returns list of all copyrights
2717:
2718: =cut
2719:
2720: sub copyrightids {
2721: return sort(keys(%cprtag));
2722: }
2723:
2724: =pod
2725:
2726: =item * copyrightdescription()
2727:
2728: returns description of a specified copyright id
2729:
2730: =cut
2731:
2732: sub copyrightdescription {
1.166 www 2733: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2734: }
1.197 matthew 2735:
2736: =pod
2737:
1.192 taceyjo1 2738: =item * source_copyrightids()
2739:
2740: returns list of all source copyrights
2741:
2742: =cut
2743:
2744: sub source_copyrightids {
2745: return sort(keys(%scprtag));
2746: }
2747:
2748: =pod
2749:
2750: =item * source_copyrightdescription()
2751:
2752: returns description of a specified source copyright id
2753:
2754: =cut
2755:
2756: sub source_copyrightdescription {
2757: return &mt($scprtag{shift(@_)});
2758: }
1.112 bowersj2 2759:
2760: =pod
2761:
2762: =item * filecategories()
2763:
2764: returns list of all file categories
2765:
2766: =cut
2767:
2768: sub filecategories {
2769: return sort(keys(%category_extensions));
2770: }
2771:
2772: =pod
2773:
2774: =item * filecategorytypes()
2775:
2776: returns list of file types belonging to a given file
2777: category
2778:
2779: =cut
2780:
2781: sub filecategorytypes {
1.356 albertel 2782: my ($cat) = @_;
2783: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2784: }
2785:
2786: =pod
2787:
2788: =item * fileembstyle()
2789:
2790: returns embedding style for a specified file type
2791:
2792: =cut
2793:
2794: sub fileembstyle {
2795: return $fe{lc(shift(@_))};
1.169 www 2796: }
2797:
1.351 www 2798: sub filemimetype {
2799: return $fm{lc(shift(@_))};
2800: }
2801:
1.169 www 2802:
2803: sub filecategoryselect {
2804: my ($name,$value)=@_;
1.189 matthew 2805: return &select_form($value,$name,
1.169 www 2806: '' => &mt('Any category'),
2807: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2808: }
2809:
2810: =pod
2811:
2812: =item * filedescription()
2813:
2814: returns description for a specified file type
2815:
2816: =cut
2817:
2818: sub filedescription {
1.188 matthew 2819: my $file_description = $fd{lc(shift())};
2820: $file_description =~ s:([\[\]]):~$1:g;
2821: return &mt($file_description);
1.112 bowersj2 2822: }
2823:
2824: =pod
2825:
2826: =item * filedescriptionex()
2827:
2828: returns description for a specified file type with
2829: extra formatting
2830:
2831: =cut
2832:
2833: sub filedescriptionex {
2834: my $ex=shift;
1.188 matthew 2835: my $file_description = $fd{lc($ex)};
2836: $file_description =~ s:([\[\]]):~$1:g;
2837: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2838: }
2839:
2840: # End of .tab access
2841: =pod
2842:
2843: =back
2844:
2845: =cut
2846:
2847: # ------------------------------------------------------------------ File Types
2848: sub fileextensions {
2849: return sort(keys(%fe));
2850: }
2851:
1.97 www 2852: # ----------------------------------------------------------- Display Languages
2853: # returns a hash with all desired display languages
2854: #
2855:
2856: sub display_languages {
2857: my %languages=();
1.356 albertel 2858: foreach my $lang (&preferred_languages()) {
2859: $languages{$lang}=1;
1.97 www 2860: }
2861: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 2862: if ($env{'form.displaylanguage'}) {
1.356 albertel 2863: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
2864: $languages{$lang}=1;
1.97 www 2865: }
2866: }
2867: return %languages;
1.14 harris41 2868: }
2869:
1.117 www 2870: sub preferred_languages {
2871: my @languages=();
1.258 albertel 2872: if ($env{'course.'.$env{'request.course.id'}.'.languages'}) {
1.117 www 2873: @languages=(@languages,split(/\s*(\,|\;|\:)\s*/,
1.258 albertel 2874: $env{'course.'.$env{'request.course.id'}.'.languages'}));
1.177 www 2875: }
1.258 albertel 2876: if ($env{'environment.languages'}) {
1.459 albertel 2877: @languages=(@languages,
2878: split(/\s*(\,|\;|\:)\s*/,$env{'environment.languages'}));
1.118 www 2879: }
1.583 albertel 2880: my $browser=$ENV{'HTTP_ACCEPT_LANGUAGE'};
1.162 www 2881: if ($browser) {
1.583 albertel 2882: my @browser =
2883: map { (split(/\s*;\s*/,$_))[0] } (split(/\s*,\s*/,$browser));
2884: push(@languages,@browser);
1.162 www 2885: }
1.514 albertel 2886: if (&Apache::lonnet::domain($env{'user.domain'},'lang_def')) {
1.118 www 2887: @languages=(@languages,
1.514 albertel 2888: &Apache::lonnet::domain($env{'user.domain'},
2889: 'lang_def'));
1.118 www 2890: }
1.514 albertel 2891: if (&Apache::lonnet::domain($env{'request.role.domain'},'lang_def')) {
1.118 www 2892: @languages=(@languages,
1.514 albertel 2893: &Apache::lonnet::domain($env{'request.role.domain'},
2894: 'lang_def'));
1.118 www 2895: }
1.514 albertel 2896: if (&Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2897: 'lang_def')) {
1.118 www 2898: @languages=(@languages,
1.514 albertel 2899: &Apache::lonnet::domain($Apache::lonnet::perlvar{'lonDefDomain'},
2900: 'lang_def'));
1.118 www 2901: }
2902: # turn "en-ca" into "en-ca,en"
2903: my @genlanguages;
1.356 albertel 2904: foreach my $lang (@languages) {
2905: unless ($lang=~/\w/) { next; }
1.583 albertel 2906: push(@genlanguages,$lang);
1.356 albertel 2907: if ($lang=~/(\-|\_)/) {
2908: push(@genlanguages,(split(/(\-|\_)/,$lang))[0]);
1.118 www 2909: }
2910: }
1.583 albertel 2911: #uniqueify the languages list
2912: my %count;
2913: @genlanguages = map { $count{$_}++ == 0 ? $_ : () } @genlanguages;
1.118 www 2914: return @genlanguages;
1.117 www 2915: }
2916:
1.582 albertel 2917: sub languages {
2918: my ($possible_langs) = @_;
2919: my @preferred_langs = &preferred_languages();
2920: if (!ref($possible_langs)) {
2921: if( wantarray ) {
2922: return @preferred_langs;
2923: } else {
2924: return $preferred_langs[0];
2925: }
2926: }
2927: my %possibilities = map { $_ => 1 } (@$possible_langs);
2928: my @preferred_possibilities;
2929: foreach my $preferred_lang (@preferred_langs) {
2930: if (exists($possibilities{$preferred_lang})) {
2931: push(@preferred_possibilities, $preferred_lang);
2932: }
2933: }
2934: if( wantarray ) {
2935: return @preferred_possibilities;
2936: }
2937: return $preferred_possibilities[0];
2938: }
2939:
1.112 bowersj2 2940: ###############################################################
2941: ## Student Answer Attempts ##
2942: ###############################################################
2943:
2944: =pod
2945:
2946: =head1 Alternate Problem Views
2947:
2948: =over 4
2949:
2950: =item * get_previous_attempt($symb, $username, $domain, $course,
2951: $getattempt, $regexp, $gradesub)
2952:
2953: Return string with previous attempt on problem. Arguments:
2954:
2955: =over 4
2956:
2957: =item * $symb: Problem, including path
2958:
2959: =item * $username: username of the desired student
2960:
2961: =item * $domain: domain of the desired student
1.14 harris41 2962:
1.112 bowersj2 2963: =item * $course: Course ID
1.14 harris41 2964:
1.112 bowersj2 2965: =item * $getattempt: Leave blank for all attempts, otherwise put
2966: something
1.14 harris41 2967:
1.112 bowersj2 2968: =item * $regexp: if string matches this regexp, the string will be
2969: sent to $gradesub
1.14 harris41 2970:
1.112 bowersj2 2971: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 2972:
1.112 bowersj2 2973: =back
1.14 harris41 2974:
1.112 bowersj2 2975: The output string is a table containing all desired attempts, if any.
1.16 harris41 2976:
1.112 bowersj2 2977: =cut
1.1 albertel 2978:
2979: sub get_previous_attempt {
1.43 ng 2980: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 2981: my $prevattempts='';
1.43 ng 2982: no strict 'refs';
1.1 albertel 2983: if ($symb) {
1.3 albertel 2984: my (%returnhash)=
2985: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 2986: if ($returnhash{'version'}) {
2987: my %lasthash=();
2988: my $version;
2989: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 2990: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
2991: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 2992: }
1.1 albertel 2993: }
1.596 albertel 2994: $prevattempts=&start_data_table().&start_data_table_header_row();
2995: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 2996: foreach my $key (sort(keys(%lasthash))) {
2997: my ($ign,@parts) = split(/\./,$key);
1.41 ng 2998: if ($#parts > 0) {
1.31 albertel 2999: my $data=$parts[-1];
3000: pop(@parts);
1.596 albertel 3001: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3002: } else {
1.41 ng 3003: if ($#parts == 0) {
3004: $prevattempts.='<th>'.$parts[0].'</th>';
3005: } else {
3006: $prevattempts.='<th>'.$ign.'</th>';
3007: }
1.31 albertel 3008: }
1.16 harris41 3009: }
1.596 albertel 3010: $prevattempts.=&end_data_table_header_row();
1.40 ng 3011: if ($getattempt eq '') {
3012: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3013: $prevattempts.=&start_data_table_row().
3014: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3015: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3016: my $value = &format_previous_attempt_value($key,
3017: $returnhash{$version.':'.$key});
3018: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3019: }
1.596 albertel 3020: $prevattempts.=&end_data_table_row();
1.40 ng 3021: }
1.1 albertel 3022: }
1.596 albertel 3023: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3024: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3025: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3026: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3027: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3028: }
1.596 albertel 3029: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3030: } else {
1.596 albertel 3031: $prevattempts=
3032: &start_data_table().&start_data_table_row().
3033: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3034: &end_data_table_row().&end_data_table();
1.1 albertel 3035: }
3036: } else {
1.596 albertel 3037: $prevattempts=
3038: &start_data_table().&start_data_table_row().
3039: '<td>'.&mt('No data.').'</td>'.
3040: &end_data_table_row().&end_data_table();
1.1 albertel 3041: }
1.10 albertel 3042: }
3043:
1.581 albertel 3044: sub format_previous_attempt_value {
3045: my ($key,$value) = @_;
3046: if ($key =~ /timestamp/) {
3047: $value = &Apache::lonlocal::locallocaltime($value);
3048: } elsif (ref($value) eq 'ARRAY') {
3049: $value = '('.join(', ', @{ $value }).')';
3050: } else {
3051: $value = &unescape($value);
3052: }
3053: return $value;
3054: }
3055:
3056:
1.107 albertel 3057: sub relative_to_absolute {
3058: my ($url,$output)=@_;
3059: my $parser=HTML::TokeParser->new(\$output);
3060: my $token;
3061: my $thisdir=$url;
3062: my @rlinks=();
3063: while ($token=$parser->get_token) {
3064: if ($token->[0] eq 'S') {
3065: if ($token->[1] eq 'a') {
3066: if ($token->[2]->{'href'}) {
3067: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3068: }
3069: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3070: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3071: } elsif ($token->[1] eq 'base') {
3072: $thisdir=$token->[2]->{'href'};
3073: }
3074: }
3075: }
3076: $thisdir=~s-/[^/]*$--;
1.356 albertel 3077: foreach my $link (@rlinks) {
3078: unless (($link=~/^http:\/\//i) ||
3079: ($link=~/^\//) ||
3080: ($link=~/^javascript:/i) ||
3081: ($link=~/^mailto:/i) ||
3082: ($link=~/^\#/)) {
3083: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3084: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3085: }
3086: }
3087: # -------------------------------------------------- Deal with Applet codebases
3088: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3089: return $output;
3090: }
3091:
1.112 bowersj2 3092: =pod
3093:
3094: =item * get_student_view
3095:
3096: show a snapshot of what student was looking at
3097:
3098: =cut
3099:
1.10 albertel 3100: sub get_student_view {
1.186 albertel 3101: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3102: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3103: my (%form);
1.10 albertel 3104: my @elements=('symb','courseid','domain','username');
3105: foreach my $element (@elements) {
1.186 albertel 3106: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3107: }
1.186 albertel 3108: if (defined($moreenv)) {
3109: %form=(%form,%{$moreenv});
3110: }
1.236 albertel 3111: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3112: $feedurl=&Apache::lonnet::clutter($feedurl);
1.186 albertel 3113: my $userview=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3114: $userview=~s/\<body[^\>]*\>//gi;
3115: $userview=~s/\<\/body\>//gi;
3116: $userview=~s/\<html\>//gi;
3117: $userview=~s/\<\/html\>//gi;
3118: $userview=~s/\<head\>//gi;
3119: $userview=~s/\<\/head\>//gi;
3120: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3121: $userview=&relative_to_absolute($feedurl,$userview);
1.11 albertel 3122: return $userview;
3123: }
3124:
1.112 bowersj2 3125: =pod
3126:
3127: =item * get_student_answers()
3128:
3129: show a snapshot of how student was answering problem
3130:
3131: =cut
3132:
1.11 albertel 3133: sub get_student_answers {
1.100 sakharuk 3134: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3135: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3136: my (%moreenv);
1.11 albertel 3137: my @elements=('symb','courseid','domain','username');
3138: foreach my $element (@elements) {
1.186 albertel 3139: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3140: }
1.186 albertel 3141: $moreenv{'grade_target'}='answer';
3142: %moreenv=(%form,%moreenv);
1.497 raeburn 3143: $feedurl = &Apache::lonnet::clutter($feedurl);
3144: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3145: return $userview;
1.1 albertel 3146: }
1.116 albertel 3147:
3148: =pod
3149:
3150: =item * &submlink()
3151:
1.242 albertel 3152: Inputs: $text $uname $udom $symb $target
1.116 albertel 3153:
3154: Returns: A link to grades.pm such as to see the SUBM view of a student
3155:
3156: =cut
3157:
3158: ###############################################
3159: sub submlink {
1.242 albertel 3160: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3161: if (!($uname && $udom)) {
3162: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3163: &Apache::lonnet::whichuser($symb);
1.116 albertel 3164: if (!$symb) { $symb=$cursymb; }
3165: }
1.254 matthew 3166: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3167: $symb=&escape($symb);
1.242 albertel 3168: if ($target) { $target="target=\"$target\""; }
3169: return '<a href="/adm/grades?&command=submission&'.
3170: 'symb='.$symb.'&student='.$uname.
3171: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3172: }
3173: ##############################################
3174:
3175: =pod
3176:
3177: =item * &pgrdlink()
3178:
3179: Inputs: $text $uname $udom $symb $target
3180:
3181: Returns: A link to grades.pm such as to see the PGRD view of a student
3182:
3183: =cut
3184:
3185: ###############################################
3186: sub pgrdlink {
3187: my $link=&submlink(@_);
3188: $link=~s/(&command=submission)/$1&showgrading=yes/;
3189: return $link;
3190: }
3191: ##############################################
3192:
3193: =pod
3194:
3195: =item * &pprmlink()
3196:
3197: Inputs: $text $uname $udom $symb $target
3198:
3199: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3200: student and a specific resource
1.242 albertel 3201:
3202: =cut
3203:
3204: ###############################################
3205: sub pprmlink {
3206: my ($text,$uname,$udom,$symb,$target)=@_;
3207: if (!($uname && $udom)) {
3208: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3209: &Apache::lonnet::whichuser($symb);
1.242 albertel 3210: if (!$symb) { $symb=$cursymb; }
3211: }
1.254 matthew 3212: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3213: $symb=&escape($symb);
1.242 albertel 3214: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3215: return '<a href="/adm/parmset?command=set&'.
3216: 'symb='.$symb.'&uname='.$uname.
3217: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3218: }
3219: ##############################################
1.37 matthew 3220:
1.112 bowersj2 3221: =pod
3222:
3223: =back
3224:
3225: =cut
3226:
1.37 matthew 3227: ###############################################
1.51 www 3228:
3229:
3230: sub timehash {
3231: my @ltime=localtime(shift);
3232: return ( 'seconds' => $ltime[0],
3233: 'minutes' => $ltime[1],
3234: 'hours' => $ltime[2],
3235: 'day' => $ltime[3],
3236: 'month' => $ltime[4]+1,
3237: 'year' => $ltime[5]+1900,
3238: 'weekday' => $ltime[6],
3239: 'dayyear' => $ltime[7]+1,
3240: 'dlsav' => $ltime[8] );
3241: }
3242:
1.370 www 3243: sub utc_string {
3244: my ($date)=@_;
1.371 www 3245: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3246: }
3247:
1.51 www 3248: sub maketime {
3249: my %th=@_;
3250: return POSIX::mktime(
3251: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3252: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3253: }
3254:
3255: #########################################
1.51 www 3256:
3257: sub findallcourses {
1.482 raeburn 3258: my ($roles,$uname,$udom) = @_;
1.355 albertel 3259: my %roles;
3260: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3261: my %courses;
1.51 www 3262: my $now=time;
1.482 raeburn 3263: if (!defined($uname)) {
3264: $uname = $env{'user.name'};
3265: }
3266: if (!defined($udom)) {
3267: $udom = $env{'user.domain'};
3268: }
3269: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3270: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3271: if (!%roles) {
3272: %roles = (
3273: cc => 1,
3274: in => 1,
3275: ep => 1,
3276: ta => 1,
3277: cr => 1,
3278: st => 1,
3279: );
3280: }
3281: foreach my $entry (keys(%roleshash)) {
3282: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3283: if ($trole =~ /^cr/) {
3284: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3285: } else {
3286: next if (!exists($roles{$trole}));
3287: }
3288: if ($tend) {
3289: next if ($tend < $now);
3290: }
3291: if ($tstart) {
3292: next if ($tstart > $now);
3293: }
3294: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3295: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3296: if ($secpart eq '') {
3297: ($cnum,$role) = split(/_/,$cnumpart);
3298: $sec = 'none';
3299: $realsec = '';
3300: } else {
3301: $cnum = $cnumpart;
3302: ($sec,$role) = split(/_/,$secpart);
3303: $realsec = $sec;
1.490 raeburn 3304: }
1.482 raeburn 3305: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3306: }
3307: } else {
3308: foreach my $key (keys(%env)) {
1.483 albertel 3309: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3310: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3311: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3312: next if ($role eq 'ca' || $role eq 'aa');
3313: next if (%roles && !exists($roles{$role}));
3314: my ($starttime,$endtime)=split(/\./,$env{$key});
3315: my $active=1;
3316: if ($starttime) {
3317: if ($now<$starttime) { $active=0; }
3318: }
3319: if ($endtime) {
3320: if ($now>$endtime) { $active=0; }
3321: }
3322: if ($active) {
3323: if ($sec eq '') {
3324: $sec = 'none';
3325: }
3326: $courses{$cdom.'_'.$cnum}{$sec} =
3327: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3328: }
3329: }
1.51 www 3330: }
3331: }
1.474 raeburn 3332: return %courses;
1.51 www 3333: }
1.37 matthew 3334:
1.54 www 3335: ###############################################
1.474 raeburn 3336:
3337: sub blockcheck {
1.482 raeburn 3338: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3339:
3340: if (!defined($udom)) {
3341: $udom = $env{'user.domain'};
3342: }
3343: if (!defined($uname)) {
3344: $uname = $env{'user.name'};
3345: }
3346:
3347: # If uname and udom are for a course, check for blocks in the course.
3348:
3349: if (&Apache::lonnet::is_course($udom,$uname)) {
3350: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3351: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3352: return ($startblock,$endblock);
3353: }
1.474 raeburn 3354:
1.502 raeburn 3355: my $startblock = 0;
3356: my $endblock = 0;
1.482 raeburn 3357: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3358:
1.490 raeburn 3359: # If uname is for a user, and activity is course-specific, i.e.,
3360: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3361:
1.490 raeburn 3362: if (($activity eq 'boards' || $activity eq 'chat' ||
3363: $activity eq 'groups') && ($env{'request.course.id'})) {
3364: foreach my $key (keys(%live_courses)) {
3365: if ($key ne $env{'request.course.id'}) {
3366: delete($live_courses{$key});
3367: }
3368: }
3369: }
3370:
3371: my $otheruser = 0;
3372: my %own_courses;
3373: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3374: # Resource belongs to user other than current user.
3375: $otheruser = 1;
3376: # Gather courses for current user
3377: %own_courses =
3378: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3379: }
3380:
3381: # Gather active course roles - course coordinator, instructor,
3382: # exam proctor, ta, student, or custom role.
1.474 raeburn 3383:
3384: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3385: my ($cdom,$cnum);
3386: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3387: $cdom = $env{'course.'.$course.'.domain'};
3388: $cnum = $env{'course.'.$course.'.num'};
3389: } else {
1.490 raeburn 3390: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3391: }
3392: my $no_ownblock = 0;
3393: my $no_userblock = 0;
1.533 raeburn 3394: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3395: # Check if current user has 'evb' priv for this
3396: if (defined($own_courses{$course})) {
3397: foreach my $sec (keys(%{$own_courses{$course}})) {
3398: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3399: if ($sec ne 'none') {
3400: $checkrole .= '/'.$sec;
3401: }
3402: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3403: $no_ownblock = 1;
3404: last;
3405: }
3406: }
3407: }
3408: # if they have 'evb' priv and are currently not playing student
3409: next if (($no_ownblock) &&
3410: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3411: }
1.474 raeburn 3412: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3413: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3414: if ($sec ne 'none') {
1.482 raeburn 3415: $checkrole .= '/'.$sec;
1.474 raeburn 3416: }
1.490 raeburn 3417: if ($otheruser) {
3418: # Resource belongs to user other than current user.
3419: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3420: my ($trole,$tdom,$tnum,$tsec);
3421: my $entry = $live_courses{$course}{$sec};
3422: if ($entry =~ /^cr/) {
3423: ($trole,$tdom,$tnum,$tsec) =
3424: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3425: } else {
3426: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3427: }
3428: my ($spec,$area,$trest,%allroles,%userroles);
3429: $area = '/'.$tdom.'/'.$tnum;
3430: $trest = $tnum;
3431: if ($tsec ne '') {
3432: $area .= '/'.$tsec;
3433: $trest .= '/'.$tsec;
3434: }
3435: $spec = $trole.'.'.$area;
3436: if ($trole =~ /^cr/) {
3437: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3438: $tdom,$spec,$trest,$area);
3439: } else {
3440: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3441: $tdom,$spec,$trest,$area);
3442: }
3443: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3444: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3445: if ($1) {
3446: $no_userblock = 1;
3447: last;
3448: }
3449: }
1.490 raeburn 3450: } else {
3451: # Resource belongs to current user
3452: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3453: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3454: $no_ownblock = 1;
3455: last;
3456: }
1.474 raeburn 3457: }
3458: }
3459: # if they have the evb priv and are currently not playing student
1.482 raeburn 3460: next if (($no_ownblock) &&
1.491 albertel 3461: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3462: next if ($no_userblock);
1.474 raeburn 3463:
1.490 raeburn 3464: # Retrieve blocking times and identity of blocker for course
3465: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3466:
3467: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3468: if (($start != 0) &&
3469: (($startblock == 0) || ($startblock > $start))) {
3470: $startblock = $start;
3471: }
3472: if (($end != 0) &&
3473: (($endblock == 0) || ($endblock < $end))) {
3474: $endblock = $end;
3475: }
1.490 raeburn 3476: }
3477: return ($startblock,$endblock);
3478: }
3479:
3480: sub get_blocks {
3481: my ($setters,$activity,$cdom,$cnum) = @_;
3482: my $startblock = 0;
3483: my $endblock = 0;
3484: my $course = $cdom.'_'.$cnum;
3485: $setters->{$course} = {};
3486: $setters->{$course}{'staff'} = [];
3487: $setters->{$course}{'times'} = [];
3488: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3489: foreach my $record (keys(%records)) {
3490: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3491: if ($start <= time && $end >= time) {
3492: my ($staff_name,$staff_dom,$title,$blocks) =
3493: &parse_block_record($records{$record});
3494: if ($blocks->{$activity} eq 'on') {
3495: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3496: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3497: if ( ($startblock == 0) || ($startblock > $start) ) {
3498: $startblock = $start;
1.490 raeburn 3499: }
1.491 albertel 3500: if ( ($endblock == 0) || ($endblock < $end) ) {
3501: $endblock = $end;
1.474 raeburn 3502: }
3503: }
3504: }
3505: }
3506: return ($startblock,$endblock);
3507: }
3508:
3509: sub parse_block_record {
3510: my ($record) = @_;
3511: my ($setuname,$setudom,$title,$blocks);
3512: if (ref($record) eq 'HASH') {
3513: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3514: $title = &unescape($record->{'event'});
3515: $blocks = $record->{'blocks'};
3516: } else {
3517: my @data = split(/:/,$record,3);
3518: if (scalar(@data) eq 2) {
3519: $title = $data[1];
3520: ($setuname,$setudom) = split(/@/,$data[0]);
3521: } else {
3522: ($setuname,$setudom,$title) = @data;
3523: }
3524: $blocks = { 'com' => 'on' };
3525: }
3526: return ($setuname,$setudom,$title,$blocks);
3527: }
3528:
3529: sub build_block_table {
3530: my ($startblock,$endblock,$setters) = @_;
3531: my %lt = &Apache::lonlocal::texthash(
3532: 'cacb' => 'Currently active communication blocks',
3533: 'cour' => 'Course',
3534: 'dura' => 'Duration',
3535: 'blse' => 'Block set by'
3536: );
3537: my $output;
1.476 raeburn 3538: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3539: $output .= &start_data_table();
3540: $output .= '
3541: <tr>
3542: <th>'.$lt{'cour'}.'</th>
3543: <th>'.$lt{'dura'}.'</th>
3544: <th>'.$lt{'blse'}.'</th>
3545: </tr>
3546: ';
3547: foreach my $course (keys(%{$setters})) {
3548: my %courseinfo=&Apache::lonnet::coursedescription($course);
3549: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3550: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3551: my $fullname = &plainname($uname,$udom);
3552: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3553: && $env{'user.name'} ne 'public'
3554: && $env{'user.domain'} ne 'public') {
3555: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3556: }
1.474 raeburn 3557: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3558: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3559: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3560: $output .= &Apache::loncommon::start_data_table_row().
3561: '<td>'.$courseinfo{'description'}.'</td>'.
3562: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3563: '<td>'.$fullname.'</td>'.
1.474 raeburn 3564: &Apache::loncommon::end_data_table_row();
3565: }
3566: }
3567: $output .= &end_data_table();
3568: }
3569:
1.490 raeburn 3570: sub blocking_status {
3571: my ($activity,$uname,$udom) = @_;
3572: my %setters;
3573: my ($blocked,$output,$ownitem,$is_course);
3574: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3575: if ($startblock && $endblock) {
3576: $blocked = 1;
3577: if (wantarray) {
3578: my $category;
3579: if ($activity eq 'boards') {
3580: $category = 'Discussion posts in this course';
3581: } elsif ($activity eq 'blogs') {
3582: $category = 'Blogs';
3583: } elsif ($activity eq 'port') {
3584: if (defined($uname) && defined($udom)) {
3585: if ($uname eq $env{'user.name'} &&
3586: $udom eq $env{'user.domain'}) {
3587: $ownitem = 1;
3588: }
3589: }
3590: $is_course = &Apache::lonnet::is_course($udom,$uname);
3591: if ($ownitem) {
3592: $category = 'Your portfolio files';
3593: } elsif ($is_course) {
3594: my $coursedesc;
3595: foreach my $course (keys(%setters)) {
3596: my %courseinfo =
3597: &Apache::lonnet::coursedescription($course);
3598: $coursedesc = $courseinfo{'description'};
3599: }
3600: $category = "Group files in the course '$coursedesc'";
3601: } else {
3602: $category = 'Portfolio files belonging to ';
3603: if ($env{'user.name'} eq 'public' &&
3604: $env{'user.domain'} eq 'public') {
3605: $category .= &plainname($uname,$udom);
3606: } else {
3607: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3608: }
3609: }
3610: } elsif ($activity eq 'groups') {
3611: $category = 'Groups in this course';
3612: }
3613: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3614: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3615: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3616: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3617: $output .= &build_block_table($startblock,$endblock,\%setters);
3618: }
3619: }
3620: }
3621: if (wantarray) {
3622: return ($blocked,$output);
3623: } else {
3624: return $blocked;
3625: }
3626: }
3627:
1.60 matthew 3628: ###############################################
3629:
3630: =pod
3631:
1.112 bowersj2 3632: =head1 Domain Template Functions
3633:
3634: =over 4
3635:
3636: =item * &determinedomain()
1.60 matthew 3637:
3638: Inputs: $domain (usually will be undef)
3639:
1.63 www 3640: Returns: Determines which domain should be used for designs
1.60 matthew 3641:
3642: =cut
1.54 www 3643:
1.60 matthew 3644: ###############################################
1.63 www 3645: sub determinedomain {
3646: my $domain=shift;
1.531 albertel 3647: if (! $domain) {
1.60 matthew 3648: # Determine domain if we have not been given one
3649: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3650: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3651: if ($env{'request.role.domain'}) {
3652: $domain=$env{'request.role.domain'};
1.60 matthew 3653: }
3654: }
1.63 www 3655: return $domain;
3656: }
3657: ###############################################
1.517 raeburn 3658:
1.518 albertel 3659: sub devalidate_domconfig_cache {
3660: my ($udom)=@_;
3661: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3662: }
3663:
3664: # ---------------------- Get domain configuration for a domain
3665: sub get_domainconf {
3666: my ($udom) = @_;
3667: my $cachetime=1800;
3668: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3669: if (defined($cached)) { return %{$result}; }
3670:
3671: my %domconfig = &Apache::lonnet::get_dom('configuration',
3672: ['login','rolecolors'],$udom);
3673: my %designhash;
3674: if (keys(%domconfig) > 0) {
3675: if (ref($domconfig{'login'}) eq 'HASH') {
3676: foreach my $key (keys(%{$domconfig{'login'}})) {
3677: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3678: }
3679: }
3680: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
3681: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3682: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3683: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3684: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3685: }
3686: }
3687: }
3688: }
3689: } else {
3690: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3691: my $designfile = $designdir.'/'.$udom.'.tab';
3692: if (-e $designfile) {
3693: if ( open (my $fh,"<$designfile") ) {
3694: while (my $line = <$fh>) {
3695: next if ($line =~ /^\#/);
3696: chomp($line);
3697: my ($key,$val)=(split(/\=/,$line));
3698: if ($val) { $designhash{$udom.'.'.$key}=$val; }
3699: }
3700: close($fh);
3701: }
3702: }
3703: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
1.519 raeburn 3704: $designhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
1.518 albertel 3705: }
3706: }
3707: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3708: $cachetime);
3709: return %designhash;
3710: }
3711:
1.63 www 3712: =pod
3713:
1.112 bowersj2 3714: =item * &domainlogo()
1.63 www 3715:
3716: Inputs: $domain (usually will be undef)
3717:
3718: Returns: A link to a domain logo, if the domain logo exists.
3719: If the domain logo does not exist, a description of the domain.
3720:
3721: =cut
1.112 bowersj2 3722:
1.63 www 3723: ###############################################
3724: sub domainlogo {
1.517 raeburn 3725: my $domain = &determinedomain(shift);
1.518 albertel 3726: my %designhash = &get_domainconf($domain);
1.517 raeburn 3727: # See if there is a logo
3728: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3729: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3730: if ($imgsrc =~ m{^/(adm|res)/}) {
3731: if ($imgsrc =~ m{^/res/}) {
3732: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3733: &Apache::lonnet::repcopy($local_name);
3734: }
3735: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3736: }
3737: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3738: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3739: return &Apache::lonnet::domain($domain,'description');
1.59 www 3740: } else {
1.60 matthew 3741: return '';
1.59 www 3742: }
3743: }
1.63 www 3744: ##############################################
3745:
3746: =pod
3747:
1.112 bowersj2 3748: =item * &designparm()
1.63 www 3749:
3750: Inputs: $which parameter; $domain (usually will be undef)
3751:
3752: Returns: value of designparamter $which
3753:
3754: =cut
1.112 bowersj2 3755:
1.397 albertel 3756:
1.400 albertel 3757: ##############################################
1.397 albertel 3758: sub designparm {
3759: my ($which,$domain)=@_;
1.258 albertel 3760: if ($env{'browser.blackwhite'} eq 'on') {
1.110 www 3761: if ($which=~/\.(font|alink|vlink|link)$/) {
3762: return '#000000';
3763: }
3764: if ($which=~/\.(pgbg|sidebg)$/) {
3765: return '#FFFFFF';
3766: }
3767: if ($which=~/\.tabbg$/) {
3768: return '#CCCCCC';
3769: }
3770: }
1.397 albertel 3771: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 3772: return $env{'environment.color.'.$which};
1.96 www 3773: }
1.63 www 3774: $domain=&determinedomain($domain);
1.518 albertel 3775: my %domdesign = &get_domainconf($domain);
1.520 raeburn 3776: my $output;
1.517 raeburn 3777: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 3778: $output = $domdesign{$domain.'.'.$which};
1.63 www 3779: } else {
1.520 raeburn 3780: $output = $defaultdesign{$which};
3781: }
3782: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
3783: ($which =~ /login\.(img|logo|domlogo)/)) {
1.538 albertel 3784: if ($output =~ m{^/(adm|res)/}) {
3785: if ($output =~ m{^/res/}) {
3786: my $local_name = &Apache::lonnet::filelocation('',$output);
3787: &Apache::lonnet::repcopy($local_name);
3788: }
1.520 raeburn 3789: $output = &lonhttpdurl($output);
3790: }
1.63 www 3791: }
1.520 raeburn 3792: return $output;
1.63 www 3793: }
1.59 www 3794:
1.60 matthew 3795: ###############################################
3796: ###############################################
3797:
3798: =pod
3799:
1.112 bowersj2 3800: =back
3801:
1.549 albertel 3802: =head1 HTML Helpers
1.112 bowersj2 3803:
3804: =over 4
3805:
3806: =item * &bodytag()
1.60 matthew 3807:
3808: Returns a uniform header for LON-CAPA web pages.
3809:
3810: Inputs:
3811:
1.112 bowersj2 3812: =over 4
3813:
3814: =item * $title, A title to be displayed on the page.
3815:
3816: =item * $function, the current role (can be undef).
3817:
3818: =item * $addentries, extra parameters for the <body> tag.
3819:
3820: =item * $bodyonly, if defined, only return the <body> tag.
3821:
3822: =item * $domain, if defined, force a given domain.
3823:
3824: =item * $forcereg, if page should register as content page (relevant for
1.86 www 3825: text interface only)
1.60 matthew 3826:
1.326 albertel 3827: =item * $customtitle, alternate text to use instead of $title
3828: in the title box that appears, this text
3829: is not auto translated like the $title is
1.309 albertel 3830:
3831: =item * $notopbar, if true, keep the 'what is this' info but remove the
3832: navigational links
1.317 albertel 3833:
1.338 albertel 3834: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
3835:
3836: =item * $notitle, if true keep the nav controls, but remove the title bar
3837:
1.361 albertel 3838: =item * $no_inline_link, if true and in remote mode, don't show the
3839: 'Switch To Inline Menu' link
3840:
1.460 albertel 3841: =item * $args, optional argument valid values are
3842: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 3843: inherit_jsmath -> when creating popup window in a page,
3844: should it have jsmath forced on by the
3845: current page
1.460 albertel 3846:
1.112 bowersj2 3847: =back
3848:
1.60 matthew 3849: Returns: A uniform header for LON-CAPA web pages.
3850: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
3851: If $bodyonly is undef or zero, an html string containing a <body> tag and
3852: other decorations will be returned.
3853:
3854: =cut
3855:
1.54 www 3856: sub bodytag {
1.309 albertel 3857: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 3858: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 3859:
1.460 albertel 3860: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 3861:
1.183 matthew 3862: $function = &get_users_function() if (!$function);
1.339 albertel 3863: my $img = &designparm($function.'.img',$domain);
3864: my $font = &designparm($function.'.font',$domain);
3865: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
3866:
3867: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 3868: 'bgcolor' => $pgbg,
1.339 albertel 3869: 'text' => $font,
3870: 'alink' => &designparm($function.'.alink',$domain),
3871: 'vlink' => &designparm($function.'.vlink',$domain),
3872: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 3873: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 3874:
1.63 www 3875: # role and realm
1.378 raeburn 3876: my ($role,$realm) = split(/\./,$env{'request.role'},2);
3877: if ($role eq 'ca') {
1.479 albertel 3878: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 3879: $realm = &plainname($rname,$rdom);
1.378 raeburn 3880: }
1.55 www 3881: # realm
1.258 albertel 3882: if ($env{'request.course.id'}) {
1.378 raeburn 3883: if ($env{'request.role'} !~ /^cr/) {
3884: $role = &Apache::lonnet::plaintext($role,&course_type());
3885: }
1.359 albertel 3886: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 3887: } else {
3888: $role = &Apache::lonnet::plaintext($role);
1.54 www 3889: }
1.433 albertel 3890:
1.359 albertel 3891: if (!$realm) { $realm=' '; }
1.55 www 3892: # Set messages
1.60 matthew 3893: my $messages=&domainlogo($domain);
1.330 albertel 3894:
1.438 albertel 3895: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 3896:
1.101 www 3897: # construct main body tag
1.359 albertel 3898: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 3899: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 3900:
1.530 albertel 3901: if ($bodyonly) {
1.60 matthew 3902: return $bodytag;
1.258 albertel 3903: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 3904: # Accessibility
1.224 raeburn 3905:
1.337 albertel 3906: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 3907: if (!$notitle) {
1.337 albertel 3908: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
3909: }
3910: return $bodytag;
1.359 albertel 3911: }
3912:
1.410 albertel 3913: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 3914: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3915: undef($role);
1.434 albertel 3916: } else {
3917: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 3918: }
1.359 albertel 3919:
3920: my $roleinfo=(<<ENDROLE);
3921: <td class="LC_title_bar_who">
3922: <div class="LC_title_bar_name">
1.410 albertel 3923: $name
1.361 albertel 3924:
1.359 albertel 3925: </div>
3926: <div class="LC_title_bar_role">
1.361 albertel 3927: $role
1.359 albertel 3928: </div>
3929: <div class="LC_title_bar_realm">
1.361 albertel 3930: $realm
1.359 albertel 3931: </div>
1.206 albertel 3932: </td>
3933: ENDROLE
1.235 raeburn 3934:
1.359 albertel 3935: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
3936: if ($customtitle) {
3937: $titleinfo = $customtitle;
3938: }
3939: #
3940: # Extra info if you are the DC
3941: my $dc_info = '';
3942: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
3943: $env{'course.'.$env{'request.course.id'}.
3944: '.domain'}.'/'})) {
3945: my $cid = $env{'request.course.id'};
3946: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 3947: $dc_info =~ s/\s+$//;
1.359 albertel 3948: $dc_info = '('.$dc_info.')';
3949: }
3950:
3951: if ($env{'environment.remote'} eq 'off') {
3952: # No Remote
1.258 albertel 3953: if ($env{'request.state'} eq 'construct') {
1.359 albertel 3954: $forcereg=1;
3955: }
3956:
3957: if (!$customtitle && $env{'request.state'} eq 'construct') {
3958: # this is for resources; directories have customtitle, and crumbs
3959: # and select recent are created in lonpubdir.pm
1.229 albertel 3960: my ($uname,$thisdisfn)=
1.258 albertel 3961: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 3962: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
3963: $formaction=~s/\/+/\//g;
3964:
1.359 albertel 3965: my $parentpath = '';
3966: my $lastitem = '';
3967: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
3968: $parentpath = $1;
3969: $lastitem = $2;
3970: } else {
3971: $lastitem = $thisdisfn;
3972: }
3973: $titleinfo =
1.401 albertel 3974: &Apache::loncommon::help_open_menu('','',3,'Authoring').
1.359 albertel 3975: '<b>Construction Space</b>: '.
3976: '<form name="dirs" method="post" action="'.$formaction
3977: .'" target="_top"><tt><b>'
3978: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
3979: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
3980: .'</form>'
3981: .&Apache::lonmenu::constspaceform();
1.235 raeburn 3982: }
1.359 albertel 3983:
1.337 albertel 3984: my $titletable;
1.338 albertel 3985: if (!$notitle) {
1.337 albertel 3986: $titletable =
1.359 albertel 3987: '<table id="LC_title_bar">'.
3988: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
3989: '</tr></table>';
1.337 albertel 3990: }
1.359 albertel 3991: if ($notopbar) {
3992: $bodytag .= $titletable;
3993: } else {
3994: if ($env{'request.state'} eq 'construct') {
1.337 albertel 3995: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
3996: $titletable);
1.272 raeburn 3997: } else {
1.336 albertel 3998: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 3999: $titletable;
1.272 raeburn 4000: }
1.235 raeburn 4001: }
4002: return $bodytag;
1.94 www 4003: }
1.95 www 4004:
1.93 www 4005: #
1.95 www 4006: # Top frame rendering, Remote is up
1.93 www 4007: #
1.359 albertel 4008:
1.517 raeburn 4009: my $imgsrc = $img;
4010: if ($img =~ /^\/adm/) {
1.575 albertel 4011: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4012: }
4013: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4014:
1.305 www 4015: # Explicit link to get inline menu
1.361 albertel 4016: my $menu= ($no_inline_link?''
4017: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4018: #
1.338 albertel 4019: if ($notitle) {
1.337 albertel 4020: return $bodytag;
4021: }
1.94 www 4022: return(<<ENDBODY);
1.60 matthew 4023: $bodytag
1.359 albertel 4024: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4025: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4026: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4027: </tr>
1.359 albertel 4028: <tr><td>$titleinfo $dc_info $menu</td>
4029: $roleinfo
1.368 albertel 4030: </tr>
1.356 albertel 4031: </table>
1.54 www 4032: ENDBODY
1.182 matthew 4033: }
4034:
1.330 albertel 4035: sub make_attr_string {
4036: my ($register,$attr_ref) = @_;
4037:
4038: if ($attr_ref && !ref($attr_ref)) {
4039: die("addentries Must be a hash ref ".
4040: join(':',caller(1))." ".
4041: join(':',caller(0))." ");
4042: }
4043:
4044: if ($register) {
1.339 albertel 4045: my ($on_load,$on_unload);
4046: foreach my $key (keys(%{$attr_ref})) {
4047: if (lc($key) eq 'onload') {
4048: $on_load.=$attr_ref->{$key}.';';
4049: delete($attr_ref->{$key});
4050:
4051: } elsif (lc($key) eq 'onunload') {
4052: $on_unload.=$attr_ref->{$key}.';';
4053: delete($attr_ref->{$key});
4054: }
4055: }
4056: $attr_ref->{'onload'} =
4057: &Apache::lonmenu::loadevents(). $on_load;
4058: $attr_ref->{'onunload'}=
4059: &Apache::lonmenu::unloadevents().$on_unload;
4060: }
4061:
4062: # Accessibility font enhance
4063: if ($env{'browser.fontenhance'} eq 'on') {
4064: my $style;
4065: foreach my $key (keys(%{$attr_ref})) {
4066: if (lc($key) eq 'style') {
4067: $style.=$attr_ref->{$key}.';';
4068: delete($attr_ref->{$key});
4069: }
4070: }
4071: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4072: }
1.339 albertel 4073:
4074: if ($env{'browser.blackwhite'} eq 'on') {
4075: delete($attr_ref->{'font'});
4076: delete($attr_ref->{'link'});
4077: delete($attr_ref->{'alink'});
4078: delete($attr_ref->{'vlink'});
4079: delete($attr_ref->{'bgcolor'});
4080: delete($attr_ref->{'background'});
4081: }
4082:
1.330 albertel 4083: my $attr_string;
4084: foreach my $attr (keys(%$attr_ref)) {
4085: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4086: }
4087: return $attr_string;
4088: }
4089:
4090:
1.182 matthew 4091: ###############################################
1.251 albertel 4092: ###############################################
4093:
4094: =pod
4095:
4096: =item * &endbodytag()
4097:
4098: Returns a uniform footer for LON-CAPA web pages.
4099:
1.306 albertel 4100: Inputs: none
1.251 albertel 4101:
4102: =cut
4103:
4104: sub endbodytag {
4105: my $endbodytag='</body>';
1.269 albertel 4106: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4107: if ( exists( $env{'internal.head.redirect'} ) ) {
4108: $endbodytag=
4109: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4110: &mt('Continue').'</a>'.
4111: $endbodytag;
4112: }
1.251 albertel 4113: return $endbodytag;
4114: }
4115:
1.352 albertel 4116: =pod
4117:
4118: =item * &standard_css()
4119:
4120: Returns a style sheet
4121:
4122: Inputs: (all optional)
4123: domain -> force to color decorate a page for a specific
4124: domain
4125: function -> force usage of a specific rolish color scheme
4126: bgcolor -> override the default page bgcolor
4127:
4128: =cut
4129:
1.343 albertel 4130: sub standard_css {
1.345 albertel 4131: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4132: $function = &get_users_function() if (!$function);
4133: my $img = &designparm($function.'.img', $domain);
4134: my $tabbg = &designparm($function.'.tabbg', $domain);
4135: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4136: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4137: my $pgbg_or_bgcolor =
4138: $bgcolor ||
1.352 albertel 4139: &designparm($function.'.pgbg', $domain);
1.382 albertel 4140: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4141: my $alink = &designparm($function.'.alink', $domain);
4142: my $vlink = &designparm($function.'.vlink', $domain);
4143: my $link = &designparm($function.'.link', $domain);
4144:
1.602 albertel 4145: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4146: my $mono = 'monospace';
1.352 albertel 4147: my $data_table_head = $tabbg;
4148: my $data_table_light = '#EEEEEE';
1.470 banghart 4149: my $data_table_dark = '#DDDDDD';
4150: my $data_table_darker = '#CCCCCC';
1.349 albertel 4151: my $data_table_highlight = '#FFFF00';
1.352 albertel 4152: my $mail_new = '#FFBB77';
4153: my $mail_new_hover = '#DD9955';
4154: my $mail_read = '#BBBB77';
4155: my $mail_read_hover = '#999944';
4156: my $mail_replied = '#AAAA88';
4157: my $mail_replied_hover = '#888855';
4158: my $mail_other = '#99BBBB';
4159: my $mail_other_hover = '#669999';
1.391 albertel 4160: my $table_header = '#DDDDDD';
1.489 raeburn 4161: my $feedback_link_bg = '#BBBBBB';
1.392 albertel 4162:
1.608 albertel 4163: my $border = ($env{'browser.type'} eq 'explorer' ||
4164: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4165: : '0px 3px 0px 4px';
1.448 albertel 4166:
1.523 albertel 4167:
1.343 albertel 4168: return <<END;
1.345 albertel 4169: h1, h2, h3, th { font-family: $sans }
1.343 albertel 4170: a:focus { color: red; background: yellow }
1.510 albertel 4171: table.thinborder,
1.523 albertel 4172:
1.510 albertel 4173: table.thinborder tr th {
4174: border-style: solid;
4175: border-width: 1px;
4176: background: $tabbg;
4177: }
1.523 albertel 4178: table.thinborder tr td {
1.510 albertel 4179: border-style: solid;
4180: border-width: 1px
4181: }
1.426 albertel 4182:
1.343 albertel 4183: form, .inline { display: inline; }
4184: .center { text-align: center; }
1.593 albertel 4185: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4186: .LC_error {
4187: color: red;
4188: font-size: larger;
4189: }
1.457 albertel 4190: .LC_warning,
4191: .LC_diff_removed {
1.394 albertel 4192: color: red;
4193: }
1.532 albertel 4194:
4195: .LC_info,
1.457 albertel 4196: .LC_success,
4197: .LC_diff_added {
1.350 albertel 4198: color: green;
4199: }
1.543 albertel 4200: .LC_unknown {
4201: color: yellow;
4202: }
4203:
1.440 albertel 4204: .LC_icon {
4205: border: 0px;
4206: }
1.539 albertel 4207: .LC_indexer_icon {
4208: border: 0px;
4209: height: 22px;
4210: }
1.543 albertel 4211: .LC_docs_spacer {
4212: width: 25px;
4213: height: 1px;
4214: border: 0px;
4215: }
1.346 albertel 4216:
1.532 albertel 4217: .LC_internal_info {
4218: color: #999;
4219: }
4220:
1.458 albertel 4221: table.LC_pastsubmission {
4222: border: 1px solid black;
4223: margin: 2px;
4224: }
4225:
1.606 albertel 4226: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4227: width: 100%;
4228: background: $pgbg;
1.392 albertel 4229: border: 2px;
1.402 albertel 4230: border-collapse: separate;
1.403 albertel 4231: padding: 0px;
1.345 albertel 4232: }
1.392 albertel 4233:
1.606 albertel 4234: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4235: table#LC_title_bar.LC_with_remote {
1.359 albertel 4236: width: 100%;
1.392 albertel 4237: border-color: $pgbg;
4238: border-style: solid;
4239: border-width: $border;
4240:
1.379 albertel 4241: background: $pgbg;
4242: font-family: $sans;
1.392 albertel 4243: border-collapse: collapse;
1.403 albertel 4244: padding: 0px;
1.359 albertel 4245: }
1.392 albertel 4246:
1.409 albertel 4247: table.LC_docs_path {
4248: width: 100%;
4249: border: 0;
4250: background: $pgbg;
4251: font-family: $sans;
4252: border-collapse: collapse;
4253: padding: 0px;
4254: }
4255:
1.359 albertel 4256: table#LC_title_bar td {
4257: background: $tabbg;
4258: }
4259: table#LC_title_bar td.LC_title_bar_who {
4260: background: $tabbg;
4261: color: $font;
1.427 albertel 4262: font: small $sans;
1.359 albertel 4263: text-align: right;
4264: }
1.469 banghart 4265: span.LC_metadata {
4266: font-family: $sans;
4267: }
1.359 albertel 4268: span.LC_title_bar_title {
1.416 albertel 4269: font: bold x-large $sans;
1.359 albertel 4270: }
4271: table#LC_title_bar td.LC_title_bar_domain_logo {
4272: background: $sidebg;
4273: text-align: right;
1.368 albertel 4274: padding: 0px;
4275: }
4276: table#LC_title_bar td.LC_title_bar_role_logo {
4277: background: $sidebg;
4278: padding: 0px;
1.359 albertel 4279: }
4280:
1.346 albertel 4281: table#LC_menubuttons_mainmenu {
1.526 www 4282: width: 100%;
1.346 albertel 4283: border: 0px;
4284: border-spacing: 1px;
1.372 albertel 4285: padding: 0px 1px;
1.346 albertel 4286: margin: 0px;
4287: border-collapse: separate;
4288: }
4289: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
4290: border: 0px;
4291: }
1.345 albertel 4292: table#LC_top_nav td {
4293: background: $tabbg;
1.392 albertel 4294: border: 0px;
1.407 albertel 4295: font-size: small;
1.345 albertel 4296: }
4297: table#LC_top_nav td a, div#LC_top_nav a {
4298: color: $font;
4299: font-family: $sans;
4300: }
1.364 albertel 4301: table#LC_top_nav td.LC_top_nav_logo {
4302: background: $tabbg;
1.432 albertel 4303: text-align: left;
1.408 albertel 4304: white-space: nowrap;
1.432 albertel 4305: width: 31px;
1.408 albertel 4306: }
4307: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4308: border: 0px;
1.408 albertel 4309: vertical-align: bottom;
1.364 albertel 4310: }
1.432 albertel 4311: table#LC_top_nav td.LC_top_nav_exit,
4312: table#LC_top_nav td.LC_top_nav_help {
4313: width: 2.0em;
4314: }
1.442 albertel 4315: table#LC_top_nav td.LC_top_nav_login {
4316: width: 4.0em;
4317: text-align: center;
4318: }
1.409 albertel 4319: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4320: background: $tabbg;
4321: color: $font;
4322: font-family: $sans;
1.358 albertel 4323: font-size: smaller;
1.357 albertel 4324: }
1.411 albertel 4325: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4326: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4327: background: $tabbg;
4328: color: $font;
4329: font-family: $sans;
4330: font-size: larger;
4331: text-align: right;
4332: }
1.383 albertel 4333: td.LC_table_cell_checkbox {
4334: text-align: center;
4335: }
4336:
1.522 albertel 4337: table#LC_mainmenu td.LC_mainmenu_column {
4338: vertical-align: top;
4339: }
4340:
1.346 albertel 4341: .LC_menubuttons_inline_text {
4342: color: $font;
4343: font-family: $sans;
4344: font-size: smaller;
4345: }
4346:
1.526 www 4347: .LC_menubuttons_link {
4348: text-decoration: none;
4349: }
4350:
1.522 albertel 4351: .LC_menubuttons_category {
1.521 www 4352: color: $font;
1.526 www 4353: background: $pgbg;
1.521 www 4354: font-family: $sans;
4355: font-size: larger;
4356: font-weight: bold;
4357: }
4358:
1.346 albertel 4359: td.LC_menubuttons_text {
1.526 www 4360: width: 90%;
1.346 albertel 4361: color: $font;
4362: font-family: $sans;
4363: }
1.526 www 4364:
1.346 albertel 4365: td.LC_menubuttons_img {
4366: }
1.526 www 4367:
1.346 albertel 4368: .LC_current_location {
4369: font-family: $sans;
4370: background: $tabbg;
4371: }
4372: .LC_new_mail {
4373: font-family: $sans;
4374: font-weight: bold;
4375: }
1.347 albertel 4376:
1.526 www 4377: .LC_rolesmenu_is {
4378: font-family: $sans;
4379: }
4380:
4381: .LC_rolesmenu_selected {
4382: font-family: $sans;
4383: }
4384:
4385: .LC_rolesmenu_future {
4386: font-family: $sans;
4387: }
4388:
4389:
4390: .LC_rolesmenu_will {
4391: font-family: $sans;
4392: }
4393:
4394: .LC_rolesmenu_will_not {
4395: font-family: $sans;
4396: }
4397:
4398: .LC_rolesmenu_expired {
4399: font-family: $sans;
4400: }
4401:
4402: .LC_rolesinfo {
4403: font-family: $sans;
4404: }
4405:
1.527 www 4406: .LC_dropadd_labeltext {
4407: font-family: $sans;
4408: text-align: right;
4409: }
4410:
4411: .LC_preferences_labeltext {
4412: font-family: $sans;
4413: text-align: right;
4414: }
4415:
1.440 albertel 4416: table.LC_aboutme_port {
4417: border: 0px;
4418: border-collapse: collapse;
4419: border-spacing: 0px;
4420: }
1.349 albertel 4421: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4422: border: 1px solid #000000;
1.402 albertel 4423: border-collapse: separate;
1.426 albertel 4424: border-spacing: 1px;
1.610 albertel 4425: background: $pgbg;
1.347 albertel 4426: }
1.422 albertel 4427: .LC_data_table_dense {
4428: font-size: small;
4429: }
1.507 raeburn 4430: table.LC_nested_outer {
4431: border: 1px solid #000000;
1.589 raeburn 4432: border-collapse: collapse;
1.507 raeburn 4433: border-spacing: 0px;
4434: width: 100%;
4435: }
4436: table.LC_nested {
4437: border: 0px;
1.589 raeburn 4438: border-collapse: collapse;
1.507 raeburn 4439: border-spacing: 0px;
4440: width: 100%;
4441: }
1.523 albertel 4442: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4443: table.LC_prior_tries tr th {
1.349 albertel 4444: font-weight: bold;
4445: background-color: $data_table_head;
1.421 albertel 4446: font-size: smaller;
1.347 albertel 4447: }
1.610 albertel 4448: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4449: table.LC_aboutme_port tr td {
1.349 albertel 4450: background-color: $data_table_light;
1.425 albertel 4451: padding: 2px;
1.347 albertel 4452: }
1.610 albertel 4453: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4454: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4455: background-color: $data_table_dark;
1.347 albertel 4456: }
1.425 albertel 4457: table.LC_data_table tr.LC_data_table_highlight td {
4458: background-color: $data_table_darker;
4459: }
1.451 albertel 4460: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4461: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4462: background-color: #FFFFFF;
1.421 albertel 4463: font-weight: bold;
4464: font-style: italic;
4465: text-align: center;
4466: padding: 8px;
1.347 albertel 4467: }
1.507 raeburn 4468: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4469: padding: 4ex
4470: }
1.507 raeburn 4471: table.LC_nested_outer tr th {
4472: font-weight: bold;
4473: background-color: $data_table_head;
4474: font-size: smaller;
4475: border-bottom: 1px solid #000000;
4476: }
4477: table.LC_nested_outer tr td.LC_subheader {
4478: background-color: $data_table_head;
4479: font-weight: bold;
4480: font-size: small;
4481: border-bottom: 1px solid #000000;
4482: text-align: right;
1.451 albertel 4483: }
1.507 raeburn 4484: table.LC_nested tr.LC_info_row td {
1.451 albertel 4485: background-color: #CCC;
4486: font-weight: bold;
4487: font-size: small;
1.507 raeburn 4488: text-align: center;
4489: }
1.589 raeburn 4490: table.LC_nested tr.LC_info_row td.LC_left_item,
4491: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4492: text-align: left;
1.451 albertel 4493: }
1.507 raeburn 4494: table.LC_nested td {
1.451 albertel 4495: background-color: #FFF;
4496: font-size: small;
1.507 raeburn 4497: }
4498: table.LC_nested_outer tr th.LC_right_item,
4499: table.LC_nested tr.LC_info_row td.LC_right_item,
4500: table.LC_nested tr.LC_odd_row td.LC_right_item,
4501: table.LC_nested tr td.LC_right_item {
1.451 albertel 4502: text-align: right;
4503: }
4504:
1.507 raeburn 4505: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4506: background-color: #EEE;
4507: }
4508:
1.473 raeburn 4509: table.LC_createuser {
4510: }
4511:
4512: table.LC_createuser tr.LC_section_row td {
4513: font-size: smaller;
4514: }
4515:
4516: table.LC_createuser tr.LC_info_row td {
4517: background-color: #CCC;
4518: font-weight: bold;
4519: text-align: center;
4520: }
4521:
1.349 albertel 4522: table.LC_calendar {
4523: border: 1px solid #000000;
4524: border-collapse: collapse;
4525: }
4526: table.LC_calendar_pickdate {
4527: font-size: xx-small;
4528: }
4529: table.LC_calendar tr td {
4530: border: 1px solid #000000;
4531: vertical-align: top;
4532: }
4533: table.LC_calendar tr td.LC_calendar_day_empty {
4534: background-color: $data_table_dark;
4535: }
4536: table.LC_calendar tr td.LC_calendar_day_current {
4537: background-color: $data_table_highlight;
4538: }
4539:
4540: table.LC_mail_list tr.LC_mail_new {
4541: background-color: $mail_new;
4542: }
4543: table.LC_mail_list tr.LC_mail_new:hover {
4544: background-color: $mail_new_hover;
4545: }
4546: table.LC_mail_list tr.LC_mail_read {
4547: background-color: $mail_read;
4548: }
4549: table.LC_mail_list tr.LC_mail_read:hover {
4550: background-color: $mail_read_hover;
4551: }
4552: table.LC_mail_list tr.LC_mail_replied {
4553: background-color: $mail_replied;
4554: }
4555: table.LC_mail_list tr.LC_mail_replied:hover {
4556: background-color: $mail_replied_hover;
4557: }
4558: table.LC_mail_list tr.LC_mail_other {
4559: background-color: $mail_other;
4560: }
4561: table.LC_mail_list tr.LC_mail_other:hover {
4562: background-color: $mail_other_hover;
4563: }
1.494 raeburn 4564: table.LC_mail_list tr.LC_mail_even {
4565: }
4566: table.LC_mail_list tr.LC_mail_odd {
4567: }
4568:
1.385 albertel 4569:
1.386 albertel 4570: table#LC_portfolio_actions {
4571: width: auto;
4572: background: $pgbg;
4573: border: 0px;
4574: border-spacing: 2px 2px;
4575: padding: 0px;
4576: margin: 0px;
4577: border-collapse: separate;
4578: }
4579: table#LC_portfolio_actions td.LC_label {
4580: background: $tabbg;
4581: text-align: right;
4582: }
4583: table#LC_portfolio_actions td.LC_value {
4584: background: $tabbg;
4585: }
1.385 albertel 4586:
1.391 albertel 4587: table#LC_cstr_controls {
4588: width: 100%;
4589: border-collapse: collapse;
4590: }
4591: table#LC_cstr_controls tr td {
4592: border: 4px solid $pgbg;
4593: padding: 4px;
4594: text-align: center;
4595: background: $tabbg;
4596: }
4597: table#LC_cstr_controls tr th {
4598: border: 4px solid $pgbg;
4599: background: $table_header;
4600: text-align: center;
4601: font-family: $sans;
4602: font-size: smaller;
4603: }
4604:
1.389 albertel 4605: table#LC_browser {
4606:
4607: }
4608: table#LC_browser tr th {
1.391 albertel 4609: background: $table_header;
1.389 albertel 4610: }
1.390 albertel 4611: table#LC_browser tr td {
4612: padding: 2px;
4613: }
1.389 albertel 4614: table#LC_browser tr.LC_browser_file,
4615: table#LC_browser tr.LC_browser_file_published {
4616: background: #CCFF88;
4617: }
4618: table#LC_browser tr.LC_browser_file_locked,
4619: table#LC_browser tr.LC_browser_file_unpublished {
4620: background: #FFAA99;
1.387 albertel 4621: }
1.389 albertel 4622: table#LC_browser tr.LC_browser_file_obsolete {
4623: background: #AAAAAA;
1.387 albertel 4624: }
1.455 albertel 4625: table#LC_browser tr.LC_browser_file_modified,
4626: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 4627: background: #FFFF77;
1.387 albertel 4628: }
1.389 albertel 4629: table#LC_browser tr.LC_browser_folder {
4630: background: #CCCCFF;
1.387 albertel 4631: }
1.388 albertel 4632: span.LC_current_location {
4633: font-size: x-large;
4634: background: $pgbg;
4635: }
1.387 albertel 4636:
1.395 albertel 4637: span.LC_parm_menu_item {
4638: font-size: larger;
4639: font-family: $sans;
4640: }
4641: span.LC_parm_scope_all {
4642: color: red;
4643: }
4644: span.LC_parm_scope_folder {
4645: color: green;
4646: }
4647: span.LC_parm_scope_resource {
4648: color: orange;
4649: }
4650: span.LC_parm_part {
4651: color: blue;
4652: }
4653: span.LC_parm_folder, span.LC_parm_symb {
4654: font-size: x-small;
4655: font-family: $mono;
4656: color: #AAAAAA;
4657: }
4658:
1.396 albertel 4659: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4660: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4661: border: 1px solid black;
4662: border-collapse: collapse;
4663: }
4664: table.LC_parm_overview_restrictions td {
4665: border-width: 1px 4px 1px 4px;
4666: border-style: solid;
4667: border-color: $pgbg;
4668: text-align: center;
4669: }
4670: table.LC_parm_overview_restrictions th {
4671: background: $tabbg;
4672: border-width: 1px 4px 1px 4px;
4673: border-style: solid;
4674: border-color: $pgbg;
4675: }
1.398 albertel 4676: table#LC_helpmenu {
4677: border: 0px;
4678: height: 55px;
4679: border-spacing: 0px;
4680: }
4681:
4682: table#LC_helpmenu fieldset legend {
4683: font-size: larger;
4684: font-weight: bold;
4685: }
1.397 albertel 4686: table#LC_helpmenu_links {
4687: width: 100%;
4688: border: 1px solid black;
4689: background: $pgbg;
4690: padding: 0px;
4691: border-spacing: 1px;
4692: }
4693: table#LC_helpmenu_links tr td {
4694: padding: 1px;
4695: background: $tabbg;
1.399 albertel 4696: text-align: center;
4697: font-weight: bold;
1.397 albertel 4698: }
1.396 albertel 4699:
1.397 albertel 4700: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4701: table#LC_helpmenu_links a:active {
4702: text-decoration: none;
4703: color: $font;
4704: }
4705: table#LC_helpmenu_links a:hover {
4706: text-decoration: underline;
4707: color: $vlink;
4708: }
1.396 albertel 4709:
1.417 albertel 4710: .LC_chrt_popup_exists {
4711: border: 1px solid #339933;
4712: margin: -1px;
4713: }
4714: .LC_chrt_popup_up {
4715: border: 1px solid yellow;
4716: margin: -1px;
4717: }
4718: .LC_chrt_popup {
4719: border: 1px solid #8888FF;
4720: background: #CCCCFF;
4721: }
1.421 albertel 4722: table.LC_pick_box {
4723: border-collapse: separate;
4724: background: white;
4725: border: 1px solid black;
4726: border-spacing: 1px;
4727: }
4728: table.LC_pick_box td.LC_pick_box_title {
4729: background: $tabbg;
4730: font-weight: bold;
4731: text-align: right;
4732: width: 184px;
4733: padding: 8px;
4734: }
1.579 raeburn 4735: table.LC_pick_box td.LC_pick_box_value {
4736: text-align: left;
4737: padding: 8px;
4738: }
4739: table.LC_pick_box td.LC_pick_box_select {
4740: text-align: left;
4741: padding: 8px;
4742: }
1.424 albertel 4743: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 4744: padding: 0px;
4745: height: 1px;
4746: background: black;
4747: }
4748: table.LC_pick_box td.LC_pick_box_submit {
4749: text-align: right;
4750: }
1.579 raeburn 4751: table.LC_pick_box td.LC_evenrow_value {
4752: text-align: left;
4753: padding: 8px;
4754: background-color: $data_table_light;
4755: }
4756: table.LC_pick_box td.LC_oddrow_value {
4757: text-align: left;
4758: padding: 8px;
4759: background-color: $data_table_light;
4760: }
4761: table.LC_helpform_receipt {
4762: width: 620px;
4763: border-collapse: separate;
4764: background: white;
4765: border: 1px solid black;
4766: border-spacing: 1px;
4767: }
4768: table.LC_helpform_receipt td.LC_pick_box_title {
4769: background: $tabbg;
4770: font-weight: bold;
4771: text-align: right;
4772: width: 184px;
4773: padding: 8px;
4774: }
4775: table.LC_helpform_receipt td.LC_evenrow_value {
4776: text-align: left;
4777: padding: 8px;
4778: background-color: $data_table_light;
4779: }
4780: table.LC_helpform_receipt td.LC_oddrow_value {
4781: text-align: left;
4782: padding: 8px;
4783: background-color: $data_table_light;
4784: }
4785: table.LC_helpform_receipt td.LC_pick_box_separator {
4786: padding: 0px;
4787: height: 1px;
4788: background: black;
4789: }
4790: span.LC_helpform_receipt_cat {
4791: font-weight: bold;
4792: }
1.424 albertel 4793: table.LC_group_priv_box {
4794: background: white;
4795: border: 1px solid black;
4796: border-spacing: 1px;
4797: }
4798: table.LC_group_priv_box td.LC_pick_box_title {
4799: background: $tabbg;
4800: font-weight: bold;
4801: text-align: right;
4802: width: 184px;
4803: }
4804: table.LC_group_priv_box td.LC_groups_fixed {
4805: background: $data_table_light;
4806: text-align: center;
4807: }
4808: table.LC_group_priv_box td.LC_groups_optional {
4809: background: $data_table_dark;
4810: text-align: center;
4811: }
4812: table.LC_group_priv_box td.LC_groups_functionality {
4813: background: $data_table_darker;
4814: text-align: center;
4815: font-weight: bold;
4816: }
4817: table.LC_group_priv td {
4818: text-align: left;
4819: padding: 0px;
4820: }
4821:
1.421 albertel 4822: table.LC_notify_front_page {
4823: background: white;
4824: border: 1px solid black;
4825: padding: 8px;
4826: }
4827: table.LC_notify_front_page td {
4828: padding: 8px;
4829: }
1.424 albertel 4830: .LC_navbuttons {
4831: margin: 2ex 0ex 2ex 0ex;
4832: }
1.423 albertel 4833: .LC_topic_bar {
4834: font-family: $sans;
4835: font-weight: bold;
4836: width: 100%;
4837: background: $tabbg;
4838: vertical-align: middle;
4839: margin: 2ex 0ex 2ex 0ex;
4840: }
4841: .LC_topic_bar span {
4842: vertical-align: middle;
4843: }
4844: .LC_topic_bar img {
4845: vertical-align: bottom;
4846: }
4847: table.LC_course_group_status {
4848: margin: 20px;
4849: }
4850: table.LC_status_selector td {
4851: vertical-align: top;
4852: text-align: center;
1.424 albertel 4853: padding: 4px;
4854: }
4855: table.LC_descriptive_input td.LC_description {
4856: vertical-align: top;
4857: text-align: right;
4858: font-weight: bold;
1.423 albertel 4859: }
1.599 albertel 4860: div.LC_feedback_link {
1.616 albertel 4861: clear: both;
1.599 albertel 4862: background: white;
4863: width: 100%;
1.489 raeburn 4864: }
4865: span.LC_feedback_link {
1.599 albertel 4866: background: $feedback_link_bg;
4867: font-size: larger;
4868: }
4869: span.LC_message_link {
4870: background: $feedback_link_bg;
4871: font-size: larger;
4872: position: absolute;
4873: right: 1em;
1.489 raeburn 4874: }
1.421 albertel 4875:
1.515 albertel 4876: table.LC_prior_tries {
1.524 albertel 4877: border: 1px solid #000000;
4878: border-collapse: separate;
4879: border-spacing: 1px;
1.515 albertel 4880: }
1.523 albertel 4881:
1.515 albertel 4882: table.LC_prior_tries td {
1.524 albertel 4883: padding: 2px;
1.515 albertel 4884: }
1.523 albertel 4885:
4886: .LC_answer_correct {
4887: background: #AAFFAA;
4888: color: black;
4889: }
4890: .LC_answer_charged_try {
4891: background: #FFAAAA ! important;
4892: color: black;
4893: }
4894: .LC_answer_not_charged_try,
4895: .LC_answer_no_grade,
4896: .LC_answer_late {
4897: background: #FFFFAA;
4898: color: black;
4899: }
4900: .LC_answer_previous {
4901: background: #AAAAFF;
4902: color: black;
4903: }
4904: .LC_answer_no_message {
4905: background: #FFFFFF;
4906: color: black;
4907: }
4908: .LC_answer_unknown {
4909: background: orange;
4910: color: black;
4911: }
4912:
4913:
1.529 albertel 4914: span.LC_prior_numerical,
4915: span.LC_prior_string,
4916: span.LC_prior_custom,
4917: span.LC_prior_reaction,
4918: span.LC_prior_math {
1.523 albertel 4919: font-family: monospace;
4920: white-space: pre;
4921: }
4922:
1.525 albertel 4923: span.LC_prior_string {
4924: font-family: monospace;
4925: white-space: pre;
4926: }
4927:
1.523 albertel 4928: table.LC_prior_option {
4929: width: 100%;
4930: border-collapse: collapse;
4931: }
1.528 albertel 4932: table.LC_prior_rank, table.LC_prior_match {
4933: border-collapse: collapse;
4934: }
4935: table.LC_prior_option tr td,
4936: table.LC_prior_rank tr td,
4937: table.LC_prior_match tr td {
1.524 albertel 4938: border: 1px solid #000000;
1.515 albertel 4939: }
4940:
1.519 raeburn 4941: span.LC_nobreak {
1.544 albertel 4942: white-space: nowrap;
1.519 raeburn 4943: }
4944:
1.576 raeburn 4945: span.LC_cusr_emph {
4946: font-style: italic;
4947: }
4948:
1.545 albertel 4949: table.LC_docs_documents {
4950: background: #BBBBBB;
1.547 albertel 4951: border-width: 0px;
1.545 albertel 4952: border-collapse: collapse;
4953: }
4954:
4955: table.LC_docs_documents td.LC_docs_document {
4956: border: 2px solid black;
4957: padding: 4px;
4958: }
4959:
4960: .LC_docs_course_commands div {
4961: float: left;
4962: border: 4px solid #AAAAAA;
4963: padding: 4px;
4964: background: #DDDDCC;
4965: }
4966:
4967: .LC_docs_entry_move {
4968: border: 0px;
4969: border-collapse: collapse;
1.544 albertel 4970: }
4971:
1.545 albertel 4972: .LC_docs_entry_move td {
4973: border: 2px solid #BBBBBB;
4974: background: #DDDDDD;
4975: }
4976:
4977: .LC_docs_editor td.LC_docs_entry_commands {
4978: background: #DDDDDD;
4979: font-size: x-small;
4980: }
1.544 albertel 4981: .LC_docs_copy {
1.545 albertel 4982: color: #000099;
1.544 albertel 4983: }
4984: .LC_docs_cut {
1.545 albertel 4985: color: #550044;
1.544 albertel 4986: }
4987: .LC_docs_rename {
1.545 albertel 4988: color: #009900;
1.544 albertel 4989: }
4990: .LC_docs_remove {
1.545 albertel 4991: color: #990000;
4992: }
4993:
1.547 albertel 4994: .LC_docs_reinit_warn,
4995: .LC_docs_ext_edit {
4996: font-size: x-small;
4997: }
4998:
1.545 albertel 4999: .LC_docs_editor td.LC_docs_entry_title,
5000: .LC_docs_editor td.LC_docs_entry_icon {
5001: background: #FFFFBB;
5002: }
5003: .LC_docs_editor td.LC_docs_entry_parameter {
5004: background: #BBBBFF;
5005: font-size: x-small;
5006: white-space: nowrap;
5007: }
5008:
5009: table.LC_docs_adddocs td,
5010: table.LC_docs_adddocs th {
5011: border: 1px solid #BBBBBB;
5012: padding: 4px;
5013: background: #DDDDDD;
1.543 albertel 5014: }
5015:
1.584 albertel 5016: table.LC_sty_begin {
5017: background: #BBFFBB;
5018: }
5019: table.LC_sty_end {
5020: background: #FFBBBB;
5021: }
5022:
1.589 raeburn 5023: table.LC_double_column {
5024: border-width: 0px;
5025: border-collapse: collapse;
5026: width: 100%;
5027: padding: 2px;
5028: }
5029:
5030: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5031: top: 2px;
1.589 raeburn 5032: left: 2px;
5033: width: 47%;
5034: vertical-align: top;
5035: }
5036:
5037: table.LC_double_column tr td.LC_right_col {
5038: top: 2px;
5039: right: 2px;
5040: width: 47%;
5041: vertical-align: top;
5042: }
5043:
1.594 raeburn 5044: span.LC_role_level {
5045: font-weight: bold;
5046: }
5047:
1.591 raeburn 5048: div.LC_left_float {
5049: float: left;
5050: padding-right: 5%;
1.597 albertel 5051: padding-bottom: 4px;
1.591 raeburn 5052: }
5053:
5054: div.LC_clear_float_header {
1.597 albertel 5055: padding-bottom: 2px;
1.591 raeburn 5056: }
5057:
5058: div.LC_clear_float_footer {
1.597 albertel 5059: padding-top: 10px;
1.591 raeburn 5060: clear: both;
5061: }
5062:
1.597 albertel 5063:
1.601 albertel 5064: div.LC_grade_select_mode {
1.604 albertel 5065: font-family: $sans;
1.601 albertel 5066: }
5067: div.LC_grade_select_mode div div {
5068: margin: 5px;
5069: }
5070: div.LC_grade_select_mode_selector {
5071: margin: 5px;
5072: float: left;
5073: }
5074: div.LC_grade_select_mode_selector_header {
5075: font: bold medium $sans;
5076: }
5077: div.LC_grade_select_mode_type {
5078: clear: left;
5079: }
5080:
1.597 albertel 5081: div.LC_grade_show_user {
5082: margin-top: 20px;
5083: border: 1px solid black;
5084: }
5085: div.LC_grade_user_name {
5086: background: #DDDDEE;
5087: border-bottom: 1px solid black;
5088: font: bold large $sans;
5089: }
5090: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5091: background: #DDEEDD;
5092: }
5093:
5094: div.LC_grade_show_problem,
5095: div.LC_grade_submissions,
5096: div.LC_grade_message_center,
5097: div.LC_grade_info_links,
5098: div.LC_grade_assign {
5099: margin: 5px;
5100: width: 99%;
5101: background: #FFFFFF;
5102: }
5103: div.LC_grade_show_problem_header,
5104: div.LC_grade_submissions_header,
5105: div.LC_grade_message_center_header,
5106: div.LC_grade_assign_header {
5107: font: bold large $sans;
5108: }
5109: div.LC_grade_show_problem_problem,
5110: div.LC_grade_submissions_body,
5111: div.LC_grade_message_center_body,
5112: div.LC_grade_assign_body {
5113: border: 1px solid black;
5114: width: 99%;
5115: background: #FFFFFF;
5116: }
1.598 albertel 5117: span.LC_grade_check_note {
5118: font: normal medium $sans;
5119: display: inline;
5120: position: absolute;
5121: right: 1em;
5122: }
1.597 albertel 5123:
1.613 albertel 5124: table.LC_scantron_action {
5125: width: 100%;
5126: }
5127: table.LC_scantron_action tr th {
5128: font: normal bold $sans;
5129: }
1.600 albertel 5130:
1.614 albertel 5131: div.LC_edit_problem_header,
5132: div.LC_edit_problem_footer {
1.600 albertel 5133: font: normal medium $sans;
1.602 albertel 5134: margin: 2px;
1.600 albertel 5135: }
5136: div.LC_edit_problem_header,
1.602 albertel 5137: div.LC_edit_problem_header div,
1.614 albertel 5138: div.LC_edit_problem_footer,
5139: div.LC_edit_problem_footer div,
1.602 albertel 5140: div.LC_edit_problem_editxml_header,
5141: div.LC_edit_problem_editxml_header div {
1.600 albertel 5142: margin-top: 5px;
5143: }
1.602 albertel 5144: div.LC_edit_problem_header_edit_row {
5145: background: $tabbg;
5146: padding: 3px;
5147: margin-bottom: 5px;
5148: }
1.600 albertel 5149: div.LC_edit_problem_header_title {
1.602 albertel 5150: font: larger bold $sans;
5151: background: $tabbg;
5152: padding: 3px;
5153: }
5154: table.LC_edit_problem_header_title {
5155: font: larger bold $sans;
5156: width: 100%;
5157: border-color: $pgbg;
5158: border-style: solid;
5159: border-width: $border;
5160:
1.600 albertel 5161: background: $tabbg;
1.602 albertel 5162: border-collapse: collapse;
5163: padding: 0px
5164: }
5165:
5166: div.LC_edit_problem_discards {
5167: float: left;
5168: padding-bottom: 5px;
5169: }
5170: div.LC_edit_problem_saves {
5171: float: right;
5172: padding-bottom: 5px;
1.600 albertel 5173: }
5174: hr.LC_edit_problem_divide {
1.602 albertel 5175: clear: both;
1.600 albertel 5176: color: $tabbg;
5177: background-color: $tabbg;
5178: height: 3px;
5179: border: 0px;
5180: }
1.343 albertel 5181: END
5182: }
5183:
1.306 albertel 5184: =pod
5185:
5186: =item * &headtag()
5187:
5188: Returns a uniform footer for LON-CAPA web pages.
5189:
1.307 albertel 5190: Inputs: $title - optional title for the head
5191: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5192: $args - optional arguments
1.319 albertel 5193: force_register - if is true call registerurl so the remote is
5194: informed
1.415 albertel 5195: redirect -> array ref of
5196: 1- seconds before redirect occurs
5197: 2- url to redirect to
5198: 3- whether the side effect should occur
1.315 albertel 5199: (side effect of setting
5200: $env{'internal.head.redirect'} to the url
5201: redirected too)
1.352 albertel 5202: domain -> force to color decorate a page for a specific
5203: domain
5204: function -> force usage of a specific rolish color scheme
5205: bgcolor -> override the default page bgcolor
1.460 albertel 5206: no_auto_mt_title
5207: -> prevent &mt()ing the title arg
1.464 albertel 5208:
1.306 albertel 5209: =cut
5210:
5211: sub headtag {
1.313 albertel 5212: my ($title,$head_extra,$args) = @_;
1.306 albertel 5213:
1.363 albertel 5214: my $function = $args->{'function'} || &get_users_function();
5215: my $domain = $args->{'domain'} || &determinedomain();
5216: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5217: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5218: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5219: #time(),
1.418 albertel 5220: $env{'environment.color.timestamp'},
1.363 albertel 5221: $function,$domain,$bgcolor);
5222:
1.369 www 5223: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5224:
1.308 albertel 5225: my $result =
5226: '<head>'.
1.461 albertel 5227: &font_settings();
1.319 albertel 5228:
1.461 albertel 5229: if (!$args->{'frameset'}) {
5230: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5231: }
1.319 albertel 5232: if ($args->{'force_register'}) {
5233: $result .= &Apache::lonmenu::registerurl(1);
5234: }
1.436 albertel 5235: if (!$args->{'no_nav_bar'}
5236: && !$args->{'only_body'}
5237: && !$args->{'frameset'}) {
5238: $result .= &help_menu_js();
5239: }
1.319 albertel 5240:
1.314 albertel 5241: if (ref($args->{'redirect'})) {
1.414 albertel 5242: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5243: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5244: if (!$inhibit_continue) {
5245: $env{'internal.head.redirect'} = $url;
5246: }
1.313 albertel 5247: $result.=<<ADDMETA
5248: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5249: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5250: ADDMETA
5251: }
1.306 albertel 5252: if (!defined($title)) {
5253: $title = 'The LearningOnline Network with CAPA';
5254: }
1.460 albertel 5255: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5256: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5257: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5258: .$head_extra;
1.306 albertel 5259: return $result;
5260: }
5261:
5262: =pod
5263:
1.340 albertel 5264: =item * &font_settings()
5265:
5266: Returns neccessary <meta> to set the proper encoding
5267:
5268: Inputs: none
5269:
5270: =cut
5271:
5272: sub font_settings {
5273: my $headerstring='';
5274: if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
5275: $headerstring.=
5276: '<meta Content-Type="text/html; charset=x-mac-roman" />';
5277: } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
5278: $headerstring.=
5279: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5280: }
5281: return $headerstring;
5282: }
5283:
1.341 albertel 5284: =pod
5285:
5286: =item * &xml_begin()
5287:
5288: Returns the needed doctype and <html>
5289:
5290: Inputs: none
5291:
5292: =cut
5293:
5294: sub xml_begin {
5295: my $output='';
5296:
1.592 albertel 5297: if ($env{'internal.start_page'}==1) {
5298: &Apache::lonhtmlcommon::init_htmlareafields();
5299: }
1.342 albertel 5300:
1.341 albertel 5301: if ($env{'browser.mathml'}) {
5302: $output='<?xml version="1.0"?>'
5303: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5304: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5305:
5306: # .'<!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">] >'
5307: .'<!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">'
5308: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5309: .'xmlns="http://www.w3.org/1999/xhtml">';
5310: } else {
5311: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5312: }
5313: return $output;
5314: }
1.340 albertel 5315:
5316: =pod
5317:
1.306 albertel 5318: =item * &endheadtag()
5319:
5320: Returns a uniform </head> for LON-CAPA web pages.
5321:
5322: Inputs: none
5323:
5324: =cut
5325:
5326: sub endheadtag {
5327: return '</head>';
5328: }
5329:
5330: =pod
5331:
5332: =item * &head()
5333:
5334: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5335:
5336: Inputs: $title - optional title for the page
1.307 albertel 5337: $head_extra - optional extra HTML to put inside the <head>
1.405 albertel 5338:
1.306 albertel 5339: =cut
5340:
5341: sub head {
1.325 albertel 5342: my ($title,$head_extra,$args) = @_;
5343: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5344: }
5345:
5346: =pod
5347:
5348: =item * &start_page()
5349:
5350: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5351:
5352: Inputs: $title - optional title for the page
5353: $head_extra - optional extra HTML to incude inside the <head>
1.315 albertel 5354: $args - additional optional args supported are:
1.317 albertel 5355: only_body -> is true will set &bodytag() onlybodytag
5356: arg on
5357: no_nav_bar -> is true will set &bodytag() notopbar arg on
5358: add_entries -> additional attributes to add to the <body>
5359: domain -> force to color decorate a page for a
5360: specific domain
5361: function -> force usage of a specific rolish color
5362: scheme
5363: redirect -> see &headtag()
5364: bgcolor -> override the default page bg color
5365: js_ready -> return a string ready for being used in
5366: a javascript writeln
1.320 albertel 5367: html_encode -> return a string ready for being used in
5368: a html attribute
1.317 albertel 5369: force_register -> if is true will turn on the &bodytag()
5370: $forcereg arg
1.326 albertel 5371: body_title -> alternate text to use instead of $title
5372: in the title box that appears, this text
5373: is not auto translated like the $title is
1.330 albertel 5374: frameset -> if true will start with a <frameset>
5375: rather than <body>
1.338 albertel 5376: no_title -> if true the title bar won't be shown
5377: skip_phases -> hash ref of
5378: head -> skip the <html><head> generation
5379: body -> skip all <body> generation
1.337 albertel 5380:
1.361 albertel 5381: no_inline_link -> if true and in remote mode, don't show the
5382: 'Switch To Inline Menu' link
5383:
1.460 albertel 5384: no_auto_mt_title -> prevent &mt()ing the title arg
5385:
1.562 albertel 5386: inherit_jsmath -> when creating popup window in a page,
5387: should it have jsmath forced on by the
5388: current page
5389:
1.306 albertel 5390: =cut
5391:
5392: sub start_page {
1.309 albertel 5393: my ($title,$head_extra,$args) = @_;
1.318 albertel 5394: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 5395: my %head_args;
1.352 albertel 5396: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 5397: 'bgcolor','frameset','no_nav_bar','only_body',
5398: 'no_auto_mt_title') {
1.319 albertel 5399: if (defined($args->{$arg})) {
1.324 raeburn 5400: $head_args{$arg} = $args->{$arg};
1.319 albertel 5401: }
1.313 albertel 5402: }
1.319 albertel 5403:
1.315 albertel 5404: $env{'internal.start_page'}++;
1.338 albertel 5405: my $result;
5406: if (! exists($args->{'skip_phases'}{'head'}) ) {
5407: $result.=
1.341 albertel 5408: &xml_begin().
1.338 albertel 5409: &headtag($title,$head_extra,\%head_args).&endheadtag();
5410: }
5411:
5412: if (! exists($args->{'skip_phases'}{'body'}) ) {
5413: if ($args->{'frameset'}) {
5414: my $attr_string = &make_attr_string($args->{'force_register'},
5415: $args->{'add_entries'});
5416: $result .= "\n<frameset $attr_string>\n";
5417: } else {
5418: $result .=
5419: &bodytag($title,
5420: $args->{'function'}, $args->{'add_entries'},
5421: $args->{'only_body'}, $args->{'domain'},
5422: $args->{'force_register'}, $args->{'body_title'},
5423: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 5424: $args->{'no_title'}, $args->{'no_inline_link'},
5425: $args);
1.338 albertel 5426: }
1.330 albertel 5427: }
1.338 albertel 5428:
1.315 albertel 5429: if ($args->{'js_ready'}) {
1.317 albertel 5430: $result = &js_ready($result);
1.315 albertel 5431: }
1.320 albertel 5432: if ($args->{'html_encode'}) {
5433: $result = &html_encode($result);
5434: }
1.315 albertel 5435: return $result;
1.306 albertel 5436: }
5437:
1.330 albertel 5438:
1.306 albertel 5439: =pod
5440:
5441: =item * &head()
5442:
5443: Returns a complete </body></html> section for LON-CAPA web pages.
5444:
1.315 albertel 5445: Inputs: $args - additional optional args supported are:
5446: js_ready -> return a string ready for being used in
5447: a javascript writeln
1.320 albertel 5448: html_encode -> return a string ready for being used in
5449: a html attribute
1.330 albertel 5450: frameset -> if true will start with a <frameset>
5451: rather than <body>
1.493 albertel 5452: dicsussion -> if true will get discussion from
5453: lonxml::xmlend
5454: (you can pass the target and parser arguments
5455: through optional 'target' and 'parser' args
5456: to this routine)
1.306 albertel 5457:
5458: =cut
5459:
5460: sub end_page {
1.315 albertel 5461: my ($args) = @_;
5462: $env{'internal.end_page'}++;
1.330 albertel 5463: my $result;
1.335 albertel 5464: if ($args->{'discussion'}) {
5465: my ($target,$parser);
5466: if (ref($args->{'discussion'})) {
5467: ($target,$parser) =($args->{'discussion'}{'target'},
5468: $args->{'discussion'}{'parser'});
5469: }
5470: $result .= &Apache::lonxml::xmlend($target,$parser);
5471: }
5472:
1.330 albertel 5473: if ($args->{'frameset'}) {
5474: $result .= '</frameset>';
5475: } else {
5476: $result .= &endbodytag();
5477: }
5478: $result .= "\n</html>";
5479:
1.315 albertel 5480: if ($args->{'js_ready'}) {
1.317 albertel 5481: $result = &js_ready($result);
1.315 albertel 5482: }
1.335 albertel 5483:
1.320 albertel 5484: if ($args->{'html_encode'}) {
5485: $result = &html_encode($result);
5486: }
1.335 albertel 5487:
1.315 albertel 5488: return $result;
5489: }
5490:
1.320 albertel 5491: sub html_encode {
5492: my ($result) = @_;
5493:
1.322 albertel 5494: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 5495:
5496: return $result;
5497: }
1.317 albertel 5498: sub js_ready {
5499: my ($result) = @_;
5500:
1.323 albertel 5501: $result =~ s/[\n\r]/ /xmsg;
5502: $result =~ s/\\/\\\\/xmsg;
5503: $result =~ s/'/\\'/xmsg;
1.372 albertel 5504: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 5505:
5506: return $result;
5507: }
5508:
1.315 albertel 5509: sub validate_page {
5510: if ( exists($env{'internal.start_page'})
1.316 albertel 5511: && $env{'internal.start_page'} > 1) {
5512: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 5513: $env{'internal.start_page'}.' '.
1.316 albertel 5514: $ENV{'request.filename'});
1.315 albertel 5515: }
5516: if ( exists($env{'internal.end_page'})
1.316 albertel 5517: && $env{'internal.end_page'} > 1) {
5518: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 5519: $env{'internal.end_page'}.' '.
1.316 albertel 5520: $env{'request.filename'});
1.315 albertel 5521: }
5522: if ( exists($env{'internal.start_page'})
5523: && ! exists($env{'internal.end_page'})) {
1.316 albertel 5524: &Apache::lonnet::logthis('start_page called without end_page '.
5525: $env{'request.filename'});
1.315 albertel 5526: }
5527: if ( ! exists($env{'internal.start_page'})
5528: && exists($env{'internal.end_page'})) {
1.316 albertel 5529: &Apache::lonnet::logthis('end_page called without start_page'.
5530: $env{'request.filename'});
1.315 albertel 5531: }
1.306 albertel 5532: }
1.315 albertel 5533:
1.318 albertel 5534: sub simple_error_page {
5535: my ($r,$title,$msg) = @_;
5536: my $page =
5537: &Apache::loncommon::start_page($title).
5538: &mt($msg).
5539: &Apache::loncommon::end_page();
5540: if (ref($r)) {
5541: $r->print($page);
1.327 albertel 5542: return;
1.318 albertel 5543: }
5544: return $page;
5545: }
1.347 albertel 5546:
5547: {
1.610 albertel 5548: my @row_count;
1.347 albertel 5549: sub start_data_table {
1.422 albertel 5550: my ($add_class) = @_;
5551: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 5552: unshift(@row_count,0);
1.422 albertel 5553: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 5554: }
5555:
5556: sub end_data_table {
1.610 albertel 5557: shift(@row_count);
1.389 albertel 5558: return '</table>'."\n";;
1.347 albertel 5559: }
5560:
5561: sub start_data_table_row {
1.422 albertel 5562: my ($add_class) = @_;
1.610 albertel 5563: $row_count[0]++;
5564: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 5565: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 5566: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 5567: }
1.471 banghart 5568:
5569: sub continue_data_table_row {
5570: my ($add_class) = @_;
1.610 albertel 5571: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 5572: $css_class = (join(' ',$css_class,$add_class));
5573: return '<tr class="'.$css_class.'">'."\n";;
5574: }
1.347 albertel 5575:
5576: sub end_data_table_row {
1.389 albertel 5577: return '</tr>'."\n";;
1.347 albertel 5578: }
1.367 www 5579:
1.421 albertel 5580: sub start_data_table_empty_row {
1.610 albertel 5581: $row_count[0]++;
1.421 albertel 5582: return '<tr class="LC_empty_row" >'."\n";;
5583: }
5584:
5585: sub end_data_table_empty_row {
5586: return '</tr>'."\n";;
5587: }
5588:
1.367 www 5589: sub start_data_table_header_row {
1.389 albertel 5590: return '<tr class="LC_header_row">'."\n";;
1.367 www 5591: }
5592:
5593: sub end_data_table_header_row {
1.389 albertel 5594: return '</tr>'."\n";;
1.367 www 5595: }
1.347 albertel 5596: }
5597:
1.548 albertel 5598: =pod
5599:
5600: =item * &inhibit_menu_check($arg)
5601:
5602: Checks for a inhibitmenu state and generates output to preserve it
5603:
5604: Inputs: $arg - can be any of
5605: - undef - in which case the return value is a string
5606: to add into arguments list of a uri
5607: - 'input' - in which case the return value is a HTML
5608: <form> <input> field of type hidden to
5609: preserve the value
5610: - a url - in which case the return value is the url with
5611: the neccesary cgi args added to preserve the
5612: inhibitmenu state
5613: - a ref to a url - no return value, but the string is
5614: updated to include the neccessary cgi
5615: args to preserve the inhibitmenu state
5616:
5617: =cut
5618:
5619: sub inhibit_menu_check {
5620: my ($arg) = @_;
5621: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5622: if ($arg eq 'input') {
5623: if ($env{'form.inhibitmenu'}) {
5624: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
5625: } else {
5626: return
5627: }
5628: }
5629: if ($env{'form.inhibitmenu'}) {
5630: if (ref($arg)) {
5631: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5632: } elsif ($arg eq '') {
5633: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
5634: } else {
5635: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5636: }
5637: }
5638: if (!ref($arg)) {
5639: return $arg;
5640: }
5641: }
5642:
1.251 albertel 5643: ###############################################
1.182 matthew 5644:
5645: =pod
5646:
1.549 albertel 5647: =back
5648:
5649: =head1 User Information Routines
5650:
5651: =over 4
5652:
1.405 albertel 5653: =item * &get_users_function()
1.182 matthew 5654:
5655: Used by &bodytag to determine the current users primary role.
5656: Returns either 'student','coordinator','admin', or 'author'.
5657:
5658: =cut
5659:
5660: ###############################################
5661: sub get_users_function {
5662: my $function = 'student';
1.258 albertel 5663: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 5664: $function='coordinator';
5665: }
1.258 albertel 5666: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 5667: $function='admin';
5668: }
1.258 albertel 5669: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 5670: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
5671: $function='author';
5672: }
5673: return $function;
1.54 www 5674: }
1.99 www 5675:
5676: ###############################################
5677:
1.233 raeburn 5678: =pod
5679:
1.542 raeburn 5680: =item * &check_user_status()
1.274 raeburn 5681:
5682: Determines current status of supplied role for a
5683: specific user. Roles can be active, previous or future.
5684:
5685: Inputs:
5686: user's domain, user's username, course's domain,
1.375 raeburn 5687: course's number, optional section ID.
1.274 raeburn 5688:
5689: Outputs:
5690: role status: active, previous or future.
5691:
5692: =cut
5693:
5694: sub check_user_status {
1.412 raeburn 5695: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 5696: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
5697: my @uroles = keys %userinfo;
5698: my $srchstr;
5699: my $active_chk = 'none';
1.412 raeburn 5700: my $now = time;
1.274 raeburn 5701: if (@uroles > 0) {
1.412 raeburn 5702: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 5703: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
5704: } else {
1.412 raeburn 5705: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
5706: }
5707: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 5708: my $role_end = 0;
5709: my $role_start = 0;
5710: $active_chk = 'active';
1.412 raeburn 5711: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
5712: $role_end = $1;
5713: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
5714: $role_start = $1;
1.274 raeburn 5715: }
5716: }
5717: if ($role_start > 0) {
1.412 raeburn 5718: if ($now < $role_start) {
1.274 raeburn 5719: $active_chk = 'future';
5720: }
5721: }
5722: if ($role_end > 0) {
1.412 raeburn 5723: if ($now > $role_end) {
1.274 raeburn 5724: $active_chk = 'previous';
5725: }
5726: }
5727: }
5728: }
5729: return $active_chk;
5730: }
5731:
5732: ###############################################
5733:
5734: =pod
5735:
1.405 albertel 5736: =item * &get_sections()
1.233 raeburn 5737:
5738: Determines all the sections for a course including
5739: sections with students and sections containing other roles.
1.419 raeburn 5740: Incoming parameters:
5741:
5742: 1. domain
5743: 2. course number
5744: 3. reference to array containing roles for which sections should
5745: be gathered (optional).
5746: 4. reference to array containing status types for which sections
5747: should be gathered (optional).
5748:
5749: If the third argument is undefined, sections are gathered for any role.
5750: If the fourth argument is undefined, sections are gathered for any status.
5751: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 5752:
1.374 raeburn 5753: Returns section hash (keys are section IDs, values are
5754: number of users in each section), subject to the
1.419 raeburn 5755: optional roles filter, optional status filter
1.233 raeburn 5756:
5757: =cut
5758:
5759: ###############################################
5760: sub get_sections {
1.419 raeburn 5761: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 5762: if (!defined($cdom) || !defined($cnum)) {
5763: my $cid = $env{'request.course.id'};
5764:
5765: return if (!defined($cid));
5766:
5767: $cdom = $env{'course.'.$cid.'.domain'};
5768: $cnum = $env{'course.'.$cid.'.num'};
5769: }
5770:
5771: my %sectioncount;
1.419 raeburn 5772: my $now = time;
1.240 albertel 5773:
1.366 albertel 5774: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 5775: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 5776: my $sec_index = &Apache::loncoursedata::CL_SECTION();
5777: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 5778: my $start_index = &Apache::loncoursedata::CL_START();
5779: my $end_index = &Apache::loncoursedata::CL_END();
5780: my $status;
1.366 albertel 5781: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 5782: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
5783: $data->[$status_index],
5784: $data->[$start_index],
5785: $data->[$end_index]);
5786: if ($stu_status eq 'Active') {
5787: $status = 'active';
5788: } elsif ($end < $now) {
5789: $status = 'previous';
5790: } elsif ($start > $now) {
5791: $status = 'future';
5792: }
5793: if ($section ne '-1' && $section !~ /^\s*$/) {
5794: if ((!defined($possible_status)) || (($status ne '') &&
5795: (grep/^\Q$status\E$/,@{$possible_status}))) {
5796: $sectioncount{$section}++;
5797: }
1.240 albertel 5798: }
5799: }
5800: }
5801: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5802: foreach my $user (sort(keys(%courseroles))) {
5803: if ($user !~ /^(\w{2})/) { next; }
5804: my ($role) = ($user =~ /^(\w{2})/);
5805: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 5806: my ($section,$status);
1.240 albertel 5807: if ($role eq 'cr' &&
5808: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
5809: $section=$1;
5810: }
5811: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
5812: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 5813: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
5814: if ($end == -1 && $start == -1) {
5815: next; #deleted role
5816: }
5817: if (!defined($possible_status)) {
5818: $sectioncount{$section}++;
5819: } else {
5820: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
5821: $status = 'active';
5822: } elsif ($end < $now) {
5823: $status = 'future';
5824: } elsif ($start > $now) {
5825: $status = 'previous';
5826: }
5827: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
5828: $sectioncount{$section}++;
5829: }
5830: }
1.233 raeburn 5831: }
1.366 albertel 5832: return %sectioncount;
1.233 raeburn 5833: }
5834:
1.274 raeburn 5835: ###############################################
1.294 raeburn 5836:
5837: =pod
1.405 albertel 5838:
5839: =item * &get_course_users()
5840:
1.275 raeburn 5841: Retrieves usernames:domains for users in the specified course
5842: with specific role(s), and access status.
5843:
5844: Incoming parameters:
1.277 albertel 5845: 1. course domain
5846: 2. course number
5847: 3. access status: users must have - either active,
1.275 raeburn 5848: previous, future, or all.
1.277 albertel 5849: 4. reference to array of permissible roles
1.288 raeburn 5850: 5. reference to array of section restrictions (optional)
5851: 6. reference to results object (hash of hashes).
5852: 7. reference to optional userdata hash
1.609 raeburn 5853: 8. reference to optional statushash
1.630 raeburn 5854: 9. flag if privileged users (except those set to unhide in
5855: course settings) should be excluded
1.609 raeburn 5856: Keys of top level results hash are roles.
1.275 raeburn 5857: Keys of inner hashes are username:domain, with
5858: values set to access type.
1.288 raeburn 5859: Optional userdata hash returns an array with arguments in the
5860: same order as loncoursedata::get_classlist() for student data.
5861:
1.609 raeburn 5862: Optional statushash returns
5863:
1.288 raeburn 5864: Entries for end, start, section and status are blank because
5865: of the possibility of multiple values for non-student roles.
5866:
1.275 raeburn 5867: =cut
1.405 albertel 5868:
1.275 raeburn 5869: ###############################################
1.405 albertel 5870:
1.275 raeburn 5871: sub get_course_users {
1.630 raeburn 5872: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 5873: my %idx = ();
1.419 raeburn 5874: my %seclists;
1.288 raeburn 5875:
5876: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
5877: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
5878: $idx{end} = &Apache::loncoursedata::CL_END();
5879: $idx{start} = &Apache::loncoursedata::CL_START();
5880: $idx{id} = &Apache::loncoursedata::CL_ID();
5881: $idx{section} = &Apache::loncoursedata::CL_SECTION();
5882: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
5883: $idx{status} = &Apache::loncoursedata::CL_STATUS();
5884:
1.290 albertel 5885: if (grep(/^st$/,@{$roles})) {
1.276 albertel 5886: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 5887: my $now = time;
1.277 albertel 5888: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 5889: my $match = 0;
1.412 raeburn 5890: my $secmatch = 0;
1.419 raeburn 5891: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 5892: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 5893: if ($section eq '') {
5894: $section = 'none';
5895: }
1.291 albertel 5896: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5897: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5898: $secmatch = 1;
5899: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 5900: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5901: $secmatch = 1;
5902: }
5903: } else {
1.419 raeburn 5904: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 5905: $secmatch = 1;
5906: }
1.290 albertel 5907: }
1.412 raeburn 5908: if (!$secmatch) {
5909: next;
5910: }
1.419 raeburn 5911: }
1.275 raeburn 5912: if (defined($$types{'active'})) {
1.288 raeburn 5913: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 5914: push(@{$$users{st}{$student}},'active');
1.288 raeburn 5915: $match = 1;
1.275 raeburn 5916: }
5917: }
5918: if (defined($$types{'previous'})) {
1.609 raeburn 5919: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 5920: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 5921: $match = 1;
1.275 raeburn 5922: }
5923: }
5924: if (defined($$types{'future'})) {
1.609 raeburn 5925: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 5926: push(@{$$users{st}{$student}},'future');
1.288 raeburn 5927: $match = 1;
1.275 raeburn 5928: }
5929: }
1.609 raeburn 5930: if ($match) {
5931: push(@{$seclists{$student}},$section);
5932: if (ref($userdata) eq 'HASH') {
5933: $$userdata{$student} = $$classlist{$student};
5934: }
5935: if (ref($statushash) eq 'HASH') {
5936: $statushash->{$student}{'st'}{$section} = $status;
5937: }
1.288 raeburn 5938: }
1.275 raeburn 5939: }
5940: }
1.412 raeburn 5941: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 5942: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5943: my $now = time;
1.609 raeburn 5944: my %displaystatus = ( previous => 'Expired',
5945: active => 'Active',
5946: future => 'Future',
5947: );
1.630 raeburn 5948: my %nothide;
5949: if ($hidepriv) {
5950: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
5951: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5952: if ($user !~ /:/) {
5953: $nothide{join(':',split(/[\@]/,$user))}=1;
5954: } else {
5955: $nothide{$user} = 1;
5956: }
5957: }
5958: }
1.439 raeburn 5959: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 5960: my $match = 0;
1.412 raeburn 5961: my $secmatch = 0;
1.439 raeburn 5962: my $status;
1.412 raeburn 5963: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 5964: $user =~ s/:$//;
1.439 raeburn 5965: my ($end,$start) = split(/:/,$coursepersonnel{$person});
5966: if ($end == -1 || $start == -1) {
5967: next;
5968: }
5969: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
5970: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 5971: my ($uname,$udom) = split(/:/,$user);
5972: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5973: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5974: $secmatch = 1;
5975: } elsif ($usec eq '') {
1.420 albertel 5976: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5977: $secmatch = 1;
5978: }
5979: } else {
5980: if (grep(/^\Q$usec\E$/,@{$sections})) {
5981: $secmatch = 1;
5982: }
5983: }
5984: if (!$secmatch) {
5985: next;
5986: }
1.288 raeburn 5987: }
1.419 raeburn 5988: if ($usec eq '') {
5989: $usec = 'none';
5990: }
1.275 raeburn 5991: if ($uname ne '' && $udom ne '') {
1.630 raeburn 5992: if ($hidepriv) {
5993: if ((&Apache::lonnet::privileged($uname,$udom)) &&
5994: (!$nothide{$uname.':'.$udom})) {
5995: next;
5996: }
5997: }
1.503 raeburn 5998: if ($end > 0 && $end < $now) {
1.439 raeburn 5999: $status = 'previous';
6000: } elsif ($start > $now) {
6001: $status = 'future';
6002: } else {
6003: $status = 'active';
6004: }
1.277 albertel 6005: foreach my $type (keys(%{$types})) {
1.275 raeburn 6006: if ($status eq $type) {
1.420 albertel 6007: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6008: push(@{$$users{$role}{$user}},$type);
6009: }
1.288 raeburn 6010: $match = 1;
6011: }
6012: }
1.419 raeburn 6013: if (($match) && (ref($userdata) eq 'HASH')) {
6014: if (!exists($$userdata{$uname.':'.$udom})) {
6015: &get_user_info($udom,$uname,\%idx,$userdata);
6016: }
1.420 albertel 6017: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6018: push(@{$seclists{$uname.':'.$udom}},$usec);
6019: }
1.609 raeburn 6020: if (ref($statushash) eq 'HASH') {
6021: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6022: }
1.275 raeburn 6023: }
6024: }
6025: }
6026: }
1.290 albertel 6027: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6028: if ((defined($cdom)) && (defined($cnum))) {
6029: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6030: if ( defined($csettings{'internal.courseowner'}) ) {
6031: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6032: next if ($owner eq '');
6033: my ($ownername,$ownerdom);
6034: if ($owner =~ /^([^:]+):([^:]+)$/) {
6035: $ownername = $1;
6036: $ownerdom = $2;
6037: } else {
6038: $ownername = $owner;
6039: $ownerdom = $cdom;
6040: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6041: }
6042: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6043: if (defined($userdata) &&
1.609 raeburn 6044: !exists($$userdata{$owner})) {
6045: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6046: if (!grep(/^none$/,@{$seclists{$owner}})) {
6047: push(@{$seclists{$owner}},'none');
6048: }
6049: if (ref($statushash) eq 'HASH') {
6050: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6051: }
1.290 albertel 6052: }
1.279 raeburn 6053: }
6054: }
6055: }
1.419 raeburn 6056: foreach my $user (keys(%seclists)) {
6057: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6058: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6059: }
1.275 raeburn 6060: }
6061: return;
6062: }
6063:
1.288 raeburn 6064: sub get_user_info {
6065: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6066: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6067: &plainname($uname,$udom,'lastname');
1.291 albertel 6068: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6069: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6070: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6071: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6072: return;
6073: }
1.275 raeburn 6074:
1.472 raeburn 6075: ###############################################
6076:
6077: =pod
6078:
6079: =item * &get_user_quota()
6080:
6081: Retrieves quota assigned for storage of portfolio files for a user
6082:
6083: Incoming parameters:
6084: 1. user's username
6085: 2. user's domain
6086:
6087: Returns:
1.536 raeburn 6088: 1. Disk quota (in Mb) assigned to student.
6089: 2. (Optional) Type of setting: custom or default
6090: (individually assigned or default for user's
6091: institutional status).
6092: 3. (Optional) - User's institutional status (e.g., faculty, staff
6093: or student - types as defined in localenroll::inst_usertypes
6094: for user's domain, which determines default quota for user.
6095: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6096:
6097: If a value has been stored in the user's environment,
1.536 raeburn 6098: it will return that, otherwise it returns the maximal default
6099: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6100:
6101: =cut
6102:
6103: ###############################################
6104:
6105:
6106: sub get_user_quota {
6107: my ($uname,$udom) = @_;
1.536 raeburn 6108: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6109: if (!defined($udom)) {
6110: $udom = $env{'user.domain'};
6111: }
6112: if (!defined($uname)) {
6113: $uname = $env{'user.name'};
6114: }
6115: if (($udom eq '' || $uname eq '') ||
6116: ($udom eq 'public') && ($uname eq 'public')) {
6117: $quota = 0;
1.536 raeburn 6118: $quotatype = 'default';
6119: $defquota = 0;
1.472 raeburn 6120: } else {
1.536 raeburn 6121: my $inststatus;
1.472 raeburn 6122: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6123: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6124: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6125: } else {
1.536 raeburn 6126: my %userenv =
6127: &Apache::lonnet::get('environment',['portfolioquota',
6128: 'inststatus'],$udom,$uname);
1.472 raeburn 6129: my ($tmp) = keys(%userenv);
6130: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6131: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6132: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6133: } else {
6134: undef(%userenv);
6135: }
6136: }
1.536 raeburn 6137: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6138: if ($quota eq '') {
1.536 raeburn 6139: $quota = $defquota;
6140: $quotatype = 'default';
6141: } else {
6142: $quotatype = 'custom';
1.472 raeburn 6143: }
6144: }
1.536 raeburn 6145: if (wantarray) {
6146: return ($quota,$quotatype,$settingstatus,$defquota);
6147: } else {
6148: return $quota;
6149: }
1.472 raeburn 6150: }
6151:
6152: ###############################################
6153:
6154: =pod
6155:
6156: =item * &default_quota()
6157:
1.536 raeburn 6158: Retrieves default quota assigned for storage of user portfolio files,
6159: given an (optional) user's institutional status.
1.472 raeburn 6160:
6161: Incoming parameters:
6162: 1. domain
1.536 raeburn 6163: 2. (Optional) institutional status(es). This is a : separated list of
6164: status types (e.g., faculty, staff, student etc.)
6165: which apply to the user for whom the default is being retrieved.
6166: If the institutional status string in undefined, the domain
6167: default quota will be returned.
1.472 raeburn 6168:
6169: Returns:
6170: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6171: 2. (Optional) institutional type which determined the value of the
6172: default quota.
1.472 raeburn 6173:
6174: If a value has been stored in the domain's configuration db,
6175: it will return that, otherwise it returns 20 (for backwards
6176: compatibility with domains which have not set up a configuration
6177: db file; the original statically defined portfolio quota was 20 Mb).
6178:
1.536 raeburn 6179: If the user's status includes multiple types (e.g., staff and student),
6180: the largest default quota which applies to the user determines the
6181: default quota returned.
6182:
1.472 raeburn 6183: =cut
6184:
6185: ###############################################
6186:
6187:
6188: sub default_quota {
1.536 raeburn 6189: my ($udom,$inststatus) = @_;
6190: my ($defquota,$settingstatus);
6191: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6192: ['quotas'],$udom);
6193: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6194: if ($inststatus ne '') {
6195: my @statuses = split(/:/,$inststatus);
6196: foreach my $item (@statuses) {
1.622 raeburn 6197: if ($quotahash{'quotas'}{$item} ne '') {
1.536 raeburn 6198: if ($defquota eq '') {
1.622 raeburn 6199: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6200: $settingstatus = $item;
1.622 raeburn 6201: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6202: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6203: $settingstatus = $item;
6204: }
6205: }
6206: }
6207: }
6208: if ($defquota eq '') {
1.622 raeburn 6209: $defquota = $quotahash{'quotas'}{'default'};
1.536 raeburn 6210: $settingstatus = 'default';
6211: }
6212: } else {
6213: $settingstatus = 'default';
6214: $defquota = 20;
6215: }
6216: if (wantarray) {
6217: return ($defquota,$settingstatus);
1.472 raeburn 6218: } else {
1.536 raeburn 6219: return $defquota;
1.472 raeburn 6220: }
6221: }
6222:
1.384 raeburn 6223: sub get_secgrprole_info {
6224: my ($cdom,$cnum,$needroles,$type) = @_;
6225: my %sections_count = &get_sections($cdom,$cnum);
6226: my @sections = (sort {$a <=> $b} keys(%sections_count));
6227: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6228: my @groups = sort(keys(%curr_groups));
6229: my $allroles = [];
6230: my $rolehash;
6231: my $accesshash = {
6232: active => 'Currently has access',
6233: future => 'Will have future access',
6234: previous => 'Previously had access',
6235: };
6236: if ($needroles) {
6237: $rolehash = {'all' => 'all'};
1.385 albertel 6238: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6239: if (&Apache::lonnet::error(%user_roles)) {
6240: undef(%user_roles);
6241: }
6242: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6243: my ($role)=split(/\:/,$item,2);
6244: if ($role eq 'cr') { next; }
6245: if ($role =~ /^cr/) {
6246: $$rolehash{$role} = (split('/',$role))[3];
6247: } else {
6248: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6249: }
6250: }
6251: foreach my $key (sort(keys(%{$rolehash}))) {
6252: push(@{$allroles},$key);
6253: }
6254: push (@{$allroles},'st');
6255: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6256: }
6257: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6258: }
6259:
1.555 raeburn 6260: sub user_picker {
1.627 raeburn 6261: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6262: my $currdom = $dom;
6263: my %curr_selected = (
6264: srchin => 'dom',
1.580 raeburn 6265: srchby => 'lastname',
1.555 raeburn 6266: );
6267: my $srchterm;
1.625 raeburn 6268: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6269: if ($srch->{'srchby'} ne '') {
6270: $curr_selected{'srchby'} = $srch->{'srchby'};
6271: }
6272: if ($srch->{'srchin'} ne '') {
6273: $curr_selected{'srchin'} = $srch->{'srchin'};
6274: }
6275: if ($srch->{'srchtype'} ne '') {
6276: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6277: }
6278: if ($srch->{'srchdomain'} ne '') {
6279: $currdom = $srch->{'srchdomain'};
6280: }
6281: $srchterm = $srch->{'srchterm'};
6282: }
6283: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6284: 'usr' => 'Search criteria',
1.563 raeburn 6285: 'doma' => 'Domain/institution to search',
1.558 albertel 6286: 'uname' => 'username',
6287: 'lastname' => 'last name',
1.555 raeburn 6288: 'lastfirst' => 'last name, first name',
1.558 albertel 6289: 'crs' => 'in this course',
1.576 raeburn 6290: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6291: 'alc' => 'all LON-CAPA',
1.573 raeburn 6292: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6293: 'exact' => 'is',
6294: 'contains' => 'contains',
1.569 raeburn 6295: 'begins' => 'begins with',
1.571 raeburn 6296: 'youm' => "You must include some text to search for.",
6297: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6298: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6299: 'yomc' => "You must choose a domain when using an institutional directory search.",
6300: 'ymcd' => "You must choose a domain when using a domain search.",
6301: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6302: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6303: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6304: );
1.563 raeburn 6305: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6306: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6307:
6308: my @srchins = ('crs','dom','alc','instd');
6309:
6310: foreach my $option (@srchins) {
6311: # FIXME 'alc' option unavailable until
6312: # loncreateuser::print_user_query_page()
6313: # has been completed.
6314: next if ($option eq 'alc');
6315: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6316: if ($curr_selected{'srchin'} eq $option) {
6317: $srchinsel .= '
6318: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6319: } else {
6320: $srchinsel .= '
6321: <option value="'.$option.'">'.$lt{$option}.'</option>';
6322: }
1.555 raeburn 6323: }
1.563 raeburn 6324: $srchinsel .= "\n </select>\n";
1.555 raeburn 6325:
6326: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6327: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6328: if ($curr_selected{'srchby'} eq $option) {
6329: $srchbysel .= '
6330: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6331: } else {
6332: $srchbysel .= '
6333: <option value="'.$option.'">'.$lt{$option}.'</option>';
6334: }
6335: }
6336: $srchbysel .= "\n </select>\n";
6337:
6338: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6339: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6340: if ($curr_selected{'srchtype'} eq $option) {
6341: $srchtypesel .= '
6342: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6343: } else {
6344: $srchtypesel .= '
6345: <option value="'.$option.'">'.$lt{$option}.'</option>';
6346: }
6347: }
6348: $srchtypesel .= "\n </select>\n";
6349:
1.558 albertel 6350: my ($newuserscript,$new_user_create);
1.556 raeburn 6351:
6352: if ($forcenewuser) {
1.576 raeburn 6353: if (ref($srch) eq 'HASH') {
6354: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6355: if ($cancreate) {
6356: $new_user_create = '<p> <input type="submit" name="forcenew" value="'.&HTML::Entities::encode(&mt('Make new user "[_1]"',$srchterm),'<>&"').'" onclick="javascript:setSearch(\'1\','.$caller.');" /> </p>';
6357: } else {
6358: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6359: my %usertypetext = (
6360: official => 'institutional',
6361: unofficial => 'non-institutional',
6362: );
6363: $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
6364: }
1.576 raeburn 6365: }
6366: }
6367:
1.556 raeburn 6368: $newuserscript = <<"ENDSCRIPT";
6369:
1.570 raeburn 6370: function setSearch(createnew,callingForm) {
1.556 raeburn 6371: if (createnew == 1) {
1.570 raeburn 6372: for (var i=0; i<callingForm.srchby.length; i++) {
6373: if (callingForm.srchby.options[i].value == 'uname') {
6374: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6375: }
6376: }
1.570 raeburn 6377: for (var i=0; i<callingForm.srchin.length; i++) {
6378: if ( callingForm.srchin.options[i].value == 'dom') {
6379: callingForm.srchin.selectedIndex = i;
1.556 raeburn 6380: }
6381: }
1.570 raeburn 6382: for (var i=0; i<callingForm.srchtype.length; i++) {
6383: if (callingForm.srchtype.options[i].value == 'exact') {
6384: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 6385: }
6386: }
1.570 raeburn 6387: for (var i=0; i<callingForm.srchdomain.length; i++) {
6388: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6389: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 6390: }
6391: }
6392: }
6393: }
6394: ENDSCRIPT
1.558 albertel 6395:
1.556 raeburn 6396: }
6397:
1.555 raeburn 6398: my $output = <<"END_BLOCK";
1.556 raeburn 6399: <script type="text/javascript">
1.570 raeburn 6400: function validateEntry(callingForm) {
1.558 albertel 6401:
1.556 raeburn 6402: var checkok = 1;
1.558 albertel 6403: var srchin;
1.570 raeburn 6404: for (var i=0; i<callingForm.srchin.length; i++) {
6405: if ( callingForm.srchin[i].checked ) {
6406: srchin = callingForm.srchin[i].value;
1.558 albertel 6407: }
6408: }
6409:
1.570 raeburn 6410: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
6411: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
6412: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
6413: var srchterm = callingForm.srchterm.value;
6414: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 6415: var msg = "";
6416:
6417: if (srchterm == "") {
6418: checkok = 0;
1.571 raeburn 6419: msg += "$lt{'youm'}\\n";
1.556 raeburn 6420: }
6421:
1.569 raeburn 6422: if (srchtype== 'begins') {
6423: if (srchterm.length < 2) {
6424: checkok = 0;
1.571 raeburn 6425: msg += "$lt{'thte'}\\n";
1.569 raeburn 6426: }
6427: }
6428:
1.556 raeburn 6429: if (srchtype== 'contains') {
6430: if (srchterm.length < 3) {
6431: checkok = 0;
1.571 raeburn 6432: msg += "$lt{'thet'}\\n";
1.556 raeburn 6433: }
6434: }
6435: if (srchin == 'instd') {
6436: if (srchdomain == '') {
6437: checkok = 0;
1.571 raeburn 6438: msg += "$lt{'yomc'}\\n";
1.556 raeburn 6439: }
6440: }
6441: if (srchin == 'dom') {
6442: if (srchdomain == '') {
6443: checkok = 0;
1.571 raeburn 6444: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 6445: }
6446: }
6447: if (srchby == 'lastfirst') {
6448: if (srchterm.indexOf(",") == -1) {
6449: checkok = 0;
1.571 raeburn 6450: msg += "$lt{'whus'}\\n";
1.556 raeburn 6451: }
6452: if (srchterm.indexOf(",") == srchterm.length -1) {
6453: checkok = 0;
1.571 raeburn 6454: msg += "$lt{'whse'}\\n";
1.556 raeburn 6455: }
6456: }
6457: if (checkok == 0) {
1.571 raeburn 6458: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 6459: return;
6460: }
6461: if (checkok == 1) {
1.570 raeburn 6462: callingForm.submit();
1.556 raeburn 6463: }
6464: }
6465:
6466: $newuserscript
6467:
6468: </script>
1.558 albertel 6469:
6470: $new_user_create
6471:
1.555 raeburn 6472: <table>
1.558 albertel 6473: <tr>
1.573 raeburn 6474: <td>$lt{'doma'}:</td>
6475: <td>$domform</td>
6476: </td>
6477: </tr>
6478: <tr>
6479: <td>$lt{'usr'}:</td>
1.563 raeburn 6480: <td>$srchbysel
6481: $srchtypesel
6482: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 6483: $srchinsel
1.563 raeburn 6484: </td>
6485: </tr>
1.555 raeburn 6486: </table>
6487: <br />
6488: END_BLOCK
1.558 albertel 6489:
1.555 raeburn 6490: return $output;
6491: }
6492:
1.612 raeburn 6493: sub user_rule_check {
1.615 raeburn 6494: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 6495: my $response;
6496: if (ref($usershash) eq 'HASH') {
6497: foreach my $user (keys(%{$usershash})) {
6498: my ($uname,$udom) = split(/:/,$user);
6499: next if ($udom eq '' || $uname eq '');
1.615 raeburn 6500: my ($id,$newuser);
1.612 raeburn 6501: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 6502: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 6503: $id = $usershash->{$user}->{'id'};
6504: }
6505: my $inst_response;
6506: if (ref($checks) eq 'HASH') {
6507: if (defined($checks->{'username'})) {
1.615 raeburn 6508: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 6509: &Apache::lonnet::get_instuser($udom,$uname);
6510: } elsif (defined($checks->{'id'})) {
1.615 raeburn 6511: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 6512: &Apache::lonnet::get_instuser($udom,undef,$id);
6513: }
1.615 raeburn 6514: } else {
6515: ($inst_response,%{$inst_results->{$user}}) =
6516: &Apache::lonnet::get_instuser($udom,$uname);
6517: return;
1.612 raeburn 6518: }
1.615 raeburn 6519: if (!$got_rules->{$udom}) {
1.612 raeburn 6520: my %domconfig = &Apache::lonnet::get_dom('configuration',
6521: ['usercreation'],$udom);
6522: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 6523: foreach my $item ('username','id') {
1.612 raeburn 6524: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
6525: $$curr_rules{$udom}{$item} =
6526: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 6527: }
6528: }
6529: }
1.615 raeburn 6530: $got_rules->{$udom} = 1;
1.585 raeburn 6531: }
1.612 raeburn 6532: foreach my $item (keys(%{$checks})) {
6533: if (ref($$curr_rules{$udom}) eq 'HASH') {
6534: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
6535: if (@{$$curr_rules{$udom}{$item}} > 0) {
6536: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
6537: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
6538: if ($rule_check{$rule}) {
6539: $$rulematch{$user}{$item} = $rule;
6540: if ($inst_response eq 'ok') {
1.615 raeburn 6541: if (ref($inst_results) eq 'HASH') {
6542: if (ref($inst_results->{$user}) eq 'HASH') {
6543: if (keys(%{$inst_results->{$user}}) == 0) {
6544: $$alerts{$item}{$udom}{$uname} = 1;
6545: }
1.612 raeburn 6546: }
6547: }
1.615 raeburn 6548: }
6549: last;
1.585 raeburn 6550: }
6551: }
6552: }
6553: }
6554: }
6555: }
6556: }
6557: }
1.612 raeburn 6558: return;
6559: }
6560:
6561: sub user_rule_formats {
6562: my ($domain,$domdesc,$curr_rules,$check) = @_;
6563: my %text = (
6564: 'username' => 'Usernames',
6565: 'id' => 'IDs',
6566: );
6567: my $output;
6568: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
6569: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
6570: if (@{$ruleorder} > 0) {
6571: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
6572: foreach my $rule (@{$ruleorder}) {
6573: if (ref($curr_rules) eq 'ARRAY') {
6574: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
6575: if (ref($rules->{$rule}) eq 'HASH') {
6576: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
6577: $rules->{$rule}{'desc'}.'</li>';
6578: }
6579: }
6580: }
6581: }
6582: $output .= '</ul>';
6583: }
6584: }
6585: return $output;
6586: }
6587:
6588: sub instrule_disallow_msg {
1.615 raeburn 6589: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 6590: my $response;
6591: my %text = (
6592: item => 'username',
6593: items => 'usernames',
6594: match => 'matches',
6595: do => 'does',
6596: action => 'a username',
6597: one => 'one',
6598: );
6599: if ($count > 1) {
6600: $text{'item'} = 'usernames';
6601: $text{'match'} ='match';
6602: $text{'do'} = 'do';
6603: $text{'action'} = 'usernames',
6604: $text{'one'} = 'ones';
6605: }
6606: if ($checkitem eq 'id') {
6607: $text{'items'} = 'IDs';
6608: $text{'item'} = 'ID';
6609: $text{'action'} = 'an ID';
1.615 raeburn 6610: if ($count > 1) {
6611: $text{'item'} = 'IDs';
6612: $text{'action'} = 'IDs';
6613: }
1.612 raeburn 6614: }
6615: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for <span class=\"LC_cusr_emph\">[_1]</span>, but the $text{'item'} $text{'do'} not exist in the institutional directory.",$domdesc).'<br />';
1.615 raeburn 6616: if ($mode eq 'upload') {
6617: if ($checkitem eq 'username') {
6618: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
6619: } elsif ($checkitem eq 'id') {
6620: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the ID/Student Number field.");
6621: }
6622: } else {
6623: if ($checkitem eq 'username') {
6624: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
6625: } elsif ($checkitem eq 'id') {
6626: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
6627: }
1.612 raeburn 6628: }
6629: return $response;
1.585 raeburn 6630: }
6631:
1.624 raeburn 6632: sub personal_data_fieldtitles {
6633: my %fieldtitles = &Apache::lonlocal::texthash (
6634: id => 'Student/Employee ID',
6635: permanentemail => 'E-mail address',
6636: lastname => 'Last Name',
6637: firstname => 'First Name',
6638: middlename => 'Middle Name',
6639: generation => 'Generation',
6640: gen => 'Generation',
6641: );
6642: return %fieldtitles;
6643: }
6644:
1.112 bowersj2 6645: =pod
6646:
1.549 albertel 6647: =back
6648:
6649: =head1 HTTP Helpers
6650:
6651: =over 4
6652:
1.112 bowersj2 6653: =item * get_unprocessed_cgi($query,$possible_names)
6654:
1.258 albertel 6655: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 6656: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 6657: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 6658:
6659: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
6660: $possible_names is an ref to an array of form element names. As an example:
6661: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 6662: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 6663:
6664: =cut
1.1 albertel 6665:
1.6 albertel 6666: sub get_unprocessed_cgi {
1.25 albertel 6667: my ($query,$possible_names)= @_;
1.26 matthew 6668: # $Apache::lonxml::debug=1;
1.356 albertel 6669: foreach my $pair (split(/&/,$query)) {
6670: my ($name, $value) = split(/=/,$pair);
1.369 www 6671: $name = &unescape($name);
1.25 albertel 6672: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
6673: $value =~ tr/+/ /;
6674: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 6675: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 6676: }
1.16 harris41 6677: }
1.6 albertel 6678: }
6679:
1.112 bowersj2 6680: =pod
6681:
6682: =item * cacheheader()
6683:
6684: returns cache-controlling header code
6685:
6686: =cut
6687:
1.7 albertel 6688: sub cacheheader {
1.258 albertel 6689: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 6690: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
6691: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 6692: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
6693: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 6694: return $output;
1.7 albertel 6695: }
6696:
1.112 bowersj2 6697: =pod
6698:
6699: =item * no_cache($r)
6700:
6701: specifies header code to not have cache
6702:
6703: =cut
6704:
1.9 albertel 6705: sub no_cache {
1.216 albertel 6706: my ($r) = @_;
6707: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 6708: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 6709: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
6710: $r->no_cache(1);
6711: $r->header_out("Expires" => $date);
6712: $r->header_out("Pragma" => "no-cache");
1.123 www 6713: }
6714:
6715: sub content_type {
1.181 albertel 6716: my ($r,$type,$charset) = @_;
1.299 foxr 6717: if ($r) {
6718: # Note that printout.pl calls this with undef for $r.
6719: &no_cache($r);
6720: }
1.258 albertel 6721: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 6722: unless ($charset) {
6723: $charset=&Apache::lonlocal::current_encoding;
6724: }
6725: if ($charset) { $type.='; charset='.$charset; }
6726: if ($r) {
6727: $r->content_type($type);
6728: } else {
6729: print("Content-type: $type\n\n");
6730: }
1.9 albertel 6731: }
1.25 albertel 6732:
1.112 bowersj2 6733: =pod
6734:
6735: =item * add_to_env($name,$value)
6736:
1.258 albertel 6737: adds $name to the %env hash with value
1.112 bowersj2 6738: $value, if $name already exists, the entry is converted to an array
6739: reference and $value is added to the array.
6740:
6741: =cut
6742:
1.25 albertel 6743: sub add_to_env {
6744: my ($name,$value)=@_;
1.258 albertel 6745: if (defined($env{$name})) {
6746: if (ref($env{$name})) {
1.25 albertel 6747: #already have multiple values
1.258 albertel 6748: push(@{ $env{$name} },$value);
1.25 albertel 6749: } else {
6750: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 6751: my $first=$env{$name};
6752: undef($env{$name});
6753: push(@{ $env{$name} },$first,$value);
1.25 albertel 6754: }
6755: } else {
1.258 albertel 6756: $env{$name}=$value;
1.25 albertel 6757: }
1.31 albertel 6758: }
1.149 albertel 6759:
6760: =pod
6761:
6762: =item * get_env_multiple($name)
6763:
1.258 albertel 6764: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 6765: values may be defined and end up as an array ref.
6766:
6767: returns an array of values
6768:
6769: =cut
6770:
6771: sub get_env_multiple {
6772: my ($name) = @_;
6773: my @values;
1.258 albertel 6774: if (defined($env{$name})) {
1.149 albertel 6775: # exists is it an array
1.258 albertel 6776: if (ref($env{$name})) {
6777: @values=@{ $env{$name} };
1.149 albertel 6778: } else {
1.258 albertel 6779: $values[0]=$env{$name};
1.149 albertel 6780: }
6781: }
6782: return(@values);
6783: }
6784:
1.31 albertel 6785:
1.41 ng 6786: =pod
1.45 matthew 6787:
1.464 albertel 6788: =back
1.41 ng 6789:
1.112 bowersj2 6790: =head1 CSV Upload/Handling functions
1.38 albertel 6791:
1.41 ng 6792: =over 4
6793:
1.112 bowersj2 6794: =item * upfile_store($r)
1.41 ng 6795:
6796: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 6797: needs $env{'form.upfile'}
1.41 ng 6798: returns $datatoken to be put into hidden field
6799:
6800: =cut
1.31 albertel 6801:
6802: sub upfile_store {
6803: my $r=shift;
1.258 albertel 6804: $env{'form.upfile'}=~s/\r/\n/gs;
6805: $env{'form.upfile'}=~s/\f/\n/gs;
6806: $env{'form.upfile'}=~s/\n+/\n/gs;
6807: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 6808:
1.258 albertel 6809: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
6810: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 6811: {
1.158 raeburn 6812: my $datafile = $r->dir_config('lonDaemons').
6813: '/tmp/'.$datatoken.'.tmp';
6814: if ( open(my $fh,">$datafile") ) {
1.258 albertel 6815: print $fh $env{'form.upfile'};
1.158 raeburn 6816: close($fh);
6817: }
1.31 albertel 6818: }
6819: return $datatoken;
6820: }
6821:
1.56 matthew 6822: =pod
6823:
1.112 bowersj2 6824: =item * load_tmp_file($r)
1.41 ng 6825:
6826: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 6827: needs $env{'form.datatoken'},
6828: sets $env{'form.upfile'} to the contents of the file
1.41 ng 6829:
6830: =cut
1.31 albertel 6831:
6832: sub load_tmp_file {
6833: my $r=shift;
6834: my @studentdata=();
6835: {
1.158 raeburn 6836: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 6837: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 6838: if ( open(my $fh,"<$studentfile") ) {
6839: @studentdata=<$fh>;
6840: close($fh);
6841: }
1.31 albertel 6842: }
1.258 albertel 6843: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 6844: }
6845:
1.56 matthew 6846: =pod
6847:
1.112 bowersj2 6848: =item * upfile_record_sep()
1.41 ng 6849:
6850: Separate uploaded file into records
6851: returns array of records,
1.258 albertel 6852: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 6853:
6854: =cut
1.31 albertel 6855:
6856: sub upfile_record_sep {
1.258 albertel 6857: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 6858: } else {
1.248 albertel 6859: my @records;
1.258 albertel 6860: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 6861: if ($line=~/^\s*$/) { next; }
6862: push(@records,$line);
6863: }
6864: return @records;
1.31 albertel 6865: }
6866: }
6867:
1.56 matthew 6868: =pod
6869:
1.112 bowersj2 6870: =item * record_sep($record)
1.41 ng 6871:
1.258 albertel 6872: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 6873:
6874: =cut
6875:
1.263 www 6876: sub takeleft {
6877: my $index=shift;
6878: return substr('0000'.$index,-4,4);
6879: }
6880:
1.31 albertel 6881: sub record_sep {
6882: my $record=shift;
6883: my %components=();
1.258 albertel 6884: if ($env{'form.upfiletype'} eq 'xml') {
6885: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 6886: my $i=0;
1.356 albertel 6887: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 6888: $field=~s/^(\"|\')//;
6889: $field=~s/(\"|\')$//;
1.263 www 6890: $components{&takeleft($i)}=$field;
1.31 albertel 6891: $i++;
6892: }
1.258 albertel 6893: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 6894: my $i=0;
1.356 albertel 6895: foreach my $field (split(/\t/,$record)) {
1.31 albertel 6896: $field=~s/^(\"|\')//;
6897: $field=~s/(\"|\')$//;
1.263 www 6898: $components{&takeleft($i)}=$field;
1.31 albertel 6899: $i++;
6900: }
6901: } else {
1.561 www 6902: my $separator=',';
1.480 banghart 6903: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 6904: $separator=';';
1.480 banghart 6905: }
1.31 albertel 6906: my $i=0;
1.561 www 6907: # the character we are looking for to indicate the end of a quote or a record
6908: my $looking_for=$separator;
6909: # do not add the characters to the fields
6910: my $ignore=0;
6911: # we just encountered a separator (or the beginning of the record)
6912: my $just_found_separator=1;
6913: # store the field we are working on here
6914: my $field='';
6915: # work our way through all characters in record
6916: foreach my $character ($record=~/(.)/g) {
6917: if ($character eq $looking_for) {
6918: if ($character ne $separator) {
6919: # Found the end of a quote, again looking for separator
6920: $looking_for=$separator;
6921: $ignore=1;
6922: } else {
6923: # Found a separator, store away what we got
6924: $components{&takeleft($i)}=$field;
6925: $i++;
6926: $just_found_separator=1;
6927: $ignore=0;
6928: $field='';
6929: }
6930: next;
6931: }
6932: # single or double quotation marks after a separator indicate beginning of a quote
6933: # we are now looking for the end of the quote and need to ignore separators
6934: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
6935: $looking_for=$character;
6936: next;
6937: }
6938: # ignore would be true after we reached the end of a quote
6939: if ($ignore) { next; }
6940: if (($just_found_separator) && ($character=~/\s/)) { next; }
6941: $field.=$character;
6942: $just_found_separator=0;
1.31 albertel 6943: }
1.561 www 6944: # catch the very last entry, since we never encountered the separator
6945: $components{&takeleft($i)}=$field;
1.31 albertel 6946: }
6947: return %components;
6948: }
6949:
1.144 matthew 6950: ######################################################
6951: ######################################################
6952:
1.56 matthew 6953: =pod
6954:
1.112 bowersj2 6955: =item * upfile_select_html()
1.41 ng 6956:
1.144 matthew 6957: Return HTML code to select a file from the users machine and specify
6958: the file type.
1.41 ng 6959:
6960: =cut
6961:
1.144 matthew 6962: ######################################################
6963: ######################################################
1.31 albertel 6964: sub upfile_select_html {
1.144 matthew 6965: my %Types = (
6966: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 6967: semisv => &mt('Semicolon separated values'),
1.144 matthew 6968: space => &mt('Space separated'),
6969: tab => &mt('Tabulator separated'),
6970: # xml => &mt('HTML/XML'),
6971: );
6972: my $Str = '<input type="file" name="upfile" size="50" />'.
6973: '<br />Type: <select name="upfiletype">';
6974: foreach my $type (sort(keys(%Types))) {
6975: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
6976: }
6977: $Str .= "</select>\n";
6978: return $Str;
1.31 albertel 6979: }
6980:
1.301 albertel 6981: sub get_samples {
6982: my ($records,$toget) = @_;
6983: my @samples=({});
6984: my $got=0;
6985: foreach my $rec (@$records) {
6986: my %temp = &record_sep($rec);
6987: if (! grep(/\S/, values(%temp))) { next; }
6988: if (%temp) {
6989: $samples[$got]=\%temp;
6990: $got++;
6991: if ($got == $toget) { last; }
6992: }
6993: }
6994: return \@samples;
6995: }
6996:
1.144 matthew 6997: ######################################################
6998: ######################################################
6999:
1.56 matthew 7000: =pod
7001:
1.112 bowersj2 7002: =item * csv_print_samples($r,$records)
1.41 ng 7003:
7004: Prints a table of sample values from each column uploaded $r is an
7005: Apache Request ref, $records is an arrayref from
7006: &Apache::loncommon::upfile_record_sep
7007:
7008: =cut
7009:
1.144 matthew 7010: ######################################################
7011: ######################################################
1.31 albertel 7012: sub csv_print_samples {
7013: my ($r,$records) = @_;
1.301 albertel 7014: my $samples = &get_samples($records,3);
7015:
1.594 raeburn 7016: $r->print(&mt('Samples').'<br />'.&start_data_table().
7017: &start_data_table_header_row());
1.356 albertel 7018: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7019: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7020: $r->print(&end_data_table_header_row());
1.301 albertel 7021: foreach my $hash (@$samples) {
1.594 raeburn 7022: $r->print(&start_data_table_row());
1.356 albertel 7023: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7024: $r->print('<td>');
1.356 albertel 7025: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7026: $r->print('</td>');
7027: }
1.594 raeburn 7028: $r->print(&end_data_table_row());
1.31 albertel 7029: }
1.594 raeburn 7030: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7031: }
7032:
1.144 matthew 7033: ######################################################
7034: ######################################################
7035:
1.56 matthew 7036: =pod
7037:
1.112 bowersj2 7038: =item * csv_print_select_table($r,$records,$d)
1.41 ng 7039:
7040: Prints a table to create associations between values and table columns.
1.144 matthew 7041:
1.41 ng 7042: $r is an Apache Request ref,
7043: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7044: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7045:
7046: =cut
7047:
1.144 matthew 7048: ######################################################
7049: ######################################################
1.31 albertel 7050: sub csv_print_select_table {
7051: my ($r,$records,$d) = @_;
1.301 albertel 7052: my $i=0;
7053: my $samples = &get_samples($records,1);
1.144 matthew 7054: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7055: &start_data_table().&start_data_table_header_row().
1.144 matthew 7056: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7057: '<th>'.&mt('Column').'</th>'.
7058: &end_data_table_header_row()."\n");
1.356 albertel 7059: foreach my $array_ref (@$d) {
7060: my ($value,$display,$defaultcol)=@{ $array_ref };
1.594 raeburn 7061: $r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');
1.31 albertel 7062:
7063: $r->print('<td><select name=f'.$i.
1.32 matthew 7064: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7065: $r->print('<option value="none"></option>');
1.356 albertel 7066: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7067: $r->print('<option value="'.$sample.'"'.
7068: ($sample eq $defaultcol ? ' selected="selected" ' : '').
7069: '>Column '.($sample+1).'</option>');
1.31 albertel 7070: }
1.594 raeburn 7071: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7072: $i++;
7073: }
1.594 raeburn 7074: $r->print(&end_data_table());
1.31 albertel 7075: $i--;
7076: return $i;
7077: }
1.56 matthew 7078:
1.144 matthew 7079: ######################################################
7080: ######################################################
7081:
1.56 matthew 7082: =pod
1.31 albertel 7083:
1.112 bowersj2 7084: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 7085:
7086: Prints a table of sample values from the upload and can make associate samples to internal names.
7087:
7088: $r is an Apache Request ref,
7089: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7090: $d is an array of 2 element arrays (internal name, displayed name)
7091:
7092: =cut
7093:
1.144 matthew 7094: ######################################################
7095: ######################################################
1.31 albertel 7096: sub csv_samples_select_table {
7097: my ($r,$records,$d) = @_;
7098: my $i=0;
1.144 matthew 7099: #
1.301 albertel 7100: my $samples = &get_samples($records,3);
1.594 raeburn 7101: $r->print(&start_data_table().
7102: &start_data_table_header_row().'<th>'.
7103: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
7104: &end_data_table_header_row());
1.301 albertel 7105:
7106: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 7107: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 7108: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 7109: foreach my $option (@$d) {
7110: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 7111: $r->print('<option value="'.$value.'"'.
1.253 albertel 7112: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 7113: $display.'</option>');
1.31 albertel 7114: }
7115: $r->print('</select></td><td>');
1.301 albertel 7116: foreach my $line (0..2) {
7117: if (defined($samples->[$line]{$key})) {
7118: $r->print($samples->[$line]{$key}."<br />\n");
7119: }
7120: }
1.594 raeburn 7121: $r->print('</td>'.&end_data_table_row());
1.31 albertel 7122: $i++;
7123: }
1.594 raeburn 7124: $r->print(&end_data_table());
1.31 albertel 7125: $i--;
7126: return($i);
1.115 matthew 7127: }
7128:
1.144 matthew 7129: ######################################################
7130: ######################################################
7131:
1.115 matthew 7132: =pod
7133:
7134: =item clean_excel_name($name)
7135:
7136: Returns a replacement for $name which does not contain any illegal characters.
7137:
7138: =cut
7139:
1.144 matthew 7140: ######################################################
7141: ######################################################
1.115 matthew 7142: sub clean_excel_name {
7143: my ($name) = @_;
7144: $name =~ s/[:\*\?\/\\]//g;
7145: if (length($name) > 31) {
7146: $name = substr($name,0,31);
7147: }
7148: return $name;
1.25 albertel 7149: }
1.84 albertel 7150:
1.85 albertel 7151: =pod
7152:
1.112 bowersj2 7153: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 7154:
7155: Returns either 1 or undef
7156:
7157: 1 if the part is to be hidden, undef if it is to be shown
7158:
7159: Arguments are:
7160:
7161: $id the id of the part to be checked
7162: $symb, optional the symb of the resource to check
7163: $udom, optional the domain of the user to check for
7164: $uname, optional the username of the user to check for
7165:
7166: =cut
1.84 albertel 7167:
7168: sub check_if_partid_hidden {
7169: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 7170: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 7171: $symb,$udom,$uname);
1.141 albertel 7172: my $truth=1;
7173: #if the string starts with !, then the list is the list to show not hide
7174: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 7175: my @hiddenlist=split(/,/,$hiddenparts);
7176: foreach my $checkid (@hiddenlist) {
1.141 albertel 7177: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 7178: }
1.141 albertel 7179: return !$truth;
1.84 albertel 7180: }
1.127 matthew 7181:
1.138 matthew 7182:
7183: ############################################################
7184: ############################################################
7185:
7186: =pod
7187:
1.157 matthew 7188: =back
7189:
1.138 matthew 7190: =head1 cgi-bin script and graphing routines
7191:
1.157 matthew 7192: =over 4
7193:
1.138 matthew 7194: =item get_cgi_id
7195:
7196: Inputs: none
7197:
7198: Returns an id which can be used to pass environment variables
7199: to various cgi-bin scripts. These environment variables will
7200: be removed from the users environment after a given time by
7201: the routine &Apache::lonnet::transfer_profile_to_env.
7202:
7203: =cut
7204:
7205: ############################################################
7206: ############################################################
1.152 albertel 7207: my $uniq=0;
1.136 matthew 7208: sub get_cgi_id {
1.154 albertel 7209: $uniq=($uniq+1)%100000;
1.280 albertel 7210: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 7211: }
7212:
1.127 matthew 7213: ############################################################
7214: ############################################################
7215:
7216: =pod
7217:
1.134 matthew 7218: =item DrawBarGraph
1.127 matthew 7219:
1.138 matthew 7220: Facilitates the plotting of data in a (stacked) bar graph.
7221: Puts plot definition data into the users environment in order for
7222: graph.png to plot it. Returns an <img> tag for the plot.
7223: The bars on the plot are labeled '1','2',...,'n'.
7224:
7225: Inputs:
7226:
7227: =over 4
7228:
7229: =item $Title: string, the title of the plot
7230:
7231: =item $xlabel: string, text describing the X-axis of the plot
7232:
7233: =item $ylabel: string, text describing the Y-axis of the plot
7234:
7235: =item $Max: scalar, the maximum Y value to use in the plot
7236: If $Max is < any data point, the graph will not be rendered.
7237:
1.140 matthew 7238: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 7239: they are plotted. If undefined, default values will be used.
7240:
1.178 matthew 7241: =item $labels: array ref holding the labels to use on the x-axis for the bars.
7242:
1.138 matthew 7243: =item @Values: An array of array references. Each array reference holds data
7244: to be plotted in a stacked bar chart.
7245:
1.239 matthew 7246: =item If the final element of @Values is a hash reference the key/value
7247: pairs will be added to the graph definition.
7248:
1.138 matthew 7249: =back
7250:
7251: Returns:
7252:
7253: An <img> tag which references graph.png and the appropriate identifying
7254: information for the plot.
7255:
1.127 matthew 7256: =cut
7257:
7258: ############################################################
7259: ############################################################
1.134 matthew 7260: sub DrawBarGraph {
1.178 matthew 7261: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 7262: #
7263: if (! defined($colors)) {
7264: $colors = ['#33ff00',
7265: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
7266: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
7267: ];
7268: }
1.228 matthew 7269: my $extra_settings = {};
7270: if (ref($Values[-1]) eq 'HASH') {
7271: $extra_settings = pop(@Values);
7272: }
1.127 matthew 7273: #
1.136 matthew 7274: my $identifier = &get_cgi_id();
7275: my $id = 'cgi.'.$identifier;
1.129 matthew 7276: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 7277: return '';
7278: }
1.225 matthew 7279: #
7280: my @Labels;
7281: if (defined($labels)) {
7282: @Labels = @$labels;
7283: } else {
7284: for (my $i=0;$i<@{$Values[0]};$i++) {
7285: push (@Labels,$i+1);
7286: }
7287: }
7288: #
1.129 matthew 7289: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 7290: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 7291: my %ValuesHash;
7292: my $NumSets=1;
7293: foreach my $array (@Values) {
7294: next if (! ref($array));
1.136 matthew 7295: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 7296: join(',',@$array);
1.129 matthew 7297: }
1.127 matthew 7298: #
1.136 matthew 7299: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 7300: if ($NumBars < 3) {
7301: $width = 120+$NumBars*32;
1.220 matthew 7302: $xskip = 1;
1.225 matthew 7303: $bar_width = 30;
7304: } elsif ($NumBars < 5) {
7305: $width = 120+$NumBars*20;
7306: $xskip = 1;
7307: $bar_width = 20;
1.220 matthew 7308: } elsif ($NumBars < 10) {
1.136 matthew 7309: $width = 120+$NumBars*15;
7310: $xskip = 1;
7311: $bar_width = 15;
7312: } elsif ($NumBars <= 25) {
7313: $width = 120+$NumBars*11;
7314: $xskip = 5;
7315: $bar_width = 8;
7316: } elsif ($NumBars <= 50) {
7317: $width = 120+$NumBars*8;
7318: $xskip = 5;
7319: $bar_width = 4;
7320: } else {
7321: $width = 120+$NumBars*8;
7322: $xskip = 5;
7323: $bar_width = 4;
7324: }
7325: #
1.137 matthew 7326: $Max = 1 if ($Max < 1);
7327: if ( int($Max) < $Max ) {
7328: $Max++;
7329: $Max = int($Max);
7330: }
1.127 matthew 7331: $Title = '' if (! defined($Title));
7332: $xlabel = '' if (! defined($xlabel));
7333: $ylabel = '' if (! defined($ylabel));
1.369 www 7334: $ValuesHash{$id.'.title'} = &escape($Title);
7335: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
7336: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 7337: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 7338: $ValuesHash{$id.'.NumBars'} = $NumBars;
7339: $ValuesHash{$id.'.NumSets'} = $NumSets;
7340: $ValuesHash{$id.'.PlotType'} = 'bar';
7341: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7342: $ValuesHash{$id.'.height'} = $height;
7343: $ValuesHash{$id.'.width'} = $width;
7344: $ValuesHash{$id.'.xskip'} = $xskip;
7345: $ValuesHash{$id.'.bar_width'} = $bar_width;
7346: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 7347: #
1.228 matthew 7348: # Deal with other parameters
7349: while (my ($key,$value) = each(%$extra_settings)) {
7350: $ValuesHash{$id.'.'.$key} = $value;
7351: }
7352: #
1.137 matthew 7353: &Apache::lonnet::appenv(%ValuesHash);
7354: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
7355: }
7356:
7357: ############################################################
7358: ############################################################
7359:
7360: =pod
7361:
7362: =item DrawXYGraph
7363:
1.138 matthew 7364: Facilitates the plotting of data in an XY graph.
7365: Puts plot definition data into the users environment in order for
7366: graph.png to plot it. Returns an <img> tag for the plot.
7367:
7368: Inputs:
7369:
7370: =over 4
7371:
7372: =item $Title: string, the title of the plot
7373:
7374: =item $xlabel: string, text describing the X-axis of the plot
7375:
7376: =item $ylabel: string, text describing the Y-axis of the plot
7377:
7378: =item $Max: scalar, the maximum Y value to use in the plot
7379: If $Max is < any data point, the graph will not be rendered.
7380:
7381: =item $colors: Array ref containing the hex color codes for the data to be
7382: plotted in. If undefined, default values will be used.
7383:
7384: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
7385:
7386: =item $Ydata: Array ref containing Array refs.
1.185 www 7387: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 7388:
7389: =item %Values: hash indicating or overriding any default values which are
7390: passed to graph.png.
7391: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
7392:
7393: =back
7394:
7395: Returns:
7396:
7397: An <img> tag which references graph.png and the appropriate identifying
7398: information for the plot.
7399:
1.137 matthew 7400: =cut
7401:
7402: ############################################################
7403: ############################################################
7404: sub DrawXYGraph {
7405: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
7406: #
7407: # Create the identifier for the graph
7408: my $identifier = &get_cgi_id();
7409: my $id = 'cgi.'.$identifier;
7410: #
7411: $Title = '' if (! defined($Title));
7412: $xlabel = '' if (! defined($xlabel));
7413: $ylabel = '' if (! defined($ylabel));
7414: my %ValuesHash =
7415: (
1.369 www 7416: $id.'.title' => &escape($Title),
7417: $id.'.xlabel' => &escape($xlabel),
7418: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 7419: $id.'.y_max_value'=> $Max,
7420: $id.'.labels' => join(',',@$Xlabels),
7421: $id.'.PlotType' => 'XY',
7422: );
7423: #
7424: if (defined($colors) && ref($colors) eq 'ARRAY') {
7425: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7426: }
7427: #
7428: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
7429: return '';
7430: }
7431: my $NumSets=1;
1.138 matthew 7432: foreach my $array (@{$Ydata}){
1.137 matthew 7433: next if (! ref($array));
7434: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
7435: }
1.138 matthew 7436: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 7437: #
7438: # Deal with other parameters
7439: while (my ($key,$value) = each(%Values)) {
7440: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 7441: }
7442: #
1.136 matthew 7443: &Apache::lonnet::appenv(%ValuesHash);
7444: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
7445: }
7446:
7447: ############################################################
7448: ############################################################
7449:
7450: =pod
7451:
1.138 matthew 7452: =item DrawXYYGraph
7453:
7454: Facilitates the plotting of data in an XY graph with two Y axes.
7455: Puts plot definition data into the users environment in order for
7456: graph.png to plot it. Returns an <img> tag for the plot.
7457:
7458: Inputs:
7459:
7460: =over 4
7461:
7462: =item $Title: string, the title of the plot
7463:
7464: =item $xlabel: string, text describing the X-axis of the plot
7465:
7466: =item $ylabel: string, text describing the Y-axis of the plot
7467:
7468: =item $colors: Array ref containing the hex color codes for the data to be
7469: plotted in. If undefined, default values will be used.
7470:
7471: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
7472:
7473: =item $Ydata1: The first data set
7474:
7475: =item $Min1: The minimum value of the left Y-axis
7476:
7477: =item $Max1: The maximum value of the left Y-axis
7478:
7479: =item $Ydata2: The second data set
7480:
7481: =item $Min2: The minimum value of the right Y-axis
7482:
7483: =item $Max2: The maximum value of the left Y-axis
7484:
7485: =item %Values: hash indicating or overriding any default values which are
7486: passed to graph.png.
7487: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
7488:
7489: =back
7490:
7491: Returns:
7492:
7493: An <img> tag which references graph.png and the appropriate identifying
7494: information for the plot.
1.136 matthew 7495:
7496: =cut
7497:
7498: ############################################################
7499: ############################################################
1.137 matthew 7500: sub DrawXYYGraph {
7501: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
7502: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 7503: #
7504: # Create the identifier for the graph
7505: my $identifier = &get_cgi_id();
7506: my $id = 'cgi.'.$identifier;
7507: #
7508: $Title = '' if (! defined($Title));
7509: $xlabel = '' if (! defined($xlabel));
7510: $ylabel = '' if (! defined($ylabel));
7511: my %ValuesHash =
7512: (
1.369 www 7513: $id.'.title' => &escape($Title),
7514: $id.'.xlabel' => &escape($xlabel),
7515: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 7516: $id.'.labels' => join(',',@$Xlabels),
7517: $id.'.PlotType' => 'XY',
7518: $id.'.NumSets' => 2,
1.137 matthew 7519: $id.'.two_axes' => 1,
7520: $id.'.y1_max_value' => $Max1,
7521: $id.'.y1_min_value' => $Min1,
7522: $id.'.y2_max_value' => $Max2,
7523: $id.'.y2_min_value' => $Min2,
1.136 matthew 7524: );
7525: #
1.137 matthew 7526: if (defined($colors) && ref($colors) eq 'ARRAY') {
7527: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7528: }
7529: #
7530: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
7531: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 7532: return '';
7533: }
7534: my $NumSets=1;
1.137 matthew 7535: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 7536: next if (! ref($array));
7537: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 7538: }
7539: #
7540: # Deal with other parameters
7541: while (my ($key,$value) = each(%Values)) {
7542: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 7543: }
7544: #
7545: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 7546: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 7547: }
7548:
7549: ############################################################
7550: ############################################################
7551:
7552: =pod
7553:
1.157 matthew 7554: =back
7555:
1.139 matthew 7556: =head1 Statistics helper routines?
7557:
7558: Bad place for them but what the hell.
7559:
1.157 matthew 7560: =over 4
7561:
1.139 matthew 7562: =item &chartlink
7563:
7564: Returns a link to the chart for a specific student.
7565:
7566: Inputs:
7567:
7568: =over 4
7569:
7570: =item $linktext: The text of the link
7571:
7572: =item $sname: The students username
7573:
7574: =item $sdomain: The students domain
7575:
7576: =back
7577:
1.157 matthew 7578: =back
7579:
1.139 matthew 7580: =cut
7581:
7582: ############################################################
7583: ############################################################
7584: sub chartlink {
7585: my ($linktext, $sname, $sdomain) = @_;
7586: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 7587: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 7588: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 7589: '">'.$linktext.'</a>';
1.153 matthew 7590: }
7591:
7592: #######################################################
7593: #######################################################
7594:
7595: =pod
7596:
7597: =head1 Course Environment Routines
1.157 matthew 7598:
7599: =over 4
1.153 matthew 7600:
7601: =item &restore_course_settings
7602:
7603: =item &store_course_settings
7604:
7605: Restores/Store indicated form parameters from the course environment.
7606: Will not overwrite existing values of the form parameters.
7607:
7608: Inputs:
7609: a scalar describing the data (e.g. 'chart', 'problem_analysis')
7610:
7611: a hash ref describing the data to be stored. For example:
7612:
7613: %Save_Parameters = ('Status' => 'scalar',
7614: 'chartoutputmode' => 'scalar',
7615: 'chartoutputdata' => 'scalar',
7616: 'Section' => 'array',
1.373 raeburn 7617: 'Group' => 'array',
1.153 matthew 7618: 'StudentData' => 'array',
7619: 'Maps' => 'array');
7620:
7621: Returns: both routines return nothing
7622:
1.631 ! raeburn 7623: =back
! 7624:
1.153 matthew 7625: =cut
7626:
7627: #######################################################
7628: #######################################################
7629: sub store_course_settings {
1.496 albertel 7630: return &store_settings($env{'request.course.id'},@_);
7631: }
7632:
7633: sub store_settings {
1.153 matthew 7634: # save to the environment
7635: # appenv the same items, just to be safe
1.300 albertel 7636: my $udom = $env{'user.domain'};
7637: my $uname = $env{'user.name'};
1.496 albertel 7638: my ($context,$prefix,$Settings) = @_;
1.153 matthew 7639: my %SaveHash;
7640: my %AppHash;
7641: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 7642: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 7643: my $envname = 'environment.'.$basename;
1.258 albertel 7644: if (exists($env{'form.'.$setting})) {
1.153 matthew 7645: # Save this value away
7646: if ($type eq 'scalar' &&
1.258 albertel 7647: (! exists($env{$envname}) ||
7648: $env{$envname} ne $env{'form.'.$setting})) {
7649: $SaveHash{$basename} = $env{'form.'.$setting};
7650: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 7651: } elsif ($type eq 'array') {
7652: my $stored_form;
1.258 albertel 7653: if (ref($env{'form.'.$setting})) {
1.153 matthew 7654: $stored_form = join(',',
7655: map {
1.369 www 7656: &escape($_);
1.258 albertel 7657: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 7658: } else {
7659: $stored_form =
1.369 www 7660: &escape($env{'form.'.$setting});
1.153 matthew 7661: }
7662: # Determine if the array contents are the same.
1.258 albertel 7663: if ($stored_form ne $env{$envname}) {
1.153 matthew 7664: $SaveHash{$basename} = $stored_form;
7665: $AppHash{$envname} = $stored_form;
7666: }
7667: }
7668: }
7669: }
7670: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 7671: $udom,$uname);
1.153 matthew 7672: if ($put_result !~ /^(ok|delayed)/) {
7673: &Apache::lonnet::logthis('unable to save form parameters, '.
7674: 'got error:'.$put_result);
7675: }
7676: # Make sure these settings stick around in this session, too
7677: &Apache::lonnet::appenv(%AppHash);
7678: return;
7679: }
7680:
7681: sub restore_course_settings {
1.499 albertel 7682: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 7683: }
7684:
7685: sub restore_settings {
7686: my ($context,$prefix,$Settings) = @_;
1.153 matthew 7687: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 7688: next if (exists($env{'form.'.$setting}));
1.496 albertel 7689: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 7690: '.'.$setting;
1.258 albertel 7691: if (exists($env{$envname})) {
1.153 matthew 7692: if ($type eq 'scalar') {
1.258 albertel 7693: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 7694: } elsif ($type eq 'array') {
1.258 albertel 7695: $env{'form.'.$setting} = [
1.153 matthew 7696: map {
1.369 www 7697: &unescape($_);
1.258 albertel 7698: } split(',',$env{$envname})
1.153 matthew 7699: ];
7700: }
7701: }
7702: }
1.127 matthew 7703: }
7704:
1.618 raeburn 7705: #######################################################
7706: #######################################################
7707:
7708: =pod
7709:
7710: =head1 Domain E-mail Routines
7711:
7712: =over 4
7713:
7714: =item &build_recipient_list
7715:
7716: Build recipient lists for three types of e-mail:
7717: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 7718: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 7719:
7720: Inputs:
1.619 raeburn 7721: defmail (scalar - email address of default recipient),
1.618 raeburn 7722: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 7723: defdom (domain for which to retrieve configuration settings),
7724: origmail (scalar - email address of recipient from loncapa.conf,
7725: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 7726:
7727: Returns: comma separated list of addresses to which to send e-mail.
7728:
7729: =cut
7730:
7731: ############################################################
7732: ############################################################
7733: sub build_recipient_list {
1.619 raeburn 7734: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 7735: my @recipients;
7736: my $otheremails;
7737: my %domconfig =
7738: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
7739: if (ref($domconfig{'contacts'}) eq 'HASH') {
7740: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
7741: my @contacts = ('adminemail','supportemail');
7742: foreach my $item (@contacts) {
7743: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 7744: my $addr = $domconfig{'contacts'}{$item};
7745: if (!grep(/^\Q$addr\E$/,@recipients)) {
7746: push(@recipients,$addr);
7747: }
1.618 raeburn 7748: }
7749: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
7750: }
7751: }
1.619 raeburn 7752: } elsif ($origmail ne '') {
7753: push(@recipients,$origmail);
1.618 raeburn 7754: }
7755: if ($defmail ne '') {
7756: push(@recipients,$defmail);
7757: }
7758: if ($otheremails) {
1.619 raeburn 7759: my @others;
7760: if ($otheremails =~ /,/) {
7761: @others = split(/,/,$otheremails);
1.618 raeburn 7762: } else {
1.619 raeburn 7763: push(@others,$otheremails);
7764: }
7765: foreach my $addr (@others) {
7766: if (!grep(/^\Q$addr\E$/,@recipients)) {
7767: push(@recipients,$addr);
7768: }
1.618 raeburn 7769: }
7770: }
1.619 raeburn 7771: my $recipientlist = join(',',@recipients);
1.618 raeburn 7772: return $recipientlist;
7773: }
7774:
1.127 matthew 7775: ############################################################
7776: ############################################################
1.154 albertel 7777:
1.443 albertel 7778: sub commit_customrole {
7779: my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
1.630 raeburn 7780: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 7781: ($start?', '.&mt('starting').' '.localtime($start):'').
7782: ($end?', ending '.localtime($end):'').': <b>'.
7783: &Apache::lonnet::assigncustomrole(
7784: $udom,$uname,$url,$three,$four,$five,$end,$start).
7785: '</b><br />';
7786: return $output;
7787: }
7788:
7789: sub commit_standardrole {
1.541 raeburn 7790: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
7791: my ($output,$logmsg,$linefeed);
7792: if ($context eq 'auto') {
7793: $linefeed = "\n";
7794: } else {
7795: $linefeed = "<br />\n";
7796: }
1.443 albertel 7797: if ($three eq 'st') {
1.541 raeburn 7798: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
7799: $one,$two,$sec,$context);
7800: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 7801: ($result eq 'unknown_course') || ($result eq 'refused')) {
7802: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 7803: } else {
1.541 raeburn 7804: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 7805: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 7806: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
7807: if ($context eq 'auto') {
7808: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
7809: } else {
7810: $output .= '<b>'.$result.'</b>'.$linefeed.
7811: &mt('Add to classlist').': <b>ok</b>';
7812: }
7813: $output .= $linefeed;
1.443 albertel 7814: }
7815: } else {
7816: $output = &mt('Assigning').' '.$three.' in '.$url.
7817: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 7818: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
7819: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);
7820: if ($context eq 'auto') {
7821: $output .= $result.$linefeed;
7822: } else {
7823: $output .= '<b>'.$result.'</b>'.$linefeed;
7824: }
1.443 albertel 7825: }
7826: return $output;
7827: }
7828:
7829: sub commit_studentrole {
1.541 raeburn 7830: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 7831: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 7832: if ($context eq 'auto') {
7833: $linefeed = "\n";
7834: } else {
7835: $linefeed = '<br />'."\n";
7836: }
1.443 albertel 7837: if (defined($one) && defined($two)) {
7838: my $cid=$one.'_'.$two;
7839: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
7840: my $secchange = 0;
7841: my $expire_role_result;
7842: my $modify_section_result;
1.628 raeburn 7843: if ($oldsec ne '-1') {
7844: if ($oldsec ne $sec) {
1.443 albertel 7845: $secchange = 1;
1.628 raeburn 7846: my $now = time;
1.443 albertel 7847: my $uurl='/'.$cid;
7848: $uurl=~s/\_/\//g;
7849: if ($oldsec) {
7850: $uurl.='/'.$oldsec;
7851: }
1.626 raeburn 7852: $oldsecurl = $uurl;
1.628 raeburn 7853: $expire_role_result =
7854: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now);
7855: if ($env{'request.course.sec'} ne '') {
7856: if ($expire_role_result eq 'refused') {
7857: my @roles = ('st');
7858: my @statuses = ('previous');
7859: my @roledoms = ($one);
7860: my $withsec = 1;
7861: my %roleshash =
7862: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
7863: \@statuses,\@roles,\@roledoms,$withsec);
7864: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
7865: my ($oldstart,$oldend) =
7866: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
7867: if ($oldend > 0 && $oldend <= $now) {
7868: $expire_role_result = 'ok';
7869: }
7870: }
7871: }
7872: }
1.443 albertel 7873: $result = $expire_role_result;
7874: }
7875: }
7876: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
7877: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
7878: if ($modify_section_result =~ /^ok/) {
7879: if ($secchange == 1) {
1.628 raeburn 7880: if ($sec eq '') {
7881: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
7882: } else {
7883: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
7884: }
1.443 albertel 7885: } elsif ($oldsec eq '-1') {
1.628 raeburn 7886: if ($sec eq '') {
7887: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
7888: } else {
7889: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
7890: }
1.443 albertel 7891: } else {
1.628 raeburn 7892: if ($sec eq '') {
7893: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
7894: } else {
7895: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
7896: }
1.443 albertel 7897: }
7898: } else {
1.628 raeburn 7899: if ($secchange) {
7900: $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
7901: } else {
7902: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
7903: }
1.443 albertel 7904: }
7905: $result = $modify_section_result;
7906: } elsif ($secchange == 1) {
1.628 raeburn 7907: if ($oldsec eq '') {
7908: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
7909: } else {
7910: $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
7911: }
1.626 raeburn 7912: if ($expire_role_result eq 'refused') {
7913: my $newsecurl = '/'.$cid;
7914: $newsecurl =~ s/\_/\//g;
7915: if ($sec ne '') {
7916: $newsecurl.='/'.$sec;
7917: }
7918: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
7919: if ($sec eq '') {
7920: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
7921: } else {
7922: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
7923: }
7924: }
7925: }
1.443 albertel 7926: }
7927: } else {
1.626 raeburn 7928: $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443 albertel 7929: $result = "error: incomplete course id\n";
7930: }
7931: return $result;
7932: }
7933:
7934: ############################################################
7935: ############################################################
7936:
1.566 albertel 7937: sub check_clone {
1.578 raeburn 7938: my ($args,$linefeed) = @_;
1.566 albertel 7939: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
7940: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
7941: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
7942: my $clonemsg;
7943: my $can_clone = 0;
7944:
7945: if ($clonehome eq 'no_host') {
1.578 raeburn 7946: $clonemsg = &mt('No new course created.').$linefeed.&mt('A new course could not be cloned from the specified original - [_1] - because it is a non-existent course.',$args->{'clonecourse'}.':'.$args->{'clonedomain'});
1.566 albertel 7947: } else {
7948: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 7949: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 7950: $can_clone = 1;
7951: } else {
7952: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
7953: $args->{'clonedomain'},$args->{'clonecourse'});
7954: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 7955: if (grep(/^\*$/,@cloners)) {
7956: $can_clone = 1;
7957: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
7958: $can_clone = 1;
7959: } else {
7960: my %roleshash =
7961: &Apache::lonnet::get_my_roles($args->{'ccuname'},
7962: $args->{'ccdomain'},
7963: 'userroles',['active'],['cc'],
7964: [$args->{'clonedomain'}]);
7965: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
7966: $can_clone = 1;
7967: } else {
7968: $clonemsg = &mt('No new course created.').$linefeed.&mt('The new course could not be cloned from the existing course because the new course owner ([_1]) does not have cloning rights in the existing course ([_2]).',$args->{'ccuname'}.':'.$args->{'ccdomain'},$clonedesc{'description'});
7969: }
1.566 albertel 7970: }
1.578 raeburn 7971: }
1.566 albertel 7972: }
7973: return ($can_clone, $clonemsg, $cloneid, $clonehome);
7974: }
7975:
1.444 albertel 7976: sub construct_course {
1.541 raeburn 7977: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 7978: my $outcome;
1.541 raeburn 7979: my $linefeed = '<br />'."\n";
7980: if ($context eq 'auto') {
7981: $linefeed = "\n";
7982: }
1.566 albertel 7983:
7984: #
7985: # Are we cloning?
7986: #
7987: my ($can_clone, $clonemsg, $cloneid, $clonehome);
7988: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 7989: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 7990: if ($context ne 'auto') {
1.578 raeburn 7991: if ($clonemsg ne '') {
7992: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
7993: }
1.566 albertel 7994: }
7995: $outcome .= $clonemsg.$linefeed;
7996:
7997: if (!$can_clone) {
7998: return (0,$outcome);
7999: }
8000: }
8001:
1.444 albertel 8002: #
8003: # Open course
8004: #
8005: my $crstype = lc($args->{'crstype'});
8006: my %cenv=();
8007: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
8008: $args->{'cdescr'},
8009: $args->{'curl'},
8010: $args->{'course_home'},
8011: $args->{'nonstandard'},
8012: $args->{'crscode'},
8013: $args->{'ccuname'}.':'.
8014: $args->{'ccdomain'},
8015: $args->{'crstype'});
8016:
8017: # Note: The testing routines depend on this being output; see
8018: # Utils::Course. This needs to at least be output as a comment
8019: # if anyone ever decides to not show this, and Utils::Course::new
8020: # will need to be suitably modified.
1.541 raeburn 8021: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 8022: #
8023: # Check if created correctly
8024: #
1.479 albertel 8025: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 8026: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 8027: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 8028:
1.444 albertel 8029: #
1.566 albertel 8030: # Do the cloning
8031: #
8032: if ($can_clone && $cloneid) {
8033: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
8034: if ($context ne 'auto') {
8035: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
8036: }
8037: $outcome .= $clonemsg.$linefeed;
8038: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 8039: # Copy all files
1.566 albertel 8040: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
1.444 albertel 8041: # Restore URL
1.566 albertel 8042: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 8043: # Restore title
1.566 albertel 8044: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 8045: # restore grading mode
1.566 albertel 8046: if (defined($oldcenv{'grading'})) {
8047: $cenv{'grading'}=$oldcenv{'grading'};
8048: }
1.444 albertel 8049: # Mark as cloned
1.566 albertel 8050: $cenv{'clonedfrom'}=$cloneid;
8051: delete($cenv{'default_enrollment_start_date'});
8052: delete($cenv{'default_enrollment_end_date'});
1.444 albertel 8053: }
1.566 albertel 8054:
1.444 albertel 8055: #
8056: # Set environment (will override cloned, if existing)
8057: #
8058: my @sections = ();
8059: my @xlists = ();
8060: if ($args->{'crstype'}) {
8061: $cenv{'type'}=$args->{'crstype'};
8062: }
8063: if ($args->{'crsid'}) {
8064: $cenv{'courseid'}=$args->{'crsid'};
8065: }
8066: if ($args->{'crscode'}) {
8067: $cenv{'internal.coursecode'}=$args->{'crscode'};
8068: }
8069: if ($args->{'crsquota'} ne '') {
8070: $cenv{'internal.coursequota'}=$args->{'crsquota'};
8071: } else {
8072: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
8073: }
8074: if ($args->{'ccuname'}) {
8075: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
8076: ':'.$args->{'ccdomain'};
8077: } else {
8078: $cenv{'internal.courseowner'} = $args->{'curruser'};
8079: }
8080:
8081: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
8082: if ($args->{'crssections'}) {
8083: $cenv{'internal.sectionnums'} = '';
8084: if ($args->{'crssections'} =~ m/,/) {
8085: @sections = split/,/,$args->{'crssections'};
8086: } else {
8087: $sections[0] = $args->{'crssections'};
8088: }
8089: if (@sections > 0) {
8090: foreach my $item (@sections) {
8091: my ($sec,$gp) = split/:/,$item;
8092: my $class = $args->{'crscode'}.$sec;
8093: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
8094: $cenv{'internal.sectionnums'} .= $item.',';
8095: unless ($addcheck eq 'ok') {
8096: push @badclasses, $class;
8097: }
8098: }
8099: $cenv{'internal.sectionnums'} =~ s/,$//;
8100: }
8101: }
8102: # do not hide course coordinator from staff listing,
8103: # even if privileged
8104: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
8105: # add crosslistings
8106: if ($args->{'crsxlist'}) {
8107: $cenv{'internal.crosslistings'}='';
8108: if ($args->{'crsxlist'} =~ m/,/) {
8109: @xlists = split/,/,$args->{'crsxlist'};
8110: } else {
8111: $xlists[0] = $args->{'crsxlist'};
8112: }
8113: if (@xlists > 0) {
8114: foreach my $item (@xlists) {
8115: my ($xl,$gp) = split/:/,$item;
8116: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
8117: $cenv{'internal.crosslistings'} .= $item.',';
8118: unless ($addcheck eq 'ok') {
8119: push @badclasses, $xl;
8120: }
8121: }
8122: $cenv{'internal.crosslistings'} =~ s/,$//;
8123: }
8124: }
8125: if ($args->{'autoadds'}) {
8126: $cenv{'internal.autoadds'}=$args->{'autoadds'};
8127: }
8128: if ($args->{'autodrops'}) {
8129: $cenv{'internal.autodrops'}=$args->{'autodrops'};
8130: }
8131: # check for notification of enrollment changes
8132: my @notified = ();
8133: if ($args->{'notify_owner'}) {
8134: if ($args->{'ccuname'} ne '') {
8135: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
8136: }
8137: }
8138: if ($args->{'notify_dc'}) {
8139: if ($uname ne '') {
1.630 raeburn 8140: push(@notified,$uname.':'.$udom);
1.444 albertel 8141: }
8142: }
8143: if (@notified > 0) {
8144: my $notifylist;
8145: if (@notified > 1) {
8146: $notifylist = join(',',@notified);
8147: } else {
8148: $notifylist = $notified[0];
8149: }
8150: $cenv{'internal.notifylist'} = $notifylist;
8151: }
8152: if (@badclasses > 0) {
8153: my %lt=&Apache::lonlocal::texthash(
8154: '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',
8155: 'dnhr' => 'does not have rights to access enrollment in these classes',
8156: 'adby' => 'as determined by the policies of your institution on access to official classlists'
8157: );
1.541 raeburn 8158: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
8159: ' ('.$lt{'adby'}.')';
8160: if ($context eq 'auto') {
8161: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 8162: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 8163: foreach my $item (@badclasses) {
8164: if ($context eq 'auto') {
8165: $outcome .= " - $item\n";
8166: } else {
8167: $outcome .= "<li>$item</li>\n";
8168: }
8169: }
8170: if ($context eq 'auto') {
8171: $outcome .= $linefeed;
8172: } else {
1.566 albertel 8173: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 8174: }
8175: }
1.444 albertel 8176: }
8177: if ($args->{'no_end_date'}) {
8178: $args->{'endaccess'} = 0;
8179: }
8180: $cenv{'internal.autostart'}=$args->{'enrollstart'};
8181: $cenv{'internal.autoend'}=$args->{'enrollend'};
8182: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
8183: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
8184: if ($args->{'showphotos'}) {
8185: $cenv{'internal.showphotos'}=$args->{'showphotos'};
8186: }
8187: $cenv{'internal.authtype'} = $args->{'authtype'};
8188: $cenv{'internal.autharg'} = $args->{'autharg'};
8189: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
8190: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 8191: 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');
8192: if ($context eq 'auto') {
8193: $outcome .= $krb_msg;
8194: } else {
1.566 albertel 8195: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 8196: }
8197: $outcome .= $linefeed;
1.444 albertel 8198: }
8199: }
8200: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
8201: if ($args->{'setpolicy'}) {
8202: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
8203: }
8204: if ($args->{'setcontent'}) {
8205: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
8206: }
8207: }
8208: if ($args->{'reshome'}) {
8209: $cenv{'reshome'}=$args->{'reshome'}.'/';
8210: $cenv{'reshome'}=~s/\/+$/\//;
8211: }
8212: #
8213: # course has keyed access
8214: #
8215: if ($args->{'setkeys'}) {
8216: $cenv{'keyaccess'}='yes';
8217: }
8218: # if specified, key authority is not course, but user
8219: # only active if keyaccess is yes
8220: if ($args->{'keyauth'}) {
1.487 albertel 8221: my ($user,$domain) = split(':',$args->{'keyauth'});
8222: $user = &LONCAPA::clean_username($user);
8223: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 8224: if ($user ne '' && $domain ne '') {
1.487 albertel 8225: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 8226: }
8227: }
8228:
8229: if ($args->{'disresdis'}) {
8230: $cenv{'pch.roles.denied'}='st';
8231: }
8232: if ($args->{'disablechat'}) {
8233: $cenv{'plc.roles.denied'}='st';
8234: }
8235:
8236: # Record we've not yet viewed the Course Initialization Helper for this
8237: # course
8238: $cenv{'course.helper.not.run'} = 1;
8239: #
8240: # Use new Randomseed
8241: #
8242: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
8243: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
8244: #
8245: # The encryption code and receipt prefix for this course
8246: #
8247: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
8248: $cenv{'internal.encpref'}=100+int(9*rand(99));
8249: #
8250: # By default, use standard grading
8251: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
8252:
1.541 raeburn 8253: $outcome .= $linefeed.&mt('Setting environment').': '.
8254: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 8255: #
8256: # Open all assignments
8257: #
8258: if ($args->{'openall'}) {
8259: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
8260: my %storecontent = ($storeunder => time,
8261: $storeunder.'.type' => 'date_start');
8262:
8263: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 8264: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 8265: }
8266: #
8267: # Set first page
8268: #
8269: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
8270: || ($cloneid)) {
1.445 albertel 8271: use LONCAPA::map;
1.444 albertel 8272: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 8273:
8274: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
8275: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
8276:
1.444 albertel 8277: $outcome .= ($fatal?$errtext:'read ok').' - ';
8278: my $title; my $url;
8279: if ($args->{'firstres'} eq 'syl') {
8280: $title='Syllabus';
8281: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
8282: } else {
8283: $title='Navigate Contents';
8284: $url='/adm/navmaps';
8285: }
1.445 albertel 8286:
8287: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
8288: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
8289:
8290: if ($errtext) { $fatal=2; }
1.541 raeburn 8291: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 8292: }
1.566 albertel 8293:
8294: return (1,$outcome);
1.444 albertel 8295: }
8296:
8297: ############################################################
8298: ############################################################
8299:
1.378 raeburn 8300: sub course_type {
8301: my ($cid) = @_;
8302: if (!defined($cid)) {
8303: $cid = $env{'request.course.id'};
8304: }
1.404 albertel 8305: if (defined($env{'course.'.$cid.'.type'})) {
8306: return $env{'course.'.$cid.'.type'};
1.378 raeburn 8307: } else {
8308: return 'Course';
1.377 raeburn 8309: }
8310: }
1.156 albertel 8311:
1.406 raeburn 8312: sub group_term {
8313: my $crstype = &course_type();
8314: my %names = (
8315: 'Course' => 'group',
8316: 'Group' => 'team',
8317: );
8318: return $names{$crstype};
8319: }
8320:
1.156 albertel 8321: sub icon {
8322: my ($file)=@_;
1.505 albertel 8323: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 8324: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 8325: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 8326: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
8327: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
8328: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
8329: $curfext.".gif") {
8330: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
8331: $curfext.".gif";
8332: }
8333: }
1.249 albertel 8334: return &lonhttpdurl($iconname);
1.154 albertel 8335: }
1.84 albertel 8336:
1.575 albertel 8337: sub lonhttpd_port {
1.215 albertel 8338: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
8339: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
1.574 albertel 8340: # IE doesn't like a secure page getting images from a non-secure
8341: # port (when logging we haven't parsed the browser type so default
8342: # back to secure
8343: if ((!exists($env{'browser.type'}) || $env{'browser.type'} eq 'explorer')
8344: && $ENV{'SERVER_PORT'} == 443) {
1.575 albertel 8345: return 443;
8346: }
8347: return $lonhttpd_port;
8348:
8349: }
8350:
8351: sub lonhttpdurl {
8352: my ($url)=@_;
8353:
8354: my $lonhttpd_port = &lonhttpd_port();
8355: if ($lonhttpd_port == 443) {
1.574 albertel 8356: return 'https://'.$ENV{'SERVER_NAME'}.$url;
8357: }
1.215 albertel 8358: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
8359: }
8360:
1.213 albertel 8361: sub connection_aborted {
8362: my ($r)=@_;
8363: $r->print(" ");$r->rflush();
8364: my $c = $r->connection;
8365: return $c->aborted();
8366: }
8367:
1.221 foxr 8368: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 8369: # strings as 'strings'.
8370: sub escape_single {
1.221 foxr 8371: my ($input) = @_;
1.223 albertel 8372: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 8373: $input =~ s/\'/\\\'/g; # Esacpe the 's....
8374: return $input;
8375: }
1.223 albertel 8376:
1.222 foxr 8377: # Same as escape_single, but escape's "'s This
8378: # can be used for "strings"
8379: sub escape_double {
8380: my ($input) = @_;
8381: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
8382: $input =~ s/\"/\\\"/g; # Esacpe the "s....
8383: return $input;
8384: }
1.223 albertel 8385:
1.222 foxr 8386: # Escapes the last element of a full URL.
8387: sub escape_url {
8388: my ($url) = @_;
1.238 raeburn 8389: my @urlslices = split(/\//, $url,-1);
1.369 www 8390: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 8391: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 8392: }
1.462 albertel 8393:
8394: # -------------------------------------------------------- Initliaze user login
8395: sub init_user_environment {
1.463 albertel 8396: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 8397: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
8398:
8399: my $public=($username eq 'public' && $domain eq 'public');
8400:
8401: # See if old ID present, if so, remove
8402:
8403: my ($filename,$cookie,$userroles);
8404: my $now=time;
8405:
8406: if ($public) {
8407: my $max_public=100;
8408: my $oldest;
8409: my $oldest_time=0;
8410: for(my $next=1;$next<=$max_public;$next++) {
8411: if (-e $lonids."/publicuser_$next.id") {
8412: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
8413: if ($mtime<$oldest_time || !$oldest_time) {
8414: $oldest_time=$mtime;
8415: $oldest=$next;
8416: }
8417: } else {
8418: $cookie="publicuser_$next";
8419: last;
8420: }
8421: }
8422: if (!$cookie) { $cookie="publicuser_$oldest"; }
8423: } else {
1.463 albertel 8424: # if this isn't a robot, kill any existing non-robot sessions
8425: if (!$args->{'robot'}) {
8426: opendir(DIR,$lonids);
8427: while ($filename=readdir(DIR)) {
8428: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
8429: unlink($lonids.'/'.$filename);
8430: }
1.462 albertel 8431: }
1.463 albertel 8432: closedir(DIR);
1.462 albertel 8433: }
8434: # Give them a new cookie
1.463 albertel 8435: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
8436: : $now);
8437: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 8438:
8439: # Initialize roles
8440:
8441: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
8442: }
8443: # ------------------------------------ Check browser type and MathML capability
8444:
8445: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
8446: $clientunicode,$clientos) = &decode_user_agent($r);
8447:
8448: # -------------------------------------- Any accessibility options to remember?
8449: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
8450: foreach my $option ('imagesuppress','appletsuppress',
8451: 'embedsuppress','fontenhance','blackwhite') {
8452: if ($form->{$option} eq 'true') {
8453: &Apache::lonnet::put('environment',{$option => 'on'},
8454: $domain,$username);
8455: } else {
8456: &Apache::lonnet::del('environment',[$option],
8457: $domain,$username);
8458: }
8459: }
8460: }
8461: # ------------------------------------------------------------- Get environment
8462:
8463: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
8464: my ($tmp) = keys(%userenv);
8465: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8466: # default remote control to off
8467: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
8468: } else {
8469: undef(%userenv);
8470: }
8471: if (($userenv{'interface'}) && (!$form->{'interface'})) {
8472: $form->{'interface'}=$userenv{'interface'};
8473: }
8474: $env{'environment.remote'}=$userenv{'remote'};
8475: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
8476:
8477: # --------------- Do not trust query string to be put directly into environment
8478: foreach my $option ('imagesuppress','appletsuppress',
8479: 'embedsuppress','fontenhance','blackwhite',
8480: 'interface','localpath','localres') {
8481: $form->{$option}=~s/[\n\r\=]//gs;
8482: }
8483: # --------------------------------------------------------- Write first profile
8484:
8485: {
8486: my %initial_env =
8487: ("user.name" => $username,
8488: "user.domain" => $domain,
8489: "user.home" => $authhost,
8490: "browser.type" => $clientbrowser,
8491: "browser.version" => $clientversion,
8492: "browser.mathml" => $clientmathml,
8493: "browser.unicode" => $clientunicode,
8494: "browser.os" => $clientos,
8495: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
8496: "request.course.fn" => '',
8497: "request.course.uri" => '',
8498: "request.course.sec" => '',
8499: "request.role" => 'cm',
8500: "request.role.adv" => $env{'user.adv'},
8501: "request.host" => $ENV{'REMOTE_ADDR'},);
8502:
8503: if ($form->{'localpath'}) {
8504: $initial_env{"browser.localpath"} = $form->{'localpath'};
8505: $initial_env{"browser.localres"} = $form->{'localres'};
8506: }
8507:
8508: if ($public) {
8509: $initial_env{"environment.remote"} = "off";
8510: }
8511: if ($form->{'interface'}) {
8512: $form->{'interface'}=~s/\W//gs;
8513: $initial_env{"browser.interface"} = $form->{'interface'};
8514: $env{'browser.interface'}=$form->{'interface'};
8515: foreach my $option ('imagesuppress','appletsuppress',
8516: 'embedsuppress','fontenhance','blackwhite') {
8517: if (($form->{$option} eq 'true') ||
8518: ($userenv{$option} eq 'on')) {
8519: $initial_env{"browser.$option"} = "on";
8520: }
8521: }
8522: }
8523:
8524: $env{'user.environment'} = "$lonids/$cookie.id";
8525:
8526: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
8527: &GDBM_WRCREAT(),0640)) {
8528: &_add_to_env(\%disk_env,\%initial_env);
8529: &_add_to_env(\%disk_env,\%userenv,'environment.');
8530: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 8531: if (ref($args->{'extra_env'})) {
8532: &_add_to_env(\%disk_env,$args->{'extra_env'});
8533: }
1.462 albertel 8534: untie(%disk_env);
8535: } else {
8536: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
8537: 'Could not create environment storage in lonauth: '.$!.'</font>');
8538: return 'error: '.$!;
8539: }
8540: }
8541: $env{'request.role'}='cm';
8542: $env{'request.role.adv'}=$env{'user.adv'};
8543: $env{'browser.type'}=$clientbrowser;
8544:
8545: return $cookie;
8546:
8547: }
8548:
8549: sub _add_to_env {
8550: my ($idf,$env_data,$prefix) = @_;
8551: while (my ($key,$value) = each(%$env_data)) {
8552: $idf->{$prefix.$key} = $value;
8553: $env{$prefix.$key} = $value;
8554: }
8555: }
8556:
8557:
1.41 ng 8558: =pod
8559:
8560: =back
8561:
1.112 bowersj2 8562: =cut
1.41 ng 8563:
1.112 bowersj2 8564: 1;
8565: __END__;
1.41 ng 8566:
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