Annotation of loncom/interface/loncommon.pm, revision 1.634
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.634 ! www 4: # $Id: loncommon.pm,v 1.633 2008/01/06 04:38:57 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);
1.632 raeburn 3673: my (%designhash,%legacy);
1.518 albertel 3674: if (keys(%domconfig) > 0) {
3675: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3676: if (keys(%{$domconfig{'login'}})) {
3677: foreach my $key (keys(%{$domconfig{'login'}})) {
3678: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3679: }
3680: } else {
3681: $legacy{'login'} = 1;
1.518 albertel 3682: }
1.632 raeburn 3683: } else {
3684: $legacy{'login'} = 1;
1.518 albertel 3685: }
3686: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3687: if (keys(%{$domconfig{'rolecolors'}})) {
3688: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3689: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3690: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3691: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3692: }
1.518 albertel 3693: }
3694: }
1.632 raeburn 3695: } else {
3696: $legacy{'rolecolors'} = 1;
1.518 albertel 3697: }
1.632 raeburn 3698: } else {
3699: $legacy{'rolecolors'} = 1;
1.518 albertel 3700: }
1.632 raeburn 3701: if (keys(%legacy) > 0) {
3702: my %legacyhash = &get_legacy_domconf($udom);
3703: foreach my $item (keys(%legacyhash)) {
3704: if ($item =~ /^\Q$udom\E\.login/) {
3705: if ($legacy{'login'}) {
3706: $designhash{$item} = $legacyhash{$item};
3707: }
3708: } else {
3709: if ($legacy{'rolecolors'}) {
3710: $designhash{$item} = $legacyhash{$item};
3711: }
1.518 albertel 3712: }
3713: }
3714: }
1.632 raeburn 3715: } else {
3716: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3717: }
3718: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3719: $cachetime);
3720: return %designhash;
3721: }
3722:
1.632 raeburn 3723: sub get_legacy_domconf {
3724: my ($udom) = @_;
3725: my %legacyhash;
3726: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3727: my $designfile = $designdir.'/'.$udom.'.tab';
3728: if (-e $designfile) {
3729: if ( open (my $fh,"<$designfile") ) {
3730: while (my $line = <$fh>) {
3731: next if ($line =~ /^\#/);
3732: chomp($line);
3733: my ($key,$val)=(split(/\=/,$line));
3734: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3735: }
3736: close($fh);
3737: }
3738: }
3739: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3740: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3741: }
3742: return %legacyhash;
3743: }
3744:
1.63 www 3745: =pod
3746:
1.112 bowersj2 3747: =item * &domainlogo()
1.63 www 3748:
3749: Inputs: $domain (usually will be undef)
3750:
3751: Returns: A link to a domain logo, if the domain logo exists.
3752: If the domain logo does not exist, a description of the domain.
3753:
3754: =cut
1.112 bowersj2 3755:
1.63 www 3756: ###############################################
3757: sub domainlogo {
1.517 raeburn 3758: my $domain = &determinedomain(shift);
1.518 albertel 3759: my %designhash = &get_domainconf($domain);
1.517 raeburn 3760: # See if there is a logo
3761: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3762: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3763: if ($imgsrc =~ m{^/(adm|res)/}) {
3764: if ($imgsrc =~ m{^/res/}) {
3765: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3766: &Apache::lonnet::repcopy($local_name);
3767: }
3768: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3769: }
3770: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3771: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3772: return &Apache::lonnet::domain($domain,'description');
1.59 www 3773: } else {
1.60 matthew 3774: return '';
1.59 www 3775: }
3776: }
1.63 www 3777: ##############################################
3778:
3779: =pod
3780:
1.112 bowersj2 3781: =item * &designparm()
1.63 www 3782:
3783: Inputs: $which parameter; $domain (usually will be undef)
3784:
3785: Returns: value of designparamter $which
3786:
3787: =cut
1.112 bowersj2 3788:
1.397 albertel 3789:
1.400 albertel 3790: ##############################################
1.397 albertel 3791: sub designparm {
3792: my ($which,$domain)=@_;
1.258 albertel 3793: if ($env{'browser.blackwhite'} eq 'on') {
1.110 www 3794: if ($which=~/\.(font|alink|vlink|link)$/) {
3795: return '#000000';
3796: }
3797: if ($which=~/\.(pgbg|sidebg)$/) {
3798: return '#FFFFFF';
3799: }
3800: if ($which=~/\.tabbg$/) {
3801: return '#CCCCCC';
3802: }
3803: }
1.397 albertel 3804: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 3805: return $env{'environment.color.'.$which};
1.96 www 3806: }
1.63 www 3807: $domain=&determinedomain($domain);
1.518 albertel 3808: my %domdesign = &get_domainconf($domain);
1.520 raeburn 3809: my $output;
1.517 raeburn 3810: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 3811: $output = $domdesign{$domain.'.'.$which};
1.63 www 3812: } else {
1.520 raeburn 3813: $output = $defaultdesign{$which};
3814: }
3815: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
3816: ($which =~ /login\.(img|logo|domlogo)/)) {
1.538 albertel 3817: if ($output =~ m{^/(adm|res)/}) {
3818: if ($output =~ m{^/res/}) {
3819: my $local_name = &Apache::lonnet::filelocation('',$output);
3820: &Apache::lonnet::repcopy($local_name);
3821: }
1.520 raeburn 3822: $output = &lonhttpdurl($output);
3823: }
1.63 www 3824: }
1.520 raeburn 3825: return $output;
1.63 www 3826: }
1.59 www 3827:
1.60 matthew 3828: ###############################################
3829: ###############################################
3830:
3831: =pod
3832:
1.112 bowersj2 3833: =back
3834:
1.549 albertel 3835: =head1 HTML Helpers
1.112 bowersj2 3836:
3837: =over 4
3838:
3839: =item * &bodytag()
1.60 matthew 3840:
3841: Returns a uniform header for LON-CAPA web pages.
3842:
3843: Inputs:
3844:
1.112 bowersj2 3845: =over 4
3846:
3847: =item * $title, A title to be displayed on the page.
3848:
3849: =item * $function, the current role (can be undef).
3850:
3851: =item * $addentries, extra parameters for the <body> tag.
3852:
3853: =item * $bodyonly, if defined, only return the <body> tag.
3854:
3855: =item * $domain, if defined, force a given domain.
3856:
3857: =item * $forcereg, if page should register as content page (relevant for
1.86 www 3858: text interface only)
1.60 matthew 3859:
1.326 albertel 3860: =item * $customtitle, alternate text to use instead of $title
3861: in the title box that appears, this text
3862: is not auto translated like the $title is
1.309 albertel 3863:
3864: =item * $notopbar, if true, keep the 'what is this' info but remove the
3865: navigational links
1.317 albertel 3866:
1.338 albertel 3867: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
3868:
3869: =item * $notitle, if true keep the nav controls, but remove the title bar
3870:
1.361 albertel 3871: =item * $no_inline_link, if true and in remote mode, don't show the
3872: 'Switch To Inline Menu' link
3873:
1.460 albertel 3874: =item * $args, optional argument valid values are
3875: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 3876: inherit_jsmath -> when creating popup window in a page,
3877: should it have jsmath forced on by the
3878: current page
1.460 albertel 3879:
1.112 bowersj2 3880: =back
3881:
1.60 matthew 3882: Returns: A uniform header for LON-CAPA web pages.
3883: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
3884: If $bodyonly is undef or zero, an html string containing a <body> tag and
3885: other decorations will be returned.
3886:
3887: =cut
3888:
1.54 www 3889: sub bodytag {
1.309 albertel 3890: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 3891: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 3892:
1.460 albertel 3893: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 3894:
1.183 matthew 3895: $function = &get_users_function() if (!$function);
1.339 albertel 3896: my $img = &designparm($function.'.img',$domain);
3897: my $font = &designparm($function.'.font',$domain);
3898: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
3899:
3900: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 3901: 'bgcolor' => $pgbg,
1.339 albertel 3902: 'text' => $font,
3903: 'alink' => &designparm($function.'.alink',$domain),
3904: 'vlink' => &designparm($function.'.vlink',$domain),
3905: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 3906: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 3907:
1.63 www 3908: # role and realm
1.378 raeburn 3909: my ($role,$realm) = split(/\./,$env{'request.role'},2);
3910: if ($role eq 'ca') {
1.479 albertel 3911: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 3912: $realm = &plainname($rname,$rdom);
1.378 raeburn 3913: }
1.55 www 3914: # realm
1.258 albertel 3915: if ($env{'request.course.id'}) {
1.378 raeburn 3916: if ($env{'request.role'} !~ /^cr/) {
3917: $role = &Apache::lonnet::plaintext($role,&course_type());
3918: }
1.359 albertel 3919: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 3920: } else {
3921: $role = &Apache::lonnet::plaintext($role);
1.54 www 3922: }
1.433 albertel 3923:
1.359 albertel 3924: if (!$realm) { $realm=' '; }
1.55 www 3925: # Set messages
1.60 matthew 3926: my $messages=&domainlogo($domain);
1.330 albertel 3927:
1.438 albertel 3928: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 3929:
1.101 www 3930: # construct main body tag
1.359 albertel 3931: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 3932: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 3933:
1.530 albertel 3934: if ($bodyonly) {
1.60 matthew 3935: return $bodytag;
1.258 albertel 3936: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 3937: # Accessibility
1.224 raeburn 3938:
1.337 albertel 3939: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 3940: if (!$notitle) {
1.337 albertel 3941: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
3942: }
3943: return $bodytag;
1.359 albertel 3944: }
3945:
1.410 albertel 3946: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 3947: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
3948: undef($role);
1.434 albertel 3949: } else {
3950: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 3951: }
1.359 albertel 3952:
3953: my $roleinfo=(<<ENDROLE);
3954: <td class="LC_title_bar_who">
3955: <div class="LC_title_bar_name">
1.410 albertel 3956: $name
1.361 albertel 3957:
1.359 albertel 3958: </div>
3959: <div class="LC_title_bar_role">
1.361 albertel 3960: $role
1.359 albertel 3961: </div>
3962: <div class="LC_title_bar_realm">
1.361 albertel 3963: $realm
1.359 albertel 3964: </div>
1.206 albertel 3965: </td>
3966: ENDROLE
1.235 raeburn 3967:
1.359 albertel 3968: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
3969: if ($customtitle) {
3970: $titleinfo = $customtitle;
3971: }
3972: #
3973: # Extra info if you are the DC
3974: my $dc_info = '';
3975: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
3976: $env{'course.'.$env{'request.course.id'}.
3977: '.domain'}.'/'})) {
3978: my $cid = $env{'request.course.id'};
3979: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 3980: $dc_info =~ s/\s+$//;
1.359 albertel 3981: $dc_info = '('.$dc_info.')';
3982: }
3983:
3984: if ($env{'environment.remote'} eq 'off') {
3985: # No Remote
1.258 albertel 3986: if ($env{'request.state'} eq 'construct') {
1.359 albertel 3987: $forcereg=1;
3988: }
3989:
3990: if (!$customtitle && $env{'request.state'} eq 'construct') {
3991: # this is for resources; directories have customtitle, and crumbs
3992: # and select recent are created in lonpubdir.pm
1.229 albertel 3993: my ($uname,$thisdisfn)=
1.258 albertel 3994: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 3995: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
3996: $formaction=~s/\/+/\//g;
3997:
1.359 albertel 3998: my $parentpath = '';
3999: my $lastitem = '';
4000: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4001: $parentpath = $1;
4002: $lastitem = $2;
4003: } else {
4004: $lastitem = $thisdisfn;
4005: }
4006: $titleinfo =
1.401 albertel 4007: &Apache::loncommon::help_open_menu('','',3,'Authoring').
1.359 albertel 4008: '<b>Construction Space</b>: '.
4009: '<form name="dirs" method="post" action="'.$formaction
4010: .'" target="_top"><tt><b>'
4011: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
4012: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4013: .'</form>'
4014: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4015: }
1.359 albertel 4016:
1.337 albertel 4017: my $titletable;
1.338 albertel 4018: if (!$notitle) {
1.337 albertel 4019: $titletable =
1.359 albertel 4020: '<table id="LC_title_bar">'.
4021: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4022: '</tr></table>';
1.337 albertel 4023: }
1.359 albertel 4024: if ($notopbar) {
4025: $bodytag .= $titletable;
4026: } else {
4027: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4028: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4029: $titletable);
1.272 raeburn 4030: } else {
1.336 albertel 4031: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4032: $titletable;
1.272 raeburn 4033: }
1.235 raeburn 4034: }
4035: return $bodytag;
1.94 www 4036: }
1.95 www 4037:
1.93 www 4038: #
1.95 www 4039: # Top frame rendering, Remote is up
1.93 www 4040: #
1.359 albertel 4041:
1.517 raeburn 4042: my $imgsrc = $img;
4043: if ($img =~ /^\/adm/) {
1.575 albertel 4044: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4045: }
4046: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4047:
1.305 www 4048: # Explicit link to get inline menu
1.361 albertel 4049: my $menu= ($no_inline_link?''
4050: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4051: #
1.338 albertel 4052: if ($notitle) {
1.337 albertel 4053: return $bodytag;
4054: }
1.94 www 4055: return(<<ENDBODY);
1.60 matthew 4056: $bodytag
1.359 albertel 4057: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4058: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4059: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4060: </tr>
1.359 albertel 4061: <tr><td>$titleinfo $dc_info $menu</td>
4062: $roleinfo
1.368 albertel 4063: </tr>
1.356 albertel 4064: </table>
1.54 www 4065: ENDBODY
1.182 matthew 4066: }
4067:
1.330 albertel 4068: sub make_attr_string {
4069: my ($register,$attr_ref) = @_;
4070:
4071: if ($attr_ref && !ref($attr_ref)) {
4072: die("addentries Must be a hash ref ".
4073: join(':',caller(1))." ".
4074: join(':',caller(0))." ");
4075: }
4076:
4077: if ($register) {
1.339 albertel 4078: my ($on_load,$on_unload);
4079: foreach my $key (keys(%{$attr_ref})) {
4080: if (lc($key) eq 'onload') {
4081: $on_load.=$attr_ref->{$key}.';';
4082: delete($attr_ref->{$key});
4083:
4084: } elsif (lc($key) eq 'onunload') {
4085: $on_unload.=$attr_ref->{$key}.';';
4086: delete($attr_ref->{$key});
4087: }
4088: }
4089: $attr_ref->{'onload'} =
4090: &Apache::lonmenu::loadevents(). $on_load;
4091: $attr_ref->{'onunload'}=
4092: &Apache::lonmenu::unloadevents().$on_unload;
4093: }
4094:
4095: # Accessibility font enhance
4096: if ($env{'browser.fontenhance'} eq 'on') {
4097: my $style;
4098: foreach my $key (keys(%{$attr_ref})) {
4099: if (lc($key) eq 'style') {
4100: $style.=$attr_ref->{$key}.';';
4101: delete($attr_ref->{$key});
4102: }
4103: }
4104: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4105: }
1.339 albertel 4106:
4107: if ($env{'browser.blackwhite'} eq 'on') {
4108: delete($attr_ref->{'font'});
4109: delete($attr_ref->{'link'});
4110: delete($attr_ref->{'alink'});
4111: delete($attr_ref->{'vlink'});
4112: delete($attr_ref->{'bgcolor'});
4113: delete($attr_ref->{'background'});
4114: }
4115:
1.330 albertel 4116: my $attr_string;
4117: foreach my $attr (keys(%$attr_ref)) {
4118: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4119: }
4120: return $attr_string;
4121: }
4122:
4123:
1.182 matthew 4124: ###############################################
1.251 albertel 4125: ###############################################
4126:
4127: =pod
4128:
4129: =item * &endbodytag()
4130:
4131: Returns a uniform footer for LON-CAPA web pages.
4132:
1.306 albertel 4133: Inputs: none
1.251 albertel 4134:
4135: =cut
4136:
4137: sub endbodytag {
4138: my $endbodytag='</body>';
1.269 albertel 4139: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4140: if ( exists( $env{'internal.head.redirect'} ) ) {
4141: $endbodytag=
4142: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4143: &mt('Continue').'</a>'.
4144: $endbodytag;
4145: }
1.251 albertel 4146: return $endbodytag;
4147: }
4148:
1.352 albertel 4149: =pod
4150:
4151: =item * &standard_css()
4152:
4153: Returns a style sheet
4154:
4155: Inputs: (all optional)
4156: domain -> force to color decorate a page for a specific
4157: domain
4158: function -> force usage of a specific rolish color scheme
4159: bgcolor -> override the default page bgcolor
4160:
4161: =cut
4162:
1.343 albertel 4163: sub standard_css {
1.345 albertel 4164: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4165: $function = &get_users_function() if (!$function);
4166: my $img = &designparm($function.'.img', $domain);
4167: my $tabbg = &designparm($function.'.tabbg', $domain);
4168: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4169: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4170: my $pgbg_or_bgcolor =
4171: $bgcolor ||
1.352 albertel 4172: &designparm($function.'.pgbg', $domain);
1.382 albertel 4173: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4174: my $alink = &designparm($function.'.alink', $domain);
4175: my $vlink = &designparm($function.'.vlink', $domain);
4176: my $link = &designparm($function.'.link', $domain);
4177:
1.602 albertel 4178: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4179: my $mono = 'monospace';
1.352 albertel 4180: my $data_table_head = $tabbg;
4181: my $data_table_light = '#EEEEEE';
1.470 banghart 4182: my $data_table_dark = '#DDDDDD';
4183: my $data_table_darker = '#CCCCCC';
1.349 albertel 4184: my $data_table_highlight = '#FFFF00';
1.352 albertel 4185: my $mail_new = '#FFBB77';
4186: my $mail_new_hover = '#DD9955';
4187: my $mail_read = '#BBBB77';
4188: my $mail_read_hover = '#999944';
4189: my $mail_replied = '#AAAA88';
4190: my $mail_replied_hover = '#888855';
4191: my $mail_other = '#99BBBB';
4192: my $mail_other_hover = '#669999';
1.391 albertel 4193: my $table_header = '#DDDDDD';
1.489 raeburn 4194: my $feedback_link_bg = '#BBBBBB';
1.392 albertel 4195:
1.608 albertel 4196: my $border = ($env{'browser.type'} eq 'explorer' ||
4197: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4198: : '0px 3px 0px 4px';
1.448 albertel 4199:
1.523 albertel 4200:
1.343 albertel 4201: return <<END;
1.345 albertel 4202: h1, h2, h3, th { font-family: $sans }
1.343 albertel 4203: a:focus { color: red; background: yellow }
1.510 albertel 4204: table.thinborder,
1.523 albertel 4205:
1.510 albertel 4206: table.thinborder tr th {
4207: border-style: solid;
4208: border-width: 1px;
4209: background: $tabbg;
4210: }
1.523 albertel 4211: table.thinborder tr td {
1.510 albertel 4212: border-style: solid;
4213: border-width: 1px
4214: }
1.426 albertel 4215:
1.343 albertel 4216: form, .inline { display: inline; }
4217: .center { text-align: center; }
1.593 albertel 4218: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4219: .LC_error {
4220: color: red;
4221: font-size: larger;
4222: }
1.457 albertel 4223: .LC_warning,
4224: .LC_diff_removed {
1.394 albertel 4225: color: red;
4226: }
1.532 albertel 4227:
4228: .LC_info,
1.457 albertel 4229: .LC_success,
4230: .LC_diff_added {
1.350 albertel 4231: color: green;
4232: }
1.543 albertel 4233: .LC_unknown {
4234: color: yellow;
4235: }
4236:
1.440 albertel 4237: .LC_icon {
4238: border: 0px;
4239: }
1.539 albertel 4240: .LC_indexer_icon {
4241: border: 0px;
4242: height: 22px;
4243: }
1.543 albertel 4244: .LC_docs_spacer {
4245: width: 25px;
4246: height: 1px;
4247: border: 0px;
4248: }
1.346 albertel 4249:
1.532 albertel 4250: .LC_internal_info {
4251: color: #999;
4252: }
4253:
1.458 albertel 4254: table.LC_pastsubmission {
4255: border: 1px solid black;
4256: margin: 2px;
4257: }
4258:
1.606 albertel 4259: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4260: width: 100%;
4261: background: $pgbg;
1.392 albertel 4262: border: 2px;
1.402 albertel 4263: border-collapse: separate;
1.403 albertel 4264: padding: 0px;
1.345 albertel 4265: }
1.392 albertel 4266:
1.606 albertel 4267: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4268: table#LC_title_bar.LC_with_remote {
1.359 albertel 4269: width: 100%;
1.392 albertel 4270: border-color: $pgbg;
4271: border-style: solid;
4272: border-width: $border;
4273:
1.379 albertel 4274: background: $pgbg;
4275: font-family: $sans;
1.392 albertel 4276: border-collapse: collapse;
1.403 albertel 4277: padding: 0px;
1.359 albertel 4278: }
1.392 albertel 4279:
1.409 albertel 4280: table.LC_docs_path {
4281: width: 100%;
4282: border: 0;
4283: background: $pgbg;
4284: font-family: $sans;
4285: border-collapse: collapse;
4286: padding: 0px;
4287: }
4288:
1.359 albertel 4289: table#LC_title_bar td {
4290: background: $tabbg;
4291: }
4292: table#LC_title_bar td.LC_title_bar_who {
4293: background: $tabbg;
4294: color: $font;
1.427 albertel 4295: font: small $sans;
1.359 albertel 4296: text-align: right;
4297: }
1.469 banghart 4298: span.LC_metadata {
4299: font-family: $sans;
4300: }
1.359 albertel 4301: span.LC_title_bar_title {
1.416 albertel 4302: font: bold x-large $sans;
1.359 albertel 4303: }
4304: table#LC_title_bar td.LC_title_bar_domain_logo {
4305: background: $sidebg;
4306: text-align: right;
1.368 albertel 4307: padding: 0px;
4308: }
4309: table#LC_title_bar td.LC_title_bar_role_logo {
4310: background: $sidebg;
4311: padding: 0px;
1.359 albertel 4312: }
4313:
1.346 albertel 4314: table#LC_menubuttons_mainmenu {
1.526 www 4315: width: 100%;
1.346 albertel 4316: border: 0px;
4317: border-spacing: 1px;
1.372 albertel 4318: padding: 0px 1px;
1.346 albertel 4319: margin: 0px;
4320: border-collapse: separate;
4321: }
4322: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
4323: border: 0px;
4324: }
1.345 albertel 4325: table#LC_top_nav td {
4326: background: $tabbg;
1.392 albertel 4327: border: 0px;
1.407 albertel 4328: font-size: small;
1.345 albertel 4329: }
4330: table#LC_top_nav td a, div#LC_top_nav a {
4331: color: $font;
4332: font-family: $sans;
4333: }
1.364 albertel 4334: table#LC_top_nav td.LC_top_nav_logo {
4335: background: $tabbg;
1.432 albertel 4336: text-align: left;
1.408 albertel 4337: white-space: nowrap;
1.432 albertel 4338: width: 31px;
1.408 albertel 4339: }
4340: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4341: border: 0px;
1.408 albertel 4342: vertical-align: bottom;
1.364 albertel 4343: }
1.432 albertel 4344: table#LC_top_nav td.LC_top_nav_exit,
4345: table#LC_top_nav td.LC_top_nav_help {
4346: width: 2.0em;
4347: }
1.442 albertel 4348: table#LC_top_nav td.LC_top_nav_login {
4349: width: 4.0em;
4350: text-align: center;
4351: }
1.409 albertel 4352: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4353: background: $tabbg;
4354: color: $font;
4355: font-family: $sans;
1.358 albertel 4356: font-size: smaller;
1.357 albertel 4357: }
1.411 albertel 4358: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4359: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4360: background: $tabbg;
4361: color: $font;
4362: font-family: $sans;
4363: font-size: larger;
4364: text-align: right;
4365: }
1.383 albertel 4366: td.LC_table_cell_checkbox {
4367: text-align: center;
4368: }
4369:
1.522 albertel 4370: table#LC_mainmenu td.LC_mainmenu_column {
4371: vertical-align: top;
4372: }
4373:
1.346 albertel 4374: .LC_menubuttons_inline_text {
4375: color: $font;
4376: font-family: $sans;
4377: font-size: smaller;
4378: }
4379:
1.526 www 4380: .LC_menubuttons_link {
4381: text-decoration: none;
4382: }
4383:
1.522 albertel 4384: .LC_menubuttons_category {
1.521 www 4385: color: $font;
1.526 www 4386: background: $pgbg;
1.521 www 4387: font-family: $sans;
4388: font-size: larger;
4389: font-weight: bold;
4390: }
4391:
1.346 albertel 4392: td.LC_menubuttons_text {
1.526 www 4393: width: 90%;
1.346 albertel 4394: color: $font;
4395: font-family: $sans;
4396: }
1.526 www 4397:
1.346 albertel 4398: td.LC_menubuttons_img {
4399: }
1.526 www 4400:
1.346 albertel 4401: .LC_current_location {
4402: font-family: $sans;
4403: background: $tabbg;
4404: }
4405: .LC_new_mail {
4406: font-family: $sans;
1.634 ! www 4407: background: $tabbg;
1.346 albertel 4408: font-weight: bold;
4409: }
1.347 albertel 4410:
1.526 www 4411: .LC_rolesmenu_is {
4412: font-family: $sans;
4413: }
4414:
4415: .LC_rolesmenu_selected {
4416: font-family: $sans;
4417: }
4418:
4419: .LC_rolesmenu_future {
4420: font-family: $sans;
4421: }
4422:
4423:
4424: .LC_rolesmenu_will {
4425: font-family: $sans;
4426: }
4427:
4428: .LC_rolesmenu_will_not {
4429: font-family: $sans;
4430: }
4431:
4432: .LC_rolesmenu_expired {
4433: font-family: $sans;
4434: }
4435:
4436: .LC_rolesinfo {
4437: font-family: $sans;
4438: }
4439:
1.527 www 4440: .LC_dropadd_labeltext {
4441: font-family: $sans;
4442: text-align: right;
4443: }
4444:
4445: .LC_preferences_labeltext {
4446: font-family: $sans;
4447: text-align: right;
4448: }
4449:
1.440 albertel 4450: table.LC_aboutme_port {
4451: border: 0px;
4452: border-collapse: collapse;
4453: border-spacing: 0px;
4454: }
1.349 albertel 4455: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4456: border: 1px solid #000000;
1.402 albertel 4457: border-collapse: separate;
1.426 albertel 4458: border-spacing: 1px;
1.610 albertel 4459: background: $pgbg;
1.347 albertel 4460: }
1.422 albertel 4461: .LC_data_table_dense {
4462: font-size: small;
4463: }
1.507 raeburn 4464: table.LC_nested_outer {
4465: border: 1px solid #000000;
1.589 raeburn 4466: border-collapse: collapse;
1.507 raeburn 4467: border-spacing: 0px;
4468: width: 100%;
4469: }
4470: table.LC_nested {
4471: border: 0px;
1.589 raeburn 4472: border-collapse: collapse;
1.507 raeburn 4473: border-spacing: 0px;
4474: width: 100%;
4475: }
1.523 albertel 4476: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4477: table.LC_prior_tries tr th {
1.349 albertel 4478: font-weight: bold;
4479: background-color: $data_table_head;
1.421 albertel 4480: font-size: smaller;
1.347 albertel 4481: }
1.610 albertel 4482: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4483: table.LC_aboutme_port tr td {
1.349 albertel 4484: background-color: $data_table_light;
1.425 albertel 4485: padding: 2px;
1.347 albertel 4486: }
1.610 albertel 4487: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4488: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4489: background-color: $data_table_dark;
1.347 albertel 4490: }
1.425 albertel 4491: table.LC_data_table tr.LC_data_table_highlight td {
4492: background-color: $data_table_darker;
4493: }
1.451 albertel 4494: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4495: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4496: background-color: #FFFFFF;
1.421 albertel 4497: font-weight: bold;
4498: font-style: italic;
4499: text-align: center;
4500: padding: 8px;
1.347 albertel 4501: }
1.507 raeburn 4502: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4503: padding: 4ex
4504: }
1.507 raeburn 4505: table.LC_nested_outer tr th {
4506: font-weight: bold;
4507: background-color: $data_table_head;
4508: font-size: smaller;
4509: border-bottom: 1px solid #000000;
4510: }
4511: table.LC_nested_outer tr td.LC_subheader {
4512: background-color: $data_table_head;
4513: font-weight: bold;
4514: font-size: small;
4515: border-bottom: 1px solid #000000;
4516: text-align: right;
1.451 albertel 4517: }
1.507 raeburn 4518: table.LC_nested tr.LC_info_row td {
1.451 albertel 4519: background-color: #CCC;
4520: font-weight: bold;
4521: font-size: small;
1.507 raeburn 4522: text-align: center;
4523: }
1.589 raeburn 4524: table.LC_nested tr.LC_info_row td.LC_left_item,
4525: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4526: text-align: left;
1.451 albertel 4527: }
1.507 raeburn 4528: table.LC_nested td {
1.451 albertel 4529: background-color: #FFF;
4530: font-size: small;
1.507 raeburn 4531: }
4532: table.LC_nested_outer tr th.LC_right_item,
4533: table.LC_nested tr.LC_info_row td.LC_right_item,
4534: table.LC_nested tr.LC_odd_row td.LC_right_item,
4535: table.LC_nested tr td.LC_right_item {
1.451 albertel 4536: text-align: right;
4537: }
4538:
1.507 raeburn 4539: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4540: background-color: #EEE;
4541: }
4542:
1.473 raeburn 4543: table.LC_createuser {
4544: }
4545:
4546: table.LC_createuser tr.LC_section_row td {
4547: font-size: smaller;
4548: }
4549:
4550: table.LC_createuser tr.LC_info_row td {
4551: background-color: #CCC;
4552: font-weight: bold;
4553: text-align: center;
4554: }
4555:
1.349 albertel 4556: table.LC_calendar {
4557: border: 1px solid #000000;
4558: border-collapse: collapse;
4559: }
4560: table.LC_calendar_pickdate {
4561: font-size: xx-small;
4562: }
4563: table.LC_calendar tr td {
4564: border: 1px solid #000000;
4565: vertical-align: top;
4566: }
4567: table.LC_calendar tr td.LC_calendar_day_empty {
4568: background-color: $data_table_dark;
4569: }
4570: table.LC_calendar tr td.LC_calendar_day_current {
4571: background-color: $data_table_highlight;
4572: }
4573:
4574: table.LC_mail_list tr.LC_mail_new {
4575: background-color: $mail_new;
4576: }
4577: table.LC_mail_list tr.LC_mail_new:hover {
4578: background-color: $mail_new_hover;
4579: }
4580: table.LC_mail_list tr.LC_mail_read {
4581: background-color: $mail_read;
4582: }
4583: table.LC_mail_list tr.LC_mail_read:hover {
4584: background-color: $mail_read_hover;
4585: }
4586: table.LC_mail_list tr.LC_mail_replied {
4587: background-color: $mail_replied;
4588: }
4589: table.LC_mail_list tr.LC_mail_replied:hover {
4590: background-color: $mail_replied_hover;
4591: }
4592: table.LC_mail_list tr.LC_mail_other {
4593: background-color: $mail_other;
4594: }
4595: table.LC_mail_list tr.LC_mail_other:hover {
4596: background-color: $mail_other_hover;
4597: }
1.494 raeburn 4598: table.LC_mail_list tr.LC_mail_even {
4599: }
4600: table.LC_mail_list tr.LC_mail_odd {
4601: }
4602:
1.385 albertel 4603:
1.386 albertel 4604: table#LC_portfolio_actions {
4605: width: auto;
4606: background: $pgbg;
4607: border: 0px;
4608: border-spacing: 2px 2px;
4609: padding: 0px;
4610: margin: 0px;
4611: border-collapse: separate;
4612: }
4613: table#LC_portfolio_actions td.LC_label {
4614: background: $tabbg;
4615: text-align: right;
4616: }
4617: table#LC_portfolio_actions td.LC_value {
4618: background: $tabbg;
4619: }
1.385 albertel 4620:
1.391 albertel 4621: table#LC_cstr_controls {
4622: width: 100%;
4623: border-collapse: collapse;
4624: }
4625: table#LC_cstr_controls tr td {
4626: border: 4px solid $pgbg;
4627: padding: 4px;
4628: text-align: center;
4629: background: $tabbg;
4630: }
4631: table#LC_cstr_controls tr th {
4632: border: 4px solid $pgbg;
4633: background: $table_header;
4634: text-align: center;
4635: font-family: $sans;
4636: font-size: smaller;
4637: }
4638:
1.389 albertel 4639: table#LC_browser {
4640:
4641: }
4642: table#LC_browser tr th {
1.391 albertel 4643: background: $table_header;
1.389 albertel 4644: }
1.390 albertel 4645: table#LC_browser tr td {
4646: padding: 2px;
4647: }
1.389 albertel 4648: table#LC_browser tr.LC_browser_file,
4649: table#LC_browser tr.LC_browser_file_published {
4650: background: #CCFF88;
4651: }
4652: table#LC_browser tr.LC_browser_file_locked,
4653: table#LC_browser tr.LC_browser_file_unpublished {
4654: background: #FFAA99;
1.387 albertel 4655: }
1.389 albertel 4656: table#LC_browser tr.LC_browser_file_obsolete {
4657: background: #AAAAAA;
1.387 albertel 4658: }
1.455 albertel 4659: table#LC_browser tr.LC_browser_file_modified,
4660: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 4661: background: #FFFF77;
1.387 albertel 4662: }
1.389 albertel 4663: table#LC_browser tr.LC_browser_folder {
4664: background: #CCCCFF;
1.387 albertel 4665: }
1.388 albertel 4666: span.LC_current_location {
4667: font-size: x-large;
4668: background: $pgbg;
4669: }
1.387 albertel 4670:
1.395 albertel 4671: span.LC_parm_menu_item {
4672: font-size: larger;
4673: font-family: $sans;
4674: }
4675: span.LC_parm_scope_all {
4676: color: red;
4677: }
4678: span.LC_parm_scope_folder {
4679: color: green;
4680: }
4681: span.LC_parm_scope_resource {
4682: color: orange;
4683: }
4684: span.LC_parm_part {
4685: color: blue;
4686: }
4687: span.LC_parm_folder, span.LC_parm_symb {
4688: font-size: x-small;
4689: font-family: $mono;
4690: color: #AAAAAA;
4691: }
4692:
1.396 albertel 4693: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4694: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4695: border: 1px solid black;
4696: border-collapse: collapse;
4697: }
4698: table.LC_parm_overview_restrictions td {
4699: border-width: 1px 4px 1px 4px;
4700: border-style: solid;
4701: border-color: $pgbg;
4702: text-align: center;
4703: }
4704: table.LC_parm_overview_restrictions th {
4705: background: $tabbg;
4706: border-width: 1px 4px 1px 4px;
4707: border-style: solid;
4708: border-color: $pgbg;
4709: }
1.398 albertel 4710: table#LC_helpmenu {
4711: border: 0px;
4712: height: 55px;
4713: border-spacing: 0px;
4714: }
4715:
4716: table#LC_helpmenu fieldset legend {
4717: font-size: larger;
4718: font-weight: bold;
4719: }
1.397 albertel 4720: table#LC_helpmenu_links {
4721: width: 100%;
4722: border: 1px solid black;
4723: background: $pgbg;
4724: padding: 0px;
4725: border-spacing: 1px;
4726: }
4727: table#LC_helpmenu_links tr td {
4728: padding: 1px;
4729: background: $tabbg;
1.399 albertel 4730: text-align: center;
4731: font-weight: bold;
1.397 albertel 4732: }
1.396 albertel 4733:
1.397 albertel 4734: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4735: table#LC_helpmenu_links a:active {
4736: text-decoration: none;
4737: color: $font;
4738: }
4739: table#LC_helpmenu_links a:hover {
4740: text-decoration: underline;
4741: color: $vlink;
4742: }
1.396 albertel 4743:
1.417 albertel 4744: .LC_chrt_popup_exists {
4745: border: 1px solid #339933;
4746: margin: -1px;
4747: }
4748: .LC_chrt_popup_up {
4749: border: 1px solid yellow;
4750: margin: -1px;
4751: }
4752: .LC_chrt_popup {
4753: border: 1px solid #8888FF;
4754: background: #CCCCFF;
4755: }
1.421 albertel 4756: table.LC_pick_box {
4757: border-collapse: separate;
4758: background: white;
4759: border: 1px solid black;
4760: border-spacing: 1px;
4761: }
4762: table.LC_pick_box td.LC_pick_box_title {
4763: background: $tabbg;
4764: font-weight: bold;
4765: text-align: right;
4766: width: 184px;
4767: padding: 8px;
4768: }
1.579 raeburn 4769: table.LC_pick_box td.LC_pick_box_value {
4770: text-align: left;
4771: padding: 8px;
4772: }
4773: table.LC_pick_box td.LC_pick_box_select {
4774: text-align: left;
4775: padding: 8px;
4776: }
1.424 albertel 4777: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 4778: padding: 0px;
4779: height: 1px;
4780: background: black;
4781: }
4782: table.LC_pick_box td.LC_pick_box_submit {
4783: text-align: right;
4784: }
1.579 raeburn 4785: table.LC_pick_box td.LC_evenrow_value {
4786: text-align: left;
4787: padding: 8px;
4788: background-color: $data_table_light;
4789: }
4790: table.LC_pick_box td.LC_oddrow_value {
4791: text-align: left;
4792: padding: 8px;
4793: background-color: $data_table_light;
4794: }
4795: table.LC_helpform_receipt {
4796: width: 620px;
4797: border-collapse: separate;
4798: background: white;
4799: border: 1px solid black;
4800: border-spacing: 1px;
4801: }
4802: table.LC_helpform_receipt td.LC_pick_box_title {
4803: background: $tabbg;
4804: font-weight: bold;
4805: text-align: right;
4806: width: 184px;
4807: padding: 8px;
4808: }
4809: table.LC_helpform_receipt td.LC_evenrow_value {
4810: text-align: left;
4811: padding: 8px;
4812: background-color: $data_table_light;
4813: }
4814: table.LC_helpform_receipt td.LC_oddrow_value {
4815: text-align: left;
4816: padding: 8px;
4817: background-color: $data_table_light;
4818: }
4819: table.LC_helpform_receipt td.LC_pick_box_separator {
4820: padding: 0px;
4821: height: 1px;
4822: background: black;
4823: }
4824: span.LC_helpform_receipt_cat {
4825: font-weight: bold;
4826: }
1.424 albertel 4827: table.LC_group_priv_box {
4828: background: white;
4829: border: 1px solid black;
4830: border-spacing: 1px;
4831: }
4832: table.LC_group_priv_box td.LC_pick_box_title {
4833: background: $tabbg;
4834: font-weight: bold;
4835: text-align: right;
4836: width: 184px;
4837: }
4838: table.LC_group_priv_box td.LC_groups_fixed {
4839: background: $data_table_light;
4840: text-align: center;
4841: }
4842: table.LC_group_priv_box td.LC_groups_optional {
4843: background: $data_table_dark;
4844: text-align: center;
4845: }
4846: table.LC_group_priv_box td.LC_groups_functionality {
4847: background: $data_table_darker;
4848: text-align: center;
4849: font-weight: bold;
4850: }
4851: table.LC_group_priv td {
4852: text-align: left;
4853: padding: 0px;
4854: }
4855:
1.421 albertel 4856: table.LC_notify_front_page {
4857: background: white;
4858: border: 1px solid black;
4859: padding: 8px;
4860: }
4861: table.LC_notify_front_page td {
4862: padding: 8px;
4863: }
1.424 albertel 4864: .LC_navbuttons {
4865: margin: 2ex 0ex 2ex 0ex;
4866: }
1.423 albertel 4867: .LC_topic_bar {
4868: font-family: $sans;
4869: font-weight: bold;
4870: width: 100%;
4871: background: $tabbg;
4872: vertical-align: middle;
4873: margin: 2ex 0ex 2ex 0ex;
4874: }
4875: .LC_topic_bar span {
4876: vertical-align: middle;
4877: }
4878: .LC_topic_bar img {
4879: vertical-align: bottom;
4880: }
4881: table.LC_course_group_status {
4882: margin: 20px;
4883: }
4884: table.LC_status_selector td {
4885: vertical-align: top;
4886: text-align: center;
1.424 albertel 4887: padding: 4px;
4888: }
4889: table.LC_descriptive_input td.LC_description {
4890: vertical-align: top;
4891: text-align: right;
4892: font-weight: bold;
1.423 albertel 4893: }
1.599 albertel 4894: div.LC_feedback_link {
1.616 albertel 4895: clear: both;
1.599 albertel 4896: background: white;
4897: width: 100%;
1.489 raeburn 4898: }
4899: span.LC_feedback_link {
1.599 albertel 4900: background: $feedback_link_bg;
4901: font-size: larger;
4902: }
4903: span.LC_message_link {
4904: background: $feedback_link_bg;
4905: font-size: larger;
4906: position: absolute;
4907: right: 1em;
1.489 raeburn 4908: }
1.421 albertel 4909:
1.515 albertel 4910: table.LC_prior_tries {
1.524 albertel 4911: border: 1px solid #000000;
4912: border-collapse: separate;
4913: border-spacing: 1px;
1.515 albertel 4914: }
1.523 albertel 4915:
1.515 albertel 4916: table.LC_prior_tries td {
1.524 albertel 4917: padding: 2px;
1.515 albertel 4918: }
1.523 albertel 4919:
4920: .LC_answer_correct {
4921: background: #AAFFAA;
4922: color: black;
4923: }
4924: .LC_answer_charged_try {
4925: background: #FFAAAA ! important;
4926: color: black;
4927: }
4928: .LC_answer_not_charged_try,
4929: .LC_answer_no_grade,
4930: .LC_answer_late {
4931: background: #FFFFAA;
4932: color: black;
4933: }
4934: .LC_answer_previous {
4935: background: #AAAAFF;
4936: color: black;
4937: }
4938: .LC_answer_no_message {
4939: background: #FFFFFF;
4940: color: black;
4941: }
4942: .LC_answer_unknown {
4943: background: orange;
4944: color: black;
4945: }
4946:
4947:
1.529 albertel 4948: span.LC_prior_numerical,
4949: span.LC_prior_string,
4950: span.LC_prior_custom,
4951: span.LC_prior_reaction,
4952: span.LC_prior_math {
1.523 albertel 4953: font-family: monospace;
4954: white-space: pre;
4955: }
4956:
1.525 albertel 4957: span.LC_prior_string {
4958: font-family: monospace;
4959: white-space: pre;
4960: }
4961:
1.523 albertel 4962: table.LC_prior_option {
4963: width: 100%;
4964: border-collapse: collapse;
4965: }
1.528 albertel 4966: table.LC_prior_rank, table.LC_prior_match {
4967: border-collapse: collapse;
4968: }
4969: table.LC_prior_option tr td,
4970: table.LC_prior_rank tr td,
4971: table.LC_prior_match tr td {
1.524 albertel 4972: border: 1px solid #000000;
1.515 albertel 4973: }
4974:
1.519 raeburn 4975: span.LC_nobreak {
1.544 albertel 4976: white-space: nowrap;
1.519 raeburn 4977: }
4978:
1.576 raeburn 4979: span.LC_cusr_emph {
4980: font-style: italic;
4981: }
4982:
1.633 raeburn 4983: span.LC_cusr_subheading {
4984: font-weight: normal;
4985: font-size: 85%;
4986: }
4987:
1.545 albertel 4988: table.LC_docs_documents {
4989: background: #BBBBBB;
1.547 albertel 4990: border-width: 0px;
1.545 albertel 4991: border-collapse: collapse;
4992: }
4993:
4994: table.LC_docs_documents td.LC_docs_document {
4995: border: 2px solid black;
4996: padding: 4px;
4997: }
4998:
4999: .LC_docs_course_commands div {
5000: float: left;
5001: border: 4px solid #AAAAAA;
5002: padding: 4px;
5003: background: #DDDDCC;
5004: }
5005:
5006: .LC_docs_entry_move {
5007: border: 0px;
5008: border-collapse: collapse;
1.544 albertel 5009: }
5010:
1.545 albertel 5011: .LC_docs_entry_move td {
5012: border: 2px solid #BBBBBB;
5013: background: #DDDDDD;
5014: }
5015:
5016: .LC_docs_editor td.LC_docs_entry_commands {
5017: background: #DDDDDD;
5018: font-size: x-small;
5019: }
1.544 albertel 5020: .LC_docs_copy {
1.545 albertel 5021: color: #000099;
1.544 albertel 5022: }
5023: .LC_docs_cut {
1.545 albertel 5024: color: #550044;
1.544 albertel 5025: }
5026: .LC_docs_rename {
1.545 albertel 5027: color: #009900;
1.544 albertel 5028: }
5029: .LC_docs_remove {
1.545 albertel 5030: color: #990000;
5031: }
5032:
1.547 albertel 5033: .LC_docs_reinit_warn,
5034: .LC_docs_ext_edit {
5035: font-size: x-small;
5036: }
5037:
1.545 albertel 5038: .LC_docs_editor td.LC_docs_entry_title,
5039: .LC_docs_editor td.LC_docs_entry_icon {
5040: background: #FFFFBB;
5041: }
5042: .LC_docs_editor td.LC_docs_entry_parameter {
5043: background: #BBBBFF;
5044: font-size: x-small;
5045: white-space: nowrap;
5046: }
5047:
5048: table.LC_docs_adddocs td,
5049: table.LC_docs_adddocs th {
5050: border: 1px solid #BBBBBB;
5051: padding: 4px;
5052: background: #DDDDDD;
1.543 albertel 5053: }
5054:
1.584 albertel 5055: table.LC_sty_begin {
5056: background: #BBFFBB;
5057: }
5058: table.LC_sty_end {
5059: background: #FFBBBB;
5060: }
5061:
1.589 raeburn 5062: table.LC_double_column {
5063: border-width: 0px;
5064: border-collapse: collapse;
5065: width: 100%;
5066: padding: 2px;
5067: }
5068:
5069: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5070: top: 2px;
1.589 raeburn 5071: left: 2px;
5072: width: 47%;
5073: vertical-align: top;
5074: }
5075:
5076: table.LC_double_column tr td.LC_right_col {
5077: top: 2px;
5078: right: 2px;
5079: width: 47%;
5080: vertical-align: top;
5081: }
5082:
1.594 raeburn 5083: span.LC_role_level {
5084: font-weight: bold;
5085: }
5086:
1.591 raeburn 5087: div.LC_left_float {
5088: float: left;
5089: padding-right: 5%;
1.597 albertel 5090: padding-bottom: 4px;
1.591 raeburn 5091: }
5092:
5093: div.LC_clear_float_header {
1.597 albertel 5094: padding-bottom: 2px;
1.591 raeburn 5095: }
5096:
5097: div.LC_clear_float_footer {
1.597 albertel 5098: padding-top: 10px;
1.591 raeburn 5099: clear: both;
5100: }
5101:
1.597 albertel 5102:
1.601 albertel 5103: div.LC_grade_select_mode {
1.604 albertel 5104: font-family: $sans;
1.601 albertel 5105: }
5106: div.LC_grade_select_mode div div {
5107: margin: 5px;
5108: }
5109: div.LC_grade_select_mode_selector {
5110: margin: 5px;
5111: float: left;
5112: }
5113: div.LC_grade_select_mode_selector_header {
5114: font: bold medium $sans;
5115: }
5116: div.LC_grade_select_mode_type {
5117: clear: left;
5118: }
5119:
1.597 albertel 5120: div.LC_grade_show_user {
5121: margin-top: 20px;
5122: border: 1px solid black;
5123: }
5124: div.LC_grade_user_name {
5125: background: #DDDDEE;
5126: border-bottom: 1px solid black;
5127: font: bold large $sans;
5128: }
5129: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5130: background: #DDEEDD;
5131: }
5132:
5133: div.LC_grade_show_problem,
5134: div.LC_grade_submissions,
5135: div.LC_grade_message_center,
5136: div.LC_grade_info_links,
5137: div.LC_grade_assign {
5138: margin: 5px;
5139: width: 99%;
5140: background: #FFFFFF;
5141: }
5142: div.LC_grade_show_problem_header,
5143: div.LC_grade_submissions_header,
5144: div.LC_grade_message_center_header,
5145: div.LC_grade_assign_header {
5146: font: bold large $sans;
5147: }
5148: div.LC_grade_show_problem_problem,
5149: div.LC_grade_submissions_body,
5150: div.LC_grade_message_center_body,
5151: div.LC_grade_assign_body {
5152: border: 1px solid black;
5153: width: 99%;
5154: background: #FFFFFF;
5155: }
1.598 albertel 5156: span.LC_grade_check_note {
5157: font: normal medium $sans;
5158: display: inline;
5159: position: absolute;
5160: right: 1em;
5161: }
1.597 albertel 5162:
1.613 albertel 5163: table.LC_scantron_action {
5164: width: 100%;
5165: }
5166: table.LC_scantron_action tr th {
5167: font: normal bold $sans;
5168: }
1.600 albertel 5169:
1.614 albertel 5170: div.LC_edit_problem_header,
5171: div.LC_edit_problem_footer {
1.600 albertel 5172: font: normal medium $sans;
1.602 albertel 5173: margin: 2px;
1.600 albertel 5174: }
5175: div.LC_edit_problem_header,
1.602 albertel 5176: div.LC_edit_problem_header div,
1.614 albertel 5177: div.LC_edit_problem_footer,
5178: div.LC_edit_problem_footer div,
1.602 albertel 5179: div.LC_edit_problem_editxml_header,
5180: div.LC_edit_problem_editxml_header div {
1.600 albertel 5181: margin-top: 5px;
5182: }
1.602 albertel 5183: div.LC_edit_problem_header_edit_row {
5184: background: $tabbg;
5185: padding: 3px;
5186: margin-bottom: 5px;
5187: }
1.600 albertel 5188: div.LC_edit_problem_header_title {
1.602 albertel 5189: font: larger bold $sans;
5190: background: $tabbg;
5191: padding: 3px;
5192: }
5193: table.LC_edit_problem_header_title {
5194: font: larger bold $sans;
5195: width: 100%;
5196: border-color: $pgbg;
5197: border-style: solid;
5198: border-width: $border;
5199:
1.600 albertel 5200: background: $tabbg;
1.602 albertel 5201: border-collapse: collapse;
5202: padding: 0px
5203: }
5204:
5205: div.LC_edit_problem_discards {
5206: float: left;
5207: padding-bottom: 5px;
5208: }
5209: div.LC_edit_problem_saves {
5210: float: right;
5211: padding-bottom: 5px;
1.600 albertel 5212: }
5213: hr.LC_edit_problem_divide {
1.602 albertel 5214: clear: both;
1.600 albertel 5215: color: $tabbg;
5216: background-color: $tabbg;
5217: height: 3px;
5218: border: 0px;
5219: }
1.343 albertel 5220: END
5221: }
5222:
1.306 albertel 5223: =pod
5224:
5225: =item * &headtag()
5226:
5227: Returns a uniform footer for LON-CAPA web pages.
5228:
1.307 albertel 5229: Inputs: $title - optional title for the head
5230: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5231: $args - optional arguments
1.319 albertel 5232: force_register - if is true call registerurl so the remote is
5233: informed
1.415 albertel 5234: redirect -> array ref of
5235: 1- seconds before redirect occurs
5236: 2- url to redirect to
5237: 3- whether the side effect should occur
1.315 albertel 5238: (side effect of setting
5239: $env{'internal.head.redirect'} to the url
5240: redirected too)
1.352 albertel 5241: domain -> force to color decorate a page for a specific
5242: domain
5243: function -> force usage of a specific rolish color scheme
5244: bgcolor -> override the default page bgcolor
1.460 albertel 5245: no_auto_mt_title
5246: -> prevent &mt()ing the title arg
1.464 albertel 5247:
1.306 albertel 5248: =cut
5249:
5250: sub headtag {
1.313 albertel 5251: my ($title,$head_extra,$args) = @_;
1.306 albertel 5252:
1.363 albertel 5253: my $function = $args->{'function'} || &get_users_function();
5254: my $domain = $args->{'domain'} || &determinedomain();
5255: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5256: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5257: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5258: #time(),
1.418 albertel 5259: $env{'environment.color.timestamp'},
1.363 albertel 5260: $function,$domain,$bgcolor);
5261:
1.369 www 5262: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5263:
1.308 albertel 5264: my $result =
5265: '<head>'.
1.461 albertel 5266: &font_settings();
1.319 albertel 5267:
1.461 albertel 5268: if (!$args->{'frameset'}) {
5269: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5270: }
1.319 albertel 5271: if ($args->{'force_register'}) {
5272: $result .= &Apache::lonmenu::registerurl(1);
5273: }
1.436 albertel 5274: if (!$args->{'no_nav_bar'}
5275: && !$args->{'only_body'}
5276: && !$args->{'frameset'}) {
5277: $result .= &help_menu_js();
5278: }
1.319 albertel 5279:
1.314 albertel 5280: if (ref($args->{'redirect'})) {
1.414 albertel 5281: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5282: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5283: if (!$inhibit_continue) {
5284: $env{'internal.head.redirect'} = $url;
5285: }
1.313 albertel 5286: $result.=<<ADDMETA
5287: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5288: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5289: ADDMETA
5290: }
1.306 albertel 5291: if (!defined($title)) {
5292: $title = 'The LearningOnline Network with CAPA';
5293: }
1.460 albertel 5294: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5295: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5296: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5297: .$head_extra;
1.306 albertel 5298: return $result;
5299: }
5300:
5301: =pod
5302:
1.340 albertel 5303: =item * &font_settings()
5304:
5305: Returns neccessary <meta> to set the proper encoding
5306:
5307: Inputs: none
5308:
5309: =cut
5310:
5311: sub font_settings {
5312: my $headerstring='';
5313: if (($env{'browser.os'} eq 'mac') && (!$env{'browser.mathml'})) {
5314: $headerstring.=
5315: '<meta Content-Type="text/html; charset=x-mac-roman" />';
5316: } elsif (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
5317: $headerstring.=
5318: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5319: }
5320: return $headerstring;
5321: }
5322:
1.341 albertel 5323: =pod
5324:
5325: =item * &xml_begin()
5326:
5327: Returns the needed doctype and <html>
5328:
5329: Inputs: none
5330:
5331: =cut
5332:
5333: sub xml_begin {
5334: my $output='';
5335:
1.592 albertel 5336: if ($env{'internal.start_page'}==1) {
5337: &Apache::lonhtmlcommon::init_htmlareafields();
5338: }
1.342 albertel 5339:
1.341 albertel 5340: if ($env{'browser.mathml'}) {
5341: $output='<?xml version="1.0"?>'
5342: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5343: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5344:
5345: # .'<!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">] >'
5346: .'<!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">'
5347: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5348: .'xmlns="http://www.w3.org/1999/xhtml">';
5349: } else {
5350: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5351: }
5352: return $output;
5353: }
1.340 albertel 5354:
5355: =pod
5356:
1.306 albertel 5357: =item * &endheadtag()
5358:
5359: Returns a uniform </head> for LON-CAPA web pages.
5360:
5361: Inputs: none
5362:
5363: =cut
5364:
5365: sub endheadtag {
5366: return '</head>';
5367: }
5368:
5369: =pod
5370:
5371: =item * &head()
5372:
5373: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5374:
5375: Inputs: $title - optional title for the page
1.307 albertel 5376: $head_extra - optional extra HTML to put inside the <head>
1.405 albertel 5377:
1.306 albertel 5378: =cut
5379:
5380: sub head {
1.325 albertel 5381: my ($title,$head_extra,$args) = @_;
5382: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5383: }
5384:
5385: =pod
5386:
5387: =item * &start_page()
5388:
5389: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5390:
5391: Inputs: $title - optional title for the page
5392: $head_extra - optional extra HTML to incude inside the <head>
1.315 albertel 5393: $args - additional optional args supported are:
1.317 albertel 5394: only_body -> is true will set &bodytag() onlybodytag
5395: arg on
5396: no_nav_bar -> is true will set &bodytag() notopbar arg on
5397: add_entries -> additional attributes to add to the <body>
5398: domain -> force to color decorate a page for a
5399: specific domain
5400: function -> force usage of a specific rolish color
5401: scheme
5402: redirect -> see &headtag()
5403: bgcolor -> override the default page bg color
5404: js_ready -> return a string ready for being used in
5405: a javascript writeln
1.320 albertel 5406: html_encode -> return a string ready for being used in
5407: a html attribute
1.317 albertel 5408: force_register -> if is true will turn on the &bodytag()
5409: $forcereg arg
1.326 albertel 5410: body_title -> alternate text to use instead of $title
5411: in the title box that appears, this text
5412: is not auto translated like the $title is
1.330 albertel 5413: frameset -> if true will start with a <frameset>
5414: rather than <body>
1.338 albertel 5415: no_title -> if true the title bar won't be shown
5416: skip_phases -> hash ref of
5417: head -> skip the <html><head> generation
5418: body -> skip all <body> generation
1.337 albertel 5419:
1.361 albertel 5420: no_inline_link -> if true and in remote mode, don't show the
5421: 'Switch To Inline Menu' link
5422:
1.460 albertel 5423: no_auto_mt_title -> prevent &mt()ing the title arg
5424:
1.562 albertel 5425: inherit_jsmath -> when creating popup window in a page,
5426: should it have jsmath forced on by the
5427: current page
5428:
1.306 albertel 5429: =cut
5430:
5431: sub start_page {
1.309 albertel 5432: my ($title,$head_extra,$args) = @_;
1.318 albertel 5433: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 5434: my %head_args;
1.352 albertel 5435: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 5436: 'bgcolor','frameset','no_nav_bar','only_body',
5437: 'no_auto_mt_title') {
1.319 albertel 5438: if (defined($args->{$arg})) {
1.324 raeburn 5439: $head_args{$arg} = $args->{$arg};
1.319 albertel 5440: }
1.313 albertel 5441: }
1.319 albertel 5442:
1.315 albertel 5443: $env{'internal.start_page'}++;
1.338 albertel 5444: my $result;
5445: if (! exists($args->{'skip_phases'}{'head'}) ) {
5446: $result.=
1.341 albertel 5447: &xml_begin().
1.338 albertel 5448: &headtag($title,$head_extra,\%head_args).&endheadtag();
5449: }
5450:
5451: if (! exists($args->{'skip_phases'}{'body'}) ) {
5452: if ($args->{'frameset'}) {
5453: my $attr_string = &make_attr_string($args->{'force_register'},
5454: $args->{'add_entries'});
5455: $result .= "\n<frameset $attr_string>\n";
5456: } else {
5457: $result .=
5458: &bodytag($title,
5459: $args->{'function'}, $args->{'add_entries'},
5460: $args->{'only_body'}, $args->{'domain'},
5461: $args->{'force_register'}, $args->{'body_title'},
5462: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 5463: $args->{'no_title'}, $args->{'no_inline_link'},
5464: $args);
1.338 albertel 5465: }
1.330 albertel 5466: }
1.338 albertel 5467:
1.315 albertel 5468: if ($args->{'js_ready'}) {
1.317 albertel 5469: $result = &js_ready($result);
1.315 albertel 5470: }
1.320 albertel 5471: if ($args->{'html_encode'}) {
5472: $result = &html_encode($result);
5473: }
1.315 albertel 5474: return $result;
1.306 albertel 5475: }
5476:
1.330 albertel 5477:
1.306 albertel 5478: =pod
5479:
5480: =item * &head()
5481:
5482: Returns a complete </body></html> section for LON-CAPA web pages.
5483:
1.315 albertel 5484: Inputs: $args - additional optional args supported are:
5485: js_ready -> return a string ready for being used in
5486: a javascript writeln
1.320 albertel 5487: html_encode -> return a string ready for being used in
5488: a html attribute
1.330 albertel 5489: frameset -> if true will start with a <frameset>
5490: rather than <body>
1.493 albertel 5491: dicsussion -> if true will get discussion from
5492: lonxml::xmlend
5493: (you can pass the target and parser arguments
5494: through optional 'target' and 'parser' args
5495: to this routine)
1.306 albertel 5496:
5497: =cut
5498:
5499: sub end_page {
1.315 albertel 5500: my ($args) = @_;
5501: $env{'internal.end_page'}++;
1.330 albertel 5502: my $result;
1.335 albertel 5503: if ($args->{'discussion'}) {
5504: my ($target,$parser);
5505: if (ref($args->{'discussion'})) {
5506: ($target,$parser) =($args->{'discussion'}{'target'},
5507: $args->{'discussion'}{'parser'});
5508: }
5509: $result .= &Apache::lonxml::xmlend($target,$parser);
5510: }
5511:
1.330 albertel 5512: if ($args->{'frameset'}) {
5513: $result .= '</frameset>';
5514: } else {
5515: $result .= &endbodytag();
5516: }
5517: $result .= "\n</html>";
5518:
1.315 albertel 5519: if ($args->{'js_ready'}) {
1.317 albertel 5520: $result = &js_ready($result);
1.315 albertel 5521: }
1.335 albertel 5522:
1.320 albertel 5523: if ($args->{'html_encode'}) {
5524: $result = &html_encode($result);
5525: }
1.335 albertel 5526:
1.315 albertel 5527: return $result;
5528: }
5529:
1.320 albertel 5530: sub html_encode {
5531: my ($result) = @_;
5532:
1.322 albertel 5533: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 5534:
5535: return $result;
5536: }
1.317 albertel 5537: sub js_ready {
5538: my ($result) = @_;
5539:
1.323 albertel 5540: $result =~ s/[\n\r]/ /xmsg;
5541: $result =~ s/\\/\\\\/xmsg;
5542: $result =~ s/'/\\'/xmsg;
1.372 albertel 5543: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 5544:
5545: return $result;
5546: }
5547:
1.315 albertel 5548: sub validate_page {
5549: if ( exists($env{'internal.start_page'})
1.316 albertel 5550: && $env{'internal.start_page'} > 1) {
5551: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 5552: $env{'internal.start_page'}.' '.
1.316 albertel 5553: $ENV{'request.filename'});
1.315 albertel 5554: }
5555: if ( exists($env{'internal.end_page'})
1.316 albertel 5556: && $env{'internal.end_page'} > 1) {
5557: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 5558: $env{'internal.end_page'}.' '.
1.316 albertel 5559: $env{'request.filename'});
1.315 albertel 5560: }
5561: if ( exists($env{'internal.start_page'})
5562: && ! exists($env{'internal.end_page'})) {
1.316 albertel 5563: &Apache::lonnet::logthis('start_page called without end_page '.
5564: $env{'request.filename'});
1.315 albertel 5565: }
5566: if ( ! exists($env{'internal.start_page'})
5567: && exists($env{'internal.end_page'})) {
1.316 albertel 5568: &Apache::lonnet::logthis('end_page called without start_page'.
5569: $env{'request.filename'});
1.315 albertel 5570: }
1.306 albertel 5571: }
1.315 albertel 5572:
1.318 albertel 5573: sub simple_error_page {
5574: my ($r,$title,$msg) = @_;
5575: my $page =
5576: &Apache::loncommon::start_page($title).
5577: &mt($msg).
5578: &Apache::loncommon::end_page();
5579: if (ref($r)) {
5580: $r->print($page);
1.327 albertel 5581: return;
1.318 albertel 5582: }
5583: return $page;
5584: }
1.347 albertel 5585:
5586: {
1.610 albertel 5587: my @row_count;
1.347 albertel 5588: sub start_data_table {
1.422 albertel 5589: my ($add_class) = @_;
5590: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 5591: unshift(@row_count,0);
1.422 albertel 5592: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 5593: }
5594:
5595: sub end_data_table {
1.610 albertel 5596: shift(@row_count);
1.389 albertel 5597: return '</table>'."\n";;
1.347 albertel 5598: }
5599:
5600: sub start_data_table_row {
1.422 albertel 5601: my ($add_class) = @_;
1.610 albertel 5602: $row_count[0]++;
5603: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 5604: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 5605: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 5606: }
1.471 banghart 5607:
5608: sub continue_data_table_row {
5609: my ($add_class) = @_;
1.610 albertel 5610: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 5611: $css_class = (join(' ',$css_class,$add_class));
5612: return '<tr class="'.$css_class.'">'."\n";;
5613: }
1.347 albertel 5614:
5615: sub end_data_table_row {
1.389 albertel 5616: return '</tr>'."\n";;
1.347 albertel 5617: }
1.367 www 5618:
1.421 albertel 5619: sub start_data_table_empty_row {
1.610 albertel 5620: $row_count[0]++;
1.421 albertel 5621: return '<tr class="LC_empty_row" >'."\n";;
5622: }
5623:
5624: sub end_data_table_empty_row {
5625: return '</tr>'."\n";;
5626: }
5627:
1.367 www 5628: sub start_data_table_header_row {
1.389 albertel 5629: return '<tr class="LC_header_row">'."\n";;
1.367 www 5630: }
5631:
5632: sub end_data_table_header_row {
1.389 albertel 5633: return '</tr>'."\n";;
1.367 www 5634: }
1.347 albertel 5635: }
5636:
1.548 albertel 5637: =pod
5638:
5639: =item * &inhibit_menu_check($arg)
5640:
5641: Checks for a inhibitmenu state and generates output to preserve it
5642:
5643: Inputs: $arg - can be any of
5644: - undef - in which case the return value is a string
5645: to add into arguments list of a uri
5646: - 'input' - in which case the return value is a HTML
5647: <form> <input> field of type hidden to
5648: preserve the value
5649: - a url - in which case the return value is the url with
5650: the neccesary cgi args added to preserve the
5651: inhibitmenu state
5652: - a ref to a url - no return value, but the string is
5653: updated to include the neccessary cgi
5654: args to preserve the inhibitmenu state
5655:
5656: =cut
5657:
5658: sub inhibit_menu_check {
5659: my ($arg) = @_;
5660: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5661: if ($arg eq 'input') {
5662: if ($env{'form.inhibitmenu'}) {
5663: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
5664: } else {
5665: return
5666: }
5667: }
5668: if ($env{'form.inhibitmenu'}) {
5669: if (ref($arg)) {
5670: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5671: } elsif ($arg eq '') {
5672: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
5673: } else {
5674: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5675: }
5676: }
5677: if (!ref($arg)) {
5678: return $arg;
5679: }
5680: }
5681:
1.251 albertel 5682: ###############################################
1.182 matthew 5683:
5684: =pod
5685:
1.549 albertel 5686: =back
5687:
5688: =head1 User Information Routines
5689:
5690: =over 4
5691:
1.405 albertel 5692: =item * &get_users_function()
1.182 matthew 5693:
5694: Used by &bodytag to determine the current users primary role.
5695: Returns either 'student','coordinator','admin', or 'author'.
5696:
5697: =cut
5698:
5699: ###############################################
5700: sub get_users_function {
5701: my $function = 'student';
1.258 albertel 5702: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 5703: $function='coordinator';
5704: }
1.258 albertel 5705: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 5706: $function='admin';
5707: }
1.258 albertel 5708: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 5709: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
5710: $function='author';
5711: }
5712: return $function;
1.54 www 5713: }
1.99 www 5714:
5715: ###############################################
5716:
1.233 raeburn 5717: =pod
5718:
1.542 raeburn 5719: =item * &check_user_status()
1.274 raeburn 5720:
5721: Determines current status of supplied role for a
5722: specific user. Roles can be active, previous or future.
5723:
5724: Inputs:
5725: user's domain, user's username, course's domain,
1.375 raeburn 5726: course's number, optional section ID.
1.274 raeburn 5727:
5728: Outputs:
5729: role status: active, previous or future.
5730:
5731: =cut
5732:
5733: sub check_user_status {
1.412 raeburn 5734: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 5735: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
5736: my @uroles = keys %userinfo;
5737: my $srchstr;
5738: my $active_chk = 'none';
1.412 raeburn 5739: my $now = time;
1.274 raeburn 5740: if (@uroles > 0) {
1.412 raeburn 5741: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 5742: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
5743: } else {
1.412 raeburn 5744: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
5745: }
5746: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 5747: my $role_end = 0;
5748: my $role_start = 0;
5749: $active_chk = 'active';
1.412 raeburn 5750: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
5751: $role_end = $1;
5752: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
5753: $role_start = $1;
1.274 raeburn 5754: }
5755: }
5756: if ($role_start > 0) {
1.412 raeburn 5757: if ($now < $role_start) {
1.274 raeburn 5758: $active_chk = 'future';
5759: }
5760: }
5761: if ($role_end > 0) {
1.412 raeburn 5762: if ($now > $role_end) {
1.274 raeburn 5763: $active_chk = 'previous';
5764: }
5765: }
5766: }
5767: }
5768: return $active_chk;
5769: }
5770:
5771: ###############################################
5772:
5773: =pod
5774:
1.405 albertel 5775: =item * &get_sections()
1.233 raeburn 5776:
5777: Determines all the sections for a course including
5778: sections with students and sections containing other roles.
1.419 raeburn 5779: Incoming parameters:
5780:
5781: 1. domain
5782: 2. course number
5783: 3. reference to array containing roles for which sections should
5784: be gathered (optional).
5785: 4. reference to array containing status types for which sections
5786: should be gathered (optional).
5787:
5788: If the third argument is undefined, sections are gathered for any role.
5789: If the fourth argument is undefined, sections are gathered for any status.
5790: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 5791:
1.374 raeburn 5792: Returns section hash (keys are section IDs, values are
5793: number of users in each section), subject to the
1.419 raeburn 5794: optional roles filter, optional status filter
1.233 raeburn 5795:
5796: =cut
5797:
5798: ###############################################
5799: sub get_sections {
1.419 raeburn 5800: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 5801: if (!defined($cdom) || !defined($cnum)) {
5802: my $cid = $env{'request.course.id'};
5803:
5804: return if (!defined($cid));
5805:
5806: $cdom = $env{'course.'.$cid.'.domain'};
5807: $cnum = $env{'course.'.$cid.'.num'};
5808: }
5809:
5810: my %sectioncount;
1.419 raeburn 5811: my $now = time;
1.240 albertel 5812:
1.366 albertel 5813: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 5814: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 5815: my $sec_index = &Apache::loncoursedata::CL_SECTION();
5816: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 5817: my $start_index = &Apache::loncoursedata::CL_START();
5818: my $end_index = &Apache::loncoursedata::CL_END();
5819: my $status;
1.366 albertel 5820: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 5821: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
5822: $data->[$status_index],
5823: $data->[$start_index],
5824: $data->[$end_index]);
5825: if ($stu_status eq 'Active') {
5826: $status = 'active';
5827: } elsif ($end < $now) {
5828: $status = 'previous';
5829: } elsif ($start > $now) {
5830: $status = 'future';
5831: }
5832: if ($section ne '-1' && $section !~ /^\s*$/) {
5833: if ((!defined($possible_status)) || (($status ne '') &&
5834: (grep/^\Q$status\E$/,@{$possible_status}))) {
5835: $sectioncount{$section}++;
5836: }
1.240 albertel 5837: }
5838: }
5839: }
5840: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5841: foreach my $user (sort(keys(%courseroles))) {
5842: if ($user !~ /^(\w{2})/) { next; }
5843: my ($role) = ($user =~ /^(\w{2})/);
5844: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 5845: my ($section,$status);
1.240 albertel 5846: if ($role eq 'cr' &&
5847: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
5848: $section=$1;
5849: }
5850: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
5851: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 5852: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
5853: if ($end == -1 && $start == -1) {
5854: next; #deleted role
5855: }
5856: if (!defined($possible_status)) {
5857: $sectioncount{$section}++;
5858: } else {
5859: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
5860: $status = 'active';
5861: } elsif ($end < $now) {
5862: $status = 'future';
5863: } elsif ($start > $now) {
5864: $status = 'previous';
5865: }
5866: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
5867: $sectioncount{$section}++;
5868: }
5869: }
1.233 raeburn 5870: }
1.366 albertel 5871: return %sectioncount;
1.233 raeburn 5872: }
5873:
1.274 raeburn 5874: ###############################################
1.294 raeburn 5875:
5876: =pod
1.405 albertel 5877:
5878: =item * &get_course_users()
5879:
1.275 raeburn 5880: Retrieves usernames:domains for users in the specified course
5881: with specific role(s), and access status.
5882:
5883: Incoming parameters:
1.277 albertel 5884: 1. course domain
5885: 2. course number
5886: 3. access status: users must have - either active,
1.275 raeburn 5887: previous, future, or all.
1.277 albertel 5888: 4. reference to array of permissible roles
1.288 raeburn 5889: 5. reference to array of section restrictions (optional)
5890: 6. reference to results object (hash of hashes).
5891: 7. reference to optional userdata hash
1.609 raeburn 5892: 8. reference to optional statushash
1.630 raeburn 5893: 9. flag if privileged users (except those set to unhide in
5894: course settings) should be excluded
1.609 raeburn 5895: Keys of top level results hash are roles.
1.275 raeburn 5896: Keys of inner hashes are username:domain, with
5897: values set to access type.
1.288 raeburn 5898: Optional userdata hash returns an array with arguments in the
5899: same order as loncoursedata::get_classlist() for student data.
5900:
1.609 raeburn 5901: Optional statushash returns
5902:
1.288 raeburn 5903: Entries for end, start, section and status are blank because
5904: of the possibility of multiple values for non-student roles.
5905:
1.275 raeburn 5906: =cut
1.405 albertel 5907:
1.275 raeburn 5908: ###############################################
1.405 albertel 5909:
1.275 raeburn 5910: sub get_course_users {
1.630 raeburn 5911: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 5912: my %idx = ();
1.419 raeburn 5913: my %seclists;
1.288 raeburn 5914:
5915: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
5916: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
5917: $idx{end} = &Apache::loncoursedata::CL_END();
5918: $idx{start} = &Apache::loncoursedata::CL_START();
5919: $idx{id} = &Apache::loncoursedata::CL_ID();
5920: $idx{section} = &Apache::loncoursedata::CL_SECTION();
5921: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
5922: $idx{status} = &Apache::loncoursedata::CL_STATUS();
5923:
1.290 albertel 5924: if (grep(/^st$/,@{$roles})) {
1.276 albertel 5925: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 5926: my $now = time;
1.277 albertel 5927: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 5928: my $match = 0;
1.412 raeburn 5929: my $secmatch = 0;
1.419 raeburn 5930: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 5931: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 5932: if ($section eq '') {
5933: $section = 'none';
5934: }
1.291 albertel 5935: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 5936: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 5937: $secmatch = 1;
5938: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 5939: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 5940: $secmatch = 1;
5941: }
5942: } else {
1.419 raeburn 5943: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 5944: $secmatch = 1;
5945: }
1.290 albertel 5946: }
1.412 raeburn 5947: if (!$secmatch) {
5948: next;
5949: }
1.419 raeburn 5950: }
1.275 raeburn 5951: if (defined($$types{'active'})) {
1.288 raeburn 5952: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 5953: push(@{$$users{st}{$student}},'active');
1.288 raeburn 5954: $match = 1;
1.275 raeburn 5955: }
5956: }
5957: if (defined($$types{'previous'})) {
1.609 raeburn 5958: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 5959: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 5960: $match = 1;
1.275 raeburn 5961: }
5962: }
5963: if (defined($$types{'future'})) {
1.609 raeburn 5964: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 5965: push(@{$$users{st}{$student}},'future');
1.288 raeburn 5966: $match = 1;
1.275 raeburn 5967: }
5968: }
1.609 raeburn 5969: if ($match) {
5970: push(@{$seclists{$student}},$section);
5971: if (ref($userdata) eq 'HASH') {
5972: $$userdata{$student} = $$classlist{$student};
5973: }
5974: if (ref($statushash) eq 'HASH') {
5975: $statushash->{$student}{'st'}{$section} = $status;
5976: }
1.288 raeburn 5977: }
1.275 raeburn 5978: }
5979: }
1.412 raeburn 5980: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 5981: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
5982: my $now = time;
1.609 raeburn 5983: my %displaystatus = ( previous => 'Expired',
5984: active => 'Active',
5985: future => 'Future',
5986: );
1.630 raeburn 5987: my %nothide;
5988: if ($hidepriv) {
5989: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
5990: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
5991: if ($user !~ /:/) {
5992: $nothide{join(':',split(/[\@]/,$user))}=1;
5993: } else {
5994: $nothide{$user} = 1;
5995: }
5996: }
5997: }
1.439 raeburn 5998: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 5999: my $match = 0;
1.412 raeburn 6000: my $secmatch = 0;
1.439 raeburn 6001: my $status;
1.412 raeburn 6002: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6003: $user =~ s/:$//;
1.439 raeburn 6004: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6005: if ($end == -1 || $start == -1) {
6006: next;
6007: }
6008: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6009: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6010: my ($uname,$udom) = split(/:/,$user);
6011: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6012: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6013: $secmatch = 1;
6014: } elsif ($usec eq '') {
1.420 albertel 6015: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6016: $secmatch = 1;
6017: }
6018: } else {
6019: if (grep(/^\Q$usec\E$/,@{$sections})) {
6020: $secmatch = 1;
6021: }
6022: }
6023: if (!$secmatch) {
6024: next;
6025: }
1.288 raeburn 6026: }
1.419 raeburn 6027: if ($usec eq '') {
6028: $usec = 'none';
6029: }
1.275 raeburn 6030: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6031: if ($hidepriv) {
6032: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6033: (!$nothide{$uname.':'.$udom})) {
6034: next;
6035: }
6036: }
1.503 raeburn 6037: if ($end > 0 && $end < $now) {
1.439 raeburn 6038: $status = 'previous';
6039: } elsif ($start > $now) {
6040: $status = 'future';
6041: } else {
6042: $status = 'active';
6043: }
1.277 albertel 6044: foreach my $type (keys(%{$types})) {
1.275 raeburn 6045: if ($status eq $type) {
1.420 albertel 6046: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6047: push(@{$$users{$role}{$user}},$type);
6048: }
1.288 raeburn 6049: $match = 1;
6050: }
6051: }
1.419 raeburn 6052: if (($match) && (ref($userdata) eq 'HASH')) {
6053: if (!exists($$userdata{$uname.':'.$udom})) {
6054: &get_user_info($udom,$uname,\%idx,$userdata);
6055: }
1.420 albertel 6056: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6057: push(@{$seclists{$uname.':'.$udom}},$usec);
6058: }
1.609 raeburn 6059: if (ref($statushash) eq 'HASH') {
6060: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6061: }
1.275 raeburn 6062: }
6063: }
6064: }
6065: }
1.290 albertel 6066: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6067: if ((defined($cdom)) && (defined($cnum))) {
6068: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6069: if ( defined($csettings{'internal.courseowner'}) ) {
6070: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6071: next if ($owner eq '');
6072: my ($ownername,$ownerdom);
6073: if ($owner =~ /^([^:]+):([^:]+)$/) {
6074: $ownername = $1;
6075: $ownerdom = $2;
6076: } else {
6077: $ownername = $owner;
6078: $ownerdom = $cdom;
6079: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6080: }
6081: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6082: if (defined($userdata) &&
1.609 raeburn 6083: !exists($$userdata{$owner})) {
6084: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6085: if (!grep(/^none$/,@{$seclists{$owner}})) {
6086: push(@{$seclists{$owner}},'none');
6087: }
6088: if (ref($statushash) eq 'HASH') {
6089: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6090: }
1.290 albertel 6091: }
1.279 raeburn 6092: }
6093: }
6094: }
1.419 raeburn 6095: foreach my $user (keys(%seclists)) {
6096: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6097: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6098: }
1.275 raeburn 6099: }
6100: return;
6101: }
6102:
1.288 raeburn 6103: sub get_user_info {
6104: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6105: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6106: &plainname($uname,$udom,'lastname');
1.291 albertel 6107: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6108: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6109: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6110: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6111: return;
6112: }
1.275 raeburn 6113:
1.472 raeburn 6114: ###############################################
6115:
6116: =pod
6117:
6118: =item * &get_user_quota()
6119:
6120: Retrieves quota assigned for storage of portfolio files for a user
6121:
6122: Incoming parameters:
6123: 1. user's username
6124: 2. user's domain
6125:
6126: Returns:
1.536 raeburn 6127: 1. Disk quota (in Mb) assigned to student.
6128: 2. (Optional) Type of setting: custom or default
6129: (individually assigned or default for user's
6130: institutional status).
6131: 3. (Optional) - User's institutional status (e.g., faculty, staff
6132: or student - types as defined in localenroll::inst_usertypes
6133: for user's domain, which determines default quota for user.
6134: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6135:
6136: If a value has been stored in the user's environment,
1.536 raeburn 6137: it will return that, otherwise it returns the maximal default
6138: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6139:
6140: =cut
6141:
6142: ###############################################
6143:
6144:
6145: sub get_user_quota {
6146: my ($uname,$udom) = @_;
1.536 raeburn 6147: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6148: if (!defined($udom)) {
6149: $udom = $env{'user.domain'};
6150: }
6151: if (!defined($uname)) {
6152: $uname = $env{'user.name'};
6153: }
6154: if (($udom eq '' || $uname eq '') ||
6155: ($udom eq 'public') && ($uname eq 'public')) {
6156: $quota = 0;
1.536 raeburn 6157: $quotatype = 'default';
6158: $defquota = 0;
1.472 raeburn 6159: } else {
1.536 raeburn 6160: my $inststatus;
1.472 raeburn 6161: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6162: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6163: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6164: } else {
1.536 raeburn 6165: my %userenv =
6166: &Apache::lonnet::get('environment',['portfolioquota',
6167: 'inststatus'],$udom,$uname);
1.472 raeburn 6168: my ($tmp) = keys(%userenv);
6169: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6170: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6171: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6172: } else {
6173: undef(%userenv);
6174: }
6175: }
1.536 raeburn 6176: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6177: if ($quota eq '') {
1.536 raeburn 6178: $quota = $defquota;
6179: $quotatype = 'default';
6180: } else {
6181: $quotatype = 'custom';
1.472 raeburn 6182: }
6183: }
1.536 raeburn 6184: if (wantarray) {
6185: return ($quota,$quotatype,$settingstatus,$defquota);
6186: } else {
6187: return $quota;
6188: }
1.472 raeburn 6189: }
6190:
6191: ###############################################
6192:
6193: =pod
6194:
6195: =item * &default_quota()
6196:
1.536 raeburn 6197: Retrieves default quota assigned for storage of user portfolio files,
6198: given an (optional) user's institutional status.
1.472 raeburn 6199:
6200: Incoming parameters:
6201: 1. domain
1.536 raeburn 6202: 2. (Optional) institutional status(es). This is a : separated list of
6203: status types (e.g., faculty, staff, student etc.)
6204: which apply to the user for whom the default is being retrieved.
6205: If the institutional status string in undefined, the domain
6206: default quota will be returned.
1.472 raeburn 6207:
6208: Returns:
6209: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6210: 2. (Optional) institutional type which determined the value of the
6211: default quota.
1.472 raeburn 6212:
6213: If a value has been stored in the domain's configuration db,
6214: it will return that, otherwise it returns 20 (for backwards
6215: compatibility with domains which have not set up a configuration
6216: db file; the original statically defined portfolio quota was 20 Mb).
6217:
1.536 raeburn 6218: If the user's status includes multiple types (e.g., staff and student),
6219: the largest default quota which applies to the user determines the
6220: default quota returned.
6221:
1.472 raeburn 6222: =cut
6223:
6224: ###############################################
6225:
6226:
6227: sub default_quota {
1.536 raeburn 6228: my ($udom,$inststatus) = @_;
6229: my ($defquota,$settingstatus);
6230: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6231: ['quotas'],$udom);
6232: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6233: if ($inststatus ne '') {
6234: my @statuses = split(/:/,$inststatus);
6235: foreach my $item (@statuses) {
1.622 raeburn 6236: if ($quotahash{'quotas'}{$item} ne '') {
1.536 raeburn 6237: if ($defquota eq '') {
1.622 raeburn 6238: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6239: $settingstatus = $item;
1.622 raeburn 6240: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6241: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6242: $settingstatus = $item;
6243: }
6244: }
6245: }
6246: }
6247: if ($defquota eq '') {
1.622 raeburn 6248: $defquota = $quotahash{'quotas'}{'default'};
1.536 raeburn 6249: $settingstatus = 'default';
6250: }
6251: } else {
6252: $settingstatus = 'default';
6253: $defquota = 20;
6254: }
6255: if (wantarray) {
6256: return ($defquota,$settingstatus);
1.472 raeburn 6257: } else {
1.536 raeburn 6258: return $defquota;
1.472 raeburn 6259: }
6260: }
6261:
1.384 raeburn 6262: sub get_secgrprole_info {
6263: my ($cdom,$cnum,$needroles,$type) = @_;
6264: my %sections_count = &get_sections($cdom,$cnum);
6265: my @sections = (sort {$a <=> $b} keys(%sections_count));
6266: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6267: my @groups = sort(keys(%curr_groups));
6268: my $allroles = [];
6269: my $rolehash;
6270: my $accesshash = {
6271: active => 'Currently has access',
6272: future => 'Will have future access',
6273: previous => 'Previously had access',
6274: };
6275: if ($needroles) {
6276: $rolehash = {'all' => 'all'};
1.385 albertel 6277: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6278: if (&Apache::lonnet::error(%user_roles)) {
6279: undef(%user_roles);
6280: }
6281: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6282: my ($role)=split(/\:/,$item,2);
6283: if ($role eq 'cr') { next; }
6284: if ($role =~ /^cr/) {
6285: $$rolehash{$role} = (split('/',$role))[3];
6286: } else {
6287: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6288: }
6289: }
6290: foreach my $key (sort(keys(%{$rolehash}))) {
6291: push(@{$allroles},$key);
6292: }
6293: push (@{$allroles},'st');
6294: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6295: }
6296: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6297: }
6298:
1.555 raeburn 6299: sub user_picker {
1.627 raeburn 6300: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6301: my $currdom = $dom;
6302: my %curr_selected = (
6303: srchin => 'dom',
1.580 raeburn 6304: srchby => 'lastname',
1.555 raeburn 6305: );
6306: my $srchterm;
1.625 raeburn 6307: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6308: if ($srch->{'srchby'} ne '') {
6309: $curr_selected{'srchby'} = $srch->{'srchby'};
6310: }
6311: if ($srch->{'srchin'} ne '') {
6312: $curr_selected{'srchin'} = $srch->{'srchin'};
6313: }
6314: if ($srch->{'srchtype'} ne '') {
6315: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6316: }
6317: if ($srch->{'srchdomain'} ne '') {
6318: $currdom = $srch->{'srchdomain'};
6319: }
6320: $srchterm = $srch->{'srchterm'};
6321: }
6322: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6323: 'usr' => 'Search criteria',
1.563 raeburn 6324: 'doma' => 'Domain/institution to search',
1.558 albertel 6325: 'uname' => 'username',
6326: 'lastname' => 'last name',
1.555 raeburn 6327: 'lastfirst' => 'last name, first name',
1.558 albertel 6328: 'crs' => 'in this course',
1.576 raeburn 6329: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6330: 'alc' => 'all LON-CAPA',
1.573 raeburn 6331: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6332: 'exact' => 'is',
6333: 'contains' => 'contains',
1.569 raeburn 6334: 'begins' => 'begins with',
1.571 raeburn 6335: 'youm' => "You must include some text to search for.",
6336: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6337: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6338: 'yomc' => "You must choose a domain when using an institutional directory search.",
6339: 'ymcd' => "You must choose a domain when using a domain search.",
6340: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6341: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6342: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6343: );
1.563 raeburn 6344: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6345: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6346:
6347: my @srchins = ('crs','dom','alc','instd');
6348:
6349: foreach my $option (@srchins) {
6350: # FIXME 'alc' option unavailable until
6351: # loncreateuser::print_user_query_page()
6352: # has been completed.
6353: next if ($option eq 'alc');
6354: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6355: if ($curr_selected{'srchin'} eq $option) {
6356: $srchinsel .= '
6357: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6358: } else {
6359: $srchinsel .= '
6360: <option value="'.$option.'">'.$lt{$option}.'</option>';
6361: }
1.555 raeburn 6362: }
1.563 raeburn 6363: $srchinsel .= "\n </select>\n";
1.555 raeburn 6364:
6365: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6366: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6367: if ($curr_selected{'srchby'} eq $option) {
6368: $srchbysel .= '
6369: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6370: } else {
6371: $srchbysel .= '
6372: <option value="'.$option.'">'.$lt{$option}.'</option>';
6373: }
6374: }
6375: $srchbysel .= "\n </select>\n";
6376:
6377: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6378: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6379: if ($curr_selected{'srchtype'} eq $option) {
6380: $srchtypesel .= '
6381: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6382: } else {
6383: $srchtypesel .= '
6384: <option value="'.$option.'">'.$lt{$option}.'</option>';
6385: }
6386: }
6387: $srchtypesel .= "\n </select>\n";
6388:
1.558 albertel 6389: my ($newuserscript,$new_user_create);
1.556 raeburn 6390:
6391: if ($forcenewuser) {
1.576 raeburn 6392: if (ref($srch) eq 'HASH') {
6393: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6394: if ($cancreate) {
6395: $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>';
6396: } else {
6397: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6398: my %usertypetext = (
6399: official => 'institutional',
6400: unofficial => 'non-institutional',
6401: );
6402: $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 />';
6403: }
1.576 raeburn 6404: }
6405: }
6406:
1.556 raeburn 6407: $newuserscript = <<"ENDSCRIPT";
6408:
1.570 raeburn 6409: function setSearch(createnew,callingForm) {
1.556 raeburn 6410: if (createnew == 1) {
1.570 raeburn 6411: for (var i=0; i<callingForm.srchby.length; i++) {
6412: if (callingForm.srchby.options[i].value == 'uname') {
6413: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6414: }
6415: }
1.570 raeburn 6416: for (var i=0; i<callingForm.srchin.length; i++) {
6417: if ( callingForm.srchin.options[i].value == 'dom') {
6418: callingForm.srchin.selectedIndex = i;
1.556 raeburn 6419: }
6420: }
1.570 raeburn 6421: for (var i=0; i<callingForm.srchtype.length; i++) {
6422: if (callingForm.srchtype.options[i].value == 'exact') {
6423: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 6424: }
6425: }
1.570 raeburn 6426: for (var i=0; i<callingForm.srchdomain.length; i++) {
6427: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6428: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 6429: }
6430: }
6431: }
6432: }
6433: ENDSCRIPT
1.558 albertel 6434:
1.556 raeburn 6435: }
6436:
1.555 raeburn 6437: my $output = <<"END_BLOCK";
1.556 raeburn 6438: <script type="text/javascript">
1.570 raeburn 6439: function validateEntry(callingForm) {
1.558 albertel 6440:
1.556 raeburn 6441: var checkok = 1;
1.558 albertel 6442: var srchin;
1.570 raeburn 6443: for (var i=0; i<callingForm.srchin.length; i++) {
6444: if ( callingForm.srchin[i].checked ) {
6445: srchin = callingForm.srchin[i].value;
1.558 albertel 6446: }
6447: }
6448:
1.570 raeburn 6449: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
6450: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
6451: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
6452: var srchterm = callingForm.srchterm.value;
6453: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 6454: var msg = "";
6455:
6456: if (srchterm == "") {
6457: checkok = 0;
1.571 raeburn 6458: msg += "$lt{'youm'}\\n";
1.556 raeburn 6459: }
6460:
1.569 raeburn 6461: if (srchtype== 'begins') {
6462: if (srchterm.length < 2) {
6463: checkok = 0;
1.571 raeburn 6464: msg += "$lt{'thte'}\\n";
1.569 raeburn 6465: }
6466: }
6467:
1.556 raeburn 6468: if (srchtype== 'contains') {
6469: if (srchterm.length < 3) {
6470: checkok = 0;
1.571 raeburn 6471: msg += "$lt{'thet'}\\n";
1.556 raeburn 6472: }
6473: }
6474: if (srchin == 'instd') {
6475: if (srchdomain == '') {
6476: checkok = 0;
1.571 raeburn 6477: msg += "$lt{'yomc'}\\n";
1.556 raeburn 6478: }
6479: }
6480: if (srchin == 'dom') {
6481: if (srchdomain == '') {
6482: checkok = 0;
1.571 raeburn 6483: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 6484: }
6485: }
6486: if (srchby == 'lastfirst') {
6487: if (srchterm.indexOf(",") == -1) {
6488: checkok = 0;
1.571 raeburn 6489: msg += "$lt{'whus'}\\n";
1.556 raeburn 6490: }
6491: if (srchterm.indexOf(",") == srchterm.length -1) {
6492: checkok = 0;
1.571 raeburn 6493: msg += "$lt{'whse'}\\n";
1.556 raeburn 6494: }
6495: }
6496: if (checkok == 0) {
1.571 raeburn 6497: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 6498: return;
6499: }
6500: if (checkok == 1) {
1.570 raeburn 6501: callingForm.submit();
1.556 raeburn 6502: }
6503: }
6504:
6505: $newuserscript
6506:
6507: </script>
1.558 albertel 6508:
6509: $new_user_create
6510:
1.555 raeburn 6511: <table>
1.558 albertel 6512: <tr>
1.573 raeburn 6513: <td>$lt{'doma'}:</td>
6514: <td>$domform</td>
6515: </td>
6516: </tr>
6517: <tr>
6518: <td>$lt{'usr'}:</td>
1.563 raeburn 6519: <td>$srchbysel
6520: $srchtypesel
6521: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 6522: $srchinsel
1.563 raeburn 6523: </td>
6524: </tr>
1.555 raeburn 6525: </table>
6526: <br />
6527: END_BLOCK
1.558 albertel 6528:
1.555 raeburn 6529: return $output;
6530: }
6531:
1.612 raeburn 6532: sub user_rule_check {
1.615 raeburn 6533: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 6534: my $response;
6535: if (ref($usershash) eq 'HASH') {
6536: foreach my $user (keys(%{$usershash})) {
6537: my ($uname,$udom) = split(/:/,$user);
6538: next if ($udom eq '' || $uname eq '');
1.615 raeburn 6539: my ($id,$newuser);
1.612 raeburn 6540: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 6541: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 6542: $id = $usershash->{$user}->{'id'};
6543: }
6544: my $inst_response;
6545: if (ref($checks) eq 'HASH') {
6546: if (defined($checks->{'username'})) {
1.615 raeburn 6547: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 6548: &Apache::lonnet::get_instuser($udom,$uname);
6549: } elsif (defined($checks->{'id'})) {
1.615 raeburn 6550: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 6551: &Apache::lonnet::get_instuser($udom,undef,$id);
6552: }
1.615 raeburn 6553: } else {
6554: ($inst_response,%{$inst_results->{$user}}) =
6555: &Apache::lonnet::get_instuser($udom,$uname);
6556: return;
1.612 raeburn 6557: }
1.615 raeburn 6558: if (!$got_rules->{$udom}) {
1.612 raeburn 6559: my %domconfig = &Apache::lonnet::get_dom('configuration',
6560: ['usercreation'],$udom);
6561: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 6562: foreach my $item ('username','id') {
1.612 raeburn 6563: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
6564: $$curr_rules{$udom}{$item} =
6565: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 6566: }
6567: }
6568: }
1.615 raeburn 6569: $got_rules->{$udom} = 1;
1.585 raeburn 6570: }
1.612 raeburn 6571: foreach my $item (keys(%{$checks})) {
6572: if (ref($$curr_rules{$udom}) eq 'HASH') {
6573: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
6574: if (@{$$curr_rules{$udom}{$item}} > 0) {
6575: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
6576: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
6577: if ($rule_check{$rule}) {
6578: $$rulematch{$user}{$item} = $rule;
6579: if ($inst_response eq 'ok') {
1.615 raeburn 6580: if (ref($inst_results) eq 'HASH') {
6581: if (ref($inst_results->{$user}) eq 'HASH') {
6582: if (keys(%{$inst_results->{$user}}) == 0) {
6583: $$alerts{$item}{$udom}{$uname} = 1;
6584: }
1.612 raeburn 6585: }
6586: }
1.615 raeburn 6587: }
6588: last;
1.585 raeburn 6589: }
6590: }
6591: }
6592: }
6593: }
6594: }
6595: }
6596: }
1.612 raeburn 6597: return;
6598: }
6599:
6600: sub user_rule_formats {
6601: my ($domain,$domdesc,$curr_rules,$check) = @_;
6602: my %text = (
6603: 'username' => 'Usernames',
6604: 'id' => 'IDs',
6605: );
6606: my $output;
6607: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
6608: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
6609: if (@{$ruleorder} > 0) {
6610: $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>';
6611: foreach my $rule (@{$ruleorder}) {
6612: if (ref($curr_rules) eq 'ARRAY') {
6613: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
6614: if (ref($rules->{$rule}) eq 'HASH') {
6615: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
6616: $rules->{$rule}{'desc'}.'</li>';
6617: }
6618: }
6619: }
6620: }
6621: $output .= '</ul>';
6622: }
6623: }
6624: return $output;
6625: }
6626:
6627: sub instrule_disallow_msg {
1.615 raeburn 6628: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 6629: my $response;
6630: my %text = (
6631: item => 'username',
6632: items => 'usernames',
6633: match => 'matches',
6634: do => 'does',
6635: action => 'a username',
6636: one => 'one',
6637: );
6638: if ($count > 1) {
6639: $text{'item'} = 'usernames';
6640: $text{'match'} ='match';
6641: $text{'do'} = 'do';
6642: $text{'action'} = 'usernames',
6643: $text{'one'} = 'ones';
6644: }
6645: if ($checkitem eq 'id') {
6646: $text{'items'} = 'IDs';
6647: $text{'item'} = 'ID';
6648: $text{'action'} = 'an ID';
1.615 raeburn 6649: if ($count > 1) {
6650: $text{'item'} = 'IDs';
6651: $text{'action'} = 'IDs';
6652: }
1.612 raeburn 6653: }
6654: $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 6655: if ($mode eq 'upload') {
6656: if ($checkitem eq 'username') {
6657: $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'}.");
6658: } elsif ($checkitem eq 'id') {
6659: $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.");
6660: }
6661: } else {
6662: if ($checkitem eq 'username') {
6663: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
6664: } elsif ($checkitem eq 'id') {
6665: $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.");
6666: }
1.612 raeburn 6667: }
6668: return $response;
1.585 raeburn 6669: }
6670:
1.624 raeburn 6671: sub personal_data_fieldtitles {
6672: my %fieldtitles = &Apache::lonlocal::texthash (
6673: id => 'Student/Employee ID',
6674: permanentemail => 'E-mail address',
6675: lastname => 'Last Name',
6676: firstname => 'First Name',
6677: middlename => 'Middle Name',
6678: generation => 'Generation',
6679: gen => 'Generation',
6680: );
6681: return %fieldtitles;
6682: }
6683:
1.112 bowersj2 6684: =pod
6685:
1.549 albertel 6686: =back
6687:
6688: =head1 HTTP Helpers
6689:
6690: =over 4
6691:
1.112 bowersj2 6692: =item * get_unprocessed_cgi($query,$possible_names)
6693:
1.258 albertel 6694: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 6695: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 6696: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 6697:
6698: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
6699: $possible_names is an ref to an array of form element names. As an example:
6700: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 6701: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 6702:
6703: =cut
1.1 albertel 6704:
1.6 albertel 6705: sub get_unprocessed_cgi {
1.25 albertel 6706: my ($query,$possible_names)= @_;
1.26 matthew 6707: # $Apache::lonxml::debug=1;
1.356 albertel 6708: foreach my $pair (split(/&/,$query)) {
6709: my ($name, $value) = split(/=/,$pair);
1.369 www 6710: $name = &unescape($name);
1.25 albertel 6711: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
6712: $value =~ tr/+/ /;
6713: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 6714: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 6715: }
1.16 harris41 6716: }
1.6 albertel 6717: }
6718:
1.112 bowersj2 6719: =pod
6720:
6721: =item * cacheheader()
6722:
6723: returns cache-controlling header code
6724:
6725: =cut
6726:
1.7 albertel 6727: sub cacheheader {
1.258 albertel 6728: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 6729: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
6730: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 6731: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
6732: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 6733: return $output;
1.7 albertel 6734: }
6735:
1.112 bowersj2 6736: =pod
6737:
6738: =item * no_cache($r)
6739:
6740: specifies header code to not have cache
6741:
6742: =cut
6743:
1.9 albertel 6744: sub no_cache {
1.216 albertel 6745: my ($r) = @_;
6746: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 6747: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 6748: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
6749: $r->no_cache(1);
6750: $r->header_out("Expires" => $date);
6751: $r->header_out("Pragma" => "no-cache");
1.123 www 6752: }
6753:
6754: sub content_type {
1.181 albertel 6755: my ($r,$type,$charset) = @_;
1.299 foxr 6756: if ($r) {
6757: # Note that printout.pl calls this with undef for $r.
6758: &no_cache($r);
6759: }
1.258 albertel 6760: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 6761: unless ($charset) {
6762: $charset=&Apache::lonlocal::current_encoding;
6763: }
6764: if ($charset) { $type.='; charset='.$charset; }
6765: if ($r) {
6766: $r->content_type($type);
6767: } else {
6768: print("Content-type: $type\n\n");
6769: }
1.9 albertel 6770: }
1.25 albertel 6771:
1.112 bowersj2 6772: =pod
6773:
6774: =item * add_to_env($name,$value)
6775:
1.258 albertel 6776: adds $name to the %env hash with value
1.112 bowersj2 6777: $value, if $name already exists, the entry is converted to an array
6778: reference and $value is added to the array.
6779:
6780: =cut
6781:
1.25 albertel 6782: sub add_to_env {
6783: my ($name,$value)=@_;
1.258 albertel 6784: if (defined($env{$name})) {
6785: if (ref($env{$name})) {
1.25 albertel 6786: #already have multiple values
1.258 albertel 6787: push(@{ $env{$name} },$value);
1.25 albertel 6788: } else {
6789: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 6790: my $first=$env{$name};
6791: undef($env{$name});
6792: push(@{ $env{$name} },$first,$value);
1.25 albertel 6793: }
6794: } else {
1.258 albertel 6795: $env{$name}=$value;
1.25 albertel 6796: }
1.31 albertel 6797: }
1.149 albertel 6798:
6799: =pod
6800:
6801: =item * get_env_multiple($name)
6802:
1.258 albertel 6803: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 6804: values may be defined and end up as an array ref.
6805:
6806: returns an array of values
6807:
6808: =cut
6809:
6810: sub get_env_multiple {
6811: my ($name) = @_;
6812: my @values;
1.258 albertel 6813: if (defined($env{$name})) {
1.149 albertel 6814: # exists is it an array
1.258 albertel 6815: if (ref($env{$name})) {
6816: @values=@{ $env{$name} };
1.149 albertel 6817: } else {
1.258 albertel 6818: $values[0]=$env{$name};
1.149 albertel 6819: }
6820: }
6821: return(@values);
6822: }
6823:
1.31 albertel 6824:
1.41 ng 6825: =pod
1.45 matthew 6826:
1.464 albertel 6827: =back
1.41 ng 6828:
1.112 bowersj2 6829: =head1 CSV Upload/Handling functions
1.38 albertel 6830:
1.41 ng 6831: =over 4
6832:
1.112 bowersj2 6833: =item * upfile_store($r)
1.41 ng 6834:
6835: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 6836: needs $env{'form.upfile'}
1.41 ng 6837: returns $datatoken to be put into hidden field
6838:
6839: =cut
1.31 albertel 6840:
6841: sub upfile_store {
6842: my $r=shift;
1.258 albertel 6843: $env{'form.upfile'}=~s/\r/\n/gs;
6844: $env{'form.upfile'}=~s/\f/\n/gs;
6845: $env{'form.upfile'}=~s/\n+/\n/gs;
6846: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 6847:
1.258 albertel 6848: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
6849: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 6850: {
1.158 raeburn 6851: my $datafile = $r->dir_config('lonDaemons').
6852: '/tmp/'.$datatoken.'.tmp';
6853: if ( open(my $fh,">$datafile") ) {
1.258 albertel 6854: print $fh $env{'form.upfile'};
1.158 raeburn 6855: close($fh);
6856: }
1.31 albertel 6857: }
6858: return $datatoken;
6859: }
6860:
1.56 matthew 6861: =pod
6862:
1.112 bowersj2 6863: =item * load_tmp_file($r)
1.41 ng 6864:
6865: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 6866: needs $env{'form.datatoken'},
6867: sets $env{'form.upfile'} to the contents of the file
1.41 ng 6868:
6869: =cut
1.31 albertel 6870:
6871: sub load_tmp_file {
6872: my $r=shift;
6873: my @studentdata=();
6874: {
1.158 raeburn 6875: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 6876: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 6877: if ( open(my $fh,"<$studentfile") ) {
6878: @studentdata=<$fh>;
6879: close($fh);
6880: }
1.31 albertel 6881: }
1.258 albertel 6882: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 6883: }
6884:
1.56 matthew 6885: =pod
6886:
1.112 bowersj2 6887: =item * upfile_record_sep()
1.41 ng 6888:
6889: Separate uploaded file into records
6890: returns array of records,
1.258 albertel 6891: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 6892:
6893: =cut
1.31 albertel 6894:
6895: sub upfile_record_sep {
1.258 albertel 6896: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 6897: } else {
1.248 albertel 6898: my @records;
1.258 albertel 6899: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 6900: if ($line=~/^\s*$/) { next; }
6901: push(@records,$line);
6902: }
6903: return @records;
1.31 albertel 6904: }
6905: }
6906:
1.56 matthew 6907: =pod
6908:
1.112 bowersj2 6909: =item * record_sep($record)
1.41 ng 6910:
1.258 albertel 6911: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 6912:
6913: =cut
6914:
1.263 www 6915: sub takeleft {
6916: my $index=shift;
6917: return substr('0000'.$index,-4,4);
6918: }
6919:
1.31 albertel 6920: sub record_sep {
6921: my $record=shift;
6922: my %components=();
1.258 albertel 6923: if ($env{'form.upfiletype'} eq 'xml') {
6924: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 6925: my $i=0;
1.356 albertel 6926: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 6927: $field=~s/^(\"|\')//;
6928: $field=~s/(\"|\')$//;
1.263 www 6929: $components{&takeleft($i)}=$field;
1.31 albertel 6930: $i++;
6931: }
1.258 albertel 6932: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 6933: my $i=0;
1.356 albertel 6934: foreach my $field (split(/\t/,$record)) {
1.31 albertel 6935: $field=~s/^(\"|\')//;
6936: $field=~s/(\"|\')$//;
1.263 www 6937: $components{&takeleft($i)}=$field;
1.31 albertel 6938: $i++;
6939: }
6940: } else {
1.561 www 6941: my $separator=',';
1.480 banghart 6942: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 6943: $separator=';';
1.480 banghart 6944: }
1.31 albertel 6945: my $i=0;
1.561 www 6946: # the character we are looking for to indicate the end of a quote or a record
6947: my $looking_for=$separator;
6948: # do not add the characters to the fields
6949: my $ignore=0;
6950: # we just encountered a separator (or the beginning of the record)
6951: my $just_found_separator=1;
6952: # store the field we are working on here
6953: my $field='';
6954: # work our way through all characters in record
6955: foreach my $character ($record=~/(.)/g) {
6956: if ($character eq $looking_for) {
6957: if ($character ne $separator) {
6958: # Found the end of a quote, again looking for separator
6959: $looking_for=$separator;
6960: $ignore=1;
6961: } else {
6962: # Found a separator, store away what we got
6963: $components{&takeleft($i)}=$field;
6964: $i++;
6965: $just_found_separator=1;
6966: $ignore=0;
6967: $field='';
6968: }
6969: next;
6970: }
6971: # single or double quotation marks after a separator indicate beginning of a quote
6972: # we are now looking for the end of the quote and need to ignore separators
6973: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
6974: $looking_for=$character;
6975: next;
6976: }
6977: # ignore would be true after we reached the end of a quote
6978: if ($ignore) { next; }
6979: if (($just_found_separator) && ($character=~/\s/)) { next; }
6980: $field.=$character;
6981: $just_found_separator=0;
1.31 albertel 6982: }
1.561 www 6983: # catch the very last entry, since we never encountered the separator
6984: $components{&takeleft($i)}=$field;
1.31 albertel 6985: }
6986: return %components;
6987: }
6988:
1.144 matthew 6989: ######################################################
6990: ######################################################
6991:
1.56 matthew 6992: =pod
6993:
1.112 bowersj2 6994: =item * upfile_select_html()
1.41 ng 6995:
1.144 matthew 6996: Return HTML code to select a file from the users machine and specify
6997: the file type.
1.41 ng 6998:
6999: =cut
7000:
1.144 matthew 7001: ######################################################
7002: ######################################################
1.31 albertel 7003: sub upfile_select_html {
1.144 matthew 7004: my %Types = (
7005: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7006: semisv => &mt('Semicolon separated values'),
1.144 matthew 7007: space => &mt('Space separated'),
7008: tab => &mt('Tabulator separated'),
7009: # xml => &mt('HTML/XML'),
7010: );
7011: my $Str = '<input type="file" name="upfile" size="50" />'.
7012: '<br />Type: <select name="upfiletype">';
7013: foreach my $type (sort(keys(%Types))) {
7014: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7015: }
7016: $Str .= "</select>\n";
7017: return $Str;
1.31 albertel 7018: }
7019:
1.301 albertel 7020: sub get_samples {
7021: my ($records,$toget) = @_;
7022: my @samples=({});
7023: my $got=0;
7024: foreach my $rec (@$records) {
7025: my %temp = &record_sep($rec);
7026: if (! grep(/\S/, values(%temp))) { next; }
7027: if (%temp) {
7028: $samples[$got]=\%temp;
7029: $got++;
7030: if ($got == $toget) { last; }
7031: }
7032: }
7033: return \@samples;
7034: }
7035:
1.144 matthew 7036: ######################################################
7037: ######################################################
7038:
1.56 matthew 7039: =pod
7040:
1.112 bowersj2 7041: =item * csv_print_samples($r,$records)
1.41 ng 7042:
7043: Prints a table of sample values from each column uploaded $r is an
7044: Apache Request ref, $records is an arrayref from
7045: &Apache::loncommon::upfile_record_sep
7046:
7047: =cut
7048:
1.144 matthew 7049: ######################################################
7050: ######################################################
1.31 albertel 7051: sub csv_print_samples {
7052: my ($r,$records) = @_;
1.301 albertel 7053: my $samples = &get_samples($records,3);
7054:
1.594 raeburn 7055: $r->print(&mt('Samples').'<br />'.&start_data_table().
7056: &start_data_table_header_row());
1.356 albertel 7057: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7058: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7059: $r->print(&end_data_table_header_row());
1.301 albertel 7060: foreach my $hash (@$samples) {
1.594 raeburn 7061: $r->print(&start_data_table_row());
1.356 albertel 7062: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7063: $r->print('<td>');
1.356 albertel 7064: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7065: $r->print('</td>');
7066: }
1.594 raeburn 7067: $r->print(&end_data_table_row());
1.31 albertel 7068: }
1.594 raeburn 7069: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7070: }
7071:
1.144 matthew 7072: ######################################################
7073: ######################################################
7074:
1.56 matthew 7075: =pod
7076:
1.112 bowersj2 7077: =item * csv_print_select_table($r,$records,$d)
1.41 ng 7078:
7079: Prints a table to create associations between values and table columns.
1.144 matthew 7080:
1.41 ng 7081: $r is an Apache Request ref,
7082: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7083: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7084:
7085: =cut
7086:
1.144 matthew 7087: ######################################################
7088: ######################################################
1.31 albertel 7089: sub csv_print_select_table {
7090: my ($r,$records,$d) = @_;
1.301 albertel 7091: my $i=0;
7092: my $samples = &get_samples($records,1);
1.144 matthew 7093: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7094: &start_data_table().&start_data_table_header_row().
1.144 matthew 7095: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7096: '<th>'.&mt('Column').'</th>'.
7097: &end_data_table_header_row()."\n");
1.356 albertel 7098: foreach my $array_ref (@$d) {
7099: my ($value,$display,$defaultcol)=@{ $array_ref };
1.594 raeburn 7100: $r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');
1.31 albertel 7101:
7102: $r->print('<td><select name=f'.$i.
1.32 matthew 7103: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7104: $r->print('<option value="none"></option>');
1.356 albertel 7105: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7106: $r->print('<option value="'.$sample.'"'.
7107: ($sample eq $defaultcol ? ' selected="selected" ' : '').
7108: '>Column '.($sample+1).'</option>');
1.31 albertel 7109: }
1.594 raeburn 7110: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7111: $i++;
7112: }
1.594 raeburn 7113: $r->print(&end_data_table());
1.31 albertel 7114: $i--;
7115: return $i;
7116: }
1.56 matthew 7117:
1.144 matthew 7118: ######################################################
7119: ######################################################
7120:
1.56 matthew 7121: =pod
1.31 albertel 7122:
1.112 bowersj2 7123: =item * csv_samples_select_table($r,$records,$d)
1.41 ng 7124:
7125: Prints a table of sample values from the upload and can make associate samples to internal names.
7126:
7127: $r is an Apache Request ref,
7128: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7129: $d is an array of 2 element arrays (internal name, displayed name)
7130:
7131: =cut
7132:
1.144 matthew 7133: ######################################################
7134: ######################################################
1.31 albertel 7135: sub csv_samples_select_table {
7136: my ($r,$records,$d) = @_;
7137: my $i=0;
1.144 matthew 7138: #
1.301 albertel 7139: my $samples = &get_samples($records,3);
1.594 raeburn 7140: $r->print(&start_data_table().
7141: &start_data_table_header_row().'<th>'.
7142: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
7143: &end_data_table_header_row());
1.301 albertel 7144:
7145: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 7146: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 7147: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 7148: foreach my $option (@$d) {
7149: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 7150: $r->print('<option value="'.$value.'"'.
1.253 albertel 7151: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 7152: $display.'</option>');
1.31 albertel 7153: }
7154: $r->print('</select></td><td>');
1.301 albertel 7155: foreach my $line (0..2) {
7156: if (defined($samples->[$line]{$key})) {
7157: $r->print($samples->[$line]{$key}."<br />\n");
7158: }
7159: }
1.594 raeburn 7160: $r->print('</td>'.&end_data_table_row());
1.31 albertel 7161: $i++;
7162: }
1.594 raeburn 7163: $r->print(&end_data_table());
1.31 albertel 7164: $i--;
7165: return($i);
1.115 matthew 7166: }
7167:
1.144 matthew 7168: ######################################################
7169: ######################################################
7170:
1.115 matthew 7171: =pod
7172:
7173: =item clean_excel_name($name)
7174:
7175: Returns a replacement for $name which does not contain any illegal characters.
7176:
7177: =cut
7178:
1.144 matthew 7179: ######################################################
7180: ######################################################
1.115 matthew 7181: sub clean_excel_name {
7182: my ($name) = @_;
7183: $name =~ s/[:\*\?\/\\]//g;
7184: if (length($name) > 31) {
7185: $name = substr($name,0,31);
7186: }
7187: return $name;
1.25 albertel 7188: }
1.84 albertel 7189:
1.85 albertel 7190: =pod
7191:
1.112 bowersj2 7192: =item * check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 7193:
7194: Returns either 1 or undef
7195:
7196: 1 if the part is to be hidden, undef if it is to be shown
7197:
7198: Arguments are:
7199:
7200: $id the id of the part to be checked
7201: $symb, optional the symb of the resource to check
7202: $udom, optional the domain of the user to check for
7203: $uname, optional the username of the user to check for
7204:
7205: =cut
1.84 albertel 7206:
7207: sub check_if_partid_hidden {
7208: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 7209: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 7210: $symb,$udom,$uname);
1.141 albertel 7211: my $truth=1;
7212: #if the string starts with !, then the list is the list to show not hide
7213: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 7214: my @hiddenlist=split(/,/,$hiddenparts);
7215: foreach my $checkid (@hiddenlist) {
1.141 albertel 7216: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 7217: }
1.141 albertel 7218: return !$truth;
1.84 albertel 7219: }
1.127 matthew 7220:
1.138 matthew 7221:
7222: ############################################################
7223: ############################################################
7224:
7225: =pod
7226:
1.157 matthew 7227: =back
7228:
1.138 matthew 7229: =head1 cgi-bin script and graphing routines
7230:
1.157 matthew 7231: =over 4
7232:
1.138 matthew 7233: =item get_cgi_id
7234:
7235: Inputs: none
7236:
7237: Returns an id which can be used to pass environment variables
7238: to various cgi-bin scripts. These environment variables will
7239: be removed from the users environment after a given time by
7240: the routine &Apache::lonnet::transfer_profile_to_env.
7241:
7242: =cut
7243:
7244: ############################################################
7245: ############################################################
1.152 albertel 7246: my $uniq=0;
1.136 matthew 7247: sub get_cgi_id {
1.154 albertel 7248: $uniq=($uniq+1)%100000;
1.280 albertel 7249: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 7250: }
7251:
1.127 matthew 7252: ############################################################
7253: ############################################################
7254:
7255: =pod
7256:
1.134 matthew 7257: =item DrawBarGraph
1.127 matthew 7258:
1.138 matthew 7259: Facilitates the plotting of data in a (stacked) bar graph.
7260: Puts plot definition data into the users environment in order for
7261: graph.png to plot it. Returns an <img> tag for the plot.
7262: The bars on the plot are labeled '1','2',...,'n'.
7263:
7264: Inputs:
7265:
7266: =over 4
7267:
7268: =item $Title: string, the title of the plot
7269:
7270: =item $xlabel: string, text describing the X-axis of the plot
7271:
7272: =item $ylabel: string, text describing the Y-axis of the plot
7273:
7274: =item $Max: scalar, the maximum Y value to use in the plot
7275: If $Max is < any data point, the graph will not be rendered.
7276:
1.140 matthew 7277: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 7278: they are plotted. If undefined, default values will be used.
7279:
1.178 matthew 7280: =item $labels: array ref holding the labels to use on the x-axis for the bars.
7281:
1.138 matthew 7282: =item @Values: An array of array references. Each array reference holds data
7283: to be plotted in a stacked bar chart.
7284:
1.239 matthew 7285: =item If the final element of @Values is a hash reference the key/value
7286: pairs will be added to the graph definition.
7287:
1.138 matthew 7288: =back
7289:
7290: Returns:
7291:
7292: An <img> tag which references graph.png and the appropriate identifying
7293: information for the plot.
7294:
1.127 matthew 7295: =cut
7296:
7297: ############################################################
7298: ############################################################
1.134 matthew 7299: sub DrawBarGraph {
1.178 matthew 7300: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 7301: #
7302: if (! defined($colors)) {
7303: $colors = ['#33ff00',
7304: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
7305: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
7306: ];
7307: }
1.228 matthew 7308: my $extra_settings = {};
7309: if (ref($Values[-1]) eq 'HASH') {
7310: $extra_settings = pop(@Values);
7311: }
1.127 matthew 7312: #
1.136 matthew 7313: my $identifier = &get_cgi_id();
7314: my $id = 'cgi.'.$identifier;
1.129 matthew 7315: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 7316: return '';
7317: }
1.225 matthew 7318: #
7319: my @Labels;
7320: if (defined($labels)) {
7321: @Labels = @$labels;
7322: } else {
7323: for (my $i=0;$i<@{$Values[0]};$i++) {
7324: push (@Labels,$i+1);
7325: }
7326: }
7327: #
1.129 matthew 7328: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 7329: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 7330: my %ValuesHash;
7331: my $NumSets=1;
7332: foreach my $array (@Values) {
7333: next if (! ref($array));
1.136 matthew 7334: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 7335: join(',',@$array);
1.129 matthew 7336: }
1.127 matthew 7337: #
1.136 matthew 7338: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 7339: if ($NumBars < 3) {
7340: $width = 120+$NumBars*32;
1.220 matthew 7341: $xskip = 1;
1.225 matthew 7342: $bar_width = 30;
7343: } elsif ($NumBars < 5) {
7344: $width = 120+$NumBars*20;
7345: $xskip = 1;
7346: $bar_width = 20;
1.220 matthew 7347: } elsif ($NumBars < 10) {
1.136 matthew 7348: $width = 120+$NumBars*15;
7349: $xskip = 1;
7350: $bar_width = 15;
7351: } elsif ($NumBars <= 25) {
7352: $width = 120+$NumBars*11;
7353: $xskip = 5;
7354: $bar_width = 8;
7355: } elsif ($NumBars <= 50) {
7356: $width = 120+$NumBars*8;
7357: $xskip = 5;
7358: $bar_width = 4;
7359: } else {
7360: $width = 120+$NumBars*8;
7361: $xskip = 5;
7362: $bar_width = 4;
7363: }
7364: #
1.137 matthew 7365: $Max = 1 if ($Max < 1);
7366: if ( int($Max) < $Max ) {
7367: $Max++;
7368: $Max = int($Max);
7369: }
1.127 matthew 7370: $Title = '' if (! defined($Title));
7371: $xlabel = '' if (! defined($xlabel));
7372: $ylabel = '' if (! defined($ylabel));
1.369 www 7373: $ValuesHash{$id.'.title'} = &escape($Title);
7374: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
7375: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 7376: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 7377: $ValuesHash{$id.'.NumBars'} = $NumBars;
7378: $ValuesHash{$id.'.NumSets'} = $NumSets;
7379: $ValuesHash{$id.'.PlotType'} = 'bar';
7380: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7381: $ValuesHash{$id.'.height'} = $height;
7382: $ValuesHash{$id.'.width'} = $width;
7383: $ValuesHash{$id.'.xskip'} = $xskip;
7384: $ValuesHash{$id.'.bar_width'} = $bar_width;
7385: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 7386: #
1.228 matthew 7387: # Deal with other parameters
7388: while (my ($key,$value) = each(%$extra_settings)) {
7389: $ValuesHash{$id.'.'.$key} = $value;
7390: }
7391: #
1.137 matthew 7392: &Apache::lonnet::appenv(%ValuesHash);
7393: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
7394: }
7395:
7396: ############################################################
7397: ############################################################
7398:
7399: =pod
7400:
7401: =item DrawXYGraph
7402:
1.138 matthew 7403: Facilitates the plotting of data in an XY graph.
7404: Puts plot definition data into the users environment in order for
7405: graph.png to plot it. Returns an <img> tag for the plot.
7406:
7407: Inputs:
7408:
7409: =over 4
7410:
7411: =item $Title: string, the title of the plot
7412:
7413: =item $xlabel: string, text describing the X-axis of the plot
7414:
7415: =item $ylabel: string, text describing the Y-axis of the plot
7416:
7417: =item $Max: scalar, the maximum Y value to use in the plot
7418: If $Max is < any data point, the graph will not be rendered.
7419:
7420: =item $colors: Array ref containing the hex color codes for the data to be
7421: plotted in. If undefined, default values will be used.
7422:
7423: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
7424:
7425: =item $Ydata: Array ref containing Array refs.
1.185 www 7426: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 7427:
7428: =item %Values: hash indicating or overriding any default values which are
7429: passed to graph.png.
7430: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
7431:
7432: =back
7433:
7434: Returns:
7435:
7436: An <img> tag which references graph.png and the appropriate identifying
7437: information for the plot.
7438:
1.137 matthew 7439: =cut
7440:
7441: ############################################################
7442: ############################################################
7443: sub DrawXYGraph {
7444: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
7445: #
7446: # Create the identifier for the graph
7447: my $identifier = &get_cgi_id();
7448: my $id = 'cgi.'.$identifier;
7449: #
7450: $Title = '' if (! defined($Title));
7451: $xlabel = '' if (! defined($xlabel));
7452: $ylabel = '' if (! defined($ylabel));
7453: my %ValuesHash =
7454: (
1.369 www 7455: $id.'.title' => &escape($Title),
7456: $id.'.xlabel' => &escape($xlabel),
7457: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 7458: $id.'.y_max_value'=> $Max,
7459: $id.'.labels' => join(',',@$Xlabels),
7460: $id.'.PlotType' => 'XY',
7461: );
7462: #
7463: if (defined($colors) && ref($colors) eq 'ARRAY') {
7464: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7465: }
7466: #
7467: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
7468: return '';
7469: }
7470: my $NumSets=1;
1.138 matthew 7471: foreach my $array (@{$Ydata}){
1.137 matthew 7472: next if (! ref($array));
7473: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
7474: }
1.138 matthew 7475: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 7476: #
7477: # Deal with other parameters
7478: while (my ($key,$value) = each(%Values)) {
7479: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 7480: }
7481: #
1.136 matthew 7482: &Apache::lonnet::appenv(%ValuesHash);
7483: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
7484: }
7485:
7486: ############################################################
7487: ############################################################
7488:
7489: =pod
7490:
1.138 matthew 7491: =item DrawXYYGraph
7492:
7493: Facilitates the plotting of data in an XY graph with two Y axes.
7494: Puts plot definition data into the users environment in order for
7495: graph.png to plot it. Returns an <img> tag for the plot.
7496:
7497: Inputs:
7498:
7499: =over 4
7500:
7501: =item $Title: string, the title of the plot
7502:
7503: =item $xlabel: string, text describing the X-axis of the plot
7504:
7505: =item $ylabel: string, text describing the Y-axis of the plot
7506:
7507: =item $colors: Array ref containing the hex color codes for the data to be
7508: plotted in. If undefined, default values will be used.
7509:
7510: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
7511:
7512: =item $Ydata1: The first data set
7513:
7514: =item $Min1: The minimum value of the left Y-axis
7515:
7516: =item $Max1: The maximum value of the left Y-axis
7517:
7518: =item $Ydata2: The second data set
7519:
7520: =item $Min2: The minimum value of the right Y-axis
7521:
7522: =item $Max2: The maximum value of the left Y-axis
7523:
7524: =item %Values: hash indicating or overriding any default values which are
7525: passed to graph.png.
7526: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
7527:
7528: =back
7529:
7530: Returns:
7531:
7532: An <img> tag which references graph.png and the appropriate identifying
7533: information for the plot.
1.136 matthew 7534:
7535: =cut
7536:
7537: ############################################################
7538: ############################################################
1.137 matthew 7539: sub DrawXYYGraph {
7540: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
7541: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 7542: #
7543: # Create the identifier for the graph
7544: my $identifier = &get_cgi_id();
7545: my $id = 'cgi.'.$identifier;
7546: #
7547: $Title = '' if (! defined($Title));
7548: $xlabel = '' if (! defined($xlabel));
7549: $ylabel = '' if (! defined($ylabel));
7550: my %ValuesHash =
7551: (
1.369 www 7552: $id.'.title' => &escape($Title),
7553: $id.'.xlabel' => &escape($xlabel),
7554: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 7555: $id.'.labels' => join(',',@$Xlabels),
7556: $id.'.PlotType' => 'XY',
7557: $id.'.NumSets' => 2,
1.137 matthew 7558: $id.'.two_axes' => 1,
7559: $id.'.y1_max_value' => $Max1,
7560: $id.'.y1_min_value' => $Min1,
7561: $id.'.y2_max_value' => $Max2,
7562: $id.'.y2_min_value' => $Min2,
1.136 matthew 7563: );
7564: #
1.137 matthew 7565: if (defined($colors) && ref($colors) eq 'ARRAY') {
7566: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7567: }
7568: #
7569: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
7570: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 7571: return '';
7572: }
7573: my $NumSets=1;
1.137 matthew 7574: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 7575: next if (! ref($array));
7576: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 7577: }
7578: #
7579: # Deal with other parameters
7580: while (my ($key,$value) = each(%Values)) {
7581: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 7582: }
7583: #
7584: &Apache::lonnet::appenv(%ValuesHash);
1.130 albertel 7585: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 7586: }
7587:
7588: ############################################################
7589: ############################################################
7590:
7591: =pod
7592:
1.157 matthew 7593: =back
7594:
1.139 matthew 7595: =head1 Statistics helper routines?
7596:
7597: Bad place for them but what the hell.
7598:
1.157 matthew 7599: =over 4
7600:
1.139 matthew 7601: =item &chartlink
7602:
7603: Returns a link to the chart for a specific student.
7604:
7605: Inputs:
7606:
7607: =over 4
7608:
7609: =item $linktext: The text of the link
7610:
7611: =item $sname: The students username
7612:
7613: =item $sdomain: The students domain
7614:
7615: =back
7616:
1.157 matthew 7617: =back
7618:
1.139 matthew 7619: =cut
7620:
7621: ############################################################
7622: ############################################################
7623: sub chartlink {
7624: my ($linktext, $sname, $sdomain) = @_;
7625: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 7626: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 7627: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 7628: '">'.$linktext.'</a>';
1.153 matthew 7629: }
7630:
7631: #######################################################
7632: #######################################################
7633:
7634: =pod
7635:
7636: =head1 Course Environment Routines
1.157 matthew 7637:
7638: =over 4
1.153 matthew 7639:
7640: =item &restore_course_settings
7641:
7642: =item &store_course_settings
7643:
7644: Restores/Store indicated form parameters from the course environment.
7645: Will not overwrite existing values of the form parameters.
7646:
7647: Inputs:
7648: a scalar describing the data (e.g. 'chart', 'problem_analysis')
7649:
7650: a hash ref describing the data to be stored. For example:
7651:
7652: %Save_Parameters = ('Status' => 'scalar',
7653: 'chartoutputmode' => 'scalar',
7654: 'chartoutputdata' => 'scalar',
7655: 'Section' => 'array',
1.373 raeburn 7656: 'Group' => 'array',
1.153 matthew 7657: 'StudentData' => 'array',
7658: 'Maps' => 'array');
7659:
7660: Returns: both routines return nothing
7661:
1.631 raeburn 7662: =back
7663:
1.153 matthew 7664: =cut
7665:
7666: #######################################################
7667: #######################################################
7668: sub store_course_settings {
1.496 albertel 7669: return &store_settings($env{'request.course.id'},@_);
7670: }
7671:
7672: sub store_settings {
1.153 matthew 7673: # save to the environment
7674: # appenv the same items, just to be safe
1.300 albertel 7675: my $udom = $env{'user.domain'};
7676: my $uname = $env{'user.name'};
1.496 albertel 7677: my ($context,$prefix,$Settings) = @_;
1.153 matthew 7678: my %SaveHash;
7679: my %AppHash;
7680: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 7681: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 7682: my $envname = 'environment.'.$basename;
1.258 albertel 7683: if (exists($env{'form.'.$setting})) {
1.153 matthew 7684: # Save this value away
7685: if ($type eq 'scalar' &&
1.258 albertel 7686: (! exists($env{$envname}) ||
7687: $env{$envname} ne $env{'form.'.$setting})) {
7688: $SaveHash{$basename} = $env{'form.'.$setting};
7689: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 7690: } elsif ($type eq 'array') {
7691: my $stored_form;
1.258 albertel 7692: if (ref($env{'form.'.$setting})) {
1.153 matthew 7693: $stored_form = join(',',
7694: map {
1.369 www 7695: &escape($_);
1.258 albertel 7696: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 7697: } else {
7698: $stored_form =
1.369 www 7699: &escape($env{'form.'.$setting});
1.153 matthew 7700: }
7701: # Determine if the array contents are the same.
1.258 albertel 7702: if ($stored_form ne $env{$envname}) {
1.153 matthew 7703: $SaveHash{$basename} = $stored_form;
7704: $AppHash{$envname} = $stored_form;
7705: }
7706: }
7707: }
7708: }
7709: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 7710: $udom,$uname);
1.153 matthew 7711: if ($put_result !~ /^(ok|delayed)/) {
7712: &Apache::lonnet::logthis('unable to save form parameters, '.
7713: 'got error:'.$put_result);
7714: }
7715: # Make sure these settings stick around in this session, too
7716: &Apache::lonnet::appenv(%AppHash);
7717: return;
7718: }
7719:
7720: sub restore_course_settings {
1.499 albertel 7721: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 7722: }
7723:
7724: sub restore_settings {
7725: my ($context,$prefix,$Settings) = @_;
1.153 matthew 7726: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 7727: next if (exists($env{'form.'.$setting}));
1.496 albertel 7728: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 7729: '.'.$setting;
1.258 albertel 7730: if (exists($env{$envname})) {
1.153 matthew 7731: if ($type eq 'scalar') {
1.258 albertel 7732: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 7733: } elsif ($type eq 'array') {
1.258 albertel 7734: $env{'form.'.$setting} = [
1.153 matthew 7735: map {
1.369 www 7736: &unescape($_);
1.258 albertel 7737: } split(',',$env{$envname})
1.153 matthew 7738: ];
7739: }
7740: }
7741: }
1.127 matthew 7742: }
7743:
1.618 raeburn 7744: #######################################################
7745: #######################################################
7746:
7747: =pod
7748:
7749: =head1 Domain E-mail Routines
7750:
7751: =over 4
7752:
7753: =item &build_recipient_list
7754:
7755: Build recipient lists for three types of e-mail:
7756: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 7757: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 7758:
7759: Inputs:
1.619 raeburn 7760: defmail (scalar - email address of default recipient),
1.618 raeburn 7761: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 7762: defdom (domain for which to retrieve configuration settings),
7763: origmail (scalar - email address of recipient from loncapa.conf,
7764: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 7765:
7766: Returns: comma separated list of addresses to which to send e-mail.
7767:
7768: =cut
7769:
7770: ############################################################
7771: ############################################################
7772: sub build_recipient_list {
1.619 raeburn 7773: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 7774: my @recipients;
7775: my $otheremails;
7776: my %domconfig =
7777: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
7778: if (ref($domconfig{'contacts'}) eq 'HASH') {
7779: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
7780: my @contacts = ('adminemail','supportemail');
7781: foreach my $item (@contacts) {
7782: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 7783: my $addr = $domconfig{'contacts'}{$item};
7784: if (!grep(/^\Q$addr\E$/,@recipients)) {
7785: push(@recipients,$addr);
7786: }
1.618 raeburn 7787: }
7788: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
7789: }
7790: }
1.619 raeburn 7791: } elsif ($origmail ne '') {
7792: push(@recipients,$origmail);
1.618 raeburn 7793: }
7794: if ($defmail ne '') {
7795: push(@recipients,$defmail);
7796: }
7797: if ($otheremails) {
1.619 raeburn 7798: my @others;
7799: if ($otheremails =~ /,/) {
7800: @others = split(/,/,$otheremails);
1.618 raeburn 7801: } else {
1.619 raeburn 7802: push(@others,$otheremails);
7803: }
7804: foreach my $addr (@others) {
7805: if (!grep(/^\Q$addr\E$/,@recipients)) {
7806: push(@recipients,$addr);
7807: }
1.618 raeburn 7808: }
7809: }
1.619 raeburn 7810: my $recipientlist = join(',',@recipients);
1.618 raeburn 7811: return $recipientlist;
7812: }
7813:
1.127 matthew 7814: ############################################################
7815: ############################################################
1.154 albertel 7816:
1.443 albertel 7817: sub commit_customrole {
7818: my ($udom,$uname,$url,$three,$four,$five,$start,$end) = @_;
1.630 raeburn 7819: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 7820: ($start?', '.&mt('starting').' '.localtime($start):'').
7821: ($end?', ending '.localtime($end):'').': <b>'.
7822: &Apache::lonnet::assigncustomrole(
7823: $udom,$uname,$url,$three,$four,$five,$end,$start).
7824: '</b><br />';
7825: return $output;
7826: }
7827:
7828: sub commit_standardrole {
1.541 raeburn 7829: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
7830: my ($output,$logmsg,$linefeed);
7831: if ($context eq 'auto') {
7832: $linefeed = "\n";
7833: } else {
7834: $linefeed = "<br />\n";
7835: }
1.443 albertel 7836: if ($three eq 'st') {
1.541 raeburn 7837: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
7838: $one,$two,$sec,$context);
7839: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 7840: ($result eq 'unknown_course') || ($result eq 'refused')) {
7841: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 7842: } else {
1.541 raeburn 7843: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 7844: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 7845: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
7846: if ($context eq 'auto') {
7847: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
7848: } else {
7849: $output .= '<b>'.$result.'</b>'.$linefeed.
7850: &mt('Add to classlist').': <b>ok</b>';
7851: }
7852: $output .= $linefeed;
1.443 albertel 7853: }
7854: } else {
7855: $output = &mt('Assigning').' '.$three.' in '.$url.
7856: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 7857: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
7858: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start);
7859: if ($context eq 'auto') {
7860: $output .= $result.$linefeed;
7861: } else {
7862: $output .= '<b>'.$result.'</b>'.$linefeed;
7863: }
1.443 albertel 7864: }
7865: return $output;
7866: }
7867:
7868: sub commit_studentrole {
1.541 raeburn 7869: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 7870: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 7871: if ($context eq 'auto') {
7872: $linefeed = "\n";
7873: } else {
7874: $linefeed = '<br />'."\n";
7875: }
1.443 albertel 7876: if (defined($one) && defined($two)) {
7877: my $cid=$one.'_'.$two;
7878: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
7879: my $secchange = 0;
7880: my $expire_role_result;
7881: my $modify_section_result;
1.628 raeburn 7882: if ($oldsec ne '-1') {
7883: if ($oldsec ne $sec) {
1.443 albertel 7884: $secchange = 1;
1.628 raeburn 7885: my $now = time;
1.443 albertel 7886: my $uurl='/'.$cid;
7887: $uurl=~s/\_/\//g;
7888: if ($oldsec) {
7889: $uurl.='/'.$oldsec;
7890: }
1.626 raeburn 7891: $oldsecurl = $uurl;
1.628 raeburn 7892: $expire_role_result =
7893: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now);
7894: if ($env{'request.course.sec'} ne '') {
7895: if ($expire_role_result eq 'refused') {
7896: my @roles = ('st');
7897: my @statuses = ('previous');
7898: my @roledoms = ($one);
7899: my $withsec = 1;
7900: my %roleshash =
7901: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
7902: \@statuses,\@roles,\@roledoms,$withsec);
7903: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
7904: my ($oldstart,$oldend) =
7905: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
7906: if ($oldend > 0 && $oldend <= $now) {
7907: $expire_role_result = 'ok';
7908: }
7909: }
7910: }
7911: }
1.443 albertel 7912: $result = $expire_role_result;
7913: }
7914: }
7915: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
7916: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid);
7917: if ($modify_section_result =~ /^ok/) {
7918: if ($secchange == 1) {
1.628 raeburn 7919: if ($sec eq '') {
7920: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
7921: } else {
7922: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
7923: }
1.443 albertel 7924: } elsif ($oldsec eq '-1') {
1.628 raeburn 7925: if ($sec eq '') {
7926: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
7927: } else {
7928: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
7929: }
1.443 albertel 7930: } else {
1.628 raeburn 7931: if ($sec eq '') {
7932: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
7933: } else {
7934: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
7935: }
1.443 albertel 7936: }
7937: } else {
1.628 raeburn 7938: if ($secchange) {
7939: $$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;
7940: } else {
7941: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
7942: }
1.443 albertel 7943: }
7944: $result = $modify_section_result;
7945: } elsif ($secchange == 1) {
1.628 raeburn 7946: if ($oldsec eq '') {
7947: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
7948: } else {
7949: $$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;
7950: }
1.626 raeburn 7951: if ($expire_role_result eq 'refused') {
7952: my $newsecurl = '/'.$cid;
7953: $newsecurl =~ s/\_/\//g;
7954: if ($sec ne '') {
7955: $newsecurl.='/'.$sec;
7956: }
7957: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
7958: if ($sec eq '') {
7959: $$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;
7960: } else {
7961: $$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;
7962: }
7963: }
7964: }
1.443 albertel 7965: }
7966: } else {
1.626 raeburn 7967: $$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 7968: $result = "error: incomplete course id\n";
7969: }
7970: return $result;
7971: }
7972:
7973: ############################################################
7974: ############################################################
7975:
1.566 albertel 7976: sub check_clone {
1.578 raeburn 7977: my ($args,$linefeed) = @_;
1.566 albertel 7978: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
7979: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
7980: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
7981: my $clonemsg;
7982: my $can_clone = 0;
7983:
7984: if ($clonehome eq 'no_host') {
1.578 raeburn 7985: $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 7986: } else {
7987: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 7988: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 7989: $can_clone = 1;
7990: } else {
7991: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
7992: $args->{'clonedomain'},$args->{'clonecourse'});
7993: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 7994: if (grep(/^\*$/,@cloners)) {
7995: $can_clone = 1;
7996: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
7997: $can_clone = 1;
7998: } else {
7999: my %roleshash =
8000: &Apache::lonnet::get_my_roles($args->{'ccuname'},
8001: $args->{'ccdomain'},
8002: 'userroles',['active'],['cc'],
8003: [$args->{'clonedomain'}]);
8004: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
8005: $can_clone = 1;
8006: } else {
8007: $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'});
8008: }
1.566 albertel 8009: }
1.578 raeburn 8010: }
1.566 albertel 8011: }
8012: return ($can_clone, $clonemsg, $cloneid, $clonehome);
8013: }
8014:
1.444 albertel 8015: sub construct_course {
1.541 raeburn 8016: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 8017: my $outcome;
1.541 raeburn 8018: my $linefeed = '<br />'."\n";
8019: if ($context eq 'auto') {
8020: $linefeed = "\n";
8021: }
1.566 albertel 8022:
8023: #
8024: # Are we cloning?
8025: #
8026: my ($can_clone, $clonemsg, $cloneid, $clonehome);
8027: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 8028: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 8029: if ($context ne 'auto') {
1.578 raeburn 8030: if ($clonemsg ne '') {
8031: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
8032: }
1.566 albertel 8033: }
8034: $outcome .= $clonemsg.$linefeed;
8035:
8036: if (!$can_clone) {
8037: return (0,$outcome);
8038: }
8039: }
8040:
1.444 albertel 8041: #
8042: # Open course
8043: #
8044: my $crstype = lc($args->{'crstype'});
8045: my %cenv=();
8046: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
8047: $args->{'cdescr'},
8048: $args->{'curl'},
8049: $args->{'course_home'},
8050: $args->{'nonstandard'},
8051: $args->{'crscode'},
8052: $args->{'ccuname'}.':'.
8053: $args->{'ccdomain'},
8054: $args->{'crstype'});
8055:
8056: # Note: The testing routines depend on this being output; see
8057: # Utils::Course. This needs to at least be output as a comment
8058: # if anyone ever decides to not show this, and Utils::Course::new
8059: # will need to be suitably modified.
1.541 raeburn 8060: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 8061: #
8062: # Check if created correctly
8063: #
1.479 albertel 8064: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 8065: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 8066: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 8067:
1.444 albertel 8068: #
1.566 albertel 8069: # Do the cloning
8070: #
8071: if ($can_clone && $cloneid) {
8072: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
8073: if ($context ne 'auto') {
8074: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
8075: }
8076: $outcome .= $clonemsg.$linefeed;
8077: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 8078: # Copy all files
1.566 albertel 8079: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid);
1.444 albertel 8080: # Restore URL
1.566 albertel 8081: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 8082: # Restore title
1.566 albertel 8083: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 8084: # restore grading mode
1.566 albertel 8085: if (defined($oldcenv{'grading'})) {
8086: $cenv{'grading'}=$oldcenv{'grading'};
8087: }
1.444 albertel 8088: # Mark as cloned
1.566 albertel 8089: $cenv{'clonedfrom'}=$cloneid;
8090: delete($cenv{'default_enrollment_start_date'});
8091: delete($cenv{'default_enrollment_end_date'});
1.444 albertel 8092: }
1.566 albertel 8093:
1.444 albertel 8094: #
8095: # Set environment (will override cloned, if existing)
8096: #
8097: my @sections = ();
8098: my @xlists = ();
8099: if ($args->{'crstype'}) {
8100: $cenv{'type'}=$args->{'crstype'};
8101: }
8102: if ($args->{'crsid'}) {
8103: $cenv{'courseid'}=$args->{'crsid'};
8104: }
8105: if ($args->{'crscode'}) {
8106: $cenv{'internal.coursecode'}=$args->{'crscode'};
8107: }
8108: if ($args->{'crsquota'} ne '') {
8109: $cenv{'internal.coursequota'}=$args->{'crsquota'};
8110: } else {
8111: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
8112: }
8113: if ($args->{'ccuname'}) {
8114: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
8115: ':'.$args->{'ccdomain'};
8116: } else {
8117: $cenv{'internal.courseowner'} = $args->{'curruser'};
8118: }
8119:
8120: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
8121: if ($args->{'crssections'}) {
8122: $cenv{'internal.sectionnums'} = '';
8123: if ($args->{'crssections'} =~ m/,/) {
8124: @sections = split/,/,$args->{'crssections'};
8125: } else {
8126: $sections[0] = $args->{'crssections'};
8127: }
8128: if (@sections > 0) {
8129: foreach my $item (@sections) {
8130: my ($sec,$gp) = split/:/,$item;
8131: my $class = $args->{'crscode'}.$sec;
8132: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
8133: $cenv{'internal.sectionnums'} .= $item.',';
8134: unless ($addcheck eq 'ok') {
8135: push @badclasses, $class;
8136: }
8137: }
8138: $cenv{'internal.sectionnums'} =~ s/,$//;
8139: }
8140: }
8141: # do not hide course coordinator from staff listing,
8142: # even if privileged
8143: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
8144: # add crosslistings
8145: if ($args->{'crsxlist'}) {
8146: $cenv{'internal.crosslistings'}='';
8147: if ($args->{'crsxlist'} =~ m/,/) {
8148: @xlists = split/,/,$args->{'crsxlist'};
8149: } else {
8150: $xlists[0] = $args->{'crsxlist'};
8151: }
8152: if (@xlists > 0) {
8153: foreach my $item (@xlists) {
8154: my ($xl,$gp) = split/:/,$item;
8155: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
8156: $cenv{'internal.crosslistings'} .= $item.',';
8157: unless ($addcheck eq 'ok') {
8158: push @badclasses, $xl;
8159: }
8160: }
8161: $cenv{'internal.crosslistings'} =~ s/,$//;
8162: }
8163: }
8164: if ($args->{'autoadds'}) {
8165: $cenv{'internal.autoadds'}=$args->{'autoadds'};
8166: }
8167: if ($args->{'autodrops'}) {
8168: $cenv{'internal.autodrops'}=$args->{'autodrops'};
8169: }
8170: # check for notification of enrollment changes
8171: my @notified = ();
8172: if ($args->{'notify_owner'}) {
8173: if ($args->{'ccuname'} ne '') {
8174: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
8175: }
8176: }
8177: if ($args->{'notify_dc'}) {
8178: if ($uname ne '') {
1.630 raeburn 8179: push(@notified,$uname.':'.$udom);
1.444 albertel 8180: }
8181: }
8182: if (@notified > 0) {
8183: my $notifylist;
8184: if (@notified > 1) {
8185: $notifylist = join(',',@notified);
8186: } else {
8187: $notifylist = $notified[0];
8188: }
8189: $cenv{'internal.notifylist'} = $notifylist;
8190: }
8191: if (@badclasses > 0) {
8192: my %lt=&Apache::lonlocal::texthash(
8193: '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',
8194: 'dnhr' => 'does not have rights to access enrollment in these classes',
8195: 'adby' => 'as determined by the policies of your institution on access to official classlists'
8196: );
1.541 raeburn 8197: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
8198: ' ('.$lt{'adby'}.')';
8199: if ($context eq 'auto') {
8200: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 8201: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 8202: foreach my $item (@badclasses) {
8203: if ($context eq 'auto') {
8204: $outcome .= " - $item\n";
8205: } else {
8206: $outcome .= "<li>$item</li>\n";
8207: }
8208: }
8209: if ($context eq 'auto') {
8210: $outcome .= $linefeed;
8211: } else {
1.566 albertel 8212: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 8213: }
8214: }
1.444 albertel 8215: }
8216: if ($args->{'no_end_date'}) {
8217: $args->{'endaccess'} = 0;
8218: }
8219: $cenv{'internal.autostart'}=$args->{'enrollstart'};
8220: $cenv{'internal.autoend'}=$args->{'enrollend'};
8221: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
8222: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
8223: if ($args->{'showphotos'}) {
8224: $cenv{'internal.showphotos'}=$args->{'showphotos'};
8225: }
8226: $cenv{'internal.authtype'} = $args->{'authtype'};
8227: $cenv{'internal.autharg'} = $args->{'autharg'};
8228: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
8229: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 8230: 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');
8231: if ($context eq 'auto') {
8232: $outcome .= $krb_msg;
8233: } else {
1.566 albertel 8234: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 8235: }
8236: $outcome .= $linefeed;
1.444 albertel 8237: }
8238: }
8239: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
8240: if ($args->{'setpolicy'}) {
8241: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
8242: }
8243: if ($args->{'setcontent'}) {
8244: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
8245: }
8246: }
8247: if ($args->{'reshome'}) {
8248: $cenv{'reshome'}=$args->{'reshome'}.'/';
8249: $cenv{'reshome'}=~s/\/+$/\//;
8250: }
8251: #
8252: # course has keyed access
8253: #
8254: if ($args->{'setkeys'}) {
8255: $cenv{'keyaccess'}='yes';
8256: }
8257: # if specified, key authority is not course, but user
8258: # only active if keyaccess is yes
8259: if ($args->{'keyauth'}) {
1.487 albertel 8260: my ($user,$domain) = split(':',$args->{'keyauth'});
8261: $user = &LONCAPA::clean_username($user);
8262: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 8263: if ($user ne '' && $domain ne '') {
1.487 albertel 8264: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 8265: }
8266: }
8267:
8268: if ($args->{'disresdis'}) {
8269: $cenv{'pch.roles.denied'}='st';
8270: }
8271: if ($args->{'disablechat'}) {
8272: $cenv{'plc.roles.denied'}='st';
8273: }
8274:
8275: # Record we've not yet viewed the Course Initialization Helper for this
8276: # course
8277: $cenv{'course.helper.not.run'} = 1;
8278: #
8279: # Use new Randomseed
8280: #
8281: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
8282: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
8283: #
8284: # The encryption code and receipt prefix for this course
8285: #
8286: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
8287: $cenv{'internal.encpref'}=100+int(9*rand(99));
8288: #
8289: # By default, use standard grading
8290: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
8291:
1.541 raeburn 8292: $outcome .= $linefeed.&mt('Setting environment').': '.
8293: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 8294: #
8295: # Open all assignments
8296: #
8297: if ($args->{'openall'}) {
8298: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
8299: my %storecontent = ($storeunder => time,
8300: $storeunder.'.type' => 'date_start');
8301:
8302: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 8303: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 8304: }
8305: #
8306: # Set first page
8307: #
8308: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
8309: || ($cloneid)) {
1.445 albertel 8310: use LONCAPA::map;
1.444 albertel 8311: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 8312:
8313: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
8314: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
8315:
1.444 albertel 8316: $outcome .= ($fatal?$errtext:'read ok').' - ';
8317: my $title; my $url;
8318: if ($args->{'firstres'} eq 'syl') {
8319: $title='Syllabus';
8320: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
8321: } else {
8322: $title='Navigate Contents';
8323: $url='/adm/navmaps';
8324: }
1.445 albertel 8325:
8326: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
8327: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
8328:
8329: if ($errtext) { $fatal=2; }
1.541 raeburn 8330: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 8331: }
1.566 albertel 8332:
8333: return (1,$outcome);
1.444 albertel 8334: }
8335:
8336: ############################################################
8337: ############################################################
8338:
1.378 raeburn 8339: sub course_type {
8340: my ($cid) = @_;
8341: if (!defined($cid)) {
8342: $cid = $env{'request.course.id'};
8343: }
1.404 albertel 8344: if (defined($env{'course.'.$cid.'.type'})) {
8345: return $env{'course.'.$cid.'.type'};
1.378 raeburn 8346: } else {
8347: return 'Course';
1.377 raeburn 8348: }
8349: }
1.156 albertel 8350:
1.406 raeburn 8351: sub group_term {
8352: my $crstype = &course_type();
8353: my %names = (
8354: 'Course' => 'group',
8355: 'Group' => 'team',
8356: );
8357: return $names{$crstype};
8358: }
8359:
1.156 albertel 8360: sub icon {
8361: my ($file)=@_;
1.505 albertel 8362: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 8363: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 8364: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 8365: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
8366: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
8367: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
8368: $curfext.".gif") {
8369: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
8370: $curfext.".gif";
8371: }
8372: }
1.249 albertel 8373: return &lonhttpdurl($iconname);
1.154 albertel 8374: }
1.84 albertel 8375:
1.575 albertel 8376: sub lonhttpd_port {
1.215 albertel 8377: my $lonhttpd_port=$Apache::lonnet::perlvar{'lonhttpdPort'};
8378: if (!defined($lonhttpd_port)) { $lonhttpd_port='8080'; }
1.574 albertel 8379: # IE doesn't like a secure page getting images from a non-secure
8380: # port (when logging we haven't parsed the browser type so default
8381: # back to secure
8382: if ((!exists($env{'browser.type'}) || $env{'browser.type'} eq 'explorer')
8383: && $ENV{'SERVER_PORT'} == 443) {
1.575 albertel 8384: return 443;
8385: }
8386: return $lonhttpd_port;
8387:
8388: }
8389:
8390: sub lonhttpdurl {
8391: my ($url)=@_;
8392:
8393: my $lonhttpd_port = &lonhttpd_port();
8394: if ($lonhttpd_port == 443) {
1.574 albertel 8395: return 'https://'.$ENV{'SERVER_NAME'}.$url;
8396: }
1.215 albertel 8397: return 'http://'.$ENV{'SERVER_NAME'}.':'.$lonhttpd_port.$url;
8398: }
8399:
1.213 albertel 8400: sub connection_aborted {
8401: my ($r)=@_;
8402: $r->print(" ");$r->rflush();
8403: my $c = $r->connection;
8404: return $c->aborted();
8405: }
8406:
1.221 foxr 8407: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 8408: # strings as 'strings'.
8409: sub escape_single {
1.221 foxr 8410: my ($input) = @_;
1.223 albertel 8411: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 8412: $input =~ s/\'/\\\'/g; # Esacpe the 's....
8413: return $input;
8414: }
1.223 albertel 8415:
1.222 foxr 8416: # Same as escape_single, but escape's "'s This
8417: # can be used for "strings"
8418: sub escape_double {
8419: my ($input) = @_;
8420: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
8421: $input =~ s/\"/\\\"/g; # Esacpe the "s....
8422: return $input;
8423: }
1.223 albertel 8424:
1.222 foxr 8425: # Escapes the last element of a full URL.
8426: sub escape_url {
8427: my ($url) = @_;
1.238 raeburn 8428: my @urlslices = split(/\//, $url,-1);
1.369 www 8429: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 8430: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 8431: }
1.462 albertel 8432:
8433: # -------------------------------------------------------- Initliaze user login
8434: sub init_user_environment {
1.463 albertel 8435: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 8436: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
8437:
8438: my $public=($username eq 'public' && $domain eq 'public');
8439:
8440: # See if old ID present, if so, remove
8441:
8442: my ($filename,$cookie,$userroles);
8443: my $now=time;
8444:
8445: if ($public) {
8446: my $max_public=100;
8447: my $oldest;
8448: my $oldest_time=0;
8449: for(my $next=1;$next<=$max_public;$next++) {
8450: if (-e $lonids."/publicuser_$next.id") {
8451: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
8452: if ($mtime<$oldest_time || !$oldest_time) {
8453: $oldest_time=$mtime;
8454: $oldest=$next;
8455: }
8456: } else {
8457: $cookie="publicuser_$next";
8458: last;
8459: }
8460: }
8461: if (!$cookie) { $cookie="publicuser_$oldest"; }
8462: } else {
1.463 albertel 8463: # if this isn't a robot, kill any existing non-robot sessions
8464: if (!$args->{'robot'}) {
8465: opendir(DIR,$lonids);
8466: while ($filename=readdir(DIR)) {
8467: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
8468: unlink($lonids.'/'.$filename);
8469: }
1.462 albertel 8470: }
1.463 albertel 8471: closedir(DIR);
1.462 albertel 8472: }
8473: # Give them a new cookie
1.463 albertel 8474: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
8475: : $now);
8476: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 8477:
8478: # Initialize roles
8479:
8480: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
8481: }
8482: # ------------------------------------ Check browser type and MathML capability
8483:
8484: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
8485: $clientunicode,$clientos) = &decode_user_agent($r);
8486:
8487: # -------------------------------------- Any accessibility options to remember?
8488: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
8489: foreach my $option ('imagesuppress','appletsuppress',
8490: 'embedsuppress','fontenhance','blackwhite') {
8491: if ($form->{$option} eq 'true') {
8492: &Apache::lonnet::put('environment',{$option => 'on'},
8493: $domain,$username);
8494: } else {
8495: &Apache::lonnet::del('environment',[$option],
8496: $domain,$username);
8497: }
8498: }
8499: }
8500: # ------------------------------------------------------------- Get environment
8501:
8502: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
8503: my ($tmp) = keys(%userenv);
8504: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
8505: # default remote control to off
8506: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
8507: } else {
8508: undef(%userenv);
8509: }
8510: if (($userenv{'interface'}) && (!$form->{'interface'})) {
8511: $form->{'interface'}=$userenv{'interface'};
8512: }
8513: $env{'environment.remote'}=$userenv{'remote'};
8514: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
8515:
8516: # --------------- Do not trust query string to be put directly into environment
8517: foreach my $option ('imagesuppress','appletsuppress',
8518: 'embedsuppress','fontenhance','blackwhite',
8519: 'interface','localpath','localres') {
8520: $form->{$option}=~s/[\n\r\=]//gs;
8521: }
8522: # --------------------------------------------------------- Write first profile
8523:
8524: {
8525: my %initial_env =
8526: ("user.name" => $username,
8527: "user.domain" => $domain,
8528: "user.home" => $authhost,
8529: "browser.type" => $clientbrowser,
8530: "browser.version" => $clientversion,
8531: "browser.mathml" => $clientmathml,
8532: "browser.unicode" => $clientunicode,
8533: "browser.os" => $clientos,
8534: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
8535: "request.course.fn" => '',
8536: "request.course.uri" => '',
8537: "request.course.sec" => '',
8538: "request.role" => 'cm',
8539: "request.role.adv" => $env{'user.adv'},
8540: "request.host" => $ENV{'REMOTE_ADDR'},);
8541:
8542: if ($form->{'localpath'}) {
8543: $initial_env{"browser.localpath"} = $form->{'localpath'};
8544: $initial_env{"browser.localres"} = $form->{'localres'};
8545: }
8546:
8547: if ($public) {
8548: $initial_env{"environment.remote"} = "off";
8549: }
8550: if ($form->{'interface'}) {
8551: $form->{'interface'}=~s/\W//gs;
8552: $initial_env{"browser.interface"} = $form->{'interface'};
8553: $env{'browser.interface'}=$form->{'interface'};
8554: foreach my $option ('imagesuppress','appletsuppress',
8555: 'embedsuppress','fontenhance','blackwhite') {
8556: if (($form->{$option} eq 'true') ||
8557: ($userenv{$option} eq 'on')) {
8558: $initial_env{"browser.$option"} = "on";
8559: }
8560: }
8561: }
8562:
8563: $env{'user.environment'} = "$lonids/$cookie.id";
8564:
8565: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
8566: &GDBM_WRCREAT(),0640)) {
8567: &_add_to_env(\%disk_env,\%initial_env);
8568: &_add_to_env(\%disk_env,\%userenv,'environment.');
8569: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 8570: if (ref($args->{'extra_env'})) {
8571: &_add_to_env(\%disk_env,$args->{'extra_env'});
8572: }
1.462 albertel 8573: untie(%disk_env);
8574: } else {
8575: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
8576: 'Could not create environment storage in lonauth: '.$!.'</font>');
8577: return 'error: '.$!;
8578: }
8579: }
8580: $env{'request.role'}='cm';
8581: $env{'request.role.adv'}=$env{'user.adv'};
8582: $env{'browser.type'}=$clientbrowser;
8583:
8584: return $cookie;
8585:
8586: }
8587:
8588: sub _add_to_env {
8589: my ($idf,$env_data,$prefix) = @_;
8590: while (my ($key,$value) = each(%$env_data)) {
8591: $idf->{$prefix.$key} = $value;
8592: $env{$prefix.$key} = $value;
8593: }
8594: }
8595:
8596:
1.41 ng 8597: =pod
8598:
8599: =back
8600:
1.112 bowersj2 8601: =cut
1.41 ng 8602:
1.112 bowersj2 8603: 1;
8604: __END__;
1.41 ng 8605:
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