Annotation of loncom/interface/loncommon.pm, revision 1.707
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.707 ! bisitz 4: # $Id: loncommon.pm,v 1.706 2008/12/04 13:39:47 harmsja 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.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
1.558 albertel 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 412: var url = '/adm/pickstudent?';
413: var filter;
1.558 albertel 414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
1.74 www 417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
1.111 www 424: if (roleflag) { url+="&roles=1"; }
1.102 www 425: var title = 'Student_Browser';
1.74 www 426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
1.42 matthew 434:
1.74 www 435: sub selectstudent_link {
1.111 www 436: my ($form,$unameele,$udomele)=@_;
1.258 albertel 437: if ($env{'request.course.id'}) {
1.302 albertel 438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
1.111 www 441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 445: }
1.258 albertel 446: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 449: }
450: return '';
1.91 www 451: }
452:
1.653 raeburn 453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
1.91 www 472: sub coursebrowser_javascript {
1.468 raeburn 473: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 474: 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 475: my $output = '
1.538 albertel 476: <script type="text/javascript">
1.468 raeburn 477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
1.377 raeburn 479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 480: var url = '/adm/pickcourse?';
1.468 raeburn 481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
1.91 www 493: }
1.128 albertel 494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
1.91 www 499: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
1.468 raeburn 502: if (extra_element !=null && extra_element != '') {
1.594 raeburn 503: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
1.234 raeburn 508: }
1.468 raeburn 509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
1.230 raeburn 514: }
1.293 raeburn 515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
1.377 raeburn 518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
1.102 www 530: var title = 'Course_Browser';
1.91 www 531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
1.468 raeburn 536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
1.91 www 554: ENDSTDBRW
1.468 raeburn 555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
1.629 raeburn 567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
1.468 raeburn 571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
1.91 www 597: }
1.468 raeburn 598: |;
599: return $setsections;
600: }
601:
1.91 www 602:
603: sub selectcourse_link {
1.377 raeburn 604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 607: }
1.42 matthew 608:
1.653 raeburn 609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
1.273 raeburn 615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
1.543 albertel 631: }
632: } else {
1.273 raeburn 633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
1.656 www 640: sub select_timezone {
1.659 raeburn 641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
1.657 raeburn 650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
1.656 www 657: }
658: $output.="</select>";
659: return $output;
660: }
1.273 raeburn 661:
1.687 raeburn 662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 680: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
1.42 matthew 713: =pod
1.36 matthew 714:
1.648 raeburn 715: =item * &linked_select_forms(...)
1.36 matthew 716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 721: order unless a defined order is provided.
1.36 matthew 722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
1.112 bowersj2 727: =item * $formname, the name of the <form> tag
1.36 matthew 728:
1.112 bowersj2 729: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 730:
1.112 bowersj2 731: =item * $firstdefault, the default value for the first menu
1.36 matthew 732:
1.112 bowersj2 733: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 734:
1.112 bowersj2 735: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 736:
1.112 bowersj2 737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 738:
1.609 raeburn 739: =item * $menuorder, the order of values in the first menu
740:
1.41 ng 741: =back
742:
1.36 matthew 743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
1.41 ng 746: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
1.112 bowersj2 750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
1.609 raeburn 757: },
758: order => ['B4','B3','B1','B2'],
1.112 bowersj2 759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
1.609 raeburn 766: },
767: order => ['C2','C1','C3'],
1.112 bowersj2 768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
1.609 raeburn 779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 781: }
782: );
1.36 matthew 783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
1.609 raeburn 792: $hashref,
793: $menuorder,
1.36 matthew 794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
1.219 albertel 799: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 807: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
1.36 matthew 812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
1.143 matthew 838: $second.options[i].value = values[i];
1.36 matthew 839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
1.36 matthew 854: $result.=" <option value=\"$value\" ";
1.253 albertel 855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
1.36 matthew 869: $result.=" <option value=\"$value\" ";
1.253 albertel 870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 871: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
1.45 matthew 878: =pod
1.44 bowersj2 879:
1.648 raeburn 880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 881:
1.112 bowersj2 882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
1.44 bowersj2 899:
900: =cut
901:
902: sub help_open_topic {
1.48 bowersj2 903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
1.44 bowersj2 905: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 906: if ($env{'browser.interface'} eq 'textual') {
1.79 www 907: $stayOnPage=1;
908: }
1.44 bowersj2 909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
1.48 bowersj2 914: my $template = "";
915: my $link;
1.572 banghart 916:
1.159 www 917: $topic=~s/\W/\_/g;
1.44 bowersj2 918:
1.572 banghart 919: if (!$stayOnPage) {
1.72 bowersj2 920: $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 921: } else {
1.48 bowersj2 922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
1.572 banghart 926: if ($text ne "") {
1.77 www 927: $template .=
1.572 banghart 928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 929: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.48 bowersj2 930: }
931:
932: # Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 935: $template .= <<"ENDTEMPLATE";
1.436 albertel 936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 937: ENDTEMPLATE
1.705 tempelho 938: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 939: return $template;
940:
1.106 bowersj2 941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
946: my $other = shift;
947: my $addOther = '';
948: if ($other) {
949: $addOther = Apache::loncommon::help_open_topic($other, shift,
950: undef, undef, 600) .
951: '</td><td>';
952: }
953: return '<table><tr><td>'.
954: $addOther .
1.636 raeburn 955: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
1.106 bowersj2 956: undef,undef,600)
957: .'</td><td>'.
1.636 raeburn 958: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
1.106 bowersj2 959: undef,undef,600)
1.673 felicia 960: .'</td><td>'.
961: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
962: undef,undef,600)
1.106 bowersj2 963: .'</td></tr></table>';
1.172 www 964: }
965:
1.430 albertel 966: sub general_help {
967: my $helptopic='Student_Intro';
968: if ($env{'request.role'}=~/^(ca|au)/) {
969: $helptopic='Authoring_Intro';
970: } elsif ($env{'request.role'}=~/^cc/) {
971: $helptopic='Course_Coordination_Intro';
1.672 raeburn 972: } elsif ($env{'request.role'}=~/^dc/) {
973: $helptopic='Domain_Coordination_Intro';
1.430 albertel 974: }
975: return $helptopic;
976: }
977:
978: sub update_help_link {
979: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
980: my $origurl = $ENV{'REQUEST_URI'};
981: $origurl=~s|^/~|/priv/|;
982: my $timestamp = time;
983: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
984: $$datum = &escape($$datum);
985: }
986:
987: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
988: my $output .= <<"ENDOUTPUT";
989: <script type="text/javascript">
990: banner_link = '$banner_link';
991: </script>
992: ENDOUTPUT
993: return $output;
994: }
995:
996: # now just updates the help link and generates a blue icon
1.193 raeburn 997: sub help_open_menu {
1.430 albertel 998: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 999: = @_;
1.430 albertel 1000: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1001: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1002: # if environment.remote is on (using remote control UI)
1.572 banghart 1003: if ($env{'browser.interface'} eq 'textual' ||
1004: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1005: $stayOnPage=1;
1.430 albertel 1006: }
1007: my $output;
1008: if ($component_help) {
1009: if (!$text) {
1010: $output=&help_open_topic($component_help,undef,$stayOnPage,
1011: $width,$height);
1012: } else {
1013: my $help_text;
1014: $help_text=&unescape($topic);
1015: $output='<table><tr><td>'.
1016: &help_open_topic($component_help,$help_text,$stayOnPage,
1017: $width,$height).'</td></tr></table>';
1018: }
1019: }
1020: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1021: return $output.$banner_link;
1022: }
1023:
1024: sub top_nav_help {
1025: my ($text) = @_;
1.436 albertel 1026: $text = &mt($text);
1.572 banghart 1027: my $stay_on_page =
1.436 albertel 1028: ($env{'browser.interface'} eq 'textual' ||
1029: $env{'environment.remote'} eq 'off' );
1.572 banghart 1030: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1031: : "javascript:helpMenu('open')";
1.572 banghart 1032: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1033:
1.201 raeburn 1034: my $title = &mt('Get help');
1.436 albertel 1035:
1036: return <<"END";
1037: $banner_link
1038: <a href="$link" title="$title">$text</a>
1039: END
1040: }
1041:
1042: sub help_menu_js {
1043: my ($text) = @_;
1044:
1045: my $stayOnPage =
1046: ($env{'browser.interface'} eq 'textual' ||
1047: $env{'environment.remote'} eq 'off' );
1048:
1049: my $width = 620;
1050: my $height = 600;
1.430 albertel 1051: my $helptopic=&general_help();
1052: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1053: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1054: my $start_page =
1055: &Apache::loncommon::start_page('Help Menu', undef,
1056: {'frameset' => 1,
1057: 'js_ready' => 1,
1058: 'add_entries' => {
1059: 'border' => '0',
1.579 raeburn 1060: 'rows' => "110,*",},});
1.331 albertel 1061: my $end_page =
1062: &Apache::loncommon::end_page({'frameset' => 1,
1063: 'js_ready' => 1,});
1064:
1.436 albertel 1065: my $template .= <<"ENDTEMPLATE";
1066: <script type="text/javascript">
1.253 albertel 1067: // <!-- BEGIN LON-CAPA Internal
1068: // <![CDATA[
1.430 albertel 1069: var banner_link = '';
1.243 raeburn 1070: function helpMenu(target) {
1071: var caller = this;
1072: if (target == 'open') {
1073: var newWindow = null;
1074: try {
1.262 albertel 1075: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1076: }
1077: catch(error) {
1078: writeHelp(caller);
1079: return;
1080: }
1081: if (newWindow) {
1082: caller = newWindow;
1083: }
1.193 raeburn 1084: }
1.243 raeburn 1085: writeHelp(caller);
1086: return;
1087: }
1088: function writeHelp(caller) {
1.430 albertel 1089: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1090: caller.document.close()
1091: caller.focus()
1.193 raeburn 1092: }
1.253 albertel 1093: // ]]>
1.219 albertel 1094: // END LON-CAPA Internal -->
1.436 albertel 1095: </script>
1.193 raeburn 1096: ENDTEMPLATE
1097: return $template;
1098: }
1099:
1.172 www 1100: sub help_open_bug {
1101: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1102: unless ($env{'user.adv'}) { return ''; }
1.172 www 1103: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1104: $text = "" if (not defined $text);
1105: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1106: if ($env{'browser.interface'} eq 'textual' ||
1107: $env{'environment.remote'} eq 'off' ) {
1.172 www 1108: $stayOnPage=1;
1109: }
1.184 albertel 1110: $width = 600 if (not defined $width);
1111: $height = 600 if (not defined $height);
1.172 www 1112:
1113: $topic=~s/\W+/\+/g;
1114: my $link='';
1115: my $template='';
1.379 albertel 1116: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1117: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1118: if (!$stayOnPage)
1119: {
1120: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1121: }
1122: else
1123: {
1124: $link = $url;
1125: }
1126: # Add the text
1127: if ($text ne "")
1128: {
1129: $template .=
1130: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1131: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1132: }
1133:
1134: # Add the graphic
1.179 matthew 1135: my $title = &mt('Report a Bug');
1.215 albertel 1136: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1137: $template .= <<"ENDTEMPLATE";
1.436 albertel 1138: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1139: ENDTEMPLATE
1140: if ($text ne '') { $template.='</td></tr></table>' };
1141: return $template;
1142:
1143: }
1144:
1145: sub help_open_faq {
1146: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1147: unless ($env{'user.adv'}) { return ''; }
1.172 www 1148: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1149: $text = "" if (not defined $text);
1150: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1151: if ($env{'browser.interface'} eq 'textual' ||
1152: $env{'environment.remote'} eq 'off' ) {
1.172 www 1153: $stayOnPage=1;
1154: }
1155: $width = 350 if (not defined $width);
1156: $height = 400 if (not defined $height);
1157:
1158: $topic=~s/\W+/\+/g;
1159: my $link='';
1160: my $template='';
1161: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1162: if (!$stayOnPage)
1163: {
1164: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1165: }
1166: else
1167: {
1168: $link = $url;
1169: }
1170:
1171: # Add the text
1172: if ($text ne "")
1173: {
1174: $template .=
1.173 www 1175: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1176: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1177: }
1178:
1179: # Add the graphic
1.179 matthew 1180: my $title = &mt('View the FAQ');
1.215 albertel 1181: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1182: $template .= <<"ENDTEMPLATE";
1.436 albertel 1183: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1184: ENDTEMPLATE
1185: if ($text ne '') { $template.='</td></tr></table>' };
1186: return $template;
1187:
1.44 bowersj2 1188: }
1.37 matthew 1189:
1.180 matthew 1190: ###############################################################
1191: ###############################################################
1192:
1.45 matthew 1193: =pod
1194:
1.648 raeburn 1195: =item * &change_content_javascript():
1.256 matthew 1196:
1197: This and the next function allow you to create small sections of an
1198: otherwise static HTML page that you can update on the fly with
1199: Javascript, even in Netscape 4.
1200:
1201: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1202: must be written to the HTML page once. It will prove the Javascript
1203: function "change(name, content)". Calling the change function with the
1204: name of the section
1205: you want to update, matching the name passed to C<changable_area>, and
1206: the new content you want to put in there, will put the content into
1207: that area.
1208:
1209: B<Note>: Netscape 4 only reserves enough space for the changable area
1210: to contain room for the original contents. You need to "make space"
1211: for whatever changes you wish to make, and be B<sure> to check your
1212: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1213: it's adequate for updating a one-line status display, but little more.
1214: This script will set the space to 100% width, so you only need to
1215: worry about height in Netscape 4.
1216:
1217: Modern browsers are much less limiting, and if you can commit to the
1218: user not using Netscape 4, this feature may be used freely with
1219: pretty much any HTML.
1220:
1221: =cut
1222:
1223: sub change_content_javascript {
1224: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1225: if ($env{'browser.type'} eq 'netscape' &&
1226: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1227: return (<<NETSCAPE4);
1228: function change(name, content) {
1229: doc = document.layers[name+"___escape"].layers[0].document;
1230: doc.open();
1231: doc.write(content);
1232: doc.close();
1233: }
1234: NETSCAPE4
1235: } else {
1236: # Otherwise, we need to use semi-standards-compliant code
1237: # (technically, "innerHTML" isn't standard but the equivalent
1238: # is really scary, and every useful browser supports it
1239: return (<<DOMBASED);
1240: function change(name, content) {
1241: element = document.getElementById(name);
1242: element.innerHTML = content;
1243: }
1244: DOMBASED
1245: }
1246: }
1247:
1248: =pod
1249:
1.648 raeburn 1250: =item * &changable_area($name,$origContent):
1.256 matthew 1251:
1252: This provides a "changable area" that can be modified on the fly via
1253: the Javascript code provided in C<change_content_javascript>. $name is
1254: the name you will use to reference the area later; do not repeat the
1255: same name on a given HTML page more then once. $origContent is what
1256: the area will originally contain, which can be left blank.
1257:
1258: =cut
1259:
1260: sub changable_area {
1261: my ($name, $origContent) = @_;
1262:
1.258 albertel 1263: if ($env{'browser.type'} eq 'netscape' &&
1264: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1265: # If this is netscape 4, we need to use the Layer tag
1266: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1267: } else {
1268: return "<span id='$name'>$origContent</span>";
1269: }
1270: }
1271:
1272: =pod
1273:
1.648 raeburn 1274: =item * &viewport_geometry_js
1.590 raeburn 1275:
1276: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1277:
1278: =cut
1279:
1280:
1281: sub viewport_geometry_js {
1282: return <<"GEOMETRY";
1283: var Geometry = {};
1284: function init_geometry() {
1285: if (Geometry.init) { return };
1286: Geometry.init=1;
1287: if (window.innerHeight) {
1288: Geometry.getViewportHeight = function() { return window.innerHeight; };
1289: Geometry.getViewportWidth = function() { return window.innerWidth; };
1290: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1291: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1292: }
1293: else if (document.documentElement && document.documentElement.clientHeight) {
1294: Geometry.getViewportHeight =
1295: function() { return document.documentElement.clientHeight; };
1296: Geometry.getViewportWidth =
1297: function() { return document.documentElement.clientWidth; };
1298:
1299: Geometry.getHorizontalScroll =
1300: function() { return document.documentElement.scrollLeft; };
1301: Geometry.getVerticalScroll =
1302: function() { return document.documentElement.scrollTop; };
1303: }
1304: else if (document.body.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.body.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.body.clientWidth; };
1309: Geometry.getHorizontalScroll =
1310: function() { return document.body.scrollLeft; };
1311: Geometry.getVerticalScroll =
1312: function() { return document.body.scrollTop; };
1313: }
1314: }
1315:
1316: GEOMETRY
1317: }
1318:
1319: =pod
1320:
1.648 raeburn 1321: =item * &viewport_size_js()
1.590 raeburn 1322:
1323: 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.
1324:
1325: =cut
1326:
1327: sub viewport_size_js {
1328: my $geometry = &viewport_geometry_js();
1329: return <<"DIMS";
1330:
1331: $geometry
1332:
1333: function getViewportDims(width,height) {
1334: init_geometry();
1335: width.value = Geometry.getViewportWidth();
1336: height.value = Geometry.getViewportHeight();
1337: return;
1338: }
1339:
1340: DIMS
1341: }
1342:
1343: =pod
1344:
1.648 raeburn 1345: =item * &resize_textarea_js()
1.565 albertel 1346:
1347: emits the needed javascript to resize a textarea to be as big as possible
1348:
1349: creates a function resize_textrea that takes two IDs first should be
1350: the id of the element to resize, second should be the id of a div that
1351: surrounds everything that comes after the textarea, this routine needs
1352: to be attached to the <body> for the onload and onresize events.
1353:
1.648 raeburn 1354: =back
1.565 albertel 1355:
1356: =cut
1357:
1358: sub resize_textarea_js {
1.590 raeburn 1359: my $geometry = &viewport_geometry_js();
1.565 albertel 1360: return <<"RESIZE";
1361: <script type="text/javascript">
1.590 raeburn 1362: $geometry
1.565 albertel 1363:
1.588 albertel 1364: function getX(element) {
1365: var x = 0;
1366: while (element) {
1367: x += element.offsetLeft;
1368: element = element.offsetParent;
1369: }
1370: return x;
1371: }
1372: function getY(element) {
1373: var y = 0;
1374: while (element) {
1375: y += element.offsetTop;
1376: element = element.offsetParent;
1377: }
1378: return y;
1379: }
1380:
1381:
1.565 albertel 1382: function resize_textarea(textarea_id,bottom_id) {
1383: init_geometry();
1384: var textarea = document.getElementById(textarea_id);
1385: //alert(textarea);
1386:
1.588 albertel 1387: var textarea_top = getY(textarea);
1.565 albertel 1388: var textarea_height = textarea.offsetHeight;
1389: var bottom = document.getElementById(bottom_id);
1.588 albertel 1390: var bottom_top = getY(bottom);
1.565 albertel 1391: var bottom_height = bottom.offsetHeight;
1392: var window_height = Geometry.getViewportHeight();
1.588 albertel 1393: var fudge = 23;
1.565 albertel 1394: var new_height = window_height-fudge-textarea_top-bottom_height;
1395: if (new_height < 300) {
1396: new_height = 300;
1397: }
1398: textarea.style.height=new_height+'px';
1399: }
1400: </script>
1401: RESIZE
1402:
1403: }
1404:
1405: =pod
1406:
1.256 matthew 1407: =head1 Excel and CSV file utility routines
1408:
1409: =over 4
1410:
1411: =cut
1412:
1413: ###############################################################
1414: ###############################################################
1415:
1416: =pod
1417:
1.648 raeburn 1418: =item * &csv_translate($text)
1.37 matthew 1419:
1.185 www 1420: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1421: format.
1422:
1423: =cut
1424:
1.180 matthew 1425: ###############################################################
1426: ###############################################################
1.37 matthew 1427: sub csv_translate {
1428: my $text = shift;
1429: $text =~ s/\"/\"\"/g;
1.209 albertel 1430: $text =~ s/\n/ /g;
1.37 matthew 1431: return $text;
1432: }
1.180 matthew 1433:
1434: ###############################################################
1435: ###############################################################
1436:
1437: =pod
1438:
1.648 raeburn 1439: =item * &define_excel_formats()
1.180 matthew 1440:
1441: Define some commonly used Excel cell formats.
1442:
1443: Currently supported formats:
1444:
1445: =over 4
1446:
1447: =item header
1448:
1449: =item bold
1450:
1451: =item h1
1452:
1453: =item h2
1454:
1455: =item h3
1456:
1.256 matthew 1457: =item h4
1458:
1459: =item i
1460:
1.180 matthew 1461: =item date
1462:
1463: =back
1464:
1465: Inputs: $workbook
1466:
1467: Returns: $format, a hash reference.
1468:
1469: =cut
1470:
1471: ###############################################################
1472: ###############################################################
1473: sub define_excel_formats {
1474: my ($workbook) = @_;
1475: my $format;
1476: $format->{'header'} = $workbook->add_format(bold => 1,
1477: bottom => 1,
1478: align => 'center');
1479: $format->{'bold'} = $workbook->add_format(bold=>1);
1480: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1481: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1482: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1483: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1484: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1485: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1486: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1487: return $format;
1488: }
1489:
1490: ###############################################################
1491: ###############################################################
1.113 bowersj2 1492:
1493: =pod
1494:
1.648 raeburn 1495: =item * &create_workbook()
1.255 matthew 1496:
1497: Create an Excel worksheet. If it fails, output message on the
1498: request object and return undefs.
1499:
1500: Inputs: Apache request object
1501:
1502: Returns (undef) on failure,
1503: Excel worksheet object, scalar with filename, and formats
1504: from &Apache::loncommon::define_excel_formats on success
1505:
1506: =cut
1507:
1508: ###############################################################
1509: ###############################################################
1510: sub create_workbook {
1511: my ($r) = @_;
1512: #
1513: # Create the excel spreadsheet
1514: my $filename = '/prtspool/'.
1.258 albertel 1515: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1516: time.'_'.rand(1000000000).'.xls';
1517: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1518: if (! defined($workbook)) {
1519: $r->log_error("Error creating excel spreadsheet $filename: $!");
1520: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1521: "This error has been logged. ".
1522: "Please alert your LON-CAPA administrator").
1523: '</p>');
1524: return (undef);
1525: }
1526: #
1527: $workbook->set_tempdir('/home/httpd/perl/tmp');
1528: #
1529: my $format = &Apache::loncommon::define_excel_formats($workbook);
1530: return ($workbook,$filename,$format);
1531: }
1532:
1533: ###############################################################
1534: ###############################################################
1535:
1536: =pod
1537:
1.648 raeburn 1538: =item * &create_text_file()
1.113 bowersj2 1539:
1.542 raeburn 1540: Create a file to write to and eventually make available to the user.
1.256 matthew 1541: If file creation fails, outputs an error message on the request object and
1542: return undefs.
1.113 bowersj2 1543:
1.256 matthew 1544: Inputs: Apache request object, and file suffix
1.113 bowersj2 1545:
1.256 matthew 1546: Returns (undef) on failure,
1547: Filehandle and filename on success.
1.113 bowersj2 1548:
1549: =cut
1550:
1.256 matthew 1551: ###############################################################
1552: ###############################################################
1553: sub create_text_file {
1554: my ($r,$suffix) = @_;
1555: if (! defined($suffix)) { $suffix = 'txt'; };
1556: my $fh;
1557: my $filename = '/prtspool/'.
1.258 albertel 1558: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1559: time.'_'.rand(1000000000).'.'.$suffix;
1560: $fh = Apache::File->new('>/home/httpd'.$filename);
1561: if (! defined($fh)) {
1562: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1563: $r->print(&mt('Problems occurred in creating the output file. '
1564: .'This error has been logged. '
1565: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1566: }
1.256 matthew 1567: return ($fh,$filename)
1.113 bowersj2 1568: }
1569:
1570:
1.256 matthew 1571: =pod
1.113 bowersj2 1572:
1573: =back
1574:
1575: =cut
1.37 matthew 1576:
1577: ###############################################################
1.33 matthew 1578: ## Home server <option> list generating code ##
1579: ###############################################################
1.35 matthew 1580:
1.169 www 1581: # ------------------------------------------
1582:
1583: sub domain_select {
1584: my ($name,$value,$multiple)=@_;
1585: my %domains=map {
1.514 albertel 1586: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1587: } &Apache::lonnet::all_domains();
1.169 www 1588: if ($multiple) {
1589: $domains{''}=&mt('Any domain');
1.550 albertel 1590: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1591: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1592: } else {
1.550 albertel 1593: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1594: return &select_form($name,$value,%domains);
1595: }
1596: }
1597:
1.282 albertel 1598: #-------------------------------------------
1599:
1600: =pod
1601:
1.519 raeburn 1602: =head1 Routines for form select boxes
1603:
1604: =over 4
1605:
1.648 raeburn 1606: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1607:
1608: Returns a string containing a <select> element int multiple mode
1609:
1610:
1611: Args:
1612: $name - name of the <select> element
1.506 raeburn 1613: $value - scalar or array ref of values that should already be selected
1.282 albertel 1614: $size - number of rows long the select element is
1.283 albertel 1615: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1616: (shown text should already have been &mt())
1.506 raeburn 1617: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1618:
1.282 albertel 1619: =cut
1620:
1621: #-------------------------------------------
1.169 www 1622: sub multiple_select_form {
1.284 albertel 1623: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1624: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1625: my $output='';
1.191 matthew 1626: if (! defined($size)) {
1627: $size = 4;
1.283 albertel 1628: if (scalar(keys(%$hash))<4) {
1629: $size = scalar(keys(%$hash));
1.191 matthew 1630: }
1631: }
1.169 www 1632: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501 banghart 1633: my @order;
1.506 raeburn 1634: if (ref($order) eq 'ARRAY') {
1635: @order = @{$order};
1636: } else {
1637: @order = sort(keys(%$hash));
1.501 banghart 1638: }
1639: if (exists($$hash{'select_form_order'})) {
1640: @order = @{$$hash{'select_form_order'}};
1641: }
1642:
1.284 albertel 1643: foreach my $key (@order) {
1.356 albertel 1644: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1645: $output.='selected="selected" ' if ($selected{$key});
1646: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1647: }
1648: $output.="</select>\n";
1649: return $output;
1650: }
1651:
1.88 www 1652: #-------------------------------------------
1653:
1654: =pod
1655:
1.648 raeburn 1656: =item * &select_form($defdom,$name,%hash)
1.88 www 1657:
1658: Returns a string containing a <select name='$name' size='1'> form to
1659: allow a user to select options from a hash option_name => displayed text.
1660: See lonrights.pm for an example invocation and use.
1661:
1662: =cut
1663:
1664: #-------------------------------------------
1665: sub select_form {
1666: my ($def,$name,%hash) = @_;
1667: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1668: my @keys;
1669: if (exists($hash{'select_form_order'})) {
1670: @keys=@{$hash{'select_form_order'}};
1671: } else {
1672: @keys=sort(keys(%hash));
1673: }
1.356 albertel 1674: foreach my $key (@keys) {
1675: $selectform.=
1676: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1677: ($key eq $def ? 'selected="selected" ' : '').
1678: ">".&mt($hash{$key})."</option>\n";
1.88 www 1679: }
1680: $selectform.="</select>";
1681: return $selectform;
1682: }
1683:
1.475 www 1684: # For display filters
1685:
1686: sub display_filter {
1687: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1688: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475 www 1689: return '<nobr><label>'.&mt('Records [_1]',
1690: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1691: (&mt('all'),10,20,50,100,1000,10000))).
1.478 www 1692: '</label></nobr> <nobr>'.
1.475 www 1693: &mt('Filter [_1]',
1.477 www 1694: &select_form($env{'form.displayfilter'},
1695: 'displayfilter',
1696: ('currentfolder' => 'Current folder/page',
1697: 'containing' => 'Containing phrase',
1698: 'none' => 'None'))).
1.478 www 1699: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475 www 1700: }
1701:
1.167 www 1702: sub gradeleveldescription {
1703: my $gradelevel=shift;
1704: my %gradelevels=(0 => 'Not specified',
1705: 1 => 'Grade 1',
1706: 2 => 'Grade 2',
1707: 3 => 'Grade 3',
1708: 4 => 'Grade 4',
1709: 5 => 'Grade 5',
1710: 6 => 'Grade 6',
1711: 7 => 'Grade 7',
1712: 8 => 'Grade 8',
1713: 9 => 'Grade 9',
1714: 10 => 'Grade 10',
1715: 11 => 'Grade 11',
1716: 12 => 'Grade 12',
1717: 13 => 'Grade 13',
1718: 14 => '100 Level',
1719: 15 => '200 Level',
1720: 16 => '300 Level',
1721: 17 => '400 Level',
1722: 18 => 'Graduate Level');
1723: return &mt($gradelevels{$gradelevel});
1724: }
1725:
1.163 www 1726: sub select_level_form {
1727: my ($deflevel,$name)=@_;
1728: unless ($deflevel) { $deflevel=0; }
1.167 www 1729: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1730: for (my $i=0; $i<=18; $i++) {
1731: $selectform.="<option value=\"$i\" ".
1.253 albertel 1732: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1733: ">".&gradeleveldescription($i)."</option>\n";
1734: }
1735: $selectform.="</select>";
1736: return $selectform;
1.163 www 1737: }
1.167 www 1738:
1.35 matthew 1739: #-------------------------------------------
1740:
1.45 matthew 1741: =pod
1742:
1.648 raeburn 1743: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1744:
1745: Returns a string containing a <select name='$name' size='1'> form to
1746: allow a user to select the domain to preform an operation in.
1747: See loncreateuser.pm for an example invocation and use.
1748:
1.90 www 1749: If the $includeempty flag is set, it also includes an empty choice ("no domain
1750: selected");
1751:
1.563 raeburn 1752: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1753:
1.35 matthew 1754: =cut
1755:
1756: #-------------------------------------------
1.34 matthew 1757: sub select_dom_form {
1.563 raeburn 1758: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1759: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1760: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1761: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1762: foreach my $dom (@domains) {
1763: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1764: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1765: if ($showdomdesc) {
1766: if ($dom ne '') {
1767: my $domdesc = &Apache::lonnet::domain($dom,'description');
1768: if ($domdesc ne '') {
1769: $selectdomain .= ' ('.$domdesc.')';
1770: }
1771: }
1772: }
1773: $selectdomain .= "</option>\n";
1.34 matthew 1774: }
1775: $selectdomain.="</select>";
1776: return $selectdomain;
1777: }
1778:
1.35 matthew 1779: #-------------------------------------------
1780:
1.45 matthew 1781: =pod
1782:
1.648 raeburn 1783: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1784:
1.586 raeburn 1785: input: 4 arguments (two required, two optional) -
1786: $domain - domain of new user
1787: $name - name of form element
1788: $default - Value of 'default' causes a default item to be first
1789: option, and selected by default.
1790: $hide - Value of 'hide' causes hiding of the name of the server,
1791: if 1 server found, or default, if 0 found.
1.594 raeburn 1792: output: returns 2 items:
1.586 raeburn 1793: (a) form element which contains either:
1794: (i) <select name="$name">
1795: <option value="$hostid1">$hostid $servers{$hostid}</option>
1796: <option value="$hostid2">$hostid $servers{$hostid}</option>
1797: </select>
1798: form item if there are multiple library servers in $domain, or
1799: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1800: if there is only one library server in $domain.
1801:
1802: (b) number of library servers found.
1803:
1804: See loncreateuser.pm for example of use.
1.35 matthew 1805:
1806: =cut
1807:
1808: #-------------------------------------------
1.586 raeburn 1809: sub home_server_form_item {
1810: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1811: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1812: my $result;
1813: my $numlib = keys(%servers);
1814: if ($numlib > 1) {
1815: $result .= '<select name="'.$name.'" />'."\n";
1816: if ($default) {
1817: $result .= '<option value="default" selected>'.&mt('default').
1818: '</option>'."\n";
1819: }
1820: foreach my $hostid (sort(keys(%servers))) {
1821: $result.= '<option value="'.$hostid.'">'.
1822: $hostid.' '.$servers{$hostid}."</option>\n";
1823: }
1824: $result .= '</select>'."\n";
1825: } elsif ($numlib == 1) {
1826: my $hostid;
1827: foreach my $item (keys(%servers)) {
1828: $hostid = $item;
1829: }
1830: $result .= '<input type="hidden" name="'.$name.'" value="'.
1831: $hostid.'" />';
1832: if (!$hide) {
1833: $result .= $hostid.' '.$servers{$hostid};
1834: }
1835: $result .= "\n";
1836: } elsif ($default) {
1837: $result .= '<input type="hidden" name="'.$name.
1838: '" value="default" />';
1839: if (!$hide) {
1840: $result .= &mt('default');
1841: }
1842: $result .= "\n";
1.33 matthew 1843: }
1.586 raeburn 1844: return ($result,$numlib);
1.33 matthew 1845: }
1.112 bowersj2 1846:
1847: =pod
1848:
1.534 albertel 1849: =back
1850:
1.112 bowersj2 1851: =cut
1.87 matthew 1852:
1853: ###############################################################
1.112 bowersj2 1854: ## Decoding User Agent ##
1.87 matthew 1855: ###############################################################
1856:
1857: =pod
1858:
1.112 bowersj2 1859: =head1 Decoding the User Agent
1860:
1861: =over 4
1862:
1863: =item * &decode_user_agent()
1.87 matthew 1864:
1865: Inputs: $r
1866:
1867: Outputs:
1868:
1869: =over 4
1870:
1.112 bowersj2 1871: =item * $httpbrowser
1.87 matthew 1872:
1.112 bowersj2 1873: =item * $clientbrowser
1.87 matthew 1874:
1.112 bowersj2 1875: =item * $clientversion
1.87 matthew 1876:
1.112 bowersj2 1877: =item * $clientmathml
1.87 matthew 1878:
1.112 bowersj2 1879: =item * $clientunicode
1.87 matthew 1880:
1.112 bowersj2 1881: =item * $clientos
1.87 matthew 1882:
1883: =back
1884:
1.157 matthew 1885: =back
1886:
1.87 matthew 1887: =cut
1888:
1889: ###############################################################
1890: ###############################################################
1891: sub decode_user_agent {
1.247 albertel 1892: my ($r)=@_;
1.87 matthew 1893: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1894: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1895: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1896: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1897: my $clientbrowser='unknown';
1898: my $clientversion='0';
1899: my $clientmathml='';
1900: my $clientunicode='0';
1901: for (my $i=0;$i<=$#browsertype;$i++) {
1902: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1903: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1904: $clientbrowser=$bname;
1905: $httpbrowser=~/$vreg/i;
1906: $clientversion=$1;
1907: $clientmathml=($clientversion>=$minv);
1908: $clientunicode=($clientversion>=$univ);
1909: }
1910: }
1911: my $clientos='unknown';
1912: if (($httpbrowser=~/linux/i) ||
1913: ($httpbrowser=~/unix/i) ||
1914: ($httpbrowser=~/ux/i) ||
1915: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1916: if (($httpbrowser=~/vax/i) ||
1917: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1918: if ($httpbrowser=~/next/i) { $clientos='next'; }
1919: if (($httpbrowser=~/mac/i) ||
1920: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1921: if ($httpbrowser=~/win/i) { $clientos='win'; }
1922: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1923: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1924: $clientunicode,$clientos,);
1925: }
1926:
1.32 matthew 1927: ###############################################################
1928: ## Authentication changing form generation subroutines ##
1929: ###############################################################
1930: ##
1931: ## All of the authform_xxxxxxx subroutines take their inputs in a
1932: ## hash, and have reasonable default values.
1933: ##
1934: ## formname = the name given in the <form> tag.
1.35 matthew 1935: #-------------------------------------------
1936:
1.45 matthew 1937: =pod
1938:
1.112 bowersj2 1939: =head1 Authentication Routines
1940:
1941: =over 4
1942:
1.648 raeburn 1943: =item * &authform_xxxxxx()
1.35 matthew 1944:
1945: The authform_xxxxxx subroutines provide javascript and html forms which
1946: handle some of the conveniences required for authentication forms.
1947: This is not an optimal method, but it works.
1948:
1949: =over 4
1950:
1.112 bowersj2 1951: =item * authform_header
1.35 matthew 1952:
1.112 bowersj2 1953: =item * authform_authorwarning
1.35 matthew 1954:
1.112 bowersj2 1955: =item * authform_nochange
1.35 matthew 1956:
1.112 bowersj2 1957: =item * authform_kerberos
1.35 matthew 1958:
1.112 bowersj2 1959: =item * authform_internal
1.35 matthew 1960:
1.112 bowersj2 1961: =item * authform_filesystem
1.35 matthew 1962:
1963: =back
1964:
1.648 raeburn 1965: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.32 matthew 1970: sub authform_header{
1971: my %in = (
1972: formname => 'cu',
1.80 albertel 1973: kerb_def_dom => '',
1.32 matthew 1974: @_,
1975: );
1976: $in{'formname'} = 'document.' . $in{'formname'};
1977: my $result='';
1.80 albertel 1978:
1979: #---------------------------------------------- Code for upper case translation
1980: my $Javascript_toUpperCase;
1981: unless ($in{kerb_def_dom}) {
1982: $Javascript_toUpperCase =<<"END";
1983: switch (choice) {
1984: case 'krb': currentform.elements[choicearg].value =
1985: currentform.elements[choicearg].value.toUpperCase();
1986: break;
1987: default:
1988: }
1989: END
1990: } else {
1991: $Javascript_toUpperCase = "";
1992: }
1993:
1.165 raeburn 1994: my $radioval = "'nochange'";
1.591 raeburn 1995: if (defined($in{'curr_authtype'})) {
1996: if ($in{'curr_authtype'} ne '') {
1997: $radioval = "'".$in{'curr_authtype'}."arg'";
1998: }
1.174 matthew 1999: }
1.165 raeburn 2000: my $argfield = 'null';
1.591 raeburn 2001: if (defined($in{'mode'})) {
1.165 raeburn 2002: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2003: if (defined($in{'curr_autharg'})) {
2004: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2005: $argfield = "'$in{'curr_autharg'}'";
2006: }
2007: }
2008: }
2009: }
2010:
1.32 matthew 2011: $result.=<<"END";
2012: var current = new Object();
1.165 raeburn 2013: current.radiovalue = $radioval;
2014: current.argfield = $argfield;
1.32 matthew 2015:
2016: function changed_radio(choice,currentform) {
2017: var choicearg = choice + 'arg';
2018: // If a radio button in changed, we need to change the argfield
2019: if (current.radiovalue != choice) {
2020: current.radiovalue = choice;
2021: if (current.argfield != null) {
2022: currentform.elements[current.argfield].value = '';
2023: }
2024: if (choice == 'nochange') {
2025: current.argfield = null;
2026: } else {
2027: current.argfield = choicearg;
2028: switch(choice) {
2029: case 'krb':
2030: currentform.elements[current.argfield].value =
2031: "$in{'kerb_def_dom'}";
2032: break;
2033: default:
2034: break;
2035: }
2036: }
2037: }
2038: return;
2039: }
1.22 www 2040:
1.32 matthew 2041: function changed_text(choice,currentform) {
2042: var choicearg = choice + 'arg';
2043: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2044: $Javascript_toUpperCase
1.32 matthew 2045: // clear old field
2046: if ((current.argfield != choicearg) && (current.argfield != null)) {
2047: currentform.elements[current.argfield].value = '';
2048: }
2049: current.argfield = choicearg;
2050: }
2051: set_auth_radio_buttons(choice,currentform);
2052: return;
1.20 www 2053: }
1.32 matthew 2054:
2055: function set_auth_radio_buttons(newvalue,currentform) {
2056: var i=0;
2057: while (i < currentform.login.length) {
2058: if (currentform.login[i].value == newvalue) { break; }
2059: i++;
2060: }
2061: if (i == currentform.login.length) {
2062: return;
2063: }
2064: current.radiovalue = newvalue;
2065: currentform.login[i].checked = true;
2066: return;
2067: }
2068: END
2069: return $result;
2070: }
2071:
2072: sub authform_authorwarning{
2073: my $result='';
1.144 matthew 2074: $result='<i>'.
2075: &mt('As a general rule, only authors or co-authors should be '.
2076: 'filesystem authenticated '.
2077: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2078: return $result;
2079: }
2080:
2081: sub authform_nochange{
2082: my %in = (
2083: formname => 'document.cu',
2084: kerb_def_dom => 'MSU.EDU',
2085: @_,
2086: );
1.586 raeburn 2087: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2088: my $result;
2089: if (keys(%can_assign) == 0) {
2090: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2091: } else {
2092: $result = '<label>'.&mt('[_1] Do not change login data',
2093: '<input type="radio" name="login" value="nochange" '.
2094: 'checked="checked" onclick="'.
1.281 albertel 2095: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2096: '</label>';
1.586 raeburn 2097: }
1.32 matthew 2098: return $result;
2099: }
2100:
1.591 raeburn 2101: sub authform_kerberos {
1.32 matthew 2102: my %in = (
2103: formname => 'document.cu',
2104: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2105: kerb_def_auth => 'krb4',
1.32 matthew 2106: @_,
2107: );
1.586 raeburn 2108: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2109: $autharg,$jscall);
2110: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2111: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2112: $check5 = ' checked="on"';
1.80 albertel 2113: } else {
1.586 raeburn 2114: $check4 = ' checked="on"';
1.80 albertel 2115: }
1.165 raeburn 2116: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2117: if (defined($in{'curr_authtype'})) {
2118: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2119: $krbcheck = ' checked="on"';
1.623 raeburn 2120: if (defined($in{'mode'})) {
2121: if ($in{'mode'} eq 'modifyuser') {
2122: $krbcheck = '';
2123: }
2124: }
1.591 raeburn 2125: if (defined($in{'curr_kerb_ver'})) {
2126: if ($in{'curr_krb_ver'} eq '5') {
2127: $check5 = ' checked="on"';
2128: $check4 = '';
2129: } else {
2130: $check4 = ' checked="on"';
2131: $check5 = '';
2132: }
1.586 raeburn 2133: }
1.591 raeburn 2134: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2135: $krbarg = $in{'curr_autharg'};
2136: }
1.586 raeburn 2137: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2138: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2139: $result =
2140: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2141: $in{'curr_autharg'},$krbver);
2142: } else {
2143: $result =
2144: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2145: }
2146: return $result;
2147: }
2148: }
2149: } else {
2150: if ($authnum == 1) {
2151: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2152: }
2153: }
1.586 raeburn 2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2155: return;
1.587 raeburn 2156: } elsif ($authtype eq '') {
1.591 raeburn 2157: if (defined($in{'mode'})) {
1.587 raeburn 2158: if ($in{'mode'} eq 'modifycourse') {
2159: if ($authnum == 1) {
2160: $authtype = '<input type="hidden" name="login" value="krb">';
2161: }
2162: }
2163: }
1.586 raeburn 2164: }
2165: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2166: if ($authtype eq '') {
2167: $authtype = '<input type="radio" name="login" value="krb" '.
2168: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2169: $krbcheck.' />';
2170: }
2171: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2172: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2173: $in{'curr_authtype'} eq 'krb5') ||
2174: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2175: $in{'curr_authtype'} eq 'krb4')) {
2176: $result .= &mt
1.144 matthew 2177: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2178: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2179: '<label>'.$authtype,
1.281 albertel 2180: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2181: 'value="'.$krbarg.'" '.
1.144 matthew 2182: 'onchange="'.$jscall.'" />',
1.281 albertel 2183: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2184: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2185: '</label>');
1.586 raeburn 2186: } elsif ($can_assign{'krb4'}) {
2187: $result .= &mt
2188: ('[_1] Kerberos authenticated with domain [_2] '.
2189: '[_3] Version 4 [_4]',
2190: '<label>'.$authtype,
2191: '</label><input type="text" size="10" name="krbarg" '.
2192: 'value="'.$krbarg.'" '.
2193: 'onchange="'.$jscall.'" />',
2194: '<label><input type="hidden" name="krbver" value="4" />',
2195: '</label>');
2196: } elsif ($can_assign{'krb5'}) {
2197: $result .= &mt
2198: ('[_1] Kerberos authenticated with domain [_2] '.
2199: '[_3] Version 5 [_4]',
2200: '<label>'.$authtype,
2201: '</label><input type="text" size="10" name="krbarg" '.
2202: 'value="'.$krbarg.'" '.
2203: 'onchange="'.$jscall.'" />',
2204: '<label><input type="hidden" name="krbver" value="5" />',
2205: '</label>');
2206: }
1.32 matthew 2207: return $result;
2208: }
2209:
2210: sub authform_internal{
1.586 raeburn 2211: my %in = (
1.32 matthew 2212: formname => 'document.cu',
2213: kerb_def_dom => 'MSU.EDU',
2214: @_,
2215: );
1.586 raeburn 2216: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2217: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2218: if (defined($in{'curr_authtype'})) {
2219: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2220: if ($can_assign{'int'}) {
2221: $intcheck = 'checked="on" ';
1.623 raeburn 2222: if (defined($in{'mode'})) {
2223: if ($in{'mode'} eq 'modifyuser') {
2224: $intcheck = '';
2225: }
2226: }
1.591 raeburn 2227: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2228: $intarg = $in{'curr_autharg'};
2229: }
2230: } else {
2231: $result = &mt('Currently internally authenticated.');
2232: return $result;
1.165 raeburn 2233: }
2234: }
1.586 raeburn 2235: } else {
2236: if ($authnum == 1) {
2237: $authtype = '<input type="hidden" name="login" value="int">';
2238: }
2239: }
2240: if (!$can_assign{'int'}) {
2241: return;
1.587 raeburn 2242: } elsif ($authtype eq '') {
1.591 raeburn 2243: if (defined($in{'mode'})) {
1.587 raeburn 2244: if ($in{'mode'} eq 'modifycourse') {
2245: if ($authnum == 1) {
2246: $authtype = '<input type="hidden" name="login" value="int">';
2247: }
2248: }
2249: }
1.165 raeburn 2250: }
1.586 raeburn 2251: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2252: if ($authtype eq '') {
2253: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2254: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2255: }
1.605 bisitz 2256: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2257: $intarg.'" onchange="'.$jscall.'" />';
2258: $result = &mt
1.144 matthew 2259: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2260: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2261: $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2262: return $result;
2263: }
2264:
2265: sub authform_local{
2266: my %in = (
2267: formname => 'document.cu',
2268: kerb_def_dom => 'MSU.EDU',
2269: @_,
2270: );
1.586 raeburn 2271: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2272: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2273: if (defined($in{'curr_authtype'})) {
2274: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2275: if ($can_assign{'loc'}) {
2276: $loccheck = 'checked="on" ';
1.623 raeburn 2277: if (defined($in{'mode'})) {
2278: if ($in{'mode'} eq 'modifyuser') {
2279: $loccheck = '';
2280: }
2281: }
1.591 raeburn 2282: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2283: $locarg = $in{'curr_autharg'};
2284: }
2285: } else {
2286: $result = &mt('Currently using local (institutional) authentication.');
2287: return $result;
1.165 raeburn 2288: }
2289: }
1.586 raeburn 2290: } else {
2291: if ($authnum == 1) {
2292: $authtype = '<input type="hidden" name="login" value="loc">';
2293: }
2294: }
2295: if (!$can_assign{'loc'}) {
2296: return;
1.587 raeburn 2297: } elsif ($authtype eq '') {
1.591 raeburn 2298: if (defined($in{'mode'})) {
1.587 raeburn 2299: if ($in{'mode'} eq 'modifycourse') {
2300: if ($authnum == 1) {
2301: $authtype = '<input type="hidden" name="login" value="loc">';
2302: }
2303: }
2304: }
1.165 raeburn 2305: }
1.586 raeburn 2306: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2307: if ($authtype eq '') {
2308: $authtype = '<input type="radio" name="login" value="loc" '.
2309: $loccheck.' onchange="'.$jscall.'" onclick="'.
2310: $jscall.'" />';
2311: }
2312: $autharg = '<input type="text" size="10" name="locarg" value="'.
2313: $locarg.'" onchange="'.$jscall.'" />';
2314: $result = &mt('[_1] Local Authentication with argument [_2]',
2315: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2316: return $result;
2317: }
2318:
2319: sub authform_filesystem{
2320: my %in = (
2321: formname => 'document.cu',
2322: kerb_def_dom => 'MSU.EDU',
2323: @_,
2324: );
1.586 raeburn 2325: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2326: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2327: if (defined($in{'curr_authtype'})) {
2328: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2329: if ($can_assign{'fsys'}) {
2330: $fsyscheck = 'checked="on" ';
1.623 raeburn 2331: if (defined($in{'mode'})) {
2332: if ($in{'mode'} eq 'modifyuser') {
2333: $fsyscheck = '';
2334: }
2335: }
1.586 raeburn 2336: } else {
2337: $result = &mt('Currently Filesystem Authenticated.');
2338: return $result;
2339: }
2340: }
2341: } else {
2342: if ($authnum == 1) {
2343: $authtype = '<input type="hidden" name="login" value="fsys">';
2344: }
2345: }
2346: if (!$can_assign{'fsys'}) {
2347: return;
1.587 raeburn 2348: } elsif ($authtype eq '') {
1.591 raeburn 2349: if (defined($in{'mode'})) {
1.587 raeburn 2350: if ($in{'mode'} eq 'modifycourse') {
2351: if ($authnum == 1) {
2352: $authtype = '<input type="hidden" name="login" value="fsys">';
2353: }
2354: }
2355: }
1.586 raeburn 2356: }
2357: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2358: if ($authtype eq '') {
2359: $authtype = '<input type="radio" name="login" value="fsys" '.
2360: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2361: $jscall.'" />';
2362: }
2363: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2364: ' onchange="'.$jscall.'" />';
2365: $result = &mt
1.144 matthew 2366: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2367: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2368: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2369: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2370: 'onchange="'.$jscall.'" />');
1.32 matthew 2371: return $result;
2372: }
2373:
1.586 raeburn 2374: sub get_assignable_auth {
2375: my ($dom) = @_;
2376: if ($dom eq '') {
2377: $dom = $env{'request.role.domain'};
2378: }
2379: my %can_assign = (
2380: krb4 => 1,
2381: krb5 => 1,
2382: int => 1,
2383: loc => 1,
2384: );
2385: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2386: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2387: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2388: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2389: my $context;
2390: if ($env{'request.role'} =~ /^au/) {
2391: $context = 'author';
2392: } elsif ($env{'request.role'} =~ /^dc/) {
2393: $context = 'domain';
2394: } elsif ($env{'request.course.id'}) {
2395: $context = 'course';
2396: }
2397: if ($context) {
2398: if (ref($authhash->{$context}) eq 'HASH') {
2399: %can_assign = %{$authhash->{$context}};
2400: }
2401: }
2402: }
2403: }
2404: my $authnum = 0;
2405: foreach my $key (keys(%can_assign)) {
2406: if ($can_assign{$key}) {
2407: $authnum ++;
2408: }
2409: }
2410: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2411: $authnum --;
2412: }
2413: return ($authnum,%can_assign);
2414: }
2415:
1.80 albertel 2416: ###############################################################
2417: ## Get Kerberos Defaults for Domain ##
2418: ###############################################################
2419: ##
2420: ## Returns default kerberos version and an associated argument
2421: ## as listed in file domain.tab. If not listed, provides
2422: ## appropriate default domain and kerberos version.
2423: ##
2424: #-------------------------------------------
2425:
2426: =pod
2427:
1.648 raeburn 2428: =item * &get_kerberos_defaults()
1.80 albertel 2429:
2430: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2431: version and domain. If not found, it defaults to version 4 and the
2432: domain of the server.
1.80 albertel 2433:
1.648 raeburn 2434: =over 4
2435:
1.80 albertel 2436: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2437:
1.648 raeburn 2438: =back
2439:
2440: =back
2441:
1.80 albertel 2442: =cut
2443:
2444: #-------------------------------------------
2445: sub get_kerberos_defaults {
2446: my $domain=shift;
1.641 raeburn 2447: my ($krbdef,$krbdefdom);
2448: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2449: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2450: $krbdef = $domdefaults{'auth_def'};
2451: $krbdefdom = $domdefaults{'auth_arg_def'};
2452: } else {
1.80 albertel 2453: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2454: my $krbdefdom=$1;
2455: $krbdefdom=~tr/a-z/A-Z/;
2456: $krbdef = "krb4";
2457: }
2458: return ($krbdef,$krbdefdom);
2459: }
1.112 bowersj2 2460:
1.32 matthew 2461:
1.46 matthew 2462: ###############################################################
2463: ## Thesaurus Functions ##
2464: ###############################################################
1.20 www 2465:
1.46 matthew 2466: =pod
1.20 www 2467:
1.112 bowersj2 2468: =head1 Thesaurus Functions
2469:
2470: =over 4
2471:
1.648 raeburn 2472: =item * &initialize_keywords()
1.46 matthew 2473:
2474: Initializes the package variable %Keywords if it is empty. Uses the
2475: package variable $thesaurus_db_file.
2476:
2477: =cut
2478:
2479: ###################################################
2480:
2481: sub initialize_keywords {
2482: return 1 if (scalar keys(%Keywords));
2483: # If we are here, %Keywords is empty, so fill it up
2484: # Make sure the file we need exists...
2485: if (! -e $thesaurus_db_file) {
2486: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2487: " failed because it does not exist");
2488: return 0;
2489: }
2490: # Set up the hash as a database
2491: my %thesaurus_db;
2492: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2493: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2494: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2495: $thesaurus_db_file);
2496: return 0;
2497: }
2498: # Get the average number of appearances of a word.
2499: my $avecount = $thesaurus_db{'average.count'};
2500: # Put keywords (those that appear > average) into %Keywords
2501: while (my ($word,$data)=each (%thesaurus_db)) {
2502: my ($count,undef) = split /:/,$data;
2503: $Keywords{$word}++ if ($count > $avecount);
2504: }
2505: untie %thesaurus_db;
2506: # Remove special values from %Keywords.
1.356 albertel 2507: foreach my $value ('total.count','average.count') {
2508: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2509: }
1.46 matthew 2510: return 1;
2511: }
2512:
2513: ###################################################
2514:
2515: =pod
2516:
1.648 raeburn 2517: =item * &keyword($word)
1.46 matthew 2518:
2519: Returns true if $word is a keyword. A keyword is a word that appears more
2520: than the average number of times in the thesaurus database. Calls
2521: &initialize_keywords
2522:
2523: =cut
2524:
2525: ###################################################
1.20 www 2526:
2527: sub keyword {
1.46 matthew 2528: return if (!&initialize_keywords());
2529: my $word=lc(shift());
2530: $word=~s/\W//g;
2531: return exists($Keywords{$word});
1.20 www 2532: }
1.46 matthew 2533:
2534: ###############################################################
2535:
2536: =pod
1.20 www 2537:
1.648 raeburn 2538: =item * &get_related_words()
1.46 matthew 2539:
1.160 matthew 2540: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2541: an array of words. If the keyword is not in the thesaurus, an empty array
2542: will be returned. The order of the words returned is determined by the
2543: database which holds them.
2544:
2545: Uses global $thesaurus_db_file.
2546:
2547: =cut
2548:
2549: ###############################################################
2550: sub get_related_words {
2551: my $keyword = shift;
2552: my %thesaurus_db;
2553: if (! -e $thesaurus_db_file) {
2554: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2555: "failed because the file does not exist");
2556: return ();
2557: }
2558: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2559: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2560: return ();
2561: }
2562: my @Words=();
1.429 www 2563: my $count=0;
1.46 matthew 2564: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2565: # The first element is the number of times
2566: # the word appears. We do not need it now.
1.429 www 2567: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2568: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2569: my $threshold=$mostfrequentcount/10;
2570: foreach my $possibleword (@RelatedWords) {
2571: my ($word,$wordcount)=split(/\,/,$possibleword);
2572: if ($wordcount>$threshold) {
2573: push(@Words,$word);
2574: $count++;
2575: if ($count>10) { last; }
2576: }
1.20 www 2577: }
2578: }
1.46 matthew 2579: untie %thesaurus_db;
2580: return @Words;
1.14 harris41 2581: }
1.46 matthew 2582:
1.112 bowersj2 2583: =pod
2584:
2585: =back
2586:
2587: =cut
1.61 www 2588:
2589: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2590: =pod
2591:
1.112 bowersj2 2592: =head1 User Name Functions
2593:
2594: =over 4
2595:
1.648 raeburn 2596: =item * &plainname($uname,$udom,$first)
1.81 albertel 2597:
1.112 bowersj2 2598: Takes a users logon name and returns it as a string in
1.226 albertel 2599: "first middle last generation" form
2600: if $first is set to 'lastname' then it returns it as
2601: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2602:
2603: =cut
1.61 www 2604:
1.295 www 2605:
1.81 albertel 2606: ###############################################################
1.61 www 2607: sub plainname {
1.226 albertel 2608: my ($uname,$udom,$first)=@_;
1.537 albertel 2609: return if (!defined($uname) || !defined($udom));
1.295 www 2610: my %names=&getnames($uname,$udom);
1.226 albertel 2611: my $name=&Apache::lonnet::format_name($names{'firstname'},
2612: $names{'middlename'},
2613: $names{'lastname'},
2614: $names{'generation'},$first);
2615: $name=~s/^\s+//;
1.62 www 2616: $name=~s/\s+$//;
2617: $name=~s/\s+/ /g;
1.353 albertel 2618: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2619: return $name;
1.61 www 2620: }
1.66 www 2621:
2622: # -------------------------------------------------------------------- Nickname
1.81 albertel 2623: =pod
2624:
1.648 raeburn 2625: =item * &nickname($uname,$udom)
1.81 albertel 2626:
2627: Gets a users name and returns it as a string as
2628:
2629: ""nickname""
1.66 www 2630:
1.81 albertel 2631: if the user has a nickname or
2632:
2633: "first middle last generation"
2634:
2635: if the user does not
2636:
2637: =cut
1.66 www 2638:
2639: sub nickname {
2640: my ($uname,$udom)=@_;
1.537 albertel 2641: return if (!defined($uname) || !defined($udom));
1.295 www 2642: my %names=&getnames($uname,$udom);
1.68 albertel 2643: my $name=$names{'nickname'};
1.66 www 2644: if ($name) {
2645: $name='"'.$name.'"';
2646: } else {
2647: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2648: $names{'lastname'}.' '.$names{'generation'};
2649: $name=~s/\s+$//;
2650: $name=~s/\s+/ /g;
2651: }
2652: return $name;
2653: }
2654:
1.295 www 2655: sub getnames {
2656: my ($uname,$udom)=@_;
1.537 albertel 2657: return if (!defined($uname) || !defined($udom));
1.433 albertel 2658: if ($udom eq 'public' && $uname eq 'public') {
2659: return ('lastname' => &mt('Public'));
2660: }
1.295 www 2661: my $id=$uname.':'.$udom;
2662: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2663: if ($cached) {
2664: return %{$names};
2665: } else {
2666: my %loadnames=&Apache::lonnet::get('environment',
2667: ['firstname','middlename','lastname','generation','nickname'],
2668: $udom,$uname);
2669: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2670: return %loadnames;
2671: }
2672: }
1.61 www 2673:
1.542 raeburn 2674: # -------------------------------------------------------------------- getemails
1.648 raeburn 2675:
1.542 raeburn 2676: =pod
2677:
1.648 raeburn 2678: =item * &getemails($uname,$udom)
1.542 raeburn 2679:
2680: Gets a user's email information and returns it as a hash with keys:
2681: notification, critnotification, permanentemail
2682:
2683: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2684: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2685:
1.648 raeburn 2686:
1.542 raeburn 2687: =cut
2688:
1.648 raeburn 2689:
1.466 albertel 2690: sub getemails {
2691: my ($uname,$udom)=@_;
2692: if ($udom eq 'public' && $uname eq 'public') {
2693: return;
2694: }
1.467 www 2695: if (!$udom) { $udom=$env{'user.domain'}; }
2696: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2697: my $id=$uname.':'.$udom;
2698: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2699: if ($cached) {
2700: return %{$names};
2701: } else {
2702: my %loadnames=&Apache::lonnet::get('environment',
2703: ['notification','critnotification',
2704: 'permanentemail'],
2705: $udom,$uname);
2706: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2707: return %loadnames;
2708: }
2709: }
2710:
1.551 albertel 2711: sub flush_email_cache {
2712: my ($uname,$udom)=@_;
2713: if (!$udom) { $udom =$env{'user.domain'}; }
2714: if (!$uname) { $uname=$env{'user.name'}; }
2715: return if ($udom eq 'public' && $uname eq 'public');
2716: my $id=$uname.':'.$udom;
2717: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2718: }
2719:
1.61 www 2720: # ------------------------------------------------------------------ Screenname
1.81 albertel 2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &screenname($uname,$udom)
1.81 albertel 2725:
2726: Gets a users screenname and returns it as a string
2727:
2728: =cut
1.61 www 2729:
2730: sub screenname {
2731: my ($uname,$udom)=@_;
1.258 albertel 2732: if ($uname eq $env{'user.name'} &&
2733: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2734: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2735: return $names{'screenname'};
1.62 www 2736: }
2737:
1.212 albertel 2738:
1.62 www 2739: # ------------------------------------------------------------- Message Wrapper
2740:
2741: sub messagewrapper {
1.369 www 2742: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2743: return
1.441 albertel 2744: '<a href="/adm/email?compose=individual&'.
2745: 'recname='.$username.'&recdom='.$domain.
2746: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2747: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2748: }
2749: # --------------------------------------------------------------- Notes Wrapper
2750:
2751: sub noteswrapper {
2752: my ($link,$un,$do)=@_;
2753: return
2754: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2755: }
2756: # ------------------------------------------------------------- Aboutme Wrapper
2757:
2758: sub aboutmewrapper {
1.166 www 2759: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2760: if (!defined($username) && !defined($domain)) {
2761: return;
2762: }
1.205 www 2763: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2764: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2765: }
2766:
2767: # ------------------------------------------------------------ Syllabus Wrapper
2768:
2769:
2770: sub syllabuswrapper {
1.707 ! bisitz 2771: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2772: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2773: }
1.14 harris41 2774:
1.208 matthew 2775: sub track_student_link {
1.268 albertel 2776: my ($linktext,$sname,$sdom,$target,$start) = @_;
2777: my $link ="/adm/trackstudent?";
1.208 matthew 2778: my $title = 'View recent activity';
2779: if (defined($sname) && $sname !~ /^\s*$/ &&
2780: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2781: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2782: $title .= ' of this student';
1.268 albertel 2783: }
1.208 matthew 2784: if (defined($target) && $target !~ /^\s*$/) {
2785: $target = qq{target="$target"};
2786: } else {
2787: $target = '';
2788: }
1.268 albertel 2789: if ($start) { $link.='&start='.$start; }
1.554 albertel 2790: $title = &mt($title);
2791: $linktext = &mt($linktext);
1.448 albertel 2792: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2793: &help_open_topic('View_recent_activity');
1.208 matthew 2794: }
2795:
1.508 www 2796: # ===================================================== Display a student photo
2797:
2798:
1.509 albertel 2799: sub student_image_tag {
1.508 www 2800: my ($domain,$user)=@_;
2801: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2802: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2803: return '<img src="'.$imgsrc.'" align="right" />';
2804: } else {
2805: return '';
2806: }
2807: }
2808:
1.112 bowersj2 2809: =pod
2810:
2811: =back
2812:
2813: =head1 Access .tab File Data
2814:
2815: =over 4
2816:
1.648 raeburn 2817: =item * &languageids()
1.112 bowersj2 2818:
2819: returns list of all language ids
2820:
2821: =cut
2822:
1.14 harris41 2823: sub languageids {
1.16 harris41 2824: return sort(keys(%language));
1.14 harris41 2825: }
2826:
1.112 bowersj2 2827: =pod
2828:
1.648 raeburn 2829: =item * &languagedescription()
1.112 bowersj2 2830:
2831: returns description of a specified language id
2832:
2833: =cut
2834:
1.14 harris41 2835: sub languagedescription {
1.125 www 2836: my $code=shift;
2837: return ($supported_language{$code}?'* ':'').
2838: $language{$code}.
1.126 www 2839: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2840: }
2841:
2842: sub plainlanguagedescription {
2843: my $code=shift;
2844: return $language{$code};
2845: }
2846:
2847: sub supportedlanguagecode {
2848: my $code=shift;
2849: return $supported_language{$code};
1.97 www 2850: }
2851:
1.112 bowersj2 2852: =pod
2853:
1.648 raeburn 2854: =item * ©rightids()
1.112 bowersj2 2855:
2856: returns list of all copyrights
2857:
2858: =cut
2859:
2860: sub copyrightids {
2861: return sort(keys(%cprtag));
2862: }
2863:
2864: =pod
2865:
1.648 raeburn 2866: =item * ©rightdescription()
1.112 bowersj2 2867:
2868: returns description of a specified copyright id
2869:
2870: =cut
2871:
2872: sub copyrightdescription {
1.166 www 2873: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2874: }
1.197 matthew 2875:
2876: =pod
2877:
1.648 raeburn 2878: =item * &source_copyrightids()
1.192 taceyjo1 2879:
2880: returns list of all source copyrights
2881:
2882: =cut
2883:
2884: sub source_copyrightids {
2885: return sort(keys(%scprtag));
2886: }
2887:
2888: =pod
2889:
1.648 raeburn 2890: =item * &source_copyrightdescription()
1.192 taceyjo1 2891:
2892: returns description of a specified source copyright id
2893:
2894: =cut
2895:
2896: sub source_copyrightdescription {
2897: return &mt($scprtag{shift(@_)});
2898: }
1.112 bowersj2 2899:
2900: =pod
2901:
1.648 raeburn 2902: =item * &filecategories()
1.112 bowersj2 2903:
2904: returns list of all file categories
2905:
2906: =cut
2907:
2908: sub filecategories {
2909: return sort(keys(%category_extensions));
2910: }
2911:
2912: =pod
2913:
1.648 raeburn 2914: =item * &filecategorytypes()
1.112 bowersj2 2915:
2916: returns list of file types belonging to a given file
2917: category
2918:
2919: =cut
2920:
2921: sub filecategorytypes {
1.356 albertel 2922: my ($cat) = @_;
2923: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2924: }
2925:
2926: =pod
2927:
1.648 raeburn 2928: =item * &fileembstyle()
1.112 bowersj2 2929:
2930: returns embedding style for a specified file type
2931:
2932: =cut
2933:
2934: sub fileembstyle {
2935: return $fe{lc(shift(@_))};
1.169 www 2936: }
2937:
1.351 www 2938: sub filemimetype {
2939: return $fm{lc(shift(@_))};
2940: }
2941:
1.169 www 2942:
2943: sub filecategoryselect {
2944: my ($name,$value)=@_;
1.189 matthew 2945: return &select_form($value,$name,
1.169 www 2946: '' => &mt('Any category'),
2947: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2948: }
2949:
2950: =pod
2951:
1.648 raeburn 2952: =item * &filedescription()
1.112 bowersj2 2953:
2954: returns description for a specified file type
2955:
2956: =cut
2957:
2958: sub filedescription {
1.188 matthew 2959: my $file_description = $fd{lc(shift())};
2960: $file_description =~ s:([\[\]]):~$1:g;
2961: return &mt($file_description);
1.112 bowersj2 2962: }
2963:
2964: =pod
2965:
1.648 raeburn 2966: =item * &filedescriptionex()
1.112 bowersj2 2967:
2968: returns description for a specified file type with
2969: extra formatting
2970:
2971: =cut
2972:
2973: sub filedescriptionex {
2974: my $ex=shift;
1.188 matthew 2975: my $file_description = $fd{lc($ex)};
2976: $file_description =~ s:([\[\]]):~$1:g;
2977: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2978: }
2979:
2980: # End of .tab access
2981: =pod
2982:
2983: =back
2984:
2985: =cut
2986:
2987: # ------------------------------------------------------------------ File Types
2988: sub fileextensions {
2989: return sort(keys(%fe));
2990: }
2991:
1.97 www 2992: # ----------------------------------------------------------- Display Languages
2993: # returns a hash with all desired display languages
2994: #
2995:
2996: sub display_languages {
2997: my %languages=();
1.695 raeburn 2998: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 2999: $languages{$lang}=1;
1.97 www 3000: }
3001: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3002: if ($env{'form.displaylanguage'}) {
1.356 albertel 3003: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3004: $languages{$lang}=1;
1.97 www 3005: }
3006: }
3007: return %languages;
1.14 harris41 3008: }
3009:
1.582 albertel 3010: sub languages {
3011: my ($possible_langs) = @_;
1.695 raeburn 3012: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3013: if (!ref($possible_langs)) {
3014: if( wantarray ) {
3015: return @preferred_langs;
3016: } else {
3017: return $preferred_langs[0];
3018: }
3019: }
3020: my %possibilities = map { $_ => 1 } (@$possible_langs);
3021: my @preferred_possibilities;
3022: foreach my $preferred_lang (@preferred_langs) {
3023: if (exists($possibilities{$preferred_lang})) {
3024: push(@preferred_possibilities, $preferred_lang);
3025: }
3026: }
3027: if( wantarray ) {
3028: return @preferred_possibilities;
3029: }
3030: return $preferred_possibilities[0];
3031: }
3032:
1.112 bowersj2 3033: ###############################################################
3034: ## Student Answer Attempts ##
3035: ###############################################################
3036:
3037: =pod
3038:
3039: =head1 Alternate Problem Views
3040:
3041: =over 4
3042:
1.648 raeburn 3043: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3044: $getattempt, $regexp, $gradesub)
3045:
3046: Return string with previous attempt on problem. Arguments:
3047:
3048: =over 4
3049:
3050: =item * $symb: Problem, including path
3051:
3052: =item * $username: username of the desired student
3053:
3054: =item * $domain: domain of the desired student
1.14 harris41 3055:
1.112 bowersj2 3056: =item * $course: Course ID
1.14 harris41 3057:
1.112 bowersj2 3058: =item * $getattempt: Leave blank for all attempts, otherwise put
3059: something
1.14 harris41 3060:
1.112 bowersj2 3061: =item * $regexp: if string matches this regexp, the string will be
3062: sent to $gradesub
1.14 harris41 3063:
1.112 bowersj2 3064: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3065:
1.112 bowersj2 3066: =back
1.14 harris41 3067:
1.112 bowersj2 3068: The output string is a table containing all desired attempts, if any.
1.16 harris41 3069:
1.112 bowersj2 3070: =cut
1.1 albertel 3071:
3072: sub get_previous_attempt {
1.43 ng 3073: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3074: my $prevattempts='';
1.43 ng 3075: no strict 'refs';
1.1 albertel 3076: if ($symb) {
1.3 albertel 3077: my (%returnhash)=
3078: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3079: if ($returnhash{'version'}) {
3080: my %lasthash=();
3081: my $version;
3082: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3083: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3084: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3085: }
1.1 albertel 3086: }
1.596 albertel 3087: $prevattempts=&start_data_table().&start_data_table_header_row();
3088: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3089: foreach my $key (sort(keys(%lasthash))) {
3090: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3091: if ($#parts > 0) {
1.31 albertel 3092: my $data=$parts[-1];
3093: pop(@parts);
1.596 albertel 3094: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3095: } else {
1.41 ng 3096: if ($#parts == 0) {
3097: $prevattempts.='<th>'.$parts[0].'</th>';
3098: } else {
3099: $prevattempts.='<th>'.$ign.'</th>';
3100: }
1.31 albertel 3101: }
1.16 harris41 3102: }
1.596 albertel 3103: $prevattempts.=&end_data_table_header_row();
1.40 ng 3104: if ($getattempt eq '') {
3105: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3106: $prevattempts.=&start_data_table_row().
3107: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3108: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3109: my $value = &format_previous_attempt_value($key,
3110: $returnhash{$version.':'.$key});
3111: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3112: }
1.596 albertel 3113: $prevattempts.=&end_data_table_row();
1.40 ng 3114: }
1.1 albertel 3115: }
1.596 albertel 3116: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3117: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3118: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3119: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3120: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3121: }
1.596 albertel 3122: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3123: } else {
1.596 albertel 3124: $prevattempts=
3125: &start_data_table().&start_data_table_row().
3126: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3127: &end_data_table_row().&end_data_table();
1.1 albertel 3128: }
3129: } else {
1.596 albertel 3130: $prevattempts=
3131: &start_data_table().&start_data_table_row().
3132: '<td>'.&mt('No data.').'</td>'.
3133: &end_data_table_row().&end_data_table();
1.1 albertel 3134: }
1.10 albertel 3135: }
3136:
1.581 albertel 3137: sub format_previous_attempt_value {
3138: my ($key,$value) = @_;
3139: if ($key =~ /timestamp/) {
3140: $value = &Apache::lonlocal::locallocaltime($value);
3141: } elsif (ref($value) eq 'ARRAY') {
3142: $value = '('.join(', ', @{ $value }).')';
3143: } else {
3144: $value = &unescape($value);
3145: }
3146: return $value;
3147: }
3148:
3149:
1.107 albertel 3150: sub relative_to_absolute {
3151: my ($url,$output)=@_;
3152: my $parser=HTML::TokeParser->new(\$output);
3153: my $token;
3154: my $thisdir=$url;
3155: my @rlinks=();
3156: while ($token=$parser->get_token) {
3157: if ($token->[0] eq 'S') {
3158: if ($token->[1] eq 'a') {
3159: if ($token->[2]->{'href'}) {
3160: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3161: }
3162: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3163: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3164: } elsif ($token->[1] eq 'base') {
3165: $thisdir=$token->[2]->{'href'};
3166: }
3167: }
3168: }
3169: $thisdir=~s-/[^/]*$--;
1.356 albertel 3170: foreach my $link (@rlinks) {
3171: unless (($link=~/^http:\/\//i) ||
3172: ($link=~/^\//) ||
3173: ($link=~/^javascript:/i) ||
3174: ($link=~/^mailto:/i) ||
3175: ($link=~/^\#/)) {
3176: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3177: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3178: }
3179: }
3180: # -------------------------------------------------- Deal with Applet codebases
3181: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3182: return $output;
3183: }
3184:
1.112 bowersj2 3185: =pod
3186:
1.648 raeburn 3187: =item * &get_student_view()
1.112 bowersj2 3188:
3189: show a snapshot of what student was looking at
3190:
3191: =cut
3192:
1.10 albertel 3193: sub get_student_view {
1.186 albertel 3194: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3195: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3196: my (%form);
1.10 albertel 3197: my @elements=('symb','courseid','domain','username');
3198: foreach my $element (@elements) {
1.186 albertel 3199: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3200: }
1.186 albertel 3201: if (defined($moreenv)) {
3202: %form=(%form,%{$moreenv});
3203: }
1.236 albertel 3204: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3205: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3206: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3207: $userview=~s/\<body[^\>]*\>//gi;
3208: $userview=~s/\<\/body\>//gi;
3209: $userview=~s/\<html\>//gi;
3210: $userview=~s/\<\/html\>//gi;
3211: $userview=~s/\<head\>//gi;
3212: $userview=~s/\<\/head\>//gi;
3213: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3214: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3215: if (wantarray) {
3216: return ($userview,$response);
3217: } else {
3218: return $userview;
3219: }
3220: }
3221:
3222: sub get_student_view_with_retries {
3223: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3224:
3225: my $ok = 0; # True if we got a good response.
3226: my $content;
3227: my $response;
3228:
3229: # Try to get the student_view done. within the retries count:
3230:
3231: do {
3232: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3233: $ok = $response->is_success;
3234: if (!$ok) {
3235: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3236: }
3237: $retries--;
3238: } while (!$ok && ($retries > 0));
3239:
3240: if (!$ok) {
3241: $content = ''; # On error return an empty content.
3242: }
1.651 www 3243: if (wantarray) {
3244: return ($content, $response);
3245: } else {
3246: return $content;
3247: }
1.11 albertel 3248: }
3249:
1.112 bowersj2 3250: =pod
3251:
1.648 raeburn 3252: =item * &get_student_answers()
1.112 bowersj2 3253:
3254: show a snapshot of how student was answering problem
3255:
3256: =cut
3257:
1.11 albertel 3258: sub get_student_answers {
1.100 sakharuk 3259: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3260: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3261: my (%moreenv);
1.11 albertel 3262: my @elements=('symb','courseid','domain','username');
3263: foreach my $element (@elements) {
1.186 albertel 3264: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3265: }
1.186 albertel 3266: $moreenv{'grade_target'}='answer';
3267: %moreenv=(%form,%moreenv);
1.497 raeburn 3268: $feedurl = &Apache::lonnet::clutter($feedurl);
3269: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3270: return $userview;
1.1 albertel 3271: }
1.116 albertel 3272:
3273: =pod
3274:
3275: =item * &submlink()
3276:
1.242 albertel 3277: Inputs: $text $uname $udom $symb $target
1.116 albertel 3278:
3279: Returns: A link to grades.pm such as to see the SUBM view of a student
3280:
3281: =cut
3282:
3283: ###############################################
3284: sub submlink {
1.242 albertel 3285: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3286: if (!($uname && $udom)) {
3287: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3288: &Apache::lonnet::whichuser($symb);
1.116 albertel 3289: if (!$symb) { $symb=$cursymb; }
3290: }
1.254 matthew 3291: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3292: $symb=&escape($symb);
1.242 albertel 3293: if ($target) { $target="target=\"$target\""; }
3294: return '<a href="/adm/grades?&command=submission&'.
3295: 'symb='.$symb.'&student='.$uname.
3296: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3297: }
3298: ##############################################
3299:
3300: =pod
3301:
3302: =item * &pgrdlink()
3303:
3304: Inputs: $text $uname $udom $symb $target
3305:
3306: Returns: A link to grades.pm such as to see the PGRD view of a student
3307:
3308: =cut
3309:
3310: ###############################################
3311: sub pgrdlink {
3312: my $link=&submlink(@_);
3313: $link=~s/(&command=submission)/$1&showgrading=yes/;
3314: return $link;
3315: }
3316: ##############################################
3317:
3318: =pod
3319:
3320: =item * &pprmlink()
3321:
3322: Inputs: $text $uname $udom $symb $target
3323:
3324: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3325: student and a specific resource
1.242 albertel 3326:
3327: =cut
3328:
3329: ###############################################
3330: sub pprmlink {
3331: my ($text,$uname,$udom,$symb,$target)=@_;
3332: if (!($uname && $udom)) {
3333: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3334: &Apache::lonnet::whichuser($symb);
1.242 albertel 3335: if (!$symb) { $symb=$cursymb; }
3336: }
1.254 matthew 3337: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3338: $symb=&escape($symb);
1.242 albertel 3339: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3340: return '<a href="/adm/parmset?command=set&'.
3341: 'symb='.$symb.'&uname='.$uname.
3342: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3343: }
3344: ##############################################
1.37 matthew 3345:
1.112 bowersj2 3346: =pod
3347:
3348: =back
3349:
3350: =cut
3351:
1.37 matthew 3352: ###############################################
1.51 www 3353:
3354:
3355: sub timehash {
1.687 raeburn 3356: my ($thistime) = @_;
3357: my $timezone = &Apache::lonlocal::gettimezone();
3358: my $dt = DateTime->from_epoch(epoch => $thistime)
3359: ->set_time_zone($timezone);
3360: my $wday = $dt->day_of_week();
3361: if ($wday == 7) { $wday = 0; }
3362: return ( 'second' => $dt->second(),
3363: 'minute' => $dt->minute(),
3364: 'hour' => $dt->hour(),
3365: 'day' => $dt->day_of_month(),
3366: 'month' => $dt->month(),
3367: 'year' => $dt->year(),
3368: 'weekday' => $wday,
3369: 'dayyear' => $dt->day_of_year(),
3370: 'dlsav' => $dt->is_dst() );
1.51 www 3371: }
3372:
1.370 www 3373: sub utc_string {
3374: my ($date)=@_;
1.371 www 3375: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3376: }
3377:
1.51 www 3378: sub maketime {
3379: my %th=@_;
1.687 raeburn 3380: my ($epoch_time,$timezone,$dt);
3381: $timezone = &Apache::lonlocal::gettimezone();
3382: eval {
3383: $dt = DateTime->new( year => $th{'year'},
3384: month => $th{'month'},
3385: day => $th{'day'},
3386: hour => $th{'hour'},
3387: minute => $th{'minute'},
3388: second => $th{'second'},
3389: time_zone => $timezone,
3390: );
3391: };
3392: if (!$@) {
3393: $epoch_time = $dt->epoch;
3394: if ($epoch_time) {
3395: return $epoch_time;
3396: }
3397: }
1.51 www 3398: return POSIX::mktime(
3399: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3400: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3401: }
3402:
3403: #########################################
1.51 www 3404:
3405: sub findallcourses {
1.482 raeburn 3406: my ($roles,$uname,$udom) = @_;
1.355 albertel 3407: my %roles;
3408: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3409: my %courses;
1.51 www 3410: my $now=time;
1.482 raeburn 3411: if (!defined($uname)) {
3412: $uname = $env{'user.name'};
3413: }
3414: if (!defined($udom)) {
3415: $udom = $env{'user.domain'};
3416: }
3417: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3418: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3419: if (!%roles) {
3420: %roles = (
3421: cc => 1,
3422: in => 1,
3423: ep => 1,
3424: ta => 1,
3425: cr => 1,
3426: st => 1,
3427: );
3428: }
3429: foreach my $entry (keys(%roleshash)) {
3430: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3431: if ($trole =~ /^cr/) {
3432: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3433: } else {
3434: next if (!exists($roles{$trole}));
3435: }
3436: if ($tend) {
3437: next if ($tend < $now);
3438: }
3439: if ($tstart) {
3440: next if ($tstart > $now);
3441: }
3442: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3443: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3444: if ($secpart eq '') {
3445: ($cnum,$role) = split(/_/,$cnumpart);
3446: $sec = 'none';
3447: $realsec = '';
3448: } else {
3449: $cnum = $cnumpart;
3450: ($sec,$role) = split(/_/,$secpart);
3451: $realsec = $sec;
1.490 raeburn 3452: }
1.482 raeburn 3453: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3454: }
3455: } else {
3456: foreach my $key (keys(%env)) {
1.483 albertel 3457: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3458: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3459: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3460: next if ($role eq 'ca' || $role eq 'aa');
3461: next if (%roles && !exists($roles{$role}));
3462: my ($starttime,$endtime)=split(/\./,$env{$key});
3463: my $active=1;
3464: if ($starttime) {
3465: if ($now<$starttime) { $active=0; }
3466: }
3467: if ($endtime) {
3468: if ($now>$endtime) { $active=0; }
3469: }
3470: if ($active) {
3471: if ($sec eq '') {
3472: $sec = 'none';
3473: }
3474: $courses{$cdom.'_'.$cnum}{$sec} =
3475: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3476: }
3477: }
1.51 www 3478: }
3479: }
1.474 raeburn 3480: return %courses;
1.51 www 3481: }
1.37 matthew 3482:
1.54 www 3483: ###############################################
1.474 raeburn 3484:
3485: sub blockcheck {
1.482 raeburn 3486: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3487:
3488: if (!defined($udom)) {
3489: $udom = $env{'user.domain'};
3490: }
3491: if (!defined($uname)) {
3492: $uname = $env{'user.name'};
3493: }
3494:
3495: # If uname and udom are for a course, check for blocks in the course.
3496:
3497: if (&Apache::lonnet::is_course($udom,$uname)) {
3498: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3499: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3500: return ($startblock,$endblock);
3501: }
1.474 raeburn 3502:
1.502 raeburn 3503: my $startblock = 0;
3504: my $endblock = 0;
1.482 raeburn 3505: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3506:
1.490 raeburn 3507: # If uname is for a user, and activity is course-specific, i.e.,
3508: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3509:
1.490 raeburn 3510: if (($activity eq 'boards' || $activity eq 'chat' ||
3511: $activity eq 'groups') && ($env{'request.course.id'})) {
3512: foreach my $key (keys(%live_courses)) {
3513: if ($key ne $env{'request.course.id'}) {
3514: delete($live_courses{$key});
3515: }
3516: }
3517: }
3518:
3519: my $otheruser = 0;
3520: my %own_courses;
3521: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3522: # Resource belongs to user other than current user.
3523: $otheruser = 1;
3524: # Gather courses for current user
3525: %own_courses =
3526: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3527: }
3528:
3529: # Gather active course roles - course coordinator, instructor,
3530: # exam proctor, ta, student, or custom role.
1.474 raeburn 3531:
3532: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3533: my ($cdom,$cnum);
3534: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3535: $cdom = $env{'course.'.$course.'.domain'};
3536: $cnum = $env{'course.'.$course.'.num'};
3537: } else {
1.490 raeburn 3538: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3539: }
3540: my $no_ownblock = 0;
3541: my $no_userblock = 0;
1.533 raeburn 3542: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3543: # Check if current user has 'evb' priv for this
3544: if (defined($own_courses{$course})) {
3545: foreach my $sec (keys(%{$own_courses{$course}})) {
3546: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3547: if ($sec ne 'none') {
3548: $checkrole .= '/'.$sec;
3549: }
3550: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3551: $no_ownblock = 1;
3552: last;
3553: }
3554: }
3555: }
3556: # if they have 'evb' priv and are currently not playing student
3557: next if (($no_ownblock) &&
3558: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3559: }
1.474 raeburn 3560: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3561: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3562: if ($sec ne 'none') {
1.482 raeburn 3563: $checkrole .= '/'.$sec;
1.474 raeburn 3564: }
1.490 raeburn 3565: if ($otheruser) {
3566: # Resource belongs to user other than current user.
3567: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3568: my ($trole,$tdom,$tnum,$tsec);
3569: my $entry = $live_courses{$course}{$sec};
3570: if ($entry =~ /^cr/) {
3571: ($trole,$tdom,$tnum,$tsec) =
3572: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3573: } else {
3574: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3575: }
3576: my ($spec,$area,$trest,%allroles,%userroles);
3577: $area = '/'.$tdom.'/'.$tnum;
3578: $trest = $tnum;
3579: if ($tsec ne '') {
3580: $area .= '/'.$tsec;
3581: $trest .= '/'.$tsec;
3582: }
3583: $spec = $trole.'.'.$area;
3584: if ($trole =~ /^cr/) {
3585: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3586: $tdom,$spec,$trest,$area);
3587: } else {
3588: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3589: $tdom,$spec,$trest,$area);
3590: }
3591: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3592: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3593: if ($1) {
3594: $no_userblock = 1;
3595: last;
3596: }
3597: }
1.490 raeburn 3598: } else {
3599: # Resource belongs to current user
3600: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3601: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3602: $no_ownblock = 1;
3603: last;
3604: }
1.474 raeburn 3605: }
3606: }
3607: # if they have the evb priv and are currently not playing student
1.482 raeburn 3608: next if (($no_ownblock) &&
1.491 albertel 3609: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3610: next if ($no_userblock);
1.474 raeburn 3611:
1.490 raeburn 3612: # Retrieve blocking times and identity of blocker for course
3613: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3614:
3615: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3616: if (($start != 0) &&
3617: (($startblock == 0) || ($startblock > $start))) {
3618: $startblock = $start;
3619: }
3620: if (($end != 0) &&
3621: (($endblock == 0) || ($endblock < $end))) {
3622: $endblock = $end;
3623: }
1.490 raeburn 3624: }
3625: return ($startblock,$endblock);
3626: }
3627:
3628: sub get_blocks {
3629: my ($setters,$activity,$cdom,$cnum) = @_;
3630: my $startblock = 0;
3631: my $endblock = 0;
3632: my $course = $cdom.'_'.$cnum;
3633: $setters->{$course} = {};
3634: $setters->{$course}{'staff'} = [];
3635: $setters->{$course}{'times'} = [];
3636: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3637: foreach my $record (keys(%records)) {
3638: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3639: if ($start <= time && $end >= time) {
3640: my ($staff_name,$staff_dom,$title,$blocks) =
3641: &parse_block_record($records{$record});
3642: if ($blocks->{$activity} eq 'on') {
3643: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3644: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3645: if ( ($startblock == 0) || ($startblock > $start) ) {
3646: $startblock = $start;
1.490 raeburn 3647: }
1.491 albertel 3648: if ( ($endblock == 0) || ($endblock < $end) ) {
3649: $endblock = $end;
1.474 raeburn 3650: }
3651: }
3652: }
3653: }
3654: return ($startblock,$endblock);
3655: }
3656:
3657: sub parse_block_record {
3658: my ($record) = @_;
3659: my ($setuname,$setudom,$title,$blocks);
3660: if (ref($record) eq 'HASH') {
3661: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3662: $title = &unescape($record->{'event'});
3663: $blocks = $record->{'blocks'};
3664: } else {
3665: my @data = split(/:/,$record,3);
3666: if (scalar(@data) eq 2) {
3667: $title = $data[1];
3668: ($setuname,$setudom) = split(/@/,$data[0]);
3669: } else {
3670: ($setuname,$setudom,$title) = @data;
3671: }
3672: $blocks = { 'com' => 'on' };
3673: }
3674: return ($setuname,$setudom,$title,$blocks);
3675: }
3676:
3677: sub build_block_table {
3678: my ($startblock,$endblock,$setters) = @_;
3679: my %lt = &Apache::lonlocal::texthash(
3680: 'cacb' => 'Currently active communication blocks',
3681: 'cour' => 'Course',
3682: 'dura' => 'Duration',
3683: 'blse' => 'Block set by'
3684: );
3685: my $output;
1.476 raeburn 3686: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3687: $output .= &start_data_table();
3688: $output .= '
3689: <tr>
3690: <th>'.$lt{'cour'}.'</th>
3691: <th>'.$lt{'dura'}.'</th>
3692: <th>'.$lt{'blse'}.'</th>
3693: </tr>
3694: ';
3695: foreach my $course (keys(%{$setters})) {
3696: my %courseinfo=&Apache::lonnet::coursedescription($course);
3697: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3698: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3699: my $fullname = &plainname($uname,$udom);
3700: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3701: && $env{'user.name'} ne 'public'
3702: && $env{'user.domain'} ne 'public') {
3703: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3704: }
1.474 raeburn 3705: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3706: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3707: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3708: $output .= &Apache::loncommon::start_data_table_row().
3709: '<td>'.$courseinfo{'description'}.'</td>'.
3710: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3711: '<td>'.$fullname.'</td>'.
1.474 raeburn 3712: &Apache::loncommon::end_data_table_row();
3713: }
3714: }
3715: $output .= &end_data_table();
3716: }
3717:
1.490 raeburn 3718: sub blocking_status {
3719: my ($activity,$uname,$udom) = @_;
3720: my %setters;
3721: my ($blocked,$output,$ownitem,$is_course);
3722: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3723: if ($startblock && $endblock) {
3724: $blocked = 1;
3725: if (wantarray) {
3726: my $category;
3727: if ($activity eq 'boards') {
3728: $category = 'Discussion posts in this course';
3729: } elsif ($activity eq 'blogs') {
3730: $category = 'Blogs';
3731: } elsif ($activity eq 'port') {
3732: if (defined($uname) && defined($udom)) {
3733: if ($uname eq $env{'user.name'} &&
3734: $udom eq $env{'user.domain'}) {
3735: $ownitem = 1;
3736: }
3737: }
3738: $is_course = &Apache::lonnet::is_course($udom,$uname);
3739: if ($ownitem) {
3740: $category = 'Your portfolio files';
3741: } elsif ($is_course) {
3742: my $coursedesc;
3743: foreach my $course (keys(%setters)) {
3744: my %courseinfo =
3745: &Apache::lonnet::coursedescription($course);
3746: $coursedesc = $courseinfo{'description'};
3747: }
3748: $category = "Group files in the course '$coursedesc'";
3749: } else {
3750: $category = 'Portfolio files belonging to ';
3751: if ($env{'user.name'} eq 'public' &&
3752: $env{'user.domain'} eq 'public') {
3753: $category .= &plainname($uname,$udom);
3754: } else {
3755: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3756: }
3757: }
3758: } elsif ($activity eq 'groups') {
3759: $category = 'Groups in this course';
3760: }
3761: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3762: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3763: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3764: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3765: $output .= &build_block_table($startblock,$endblock,\%setters);
3766: }
3767: }
3768: }
3769: if (wantarray) {
3770: return ($blocked,$output);
3771: } else {
3772: return $blocked;
3773: }
3774: }
3775:
1.60 matthew 3776: ###############################################
3777:
1.682 raeburn 3778: sub check_ip_acc {
3779: my ($acc)=@_;
3780: &Apache::lonxml::debug("acc is $acc");
3781: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3782: return 1;
3783: }
3784: my $allowed=0;
3785: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3786:
3787: my $name;
3788: foreach my $pattern (split(',',$acc)) {
3789: $pattern =~ s/^\s*//;
3790: $pattern =~ s/\s*$//;
3791: if ($pattern =~ /\*$/) {
3792: #35.8.*
3793: $pattern=~s/\*//;
3794: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3795: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3796: #35.8.3.[34-56]
3797: my $low=$2;
3798: my $high=$3;
3799: $pattern=$1;
3800: if ($ip =~ /^\Q$pattern\E/) {
3801: my $last=(split(/\./,$ip))[3];
3802: if ($last <=$high && $last >=$low) { $allowed=1; }
3803: }
3804: } elsif ($pattern =~ /^\*/) {
3805: #*.msu.edu
3806: $pattern=~s/\*//;
3807: if (!defined($name)) {
3808: use Socket;
3809: my $netaddr=inet_aton($ip);
3810: ($name)=gethostbyaddr($netaddr,AF_INET);
3811: }
3812: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3813: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3814: #127.0.0.1
3815: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3816: } else {
3817: #some.name.com
3818: if (!defined($name)) {
3819: use Socket;
3820: my $netaddr=inet_aton($ip);
3821: ($name)=gethostbyaddr($netaddr,AF_INET);
3822: }
3823: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3824: }
3825: if ($allowed) { last; }
3826: }
3827: return $allowed;
3828: }
3829:
3830: ###############################################
3831:
1.60 matthew 3832: =pod
3833:
1.112 bowersj2 3834: =head1 Domain Template Functions
3835:
3836: =over 4
3837:
3838: =item * &determinedomain()
1.60 matthew 3839:
3840: Inputs: $domain (usually will be undef)
3841:
1.63 www 3842: Returns: Determines which domain should be used for designs
1.60 matthew 3843:
3844: =cut
1.54 www 3845:
1.60 matthew 3846: ###############################################
1.63 www 3847: sub determinedomain {
3848: my $domain=shift;
1.531 albertel 3849: if (! $domain) {
1.60 matthew 3850: # Determine domain if we have not been given one
3851: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3852: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3853: if ($env{'request.role.domain'}) {
3854: $domain=$env{'request.role.domain'};
1.60 matthew 3855: }
3856: }
1.63 www 3857: return $domain;
3858: }
3859: ###############################################
1.517 raeburn 3860:
1.518 albertel 3861: sub devalidate_domconfig_cache {
3862: my ($udom)=@_;
3863: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3864: }
3865:
3866: # ---------------------- Get domain configuration for a domain
3867: sub get_domainconf {
3868: my ($udom) = @_;
3869: my $cachetime=1800;
3870: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3871: if (defined($cached)) { return %{$result}; }
3872:
3873: my %domconfig = &Apache::lonnet::get_dom('configuration',
3874: ['login','rolecolors'],$udom);
1.632 raeburn 3875: my (%designhash,%legacy);
1.518 albertel 3876: if (keys(%domconfig) > 0) {
3877: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3878: if (keys(%{$domconfig{'login'}})) {
3879: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3880: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3881: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3882: $designhash{$udom.'.login.'.$key.'_'.$img} =
3883: $domconfig{'login'}{$key}{$img};
3884: }
3885: } else {
3886: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3887: }
1.632 raeburn 3888: }
3889: } else {
3890: $legacy{'login'} = 1;
1.518 albertel 3891: }
1.632 raeburn 3892: } else {
3893: $legacy{'login'} = 1;
1.518 albertel 3894: }
3895: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3896: if (keys(%{$domconfig{'rolecolors'}})) {
3897: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3898: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3899: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3900: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3901: }
1.518 albertel 3902: }
3903: }
1.632 raeburn 3904: } else {
3905: $legacy{'rolecolors'} = 1;
1.518 albertel 3906: }
1.632 raeburn 3907: } else {
3908: $legacy{'rolecolors'} = 1;
1.518 albertel 3909: }
1.632 raeburn 3910: if (keys(%legacy) > 0) {
3911: my %legacyhash = &get_legacy_domconf($udom);
3912: foreach my $item (keys(%legacyhash)) {
3913: if ($item =~ /^\Q$udom\E\.login/) {
3914: if ($legacy{'login'}) {
3915: $designhash{$item} = $legacyhash{$item};
3916: }
3917: } else {
3918: if ($legacy{'rolecolors'}) {
3919: $designhash{$item} = $legacyhash{$item};
3920: }
1.518 albertel 3921: }
3922: }
3923: }
1.632 raeburn 3924: } else {
3925: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3926: }
3927: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3928: $cachetime);
3929: return %designhash;
3930: }
3931:
1.632 raeburn 3932: sub get_legacy_domconf {
3933: my ($udom) = @_;
3934: my %legacyhash;
3935: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3936: my $designfile = $designdir.'/'.$udom.'.tab';
3937: if (-e $designfile) {
3938: if ( open (my $fh,"<$designfile") ) {
3939: while (my $line = <$fh>) {
3940: next if ($line =~ /^\#/);
3941: chomp($line);
3942: my ($key,$val)=(split(/\=/,$line));
3943: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3944: }
3945: close($fh);
3946: }
3947: }
3948: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3949: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3950: }
3951: return %legacyhash;
3952: }
3953:
1.63 www 3954: =pod
3955:
1.112 bowersj2 3956: =item * &domainlogo()
1.63 www 3957:
3958: Inputs: $domain (usually will be undef)
3959:
3960: Returns: A link to a domain logo, if the domain logo exists.
3961: If the domain logo does not exist, a description of the domain.
3962:
3963: =cut
1.112 bowersj2 3964:
1.63 www 3965: ###############################################
3966: sub domainlogo {
1.517 raeburn 3967: my $domain = &determinedomain(shift);
1.518 albertel 3968: my %designhash = &get_domainconf($domain);
1.517 raeburn 3969: # See if there is a logo
3970: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3971: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3972: if ($imgsrc =~ m{^/(adm|res)/}) {
3973: if ($imgsrc =~ m{^/res/}) {
3974: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3975: &Apache::lonnet::repcopy($local_name);
3976: }
3977: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3978: }
3979: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3980: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3981: return &Apache::lonnet::domain($domain,'description');
1.59 www 3982: } else {
1.60 matthew 3983: return '';
1.59 www 3984: }
3985: }
1.63 www 3986: ##############################################
3987:
3988: =pod
3989:
1.112 bowersj2 3990: =item * &designparm()
1.63 www 3991:
3992: Inputs: $which parameter; $domain (usually will be undef)
3993:
3994: Returns: value of designparamter $which
3995:
3996: =cut
1.112 bowersj2 3997:
1.397 albertel 3998:
1.400 albertel 3999: ##############################################
1.397 albertel 4000: sub designparm {
4001: my ($which,$domain)=@_;
1.258 albertel 4002: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4003: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4004: return '#000000';
4005: }
1.635 raeburn 4006: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4007: return '#FFFFFF';
4008: }
4009: if ($which=~/\.tabbg$/) {
4010: return '#CCCCCC';
4011: }
4012: }
1.397 albertel 4013: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4014: return $env{'environment.color.'.$which};
1.96 www 4015: }
1.63 www 4016: $domain=&determinedomain($domain);
1.518 albertel 4017: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4018: my $output;
1.517 raeburn 4019: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4020: $output = $domdesign{$domain.'.'.$which};
1.63 www 4021: } else {
1.520 raeburn 4022: $output = $defaultdesign{$which};
4023: }
4024: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4025: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4026: if ($output =~ m{^/(adm|res)/}) {
4027: if ($output =~ m{^/res/}) {
4028: my $local_name = &Apache::lonnet::filelocation('',$output);
4029: &Apache::lonnet::repcopy($local_name);
4030: }
1.520 raeburn 4031: $output = &lonhttpdurl($output);
4032: }
1.63 www 4033: }
1.520 raeburn 4034: return $output;
1.63 www 4035: }
1.59 www 4036:
1.60 matthew 4037: ###############################################
4038: ###############################################
4039:
4040: =pod
4041:
1.112 bowersj2 4042: =back
4043:
1.549 albertel 4044: =head1 HTML Helpers
1.112 bowersj2 4045:
4046: =over 4
4047:
4048: =item * &bodytag()
1.60 matthew 4049:
4050: Returns a uniform header for LON-CAPA web pages.
4051:
4052: Inputs:
4053:
1.112 bowersj2 4054: =over 4
4055:
4056: =item * $title, A title to be displayed on the page.
4057:
4058: =item * $function, the current role (can be undef).
4059:
4060: =item * $addentries, extra parameters for the <body> tag.
4061:
4062: =item * $bodyonly, if defined, only return the <body> tag.
4063:
4064: =item * $domain, if defined, force a given domain.
4065:
4066: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4067: text interface only)
1.60 matthew 4068:
1.326 albertel 4069: =item * $customtitle, alternate text to use instead of $title
4070: in the title box that appears, this text
4071: is not auto translated like the $title is
1.309 albertel 4072:
4073: =item * $notopbar, if true, keep the 'what is this' info but remove the
4074: navigational links
1.317 albertel 4075:
1.338 albertel 4076: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4077:
4078: =item * $notitle, if true keep the nav controls, but remove the title bar
4079:
1.361 albertel 4080: =item * $no_inline_link, if true and in remote mode, don't show the
4081: 'Switch To Inline Menu' link
4082:
1.460 albertel 4083: =item * $args, optional argument valid values are
4084: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4085: inherit_jsmath -> when creating popup window in a page,
4086: should it have jsmath forced on by the
4087: current page
1.460 albertel 4088:
1.112 bowersj2 4089: =back
4090:
1.60 matthew 4091: Returns: A uniform header for LON-CAPA web pages.
4092: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4093: If $bodyonly is undef or zero, an html string containing a <body> tag and
4094: other decorations will be returned.
4095:
4096: =cut
4097:
1.54 www 4098: sub bodytag {
1.309 albertel 4099: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4100: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4101:
1.460 albertel 4102: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4103:
1.183 matthew 4104: $function = &get_users_function() if (!$function);
1.339 albertel 4105: my $img = &designparm($function.'.img',$domain);
4106: my $font = &designparm($function.'.font',$domain);
4107: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4108:
4109: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4110: 'bgcolor' => $pgbg,
1.339 albertel 4111: 'text' => $font,
4112: 'alink' => &designparm($function.'.alink',$domain),
4113: 'vlink' => &designparm($function.'.vlink',$domain),
4114: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4115: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4116:
1.63 www 4117: # role and realm
1.378 raeburn 4118: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4119: if ($role eq 'ca') {
1.479 albertel 4120: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4121: $realm = &plainname($rname,$rdom);
1.378 raeburn 4122: }
1.55 www 4123: # realm
1.258 albertel 4124: if ($env{'request.course.id'}) {
1.378 raeburn 4125: if ($env{'request.role'} !~ /^cr/) {
4126: $role = &Apache::lonnet::plaintext($role,&course_type());
4127: }
1.359 albertel 4128: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4129: } else {
4130: $role = &Apache::lonnet::plaintext($role);
1.54 www 4131: }
1.433 albertel 4132:
1.359 albertel 4133: if (!$realm) { $realm=' '; }
1.55 www 4134: # Set messages
1.60 matthew 4135: my $messages=&domainlogo($domain);
1.330 albertel 4136:
1.438 albertel 4137: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4138:
1.101 www 4139: # construct main body tag
1.359 albertel 4140: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4141: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4142:
1.530 albertel 4143: if ($bodyonly) {
1.60 matthew 4144: return $bodytag;
1.258 albertel 4145: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4146: # Accessibility
1.224 raeburn 4147:
1.337 albertel 4148: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4149: if (!$notitle) {
1.337 albertel 4150: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4151: }
4152: return $bodytag;
1.359 albertel 4153: }
4154:
1.410 albertel 4155: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4156: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4157: undef($role);
1.434 albertel 4158: } else {
4159: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4160: }
1.359 albertel 4161:
4162: my $roleinfo=(<<ENDROLE);
4163: <td class="LC_title_bar_who">
4164: <div class="LC_title_bar_name">
1.410 albertel 4165: $name
1.361 albertel 4166:
1.359 albertel 4167: </div>
4168: <div class="LC_title_bar_role">
1.361 albertel 4169: $role
1.359 albertel 4170: </div>
4171: <div class="LC_title_bar_realm">
1.361 albertel 4172: $realm
1.359 albertel 4173: </div>
1.206 albertel 4174: </td>
4175: ENDROLE
1.235 raeburn 4176:
1.359 albertel 4177: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4178: if ($customtitle) {
4179: $titleinfo = $customtitle;
4180: }
4181: #
4182: # Extra info if you are the DC
4183: my $dc_info = '';
4184: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4185: $env{'course.'.$env{'request.course.id'}.
4186: '.domain'}.'/'})) {
4187: my $cid = $env{'request.course.id'};
4188: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4189: $dc_info =~ s/\s+$//;
1.359 albertel 4190: $dc_info = '('.$dc_info.')';
4191: }
4192:
1.644 www 4193: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4194: # No Remote
1.258 albertel 4195: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4196: $forcereg=1;
4197: }
4198:
4199: if (!$customtitle && $env{'request.state'} eq 'construct') {
4200: # this is for resources; directories have customtitle, and crumbs
4201: # and select recent are created in lonpubdir.pm
1.229 albertel 4202: my ($uname,$thisdisfn)=
1.258 albertel 4203: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4204: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4205: $formaction=~s/\/+/\//g;
4206:
1.359 albertel 4207: my $parentpath = '';
4208: my $lastitem = '';
4209: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4210: $parentpath = $1;
4211: $lastitem = $2;
4212: } else {
4213: $lastitem = $thisdisfn;
4214: }
4215: $titleinfo =
1.640 bisitz 4216: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4217: .'<b>'.&mt('Construction Space').'</b>: '
4218: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4219: .'" target="_top"><tt><b>'
1.705 tempelho 4220: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4221: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4222: .'</form>'
4223: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4224: }
1.359 albertel 4225:
1.337 albertel 4226: my $titletable;
1.338 albertel 4227: if (!$notitle) {
1.337 albertel 4228: $titletable =
1.359 albertel 4229: '<table id="LC_title_bar">'.
4230: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4231: '</tr></table>';
1.337 albertel 4232: }
1.359 albertel 4233: if ($notopbar) {
4234: $bodytag .= $titletable;
4235: } else {
4236: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4237: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4238: $titletable);
1.272 raeburn 4239: } else {
1.336 albertel 4240: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4241: $titletable;
1.272 raeburn 4242: }
1.235 raeburn 4243: }
4244: return $bodytag;
1.94 www 4245: }
1.95 www 4246:
1.93 www 4247: #
1.95 www 4248: # Top frame rendering, Remote is up
1.93 www 4249: #
1.359 albertel 4250:
1.517 raeburn 4251: my $imgsrc = $img;
4252: if ($img =~ /^\/adm/) {
1.575 albertel 4253: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4254: }
4255: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4256:
1.305 www 4257: # Explicit link to get inline menu
1.361 albertel 4258: my $menu= ($no_inline_link?''
4259: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4260: #
1.338 albertel 4261: if ($notitle) {
1.337 albertel 4262: return $bodytag;
4263: }
1.94 www 4264: return(<<ENDBODY);
1.60 matthew 4265: $bodytag
1.359 albertel 4266: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4267: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4268: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4269: </tr>
1.359 albertel 4270: <tr><td>$titleinfo $dc_info $menu</td>
4271: $roleinfo
1.368 albertel 4272: </tr>
1.356 albertel 4273: </table>
1.54 www 4274: ENDBODY
1.182 matthew 4275: }
4276:
1.330 albertel 4277: sub make_attr_string {
4278: my ($register,$attr_ref) = @_;
4279:
4280: if ($attr_ref && !ref($attr_ref)) {
4281: die("addentries Must be a hash ref ".
4282: join(':',caller(1))." ".
4283: join(':',caller(0))." ");
4284: }
4285:
4286: if ($register) {
1.339 albertel 4287: my ($on_load,$on_unload);
4288: foreach my $key (keys(%{$attr_ref})) {
4289: if (lc($key) eq 'onload') {
4290: $on_load.=$attr_ref->{$key}.';';
4291: delete($attr_ref->{$key});
4292:
4293: } elsif (lc($key) eq 'onunload') {
4294: $on_unload.=$attr_ref->{$key}.';';
4295: delete($attr_ref->{$key});
4296: }
4297: }
4298: $attr_ref->{'onload'} =
4299: &Apache::lonmenu::loadevents(). $on_load;
4300: $attr_ref->{'onunload'}=
4301: &Apache::lonmenu::unloadevents().$on_unload;
4302: }
4303:
4304: # Accessibility font enhance
4305: if ($env{'browser.fontenhance'} eq 'on') {
4306: my $style;
4307: foreach my $key (keys(%{$attr_ref})) {
4308: if (lc($key) eq 'style') {
4309: $style.=$attr_ref->{$key}.';';
4310: delete($attr_ref->{$key});
4311: }
4312: }
4313: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4314: }
1.339 albertel 4315:
4316: if ($env{'browser.blackwhite'} eq 'on') {
4317: delete($attr_ref->{'font'});
4318: delete($attr_ref->{'link'});
4319: delete($attr_ref->{'alink'});
4320: delete($attr_ref->{'vlink'});
4321: delete($attr_ref->{'bgcolor'});
4322: delete($attr_ref->{'background'});
4323: }
4324:
1.330 albertel 4325: my $attr_string;
4326: foreach my $attr (keys(%$attr_ref)) {
4327: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4328: }
4329: return $attr_string;
4330: }
4331:
4332:
1.182 matthew 4333: ###############################################
1.251 albertel 4334: ###############################################
4335:
4336: =pod
4337:
4338: =item * &endbodytag()
4339:
4340: Returns a uniform footer for LON-CAPA web pages.
4341:
1.635 raeburn 4342: Inputs: 1 - optional reference to an args hash
4343: If in the hash, key for noredirectlink has a value which evaluates to true,
4344: a 'Continue' link is not displayed if the page contains an
4345: internal redirect in the <head></head> section,
4346: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4347:
4348: =cut
4349:
4350: sub endbodytag {
1.635 raeburn 4351: my ($args) = @_;
1.251 albertel 4352: my $endbodytag='</body>';
1.269 albertel 4353: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4354: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4355: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4356: $endbodytag=
4357: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4358: &mt('Continue').'</a>'.
4359: $endbodytag;
4360: }
1.315 albertel 4361: }
1.251 albertel 4362: return $endbodytag;
4363: }
4364:
1.352 albertel 4365: =pod
4366:
4367: =item * &standard_css()
4368:
4369: Returns a style sheet
4370:
4371: Inputs: (all optional)
4372: domain -> force to color decorate a page for a specific
4373: domain
4374: function -> force usage of a specific rolish color scheme
4375: bgcolor -> override the default page bgcolor
4376:
4377: =cut
4378:
1.343 albertel 4379: sub standard_css {
1.345 albertel 4380: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4381: $function = &get_users_function() if (!$function);
4382: my $img = &designparm($function.'.img', $domain);
4383: my $tabbg = &designparm($function.'.tabbg', $domain);
4384: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4385: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4386: my $pgbg_or_bgcolor =
4387: $bgcolor ||
1.352 albertel 4388: &designparm($function.'.pgbg', $domain);
1.382 albertel 4389: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4390: my $alink = &designparm($function.'.alink', $domain);
4391: my $vlink = &designparm($function.'.vlink', $domain);
4392: my $link = &designparm($function.'.link', $domain);
4393:
1.704 muellerd 4394: my $loginbg = &designparm('login.sidebg',$domain);
4395:
1.602 albertel 4396: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4397: my $mono = 'monospace';
1.352 albertel 4398: my $data_table_head = $tabbg;
4399: my $data_table_light = '#EEEEEE';
1.470 banghart 4400: my $data_table_dark = '#DDDDDD';
4401: my $data_table_darker = '#CCCCCC';
1.349 albertel 4402: my $data_table_highlight = '#FFFF00';
1.352 albertel 4403: my $mail_new = '#FFBB77';
4404: my $mail_new_hover = '#DD9955';
4405: my $mail_read = '#BBBB77';
4406: my $mail_read_hover = '#999944';
4407: my $mail_replied = '#AAAA88';
4408: my $mail_replied_hover = '#888855';
4409: my $mail_other = '#99BBBB';
4410: my $mail_other_hover = '#669999';
1.391 albertel 4411: my $table_header = '#DDDDDD';
1.489 raeburn 4412: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4413: my $lg_border_color = '#C8C8C8';
1.392 albertel 4414:
1.608 albertel 4415: my $border = ($env{'browser.type'} eq 'explorer' ||
4416: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4417: : '0px 3px 0px 4px';
1.448 albertel 4418:
1.523 albertel 4419:
1.343 albertel 4420: return <<END;
1.698 harmsja 4421: body{
4422: font-family: $sans;
4423: line-height:130%;
1.701 harmsja 4424: font-size:0.83em;
1.698 harmsja 4425: color:$font;
4426: }
1.701 harmsja 4427: a:link, a:visited { font-size:100%; }
1.698 harmsja 4428:
1.343 albertel 4429: a:focus { color: red; background: yellow }
1.510 albertel 4430: table.thinborder,
4431: table.thinborder tr th {
4432: border-style: solid;
4433: border-width: 1px;
1.698 harmsja 4434: border-color: $lg_border_color;
1.510 albertel 4435: background: $tabbg;
4436: }
1.523 albertel 4437: table.thinborder tr td {
1.510 albertel 4438: border-style: solid;
1.698 harmsja 4439: border-width: 1px;
4440: border-color: $lg_border_color;
1.510 albertel 4441: }
1.426 albertel 4442:
1.343 albertel 4443: form, .inline { display: inline; }
4444: .center { text-align: center; }
1.701 harmsja 4445: .left { text-align:left; }
4446: .right {text-align:right;}
4447: .middle {vertical-align:middle;}
4448: .top {vertical-align:top;}
4449: .bottom {vertical-align:bottom;}
1.593 albertel 4450: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4451: .LC_error {
4452: color: red;
4453: font-size: larger;
4454: }
1.457 albertel 4455: .LC_warning,
4456: .LC_diff_removed {
1.394 albertel 4457: color: red;
4458: }
1.532 albertel 4459:
4460: .LC_info,
1.457 albertel 4461: .LC_success,
4462: .LC_diff_added {
1.350 albertel 4463: color: green;
4464: }
1.543 albertel 4465: .LC_unknown {
4466: color: yellow;
4467: }
4468:
1.440 albertel 4469: .LC_icon {
4470: border: 0px;
4471: }
1.539 albertel 4472: .LC_indexer_icon {
4473: border: 0px;
4474: height: 22px;
4475: }
1.543 albertel 4476: .LC_docs_spacer {
4477: width: 25px;
4478: height: 1px;
4479: border: 0px;
4480: }
1.346 albertel 4481:
1.532 albertel 4482: .LC_internal_info {
4483: color: #999;
4484: }
4485:
1.458 albertel 4486: table.LC_pastsubmission {
4487: border: 1px solid black;
4488: margin: 2px;
4489: }
4490:
1.606 albertel 4491: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4492: width: 100%;
4493: background: $pgbg;
1.392 albertel 4494: border: 2px;
1.402 albertel 4495: border-collapse: separate;
1.403 albertel 4496: padding: 0px;
1.345 albertel 4497: }
1.392 albertel 4498:
1.606 albertel 4499: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4500: table#LC_title_bar.LC_with_remote {
1.359 albertel 4501: width: 100%;
1.392 albertel 4502: border-color: $pgbg;
4503: border-style: solid;
4504: border-width: $border;
4505:
1.379 albertel 4506: background: $pgbg;
4507: font-family: $sans;
1.392 albertel 4508: border-collapse: collapse;
1.403 albertel 4509: padding: 0px;
1.359 albertel 4510: }
1.409 albertel 4511: table.LC_docs_path {
4512: width: 100%;
4513: border: 0;
4514: background: $pgbg;
4515: font-family: $sans;
4516: border-collapse: collapse;
4517: padding: 0px;
4518: }
4519:
1.359 albertel 4520: table#LC_title_bar td {
4521: background: $tabbg;
4522: }
4523: table#LC_title_bar td.LC_title_bar_who {
4524: background: $tabbg;
4525: color: $font;
1.427 albertel 4526: font: small $sans;
1.359 albertel 4527: text-align: right;
4528: }
1.469 banghart 4529: span.LC_metadata {
4530: font-family: $sans;
4531: }
1.359 albertel 4532: span.LC_title_bar_title {
1.416 albertel 4533: font: bold x-large $sans;
1.359 albertel 4534: }
4535: table#LC_title_bar td.LC_title_bar_domain_logo {
4536: background: $sidebg;
4537: text-align: right;
1.368 albertel 4538: padding: 0px;
4539: }
4540: table#LC_title_bar td.LC_title_bar_role_logo {
4541: background: $sidebg;
4542: padding: 0px;
1.359 albertel 4543: }
4544:
1.706 harmsja 4545: table#LC_menubuttons img{
1.346 albertel 4546: border: 0px;
4547: }
1.345 albertel 4548: table#LC_top_nav td {
4549: background: $tabbg;
1.392 albertel 4550: border: 0px;
1.407 albertel 4551: font-size: small;
1.706 harmsja 4552: vertical-align:top;
4553: padding:2px 5px 2px 5px;
1.345 albertel 4554: }
4555: table#LC_top_nav td a, div#LC_top_nav a {
4556: color: $font;
4557: font-family: $sans;
4558: }
1.364 albertel 4559: table#LC_top_nav td.LC_top_nav_logo {
4560: background: $tabbg;
1.432 albertel 4561: text-align: left;
1.408 albertel 4562: white-space: nowrap;
1.432 albertel 4563: width: 31px;
1.408 albertel 4564: }
4565: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4566: border: 0px;
1.408 albertel 4567: vertical-align: bottom;
1.364 albertel 4568: }
1.432 albertel 4569: table#LC_top_nav td.LC_top_nav_exit,
4570: table#LC_top_nav td.LC_top_nav_help {
4571: width: 2.0em;
4572: }
1.442 albertel 4573: table#LC_top_nav td.LC_top_nav_login {
4574: width: 4.0em;
4575: text-align: center;
4576: }
1.409 albertel 4577: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4578: background: $tabbg;
4579: color: $font;
4580: font-family: $sans;
1.358 albertel 4581: font-size: smaller;
1.357 albertel 4582: }
1.411 albertel 4583: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4584: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4585: background: $tabbg;
4586: color: $font;
4587: font-family: $sans;
4588: font-size: larger;
4589: text-align: right;
4590: }
1.383 albertel 4591: td.LC_table_cell_checkbox {
4592: text-align: center;
4593: }
1.522 albertel 4594: table#LC_mainmenu td.LC_mainmenu_column {
4595: vertical-align: top;
4596: }
4597:
1.705 tempelho 4598: .LC_fontsize_small
4599: {
4600: font-size: 70%;
4601: }
4602:
4603: .LC_fontsize_medium
4604: {
4605: font-size: 85%;
4606: }
4607:
4608: .LC_fontsize_large
4609: {
4610: font-size: 120%;
4611: }
4612:
4613: .LC_fontcolor_red
4614: {
4615: color: #FF0000;
4616: }
4617:
1.346 albertel 4618: .LC_menubuttons_inline_text {
4619: color: $font;
4620: font-family: $sans;
1.698 harmsja 4621: font-size: 90%;
1.701 harmsja 4622: padding-left:3px;
1.346 albertel 4623: }
4624:
1.526 www 4625: .LC_menubuttons_link {
4626: text-decoration: none;
4627: }
1.698 harmsja 4628: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4629: .LC_menubuttons_category {
1.521 www 4630: color: $font;
1.526 www 4631: background: $pgbg;
1.521 www 4632: font-family: $sans;
4633: font-size: larger;
4634: font-weight: bold;
4635: }
4636:
1.346 albertel 4637: td.LC_menubuttons_text {
1.701 harmsja 4638: color: $font;
1.346 albertel 4639: }
1.706 harmsja 4640:
4641:
1.526 www 4642:
1.346 albertel 4643: .LC_current_location {
4644: font-family: $sans;
4645: background: $tabbg;
4646: }
4647: .LC_new_mail {
4648: font-family: $sans;
1.634 www 4649: background: $tabbg;
1.346 albertel 4650: font-weight: bold;
4651: }
1.347 albertel 4652:
1.526 www 4653:
1.527 www 4654: .LC_dropadd_labeltext {
4655: font-family: $sans;
4656: text-align: right;
4657: }
4658:
4659: .LC_preferences_labeltext {
4660: font-family: $sans;
4661: text-align: right;
4662: }
4663:
1.666 raeburn 4664: .LC_roleslog_note {
1.701 harmsja 4665: font-size: small;
1.666 raeburn 4666: }
4667:
1.440 albertel 4668: table.LC_aboutme_port {
4669: border: 0px;
4670: border-collapse: collapse;
4671: border-spacing: 0px;
4672: }
1.349 albertel 4673: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4674: border: 1px solid #000000;
1.402 albertel 4675: border-collapse: separate;
1.426 albertel 4676: border-spacing: 1px;
1.610 albertel 4677: background: $pgbg;
1.347 albertel 4678: }
1.422 albertel 4679: .LC_data_table_dense {
4680: font-size: small;
4681: }
1.507 raeburn 4682: table.LC_nested_outer {
4683: border: 1px solid #000000;
1.589 raeburn 4684: border-collapse: collapse;
1.507 raeburn 4685: border-spacing: 0px;
4686: width: 100%;
4687: }
4688: table.LC_nested {
4689: border: 0px;
1.589 raeburn 4690: border-collapse: collapse;
1.507 raeburn 4691: border-spacing: 0px;
4692: width: 100%;
4693: }
1.523 albertel 4694: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4695: table.LC_prior_tries tr th {
1.349 albertel 4696: font-weight: bold;
4697: background-color: $data_table_head;
1.701 harmsja 4698: font-size:90%;
1.347 albertel 4699: }
1.610 albertel 4700: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4701: table.LC_aboutme_port tr td {
1.349 albertel 4702: background-color: $data_table_light;
1.425 albertel 4703: padding: 2px;
1.347 albertel 4704: }
1.610 albertel 4705: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4706: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4707: background-color: $data_table_dark;
1.347 albertel 4708: }
1.425 albertel 4709: table.LC_data_table tr.LC_data_table_highlight td {
4710: background-color: $data_table_darker;
4711: }
1.639 raeburn 4712: table.LC_data_table tr td.LC_leftcol_header {
4713: background-color: $data_table_head;
4714: font-weight: bold;
4715: }
1.451 albertel 4716: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4717: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4718: background-color: #FFFFFF;
1.421 albertel 4719: font-weight: bold;
4720: font-style: italic;
4721: text-align: center;
4722: padding: 8px;
1.347 albertel 4723: }
1.507 raeburn 4724: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4725: padding: 4ex
4726: }
1.507 raeburn 4727: table.LC_nested_outer tr th {
4728: font-weight: bold;
4729: background-color: $data_table_head;
1.701 harmsja 4730: font-size: small;
1.507 raeburn 4731: border-bottom: 1px solid #000000;
4732: }
4733: table.LC_nested_outer tr td.LC_subheader {
4734: background-color: $data_table_head;
4735: font-weight: bold;
4736: font-size: small;
4737: border-bottom: 1px solid #000000;
4738: text-align: right;
1.451 albertel 4739: }
1.507 raeburn 4740: table.LC_nested tr.LC_info_row td {
1.451 albertel 4741: background-color: #CCC;
4742: font-weight: bold;
4743: font-size: small;
1.507 raeburn 4744: text-align: center;
4745: }
1.589 raeburn 4746: table.LC_nested tr.LC_info_row td.LC_left_item,
4747: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4748: text-align: left;
1.451 albertel 4749: }
1.507 raeburn 4750: table.LC_nested td {
1.451 albertel 4751: background-color: #FFF;
4752: font-size: small;
1.507 raeburn 4753: }
4754: table.LC_nested_outer tr th.LC_right_item,
4755: table.LC_nested tr.LC_info_row td.LC_right_item,
4756: table.LC_nested tr.LC_odd_row td.LC_right_item,
4757: table.LC_nested tr td.LC_right_item {
1.451 albertel 4758: text-align: right;
4759: }
4760:
1.507 raeburn 4761: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4762: background-color: #EEE;
4763: }
4764:
1.473 raeburn 4765: table.LC_createuser {
4766: }
4767:
4768: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4769: font-size: small;
1.473 raeburn 4770: }
4771:
4772: table.LC_createuser tr.LC_info_row td {
4773: background-color: #CCC;
4774: font-weight: bold;
4775: text-align: center;
4776: }
4777:
1.349 albertel 4778: table.LC_calendar {
4779: border: 1px solid #000000;
4780: border-collapse: collapse;
4781: }
4782: table.LC_calendar_pickdate {
4783: font-size: xx-small;
4784: }
4785: table.LC_calendar tr td {
4786: border: 1px solid #000000;
4787: vertical-align: top;
4788: }
4789: table.LC_calendar tr td.LC_calendar_day_empty {
4790: background-color: $data_table_dark;
4791: }
4792: table.LC_calendar tr td.LC_calendar_day_current {
4793: background-color: $data_table_highlight;
4794: }
4795:
4796: table.LC_mail_list tr.LC_mail_new {
4797: background-color: $mail_new;
4798: }
4799: table.LC_mail_list tr.LC_mail_new:hover {
4800: background-color: $mail_new_hover;
4801: }
4802: table.LC_mail_list tr.LC_mail_read {
4803: background-color: $mail_read;
4804: }
4805: table.LC_mail_list tr.LC_mail_read:hover {
4806: background-color: $mail_read_hover;
4807: }
4808: table.LC_mail_list tr.LC_mail_replied {
4809: background-color: $mail_replied;
4810: }
4811: table.LC_mail_list tr.LC_mail_replied:hover {
4812: background-color: $mail_replied_hover;
4813: }
4814: table.LC_mail_list tr.LC_mail_other {
4815: background-color: $mail_other;
4816: }
4817: table.LC_mail_list tr.LC_mail_other:hover {
4818: background-color: $mail_other_hover;
4819: }
1.494 raeburn 4820: table.LC_mail_list tr.LC_mail_even {
4821: }
4822: table.LC_mail_list tr.LC_mail_odd {
4823: }
4824:
1.391 albertel 4825: table#LC_cstr_controls {
4826: width: 100%;
4827: border-collapse: collapse;
4828: }
4829: table#LC_cstr_controls tr td {
4830: border: 4px solid $pgbg;
4831: padding: 4px;
4832: text-align: center;
4833: background: $tabbg;
4834: }
4835: table#LC_cstr_controls tr th {
4836: border: 4px solid $pgbg;
4837: background: $table_header;
4838: text-align: center;
4839: font-family: $sans;
4840: font-size: smaller;
4841: }
4842:
1.696 bisitz 4843: table.LC_data_table tr > td.LC_browser_file,
4844: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4845: background: #CCFF88;
4846: }
1.696 bisitz 4847: table.LC_data_table tr > td.LC_browser_file_locked,
4848: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4849: background: #FFAA99;
1.387 albertel 4850: }
1.696 bisitz 4851: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4852: background: #AAAAAA;
1.387 albertel 4853: }
1.696 bisitz 4854: table.LC_data_table tr > td.LC_browser_file_modified,
4855: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4856: background: #FFFF77;
1.387 albertel 4857: }
1.696 bisitz 4858: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4859: background: #CCCCFF;
1.387 albertel 4860: }
1.696 bisitz 4861:
1.707 ! bisitz 4862: table.LC_data_table tr > td.LC_roles_is {
! 4863: /* background: #77FF77; */
! 4864: }
! 4865: table.LC_data_table tr > td.LC_roles_future {
! 4866: background: #FFFF77;
! 4867: }
! 4868: table.LC_data_table tr > td.LC_roles_will {
! 4869: background: #FFAA77;
! 4870: }
! 4871: table.LC_data_table tr > td.LC_roles_expired {
! 4872: background: #FF7777;
! 4873: }
! 4874: table.LC_data_table tr > td.LC_roles_will_not {
! 4875: background: #AAFF77;
! 4876: }
! 4877: table.LC_data_table tr > td.LC_roles_selected {
! 4878: background: #11CC55;
! 4879: }
! 4880:
1.388 albertel 4881: span.LC_current_location {
1.701 harmsja 4882: font-size:larger;
1.388 albertel 4883: background: $pgbg;
4884: }
1.387 albertel 4885:
1.395 albertel 4886: span.LC_parm_menu_item {
4887: font-size: larger;
4888: font-family: $sans;
4889: }
4890: span.LC_parm_scope_all {
4891: color: red;
4892: }
4893: span.LC_parm_scope_folder {
4894: color: green;
4895: }
4896: span.LC_parm_scope_resource {
4897: color: orange;
4898: }
4899: span.LC_parm_part {
4900: color: blue;
4901: }
4902: span.LC_parm_folder, span.LC_parm_symb {
4903: font-size: x-small;
4904: font-family: $mono;
4905: color: #AAAAAA;
4906: }
4907:
1.396 albertel 4908: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4909: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4910: border: 1px solid black;
4911: border-collapse: collapse;
4912: }
4913: table.LC_parm_overview_restrictions td {
4914: border-width: 1px 4px 1px 4px;
4915: border-style: solid;
4916: border-color: $pgbg;
4917: text-align: center;
4918: }
4919: table.LC_parm_overview_restrictions th {
4920: background: $tabbg;
4921: border-width: 1px 4px 1px 4px;
4922: border-style: solid;
4923: border-color: $pgbg;
4924: }
1.398 albertel 4925: table#LC_helpmenu {
4926: border: 0px;
4927: height: 55px;
4928: border-spacing: 0px;
4929: }
4930:
4931: table#LC_helpmenu fieldset legend {
4932: font-size: larger;
4933: font-weight: bold;
4934: }
1.397 albertel 4935: table#LC_helpmenu_links {
4936: width: 100%;
4937: border: 1px solid black;
4938: background: $pgbg;
4939: padding: 0px;
4940: border-spacing: 1px;
4941: }
4942: table#LC_helpmenu_links tr td {
4943: padding: 1px;
4944: background: $tabbg;
1.399 albertel 4945: text-align: center;
4946: font-weight: bold;
1.397 albertel 4947: }
1.396 albertel 4948:
1.397 albertel 4949: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4950: table#LC_helpmenu_links a:active {
4951: text-decoration: none;
4952: color: $font;
4953: }
4954: table#LC_helpmenu_links a:hover {
4955: text-decoration: underline;
4956: color: $vlink;
4957: }
1.396 albertel 4958:
1.417 albertel 4959: .LC_chrt_popup_exists {
4960: border: 1px solid #339933;
4961: margin: -1px;
4962: }
4963: .LC_chrt_popup_up {
4964: border: 1px solid yellow;
4965: margin: -1px;
4966: }
4967: .LC_chrt_popup {
4968: border: 1px solid #8888FF;
4969: background: #CCCCFF;
4970: }
1.421 albertel 4971: table.LC_pick_box {
4972: border-collapse: separate;
4973: background: white;
4974: border: 1px solid black;
4975: border-spacing: 1px;
4976: }
4977: table.LC_pick_box td.LC_pick_box_title {
4978: background: $tabbg;
4979: font-weight: bold;
4980: text-align: right;
4981: width: 184px;
4982: padding: 8px;
4983: }
1.645 raeburn 4984: table.LC_pick_box td.LC_selfenroll_pick_box_title {
4985: background: $tabbg;
4986: font-weight: bold;
4987: text-align: right;
4988: width: 350px;
4989: padding: 8px;
4990: }
4991:
1.579 raeburn 4992: table.LC_pick_box td.LC_pick_box_value {
4993: text-align: left;
4994: padding: 8px;
4995: }
4996: table.LC_pick_box td.LC_pick_box_select {
4997: text-align: left;
4998: padding: 8px;
4999: }
1.424 albertel 5000: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5001: padding: 0px;
5002: height: 1px;
5003: background: black;
5004: }
5005: table.LC_pick_box td.LC_pick_box_submit {
5006: text-align: right;
5007: }
1.579 raeburn 5008: table.LC_pick_box td.LC_evenrow_value {
5009: text-align: left;
5010: padding: 8px;
5011: background-color: $data_table_light;
5012: }
5013: table.LC_pick_box td.LC_oddrow_value {
5014: text-align: left;
5015: padding: 8px;
5016: background-color: $data_table_light;
5017: }
5018: table.LC_helpform_receipt {
5019: width: 620px;
5020: border-collapse: separate;
5021: background: white;
5022: border: 1px solid black;
5023: border-spacing: 1px;
5024: }
5025: table.LC_helpform_receipt td.LC_pick_box_title {
5026: background: $tabbg;
5027: font-weight: bold;
5028: text-align: right;
5029: width: 184px;
5030: padding: 8px;
5031: }
5032: table.LC_helpform_receipt td.LC_evenrow_value {
5033: text-align: left;
5034: padding: 8px;
5035: background-color: $data_table_light;
5036: }
5037: table.LC_helpform_receipt td.LC_oddrow_value {
5038: text-align: left;
5039: padding: 8px;
5040: background-color: $data_table_light;
5041: }
5042: table.LC_helpform_receipt td.LC_pick_box_separator {
5043: padding: 0px;
5044: height: 1px;
5045: background: black;
5046: }
5047: span.LC_helpform_receipt_cat {
5048: font-weight: bold;
5049: }
1.424 albertel 5050: table.LC_group_priv_box {
5051: background: white;
5052: border: 1px solid black;
5053: border-spacing: 1px;
5054: }
5055: table.LC_group_priv_box td.LC_pick_box_title {
5056: background: $tabbg;
5057: font-weight: bold;
5058: text-align: right;
5059: width: 184px;
5060: }
5061: table.LC_group_priv_box td.LC_groups_fixed {
5062: background: $data_table_light;
5063: text-align: center;
5064: }
5065: table.LC_group_priv_box td.LC_groups_optional {
5066: background: $data_table_dark;
5067: text-align: center;
5068: }
5069: table.LC_group_priv_box td.LC_groups_functionality {
5070: background: $data_table_darker;
5071: text-align: center;
5072: font-weight: bold;
5073: }
5074: table.LC_group_priv td {
5075: text-align: left;
5076: padding: 0px;
5077: }
5078:
1.421 albertel 5079: table.LC_notify_front_page {
5080: background: white;
5081: border: 1px solid black;
5082: padding: 8px;
5083: }
5084: table.LC_notify_front_page td {
5085: padding: 8px;
5086: }
1.424 albertel 5087: .LC_navbuttons {
5088: margin: 2ex 0ex 2ex 0ex;
5089: }
1.423 albertel 5090: .LC_topic_bar {
5091: font-family: $sans;
5092: font-weight: bold;
5093: width: 100%;
5094: background: $tabbg;
5095: vertical-align: middle;
5096: margin: 2ex 0ex 2ex 0ex;
5097: }
5098: .LC_topic_bar span {
5099: vertical-align: middle;
5100: }
5101: .LC_topic_bar img {
5102: vertical-align: bottom;
5103: }
5104: table.LC_course_group_status {
5105: margin: 20px;
5106: }
5107: table.LC_status_selector td {
5108: vertical-align: top;
5109: text-align: center;
1.424 albertel 5110: padding: 4px;
5111: }
5112: table.LC_descriptive_input td.LC_description {
5113: vertical-align: top;
5114: text-align: right;
5115: font-weight: bold;
1.423 albertel 5116: }
1.599 albertel 5117: div.LC_feedback_link {
1.616 albertel 5118: clear: both;
1.599 albertel 5119: background: white;
5120: width: 100%;
1.489 raeburn 5121: }
5122: span.LC_feedback_link {
1.599 albertel 5123: background: $feedback_link_bg;
5124: font-size: larger;
5125: }
5126: span.LC_message_link {
5127: background: $feedback_link_bg;
5128: font-size: larger;
5129: position: absolute;
5130: right: 1em;
1.489 raeburn 5131: }
1.421 albertel 5132:
1.515 albertel 5133: table.LC_prior_tries {
1.524 albertel 5134: border: 1px solid #000000;
5135: border-collapse: separate;
5136: border-spacing: 1px;
1.515 albertel 5137: }
1.523 albertel 5138:
1.515 albertel 5139: table.LC_prior_tries td {
1.524 albertel 5140: padding: 2px;
1.515 albertel 5141: }
1.523 albertel 5142:
5143: .LC_answer_correct {
5144: background: #AAFFAA;
5145: color: black;
5146: }
5147: .LC_answer_charged_try {
5148: background: #FFAAAA ! important;
5149: color: black;
5150: }
5151: .LC_answer_not_charged_try,
5152: .LC_answer_no_grade,
5153: .LC_answer_late {
5154: background: #FFFFAA;
5155: color: black;
5156: }
5157: .LC_answer_previous {
5158: background: #AAAAFF;
5159: color: black;
5160: }
5161: .LC_answer_no_message {
5162: background: #FFFFFF;
5163: color: black;
5164: }
5165: .LC_answer_unknown {
5166: background: orange;
5167: color: black;
5168: }
5169:
5170:
1.529 albertel 5171: span.LC_prior_numerical,
5172: span.LC_prior_string,
5173: span.LC_prior_custom,
5174: span.LC_prior_reaction,
5175: span.LC_prior_math {
1.523 albertel 5176: font-family: monospace;
5177: white-space: pre;
5178: }
5179:
1.525 albertel 5180: span.LC_prior_string {
5181: font-family: monospace;
5182: white-space: pre;
5183: }
5184:
1.523 albertel 5185: table.LC_prior_option {
5186: width: 100%;
5187: border-collapse: collapse;
5188: }
1.528 albertel 5189: table.LC_prior_rank, table.LC_prior_match {
5190: border-collapse: collapse;
5191: }
5192: table.LC_prior_option tr td,
5193: table.LC_prior_rank tr td,
5194: table.LC_prior_match tr td {
1.524 albertel 5195: border: 1px solid #000000;
1.515 albertel 5196: }
5197:
1.519 raeburn 5198: span.LC_nobreak {
1.544 albertel 5199: white-space: nowrap;
1.519 raeburn 5200: }
5201:
1.576 raeburn 5202: span.LC_cusr_emph {
5203: font-style: italic;
5204: }
5205:
1.633 raeburn 5206: span.LC_cusr_subheading {
5207: font-weight: normal;
5208: font-size: 85%;
5209: }
5210:
1.545 albertel 5211: table.LC_docs_documents {
5212: background: #BBBBBB;
1.547 albertel 5213: border-width: 0px;
1.545 albertel 5214: border-collapse: collapse;
5215: }
5216:
5217: table.LC_docs_documents td.LC_docs_document {
5218: border: 2px solid black;
5219: padding: 4px;
5220: }
5221:
5222: .LC_docs_course_commands div {
5223: float: left;
5224: border: 4px solid #AAAAAA;
5225: padding: 4px;
5226: background: #DDDDCC;
5227: }
5228:
5229: .LC_docs_entry_move {
5230: border: 0px;
5231: border-collapse: collapse;
1.544 albertel 5232: }
5233:
1.545 albertel 5234: .LC_docs_entry_move td {
5235: border: 2px solid #BBBBBB;
5236: background: #DDDDDD;
5237: }
5238:
5239: .LC_docs_editor td.LC_docs_entry_commands {
5240: background: #DDDDDD;
5241: font-size: x-small;
5242: }
1.544 albertel 5243: .LC_docs_copy {
1.545 albertel 5244: color: #000099;
1.544 albertel 5245: }
5246: .LC_docs_cut {
1.545 albertel 5247: color: #550044;
1.544 albertel 5248: }
5249: .LC_docs_rename {
1.545 albertel 5250: color: #009900;
1.544 albertel 5251: }
5252: .LC_docs_remove {
1.545 albertel 5253: color: #990000;
5254: }
5255:
1.547 albertel 5256: .LC_docs_reinit_warn,
5257: .LC_docs_ext_edit {
5258: font-size: x-small;
5259: }
5260:
1.545 albertel 5261: .LC_docs_editor td.LC_docs_entry_title,
5262: .LC_docs_editor td.LC_docs_entry_icon {
5263: background: #FFFFBB;
5264: }
5265: .LC_docs_editor td.LC_docs_entry_parameter {
5266: background: #BBBBFF;
5267: font-size: x-small;
5268: white-space: nowrap;
5269: }
5270:
5271: table.LC_docs_adddocs td,
5272: table.LC_docs_adddocs th {
5273: border: 1px solid #BBBBBB;
5274: padding: 4px;
5275: background: #DDDDDD;
1.543 albertel 5276: }
5277:
1.584 albertel 5278: table.LC_sty_begin {
5279: background: #BBFFBB;
5280: }
5281: table.LC_sty_end {
5282: background: #FFBBBB;
5283: }
5284:
1.589 raeburn 5285: table.LC_double_column {
5286: border-width: 0px;
5287: border-collapse: collapse;
5288: width: 100%;
5289: padding: 2px;
5290: }
5291:
5292: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5293: top: 2px;
1.589 raeburn 5294: left: 2px;
5295: width: 47%;
5296: vertical-align: top;
5297: }
5298:
5299: table.LC_double_column tr td.LC_right_col {
5300: top: 2px;
5301: right: 2px;
5302: width: 47%;
5303: vertical-align: top;
5304: }
5305:
1.594 raeburn 5306: span.LC_role_level {
5307: font-weight: bold;
5308: }
5309:
1.591 raeburn 5310: div.LC_left_float {
5311: float: left;
5312: padding-right: 5%;
1.597 albertel 5313: padding-bottom: 4px;
1.591 raeburn 5314: }
5315:
5316: div.LC_clear_float_header {
1.597 albertel 5317: padding-bottom: 2px;
1.591 raeburn 5318: }
5319:
5320: div.LC_clear_float_footer {
1.597 albertel 5321: padding-top: 10px;
1.591 raeburn 5322: clear: both;
5323: }
5324:
1.597 albertel 5325:
1.601 albertel 5326: div.LC_grade_select_mode {
1.604 albertel 5327: font-family: $sans;
1.601 albertel 5328: }
5329: div.LC_grade_select_mode div div {
5330: margin: 5px;
5331: }
5332: div.LC_grade_select_mode_selector {
5333: margin: 5px;
5334: float: left;
5335: }
5336: div.LC_grade_select_mode_selector_header {
1.705 tempelho 5337: font-weight: bold;
5338: font-size: medium;
1.601 albertel 5339: }
5340: div.LC_grade_select_mode_type {
5341: clear: left;
5342: }
5343:
1.597 albertel 5344: div.LC_grade_show_user {
5345: margin-top: 20px;
5346: border: 1px solid black;
5347: }
5348: div.LC_grade_user_name {
5349: background: #DDDDEE;
5350: border-bottom: 1px solid black;
1.705 tempelho 5351: font-weight: bold;
5352: font-size: large;
1.597 albertel 5353: }
5354: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5355: background: #DDEEDD;
5356: }
5357:
5358: div.LC_grade_show_problem,
5359: div.LC_grade_submissions,
5360: div.LC_grade_message_center,
5361: div.LC_grade_info_links,
5362: div.LC_grade_assign {
5363: margin: 5px;
5364: width: 99%;
5365: background: #FFFFFF;
5366: }
5367: div.LC_grade_show_problem_header,
5368: div.LC_grade_submissions_header,
5369: div.LC_grade_message_center_header,
5370: div.LC_grade_assign_header {
1.705 tempelho 5371: font-weight: bold;
5372: font-size: large;
1.597 albertel 5373: }
5374: div.LC_grade_show_problem_problem,
5375: div.LC_grade_submissions_body,
5376: div.LC_grade_message_center_body,
5377: div.LC_grade_assign_body {
5378: border: 1px solid black;
5379: width: 99%;
5380: background: #FFFFFF;
5381: }
1.598 albertel 5382: span.LC_grade_check_note {
1.705 tempelho 5383: font-weight: normal;
5384: font-size: medium;
1.598 albertel 5385: display: inline;
5386: position: absolute;
5387: right: 1em;
5388: }
1.597 albertel 5389:
1.613 albertel 5390: table.LC_scantron_action {
5391: width: 100%;
5392: }
5393: table.LC_scantron_action tr th {
1.698 harmsja 5394: font-weight:bold;
5395: font-style:normal;
1.613 albertel 5396: }
1.698 harmsja 5397: .LC_edit_problem_header,
1.614 albertel 5398: div.LC_edit_problem_footer {
1.705 tempelho 5399: font-weight: normal;
5400: font-size: medium;
1.602 albertel 5401: margin: 2px;
1.600 albertel 5402: }
5403: div.LC_edit_problem_header,
1.602 albertel 5404: div.LC_edit_problem_header div,
1.614 albertel 5405: div.LC_edit_problem_footer,
5406: div.LC_edit_problem_footer div,
1.602 albertel 5407: div.LC_edit_problem_editxml_header,
5408: div.LC_edit_problem_editxml_header div {
1.600 albertel 5409: margin-top: 5px;
5410: }
1.602 albertel 5411: div.LC_edit_problem_header_edit_row {
5412: background: $tabbg;
5413: padding: 3px;
5414: margin-bottom: 5px;
5415: }
1.600 albertel 5416: div.LC_edit_problem_header_title {
1.705 tempelho 5417: font-weight: bold;
5418: font-size: larger;
1.602 albertel 5419: background: $tabbg;
5420: padding: 3px;
5421: }
5422: table.LC_edit_problem_header_title {
1.705 tempelho 5423: font-size: larger;
5424: font-weight: bold;
1.602 albertel 5425: width: 100%;
5426: border-color: $pgbg;
5427: border-style: solid;
5428: border-width: $border;
5429:
1.600 albertel 5430: background: $tabbg;
1.602 albertel 5431: border-collapse: collapse;
5432: padding: 0px
5433: }
5434:
5435: div.LC_edit_problem_discards {
5436: float: left;
5437: padding-bottom: 5px;
5438: }
5439: div.LC_edit_problem_saves {
5440: float: right;
5441: padding-bottom: 5px;
1.600 albertel 5442: }
5443: hr.LC_edit_problem_divide {
1.602 albertel 5444: clear: both;
1.600 albertel 5445: color: $tabbg;
5446: background-color: $tabbg;
5447: height: 3px;
5448: border: 0px;
5449: }
1.679 riegler 5450: img.stift{
1.678 riegler 5451: border-width:0;
1.679 riegler 5452: vertical-align:middle;
1.677 riegler 5453: }
1.680 riegler 5454:
1.681 riegler 5455: table#LC_mainmenu{
5456: margin-top:10px;
5457: width:80%;
5458:
5459: }
5460:
1.680 riegler 5461: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5462: vertical-align: top;
5463: width: 45%;
5464: }
5465: .LC_mainmenu_fieldset_category {
5466: color: $font;
5467: background: $pgbg;
5468: font-family: $sans;
5469: font-size: small;
5470: font-weight: bold;
5471: }
5472:
1.693 droeschl 5473: /* ---- Remove when done ----
5474: # The following styles is part of the redesign of LON-CAPA and are
5475: # subject to change during this project.
5476: # Don't rely on their current functionality as they might be
5477: # changed or removed.
5478: # --------------------------*/
5479:
1.698 harmsja 5480: a:hover,
5481: ol.smallMenu a:hover,
5482: ol#MenuBreadcrumbs a:hover,
5483: ul#TabMainMenuContent a:hover,
5484: .FormSectionClearButton input:hover{
5485: color:#BF2317;
5486: text-decoration:none;
1.693 droeschl 5487: }
5488:
5489: h1 {
1.701 harmsja 5490: padding:5px 10px 5px 0px;
1.693 droeschl 5491: line-height:130%;
5492: }
1.698 harmsja 5493:
1.693 droeschl 5494: h2,h3,h4,h5,h6
5495: {
5496: margin:5px 0px 5px 0px;
5497: line-height:130%;
5498: }
1.698 harmsja 5499: .hcell{
5500: padding:3px 15px 3px 15px;
5501: margin:0px;
1.703 harmsja 5502: background-color:$tabbg;
5503: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5504: }
1.698 harmsja 5505: .noBorder {
5506: border:0px;
5507: }
5508: /*
5509: .bgLightGrey { background:URL(images/TabMenuBG.png) repeat-x left top; }
5510: .bgLightGreyYellow {background-color:#EFECE0;}
5511: */
1.693 droeschl 5512:
5513:
1.698 harmsja 5514: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5515: .HeadRight {
5516: text-align: right;
5517: float: right;
5518: margin: 0px;
5519: padding: 0px;
1.698 harmsja 5520: right:0;
1.693 droeschl 5521: position:absolute;
1.698 harmsja 5522: overflow:hidden;
1.693 droeschl 5523: }
5524:
1.698 harmsja 5525: p {
5526: padding: 10px;
5527:
5528: }
5529: .FormSectionClearButton input {
5530: background-color:transparent;
5531: border:0px;
5532: cursor:pointer;
5533: text-decoration:underline;
1.693 droeschl 5534: }
5535:
5536:
1.698 harmsja 5537: dl,ul,div,fieldset {
5538: margin: 10px 10px 10px 0px;
1.693 droeschl 5539: overflow:hidden;
5540: }
1.698 harmsja 5541: ol.smallMenu {
5542: margin: 0px;
1.693 droeschl 5543: }
5544:
1.698 harmsja 5545: ol.smallMenu li {
1.693 droeschl 5546: display: inline;
5547: padding: 5px 5px 0px 10px;
5548: vertical-align: top;
5549: }
5550:
1.698 harmsja 5551: ol.smallMenu li img {
1.693 droeschl 5552: vertical-align: bottom;
5553: }
5554:
1.698 harmsja 5555: ol.smallMenu a {
1.693 droeschl 5556: font-size: 90%;
5557: color: RGB(80, 80, 80);
5558: text-decoration: none;
5559: }
5560:
1.698 harmsja 5561: ol#TabMainMenuContent {
1.693 droeschl 5562:
5563: margin: 0px 0px 10px 0px;
5564: padding: 0px;
5565: }
5566:
1.698 harmsja 5567: ol#TabMainMenuContent li {
1.693 droeschl 5568: display: inline;
5569: vertical-align: bottom;
5570: border-bottom: solid 1px RGB(175, 175, 175);
5571: border-right: solid 1px RGB(175, 175, 175);
5572: padding: 5px 15px 5px 15px;
5573: margin-right:4px;
5574: line-height: 140%;
5575: font-weight: bold;
5576: overflow:hidden;
1.698 harmsja 5577: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left top;*/
1.693 droeschl 5578: }
5579:
1.698 harmsja 5580: ol#TabMainMenuContent li a{
1.693 droeschl 5581: color: RGB(47, 47, 47);
5582: text-decoration: none;
5583: }
5584:
1.698 harmsja 5585: ol#TabMainMenuContent div.columnSection {
1.693 droeschl 5586: margin-bottom: 0px;
5587: }
5588:
1.698 harmsja 5589: ol#MenuBreadcrumbs, ol#PathBreadcrumbs {
1.693 droeschl 5590: border-top: solid 1px RGB(255, 255, 255);
5591: height: 20px;
5592: line-height: 20px;
5593: vertical-align: bottom;
5594: margin: 0px 0px 30px 0px;
5595: padding-left: 10px;
5596: list-style-position: inside;
1.698 harmsja 5597: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left
5598: top;*/
1.693 droeschl 5599: }
5600:
1.698 harmsja 5601: ol#MenuBreadcrumbs li, ol#PathBreadcrumbs li {
5602: /* background: url(images/pfeil_white.png) no-repeat left center;*/
1.693 droeschl 5603: display: inline;
5604: padding: 0px 0px 0px 10px;
5605: vertical-align: bottom;
5606: overflow:hidden;
5607: }
5608:
1.698 harmsja 5609: ol#MenuBreadcrumbs li a {
1.693 droeschl 5610: text-decoration: none;
5611: font-size:90%;
5612: }
1.698 harmsja 5613: ol#PathBreadcrumbs li a{
5614: text-decoration:none;
5615: font-size:100%;
5616: font-weight:bold;
1.693 droeschl 5617: }
5618:
1.698 harmsja 5619: .ContentBoxSpecial
1.693 droeschl 5620: {
1.701 harmsja 5621: border: solid 1px $lg_border_color;
1.698 harmsja 5622: }
5623: .ContentBox {
5624: padding:10px;
1.693 droeschl 5625: }
1.698 harmsja 5626: .PopUp
1.693 droeschl 5627: {
1.698 harmsja 5628: padding:10px;
5629: border-left:solid 1px $lg_border_color;
5630: border-top:solid 1px $lg_border_color;
5631: border-bottom:outset 1px $lg_border_color;
5632: border-right:outset 1px $lg_border_color;
5633: display:none;
5634: position:absolute;
5635: right:0;
5636: background-color:white;
5637: z-index:5;
1.693 droeschl 5638: }
5639:
1.698 harmsja 5640: dl.ListStyleClean dt {
1.693 droeschl 5641: padding-right: 5px;
5642: display: table-header-group;
5643: }
5644:
1.698 harmsja 5645: dl.ListStyleClean dd {
1.693 droeschl 5646: display: table-row;
5647: }
5648:
5649: .ListStyleClean,
5650: .ListStyleSimple,
5651: .ListStyleNormal,
5652: .ListStyleNormal_Border,
5653: .ListStyleSpecial
5654: {
5655: /*display:block; */
5656: list-style-position: inside;
5657: list-style-type: none;
5658: overflow: hidden;
5659: padding: 0px;
5660: }
5661:
5662: .ListStyleSimple li,
1.698 harmsja 5663: .ListStyleSimple dd,
1.693 droeschl 5664: .ListStyleNormal li,
1.698 harmsja 5665: .ListStyleNormal dd,
1.693 droeschl 5666: .ListStyleSpecial li,
1.698 harmsja 5667: .ListStyleSpecial dd
1.693 droeschl 5668: {
5669: margin: 0px;
5670: padding: 5px 5px 5px 10px;
5671: clear: both;
5672: }
5673:
1.698 harmsja 5674: .ListStyleClean li,
5675: .ListStyleClean dd {
1.693 droeschl 5676: padding-top: 0px;
5677: padding-bottom: 0px;
5678: }
5679:
1.698 harmsja 5680: .ListStyleSimple dd,
5681: .ListStyleSimple li{
5682: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5683: }
5684:
1.698 harmsja 5685: .ListStyleSpecial li,
5686: .ListStyleSpecial dd {
1.693 droeschl 5687: list-style-type: none;
5688: background-color: RGB(220, 220, 220);
5689: margin-bottom: 4px;
5690: }
5691:
1.698 harmsja 5692: table.SimpleTable {
5693: margin:5px;
5694: border:solid 1px $lg_border_color;
1.693 droeschl 5695: }
5696:
1.698 harmsja 5697: table.SimpleTable tr {
5698: padding:0px;
5699: border:solid 1px $lg_border_color;
1.693 droeschl 5700: }
5701: table.SimpleTable thead{
1.698 harmsja 5702: background:rgb(220,220,220);
1.693 droeschl 5703: }
5704:
1.698 harmsja 5705: div.columnSection {
1.693 droeschl 5706: display: block;
5707: clear: both;
5708: overflow: hidden;
5709: margin:0px;
5710: }
5711:
1.698 harmsja 5712: div.columnSection>* {
1.693 droeschl 5713: float: left;
5714: margin: 10px 20px 10px 0px;
5715: overflow:hidden;
5716: }
1.698 harmsja 5717: div.columnSection > .ContentBox,
5718: div.columnSection > .ContentBoxSpecial
1.693 droeschl 5719: {
1.698 harmsja 5720: width: 400px;
1.693 droeschl 5721:
5722: }
5723:
1.694 tempelho 5724: .LC_loginpage_container {
5725: text-align:left;
5726: margin : 0 auto;
5727: width:65%;
5728: padding: 10px;
5729: height: auto;
1.704 muellerd 5730: # background-color:#FFFFFF;
5731: background-color:$loginbg;
1.694 tempelho 5732: border:1px solid #CCCCCC;
5733: }
5734:
5735:
5736: .LC_loginpage_loginContainer {
5737: float:left;
5738: width:60%;
5739: }
5740:
5741: .LC_loginpage_loginInfo {
5742: margin-top:20px;
5743: margin-left:20px;
5744: float:left;
5745: width:30%;
5746: border:1px solid #CCCCCC;
5747: padding:10px;
5748: }
5749:
5750: .LC_loginpage_space {
5751: clear:both;
5752: margin-bottom:20px;
5753: border-bottom: 1px solid #CCCCCC;
5754: }
5755:
5756: .LC_loginpage_fieldset{
5757: border: 1px solid #CCCCCC;
5758: margin: 0 auto;
5759: }
5760:
5761: .LC_loginpage_legend{
5762: padding: 2px;
5763: margin: 0px;
5764: font-size:14px;
5765: font-weight:bold;
5766: }
5767:
5768:
1.693 droeschl 5769:
1.343 albertel 5770: END
5771: }
5772:
1.306 albertel 5773: =pod
5774:
5775: =item * &headtag()
5776:
5777: Returns a uniform footer for LON-CAPA web pages.
5778:
1.307 albertel 5779: Inputs: $title - optional title for the head
5780: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5781: $args - optional arguments
1.319 albertel 5782: force_register - if is true call registerurl so the remote is
5783: informed
1.415 albertel 5784: redirect -> array ref of
5785: 1- seconds before redirect occurs
5786: 2- url to redirect to
5787: 3- whether the side effect should occur
1.315 albertel 5788: (side effect of setting
5789: $env{'internal.head.redirect'} to the url
5790: redirected too)
1.352 albertel 5791: domain -> force to color decorate a page for a specific
5792: domain
5793: function -> force usage of a specific rolish color scheme
5794: bgcolor -> override the default page bgcolor
1.460 albertel 5795: no_auto_mt_title
5796: -> prevent &mt()ing the title arg
1.464 albertel 5797:
1.306 albertel 5798: =cut
5799:
5800: sub headtag {
1.313 albertel 5801: my ($title,$head_extra,$args) = @_;
1.306 albertel 5802:
1.363 albertel 5803: my $function = $args->{'function'} || &get_users_function();
5804: my $domain = $args->{'domain'} || &determinedomain();
5805: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5806: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5807: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5808: #time(),
1.418 albertel 5809: $env{'environment.color.timestamp'},
1.363 albertel 5810: $function,$domain,$bgcolor);
5811:
1.369 www 5812: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5813:
1.308 albertel 5814: my $result =
5815: '<head>'.
1.461 albertel 5816: &font_settings();
1.319 albertel 5817:
1.461 albertel 5818: if (!$args->{'frameset'}) {
5819: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5820: }
1.319 albertel 5821: if ($args->{'force_register'}) {
5822: $result .= &Apache::lonmenu::registerurl(1);
5823: }
1.436 albertel 5824: if (!$args->{'no_nav_bar'}
5825: && !$args->{'only_body'}
5826: && !$args->{'frameset'}) {
5827: $result .= &help_menu_js();
5828: }
1.319 albertel 5829:
1.314 albertel 5830: if (ref($args->{'redirect'})) {
1.414 albertel 5831: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5832: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5833: if (!$inhibit_continue) {
5834: $env{'internal.head.redirect'} = $url;
5835: }
1.313 albertel 5836: $result.=<<ADDMETA
5837: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5838: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5839: ADDMETA
5840: }
1.306 albertel 5841: if (!defined($title)) {
5842: $title = 'The LearningOnline Network with CAPA';
5843: }
1.460 albertel 5844: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5845: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5846: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5847: .$head_extra;
1.306 albertel 5848: return $result;
5849: }
5850:
5851: =pod
5852:
1.340 albertel 5853: =item * &font_settings()
5854:
5855: Returns neccessary <meta> to set the proper encoding
5856:
5857: Inputs: none
5858:
5859: =cut
5860:
5861: sub font_settings {
5862: my $headerstring='';
1.647 www 5863: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5864: $headerstring.=
5865: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5866: }
5867: return $headerstring;
5868: }
5869:
1.341 albertel 5870: =pod
5871:
5872: =item * &xml_begin()
5873:
5874: Returns the needed doctype and <html>
5875:
5876: Inputs: none
5877:
5878: =cut
5879:
5880: sub xml_begin {
5881: my $output='';
5882:
1.592 albertel 5883: if ($env{'internal.start_page'}==1) {
5884: &Apache::lonhtmlcommon::init_htmlareafields();
5885: }
1.342 albertel 5886:
1.341 albertel 5887: if ($env{'browser.mathml'}) {
5888: $output='<?xml version="1.0"?>'
5889: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5890: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5891:
5892: # .'<!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">] >'
5893: .'<!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">'
5894: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5895: .'xmlns="http://www.w3.org/1999/xhtml">';
5896: } else {
5897: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5898: }
5899: return $output;
5900: }
1.340 albertel 5901:
5902: =pod
5903:
1.306 albertel 5904: =item * &endheadtag()
5905:
5906: Returns a uniform </head> for LON-CAPA web pages.
5907:
5908: Inputs: none
5909:
5910: =cut
5911:
5912: sub endheadtag {
5913: return '</head>';
5914: }
5915:
5916: =pod
5917:
5918: =item * &head()
5919:
5920: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5921:
1.648 raeburn 5922: Inputs:
5923:
5924: =over 4
5925:
5926: $title - optional title for the page
5927:
5928: $head_extra - optional extra HTML to put inside the <head>
5929:
5930: =back
1.405 albertel 5931:
1.306 albertel 5932: =cut
5933:
5934: sub head {
1.325 albertel 5935: my ($title,$head_extra,$args) = @_;
5936: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5937: }
5938:
5939: =pod
5940:
5941: =item * &start_page()
5942:
5943: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5944:
1.648 raeburn 5945: Inputs:
5946:
5947: =over 4
5948:
5949: $title - optional title for the page
5950:
5951: $head_extra - optional extra HTML to incude inside the <head>
5952:
5953: $args - additional optional args supported are:
5954:
5955: =over 8
5956:
5957: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 5958: arg on
1.648 raeburn 5959: no_nav_bar -> is true will set &bodytag() notopbar arg on
5960: add_entries -> additional attributes to add to the <body>
5961: domain -> force to color decorate a page for a
1.317 albertel 5962: specific domain
1.648 raeburn 5963: function -> force usage of a specific rolish color
1.317 albertel 5964: scheme
1.648 raeburn 5965: redirect -> see &headtag()
5966: bgcolor -> override the default page bg color
5967: js_ready -> return a string ready for being used in
1.317 albertel 5968: a javascript writeln
1.648 raeburn 5969: html_encode -> return a string ready for being used in
1.320 albertel 5970: a html attribute
1.648 raeburn 5971: force_register -> if is true will turn on the &bodytag()
1.317 albertel 5972: $forcereg arg
1.648 raeburn 5973: body_title -> alternate text to use instead of $title
1.326 albertel 5974: in the title box that appears, this text
5975: is not auto translated like the $title is
1.648 raeburn 5976: frameset -> if true will start with a <frameset>
1.330 albertel 5977: rather than <body>
1.648 raeburn 5978: no_title -> if true the title bar won't be shown
5979: skip_phases -> hash ref of
1.338 albertel 5980: head -> skip the <html><head> generation
5981: body -> skip all <body> generation
1.648 raeburn 5982: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 5983: 'Switch To Inline Menu' link
1.648 raeburn 5984: no_auto_mt_title -> prevent &mt()ing the title arg
5985: inherit_jsmath -> when creating popup window in a page,
5986: should it have jsmath forced on by the
5987: current page
1.361 albertel 5988:
1.648 raeburn 5989: =back
1.460 albertel 5990:
1.648 raeburn 5991: =back
1.562 albertel 5992:
1.306 albertel 5993: =cut
5994:
5995: sub start_page {
1.309 albertel 5996: my ($title,$head_extra,$args) = @_;
1.318 albertel 5997: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 5998: my %head_args;
1.352 albertel 5999: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6000: 'bgcolor','frameset','no_nav_bar','only_body',
6001: 'no_auto_mt_title') {
1.319 albertel 6002: if (defined($args->{$arg})) {
1.324 raeburn 6003: $head_args{$arg} = $args->{$arg};
1.319 albertel 6004: }
1.313 albertel 6005: }
1.319 albertel 6006:
1.315 albertel 6007: $env{'internal.start_page'}++;
1.338 albertel 6008: my $result;
6009: if (! exists($args->{'skip_phases'}{'head'}) ) {
6010: $result.=
1.341 albertel 6011: &xml_begin().
1.338 albertel 6012: &headtag($title,$head_extra,\%head_args).&endheadtag();
6013: }
6014:
6015: if (! exists($args->{'skip_phases'}{'body'}) ) {
6016: if ($args->{'frameset'}) {
6017: my $attr_string = &make_attr_string($args->{'force_register'},
6018: $args->{'add_entries'});
6019: $result .= "\n<frameset $attr_string>\n";
6020: } else {
6021: $result .=
6022: &bodytag($title,
6023: $args->{'function'}, $args->{'add_entries'},
6024: $args->{'only_body'}, $args->{'domain'},
6025: $args->{'force_register'}, $args->{'body_title'},
6026: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6027: $args->{'no_title'}, $args->{'no_inline_link'},
6028: $args);
1.338 albertel 6029: }
1.330 albertel 6030: }
1.338 albertel 6031:
1.315 albertel 6032: if ($args->{'js_ready'}) {
1.317 albertel 6033: $result = &js_ready($result);
1.315 albertel 6034: }
1.320 albertel 6035: if ($args->{'html_encode'}) {
6036: $result = &html_encode($result);
6037: }
1.315 albertel 6038: return $result;
1.306 albertel 6039: }
6040:
1.330 albertel 6041:
1.306 albertel 6042: =pod
6043:
6044: =item * &head()
6045:
6046: Returns a complete </body></html> section for LON-CAPA web pages.
6047:
1.315 albertel 6048: Inputs: $args - additional optional args supported are:
6049: js_ready -> return a string ready for being used in
6050: a javascript writeln
1.320 albertel 6051: html_encode -> return a string ready for being used in
6052: a html attribute
1.330 albertel 6053: frameset -> if true will start with a <frameset>
6054: rather than <body>
1.493 albertel 6055: dicsussion -> if true will get discussion from
6056: lonxml::xmlend
6057: (you can pass the target and parser arguments
6058: through optional 'target' and 'parser' args
6059: to this routine)
1.306 albertel 6060:
6061: =cut
6062:
6063: sub end_page {
1.315 albertel 6064: my ($args) = @_;
6065: $env{'internal.end_page'}++;
1.330 albertel 6066: my $result;
1.335 albertel 6067: if ($args->{'discussion'}) {
6068: my ($target,$parser);
6069: if (ref($args->{'discussion'})) {
6070: ($target,$parser) =($args->{'discussion'}{'target'},
6071: $args->{'discussion'}{'parser'});
6072: }
6073: $result .= &Apache::lonxml::xmlend($target,$parser);
6074: }
6075:
1.330 albertel 6076: if ($args->{'frameset'}) {
6077: $result .= '</frameset>';
6078: } else {
1.635 raeburn 6079: $result .= &endbodytag($args);
1.330 albertel 6080: }
6081: $result .= "\n</html>";
6082:
1.315 albertel 6083: if ($args->{'js_ready'}) {
1.317 albertel 6084: $result = &js_ready($result);
1.315 albertel 6085: }
1.335 albertel 6086:
1.320 albertel 6087: if ($args->{'html_encode'}) {
6088: $result = &html_encode($result);
6089: }
1.335 albertel 6090:
1.315 albertel 6091: return $result;
6092: }
6093:
1.320 albertel 6094: sub html_encode {
6095: my ($result) = @_;
6096:
1.322 albertel 6097: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6098:
6099: return $result;
6100: }
1.317 albertel 6101: sub js_ready {
6102: my ($result) = @_;
6103:
1.323 albertel 6104: $result =~ s/[\n\r]/ /xmsg;
6105: $result =~ s/\\/\\\\/xmsg;
6106: $result =~ s/'/\\'/xmsg;
1.372 albertel 6107: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6108:
6109: return $result;
6110: }
6111:
1.315 albertel 6112: sub validate_page {
6113: if ( exists($env{'internal.start_page'})
1.316 albertel 6114: && $env{'internal.start_page'} > 1) {
6115: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6116: $env{'internal.start_page'}.' '.
1.316 albertel 6117: $ENV{'request.filename'});
1.315 albertel 6118: }
6119: if ( exists($env{'internal.end_page'})
1.316 albertel 6120: && $env{'internal.end_page'} > 1) {
6121: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6122: $env{'internal.end_page'}.' '.
1.316 albertel 6123: $env{'request.filename'});
1.315 albertel 6124: }
6125: if ( exists($env{'internal.start_page'})
6126: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6127: &Apache::lonnet::logthis('start_page called without end_page '.
6128: $env{'request.filename'});
1.315 albertel 6129: }
6130: if ( ! exists($env{'internal.start_page'})
6131: && exists($env{'internal.end_page'})) {
1.316 albertel 6132: &Apache::lonnet::logthis('end_page called without start_page'.
6133: $env{'request.filename'});
1.315 albertel 6134: }
1.306 albertel 6135: }
1.315 albertel 6136:
1.318 albertel 6137: sub simple_error_page {
6138: my ($r,$title,$msg) = @_;
6139: my $page =
6140: &Apache::loncommon::start_page($title).
6141: &mt($msg).
6142: &Apache::loncommon::end_page();
6143: if (ref($r)) {
6144: $r->print($page);
1.327 albertel 6145: return;
1.318 albertel 6146: }
6147: return $page;
6148: }
1.347 albertel 6149:
6150: {
1.610 albertel 6151: my @row_count;
1.347 albertel 6152: sub start_data_table {
1.422 albertel 6153: my ($add_class) = @_;
6154: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6155: unshift(@row_count,0);
1.422 albertel 6156: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6157: }
6158:
6159: sub end_data_table {
1.610 albertel 6160: shift(@row_count);
1.389 albertel 6161: return '</table>'."\n";;
1.347 albertel 6162: }
6163:
6164: sub start_data_table_row {
1.422 albertel 6165: my ($add_class) = @_;
1.610 albertel 6166: $row_count[0]++;
6167: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6168: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6169: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6170: }
1.471 banghart 6171:
6172: sub continue_data_table_row {
6173: my ($add_class) = @_;
1.610 albertel 6174: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6175: $css_class = (join(' ',$css_class,$add_class));
6176: return '<tr class="'.$css_class.'">'."\n";;
6177: }
1.347 albertel 6178:
6179: sub end_data_table_row {
1.389 albertel 6180: return '</tr>'."\n";;
1.347 albertel 6181: }
1.367 www 6182:
1.421 albertel 6183: sub start_data_table_empty_row {
1.707 ! bisitz 6184: # $row_count[0]++;
1.421 albertel 6185: return '<tr class="LC_empty_row" >'."\n";;
6186: }
6187:
6188: sub end_data_table_empty_row {
6189: return '</tr>'."\n";;
6190: }
6191:
1.367 www 6192: sub start_data_table_header_row {
1.389 albertel 6193: return '<tr class="LC_header_row">'."\n";;
1.367 www 6194: }
6195:
6196: sub end_data_table_header_row {
1.389 albertel 6197: return '</tr>'."\n";;
1.367 www 6198: }
1.347 albertel 6199: }
6200:
1.548 albertel 6201: =pod
6202:
6203: =item * &inhibit_menu_check($arg)
6204:
6205: Checks for a inhibitmenu state and generates output to preserve it
6206:
6207: Inputs: $arg - can be any of
6208: - undef - in which case the return value is a string
6209: to add into arguments list of a uri
6210: - 'input' - in which case the return value is a HTML
6211: <form> <input> field of type hidden to
6212: preserve the value
6213: - a url - in which case the return value is the url with
6214: the neccesary cgi args added to preserve the
6215: inhibitmenu state
6216: - a ref to a url - no return value, but the string is
6217: updated to include the neccessary cgi
6218: args to preserve the inhibitmenu state
6219:
6220: =cut
6221:
6222: sub inhibit_menu_check {
6223: my ($arg) = @_;
6224: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6225: if ($arg eq 'input') {
6226: if ($env{'form.inhibitmenu'}) {
6227: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6228: } else {
6229: return
6230: }
6231: }
6232: if ($env{'form.inhibitmenu'}) {
6233: if (ref($arg)) {
6234: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6235: } elsif ($arg eq '') {
6236: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6237: } else {
6238: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6239: }
6240: }
6241: if (!ref($arg)) {
6242: return $arg;
6243: }
6244: }
6245:
1.251 albertel 6246: ###############################################
1.182 matthew 6247:
6248: =pod
6249:
1.549 albertel 6250: =back
6251:
6252: =head1 User Information Routines
6253:
6254: =over 4
6255:
1.405 albertel 6256: =item * &get_users_function()
1.182 matthew 6257:
6258: Used by &bodytag to determine the current users primary role.
6259: Returns either 'student','coordinator','admin', or 'author'.
6260:
6261: =cut
6262:
6263: ###############################################
6264: sub get_users_function {
6265: my $function = 'student';
1.258 albertel 6266: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6267: $function='coordinator';
6268: }
1.258 albertel 6269: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6270: $function='admin';
6271: }
1.258 albertel 6272: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6273: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6274: $function='author';
6275: }
6276: return $function;
1.54 www 6277: }
1.99 www 6278:
6279: ###############################################
6280:
1.233 raeburn 6281: =pod
6282:
1.542 raeburn 6283: =item * &check_user_status()
1.274 raeburn 6284:
6285: Determines current status of supplied role for a
6286: specific user. Roles can be active, previous or future.
6287:
6288: Inputs:
6289: user's domain, user's username, course's domain,
1.375 raeburn 6290: course's number, optional section ID.
1.274 raeburn 6291:
6292: Outputs:
6293: role status: active, previous or future.
6294:
6295: =cut
6296:
6297: sub check_user_status {
1.412 raeburn 6298: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6299: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6300: my @uroles = keys %userinfo;
6301: my $srchstr;
6302: my $active_chk = 'none';
1.412 raeburn 6303: my $now = time;
1.274 raeburn 6304: if (@uroles > 0) {
1.412 raeburn 6305: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6306: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6307: } else {
1.412 raeburn 6308: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6309: }
6310: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6311: my $role_end = 0;
6312: my $role_start = 0;
6313: $active_chk = 'active';
1.412 raeburn 6314: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6315: $role_end = $1;
6316: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6317: $role_start = $1;
1.274 raeburn 6318: }
6319: }
6320: if ($role_start > 0) {
1.412 raeburn 6321: if ($now < $role_start) {
1.274 raeburn 6322: $active_chk = 'future';
6323: }
6324: }
6325: if ($role_end > 0) {
1.412 raeburn 6326: if ($now > $role_end) {
1.274 raeburn 6327: $active_chk = 'previous';
6328: }
6329: }
6330: }
6331: }
6332: return $active_chk;
6333: }
6334:
6335: ###############################################
6336:
6337: =pod
6338:
1.405 albertel 6339: =item * &get_sections()
1.233 raeburn 6340:
6341: Determines all the sections for a course including
6342: sections with students and sections containing other roles.
1.419 raeburn 6343: Incoming parameters:
6344:
6345: 1. domain
6346: 2. course number
6347: 3. reference to array containing roles for which sections should
6348: be gathered (optional).
6349: 4. reference to array containing status types for which sections
6350: should be gathered (optional).
6351:
6352: If the third argument is undefined, sections are gathered for any role.
6353: If the fourth argument is undefined, sections are gathered for any status.
6354: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6355:
1.374 raeburn 6356: Returns section hash (keys are section IDs, values are
6357: number of users in each section), subject to the
1.419 raeburn 6358: optional roles filter, optional status filter
1.233 raeburn 6359:
6360: =cut
6361:
6362: ###############################################
6363: sub get_sections {
1.419 raeburn 6364: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6365: if (!defined($cdom) || !defined($cnum)) {
6366: my $cid = $env{'request.course.id'};
6367:
6368: return if (!defined($cid));
6369:
6370: $cdom = $env{'course.'.$cid.'.domain'};
6371: $cnum = $env{'course.'.$cid.'.num'};
6372: }
6373:
6374: my %sectioncount;
1.419 raeburn 6375: my $now = time;
1.240 albertel 6376:
1.366 albertel 6377: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6378: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6379: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6380: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6381: my $start_index = &Apache::loncoursedata::CL_START();
6382: my $end_index = &Apache::loncoursedata::CL_END();
6383: my $status;
1.366 albertel 6384: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6385: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6386: $data->[$status_index],
6387: $data->[$start_index],
6388: $data->[$end_index]);
6389: if ($stu_status eq 'Active') {
6390: $status = 'active';
6391: } elsif ($end < $now) {
6392: $status = 'previous';
6393: } elsif ($start > $now) {
6394: $status = 'future';
6395: }
6396: if ($section ne '-1' && $section !~ /^\s*$/) {
6397: if ((!defined($possible_status)) || (($status ne '') &&
6398: (grep/^\Q$status\E$/,@{$possible_status}))) {
6399: $sectioncount{$section}++;
6400: }
1.240 albertel 6401: }
6402: }
6403: }
6404: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6405: foreach my $user (sort(keys(%courseroles))) {
6406: if ($user !~ /^(\w{2})/) { next; }
6407: my ($role) = ($user =~ /^(\w{2})/);
6408: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6409: my ($section,$status);
1.240 albertel 6410: if ($role eq 'cr' &&
6411: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6412: $section=$1;
6413: }
6414: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6415: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6416: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6417: if ($end == -1 && $start == -1) {
6418: next; #deleted role
6419: }
6420: if (!defined($possible_status)) {
6421: $sectioncount{$section}++;
6422: } else {
6423: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6424: $status = 'active';
6425: } elsif ($end < $now) {
6426: $status = 'future';
6427: } elsif ($start > $now) {
6428: $status = 'previous';
6429: }
6430: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6431: $sectioncount{$section}++;
6432: }
6433: }
1.233 raeburn 6434: }
1.366 albertel 6435: return %sectioncount;
1.233 raeburn 6436: }
6437:
1.274 raeburn 6438: ###############################################
1.294 raeburn 6439:
6440: =pod
1.405 albertel 6441:
6442: =item * &get_course_users()
6443:
1.275 raeburn 6444: Retrieves usernames:domains for users in the specified course
6445: with specific role(s), and access status.
6446:
6447: Incoming parameters:
1.277 albertel 6448: 1. course domain
6449: 2. course number
6450: 3. access status: users must have - either active,
1.275 raeburn 6451: previous, future, or all.
1.277 albertel 6452: 4. reference to array of permissible roles
1.288 raeburn 6453: 5. reference to array of section restrictions (optional)
6454: 6. reference to results object (hash of hashes).
6455: 7. reference to optional userdata hash
1.609 raeburn 6456: 8. reference to optional statushash
1.630 raeburn 6457: 9. flag if privileged users (except those set to unhide in
6458: course settings) should be excluded
1.609 raeburn 6459: Keys of top level results hash are roles.
1.275 raeburn 6460: Keys of inner hashes are username:domain, with
6461: values set to access type.
1.288 raeburn 6462: Optional userdata hash returns an array with arguments in the
6463: same order as loncoursedata::get_classlist() for student data.
6464:
1.609 raeburn 6465: Optional statushash returns
6466:
1.288 raeburn 6467: Entries for end, start, section and status are blank because
6468: of the possibility of multiple values for non-student roles.
6469:
1.275 raeburn 6470: =cut
1.405 albertel 6471:
1.275 raeburn 6472: ###############################################
1.405 albertel 6473:
1.275 raeburn 6474: sub get_course_users {
1.630 raeburn 6475: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6476: my %idx = ();
1.419 raeburn 6477: my %seclists;
1.288 raeburn 6478:
6479: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6480: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6481: $idx{end} = &Apache::loncoursedata::CL_END();
6482: $idx{start} = &Apache::loncoursedata::CL_START();
6483: $idx{id} = &Apache::loncoursedata::CL_ID();
6484: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6485: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6486: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6487:
1.290 albertel 6488: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6489: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6490: my $now = time;
1.277 albertel 6491: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6492: my $match = 0;
1.412 raeburn 6493: my $secmatch = 0;
1.419 raeburn 6494: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6495: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6496: if ($section eq '') {
6497: $section = 'none';
6498: }
1.291 albertel 6499: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6500: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6501: $secmatch = 1;
6502: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6503: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6504: $secmatch = 1;
6505: }
6506: } else {
1.419 raeburn 6507: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6508: $secmatch = 1;
6509: }
1.290 albertel 6510: }
1.412 raeburn 6511: if (!$secmatch) {
6512: next;
6513: }
1.419 raeburn 6514: }
1.275 raeburn 6515: if (defined($$types{'active'})) {
1.288 raeburn 6516: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6517: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6518: $match = 1;
1.275 raeburn 6519: }
6520: }
6521: if (defined($$types{'previous'})) {
1.609 raeburn 6522: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6523: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6524: $match = 1;
1.275 raeburn 6525: }
6526: }
6527: if (defined($$types{'future'})) {
1.609 raeburn 6528: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6529: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6530: $match = 1;
1.275 raeburn 6531: }
6532: }
1.609 raeburn 6533: if ($match) {
6534: push(@{$seclists{$student}},$section);
6535: if (ref($userdata) eq 'HASH') {
6536: $$userdata{$student} = $$classlist{$student};
6537: }
6538: if (ref($statushash) eq 'HASH') {
6539: $statushash->{$student}{'st'}{$section} = $status;
6540: }
1.288 raeburn 6541: }
1.275 raeburn 6542: }
6543: }
1.412 raeburn 6544: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6545: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6546: my $now = time;
1.609 raeburn 6547: my %displaystatus = ( previous => 'Expired',
6548: active => 'Active',
6549: future => 'Future',
6550: );
1.630 raeburn 6551: my %nothide;
6552: if ($hidepriv) {
6553: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6554: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6555: if ($user !~ /:/) {
6556: $nothide{join(':',split(/[\@]/,$user))}=1;
6557: } else {
6558: $nothide{$user} = 1;
6559: }
6560: }
6561: }
1.439 raeburn 6562: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6563: my $match = 0;
1.412 raeburn 6564: my $secmatch = 0;
1.439 raeburn 6565: my $status;
1.412 raeburn 6566: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6567: $user =~ s/:$//;
1.439 raeburn 6568: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6569: if ($end == -1 || $start == -1) {
6570: next;
6571: }
6572: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6573: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6574: my ($uname,$udom) = split(/:/,$user);
6575: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6576: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6577: $secmatch = 1;
6578: } elsif ($usec eq '') {
1.420 albertel 6579: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6580: $secmatch = 1;
6581: }
6582: } else {
6583: if (grep(/^\Q$usec\E$/,@{$sections})) {
6584: $secmatch = 1;
6585: }
6586: }
6587: if (!$secmatch) {
6588: next;
6589: }
1.288 raeburn 6590: }
1.419 raeburn 6591: if ($usec eq '') {
6592: $usec = 'none';
6593: }
1.275 raeburn 6594: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6595: if ($hidepriv) {
6596: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6597: (!$nothide{$uname.':'.$udom})) {
6598: next;
6599: }
6600: }
1.503 raeburn 6601: if ($end > 0 && $end < $now) {
1.439 raeburn 6602: $status = 'previous';
6603: } elsif ($start > $now) {
6604: $status = 'future';
6605: } else {
6606: $status = 'active';
6607: }
1.277 albertel 6608: foreach my $type (keys(%{$types})) {
1.275 raeburn 6609: if ($status eq $type) {
1.420 albertel 6610: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6611: push(@{$$users{$role}{$user}},$type);
6612: }
1.288 raeburn 6613: $match = 1;
6614: }
6615: }
1.419 raeburn 6616: if (($match) && (ref($userdata) eq 'HASH')) {
6617: if (!exists($$userdata{$uname.':'.$udom})) {
6618: &get_user_info($udom,$uname,\%idx,$userdata);
6619: }
1.420 albertel 6620: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6621: push(@{$seclists{$uname.':'.$udom}},$usec);
6622: }
1.609 raeburn 6623: if (ref($statushash) eq 'HASH') {
6624: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6625: }
1.275 raeburn 6626: }
6627: }
6628: }
6629: }
1.290 albertel 6630: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6631: if ((defined($cdom)) && (defined($cnum))) {
6632: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6633: if ( defined($csettings{'internal.courseowner'}) ) {
6634: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6635: next if ($owner eq '');
6636: my ($ownername,$ownerdom);
6637: if ($owner =~ /^([^:]+):([^:]+)$/) {
6638: $ownername = $1;
6639: $ownerdom = $2;
6640: } else {
6641: $ownername = $owner;
6642: $ownerdom = $cdom;
6643: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6644: }
6645: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6646: if (defined($userdata) &&
1.609 raeburn 6647: !exists($$userdata{$owner})) {
6648: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6649: if (!grep(/^none$/,@{$seclists{$owner}})) {
6650: push(@{$seclists{$owner}},'none');
6651: }
6652: if (ref($statushash) eq 'HASH') {
6653: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6654: }
1.290 albertel 6655: }
1.279 raeburn 6656: }
6657: }
6658: }
1.419 raeburn 6659: foreach my $user (keys(%seclists)) {
6660: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6661: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6662: }
1.275 raeburn 6663: }
6664: return;
6665: }
6666:
1.288 raeburn 6667: sub get_user_info {
6668: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6669: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6670: &plainname($uname,$udom,'lastname');
1.291 albertel 6671: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6672: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6673: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6674: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6675: return;
6676: }
1.275 raeburn 6677:
1.472 raeburn 6678: ###############################################
6679:
6680: =pod
6681:
6682: =item * &get_user_quota()
6683:
6684: Retrieves quota assigned for storage of portfolio files for a user
6685:
6686: Incoming parameters:
6687: 1. user's username
6688: 2. user's domain
6689:
6690: Returns:
1.536 raeburn 6691: 1. Disk quota (in Mb) assigned to student.
6692: 2. (Optional) Type of setting: custom or default
6693: (individually assigned or default for user's
6694: institutional status).
6695: 3. (Optional) - User's institutional status (e.g., faculty, staff
6696: or student - types as defined in localenroll::inst_usertypes
6697: for user's domain, which determines default quota for user.
6698: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6699:
6700: If a value has been stored in the user's environment,
1.536 raeburn 6701: it will return that, otherwise it returns the maximal default
6702: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6703:
6704: =cut
6705:
6706: ###############################################
6707:
6708:
6709: sub get_user_quota {
6710: my ($uname,$udom) = @_;
1.536 raeburn 6711: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6712: if (!defined($udom)) {
6713: $udom = $env{'user.domain'};
6714: }
6715: if (!defined($uname)) {
6716: $uname = $env{'user.name'};
6717: }
6718: if (($udom eq '' || $uname eq '') ||
6719: ($udom eq 'public') && ($uname eq 'public')) {
6720: $quota = 0;
1.536 raeburn 6721: $quotatype = 'default';
6722: $defquota = 0;
1.472 raeburn 6723: } else {
1.536 raeburn 6724: my $inststatus;
1.472 raeburn 6725: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6726: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6727: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6728: } else {
1.536 raeburn 6729: my %userenv =
6730: &Apache::lonnet::get('environment',['portfolioquota',
6731: 'inststatus'],$udom,$uname);
1.472 raeburn 6732: my ($tmp) = keys(%userenv);
6733: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6734: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6735: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6736: } else {
6737: undef(%userenv);
6738: }
6739: }
1.536 raeburn 6740: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6741: if ($quota eq '') {
1.536 raeburn 6742: $quota = $defquota;
6743: $quotatype = 'default';
6744: } else {
6745: $quotatype = 'custom';
1.472 raeburn 6746: }
6747: }
1.536 raeburn 6748: if (wantarray) {
6749: return ($quota,$quotatype,$settingstatus,$defquota);
6750: } else {
6751: return $quota;
6752: }
1.472 raeburn 6753: }
6754:
6755: ###############################################
6756:
6757: =pod
6758:
6759: =item * &default_quota()
6760:
1.536 raeburn 6761: Retrieves default quota assigned for storage of user portfolio files,
6762: given an (optional) user's institutional status.
1.472 raeburn 6763:
6764: Incoming parameters:
6765: 1. domain
1.536 raeburn 6766: 2. (Optional) institutional status(es). This is a : separated list of
6767: status types (e.g., faculty, staff, student etc.)
6768: which apply to the user for whom the default is being retrieved.
6769: If the institutional status string in undefined, the domain
6770: default quota will be returned.
1.472 raeburn 6771:
6772: Returns:
6773: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6774: 2. (Optional) institutional type which determined the value of the
6775: default quota.
1.472 raeburn 6776:
6777: If a value has been stored in the domain's configuration db,
6778: it will return that, otherwise it returns 20 (for backwards
6779: compatibility with domains which have not set up a configuration
6780: db file; the original statically defined portfolio quota was 20 Mb).
6781:
1.536 raeburn 6782: If the user's status includes multiple types (e.g., staff and student),
6783: the largest default quota which applies to the user determines the
6784: default quota returned.
6785:
1.472 raeburn 6786: =cut
6787:
6788: ###############################################
6789:
6790:
6791: sub default_quota {
1.536 raeburn 6792: my ($udom,$inststatus) = @_;
6793: my ($defquota,$settingstatus);
6794: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6795: ['quotas'],$udom);
6796: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6797: if ($inststatus ne '') {
6798: my @statuses = split(/:/,$inststatus);
6799: foreach my $item (@statuses) {
1.622 raeburn 6800: if ($quotahash{'quotas'}{$item} ne '') {
1.536 raeburn 6801: if ($defquota eq '') {
1.622 raeburn 6802: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6803: $settingstatus = $item;
1.622 raeburn 6804: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6805: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6806: $settingstatus = $item;
6807: }
6808: }
6809: }
6810: }
6811: if ($defquota eq '') {
1.622 raeburn 6812: $defquota = $quotahash{'quotas'}{'default'};
1.536 raeburn 6813: $settingstatus = 'default';
6814: }
6815: } else {
6816: $settingstatus = 'default';
6817: $defquota = 20;
6818: }
6819: if (wantarray) {
6820: return ($defquota,$settingstatus);
1.472 raeburn 6821: } else {
1.536 raeburn 6822: return $defquota;
1.472 raeburn 6823: }
6824: }
6825:
1.384 raeburn 6826: sub get_secgrprole_info {
6827: my ($cdom,$cnum,$needroles,$type) = @_;
6828: my %sections_count = &get_sections($cdom,$cnum);
6829: my @sections = (sort {$a <=> $b} keys(%sections_count));
6830: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6831: my @groups = sort(keys(%curr_groups));
6832: my $allroles = [];
6833: my $rolehash;
6834: my $accesshash = {
6835: active => 'Currently has access',
6836: future => 'Will have future access',
6837: previous => 'Previously had access',
6838: };
6839: if ($needroles) {
6840: $rolehash = {'all' => 'all'};
1.385 albertel 6841: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6842: if (&Apache::lonnet::error(%user_roles)) {
6843: undef(%user_roles);
6844: }
6845: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6846: my ($role)=split(/\:/,$item,2);
6847: if ($role eq 'cr') { next; }
6848: if ($role =~ /^cr/) {
6849: $$rolehash{$role} = (split('/',$role))[3];
6850: } else {
6851: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6852: }
6853: }
6854: foreach my $key (sort(keys(%{$rolehash}))) {
6855: push(@{$allroles},$key);
6856: }
6857: push (@{$allroles},'st');
6858: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6859: }
6860: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6861: }
6862:
1.555 raeburn 6863: sub user_picker {
1.627 raeburn 6864: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6865: my $currdom = $dom;
6866: my %curr_selected = (
6867: srchin => 'dom',
1.580 raeburn 6868: srchby => 'lastname',
1.555 raeburn 6869: );
6870: my $srchterm;
1.625 raeburn 6871: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6872: if ($srch->{'srchby'} ne '') {
6873: $curr_selected{'srchby'} = $srch->{'srchby'};
6874: }
6875: if ($srch->{'srchin'} ne '') {
6876: $curr_selected{'srchin'} = $srch->{'srchin'};
6877: }
6878: if ($srch->{'srchtype'} ne '') {
6879: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6880: }
6881: if ($srch->{'srchdomain'} ne '') {
6882: $currdom = $srch->{'srchdomain'};
6883: }
6884: $srchterm = $srch->{'srchterm'};
6885: }
6886: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6887: 'usr' => 'Search criteria',
1.563 raeburn 6888: 'doma' => 'Domain/institution to search',
1.558 albertel 6889: 'uname' => 'username',
6890: 'lastname' => 'last name',
1.555 raeburn 6891: 'lastfirst' => 'last name, first name',
1.558 albertel 6892: 'crs' => 'in this course',
1.576 raeburn 6893: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6894: 'alc' => 'all LON-CAPA',
1.573 raeburn 6895: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6896: 'exact' => 'is',
6897: 'contains' => 'contains',
1.569 raeburn 6898: 'begins' => 'begins with',
1.571 raeburn 6899: 'youm' => "You must include some text to search for.",
6900: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6901: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6902: 'yomc' => "You must choose a domain when using an institutional directory search.",
6903: 'ymcd' => "You must choose a domain when using a domain search.",
6904: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6905: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6906: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6907: );
1.563 raeburn 6908: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6909: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6910:
6911: my @srchins = ('crs','dom','alc','instd');
6912:
6913: foreach my $option (@srchins) {
6914: # FIXME 'alc' option unavailable until
6915: # loncreateuser::print_user_query_page()
6916: # has been completed.
6917: next if ($option eq 'alc');
6918: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6919: if ($curr_selected{'srchin'} eq $option) {
6920: $srchinsel .= '
6921: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6922: } else {
6923: $srchinsel .= '
6924: <option value="'.$option.'">'.$lt{$option}.'</option>';
6925: }
1.555 raeburn 6926: }
1.563 raeburn 6927: $srchinsel .= "\n </select>\n";
1.555 raeburn 6928:
6929: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6930: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6931: if ($curr_selected{'srchby'} eq $option) {
6932: $srchbysel .= '
6933: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6934: } else {
6935: $srchbysel .= '
6936: <option value="'.$option.'">'.$lt{$option}.'</option>';
6937: }
6938: }
6939: $srchbysel .= "\n </select>\n";
6940:
6941: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6942: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6943: if ($curr_selected{'srchtype'} eq $option) {
6944: $srchtypesel .= '
6945: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6946: } else {
6947: $srchtypesel .= '
6948: <option value="'.$option.'">'.$lt{$option}.'</option>';
6949: }
6950: }
6951: $srchtypesel .= "\n </select>\n";
6952:
1.558 albertel 6953: my ($newuserscript,$new_user_create);
1.556 raeburn 6954:
6955: if ($forcenewuser) {
1.576 raeburn 6956: if (ref($srch) eq 'HASH') {
6957: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6958: if ($cancreate) {
6959: $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>';
6960: } else {
6961: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6962: my %usertypetext = (
6963: official => 'institutional',
6964: unofficial => 'non-institutional',
6965: );
6966: $new_user_create = '<br /><span class="LC_warning">'.&mt("You are not authorized to create new $usertypetext{$usertype} users in this domain.").' '.&mt('Contact the <a[_1]>helpdesk</a> for assistance.',$helplink).'</span><br /><br />';
6967: }
1.576 raeburn 6968: }
6969: }
6970:
1.556 raeburn 6971: $newuserscript = <<"ENDSCRIPT";
6972:
1.570 raeburn 6973: function setSearch(createnew,callingForm) {
1.556 raeburn 6974: if (createnew == 1) {
1.570 raeburn 6975: for (var i=0; i<callingForm.srchby.length; i++) {
6976: if (callingForm.srchby.options[i].value == 'uname') {
6977: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6978: }
6979: }
1.570 raeburn 6980: for (var i=0; i<callingForm.srchin.length; i++) {
6981: if ( callingForm.srchin.options[i].value == 'dom') {
6982: callingForm.srchin.selectedIndex = i;
1.556 raeburn 6983: }
6984: }
1.570 raeburn 6985: for (var i=0; i<callingForm.srchtype.length; i++) {
6986: if (callingForm.srchtype.options[i].value == 'exact') {
6987: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 6988: }
6989: }
1.570 raeburn 6990: for (var i=0; i<callingForm.srchdomain.length; i++) {
6991: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6992: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 6993: }
6994: }
6995: }
6996: }
6997: ENDSCRIPT
1.558 albertel 6998:
1.556 raeburn 6999: }
7000:
1.555 raeburn 7001: my $output = <<"END_BLOCK";
1.556 raeburn 7002: <script type="text/javascript">
1.570 raeburn 7003: function validateEntry(callingForm) {
1.558 albertel 7004:
1.556 raeburn 7005: var checkok = 1;
1.558 albertel 7006: var srchin;
1.570 raeburn 7007: for (var i=0; i<callingForm.srchin.length; i++) {
7008: if ( callingForm.srchin[i].checked ) {
7009: srchin = callingForm.srchin[i].value;
1.558 albertel 7010: }
7011: }
7012:
1.570 raeburn 7013: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7014: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7015: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7016: var srchterm = callingForm.srchterm.value;
7017: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7018: var msg = "";
7019:
7020: if (srchterm == "") {
7021: checkok = 0;
1.571 raeburn 7022: msg += "$lt{'youm'}\\n";
1.556 raeburn 7023: }
7024:
1.569 raeburn 7025: if (srchtype== 'begins') {
7026: if (srchterm.length < 2) {
7027: checkok = 0;
1.571 raeburn 7028: msg += "$lt{'thte'}\\n";
1.569 raeburn 7029: }
7030: }
7031:
1.556 raeburn 7032: if (srchtype== 'contains') {
7033: if (srchterm.length < 3) {
7034: checkok = 0;
1.571 raeburn 7035: msg += "$lt{'thet'}\\n";
1.556 raeburn 7036: }
7037: }
7038: if (srchin == 'instd') {
7039: if (srchdomain == '') {
7040: checkok = 0;
1.571 raeburn 7041: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7042: }
7043: }
7044: if (srchin == 'dom') {
7045: if (srchdomain == '') {
7046: checkok = 0;
1.571 raeburn 7047: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7048: }
7049: }
7050: if (srchby == 'lastfirst') {
7051: if (srchterm.indexOf(",") == -1) {
7052: checkok = 0;
1.571 raeburn 7053: msg += "$lt{'whus'}\\n";
1.556 raeburn 7054: }
7055: if (srchterm.indexOf(",") == srchterm.length -1) {
7056: checkok = 0;
1.571 raeburn 7057: msg += "$lt{'whse'}\\n";
1.556 raeburn 7058: }
7059: }
7060: if (checkok == 0) {
1.571 raeburn 7061: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7062: return;
7063: }
7064: if (checkok == 1) {
1.570 raeburn 7065: callingForm.submit();
1.556 raeburn 7066: }
7067: }
7068:
7069: $newuserscript
7070:
7071: </script>
1.558 albertel 7072:
7073: $new_user_create
7074:
1.555 raeburn 7075: <table>
1.558 albertel 7076: <tr>
1.573 raeburn 7077: <td>$lt{'doma'}:</td>
7078: <td>$domform</td>
7079: </td>
7080: </tr>
7081: <tr>
7082: <td>$lt{'usr'}:</td>
1.563 raeburn 7083: <td>$srchbysel
7084: $srchtypesel
7085: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7086: $srchinsel
1.563 raeburn 7087: </td>
7088: </tr>
1.555 raeburn 7089: </table>
7090: <br />
7091: END_BLOCK
1.558 albertel 7092:
1.555 raeburn 7093: return $output;
7094: }
7095:
1.612 raeburn 7096: sub user_rule_check {
1.615 raeburn 7097: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7098: my $response;
7099: if (ref($usershash) eq 'HASH') {
7100: foreach my $user (keys(%{$usershash})) {
7101: my ($uname,$udom) = split(/:/,$user);
7102: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7103: my ($id,$newuser);
1.612 raeburn 7104: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7105: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7106: $id = $usershash->{$user}->{'id'};
7107: }
7108: my $inst_response;
7109: if (ref($checks) eq 'HASH') {
7110: if (defined($checks->{'username'})) {
1.615 raeburn 7111: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7112: &Apache::lonnet::get_instuser($udom,$uname);
7113: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7114: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7115: &Apache::lonnet::get_instuser($udom,undef,$id);
7116: }
1.615 raeburn 7117: } else {
7118: ($inst_response,%{$inst_results->{$user}}) =
7119: &Apache::lonnet::get_instuser($udom,$uname);
7120: return;
1.612 raeburn 7121: }
1.615 raeburn 7122: if (!$got_rules->{$udom}) {
1.612 raeburn 7123: my %domconfig = &Apache::lonnet::get_dom('configuration',
7124: ['usercreation'],$udom);
7125: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7126: foreach my $item ('username','id') {
1.612 raeburn 7127: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7128: $$curr_rules{$udom}{$item} =
7129: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7130: }
7131: }
7132: }
1.615 raeburn 7133: $got_rules->{$udom} = 1;
1.585 raeburn 7134: }
1.612 raeburn 7135: foreach my $item (keys(%{$checks})) {
7136: if (ref($$curr_rules{$udom}) eq 'HASH') {
7137: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7138: if (@{$$curr_rules{$udom}{$item}} > 0) {
7139: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7140: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7141: if ($rule_check{$rule}) {
7142: $$rulematch{$user}{$item} = $rule;
7143: if ($inst_response eq 'ok') {
1.615 raeburn 7144: if (ref($inst_results) eq 'HASH') {
7145: if (ref($inst_results->{$user}) eq 'HASH') {
7146: if (keys(%{$inst_results->{$user}}) == 0) {
7147: $$alerts{$item}{$udom}{$uname} = 1;
7148: }
1.612 raeburn 7149: }
7150: }
1.615 raeburn 7151: }
7152: last;
1.585 raeburn 7153: }
7154: }
7155: }
7156: }
7157: }
7158: }
7159: }
7160: }
1.612 raeburn 7161: return;
7162: }
7163:
7164: sub user_rule_formats {
7165: my ($domain,$domdesc,$curr_rules,$check) = @_;
7166: my %text = (
7167: 'username' => 'Usernames',
7168: 'id' => 'IDs',
7169: );
7170: my $output;
7171: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7172: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7173: if (@{$ruleorder} > 0) {
7174: $output = '<br />'.&mt("$text{$check} with the following format(s) may <span class=\"LC_cusr_emph\">only</span> be used for verified users at [_1]:",$domdesc).' <ul>';
7175: foreach my $rule (@{$ruleorder}) {
7176: if (ref($curr_rules) eq 'ARRAY') {
7177: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7178: if (ref($rules->{$rule}) eq 'HASH') {
7179: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7180: $rules->{$rule}{'desc'}.'</li>';
7181: }
7182: }
7183: }
7184: }
7185: $output .= '</ul>';
7186: }
7187: }
7188: return $output;
7189: }
7190:
7191: sub instrule_disallow_msg {
1.615 raeburn 7192: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7193: my $response;
7194: my %text = (
7195: item => 'username',
7196: items => 'usernames',
7197: match => 'matches',
7198: do => 'does',
7199: action => 'a username',
7200: one => 'one',
7201: );
7202: if ($count > 1) {
7203: $text{'item'} = 'usernames';
7204: $text{'match'} ='match';
7205: $text{'do'} = 'do';
7206: $text{'action'} = 'usernames',
7207: $text{'one'} = 'ones';
7208: }
7209: if ($checkitem eq 'id') {
7210: $text{'items'} = 'IDs';
7211: $text{'item'} = 'ID';
7212: $text{'action'} = 'an ID';
1.615 raeburn 7213: if ($count > 1) {
7214: $text{'item'} = 'IDs';
7215: $text{'action'} = 'IDs';
7216: }
1.612 raeburn 7217: }
1.674 bisitz 7218: $response = &mt("The $text{'item'} you chose $text{'match'} the format of $text{'items'} defined for [_1], but the $text{'item'} $text{'do'} not exist in the institutional directory.",'<span class="LC_cusr_emph">'.$domdesc.'</span>').'<br />';
1.615 raeburn 7219: if ($mode eq 'upload') {
7220: if ($checkitem eq 'username') {
7221: $response .= &mt("You will need to modify your upload file so it will include $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7222: } elsif ($checkitem eq 'id') {
1.674 bisitz 7223: $response .= &mt("Either upload a file which includes $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or when associating fields with data columns, omit an association for the Student/Employee ID field.");
1.615 raeburn 7224: }
1.669 raeburn 7225: } elsif ($mode eq 'selfcreate') {
7226: if ($checkitem eq 'id') {
7227: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
7228: }
1.615 raeburn 7229: } else {
7230: if ($checkitem eq 'username') {
7231: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7232: } elsif ($checkitem eq 'id') {
7233: $response .= &mt("You must either choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}, or leave the ID field blank.");
7234: }
1.612 raeburn 7235: }
7236: return $response;
1.585 raeburn 7237: }
7238:
1.624 raeburn 7239: sub personal_data_fieldtitles {
7240: my %fieldtitles = &Apache::lonlocal::texthash (
7241: id => 'Student/Employee ID',
7242: permanentemail => 'E-mail address',
7243: lastname => 'Last Name',
7244: firstname => 'First Name',
7245: middlename => 'Middle Name',
7246: generation => 'Generation',
7247: gen => 'Generation',
7248: );
7249: return %fieldtitles;
7250: }
7251:
1.642 raeburn 7252: sub sorted_inst_types {
7253: my ($dom) = @_;
7254: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7255: my $othertitle = &mt('All users');
7256: if ($env{'request.course.id'}) {
1.668 raeburn 7257: $othertitle = &mt('Any users');
1.642 raeburn 7258: }
7259: my @types;
7260: if (ref($order) eq 'ARRAY') {
7261: @types = @{$order};
7262: }
7263: if (@types == 0) {
7264: if (ref($usertypes) eq 'HASH') {
7265: @types = sort(keys(%{$usertypes}));
7266: }
7267: }
7268: if (keys(%{$usertypes}) > 0) {
7269: $othertitle = &mt('Other users');
7270: }
7271: return ($othertitle,$usertypes,\@types);
7272: }
7273:
1.645 raeburn 7274: sub get_institutional_codes {
7275: my ($settings,$allcourses,$LC_code) = @_;
7276: # Get complete list of course sections to update
7277: my @currsections = ();
7278: my @currxlists = ();
7279: my $coursecode = $$settings{'internal.coursecode'};
7280:
7281: if ($$settings{'internal.sectionnums'} ne '') {
7282: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7283: }
7284:
7285: if ($$settings{'internal.crosslistings'} ne '') {
7286: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7287: }
7288:
7289: if (@currxlists > 0) {
7290: foreach (@currxlists) {
7291: if (m/^([^:]+):(\w*)$/) {
7292: unless (grep/^$1$/,@{$allcourses}) {
7293: push @{$allcourses},$1;
7294: $$LC_code{$1} = $2;
7295: }
7296: }
7297: }
7298: }
7299:
7300: if (@currsections > 0) {
7301: foreach (@currsections) {
7302: if (m/^(\w+):(\w*)$/) {
7303: my $sec = $coursecode.$1;
7304: my $lc_sec = $2;
7305: unless (grep/^$sec$/,@{$allcourses}) {
7306: push @{$allcourses},$sec;
7307: $$LC_code{$sec} = $lc_sec;
7308: }
7309: }
7310: }
7311: }
7312: return;
7313: }
7314:
1.112 bowersj2 7315: =pod
7316:
1.549 albertel 7317: =back
7318:
7319: =head1 HTTP Helpers
7320:
7321: =over 4
7322:
1.648 raeburn 7323: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7324:
1.258 albertel 7325: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7326: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7327: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7328:
7329: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7330: $possible_names is an ref to an array of form element names. As an example:
7331: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7332: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7333:
7334: =cut
1.1 albertel 7335:
1.6 albertel 7336: sub get_unprocessed_cgi {
1.25 albertel 7337: my ($query,$possible_names)= @_;
1.26 matthew 7338: # $Apache::lonxml::debug=1;
1.356 albertel 7339: foreach my $pair (split(/&/,$query)) {
7340: my ($name, $value) = split(/=/,$pair);
1.369 www 7341: $name = &unescape($name);
1.25 albertel 7342: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7343: $value =~ tr/+/ /;
7344: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7345: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7346: }
1.16 harris41 7347: }
1.6 albertel 7348: }
7349:
1.112 bowersj2 7350: =pod
7351:
1.648 raeburn 7352: =item * &cacheheader()
1.112 bowersj2 7353:
7354: returns cache-controlling header code
7355:
7356: =cut
7357:
1.7 albertel 7358: sub cacheheader {
1.258 albertel 7359: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7360: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7361: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7362: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7363: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7364: return $output;
1.7 albertel 7365: }
7366:
1.112 bowersj2 7367: =pod
7368:
1.648 raeburn 7369: =item * &no_cache($r)
1.112 bowersj2 7370:
7371: specifies header code to not have cache
7372:
7373: =cut
7374:
1.9 albertel 7375: sub no_cache {
1.216 albertel 7376: my ($r) = @_;
7377: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7378: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7379: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7380: $r->no_cache(1);
7381: $r->header_out("Expires" => $date);
7382: $r->header_out("Pragma" => "no-cache");
1.123 www 7383: }
7384:
7385: sub content_type {
1.181 albertel 7386: my ($r,$type,$charset) = @_;
1.299 foxr 7387: if ($r) {
7388: # Note that printout.pl calls this with undef for $r.
7389: &no_cache($r);
7390: }
1.258 albertel 7391: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7392: unless ($charset) {
7393: $charset=&Apache::lonlocal::current_encoding;
7394: }
7395: if ($charset) { $type.='; charset='.$charset; }
7396: if ($r) {
7397: $r->content_type($type);
7398: } else {
7399: print("Content-type: $type\n\n");
7400: }
1.9 albertel 7401: }
1.25 albertel 7402:
1.112 bowersj2 7403: =pod
7404:
1.648 raeburn 7405: =item * &add_to_env($name,$value)
1.112 bowersj2 7406:
1.258 albertel 7407: adds $name to the %env hash with value
1.112 bowersj2 7408: $value, if $name already exists, the entry is converted to an array
7409: reference and $value is added to the array.
7410:
7411: =cut
7412:
1.25 albertel 7413: sub add_to_env {
7414: my ($name,$value)=@_;
1.258 albertel 7415: if (defined($env{$name})) {
7416: if (ref($env{$name})) {
1.25 albertel 7417: #already have multiple values
1.258 albertel 7418: push(@{ $env{$name} },$value);
1.25 albertel 7419: } else {
7420: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7421: my $first=$env{$name};
7422: undef($env{$name});
7423: push(@{ $env{$name} },$first,$value);
1.25 albertel 7424: }
7425: } else {
1.258 albertel 7426: $env{$name}=$value;
1.25 albertel 7427: }
1.31 albertel 7428: }
1.149 albertel 7429:
7430: =pod
7431:
1.648 raeburn 7432: =item * &get_env_multiple($name)
1.149 albertel 7433:
1.258 albertel 7434: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7435: values may be defined and end up as an array ref.
7436:
7437: returns an array of values
7438:
7439: =cut
7440:
7441: sub get_env_multiple {
7442: my ($name) = @_;
7443: my @values;
1.258 albertel 7444: if (defined($env{$name})) {
1.149 albertel 7445: # exists is it an array
1.258 albertel 7446: if (ref($env{$name})) {
7447: @values=@{ $env{$name} };
1.149 albertel 7448: } else {
1.258 albertel 7449: $values[0]=$env{$name};
1.149 albertel 7450: }
7451: }
7452: return(@values);
7453: }
7454:
1.660 raeburn 7455: sub ask_for_embedded_content {
7456: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7457: my $upload_output = '
7458: <form name="upload_embedded" action="'.$actionurl.'"
7459: method="post" enctype="multipart/form-data">';
7460: $upload_output .= $state;
1.661 raeburn 7461: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7462:
7463: my $num = 0;
7464: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7465: $upload_output .= &start_data_table_row().
7466: '<td>'.$embed_file.'</td><td>';
7467: if ($args->{'ignore_remote_references'}
7468: && $embed_file =~ m{^\w+://}) {
7469: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7470: } elsif ($args->{'error_on_invalid_names'}
7471: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7472:
7473: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7474:
7475: } else {
7476: $upload_output .='
1.661 raeburn 7477: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7478: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7479: my $attrib = join(':',@{$$allfiles{$embed_file}});
7480: $upload_output .=
7481: "\n\t\t".
7482: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7483: $attrib.'" />';
7484: if (exists($$codebase{$embed_file})) {
7485: $upload_output .=
7486: "\n\t\t".
7487: '<input name="codebase_'.$num.'" type="hidden" value="'.
7488: &escape($$codebase{$embed_file}).'" />';
7489: }
7490: }
7491: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7492: $num++;
7493: }
7494: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7495: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7496: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7497: '.&mt('(only files for which a location has been provided will be uploaded)').'
7498: </form>';
7499: return $upload_output;
7500: }
7501:
1.661 raeburn 7502: sub upload_embedded {
7503: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7504: $current_disk_usage) = @_;
7505: my $output;
7506: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7507: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7508: my $orig_uploaded_filename =
7509: $env{'form.embedded_item_'.$i.'.filename'};
7510:
7511: $env{'form.embedded_orig_'.$i} =
7512: &unescape($env{'form.embedded_orig_'.$i});
7513: my ($path,$fname) =
7514: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7515: # no path, whole string is fname
7516: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7517:
7518: $path = $env{'form.currentpath'}.$path;
7519: $fname = &Apache::lonnet::clean_filename($fname);
7520: # See if there is anything left
7521: next if ($fname eq '');
7522:
7523: # Check if file already exists as a file or directory.
7524: my ($state,$msg);
7525: if ($context eq 'portfolio') {
7526: my $port_path = $dirpath;
7527: if ($group ne '') {
7528: $port_path = "groups/$group/$port_path";
7529: }
7530: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7531: $dir_root,$port_path,$disk_quota,
7532: $current_disk_usage,$uname,$udom);
7533: if ($state eq 'will_exceed_quota'
7534: || $state eq 'file_locked'
7535: || $state eq 'file_exists' ) {
7536: $output .= $msg;
7537: next;
7538: }
7539: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7540: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7541: if ($state eq 'exists') {
7542: $output .= $msg;
7543: next;
7544: }
7545: }
7546: # Check if extension is valid
7547: if (($fname =~ /\.(\w+)$/) &&
7548: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7549: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7550: next;
7551: } elsif (($fname =~ /\.(\w+)$/) &&
7552: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7553: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7554: next;
7555: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7556: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7557: next;
7558: }
7559:
7560: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7561: if ($context eq 'portfolio') {
7562: my $result=
7563: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7564: $dirpath.$path);
7565: if ($result !~ m|^/uploaded/|) {
7566: $output .= '<span class="LC_error">'
7567: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7568: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7569: .'</span><br />';
7570: next;
7571: } else {
7572: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7573: $path.$fname.'</span>').'</p>';
7574: }
7575: } else {
7576: # Save the file
7577: my $target = $env{'form.embedded_item_'.$i};
7578: my $fullpath = $dir_root.$dirpath.'/'.$path;
7579: my $dest = $fullpath.$fname;
7580: my $url = $url_root.$dirpath.'/'.$path.$fname;
7581: my @parts=split(/\//,$fullpath);
7582: my $count;
7583: my $filepath = $dir_root;
7584: for ($count=4;$count<=$#parts;$count++) {
7585: $filepath .= "/$parts[$count]";
7586: if ((-e $filepath)!=1) {
7587: mkdir($filepath,0770);
7588: }
7589: }
7590: my $fh;
7591: if (!open($fh,'>'.$dest)) {
7592: &Apache::lonnet::logthis('Failed to create '.$dest);
7593: $output .= '<span class="LC_error">'.
7594: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7595: '</span><br />';
7596: } else {
7597: if (!print $fh $env{'form.embedded_item_'.$i}) {
7598: &Apache::lonnet::logthis('Failed to write to '.$dest);
7599: $output .= '<span class="LC_error">'.
7600: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7601: '</span><br />';
7602: } else {
7603: if ($context eq 'testbank') {
7604: $output .= &mt('Embedded file uploaded successfully:').
7605: ' <a href="'.$url.'">'.
7606: $orig_uploaded_filename.'</a><br />';
7607: } else {
1.705 tempelho 7608: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7609: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7610: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7611: }
7612: }
7613: close($fh);
7614: }
7615: }
7616: }
7617: return $output;
7618: }
7619:
7620: sub check_for_existing {
7621: my ($path,$fname,$element) = @_;
7622: my ($state,$msg);
7623: if (-d $path.'/'.$fname) {
7624: $state = 'exists';
7625: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7626: } elsif (-e $path.'/'.$fname) {
7627: $state = 'exists';
7628: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7629: }
7630: if ($state eq 'exists') {
7631: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7632: }
7633: return ($state,$msg);
7634: }
7635:
7636: sub check_for_upload {
7637: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7638: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7639: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7640: my $getpropath = 1;
7641: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7642: $getpropath);
7643: my $found_file = 0;
7644: my $locked_file = 0;
7645: foreach my $line (@dir_list) {
7646: my ($file_name)=split(/\&/,$line,2);
7647: if ($file_name eq $fname){
7648: $file_name = $path.$file_name;
7649: if ($group ne '') {
7650: $file_name = $group.$file_name;
7651: }
7652: $found_file = 1;
7653: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7654: $locked_file = 1;
7655: }
7656: }
7657: }
7658: if (($current_disk_usage + $filesize) > $disk_quota){
7659: my $msg = '<span class="LC_error">'.
7660: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7661: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7662: return ('will_exceed_quota',$msg);
7663: } elsif ($found_file) {
7664: if ($locked_file) {
7665: my $msg = '<span class="LC_error">';
7666: $msg .= &mt('Unable to upload [_1]. A locked file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>','<span class="LC_filename">'.$port_path.$env{'form.currentpath'}.'</span>');
7667: $msg .= '</span><br />';
7668: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7669: return ('file_locked',$msg);
7670: } else {
7671: my $msg = '<span class="LC_error">';
7672: $msg .= &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$port_path.$env{'form.currentpath'});
7673: $msg .= '</span>';
7674: $msg .= '<br />';
7675: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7676: return ('file_exists',$msg);
7677: }
7678: }
7679: }
7680:
1.31 albertel 7681:
1.41 ng 7682: =pod
1.45 matthew 7683:
1.464 albertel 7684: =back
1.41 ng 7685:
1.112 bowersj2 7686: =head1 CSV Upload/Handling functions
1.38 albertel 7687:
1.41 ng 7688: =over 4
7689:
1.648 raeburn 7690: =item * &upfile_store($r)
1.41 ng 7691:
7692: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7693: needs $env{'form.upfile'}
1.41 ng 7694: returns $datatoken to be put into hidden field
7695:
7696: =cut
1.31 albertel 7697:
7698: sub upfile_store {
7699: my $r=shift;
1.258 albertel 7700: $env{'form.upfile'}=~s/\r/\n/gs;
7701: $env{'form.upfile'}=~s/\f/\n/gs;
7702: $env{'form.upfile'}=~s/\n+/\n/gs;
7703: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7704:
1.258 albertel 7705: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7706: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7707: {
1.158 raeburn 7708: my $datafile = $r->dir_config('lonDaemons').
7709: '/tmp/'.$datatoken.'.tmp';
7710: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7711: print $fh $env{'form.upfile'};
1.158 raeburn 7712: close($fh);
7713: }
1.31 albertel 7714: }
7715: return $datatoken;
7716: }
7717:
1.56 matthew 7718: =pod
7719:
1.648 raeburn 7720: =item * &load_tmp_file($r)
1.41 ng 7721:
7722: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7723: needs $env{'form.datatoken'},
7724: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7725:
7726: =cut
1.31 albertel 7727:
7728: sub load_tmp_file {
7729: my $r=shift;
7730: my @studentdata=();
7731: {
1.158 raeburn 7732: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7733: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7734: if ( open(my $fh,"<$studentfile") ) {
7735: @studentdata=<$fh>;
7736: close($fh);
7737: }
1.31 albertel 7738: }
1.258 albertel 7739: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7740: }
7741:
1.56 matthew 7742: =pod
7743:
1.648 raeburn 7744: =item * &upfile_record_sep()
1.41 ng 7745:
7746: Separate uploaded file into records
7747: returns array of records,
1.258 albertel 7748: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7749:
7750: =cut
1.31 albertel 7751:
7752: sub upfile_record_sep {
1.258 albertel 7753: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7754: } else {
1.248 albertel 7755: my @records;
1.258 albertel 7756: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7757: if ($line=~/^\s*$/) { next; }
7758: push(@records,$line);
7759: }
7760: return @records;
1.31 albertel 7761: }
7762: }
7763:
1.56 matthew 7764: =pod
7765:
1.648 raeburn 7766: =item * &record_sep($record)
1.41 ng 7767:
1.258 albertel 7768: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7769:
7770: =cut
7771:
1.263 www 7772: sub takeleft {
7773: my $index=shift;
7774: return substr('0000'.$index,-4,4);
7775: }
7776:
1.31 albertel 7777: sub record_sep {
7778: my $record=shift;
7779: my %components=();
1.258 albertel 7780: if ($env{'form.upfiletype'} eq 'xml') {
7781: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7782: my $i=0;
1.356 albertel 7783: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7784: $field=~s/^(\"|\')//;
7785: $field=~s/(\"|\')$//;
1.263 www 7786: $components{&takeleft($i)}=$field;
1.31 albertel 7787: $i++;
7788: }
1.258 albertel 7789: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7790: my $i=0;
1.356 albertel 7791: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7792: $field=~s/^(\"|\')//;
7793: $field=~s/(\"|\')$//;
1.263 www 7794: $components{&takeleft($i)}=$field;
1.31 albertel 7795: $i++;
7796: }
7797: } else {
1.561 www 7798: my $separator=',';
1.480 banghart 7799: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7800: $separator=';';
1.480 banghart 7801: }
1.31 albertel 7802: my $i=0;
1.561 www 7803: # the character we are looking for to indicate the end of a quote or a record
7804: my $looking_for=$separator;
7805: # do not add the characters to the fields
7806: my $ignore=0;
7807: # we just encountered a separator (or the beginning of the record)
7808: my $just_found_separator=1;
7809: # store the field we are working on here
7810: my $field='';
7811: # work our way through all characters in record
7812: foreach my $character ($record=~/(.)/g) {
7813: if ($character eq $looking_for) {
7814: if ($character ne $separator) {
7815: # Found the end of a quote, again looking for separator
7816: $looking_for=$separator;
7817: $ignore=1;
7818: } else {
7819: # Found a separator, store away what we got
7820: $components{&takeleft($i)}=$field;
7821: $i++;
7822: $just_found_separator=1;
7823: $ignore=0;
7824: $field='';
7825: }
7826: next;
7827: }
7828: # single or double quotation marks after a separator indicate beginning of a quote
7829: # we are now looking for the end of the quote and need to ignore separators
7830: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7831: $looking_for=$character;
7832: next;
7833: }
7834: # ignore would be true after we reached the end of a quote
7835: if ($ignore) { next; }
7836: if (($just_found_separator) && ($character=~/\s/)) { next; }
7837: $field.=$character;
7838: $just_found_separator=0;
1.31 albertel 7839: }
1.561 www 7840: # catch the very last entry, since we never encountered the separator
7841: $components{&takeleft($i)}=$field;
1.31 albertel 7842: }
7843: return %components;
7844: }
7845:
1.144 matthew 7846: ######################################################
7847: ######################################################
7848:
1.56 matthew 7849: =pod
7850:
1.648 raeburn 7851: =item * &upfile_select_html()
1.41 ng 7852:
1.144 matthew 7853: Return HTML code to select a file from the users machine and specify
7854: the file type.
1.41 ng 7855:
7856: =cut
7857:
1.144 matthew 7858: ######################################################
7859: ######################################################
1.31 albertel 7860: sub upfile_select_html {
1.144 matthew 7861: my %Types = (
7862: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7863: semisv => &mt('Semicolon separated values'),
1.144 matthew 7864: space => &mt('Space separated'),
7865: tab => &mt('Tabulator separated'),
7866: # xml => &mt('HTML/XML'),
7867: );
7868: my $Str = '<input type="file" name="upfile" size="50" />'.
7869: '<br />Type: <select name="upfiletype">';
7870: foreach my $type (sort(keys(%Types))) {
7871: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7872: }
7873: $Str .= "</select>\n";
7874: return $Str;
1.31 albertel 7875: }
7876:
1.301 albertel 7877: sub get_samples {
7878: my ($records,$toget) = @_;
7879: my @samples=({});
7880: my $got=0;
7881: foreach my $rec (@$records) {
7882: my %temp = &record_sep($rec);
7883: if (! grep(/\S/, values(%temp))) { next; }
7884: if (%temp) {
7885: $samples[$got]=\%temp;
7886: $got++;
7887: if ($got == $toget) { last; }
7888: }
7889: }
7890: return \@samples;
7891: }
7892:
1.144 matthew 7893: ######################################################
7894: ######################################################
7895:
1.56 matthew 7896: =pod
7897:
1.648 raeburn 7898: =item * &csv_print_samples($r,$records)
1.41 ng 7899:
7900: Prints a table of sample values from each column uploaded $r is an
7901: Apache Request ref, $records is an arrayref from
7902: &Apache::loncommon::upfile_record_sep
7903:
7904: =cut
7905:
1.144 matthew 7906: ######################################################
7907: ######################################################
1.31 albertel 7908: sub csv_print_samples {
7909: my ($r,$records) = @_;
1.662 bisitz 7910: my $samples = &get_samples($records,5);
1.301 albertel 7911:
1.594 raeburn 7912: $r->print(&mt('Samples').'<br />'.&start_data_table().
7913: &start_data_table_header_row());
1.356 albertel 7914: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7915: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7916: $r->print(&end_data_table_header_row());
1.301 albertel 7917: foreach my $hash (@$samples) {
1.594 raeburn 7918: $r->print(&start_data_table_row());
1.356 albertel 7919: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7920: $r->print('<td>');
1.356 albertel 7921: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7922: $r->print('</td>');
7923: }
1.594 raeburn 7924: $r->print(&end_data_table_row());
1.31 albertel 7925: }
1.594 raeburn 7926: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7927: }
7928:
1.144 matthew 7929: ######################################################
7930: ######################################################
7931:
1.56 matthew 7932: =pod
7933:
1.648 raeburn 7934: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 7935:
7936: Prints a table to create associations between values and table columns.
1.144 matthew 7937:
1.41 ng 7938: $r is an Apache Request ref,
7939: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7940: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7941:
7942: =cut
7943:
1.144 matthew 7944: ######################################################
7945: ######################################################
1.31 albertel 7946: sub csv_print_select_table {
7947: my ($r,$records,$d) = @_;
1.301 albertel 7948: my $i=0;
7949: my $samples = &get_samples($records,1);
1.144 matthew 7950: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7951: &start_data_table().&start_data_table_header_row().
1.144 matthew 7952: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7953: '<th>'.&mt('Column').'</th>'.
7954: &end_data_table_header_row()."\n");
1.356 albertel 7955: foreach my $array_ref (@$d) {
7956: my ($value,$display,$defaultcol)=@{ $array_ref };
1.705 tempelho 7957: $r->print(&start_data_table_row().'<tr><td>'.$display.'</td>');
1.31 albertel 7958:
7959: $r->print('<td><select name=f'.$i.
1.32 matthew 7960: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7961: $r->print('<option value="none"></option>');
1.356 albertel 7962: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7963: $r->print('<option value="'.$sample.'"'.
7964: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 7965: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 7966: }
1.594 raeburn 7967: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7968: $i++;
7969: }
1.594 raeburn 7970: $r->print(&end_data_table());
1.31 albertel 7971: $i--;
7972: return $i;
7973: }
1.56 matthew 7974:
1.144 matthew 7975: ######################################################
7976: ######################################################
7977:
1.56 matthew 7978: =pod
1.31 albertel 7979:
1.648 raeburn 7980: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 7981:
7982: Prints a table of sample values from the upload and can make associate samples to internal names.
7983:
7984: $r is an Apache Request ref,
7985: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7986: $d is an array of 2 element arrays (internal name, displayed name)
7987:
7988: =cut
7989:
1.144 matthew 7990: ######################################################
7991: ######################################################
1.31 albertel 7992: sub csv_samples_select_table {
7993: my ($r,$records,$d) = @_;
7994: my $i=0;
1.144 matthew 7995: #
1.662 bisitz 7996: my $max_samples = 5;
7997: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 7998: $r->print(&start_data_table().
7999: &start_data_table_header_row().'<th>'.
8000: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8001: &end_data_table_header_row());
1.301 albertel 8002:
8003: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8004: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8005: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8006: foreach my $option (@$d) {
8007: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8008: $r->print('<option value="'.$value.'"'.
1.253 albertel 8009: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8010: $display.'</option>');
1.31 albertel 8011: }
8012: $r->print('</select></td><td>');
1.662 bisitz 8013: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8014: if (defined($samples->[$line]{$key})) {
8015: $r->print($samples->[$line]{$key}."<br />\n");
8016: }
8017: }
1.594 raeburn 8018: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8019: $i++;
8020: }
1.594 raeburn 8021: $r->print(&end_data_table());
1.31 albertel 8022: $i--;
8023: return($i);
1.115 matthew 8024: }
8025:
1.144 matthew 8026: ######################################################
8027: ######################################################
8028:
1.115 matthew 8029: =pod
8030:
1.648 raeburn 8031: =item * &clean_excel_name($name)
1.115 matthew 8032:
8033: Returns a replacement for $name which does not contain any illegal characters.
8034:
8035: =cut
8036:
1.144 matthew 8037: ######################################################
8038: ######################################################
1.115 matthew 8039: sub clean_excel_name {
8040: my ($name) = @_;
8041: $name =~ s/[:\*\?\/\\]//g;
8042: if (length($name) > 31) {
8043: $name = substr($name,0,31);
8044: }
8045: return $name;
1.25 albertel 8046: }
1.84 albertel 8047:
1.85 albertel 8048: =pod
8049:
1.648 raeburn 8050: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8051:
8052: Returns either 1 or undef
8053:
8054: 1 if the part is to be hidden, undef if it is to be shown
8055:
8056: Arguments are:
8057:
8058: $id the id of the part to be checked
8059: $symb, optional the symb of the resource to check
8060: $udom, optional the domain of the user to check for
8061: $uname, optional the username of the user to check for
8062:
8063: =cut
1.84 albertel 8064:
8065: sub check_if_partid_hidden {
8066: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8067: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8068: $symb,$udom,$uname);
1.141 albertel 8069: my $truth=1;
8070: #if the string starts with !, then the list is the list to show not hide
8071: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8072: my @hiddenlist=split(/,/,$hiddenparts);
8073: foreach my $checkid (@hiddenlist) {
1.141 albertel 8074: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8075: }
1.141 albertel 8076: return !$truth;
1.84 albertel 8077: }
1.127 matthew 8078:
1.138 matthew 8079:
8080: ############################################################
8081: ############################################################
8082:
8083: =pod
8084:
1.157 matthew 8085: =back
8086:
1.138 matthew 8087: =head1 cgi-bin script and graphing routines
8088:
1.157 matthew 8089: =over 4
8090:
1.648 raeburn 8091: =item * &get_cgi_id()
1.138 matthew 8092:
8093: Inputs: none
8094:
8095: Returns an id which can be used to pass environment variables
8096: to various cgi-bin scripts. These environment variables will
8097: be removed from the users environment after a given time by
8098: the routine &Apache::lonnet::transfer_profile_to_env.
8099:
8100: =cut
8101:
8102: ############################################################
8103: ############################################################
1.152 albertel 8104: my $uniq=0;
1.136 matthew 8105: sub get_cgi_id {
1.154 albertel 8106: $uniq=($uniq+1)%100000;
1.280 albertel 8107: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8108: }
8109:
1.127 matthew 8110: ############################################################
8111: ############################################################
8112:
8113: =pod
8114:
1.648 raeburn 8115: =item * &DrawBarGraph()
1.127 matthew 8116:
1.138 matthew 8117: Facilitates the plotting of data in a (stacked) bar graph.
8118: Puts plot definition data into the users environment in order for
8119: graph.png to plot it. Returns an <img> tag for the plot.
8120: The bars on the plot are labeled '1','2',...,'n'.
8121:
8122: Inputs:
8123:
8124: =over 4
8125:
8126: =item $Title: string, the title of the plot
8127:
8128: =item $xlabel: string, text describing the X-axis of the plot
8129:
8130: =item $ylabel: string, text describing the Y-axis of the plot
8131:
8132: =item $Max: scalar, the maximum Y value to use in the plot
8133: If $Max is < any data point, the graph will not be rendered.
8134:
1.140 matthew 8135: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8136: they are plotted. If undefined, default values will be used.
8137:
1.178 matthew 8138: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8139:
1.138 matthew 8140: =item @Values: An array of array references. Each array reference holds data
8141: to be plotted in a stacked bar chart.
8142:
1.239 matthew 8143: =item If the final element of @Values is a hash reference the key/value
8144: pairs will be added to the graph definition.
8145:
1.138 matthew 8146: =back
8147:
8148: Returns:
8149:
8150: An <img> tag which references graph.png and the appropriate identifying
8151: information for the plot.
8152:
1.127 matthew 8153: =cut
8154:
8155: ############################################################
8156: ############################################################
1.134 matthew 8157: sub DrawBarGraph {
1.178 matthew 8158: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8159: #
8160: if (! defined($colors)) {
8161: $colors = ['#33ff00',
8162: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8163: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8164: ];
8165: }
1.228 matthew 8166: my $extra_settings = {};
8167: if (ref($Values[-1]) eq 'HASH') {
8168: $extra_settings = pop(@Values);
8169: }
1.127 matthew 8170: #
1.136 matthew 8171: my $identifier = &get_cgi_id();
8172: my $id = 'cgi.'.$identifier;
1.129 matthew 8173: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8174: return '';
8175: }
1.225 matthew 8176: #
8177: my @Labels;
8178: if (defined($labels)) {
8179: @Labels = @$labels;
8180: } else {
8181: for (my $i=0;$i<@{$Values[0]};$i++) {
8182: push (@Labels,$i+1);
8183: }
8184: }
8185: #
1.129 matthew 8186: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8187: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8188: my %ValuesHash;
8189: my $NumSets=1;
8190: foreach my $array (@Values) {
8191: next if (! ref($array));
1.136 matthew 8192: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8193: join(',',@$array);
1.129 matthew 8194: }
1.127 matthew 8195: #
1.136 matthew 8196: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8197: if ($NumBars < 3) {
8198: $width = 120+$NumBars*32;
1.220 matthew 8199: $xskip = 1;
1.225 matthew 8200: $bar_width = 30;
8201: } elsif ($NumBars < 5) {
8202: $width = 120+$NumBars*20;
8203: $xskip = 1;
8204: $bar_width = 20;
1.220 matthew 8205: } elsif ($NumBars < 10) {
1.136 matthew 8206: $width = 120+$NumBars*15;
8207: $xskip = 1;
8208: $bar_width = 15;
8209: } elsif ($NumBars <= 25) {
8210: $width = 120+$NumBars*11;
8211: $xskip = 5;
8212: $bar_width = 8;
8213: } elsif ($NumBars <= 50) {
8214: $width = 120+$NumBars*8;
8215: $xskip = 5;
8216: $bar_width = 4;
8217: } else {
8218: $width = 120+$NumBars*8;
8219: $xskip = 5;
8220: $bar_width = 4;
8221: }
8222: #
1.137 matthew 8223: $Max = 1 if ($Max < 1);
8224: if ( int($Max) < $Max ) {
8225: $Max++;
8226: $Max = int($Max);
8227: }
1.127 matthew 8228: $Title = '' if (! defined($Title));
8229: $xlabel = '' if (! defined($xlabel));
8230: $ylabel = '' if (! defined($ylabel));
1.369 www 8231: $ValuesHash{$id.'.title'} = &escape($Title);
8232: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8233: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8234: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8235: $ValuesHash{$id.'.NumBars'} = $NumBars;
8236: $ValuesHash{$id.'.NumSets'} = $NumSets;
8237: $ValuesHash{$id.'.PlotType'} = 'bar';
8238: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8239: $ValuesHash{$id.'.height'} = $height;
8240: $ValuesHash{$id.'.width'} = $width;
8241: $ValuesHash{$id.'.xskip'} = $xskip;
8242: $ValuesHash{$id.'.bar_width'} = $bar_width;
8243: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8244: #
1.228 matthew 8245: # Deal with other parameters
8246: while (my ($key,$value) = each(%$extra_settings)) {
8247: $ValuesHash{$id.'.'.$key} = $value;
8248: }
8249: #
1.646 raeburn 8250: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8251: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8252: }
8253:
8254: ############################################################
8255: ############################################################
8256:
8257: =pod
8258:
1.648 raeburn 8259: =item * &DrawXYGraph()
1.137 matthew 8260:
1.138 matthew 8261: Facilitates the plotting of data in an XY graph.
8262: Puts plot definition data into the users environment in order for
8263: graph.png to plot it. Returns an <img> tag for the plot.
8264:
8265: Inputs:
8266:
8267: =over 4
8268:
8269: =item $Title: string, the title of the plot
8270:
8271: =item $xlabel: string, text describing the X-axis of the plot
8272:
8273: =item $ylabel: string, text describing the Y-axis of the plot
8274:
8275: =item $Max: scalar, the maximum Y value to use in the plot
8276: If $Max is < any data point, the graph will not be rendered.
8277:
8278: =item $colors: Array ref containing the hex color codes for the data to be
8279: plotted in. If undefined, default values will be used.
8280:
8281: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8282:
8283: =item $Ydata: Array ref containing Array refs.
1.185 www 8284: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8285:
8286: =item %Values: hash indicating or overriding any default values which are
8287: passed to graph.png.
8288: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8289:
8290: =back
8291:
8292: Returns:
8293:
8294: An <img> tag which references graph.png and the appropriate identifying
8295: information for the plot.
8296:
1.137 matthew 8297: =cut
8298:
8299: ############################################################
8300: ############################################################
8301: sub DrawXYGraph {
8302: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8303: #
8304: # Create the identifier for the graph
8305: my $identifier = &get_cgi_id();
8306: my $id = 'cgi.'.$identifier;
8307: #
8308: $Title = '' if (! defined($Title));
8309: $xlabel = '' if (! defined($xlabel));
8310: $ylabel = '' if (! defined($ylabel));
8311: my %ValuesHash =
8312: (
1.369 www 8313: $id.'.title' => &escape($Title),
8314: $id.'.xlabel' => &escape($xlabel),
8315: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8316: $id.'.y_max_value'=> $Max,
8317: $id.'.labels' => join(',',@$Xlabels),
8318: $id.'.PlotType' => 'XY',
8319: );
8320: #
8321: if (defined($colors) && ref($colors) eq 'ARRAY') {
8322: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8323: }
8324: #
8325: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8326: return '';
8327: }
8328: my $NumSets=1;
1.138 matthew 8329: foreach my $array (@{$Ydata}){
1.137 matthew 8330: next if (! ref($array));
8331: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8332: }
1.138 matthew 8333: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8334: #
8335: # Deal with other parameters
8336: while (my ($key,$value) = each(%Values)) {
8337: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8338: }
8339: #
1.646 raeburn 8340: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8341: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8342: }
8343:
8344: ############################################################
8345: ############################################################
8346:
8347: =pod
8348:
1.648 raeburn 8349: =item * &DrawXYYGraph()
1.138 matthew 8350:
8351: Facilitates the plotting of data in an XY graph with two Y axes.
8352: Puts plot definition data into the users environment in order for
8353: graph.png to plot it. Returns an <img> tag for the plot.
8354:
8355: Inputs:
8356:
8357: =over 4
8358:
8359: =item $Title: string, the title of the plot
8360:
8361: =item $xlabel: string, text describing the X-axis of the plot
8362:
8363: =item $ylabel: string, text describing the Y-axis of the plot
8364:
8365: =item $colors: Array ref containing the hex color codes for the data to be
8366: plotted in. If undefined, default values will be used.
8367:
8368: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8369:
8370: =item $Ydata1: The first data set
8371:
8372: =item $Min1: The minimum value of the left Y-axis
8373:
8374: =item $Max1: The maximum value of the left Y-axis
8375:
8376: =item $Ydata2: The second data set
8377:
8378: =item $Min2: The minimum value of the right Y-axis
8379:
8380: =item $Max2: The maximum value of the left Y-axis
8381:
8382: =item %Values: hash indicating or overriding any default values which are
8383: passed to graph.png.
8384: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8385:
8386: =back
8387:
8388: Returns:
8389:
8390: An <img> tag which references graph.png and the appropriate identifying
8391: information for the plot.
1.136 matthew 8392:
8393: =cut
8394:
8395: ############################################################
8396: ############################################################
1.137 matthew 8397: sub DrawXYYGraph {
8398: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8399: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8400: #
8401: # Create the identifier for the graph
8402: my $identifier = &get_cgi_id();
8403: my $id = 'cgi.'.$identifier;
8404: #
8405: $Title = '' if (! defined($Title));
8406: $xlabel = '' if (! defined($xlabel));
8407: $ylabel = '' if (! defined($ylabel));
8408: my %ValuesHash =
8409: (
1.369 www 8410: $id.'.title' => &escape($Title),
8411: $id.'.xlabel' => &escape($xlabel),
8412: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8413: $id.'.labels' => join(',',@$Xlabels),
8414: $id.'.PlotType' => 'XY',
8415: $id.'.NumSets' => 2,
1.137 matthew 8416: $id.'.two_axes' => 1,
8417: $id.'.y1_max_value' => $Max1,
8418: $id.'.y1_min_value' => $Min1,
8419: $id.'.y2_max_value' => $Max2,
8420: $id.'.y2_min_value' => $Min2,
1.136 matthew 8421: );
8422: #
1.137 matthew 8423: if (defined($colors) && ref($colors) eq 'ARRAY') {
8424: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8425: }
8426: #
8427: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8428: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8429: return '';
8430: }
8431: my $NumSets=1;
1.137 matthew 8432: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8433: next if (! ref($array));
8434: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8435: }
8436: #
8437: # Deal with other parameters
8438: while (my ($key,$value) = each(%Values)) {
8439: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8440: }
8441: #
1.646 raeburn 8442: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8443: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8444: }
8445:
8446: ############################################################
8447: ############################################################
8448:
8449: =pod
8450:
1.157 matthew 8451: =back
8452:
1.139 matthew 8453: =head1 Statistics helper routines?
8454:
8455: Bad place for them but what the hell.
8456:
1.157 matthew 8457: =over 4
8458:
1.648 raeburn 8459: =item * &chartlink()
1.139 matthew 8460:
8461: Returns a link to the chart for a specific student.
8462:
8463: Inputs:
8464:
8465: =over 4
8466:
8467: =item $linktext: The text of the link
8468:
8469: =item $sname: The students username
8470:
8471: =item $sdomain: The students domain
8472:
8473: =back
8474:
1.157 matthew 8475: =back
8476:
1.139 matthew 8477: =cut
8478:
8479: ############################################################
8480: ############################################################
8481: sub chartlink {
8482: my ($linktext, $sname, $sdomain) = @_;
8483: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8484: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8485: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8486: '">'.$linktext.'</a>';
1.153 matthew 8487: }
8488:
8489: #######################################################
8490: #######################################################
8491:
8492: =pod
8493:
8494: =head1 Course Environment Routines
1.157 matthew 8495:
8496: =over 4
1.153 matthew 8497:
1.648 raeburn 8498: =item * &restore_course_settings()
1.153 matthew 8499:
1.648 raeburn 8500: =item * &store_course_settings()
1.153 matthew 8501:
8502: Restores/Store indicated form parameters from the course environment.
8503: Will not overwrite existing values of the form parameters.
8504:
8505: Inputs:
8506: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8507:
8508: a hash ref describing the data to be stored. For example:
8509:
8510: %Save_Parameters = ('Status' => 'scalar',
8511: 'chartoutputmode' => 'scalar',
8512: 'chartoutputdata' => 'scalar',
8513: 'Section' => 'array',
1.373 raeburn 8514: 'Group' => 'array',
1.153 matthew 8515: 'StudentData' => 'array',
8516: 'Maps' => 'array');
8517:
8518: Returns: both routines return nothing
8519:
1.631 raeburn 8520: =back
8521:
1.153 matthew 8522: =cut
8523:
8524: #######################################################
8525: #######################################################
8526: sub store_course_settings {
1.496 albertel 8527: return &store_settings($env{'request.course.id'},@_);
8528: }
8529:
8530: sub store_settings {
1.153 matthew 8531: # save to the environment
8532: # appenv the same items, just to be safe
1.300 albertel 8533: my $udom = $env{'user.domain'};
8534: my $uname = $env{'user.name'};
1.496 albertel 8535: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8536: my %SaveHash;
8537: my %AppHash;
8538: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8539: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8540: my $envname = 'environment.'.$basename;
1.258 albertel 8541: if (exists($env{'form.'.$setting})) {
1.153 matthew 8542: # Save this value away
8543: if ($type eq 'scalar' &&
1.258 albertel 8544: (! exists($env{$envname}) ||
8545: $env{$envname} ne $env{'form.'.$setting})) {
8546: $SaveHash{$basename} = $env{'form.'.$setting};
8547: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8548: } elsif ($type eq 'array') {
8549: my $stored_form;
1.258 albertel 8550: if (ref($env{'form.'.$setting})) {
1.153 matthew 8551: $stored_form = join(',',
8552: map {
1.369 www 8553: &escape($_);
1.258 albertel 8554: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8555: } else {
8556: $stored_form =
1.369 www 8557: &escape($env{'form.'.$setting});
1.153 matthew 8558: }
8559: # Determine if the array contents are the same.
1.258 albertel 8560: if ($stored_form ne $env{$envname}) {
1.153 matthew 8561: $SaveHash{$basename} = $stored_form;
8562: $AppHash{$envname} = $stored_form;
8563: }
8564: }
8565: }
8566: }
8567: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8568: $udom,$uname);
1.153 matthew 8569: if ($put_result !~ /^(ok|delayed)/) {
8570: &Apache::lonnet::logthis('unable to save form parameters, '.
8571: 'got error:'.$put_result);
8572: }
8573: # Make sure these settings stick around in this session, too
1.646 raeburn 8574: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8575: return;
8576: }
8577:
8578: sub restore_course_settings {
1.499 albertel 8579: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8580: }
8581:
8582: sub restore_settings {
8583: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8584: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8585: next if (exists($env{'form.'.$setting}));
1.496 albertel 8586: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8587: '.'.$setting;
1.258 albertel 8588: if (exists($env{$envname})) {
1.153 matthew 8589: if ($type eq 'scalar') {
1.258 albertel 8590: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8591: } elsif ($type eq 'array') {
1.258 albertel 8592: $env{'form.'.$setting} = [
1.153 matthew 8593: map {
1.369 www 8594: &unescape($_);
1.258 albertel 8595: } split(',',$env{$envname})
1.153 matthew 8596: ];
8597: }
8598: }
8599: }
1.127 matthew 8600: }
8601:
1.618 raeburn 8602: #######################################################
8603: #######################################################
8604:
8605: =pod
8606:
8607: =head1 Domain E-mail Routines
8608:
8609: =over 4
8610:
1.648 raeburn 8611: =item * &build_recipient_list()
1.618 raeburn 8612:
8613: Build recipient lists for three types of e-mail:
8614: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8615: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8616:
8617: Inputs:
1.619 raeburn 8618: defmail (scalar - email address of default recipient),
1.618 raeburn 8619: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8620: defdom (domain for which to retrieve configuration settings),
8621: origmail (scalar - email address of recipient from loncapa.conf,
8622: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8623:
1.655 raeburn 8624: Returns: comma separated list of addresses to which to send e-mail.
8625:
8626: =back
1.618 raeburn 8627:
8628: =cut
8629:
8630: ############################################################
8631: ############################################################
8632: sub build_recipient_list {
1.619 raeburn 8633: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8634: my @recipients;
8635: my $otheremails;
8636: my %domconfig =
8637: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8638: if (ref($domconfig{'contacts'}) eq 'HASH') {
8639: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8640: my @contacts = ('adminemail','supportemail');
8641: foreach my $item (@contacts) {
8642: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8643: my $addr = $domconfig{'contacts'}{$item};
8644: if (!grep(/^\Q$addr\E$/,@recipients)) {
8645: push(@recipients,$addr);
8646: }
1.618 raeburn 8647: }
8648: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8649: }
8650: }
1.619 raeburn 8651: } elsif ($origmail ne '') {
8652: push(@recipients,$origmail);
1.618 raeburn 8653: }
1.688 raeburn 8654: if (defined($defmail)) {
8655: if ($defmail ne '') {
8656: push(@recipients,$defmail);
8657: }
1.618 raeburn 8658: }
8659: if ($otheremails) {
1.619 raeburn 8660: my @others;
8661: if ($otheremails =~ /,/) {
8662: @others = split(/,/,$otheremails);
1.618 raeburn 8663: } else {
1.619 raeburn 8664: push(@others,$otheremails);
8665: }
8666: foreach my $addr (@others) {
8667: if (!grep(/^\Q$addr\E$/,@recipients)) {
8668: push(@recipients,$addr);
8669: }
1.618 raeburn 8670: }
8671: }
1.619 raeburn 8672: my $recipientlist = join(',',@recipients);
1.618 raeburn 8673: return $recipientlist;
8674: }
8675:
1.127 matthew 8676: ############################################################
8677: ############################################################
1.154 albertel 8678:
1.655 raeburn 8679: =pod
8680:
8681: =head1 Course Catalog Routines
8682:
8683: =over 4
8684:
8685: =item * &gather_categories()
8686:
8687: Converts category definitions - keys of categories hash stored in
8688: coursecategories in configuration.db on the primary library server in a
8689: domain - to an array. Also generates javascript and idx hash used to
8690: generate Domain Coordinator interface for editing Course Categories.
8691:
8692: Inputs:
1.663 raeburn 8693:
1.655 raeburn 8694: categories (reference to hash of category definitions).
1.663 raeburn 8695:
1.655 raeburn 8696: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8697: categories and subcategories).
1.663 raeburn 8698:
1.655 raeburn 8699: idx (reference to hash of counters used in Domain Coordinator interface for
8700: editing Course Categories).
1.663 raeburn 8701:
1.655 raeburn 8702: jsarray (reference to array of categories used to create Javascript arrays for
8703: Domain Coordinator interface for editing Course Categories).
8704:
8705: Returns: nothing
8706:
8707: Side effects: populates cats, idx and jsarray.
8708:
8709: =cut
8710:
8711: sub gather_categories {
8712: my ($categories,$cats,$idx,$jsarray) = @_;
8713: my %counters;
8714: my $num = 0;
8715: foreach my $item (keys(%{$categories})) {
8716: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8717: if ($container eq '' && $depth == 0) {
8718: $cats->[$depth][$categories->{$item}] = $cat;
8719: } else {
8720: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8721: }
8722: my ($escitem,$tail) = split(/:/,$item,2);
8723: if ($counters{$tail} eq '') {
8724: $counters{$tail} = $num;
8725: $num ++;
8726: }
8727: if (ref($idx) eq 'HASH') {
8728: $idx->{$item} = $counters{$tail};
8729: }
8730: if (ref($jsarray) eq 'ARRAY') {
8731: push(@{$jsarray->[$counters{$tail}]},$item);
8732: }
8733: }
8734: return;
8735: }
8736:
8737: =pod
8738:
8739: =item * &extract_categories()
8740:
8741: Used to generate breadcrumb trails for course categories.
8742:
8743: Inputs:
1.663 raeburn 8744:
1.655 raeburn 8745: categories (reference to hash of category definitions).
1.663 raeburn 8746:
1.655 raeburn 8747: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8748: categories and subcategories).
1.663 raeburn 8749:
1.655 raeburn 8750: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8751:
1.655 raeburn 8752: allitems (reference to hash - key is category key
8753: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8754:
1.655 raeburn 8755: idx (reference to hash of counters used in Domain Coordinator interface for
8756: editing Course Categories).
1.663 raeburn 8757:
1.655 raeburn 8758: jsarray (reference to array of categories used to create Javascript arrays for
8759: Domain Coordinator interface for editing Course Categories).
8760:
1.665 raeburn 8761: subcats (reference to hash of arrays containing all subcategories within each
8762: category, -recursive)
8763:
1.655 raeburn 8764: Returns: nothing
8765:
8766: Side effects: populates trails and allitems hash references.
8767:
8768: =cut
8769:
8770: sub extract_categories {
1.665 raeburn 8771: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8772: if (ref($categories) eq 'HASH') {
8773: &gather_categories($categories,$cats,$idx,$jsarray);
8774: if (ref($cats->[0]) eq 'ARRAY') {
8775: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8776: my $name = $cats->[0][$i];
8777: my $item = &escape($name).'::0';
8778: my $trailstr;
8779: if ($name eq 'instcode') {
8780: $trailstr = &mt('Official courses (with institutional codes)');
8781: } else {
8782: $trailstr = $name;
8783: }
8784: if ($allitems->{$item} eq '') {
8785: push(@{$trails},$trailstr);
8786: $allitems->{$item} = scalar(@{$trails})-1;
8787: }
8788: my @parents = ($name);
8789: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8790: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8791: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8792: if (ref($subcats) eq 'HASH') {
8793: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8794: }
8795: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8796: }
8797: } else {
8798: if (ref($subcats) eq 'HASH') {
8799: $subcats->{$item} = [];
1.655 raeburn 8800: }
8801: }
8802: }
8803: }
8804: }
8805: return;
8806: }
8807:
8808: =pod
8809:
8810: =item *&recurse_categories()
8811:
8812: Recursively used to generate breadcrumb trails for course categories.
8813:
8814: Inputs:
1.663 raeburn 8815:
1.655 raeburn 8816: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8817: categories and subcategories).
1.663 raeburn 8818:
1.655 raeburn 8819: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8820:
8821: category (current course category, for which breadcrumb trail is being generated).
8822:
8823: trails (reference to array of breadcrumb trails for each category).
8824:
1.655 raeburn 8825: allitems (reference to hash - key is category key
8826: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8827:
1.655 raeburn 8828: parents (array containing containers directories for current category,
8829: back to top level).
8830:
8831: Returns: nothing
8832:
8833: Side effects: populates trails and allitems hash references
8834:
8835: =cut
8836:
8837: sub recurse_categories {
1.665 raeburn 8838: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8839: my $shallower = $depth - 1;
8840: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8841: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8842: my $name = $cats->[$depth]{$category}[$k];
8843: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8844: my $trailstr = join(' -> ',(@{$parents},$category));
8845: if ($allitems->{$item} eq '') {
8846: push(@{$trails},$trailstr);
8847: $allitems->{$item} = scalar(@{$trails})-1;
8848: }
8849: my $deeper = $depth+1;
8850: push(@{$parents},$category);
1.665 raeburn 8851: if (ref($subcats) eq 'HASH') {
8852: my $subcat = &escape($name).':'.$category.':'.$depth;
8853: for (my $j=@{$parents}; $j>=0; $j--) {
8854: my $higher;
8855: if ($j > 0) {
8856: $higher = &escape($parents->[$j]).':'.
8857: &escape($parents->[$j-1]).':'.$j;
8858: } else {
8859: $higher = &escape($parents->[$j]).'::'.$j;
8860: }
8861: push(@{$subcats->{$higher}},$subcat);
8862: }
8863: }
8864: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8865: $subcats);
1.655 raeburn 8866: pop(@{$parents});
8867: }
8868: } else {
8869: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8870: my $trailstr = join(' -> ',(@{$parents},$category));
8871: if ($allitems->{$item} eq '') {
8872: push(@{$trails},$trailstr);
8873: $allitems->{$item} = scalar(@{$trails})-1;
8874: }
8875: }
8876: return;
8877: }
8878:
1.663 raeburn 8879: =pod
8880:
8881: =item *&assign_categories_table()
8882:
8883: Create a datatable for display of hierarchical categories in a domain,
8884: with checkboxes to allow a course to be categorized.
8885:
8886: Inputs:
8887:
8888: cathash - reference to hash of categories defined for the domain (from
8889: configuration.db)
8890:
8891: currcat - scalar with an & separated list of categories assigned to a course.
8892:
8893: Returns: $output (markup to be displayed)
8894:
8895: =cut
8896:
8897: sub assign_categories_table {
8898: my ($cathash,$currcat) = @_;
8899: my $output;
8900: if (ref($cathash) eq 'HASH') {
8901: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
8902: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
8903: $maxdepth = scalar(@cats);
8904: if (@cats > 0) {
8905: my $itemcount = 0;
8906: if (ref($cats[0]) eq 'ARRAY') {
8907: $output = &Apache::loncommon::start_data_table();
8908: my @currcategories;
8909: if ($currcat ne '') {
8910: @currcategories = split('&',$currcat);
8911: }
8912: for (my $i=0; $i<@{$cats[0]}; $i++) {
8913: my $parent = $cats[0][$i];
8914: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8915: next if ($parent eq 'instcode');
8916: my $item = &escape($parent).'::0';
8917: my $checked = '';
8918: if (@currcategories > 0) {
8919: if (grep(/^\Q$item\E$/,@currcategories)) {
8920: $checked = ' checked="checked" ';
8921: }
8922: }
1.675 raeburn 8923: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
8924: '<input type="checkbox" name="usecategory" value="'.
8925: $item.'"'.$checked.' />'.$parent.'</span>'.
8926: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 8927: my $depth = 1;
8928: push(@path,$parent);
8929: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
8930: pop(@path);
8931: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
8932: $itemcount ++;
8933: }
8934: $output .= &Apache::loncommon::end_data_table();
8935: }
8936: }
8937: }
8938: return $output;
8939: }
8940:
8941: =pod
8942:
8943: =item *&assign_category_rows()
8944:
8945: Create a datatable row for display of nested categories in a domain,
8946: with checkboxes to allow a course to be categorized,called recursively.
8947:
8948: Inputs:
8949:
8950: itemcount - track row number for alternating colors
8951:
8952: cats - reference to array of arrays/hashes which encapsulates hierarchy of
8953: categories and subcategories.
8954:
8955: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
8956:
8957: parent - parent of current category item
8958:
8959: path - Array containing all categories back up through the hierarchy from the
8960: current category to the top level.
8961:
8962: currcategories - reference to array of current categories assigned to the course
8963:
8964: Returns: $output (markup to be displayed).
8965:
8966: =cut
8967:
8968: sub assign_category_rows {
8969: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
8970: my ($text,$name,$item,$chgstr);
8971: if (ref($cats) eq 'ARRAY') {
8972: my $maxdepth = scalar(@{$cats});
8973: if (ref($cats->[$depth]) eq 'HASH') {
8974: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
8975: my $numchildren = @{$cats->[$depth]{$parent}};
8976: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8977: $text .= '<td><table class="LC_datatable">';
8978: for (my $j=0; $j<$numchildren; $j++) {
8979: $name = $cats->[$depth]{$parent}[$j];
8980: $item = &escape($name).':'.&escape($parent).':'.$depth;
8981: my $deeper = $depth+1;
8982: my $checked = '';
8983: if (ref($currcategories) eq 'ARRAY') {
8984: if (@{$currcategories} > 0) {
8985: if (grep(/^\Q$item\E$/,@{$currcategories})) {
8986: $checked = ' checked="checked" ';
8987: }
8988: }
8989: }
1.664 raeburn 8990: $text .= '<tr><td><span class="LC_nobreak"><label>'.
8991: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 8992: $item.'"'.$checked.' />'.$name.'</label></span>'.
8993: '<input type="hidden" name="catname" value="'.$name.'" />'.
8994: '</td><td>';
1.663 raeburn 8995: if (ref($path) eq 'ARRAY') {
8996: push(@{$path},$name);
8997: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
8998: pop(@{$path});
8999: }
9000: $text .= '</td></tr>';
9001: }
9002: $text .= '</table></td>';
9003: }
9004: }
9005: }
9006: return $text;
9007: }
9008:
1.655 raeburn 9009: ############################################################
9010: ############################################################
9011:
9012:
1.443 albertel 9013: sub commit_customrole {
1.664 raeburn 9014: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9015: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9016: ($start?', '.&mt('starting').' '.localtime($start):'').
9017: ($end?', ending '.localtime($end):'').': <b>'.
9018: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9019: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9020: '</b><br />';
9021: return $output;
9022: }
9023:
9024: sub commit_standardrole {
1.541 raeburn 9025: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9026: my ($output,$logmsg,$linefeed);
9027: if ($context eq 'auto') {
9028: $linefeed = "\n";
9029: } else {
9030: $linefeed = "<br />\n";
9031: }
1.443 albertel 9032: if ($three eq 'st') {
1.541 raeburn 9033: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9034: $one,$two,$sec,$context);
9035: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9036: ($result eq 'unknown_course') || ($result eq 'refused')) {
9037: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9038: } else {
1.541 raeburn 9039: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9040: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9041: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9042: if ($context eq 'auto') {
9043: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9044: } else {
9045: $output .= '<b>'.$result.'</b>'.$linefeed.
9046: &mt('Add to classlist').': <b>ok</b>';
9047: }
9048: $output .= $linefeed;
1.443 albertel 9049: }
9050: } else {
9051: $output = &mt('Assigning').' '.$three.' in '.$url.
9052: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9053: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9054: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9055: if ($context eq 'auto') {
9056: $output .= $result.$linefeed;
9057: } else {
9058: $output .= '<b>'.$result.'</b>'.$linefeed;
9059: }
1.443 albertel 9060: }
9061: return $output;
9062: }
9063:
9064: sub commit_studentrole {
1.541 raeburn 9065: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9066: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9067: if ($context eq 'auto') {
9068: $linefeed = "\n";
9069: } else {
9070: $linefeed = '<br />'."\n";
9071: }
1.443 albertel 9072: if (defined($one) && defined($two)) {
9073: my $cid=$one.'_'.$two;
9074: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9075: my $secchange = 0;
9076: my $expire_role_result;
9077: my $modify_section_result;
1.628 raeburn 9078: if ($oldsec ne '-1') {
9079: if ($oldsec ne $sec) {
1.443 albertel 9080: $secchange = 1;
1.628 raeburn 9081: my $now = time;
1.443 albertel 9082: my $uurl='/'.$cid;
9083: $uurl=~s/\_/\//g;
9084: if ($oldsec) {
9085: $uurl.='/'.$oldsec;
9086: }
1.626 raeburn 9087: $oldsecurl = $uurl;
1.628 raeburn 9088: $expire_role_result =
1.652 raeburn 9089: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9090: if ($env{'request.course.sec'} ne '') {
9091: if ($expire_role_result eq 'refused') {
9092: my @roles = ('st');
9093: my @statuses = ('previous');
9094: my @roledoms = ($one);
9095: my $withsec = 1;
9096: my %roleshash =
9097: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9098: \@statuses,\@roles,\@roledoms,$withsec);
9099: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9100: my ($oldstart,$oldend) =
9101: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9102: if ($oldend > 0 && $oldend <= $now) {
9103: $expire_role_result = 'ok';
9104: }
9105: }
9106: }
9107: }
1.443 albertel 9108: $result = $expire_role_result;
9109: }
9110: }
9111: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9112: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9113: if ($modify_section_result =~ /^ok/) {
9114: if ($secchange == 1) {
1.628 raeburn 9115: if ($sec eq '') {
9116: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9117: } else {
9118: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9119: }
1.443 albertel 9120: } elsif ($oldsec eq '-1') {
1.628 raeburn 9121: if ($sec eq '') {
9122: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9123: } else {
9124: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9125: }
1.443 albertel 9126: } else {
1.628 raeburn 9127: if ($sec eq '') {
9128: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9129: } else {
9130: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9131: }
1.443 albertel 9132: }
9133: } else {
1.628 raeburn 9134: if ($secchange) {
9135: $$logmsg .= &mt('Error when attempting section change for [_1] from old section "[_2]" to new section: "[_3]" in course [_4] -error:',$uname,$oldsec,$sec,$cid).' '.$modify_section_result.$linefeed;
9136: } else {
9137: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9138: }
1.443 albertel 9139: }
9140: $result = $modify_section_result;
9141: } elsif ($secchange == 1) {
1.628 raeburn 9142: if ($oldsec eq '') {
9143: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9144: } else {
9145: $$logmsg .= &mt('Error when attempting to expire existing role for [_1] in section [_2] in course [_3] -error: ',$uname,$oldsec,$cid).' '.$expire_role_result.$linefeed;
9146: }
1.626 raeburn 9147: if ($expire_role_result eq 'refused') {
9148: my $newsecurl = '/'.$cid;
9149: $newsecurl =~ s/\_/\//g;
9150: if ($sec ne '') {
9151: $newsecurl.='/'.$sec;
9152: }
9153: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9154: if ($sec eq '') {
9155: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments unaffiliated with any section.',$sec).$linefeed;
9156: } else {
9157: $$logmsg .= &mt('Although your current role has privileges to add students to section "[_1]", you do not have privileges to modify existing enrollments in other sections.',$sec).$linefeed;
9158: }
9159: }
9160: }
1.443 albertel 9161: }
9162: } else {
1.626 raeburn 9163: $$logmsg .= &mt('Incomplete course id defined.').$linefeed.&mt('Addition of user [_1] from domain [_2] to course [_3], section [_4] not completed.',$uname,$udom,$one.'_'.$two,$sec).$linefeed;
1.443 albertel 9164: $result = "error: incomplete course id\n";
9165: }
9166: return $result;
9167: }
9168:
9169: ############################################################
9170: ############################################################
9171:
1.566 albertel 9172: sub check_clone {
1.578 raeburn 9173: my ($args,$linefeed) = @_;
1.566 albertel 9174: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9175: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9176: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9177: my $clonemsg;
9178: my $can_clone = 0;
9179:
9180: if ($clonehome eq 'no_host') {
1.578 raeburn 9181: $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 9182: } else {
9183: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9184: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9185: $can_clone = 1;
9186: } else {
9187: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9188: $args->{'clonedomain'},$args->{'clonecourse'});
9189: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9190: if (grep(/^\*$/,@cloners)) {
9191: $can_clone = 1;
9192: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9193: $can_clone = 1;
9194: } else {
9195: my %roleshash =
9196: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9197: $args->{'ccdomain'},
9198: 'userroles',['active'],['cc'],
9199: [$args->{'clonedomain'}]);
9200: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9201: $can_clone = 1;
9202: } else {
9203: $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'});
9204: }
1.566 albertel 9205: }
1.578 raeburn 9206: }
1.566 albertel 9207: }
9208: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9209: }
9210:
1.444 albertel 9211: sub construct_course {
1.541 raeburn 9212: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9213: my $outcome;
1.541 raeburn 9214: my $linefeed = '<br />'."\n";
9215: if ($context eq 'auto') {
9216: $linefeed = "\n";
9217: }
1.566 albertel 9218:
9219: #
9220: # Are we cloning?
9221: #
9222: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9223: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9224: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9225: if ($context ne 'auto') {
1.578 raeburn 9226: if ($clonemsg ne '') {
9227: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9228: }
1.566 albertel 9229: }
9230: $outcome .= $clonemsg.$linefeed;
9231:
9232: if (!$can_clone) {
9233: return (0,$outcome);
9234: }
9235: }
9236:
1.444 albertel 9237: #
9238: # Open course
9239: #
9240: my $crstype = lc($args->{'crstype'});
9241: my %cenv=();
9242: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9243: $args->{'cdescr'},
9244: $args->{'curl'},
9245: $args->{'course_home'},
9246: $args->{'nonstandard'},
9247: $args->{'crscode'},
9248: $args->{'ccuname'}.':'.
9249: $args->{'ccdomain'},
9250: $args->{'crstype'});
9251:
9252: # Note: The testing routines depend on this being output; see
9253: # Utils::Course. This needs to at least be output as a comment
9254: # if anyone ever decides to not show this, and Utils::Course::new
9255: # will need to be suitably modified.
1.541 raeburn 9256: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9257: #
9258: # Check if created correctly
9259: #
1.479 albertel 9260: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9261: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9262: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9263:
1.444 albertel 9264: #
1.566 albertel 9265: # Do the cloning
9266: #
9267: if ($can_clone && $cloneid) {
9268: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9269: if ($context ne 'auto') {
9270: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9271: }
9272: $outcome .= $clonemsg.$linefeed;
9273: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9274: # Copy all files
1.637 www 9275: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9276: # Restore URL
1.566 albertel 9277: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9278: # Restore title
1.566 albertel 9279: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9280: # Mark as cloned
1.566 albertel 9281: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9282: # Need to clone grading mode
9283: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9284: $cenv{'grading'}=$newenv{'grading'};
9285: # Do not clone these environment entries
9286: &Apache::lonnet::del('environment',
9287: ['default_enrollment_start_date',
9288: 'default_enrollment_end_date',
9289: 'question.email',
9290: 'policy.email',
9291: 'comment.email',
9292: 'pch.users.denied',
9293: 'plc.users.denied'],
9294: $$crsudom,$$crsunum);
1.444 albertel 9295: }
1.566 albertel 9296:
1.444 albertel 9297: #
9298: # Set environment (will override cloned, if existing)
9299: #
9300: my @sections = ();
9301: my @xlists = ();
9302: if ($args->{'crstype'}) {
9303: $cenv{'type'}=$args->{'crstype'};
9304: }
9305: if ($args->{'crsid'}) {
9306: $cenv{'courseid'}=$args->{'crsid'};
9307: }
9308: if ($args->{'crscode'}) {
9309: $cenv{'internal.coursecode'}=$args->{'crscode'};
9310: }
9311: if ($args->{'crsquota'} ne '') {
9312: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9313: } else {
9314: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9315: }
9316: if ($args->{'ccuname'}) {
9317: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9318: ':'.$args->{'ccdomain'};
9319: } else {
9320: $cenv{'internal.courseowner'} = $args->{'curruser'};
9321: }
9322: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9323: if ($args->{'crssections'}) {
9324: $cenv{'internal.sectionnums'} = '';
9325: if ($args->{'crssections'} =~ m/,/) {
9326: @sections = split/,/,$args->{'crssections'};
9327: } else {
9328: $sections[0] = $args->{'crssections'};
9329: }
9330: if (@sections > 0) {
9331: foreach my $item (@sections) {
9332: my ($sec,$gp) = split/:/,$item;
9333: my $class = $args->{'crscode'}.$sec;
9334: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9335: $cenv{'internal.sectionnums'} .= $item.',';
9336: unless ($addcheck eq 'ok') {
9337: push @badclasses, $class;
9338: }
9339: }
9340: $cenv{'internal.sectionnums'} =~ s/,$//;
9341: }
9342: }
9343: # do not hide course coordinator from staff listing,
9344: # even if privileged
9345: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9346: # add crosslistings
9347: if ($args->{'crsxlist'}) {
9348: $cenv{'internal.crosslistings'}='';
9349: if ($args->{'crsxlist'} =~ m/,/) {
9350: @xlists = split/,/,$args->{'crsxlist'};
9351: } else {
9352: $xlists[0] = $args->{'crsxlist'};
9353: }
9354: if (@xlists > 0) {
9355: foreach my $item (@xlists) {
9356: my ($xl,$gp) = split/:/,$item;
9357: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9358: $cenv{'internal.crosslistings'} .= $item.',';
9359: unless ($addcheck eq 'ok') {
9360: push @badclasses, $xl;
9361: }
9362: }
9363: $cenv{'internal.crosslistings'} =~ s/,$//;
9364: }
9365: }
9366: if ($args->{'autoadds'}) {
9367: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9368: }
9369: if ($args->{'autodrops'}) {
9370: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9371: }
9372: # check for notification of enrollment changes
9373: my @notified = ();
9374: if ($args->{'notify_owner'}) {
9375: if ($args->{'ccuname'} ne '') {
9376: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9377: }
9378: }
9379: if ($args->{'notify_dc'}) {
9380: if ($uname ne '') {
1.630 raeburn 9381: push(@notified,$uname.':'.$udom);
1.444 albertel 9382: }
9383: }
9384: if (@notified > 0) {
9385: my $notifylist;
9386: if (@notified > 1) {
9387: $notifylist = join(',',@notified);
9388: } else {
9389: $notifylist = $notified[0];
9390: }
9391: $cenv{'internal.notifylist'} = $notifylist;
9392: }
9393: if (@badclasses > 0) {
9394: my %lt=&Apache::lonlocal::texthash(
9395: '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',
9396: 'dnhr' => 'does not have rights to access enrollment in these classes',
9397: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9398: );
1.541 raeburn 9399: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9400: ' ('.$lt{'adby'}.')';
9401: if ($context eq 'auto') {
9402: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9403: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9404: foreach my $item (@badclasses) {
9405: if ($context eq 'auto') {
9406: $outcome .= " - $item\n";
9407: } else {
9408: $outcome .= "<li>$item</li>\n";
9409: }
9410: }
9411: if ($context eq 'auto') {
9412: $outcome .= $linefeed;
9413: } else {
1.566 albertel 9414: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9415: }
9416: }
1.444 albertel 9417: }
9418: if ($args->{'no_end_date'}) {
9419: $args->{'endaccess'} = 0;
9420: }
9421: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9422: $cenv{'internal.autoend'}=$args->{'enrollend'};
9423: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9424: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9425: if ($args->{'showphotos'}) {
9426: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9427: }
9428: $cenv{'internal.authtype'} = $args->{'authtype'};
9429: $cenv{'internal.autharg'} = $args->{'autharg'};
9430: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9431: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9432: 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');
9433: if ($context eq 'auto') {
9434: $outcome .= $krb_msg;
9435: } else {
1.566 albertel 9436: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9437: }
9438: $outcome .= $linefeed;
1.444 albertel 9439: }
9440: }
9441: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9442: if ($args->{'setpolicy'}) {
9443: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9444: }
9445: if ($args->{'setcontent'}) {
9446: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9447: }
9448: }
9449: if ($args->{'reshome'}) {
9450: $cenv{'reshome'}=$args->{'reshome'}.'/';
9451: $cenv{'reshome'}=~s/\/+$/\//;
9452: }
9453: #
9454: # course has keyed access
9455: #
9456: if ($args->{'setkeys'}) {
9457: $cenv{'keyaccess'}='yes';
9458: }
9459: # if specified, key authority is not course, but user
9460: # only active if keyaccess is yes
9461: if ($args->{'keyauth'}) {
1.487 albertel 9462: my ($user,$domain) = split(':',$args->{'keyauth'});
9463: $user = &LONCAPA::clean_username($user);
9464: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9465: if ($user ne '' && $domain ne '') {
1.487 albertel 9466: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9467: }
9468: }
9469:
9470: if ($args->{'disresdis'}) {
9471: $cenv{'pch.roles.denied'}='st';
9472: }
9473: if ($args->{'disablechat'}) {
9474: $cenv{'plc.roles.denied'}='st';
9475: }
9476:
9477: # Record we've not yet viewed the Course Initialization Helper for this
9478: # course
9479: $cenv{'course.helper.not.run'} = 1;
9480: #
9481: # Use new Randomseed
9482: #
9483: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9484: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9485: #
9486: # The encryption code and receipt prefix for this course
9487: #
9488: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9489: $cenv{'internal.encpref'}=100+int(9*rand(99));
9490: #
9491: # By default, use standard grading
9492: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9493:
1.541 raeburn 9494: $outcome .= $linefeed.&mt('Setting environment').': '.
9495: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9496: #
9497: # Open all assignments
9498: #
9499: if ($args->{'openall'}) {
9500: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9501: my %storecontent = ($storeunder => time,
9502: $storeunder.'.type' => 'date_start');
9503:
9504: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9505: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9506: }
9507: #
9508: # Set first page
9509: #
9510: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9511: || ($cloneid)) {
1.445 albertel 9512: use LONCAPA::map;
1.444 albertel 9513: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9514:
9515: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9516: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9517:
1.444 albertel 9518: $outcome .= ($fatal?$errtext:'read ok').' - ';
9519: my $title; my $url;
9520: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9521: $title=&mt('Syllabus');
1.444 albertel 9522: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9523: } else {
1.690 bisitz 9524: $title=&mt('Navigate Contents');
1.444 albertel 9525: $url='/adm/navmaps';
9526: }
1.445 albertel 9527:
9528: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9529: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9530:
9531: if ($errtext) { $fatal=2; }
1.541 raeburn 9532: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9533: }
1.566 albertel 9534:
9535: return (1,$outcome);
1.444 albertel 9536: }
9537:
9538: ############################################################
9539: ############################################################
9540:
1.378 raeburn 9541: sub course_type {
9542: my ($cid) = @_;
9543: if (!defined($cid)) {
9544: $cid = $env{'request.course.id'};
9545: }
1.404 albertel 9546: if (defined($env{'course.'.$cid.'.type'})) {
9547: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9548: } else {
9549: return 'Course';
1.377 raeburn 9550: }
9551: }
1.156 albertel 9552:
1.406 raeburn 9553: sub group_term {
9554: my $crstype = &course_type();
9555: my %names = (
9556: 'Course' => 'group',
9557: 'Group' => 'team',
9558: );
9559: return $names{$crstype};
9560: }
9561:
1.156 albertel 9562: sub icon {
9563: my ($file)=@_;
1.505 albertel 9564: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9565: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9566: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9567: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9568: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9569: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9570: $curfext.".gif") {
9571: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9572: $curfext.".gif";
9573: }
9574: }
1.249 albertel 9575: return &lonhttpdurl($iconname);
1.154 albertel 9576: }
1.84 albertel 9577:
1.575 albertel 9578: sub lonhttpdurl {
1.692 www 9579: #
9580: # Had been used for "small fry" static images on separate port 8080.
9581: # Modify here if lightweight http functionality desired again.
9582: # Currently eliminated due to increasing firewall issues.
9583: #
1.575 albertel 9584: my ($url)=@_;
1.692 www 9585: return $url;
1.215 albertel 9586: }
9587:
1.213 albertel 9588: sub connection_aborted {
9589: my ($r)=@_;
9590: $r->print(" ");$r->rflush();
9591: my $c = $r->connection;
9592: return $c->aborted();
9593: }
9594:
1.221 foxr 9595: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9596: # strings as 'strings'.
9597: sub escape_single {
1.221 foxr 9598: my ($input) = @_;
1.223 albertel 9599: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9600: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9601: return $input;
9602: }
1.223 albertel 9603:
1.222 foxr 9604: # Same as escape_single, but escape's "'s This
9605: # can be used for "strings"
9606: sub escape_double {
9607: my ($input) = @_;
9608: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9609: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9610: return $input;
9611: }
1.223 albertel 9612:
1.222 foxr 9613: # Escapes the last element of a full URL.
9614: sub escape_url {
9615: my ($url) = @_;
1.238 raeburn 9616: my @urlslices = split(/\//, $url,-1);
1.369 www 9617: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9618: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9619: }
1.462 albertel 9620:
9621: # -------------------------------------------------------- Initliaze user login
9622: sub init_user_environment {
1.463 albertel 9623: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9624: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9625:
9626: my $public=($username eq 'public' && $domain eq 'public');
9627:
9628: # See if old ID present, if so, remove
9629:
9630: my ($filename,$cookie,$userroles);
9631: my $now=time;
9632:
9633: if ($public) {
9634: my $max_public=100;
9635: my $oldest;
9636: my $oldest_time=0;
9637: for(my $next=1;$next<=$max_public;$next++) {
9638: if (-e $lonids."/publicuser_$next.id") {
9639: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9640: if ($mtime<$oldest_time || !$oldest_time) {
9641: $oldest_time=$mtime;
9642: $oldest=$next;
9643: }
9644: } else {
9645: $cookie="publicuser_$next";
9646: last;
9647: }
9648: }
9649: if (!$cookie) { $cookie="publicuser_$oldest"; }
9650: } else {
1.463 albertel 9651: # if this isn't a robot, kill any existing non-robot sessions
9652: if (!$args->{'robot'}) {
9653: opendir(DIR,$lonids);
9654: while ($filename=readdir(DIR)) {
9655: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9656: unlink($lonids.'/'.$filename);
9657: }
1.462 albertel 9658: }
1.463 albertel 9659: closedir(DIR);
1.462 albertel 9660: }
9661: # Give them a new cookie
1.463 albertel 9662: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9663: : $now.$$.int(rand(10000)));
1.463 albertel 9664: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9665:
9666: # Initialize roles
9667:
9668: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9669: }
9670: # ------------------------------------ Check browser type and MathML capability
9671:
9672: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9673: $clientunicode,$clientos) = &decode_user_agent($r);
9674:
9675: # -------------------------------------- Any accessibility options to remember?
9676: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9677: foreach my $option ('imagesuppress','appletsuppress',
9678: 'embedsuppress','fontenhance','blackwhite') {
9679: if ($form->{$option} eq 'true') {
9680: &Apache::lonnet::put('environment',{$option => 'on'},
9681: $domain,$username);
9682: } else {
9683: &Apache::lonnet::del('environment',[$option],
9684: $domain,$username);
9685: }
9686: }
9687: }
9688: # ------------------------------------------------------------- Get environment
9689:
9690: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9691: my ($tmp) = keys(%userenv);
9692: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9693: # default remote control to off
9694: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9695: } else {
9696: undef(%userenv);
9697: }
9698: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9699: $form->{'interface'}=$userenv{'interface'};
9700: }
9701: $env{'environment.remote'}=$userenv{'remote'};
9702: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9703:
9704: # --------------- Do not trust query string to be put directly into environment
9705: foreach my $option ('imagesuppress','appletsuppress',
9706: 'embedsuppress','fontenhance','blackwhite',
9707: 'interface','localpath','localres') {
9708: $form->{$option}=~s/[\n\r\=]//gs;
9709: }
9710: # --------------------------------------------------------- Write first profile
9711:
9712: {
9713: my %initial_env =
9714: ("user.name" => $username,
9715: "user.domain" => $domain,
9716: "user.home" => $authhost,
9717: "browser.type" => $clientbrowser,
9718: "browser.version" => $clientversion,
9719: "browser.mathml" => $clientmathml,
9720: "browser.unicode" => $clientunicode,
9721: "browser.os" => $clientos,
9722: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9723: "request.course.fn" => '',
9724: "request.course.uri" => '',
9725: "request.course.sec" => '',
9726: "request.role" => 'cm',
9727: "request.role.adv" => $env{'user.adv'},
9728: "request.host" => $ENV{'REMOTE_ADDR'},);
9729:
9730: if ($form->{'localpath'}) {
9731: $initial_env{"browser.localpath"} = $form->{'localpath'};
9732: $initial_env{"browser.localres"} = $form->{'localres'};
9733: }
9734:
9735: if ($public) {
9736: $initial_env{"environment.remote"} = "off";
9737: }
9738: if ($form->{'interface'}) {
9739: $form->{'interface'}=~s/\W//gs;
9740: $initial_env{"browser.interface"} = $form->{'interface'};
9741: $env{'browser.interface'}=$form->{'interface'};
9742: foreach my $option ('imagesuppress','appletsuppress',
9743: 'embedsuppress','fontenhance','blackwhite') {
9744: if (($form->{$option} eq 'true') ||
9745: ($userenv{$option} eq 'on')) {
9746: $initial_env{"browser.$option"} = "on";
9747: }
9748: }
9749: }
9750:
9751: $env{'user.environment'} = "$lonids/$cookie.id";
9752:
9753: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9754: &GDBM_WRCREAT(),0640)) {
9755: &_add_to_env(\%disk_env,\%initial_env);
9756: &_add_to_env(\%disk_env,\%userenv,'environment.');
9757: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9758: if (ref($args->{'extra_env'})) {
9759: &_add_to_env(\%disk_env,$args->{'extra_env'});
9760: }
1.462 albertel 9761: untie(%disk_env);
9762: } else {
1.705 tempelho 9763: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
9764: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 9765: return 'error: '.$!;
9766: }
9767: }
9768: $env{'request.role'}='cm';
9769: $env{'request.role.adv'}=$env{'user.adv'};
9770: $env{'browser.type'}=$clientbrowser;
9771:
9772: return $cookie;
9773:
9774: }
9775:
9776: sub _add_to_env {
9777: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9778: if (ref($env_data) eq 'HASH') {
9779: while (my ($key,$value) = each(%$env_data)) {
9780: $idf->{$prefix.$key} = $value;
9781: $env{$prefix.$key} = $value;
9782: }
1.462 albertel 9783: }
9784: }
9785:
1.685 tempelho 9786: # --- Get the symbolic name of a problem and the url
9787: sub get_symb {
9788: my ($request,$silent) = @_;
9789: (my $url=$env{'form.url'}) =~ s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
9790: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9791: if ($symb eq '') {
9792: if (!$silent) {
9793: $request->print("Unable to handle ambiguous references:$url:.");
9794: return ();
9795: }
9796: }
9797: &Apache::lonenc::check_decrypt(\$symb);
9798: return ($symb);
9799: }
9800:
9801: # --------------------------------------------------------------Get annotation
9802:
9803: sub get_annotation {
9804: my ($symb,$enc) = @_;
9805:
9806: my $key = $symb;
9807: if (!$enc) {
9808: $key =
9809: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9810: }
9811: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9812: return $annotation{$key};
9813: }
9814:
9815: sub clean_symb {
9816: my ($symb) = @_;
9817:
9818: &Apache::lonenc::check_decrypt(\$symb);
9819: my $enc = $env{'request.enc'};
9820: delete($env{'request.enc'});
9821:
9822: return ($symb,$enc);
9823: }
1.462 albertel 9824:
1.41 ng 9825: =pod
9826:
9827: =back
9828:
1.112 bowersj2 9829: =cut
1.41 ng 9830:
1.112 bowersj2 9831: 1;
9832: __END__;
1.41 ng 9833:
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