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