Annotation of loncom/interface/loncommon.pm, revision 1.699
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.699 ! raeburn 4: # $Id: loncommon.pm,v 1.698 2008/12/01 14:38:49 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.46 matthew 274: "<font color=yellow>INFO: Read file types</font>");
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.691 bisitz 929: "<td bgcolor='#5555FF'><span class=\"LC_nobreak\"><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></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.691 bisitz 938: if ($text ne '') { $template.='</span></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.436 albertel 1131: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></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.436 albertel 1176: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></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.109 matthew 2771: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2772: if ($fontcolor) {
2773: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2774: }
1.208 matthew 2775: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2776: }
1.14 harris41 2777:
1.208 matthew 2778: sub track_student_link {
1.268 albertel 2779: my ($linktext,$sname,$sdom,$target,$start) = @_;
2780: my $link ="/adm/trackstudent?";
1.208 matthew 2781: my $title = 'View recent activity';
2782: if (defined($sname) && $sname !~ /^\s*$/ &&
2783: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2784: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2785: $title .= ' of this student';
1.268 albertel 2786: }
1.208 matthew 2787: if (defined($target) && $target !~ /^\s*$/) {
2788: $target = qq{target="$target"};
2789: } else {
2790: $target = '';
2791: }
1.268 albertel 2792: if ($start) { $link.='&start='.$start; }
1.554 albertel 2793: $title = &mt($title);
2794: $linktext = &mt($linktext);
1.448 albertel 2795: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2796: &help_open_topic('View_recent_activity');
1.208 matthew 2797: }
2798:
1.508 www 2799: # ===================================================== Display a student photo
2800:
2801:
1.509 albertel 2802: sub student_image_tag {
1.508 www 2803: my ($domain,$user)=@_;
2804: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2805: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2806: return '<img src="'.$imgsrc.'" align="right" />';
2807: } else {
2808: return '';
2809: }
2810: }
2811:
1.112 bowersj2 2812: =pod
2813:
2814: =back
2815:
2816: =head1 Access .tab File Data
2817:
2818: =over 4
2819:
1.648 raeburn 2820: =item * &languageids()
1.112 bowersj2 2821:
2822: returns list of all language ids
2823:
2824: =cut
2825:
1.14 harris41 2826: sub languageids {
1.16 harris41 2827: return sort(keys(%language));
1.14 harris41 2828: }
2829:
1.112 bowersj2 2830: =pod
2831:
1.648 raeburn 2832: =item * &languagedescription()
1.112 bowersj2 2833:
2834: returns description of a specified language id
2835:
2836: =cut
2837:
1.14 harris41 2838: sub languagedescription {
1.125 www 2839: my $code=shift;
2840: return ($supported_language{$code}?'* ':'').
2841: $language{$code}.
1.126 www 2842: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2843: }
2844:
2845: sub plainlanguagedescription {
2846: my $code=shift;
2847: return $language{$code};
2848: }
2849:
2850: sub supportedlanguagecode {
2851: my $code=shift;
2852: return $supported_language{$code};
1.97 www 2853: }
2854:
1.112 bowersj2 2855: =pod
2856:
1.648 raeburn 2857: =item * ©rightids()
1.112 bowersj2 2858:
2859: returns list of all copyrights
2860:
2861: =cut
2862:
2863: sub copyrightids {
2864: return sort(keys(%cprtag));
2865: }
2866:
2867: =pod
2868:
1.648 raeburn 2869: =item * ©rightdescription()
1.112 bowersj2 2870:
2871: returns description of a specified copyright id
2872:
2873: =cut
2874:
2875: sub copyrightdescription {
1.166 www 2876: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2877: }
1.197 matthew 2878:
2879: =pod
2880:
1.648 raeburn 2881: =item * &source_copyrightids()
1.192 taceyjo1 2882:
2883: returns list of all source copyrights
2884:
2885: =cut
2886:
2887: sub source_copyrightids {
2888: return sort(keys(%scprtag));
2889: }
2890:
2891: =pod
2892:
1.648 raeburn 2893: =item * &source_copyrightdescription()
1.192 taceyjo1 2894:
2895: returns description of a specified source copyright id
2896:
2897: =cut
2898:
2899: sub source_copyrightdescription {
2900: return &mt($scprtag{shift(@_)});
2901: }
1.112 bowersj2 2902:
2903: =pod
2904:
1.648 raeburn 2905: =item * &filecategories()
1.112 bowersj2 2906:
2907: returns list of all file categories
2908:
2909: =cut
2910:
2911: sub filecategories {
2912: return sort(keys(%category_extensions));
2913: }
2914:
2915: =pod
2916:
1.648 raeburn 2917: =item * &filecategorytypes()
1.112 bowersj2 2918:
2919: returns list of file types belonging to a given file
2920: category
2921:
2922: =cut
2923:
2924: sub filecategorytypes {
1.356 albertel 2925: my ($cat) = @_;
2926: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2927: }
2928:
2929: =pod
2930:
1.648 raeburn 2931: =item * &fileembstyle()
1.112 bowersj2 2932:
2933: returns embedding style for a specified file type
2934:
2935: =cut
2936:
2937: sub fileembstyle {
2938: return $fe{lc(shift(@_))};
1.169 www 2939: }
2940:
1.351 www 2941: sub filemimetype {
2942: return $fm{lc(shift(@_))};
2943: }
2944:
1.169 www 2945:
2946: sub filecategoryselect {
2947: my ($name,$value)=@_;
1.189 matthew 2948: return &select_form($value,$name,
1.169 www 2949: '' => &mt('Any category'),
2950: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2951: }
2952:
2953: =pod
2954:
1.648 raeburn 2955: =item * &filedescription()
1.112 bowersj2 2956:
2957: returns description for a specified file type
2958:
2959: =cut
2960:
2961: sub filedescription {
1.188 matthew 2962: my $file_description = $fd{lc(shift())};
2963: $file_description =~ s:([\[\]]):~$1:g;
2964: return &mt($file_description);
1.112 bowersj2 2965: }
2966:
2967: =pod
2968:
1.648 raeburn 2969: =item * &filedescriptionex()
1.112 bowersj2 2970:
2971: returns description for a specified file type with
2972: extra formatting
2973:
2974: =cut
2975:
2976: sub filedescriptionex {
2977: my $ex=shift;
1.188 matthew 2978: my $file_description = $fd{lc($ex)};
2979: $file_description =~ s:([\[\]]):~$1:g;
2980: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2981: }
2982:
2983: # End of .tab access
2984: =pod
2985:
2986: =back
2987:
2988: =cut
2989:
2990: # ------------------------------------------------------------------ File Types
2991: sub fileextensions {
2992: return sort(keys(%fe));
2993: }
2994:
1.97 www 2995: # ----------------------------------------------------------- Display Languages
2996: # returns a hash with all desired display languages
2997: #
2998:
2999: sub display_languages {
3000: my %languages=();
1.695 raeburn 3001: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3002: $languages{$lang}=1;
1.97 www 3003: }
3004: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3005: if ($env{'form.displaylanguage'}) {
1.356 albertel 3006: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3007: $languages{$lang}=1;
1.97 www 3008: }
3009: }
3010: return %languages;
1.14 harris41 3011: }
3012:
1.582 albertel 3013: sub languages {
3014: my ($possible_langs) = @_;
1.695 raeburn 3015: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3016: if (!ref($possible_langs)) {
3017: if( wantarray ) {
3018: return @preferred_langs;
3019: } else {
3020: return $preferred_langs[0];
3021: }
3022: }
3023: my %possibilities = map { $_ => 1 } (@$possible_langs);
3024: my @preferred_possibilities;
3025: foreach my $preferred_lang (@preferred_langs) {
3026: if (exists($possibilities{$preferred_lang})) {
3027: push(@preferred_possibilities, $preferred_lang);
3028: }
3029: }
3030: if( wantarray ) {
3031: return @preferred_possibilities;
3032: }
3033: return $preferred_possibilities[0];
3034: }
3035:
1.112 bowersj2 3036: ###############################################################
3037: ## Student Answer Attempts ##
3038: ###############################################################
3039:
3040: =pod
3041:
3042: =head1 Alternate Problem Views
3043:
3044: =over 4
3045:
1.648 raeburn 3046: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3047: $getattempt, $regexp, $gradesub)
3048:
3049: Return string with previous attempt on problem. Arguments:
3050:
3051: =over 4
3052:
3053: =item * $symb: Problem, including path
3054:
3055: =item * $username: username of the desired student
3056:
3057: =item * $domain: domain of the desired student
1.14 harris41 3058:
1.112 bowersj2 3059: =item * $course: Course ID
1.14 harris41 3060:
1.112 bowersj2 3061: =item * $getattempt: Leave blank for all attempts, otherwise put
3062: something
1.14 harris41 3063:
1.112 bowersj2 3064: =item * $regexp: if string matches this regexp, the string will be
3065: sent to $gradesub
1.14 harris41 3066:
1.112 bowersj2 3067: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3068:
1.112 bowersj2 3069: =back
1.14 harris41 3070:
1.112 bowersj2 3071: The output string is a table containing all desired attempts, if any.
1.16 harris41 3072:
1.112 bowersj2 3073: =cut
1.1 albertel 3074:
3075: sub get_previous_attempt {
1.43 ng 3076: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3077: my $prevattempts='';
1.43 ng 3078: no strict 'refs';
1.1 albertel 3079: if ($symb) {
1.3 albertel 3080: my (%returnhash)=
3081: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3082: if ($returnhash{'version'}) {
3083: my %lasthash=();
3084: my $version;
3085: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3086: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3087: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3088: }
1.1 albertel 3089: }
1.596 albertel 3090: $prevattempts=&start_data_table().&start_data_table_header_row();
3091: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3092: foreach my $key (sort(keys(%lasthash))) {
3093: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3094: if ($#parts > 0) {
1.31 albertel 3095: my $data=$parts[-1];
3096: pop(@parts);
1.596 albertel 3097: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3098: } else {
1.41 ng 3099: if ($#parts == 0) {
3100: $prevattempts.='<th>'.$parts[0].'</th>';
3101: } else {
3102: $prevattempts.='<th>'.$ign.'</th>';
3103: }
1.31 albertel 3104: }
1.16 harris41 3105: }
1.596 albertel 3106: $prevattempts.=&end_data_table_header_row();
1.40 ng 3107: if ($getattempt eq '') {
3108: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3109: $prevattempts.=&start_data_table_row().
3110: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3111: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3112: my $value = &format_previous_attempt_value($key,
3113: $returnhash{$version.':'.$key});
3114: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3115: }
1.596 albertel 3116: $prevattempts.=&end_data_table_row();
1.40 ng 3117: }
1.1 albertel 3118: }
1.596 albertel 3119: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3120: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3121: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3122: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3123: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3124: }
1.596 albertel 3125: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3126: } else {
1.596 albertel 3127: $prevattempts=
3128: &start_data_table().&start_data_table_row().
3129: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3130: &end_data_table_row().&end_data_table();
1.1 albertel 3131: }
3132: } else {
1.596 albertel 3133: $prevattempts=
3134: &start_data_table().&start_data_table_row().
3135: '<td>'.&mt('No data.').'</td>'.
3136: &end_data_table_row().&end_data_table();
1.1 albertel 3137: }
1.10 albertel 3138: }
3139:
1.581 albertel 3140: sub format_previous_attempt_value {
3141: my ($key,$value) = @_;
3142: if ($key =~ /timestamp/) {
3143: $value = &Apache::lonlocal::locallocaltime($value);
3144: } elsif (ref($value) eq 'ARRAY') {
3145: $value = '('.join(', ', @{ $value }).')';
3146: } else {
3147: $value = &unescape($value);
3148: }
3149: return $value;
3150: }
3151:
3152:
1.107 albertel 3153: sub relative_to_absolute {
3154: my ($url,$output)=@_;
3155: my $parser=HTML::TokeParser->new(\$output);
3156: my $token;
3157: my $thisdir=$url;
3158: my @rlinks=();
3159: while ($token=$parser->get_token) {
3160: if ($token->[0] eq 'S') {
3161: if ($token->[1] eq 'a') {
3162: if ($token->[2]->{'href'}) {
3163: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3164: }
3165: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3166: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3167: } elsif ($token->[1] eq 'base') {
3168: $thisdir=$token->[2]->{'href'};
3169: }
3170: }
3171: }
3172: $thisdir=~s-/[^/]*$--;
1.356 albertel 3173: foreach my $link (@rlinks) {
3174: unless (($link=~/^http:\/\//i) ||
3175: ($link=~/^\//) ||
3176: ($link=~/^javascript:/i) ||
3177: ($link=~/^mailto:/i) ||
3178: ($link=~/^\#/)) {
3179: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3180: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3181: }
3182: }
3183: # -------------------------------------------------- Deal with Applet codebases
3184: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3185: return $output;
3186: }
3187:
1.112 bowersj2 3188: =pod
3189:
1.648 raeburn 3190: =item * &get_student_view()
1.112 bowersj2 3191:
3192: show a snapshot of what student was looking at
3193:
3194: =cut
3195:
1.10 albertel 3196: sub get_student_view {
1.186 albertel 3197: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3198: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3199: my (%form);
1.10 albertel 3200: my @elements=('symb','courseid','domain','username');
3201: foreach my $element (@elements) {
1.186 albertel 3202: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3203: }
1.186 albertel 3204: if (defined($moreenv)) {
3205: %form=(%form,%{$moreenv});
3206: }
1.236 albertel 3207: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3208: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3209: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3210: $userview=~s/\<body[^\>]*\>//gi;
3211: $userview=~s/\<\/body\>//gi;
3212: $userview=~s/\<html\>//gi;
3213: $userview=~s/\<\/html\>//gi;
3214: $userview=~s/\<head\>//gi;
3215: $userview=~s/\<\/head\>//gi;
3216: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3217: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3218: if (wantarray) {
3219: return ($userview,$response);
3220: } else {
3221: return $userview;
3222: }
3223: }
3224:
3225: sub get_student_view_with_retries {
3226: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3227:
3228: my $ok = 0; # True if we got a good response.
3229: my $content;
3230: my $response;
3231:
3232: # Try to get the student_view done. within the retries count:
3233:
3234: do {
3235: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3236: $ok = $response->is_success;
3237: if (!$ok) {
3238: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3239: }
3240: $retries--;
3241: } while (!$ok && ($retries > 0));
3242:
3243: if (!$ok) {
3244: $content = ''; # On error return an empty content.
3245: }
1.651 www 3246: if (wantarray) {
3247: return ($content, $response);
3248: } else {
3249: return $content;
3250: }
1.11 albertel 3251: }
3252:
1.112 bowersj2 3253: =pod
3254:
1.648 raeburn 3255: =item * &get_student_answers()
1.112 bowersj2 3256:
3257: show a snapshot of how student was answering problem
3258:
3259: =cut
3260:
1.11 albertel 3261: sub get_student_answers {
1.100 sakharuk 3262: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3263: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3264: my (%moreenv);
1.11 albertel 3265: my @elements=('symb','courseid','domain','username');
3266: foreach my $element (@elements) {
1.186 albertel 3267: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3268: }
1.186 albertel 3269: $moreenv{'grade_target'}='answer';
3270: %moreenv=(%form,%moreenv);
1.497 raeburn 3271: $feedurl = &Apache::lonnet::clutter($feedurl);
3272: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3273: return $userview;
1.1 albertel 3274: }
1.116 albertel 3275:
3276: =pod
3277:
3278: =item * &submlink()
3279:
1.242 albertel 3280: Inputs: $text $uname $udom $symb $target
1.116 albertel 3281:
3282: Returns: A link to grades.pm such as to see the SUBM view of a student
3283:
3284: =cut
3285:
3286: ###############################################
3287: sub submlink {
1.242 albertel 3288: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3289: if (!($uname && $udom)) {
3290: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3291: &Apache::lonnet::whichuser($symb);
1.116 albertel 3292: if (!$symb) { $symb=$cursymb; }
3293: }
1.254 matthew 3294: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3295: $symb=&escape($symb);
1.242 albertel 3296: if ($target) { $target="target=\"$target\""; }
3297: return '<a href="/adm/grades?&command=submission&'.
3298: 'symb='.$symb.'&student='.$uname.
3299: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3300: }
3301: ##############################################
3302:
3303: =pod
3304:
3305: =item * &pgrdlink()
3306:
3307: Inputs: $text $uname $udom $symb $target
3308:
3309: Returns: A link to grades.pm such as to see the PGRD view of a student
3310:
3311: =cut
3312:
3313: ###############################################
3314: sub pgrdlink {
3315: my $link=&submlink(@_);
3316: $link=~s/(&command=submission)/$1&showgrading=yes/;
3317: return $link;
3318: }
3319: ##############################################
3320:
3321: =pod
3322:
3323: =item * &pprmlink()
3324:
3325: Inputs: $text $uname $udom $symb $target
3326:
3327: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3328: student and a specific resource
1.242 albertel 3329:
3330: =cut
3331:
3332: ###############################################
3333: sub pprmlink {
3334: my ($text,$uname,$udom,$symb,$target)=@_;
3335: if (!($uname && $udom)) {
3336: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3337: &Apache::lonnet::whichuser($symb);
1.242 albertel 3338: if (!$symb) { $symb=$cursymb; }
3339: }
1.254 matthew 3340: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3341: $symb=&escape($symb);
1.242 albertel 3342: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3343: return '<a href="/adm/parmset?command=set&'.
3344: 'symb='.$symb.'&uname='.$uname.
3345: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3346: }
3347: ##############################################
1.37 matthew 3348:
1.112 bowersj2 3349: =pod
3350:
3351: =back
3352:
3353: =cut
3354:
1.37 matthew 3355: ###############################################
1.51 www 3356:
3357:
3358: sub timehash {
1.687 raeburn 3359: my ($thistime) = @_;
3360: my $timezone = &Apache::lonlocal::gettimezone();
3361: my $dt = DateTime->from_epoch(epoch => $thistime)
3362: ->set_time_zone($timezone);
3363: my $wday = $dt->day_of_week();
3364: if ($wday == 7) { $wday = 0; }
3365: return ( 'second' => $dt->second(),
3366: 'minute' => $dt->minute(),
3367: 'hour' => $dt->hour(),
3368: 'day' => $dt->day_of_month(),
3369: 'month' => $dt->month(),
3370: 'year' => $dt->year(),
3371: 'weekday' => $wday,
3372: 'dayyear' => $dt->day_of_year(),
3373: 'dlsav' => $dt->is_dst() );
1.51 www 3374: }
3375:
1.370 www 3376: sub utc_string {
3377: my ($date)=@_;
1.371 www 3378: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3379: }
3380:
1.51 www 3381: sub maketime {
3382: my %th=@_;
1.687 raeburn 3383: my ($epoch_time,$timezone,$dt);
3384: $timezone = &Apache::lonlocal::gettimezone();
3385: eval {
3386: $dt = DateTime->new( year => $th{'year'},
3387: month => $th{'month'},
3388: day => $th{'day'},
3389: hour => $th{'hour'},
3390: minute => $th{'minute'},
3391: second => $th{'second'},
3392: time_zone => $timezone,
3393: );
3394: };
3395: if (!$@) {
3396: $epoch_time = $dt->epoch;
3397: if ($epoch_time) {
3398: return $epoch_time;
3399: }
3400: }
1.51 www 3401: return POSIX::mktime(
3402: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3403: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3404: }
3405:
3406: #########################################
1.51 www 3407:
3408: sub findallcourses {
1.482 raeburn 3409: my ($roles,$uname,$udom) = @_;
1.355 albertel 3410: my %roles;
3411: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3412: my %courses;
1.51 www 3413: my $now=time;
1.482 raeburn 3414: if (!defined($uname)) {
3415: $uname = $env{'user.name'};
3416: }
3417: if (!defined($udom)) {
3418: $udom = $env{'user.domain'};
3419: }
3420: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3421: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3422: if (!%roles) {
3423: %roles = (
3424: cc => 1,
3425: in => 1,
3426: ep => 1,
3427: ta => 1,
3428: cr => 1,
3429: st => 1,
3430: );
3431: }
3432: foreach my $entry (keys(%roleshash)) {
3433: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3434: if ($trole =~ /^cr/) {
3435: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3436: } else {
3437: next if (!exists($roles{$trole}));
3438: }
3439: if ($tend) {
3440: next if ($tend < $now);
3441: }
3442: if ($tstart) {
3443: next if ($tstart > $now);
3444: }
3445: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3446: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3447: if ($secpart eq '') {
3448: ($cnum,$role) = split(/_/,$cnumpart);
3449: $sec = 'none';
3450: $realsec = '';
3451: } else {
3452: $cnum = $cnumpart;
3453: ($sec,$role) = split(/_/,$secpart);
3454: $realsec = $sec;
1.490 raeburn 3455: }
1.482 raeburn 3456: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3457: }
3458: } else {
3459: foreach my $key (keys(%env)) {
1.483 albertel 3460: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3461: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3462: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3463: next if ($role eq 'ca' || $role eq 'aa');
3464: next if (%roles && !exists($roles{$role}));
3465: my ($starttime,$endtime)=split(/\./,$env{$key});
3466: my $active=1;
3467: if ($starttime) {
3468: if ($now<$starttime) { $active=0; }
3469: }
3470: if ($endtime) {
3471: if ($now>$endtime) { $active=0; }
3472: }
3473: if ($active) {
3474: if ($sec eq '') {
3475: $sec = 'none';
3476: }
3477: $courses{$cdom.'_'.$cnum}{$sec} =
3478: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3479: }
3480: }
1.51 www 3481: }
3482: }
1.474 raeburn 3483: return %courses;
1.51 www 3484: }
1.37 matthew 3485:
1.54 www 3486: ###############################################
1.474 raeburn 3487:
3488: sub blockcheck {
1.482 raeburn 3489: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3490:
3491: if (!defined($udom)) {
3492: $udom = $env{'user.domain'};
3493: }
3494: if (!defined($uname)) {
3495: $uname = $env{'user.name'};
3496: }
3497:
3498: # If uname and udom are for a course, check for blocks in the course.
3499:
3500: if (&Apache::lonnet::is_course($udom,$uname)) {
3501: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3502: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3503: return ($startblock,$endblock);
3504: }
1.474 raeburn 3505:
1.502 raeburn 3506: my $startblock = 0;
3507: my $endblock = 0;
1.482 raeburn 3508: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3509:
1.490 raeburn 3510: # If uname is for a user, and activity is course-specific, i.e.,
3511: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3512:
1.490 raeburn 3513: if (($activity eq 'boards' || $activity eq 'chat' ||
3514: $activity eq 'groups') && ($env{'request.course.id'})) {
3515: foreach my $key (keys(%live_courses)) {
3516: if ($key ne $env{'request.course.id'}) {
3517: delete($live_courses{$key});
3518: }
3519: }
3520: }
3521:
3522: my $otheruser = 0;
3523: my %own_courses;
3524: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3525: # Resource belongs to user other than current user.
3526: $otheruser = 1;
3527: # Gather courses for current user
3528: %own_courses =
3529: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3530: }
3531:
3532: # Gather active course roles - course coordinator, instructor,
3533: # exam proctor, ta, student, or custom role.
1.474 raeburn 3534:
3535: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3536: my ($cdom,$cnum);
3537: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3538: $cdom = $env{'course.'.$course.'.domain'};
3539: $cnum = $env{'course.'.$course.'.num'};
3540: } else {
1.490 raeburn 3541: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3542: }
3543: my $no_ownblock = 0;
3544: my $no_userblock = 0;
1.533 raeburn 3545: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3546: # Check if current user has 'evb' priv for this
3547: if (defined($own_courses{$course})) {
3548: foreach my $sec (keys(%{$own_courses{$course}})) {
3549: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3550: if ($sec ne 'none') {
3551: $checkrole .= '/'.$sec;
3552: }
3553: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3554: $no_ownblock = 1;
3555: last;
3556: }
3557: }
3558: }
3559: # if they have 'evb' priv and are currently not playing student
3560: next if (($no_ownblock) &&
3561: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3562: }
1.474 raeburn 3563: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3564: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3565: if ($sec ne 'none') {
1.482 raeburn 3566: $checkrole .= '/'.$sec;
1.474 raeburn 3567: }
1.490 raeburn 3568: if ($otheruser) {
3569: # Resource belongs to user other than current user.
3570: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3571: my ($trole,$tdom,$tnum,$tsec);
3572: my $entry = $live_courses{$course}{$sec};
3573: if ($entry =~ /^cr/) {
3574: ($trole,$tdom,$tnum,$tsec) =
3575: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3576: } else {
3577: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3578: }
3579: my ($spec,$area,$trest,%allroles,%userroles);
3580: $area = '/'.$tdom.'/'.$tnum;
3581: $trest = $tnum;
3582: if ($tsec ne '') {
3583: $area .= '/'.$tsec;
3584: $trest .= '/'.$tsec;
3585: }
3586: $spec = $trole.'.'.$area;
3587: if ($trole =~ /^cr/) {
3588: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3589: $tdom,$spec,$trest,$area);
3590: } else {
3591: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3592: $tdom,$spec,$trest,$area);
3593: }
3594: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3595: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3596: if ($1) {
3597: $no_userblock = 1;
3598: last;
3599: }
3600: }
1.490 raeburn 3601: } else {
3602: # Resource belongs to current user
3603: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3604: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3605: $no_ownblock = 1;
3606: last;
3607: }
1.474 raeburn 3608: }
3609: }
3610: # if they have the evb priv and are currently not playing student
1.482 raeburn 3611: next if (($no_ownblock) &&
1.491 albertel 3612: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3613: next if ($no_userblock);
1.474 raeburn 3614:
1.490 raeburn 3615: # Retrieve blocking times and identity of blocker for course
3616: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3617:
3618: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3619: if (($start != 0) &&
3620: (($startblock == 0) || ($startblock > $start))) {
3621: $startblock = $start;
3622: }
3623: if (($end != 0) &&
3624: (($endblock == 0) || ($endblock < $end))) {
3625: $endblock = $end;
3626: }
1.490 raeburn 3627: }
3628: return ($startblock,$endblock);
3629: }
3630:
3631: sub get_blocks {
3632: my ($setters,$activity,$cdom,$cnum) = @_;
3633: my $startblock = 0;
3634: my $endblock = 0;
3635: my $course = $cdom.'_'.$cnum;
3636: $setters->{$course} = {};
3637: $setters->{$course}{'staff'} = [];
3638: $setters->{$course}{'times'} = [];
3639: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3640: foreach my $record (keys(%records)) {
3641: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3642: if ($start <= time && $end >= time) {
3643: my ($staff_name,$staff_dom,$title,$blocks) =
3644: &parse_block_record($records{$record});
3645: if ($blocks->{$activity} eq 'on') {
3646: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3647: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3648: if ( ($startblock == 0) || ($startblock > $start) ) {
3649: $startblock = $start;
1.490 raeburn 3650: }
1.491 albertel 3651: if ( ($endblock == 0) || ($endblock < $end) ) {
3652: $endblock = $end;
1.474 raeburn 3653: }
3654: }
3655: }
3656: }
3657: return ($startblock,$endblock);
3658: }
3659:
3660: sub parse_block_record {
3661: my ($record) = @_;
3662: my ($setuname,$setudom,$title,$blocks);
3663: if (ref($record) eq 'HASH') {
3664: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3665: $title = &unescape($record->{'event'});
3666: $blocks = $record->{'blocks'};
3667: } else {
3668: my @data = split(/:/,$record,3);
3669: if (scalar(@data) eq 2) {
3670: $title = $data[1];
3671: ($setuname,$setudom) = split(/@/,$data[0]);
3672: } else {
3673: ($setuname,$setudom,$title) = @data;
3674: }
3675: $blocks = { 'com' => 'on' };
3676: }
3677: return ($setuname,$setudom,$title,$blocks);
3678: }
3679:
3680: sub build_block_table {
3681: my ($startblock,$endblock,$setters) = @_;
3682: my %lt = &Apache::lonlocal::texthash(
3683: 'cacb' => 'Currently active communication blocks',
3684: 'cour' => 'Course',
3685: 'dura' => 'Duration',
3686: 'blse' => 'Block set by'
3687: );
3688: my $output;
1.476 raeburn 3689: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3690: $output .= &start_data_table();
3691: $output .= '
3692: <tr>
3693: <th>'.$lt{'cour'}.'</th>
3694: <th>'.$lt{'dura'}.'</th>
3695: <th>'.$lt{'blse'}.'</th>
3696: </tr>
3697: ';
3698: foreach my $course (keys(%{$setters})) {
3699: my %courseinfo=&Apache::lonnet::coursedescription($course);
3700: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3701: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3702: my $fullname = &plainname($uname,$udom);
3703: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3704: && $env{'user.name'} ne 'public'
3705: && $env{'user.domain'} ne 'public') {
3706: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3707: }
1.474 raeburn 3708: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3709: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3710: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3711: $output .= &Apache::loncommon::start_data_table_row().
3712: '<td>'.$courseinfo{'description'}.'</td>'.
3713: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3714: '<td>'.$fullname.'</td>'.
1.474 raeburn 3715: &Apache::loncommon::end_data_table_row();
3716: }
3717: }
3718: $output .= &end_data_table();
3719: }
3720:
1.490 raeburn 3721: sub blocking_status {
3722: my ($activity,$uname,$udom) = @_;
3723: my %setters;
3724: my ($blocked,$output,$ownitem,$is_course);
3725: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3726: if ($startblock && $endblock) {
3727: $blocked = 1;
3728: if (wantarray) {
3729: my $category;
3730: if ($activity eq 'boards') {
3731: $category = 'Discussion posts in this course';
3732: } elsif ($activity eq 'blogs') {
3733: $category = 'Blogs';
3734: } elsif ($activity eq 'port') {
3735: if (defined($uname) && defined($udom)) {
3736: if ($uname eq $env{'user.name'} &&
3737: $udom eq $env{'user.domain'}) {
3738: $ownitem = 1;
3739: }
3740: }
3741: $is_course = &Apache::lonnet::is_course($udom,$uname);
3742: if ($ownitem) {
3743: $category = 'Your portfolio files';
3744: } elsif ($is_course) {
3745: my $coursedesc;
3746: foreach my $course (keys(%setters)) {
3747: my %courseinfo =
3748: &Apache::lonnet::coursedescription($course);
3749: $coursedesc = $courseinfo{'description'};
3750: }
3751: $category = "Group files in the course '$coursedesc'";
3752: } else {
3753: $category = 'Portfolio files belonging to ';
3754: if ($env{'user.name'} eq 'public' &&
3755: $env{'user.domain'} eq 'public') {
3756: $category .= &plainname($uname,$udom);
3757: } else {
3758: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3759: }
3760: }
3761: } elsif ($activity eq 'groups') {
3762: $category = 'Groups in this course';
3763: }
3764: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3765: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3766: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3767: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3768: $output .= &build_block_table($startblock,$endblock,\%setters);
3769: }
3770: }
3771: }
3772: if (wantarray) {
3773: return ($blocked,$output);
3774: } else {
3775: return $blocked;
3776: }
3777: }
3778:
1.60 matthew 3779: ###############################################
3780:
1.682 raeburn 3781: sub check_ip_acc {
3782: my ($acc)=@_;
3783: &Apache::lonxml::debug("acc is $acc");
3784: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3785: return 1;
3786: }
3787: my $allowed=0;
3788: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3789:
3790: my $name;
3791: foreach my $pattern (split(',',$acc)) {
3792: $pattern =~ s/^\s*//;
3793: $pattern =~ s/\s*$//;
3794: if ($pattern =~ /\*$/) {
3795: #35.8.*
3796: $pattern=~s/\*//;
3797: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3798: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3799: #35.8.3.[34-56]
3800: my $low=$2;
3801: my $high=$3;
3802: $pattern=$1;
3803: if ($ip =~ /^\Q$pattern\E/) {
3804: my $last=(split(/\./,$ip))[3];
3805: if ($last <=$high && $last >=$low) { $allowed=1; }
3806: }
3807: } elsif ($pattern =~ /^\*/) {
3808: #*.msu.edu
3809: $pattern=~s/\*//;
3810: if (!defined($name)) {
3811: use Socket;
3812: my $netaddr=inet_aton($ip);
3813: ($name)=gethostbyaddr($netaddr,AF_INET);
3814: }
3815: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3816: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3817: #127.0.0.1
3818: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3819: } else {
3820: #some.name.com
3821: if (!defined($name)) {
3822: use Socket;
3823: my $netaddr=inet_aton($ip);
3824: ($name)=gethostbyaddr($netaddr,AF_INET);
3825: }
3826: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3827: }
3828: if ($allowed) { last; }
3829: }
3830: return $allowed;
3831: }
3832:
3833: ###############################################
3834:
1.60 matthew 3835: =pod
3836:
1.112 bowersj2 3837: =head1 Domain Template Functions
3838:
3839: =over 4
3840:
3841: =item * &determinedomain()
1.60 matthew 3842:
3843: Inputs: $domain (usually will be undef)
3844:
1.63 www 3845: Returns: Determines which domain should be used for designs
1.60 matthew 3846:
3847: =cut
1.54 www 3848:
1.60 matthew 3849: ###############################################
1.63 www 3850: sub determinedomain {
3851: my $domain=shift;
1.531 albertel 3852: if (! $domain) {
1.60 matthew 3853: # Determine domain if we have not been given one
3854: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3855: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3856: if ($env{'request.role.domain'}) {
3857: $domain=$env{'request.role.domain'};
1.60 matthew 3858: }
3859: }
1.63 www 3860: return $domain;
3861: }
3862: ###############################################
1.517 raeburn 3863:
1.518 albertel 3864: sub devalidate_domconfig_cache {
3865: my ($udom)=@_;
3866: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3867: }
3868:
3869: # ---------------------- Get domain configuration for a domain
3870: sub get_domainconf {
3871: my ($udom) = @_;
3872: my $cachetime=1800;
3873: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3874: if (defined($cached)) { return %{$result}; }
3875:
3876: my %domconfig = &Apache::lonnet::get_dom('configuration',
3877: ['login','rolecolors'],$udom);
1.632 raeburn 3878: my (%designhash,%legacy);
1.518 albertel 3879: if (keys(%domconfig) > 0) {
3880: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3881: if (keys(%{$domconfig{'login'}})) {
3882: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 ! raeburn 3883: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
! 3884: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
! 3885: $designhash{$udom.'.login.'.$key.'_'.$img} =
! 3886: $domconfig{'login'}{$key}{$img};
! 3887: }
! 3888: } else {
! 3889: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
! 3890: }
1.632 raeburn 3891: }
3892: } else {
3893: $legacy{'login'} = 1;
1.518 albertel 3894: }
1.632 raeburn 3895: } else {
3896: $legacy{'login'} = 1;
1.518 albertel 3897: }
3898: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3899: if (keys(%{$domconfig{'rolecolors'}})) {
3900: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3901: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3902: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3903: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3904: }
1.518 albertel 3905: }
3906: }
1.632 raeburn 3907: } else {
3908: $legacy{'rolecolors'} = 1;
1.518 albertel 3909: }
1.632 raeburn 3910: } else {
3911: $legacy{'rolecolors'} = 1;
1.518 albertel 3912: }
1.632 raeburn 3913: if (keys(%legacy) > 0) {
3914: my %legacyhash = &get_legacy_domconf($udom);
3915: foreach my $item (keys(%legacyhash)) {
3916: if ($item =~ /^\Q$udom\E\.login/) {
3917: if ($legacy{'login'}) {
3918: $designhash{$item} = $legacyhash{$item};
3919: }
3920: } else {
3921: if ($legacy{'rolecolors'}) {
3922: $designhash{$item} = $legacyhash{$item};
3923: }
1.518 albertel 3924: }
3925: }
3926: }
1.632 raeburn 3927: } else {
3928: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3929: }
3930: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3931: $cachetime);
3932: return %designhash;
3933: }
3934:
1.632 raeburn 3935: sub get_legacy_domconf {
3936: my ($udom) = @_;
3937: my %legacyhash;
3938: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3939: my $designfile = $designdir.'/'.$udom.'.tab';
3940: if (-e $designfile) {
3941: if ( open (my $fh,"<$designfile") ) {
3942: while (my $line = <$fh>) {
3943: next if ($line =~ /^\#/);
3944: chomp($line);
3945: my ($key,$val)=(split(/\=/,$line));
3946: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3947: }
3948: close($fh);
3949: }
3950: }
3951: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3952: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3953: }
3954: return %legacyhash;
3955: }
3956:
1.63 www 3957: =pod
3958:
1.112 bowersj2 3959: =item * &domainlogo()
1.63 www 3960:
3961: Inputs: $domain (usually will be undef)
3962:
3963: Returns: A link to a domain logo, if the domain logo exists.
3964: If the domain logo does not exist, a description of the domain.
3965:
3966: =cut
1.112 bowersj2 3967:
1.63 www 3968: ###############################################
3969: sub domainlogo {
1.517 raeburn 3970: my $domain = &determinedomain(shift);
1.518 albertel 3971: my %designhash = &get_domainconf($domain);
1.517 raeburn 3972: # See if there is a logo
3973: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3974: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3975: if ($imgsrc =~ m{^/(adm|res)/}) {
3976: if ($imgsrc =~ m{^/res/}) {
3977: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3978: &Apache::lonnet::repcopy($local_name);
3979: }
3980: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3981: }
3982: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3983: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3984: return &Apache::lonnet::domain($domain,'description');
1.59 www 3985: } else {
1.60 matthew 3986: return '';
1.59 www 3987: }
3988: }
1.63 www 3989: ##############################################
3990:
3991: =pod
3992:
1.112 bowersj2 3993: =item * &designparm()
1.63 www 3994:
3995: Inputs: $which parameter; $domain (usually will be undef)
3996:
3997: Returns: value of designparamter $which
3998:
3999: =cut
1.112 bowersj2 4000:
1.397 albertel 4001:
1.400 albertel 4002: ##############################################
1.397 albertel 4003: sub designparm {
4004: my ($which,$domain)=@_;
1.258 albertel 4005: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4006: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4007: return '#000000';
4008: }
1.635 raeburn 4009: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4010: return '#FFFFFF';
4011: }
4012: if ($which=~/\.tabbg$/) {
4013: return '#CCCCCC';
4014: }
4015: }
1.397 albertel 4016: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4017: return $env{'environment.color.'.$which};
1.96 www 4018: }
1.63 www 4019: $domain=&determinedomain($domain);
1.518 albertel 4020: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4021: my $output;
1.517 raeburn 4022: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4023: $output = $domdesign{$domain.'.'.$which};
1.63 www 4024: } else {
1.520 raeburn 4025: $output = $defaultdesign{$which};
4026: }
4027: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4028: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4029: if ($output =~ m{^/(adm|res)/}) {
4030: if ($output =~ m{^/res/}) {
4031: my $local_name = &Apache::lonnet::filelocation('',$output);
4032: &Apache::lonnet::repcopy($local_name);
4033: }
1.520 raeburn 4034: $output = &lonhttpdurl($output);
4035: }
1.63 www 4036: }
1.520 raeburn 4037: return $output;
1.63 www 4038: }
1.59 www 4039:
1.60 matthew 4040: ###############################################
4041: ###############################################
4042:
4043: =pod
4044:
1.112 bowersj2 4045: =back
4046:
1.549 albertel 4047: =head1 HTML Helpers
1.112 bowersj2 4048:
4049: =over 4
4050:
4051: =item * &bodytag()
1.60 matthew 4052:
4053: Returns a uniform header for LON-CAPA web pages.
4054:
4055: Inputs:
4056:
1.112 bowersj2 4057: =over 4
4058:
4059: =item * $title, A title to be displayed on the page.
4060:
4061: =item * $function, the current role (can be undef).
4062:
4063: =item * $addentries, extra parameters for the <body> tag.
4064:
4065: =item * $bodyonly, if defined, only return the <body> tag.
4066:
4067: =item * $domain, if defined, force a given domain.
4068:
4069: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4070: text interface only)
1.60 matthew 4071:
1.326 albertel 4072: =item * $customtitle, alternate text to use instead of $title
4073: in the title box that appears, this text
4074: is not auto translated like the $title is
1.309 albertel 4075:
4076: =item * $notopbar, if true, keep the 'what is this' info but remove the
4077: navigational links
1.317 albertel 4078:
1.338 albertel 4079: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4080:
4081: =item * $notitle, if true keep the nav controls, but remove the title bar
4082:
1.361 albertel 4083: =item * $no_inline_link, if true and in remote mode, don't show the
4084: 'Switch To Inline Menu' link
4085:
1.460 albertel 4086: =item * $args, optional argument valid values are
4087: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4088: inherit_jsmath -> when creating popup window in a page,
4089: should it have jsmath forced on by the
4090: current page
1.460 albertel 4091:
1.112 bowersj2 4092: =back
4093:
1.60 matthew 4094: Returns: A uniform header for LON-CAPA web pages.
4095: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4096: If $bodyonly is undef or zero, an html string containing a <body> tag and
4097: other decorations will be returned.
4098:
4099: =cut
4100:
1.54 www 4101: sub bodytag {
1.309 albertel 4102: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4103: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4104:
1.460 albertel 4105: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4106:
1.183 matthew 4107: $function = &get_users_function() if (!$function);
1.339 albertel 4108: my $img = &designparm($function.'.img',$domain);
4109: my $font = &designparm($function.'.font',$domain);
4110: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4111:
4112: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4113: 'bgcolor' => $pgbg,
1.339 albertel 4114: 'text' => $font,
4115: 'alink' => &designparm($function.'.alink',$domain),
4116: 'vlink' => &designparm($function.'.vlink',$domain),
4117: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4118: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4119:
1.63 www 4120: # role and realm
1.378 raeburn 4121: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4122: if ($role eq 'ca') {
1.479 albertel 4123: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4124: $realm = &plainname($rname,$rdom);
1.378 raeburn 4125: }
1.55 www 4126: # realm
1.258 albertel 4127: if ($env{'request.course.id'}) {
1.378 raeburn 4128: if ($env{'request.role'} !~ /^cr/) {
4129: $role = &Apache::lonnet::plaintext($role,&course_type());
4130: }
1.359 albertel 4131: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4132: } else {
4133: $role = &Apache::lonnet::plaintext($role);
1.54 www 4134: }
1.433 albertel 4135:
1.359 albertel 4136: if (!$realm) { $realm=' '; }
1.55 www 4137: # Set messages
1.60 matthew 4138: my $messages=&domainlogo($domain);
1.330 albertel 4139:
1.438 albertel 4140: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4141:
1.101 www 4142: # construct main body tag
1.359 albertel 4143: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4144: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4145:
1.530 albertel 4146: if ($bodyonly) {
1.60 matthew 4147: return $bodytag;
1.258 albertel 4148: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4149: # Accessibility
1.224 raeburn 4150:
1.337 albertel 4151: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4152: if (!$notitle) {
1.337 albertel 4153: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4154: }
4155: return $bodytag;
1.359 albertel 4156: }
4157:
1.410 albertel 4158: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4159: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4160: undef($role);
1.434 albertel 4161: } else {
4162: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4163: }
1.359 albertel 4164:
4165: my $roleinfo=(<<ENDROLE);
4166: <td class="LC_title_bar_who">
4167: <div class="LC_title_bar_name">
1.410 albertel 4168: $name
1.361 albertel 4169:
1.359 albertel 4170: </div>
4171: <div class="LC_title_bar_role">
1.361 albertel 4172: $role
1.359 albertel 4173: </div>
4174: <div class="LC_title_bar_realm">
1.361 albertel 4175: $realm
1.359 albertel 4176: </div>
1.206 albertel 4177: </td>
4178: ENDROLE
1.235 raeburn 4179:
1.359 albertel 4180: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4181: if ($customtitle) {
4182: $titleinfo = $customtitle;
4183: }
4184: #
4185: # Extra info if you are the DC
4186: my $dc_info = '';
4187: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4188: $env{'course.'.$env{'request.course.id'}.
4189: '.domain'}.'/'})) {
4190: my $cid = $env{'request.course.id'};
4191: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4192: $dc_info =~ s/\s+$//;
1.359 albertel 4193: $dc_info = '('.$dc_info.')';
4194: }
4195:
1.644 www 4196: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4197: # No Remote
1.258 albertel 4198: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4199: $forcereg=1;
4200: }
4201:
4202: if (!$customtitle && $env{'request.state'} eq 'construct') {
4203: # this is for resources; directories have customtitle, and crumbs
4204: # and select recent are created in lonpubdir.pm
1.229 albertel 4205: my ($uname,$thisdisfn)=
1.258 albertel 4206: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4207: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4208: $formaction=~s/\/+/\//g;
4209:
1.359 albertel 4210: my $parentpath = '';
4211: my $lastitem = '';
4212: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4213: $parentpath = $1;
4214: $lastitem = $2;
4215: } else {
4216: $lastitem = $thisdisfn;
4217: }
4218: $titleinfo =
1.640 bisitz 4219: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4220: .'<b>'.&mt('Construction Space').'</b>: '
4221: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4222: .'" target="_top"><tt><b>'
4223: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
4224: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4225: .'</form>'
4226: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4227: }
1.359 albertel 4228:
1.337 albertel 4229: my $titletable;
1.338 albertel 4230: if (!$notitle) {
1.337 albertel 4231: $titletable =
1.359 albertel 4232: '<table id="LC_title_bar">'.
4233: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4234: '</tr></table>';
1.337 albertel 4235: }
1.359 albertel 4236: if ($notopbar) {
4237: $bodytag .= $titletable;
4238: } else {
4239: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4240: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4241: $titletable);
1.272 raeburn 4242: } else {
1.336 albertel 4243: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4244: $titletable;
1.272 raeburn 4245: }
1.235 raeburn 4246: }
4247: return $bodytag;
1.94 www 4248: }
1.95 www 4249:
1.93 www 4250: #
1.95 www 4251: # Top frame rendering, Remote is up
1.93 www 4252: #
1.359 albertel 4253:
1.517 raeburn 4254: my $imgsrc = $img;
4255: if ($img =~ /^\/adm/) {
1.575 albertel 4256: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4257: }
4258: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4259:
1.305 www 4260: # Explicit link to get inline menu
1.361 albertel 4261: my $menu= ($no_inline_link?''
4262: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4263: #
1.338 albertel 4264: if ($notitle) {
1.337 albertel 4265: return $bodytag;
4266: }
1.94 www 4267: return(<<ENDBODY);
1.60 matthew 4268: $bodytag
1.359 albertel 4269: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4270: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4271: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4272: </tr>
1.359 albertel 4273: <tr><td>$titleinfo $dc_info $menu</td>
4274: $roleinfo
1.368 albertel 4275: </tr>
1.356 albertel 4276: </table>
1.54 www 4277: ENDBODY
1.182 matthew 4278: }
4279:
1.330 albertel 4280: sub make_attr_string {
4281: my ($register,$attr_ref) = @_;
4282:
4283: if ($attr_ref && !ref($attr_ref)) {
4284: die("addentries Must be a hash ref ".
4285: join(':',caller(1))." ".
4286: join(':',caller(0))." ");
4287: }
4288:
4289: if ($register) {
1.339 albertel 4290: my ($on_load,$on_unload);
4291: foreach my $key (keys(%{$attr_ref})) {
4292: if (lc($key) eq 'onload') {
4293: $on_load.=$attr_ref->{$key}.';';
4294: delete($attr_ref->{$key});
4295:
4296: } elsif (lc($key) eq 'onunload') {
4297: $on_unload.=$attr_ref->{$key}.';';
4298: delete($attr_ref->{$key});
4299: }
4300: }
4301: $attr_ref->{'onload'} =
4302: &Apache::lonmenu::loadevents(). $on_load;
4303: $attr_ref->{'onunload'}=
4304: &Apache::lonmenu::unloadevents().$on_unload;
4305: }
4306:
4307: # Accessibility font enhance
4308: if ($env{'browser.fontenhance'} eq 'on') {
4309: my $style;
4310: foreach my $key (keys(%{$attr_ref})) {
4311: if (lc($key) eq 'style') {
4312: $style.=$attr_ref->{$key}.';';
4313: delete($attr_ref->{$key});
4314: }
4315: }
4316: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4317: }
1.339 albertel 4318:
4319: if ($env{'browser.blackwhite'} eq 'on') {
4320: delete($attr_ref->{'font'});
4321: delete($attr_ref->{'link'});
4322: delete($attr_ref->{'alink'});
4323: delete($attr_ref->{'vlink'});
4324: delete($attr_ref->{'bgcolor'});
4325: delete($attr_ref->{'background'});
4326: }
4327:
1.330 albertel 4328: my $attr_string;
4329: foreach my $attr (keys(%$attr_ref)) {
4330: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4331: }
4332: return $attr_string;
4333: }
4334:
4335:
1.182 matthew 4336: ###############################################
1.251 albertel 4337: ###############################################
4338:
4339: =pod
4340:
4341: =item * &endbodytag()
4342:
4343: Returns a uniform footer for LON-CAPA web pages.
4344:
1.635 raeburn 4345: Inputs: 1 - optional reference to an args hash
4346: If in the hash, key for noredirectlink has a value which evaluates to true,
4347: a 'Continue' link is not displayed if the page contains an
4348: internal redirect in the <head></head> section,
4349: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4350:
4351: =cut
4352:
4353: sub endbodytag {
1.635 raeburn 4354: my ($args) = @_;
1.251 albertel 4355: my $endbodytag='</body>';
1.269 albertel 4356: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4357: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4358: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4359: $endbodytag=
4360: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4361: &mt('Continue').'</a>'.
4362: $endbodytag;
4363: }
1.315 albertel 4364: }
1.251 albertel 4365: return $endbodytag;
4366: }
4367:
1.352 albertel 4368: =pod
4369:
4370: =item * &standard_css()
4371:
4372: Returns a style sheet
4373:
4374: Inputs: (all optional)
4375: domain -> force to color decorate a page for a specific
4376: domain
4377: function -> force usage of a specific rolish color scheme
4378: bgcolor -> override the default page bgcolor
4379:
4380: =cut
4381:
1.343 albertel 4382: sub standard_css {
1.345 albertel 4383: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4384: $function = &get_users_function() if (!$function);
4385: my $img = &designparm($function.'.img', $domain);
4386: my $tabbg = &designparm($function.'.tabbg', $domain);
4387: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4388: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4389: my $pgbg_or_bgcolor =
4390: $bgcolor ||
1.352 albertel 4391: &designparm($function.'.pgbg', $domain);
1.382 albertel 4392: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4393: my $alink = &designparm($function.'.alink', $domain);
4394: my $vlink = &designparm($function.'.vlink', $domain);
4395: my $link = &designparm($function.'.link', $domain);
4396:
1.602 albertel 4397: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4398: my $mono = 'monospace';
1.352 albertel 4399: my $data_table_head = $tabbg;
4400: my $data_table_light = '#EEEEEE';
1.470 banghart 4401: my $data_table_dark = '#DDDDDD';
4402: my $data_table_darker = '#CCCCCC';
1.349 albertel 4403: my $data_table_highlight = '#FFFF00';
1.352 albertel 4404: my $mail_new = '#FFBB77';
4405: my $mail_new_hover = '#DD9955';
4406: my $mail_read = '#BBBB77';
4407: my $mail_read_hover = '#999944';
4408: my $mail_replied = '#AAAA88';
4409: my $mail_replied_hover = '#888855';
4410: my $mail_other = '#99BBBB';
4411: my $mail_other_hover = '#669999';
1.391 albertel 4412: my $table_header = '#DDDDDD';
1.489 raeburn 4413: my $feedback_link_bg = '#BBBBBB';
1.698 harmsja 4414: my $lg_border_color = '#D5FF6F';
1.392 albertel 4415:
1.608 albertel 4416: my $border = ($env{'browser.type'} eq 'explorer' ||
4417: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4418: : '0px 3px 0px 4px';
1.448 albertel 4419:
1.523 albertel 4420:
1.343 albertel 4421: return <<END;
1.698 harmsja 4422: body{
4423: font-family: $sans;
4424: line-height:130%;
4425: font-size:0.8em;
4426: color:$font;
4427: }
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.593 albertel 4445: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4446: .LC_error {
4447: color: red;
4448: font-size: larger;
4449: }
1.457 albertel 4450: .LC_warning,
4451: .LC_diff_removed {
1.394 albertel 4452: color: red;
4453: }
1.532 albertel 4454:
4455: .LC_info,
1.457 albertel 4456: .LC_success,
4457: .LC_diff_added {
1.350 albertel 4458: color: green;
4459: }
1.543 albertel 4460: .LC_unknown {
4461: color: yellow;
4462: }
4463:
1.440 albertel 4464: .LC_icon {
4465: border: 0px;
4466: }
1.539 albertel 4467: .LC_indexer_icon {
4468: border: 0px;
4469: height: 22px;
4470: }
1.543 albertel 4471: .LC_docs_spacer {
4472: width: 25px;
4473: height: 1px;
4474: border: 0px;
4475: }
1.346 albertel 4476:
1.532 albertel 4477: .LC_internal_info {
4478: color: #999;
4479: }
4480:
1.458 albertel 4481: table.LC_pastsubmission {
4482: border: 1px solid black;
4483: margin: 2px;
4484: }
4485:
1.606 albertel 4486: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4487: width: 100%;
4488: background: $pgbg;
1.392 albertel 4489: border: 2px;
1.402 albertel 4490: border-collapse: separate;
1.403 albertel 4491: padding: 0px;
1.345 albertel 4492: }
1.392 albertel 4493:
1.606 albertel 4494: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4495: table#LC_title_bar.LC_with_remote {
1.359 albertel 4496: width: 100%;
1.392 albertel 4497: border-color: $pgbg;
4498: border-style: solid;
4499: border-width: $border;
4500:
1.379 albertel 4501: background: $pgbg;
4502: font-family: $sans;
1.392 albertel 4503: border-collapse: collapse;
1.403 albertel 4504: padding: 0px;
1.359 albertel 4505: }
1.392 albertel 4506:
1.409 albertel 4507: table.LC_docs_path {
4508: width: 100%;
4509: border: 0;
4510: background: $pgbg;
4511: font-family: $sans;
4512: border-collapse: collapse;
4513: padding: 0px;
4514: }
4515:
1.359 albertel 4516: table#LC_title_bar td {
4517: background: $tabbg;
4518: }
4519: table#LC_title_bar td.LC_title_bar_who {
4520: background: $tabbg;
4521: color: $font;
1.427 albertel 4522: font: small $sans;
1.359 albertel 4523: text-align: right;
4524: }
1.469 banghart 4525: span.LC_metadata {
4526: font-family: $sans;
4527: }
1.359 albertel 4528: span.LC_title_bar_title {
1.416 albertel 4529: font: bold x-large $sans;
1.359 albertel 4530: }
4531: table#LC_title_bar td.LC_title_bar_domain_logo {
4532: background: $sidebg;
4533: text-align: right;
1.368 albertel 4534: padding: 0px;
4535: }
4536: table#LC_title_bar td.LC_title_bar_role_logo {
4537: background: $sidebg;
4538: padding: 0px;
1.359 albertel 4539: }
4540:
1.346 albertel 4541: table#LC_menubuttons_mainmenu {
1.526 www 4542: width: 100%;
1.346 albertel 4543: border: 0px;
4544: border-spacing: 1px;
1.372 albertel 4545: padding: 0px 1px;
1.346 albertel 4546: margin: 0px;
4547: border-collapse: separate;
4548: }
4549: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
4550: border: 0px;
4551: }
1.345 albertel 4552: table#LC_top_nav td {
4553: background: $tabbg;
1.392 albertel 4554: border: 0px;
1.407 albertel 4555: font-size: small;
1.345 albertel 4556: }
4557: table#LC_top_nav td a, div#LC_top_nav a {
4558: color: $font;
4559: font-family: $sans;
4560: }
1.364 albertel 4561: table#LC_top_nav td.LC_top_nav_logo {
4562: background: $tabbg;
1.432 albertel 4563: text-align: left;
1.408 albertel 4564: white-space: nowrap;
1.432 albertel 4565: width: 31px;
1.408 albertel 4566: }
4567: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4568: border: 0px;
1.408 albertel 4569: vertical-align: bottom;
1.364 albertel 4570: }
1.432 albertel 4571: table#LC_top_nav td.LC_top_nav_exit,
4572: table#LC_top_nav td.LC_top_nav_help {
4573: width: 2.0em;
4574: }
1.442 albertel 4575: table#LC_top_nav td.LC_top_nav_login {
4576: width: 4.0em;
4577: text-align: center;
4578: }
1.409 albertel 4579: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4580: background: $tabbg;
4581: color: $font;
4582: font-family: $sans;
1.358 albertel 4583: font-size: smaller;
1.357 albertel 4584: }
1.411 albertel 4585: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4586: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4587: background: $tabbg;
4588: color: $font;
4589: font-family: $sans;
4590: font-size: larger;
4591: text-align: right;
4592: }
1.383 albertel 4593: td.LC_table_cell_checkbox {
4594: text-align: center;
4595: }
1.522 albertel 4596: table#LC_mainmenu td.LC_mainmenu_column {
4597: vertical-align: top;
4598: }
4599:
1.346 albertel 4600: .LC_menubuttons_inline_text {
4601: color: $font;
4602: font-family: $sans;
1.698 harmsja 4603: font-size: 90%;
1.346 albertel 4604: }
4605:
1.526 www 4606: .LC_menubuttons_link {
4607: text-decoration: none;
4608: }
1.698 harmsja 4609: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4610: .LC_menubuttons_category {
1.521 www 4611: color: $font;
1.526 www 4612: background: $pgbg;
1.521 www 4613: font-family: $sans;
4614: font-size: larger;
4615: font-weight: bold;
4616: }
4617:
1.346 albertel 4618: td.LC_menubuttons_text {
1.698 harmsja 4619: color: $font;
4620: width: 90%;
1.346 albertel 4621: }
4622: td.LC_menubuttons_img {
4623: }
1.526 www 4624:
1.346 albertel 4625: .LC_current_location {
4626: font-family: $sans;
4627: background: $tabbg;
4628: }
4629: .LC_new_mail {
4630: font-family: $sans;
1.634 www 4631: background: $tabbg;
1.346 albertel 4632: font-weight: bold;
4633: }
1.347 albertel 4634:
1.526 www 4635: .LC_rolesmenu_is {
4636: font-family: $sans;
4637: }
4638:
4639: .LC_rolesmenu_selected {
4640: font-family: $sans;
4641: }
4642:
4643: .LC_rolesmenu_future {
4644: font-family: $sans;
4645: }
4646:
4647:
4648: .LC_rolesmenu_will {
4649: font-family: $sans;
4650: }
4651:
4652: .LC_rolesmenu_will_not {
4653: font-family: $sans;
4654: }
4655:
4656: .LC_rolesmenu_expired {
4657: font-family: $sans;
4658: }
4659:
4660: .LC_rolesinfo {
4661: font-family: $sans;
4662: }
4663:
1.527 www 4664: .LC_dropadd_labeltext {
4665: font-family: $sans;
4666: text-align: right;
4667: }
4668:
4669: .LC_preferences_labeltext {
4670: font-family: $sans;
4671: text-align: right;
4672: }
4673:
1.666 raeburn 4674: .LC_roleslog_note {
4675: font-size: smaller;
4676: }
4677:
1.440 albertel 4678: table.LC_aboutme_port {
4679: border: 0px;
4680: border-collapse: collapse;
4681: border-spacing: 0px;
4682: }
1.349 albertel 4683: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4684: border: 1px solid #000000;
1.402 albertel 4685: border-collapse: separate;
1.426 albertel 4686: border-spacing: 1px;
1.610 albertel 4687: background: $pgbg;
1.347 albertel 4688: }
1.422 albertel 4689: .LC_data_table_dense {
4690: font-size: small;
4691: }
1.507 raeburn 4692: table.LC_nested_outer {
4693: border: 1px solid #000000;
1.589 raeburn 4694: border-collapse: collapse;
1.507 raeburn 4695: border-spacing: 0px;
4696: width: 100%;
4697: }
4698: table.LC_nested {
4699: border: 0px;
1.589 raeburn 4700: border-collapse: collapse;
1.507 raeburn 4701: border-spacing: 0px;
4702: width: 100%;
4703: }
1.523 albertel 4704: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4705: table.LC_prior_tries tr th {
1.349 albertel 4706: font-weight: bold;
4707: background-color: $data_table_head;
1.421 albertel 4708: font-size: smaller;
1.347 albertel 4709: }
1.610 albertel 4710: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4711: table.LC_aboutme_port tr td {
1.349 albertel 4712: background-color: $data_table_light;
1.425 albertel 4713: padding: 2px;
1.347 albertel 4714: }
1.610 albertel 4715: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4716: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4717: background-color: $data_table_dark;
1.347 albertel 4718: }
1.425 albertel 4719: table.LC_data_table tr.LC_data_table_highlight td {
4720: background-color: $data_table_darker;
4721: }
1.639 raeburn 4722: table.LC_data_table tr td.LC_leftcol_header {
4723: background-color: $data_table_head;
4724: font-weight: bold;
4725: }
1.451 albertel 4726: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4727: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4728: background-color: #FFFFFF;
1.421 albertel 4729: font-weight: bold;
4730: font-style: italic;
4731: text-align: center;
4732: padding: 8px;
1.347 albertel 4733: }
1.507 raeburn 4734: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4735: padding: 4ex
4736: }
1.507 raeburn 4737: table.LC_nested_outer tr th {
4738: font-weight: bold;
4739: background-color: $data_table_head;
4740: font-size: smaller;
4741: border-bottom: 1px solid #000000;
4742: }
4743: table.LC_nested_outer tr td.LC_subheader {
4744: background-color: $data_table_head;
4745: font-weight: bold;
4746: font-size: small;
4747: border-bottom: 1px solid #000000;
4748: text-align: right;
1.451 albertel 4749: }
1.507 raeburn 4750: table.LC_nested tr.LC_info_row td {
1.451 albertel 4751: background-color: #CCC;
4752: font-weight: bold;
4753: font-size: small;
1.507 raeburn 4754: text-align: center;
4755: }
1.589 raeburn 4756: table.LC_nested tr.LC_info_row td.LC_left_item,
4757: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4758: text-align: left;
1.451 albertel 4759: }
1.507 raeburn 4760: table.LC_nested td {
1.451 albertel 4761: background-color: #FFF;
4762: font-size: small;
1.507 raeburn 4763: }
4764: table.LC_nested_outer tr th.LC_right_item,
4765: table.LC_nested tr.LC_info_row td.LC_right_item,
4766: table.LC_nested tr.LC_odd_row td.LC_right_item,
4767: table.LC_nested tr td.LC_right_item {
1.451 albertel 4768: text-align: right;
4769: }
4770:
1.507 raeburn 4771: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4772: background-color: #EEE;
4773: }
4774:
1.473 raeburn 4775: table.LC_createuser {
4776: }
4777:
4778: table.LC_createuser tr.LC_section_row td {
4779: font-size: smaller;
4780: }
4781:
4782: table.LC_createuser tr.LC_info_row td {
4783: background-color: #CCC;
4784: font-weight: bold;
4785: text-align: center;
4786: }
4787:
1.349 albertel 4788: table.LC_calendar {
4789: border: 1px solid #000000;
4790: border-collapse: collapse;
4791: }
4792: table.LC_calendar_pickdate {
4793: font-size: xx-small;
4794: }
4795: table.LC_calendar tr td {
4796: border: 1px solid #000000;
4797: vertical-align: top;
4798: }
4799: table.LC_calendar tr td.LC_calendar_day_empty {
4800: background-color: $data_table_dark;
4801: }
4802: table.LC_calendar tr td.LC_calendar_day_current {
4803: background-color: $data_table_highlight;
4804: }
4805:
4806: table.LC_mail_list tr.LC_mail_new {
4807: background-color: $mail_new;
4808: }
4809: table.LC_mail_list tr.LC_mail_new:hover {
4810: background-color: $mail_new_hover;
4811: }
4812: table.LC_mail_list tr.LC_mail_read {
4813: background-color: $mail_read;
4814: }
4815: table.LC_mail_list tr.LC_mail_read:hover {
4816: background-color: $mail_read_hover;
4817: }
4818: table.LC_mail_list tr.LC_mail_replied {
4819: background-color: $mail_replied;
4820: }
4821: table.LC_mail_list tr.LC_mail_replied:hover {
4822: background-color: $mail_replied_hover;
4823: }
4824: table.LC_mail_list tr.LC_mail_other {
4825: background-color: $mail_other;
4826: }
4827: table.LC_mail_list tr.LC_mail_other:hover {
4828: background-color: $mail_other_hover;
4829: }
1.494 raeburn 4830: table.LC_mail_list tr.LC_mail_even {
4831: }
4832: table.LC_mail_list tr.LC_mail_odd {
4833: }
4834:
1.391 albertel 4835: table#LC_cstr_controls {
4836: width: 100%;
4837: border-collapse: collapse;
4838: }
4839: table#LC_cstr_controls tr td {
4840: border: 4px solid $pgbg;
4841: padding: 4px;
4842: text-align: center;
4843: background: $tabbg;
4844: }
4845: table#LC_cstr_controls tr th {
4846: border: 4px solid $pgbg;
4847: background: $table_header;
4848: text-align: center;
4849: font-family: $sans;
4850: font-size: smaller;
4851: }
4852:
1.696 bisitz 4853: table.LC_data_table tr > td.LC_browser_file,
4854: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4855: background: #CCFF88;
4856: }
1.696 bisitz 4857: table.LC_data_table tr > td.LC_browser_file_locked,
4858: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4859: background: #FFAA99;
1.387 albertel 4860: }
1.696 bisitz 4861: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4862: background: #AAAAAA;
1.387 albertel 4863: }
1.696 bisitz 4864: table.LC_data_table tr > td.LC_browser_file_modified,
4865: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4866: background: #FFFF77;
1.387 albertel 4867: }
1.696 bisitz 4868: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4869: background: #CCCCFF;
1.387 albertel 4870: }
1.696 bisitz 4871:
1.388 albertel 4872: span.LC_current_location {
4873: font-size: x-large;
4874: background: $pgbg;
4875: }
1.387 albertel 4876:
1.395 albertel 4877: span.LC_parm_menu_item {
4878: font-size: larger;
4879: font-family: $sans;
4880: }
4881: span.LC_parm_scope_all {
4882: color: red;
4883: }
4884: span.LC_parm_scope_folder {
4885: color: green;
4886: }
4887: span.LC_parm_scope_resource {
4888: color: orange;
4889: }
4890: span.LC_parm_part {
4891: color: blue;
4892: }
4893: span.LC_parm_folder, span.LC_parm_symb {
4894: font-size: x-small;
4895: font-family: $mono;
4896: color: #AAAAAA;
4897: }
4898:
1.396 albertel 4899: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4900: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4901: border: 1px solid black;
4902: border-collapse: collapse;
4903: }
4904: table.LC_parm_overview_restrictions td {
4905: border-width: 1px 4px 1px 4px;
4906: border-style: solid;
4907: border-color: $pgbg;
4908: text-align: center;
4909: }
4910: table.LC_parm_overview_restrictions th {
4911: background: $tabbg;
4912: border-width: 1px 4px 1px 4px;
4913: border-style: solid;
4914: border-color: $pgbg;
4915: }
1.398 albertel 4916: table#LC_helpmenu {
4917: border: 0px;
4918: height: 55px;
4919: border-spacing: 0px;
4920: }
4921:
4922: table#LC_helpmenu fieldset legend {
4923: font-size: larger;
4924: font-weight: bold;
4925: }
1.397 albertel 4926: table#LC_helpmenu_links {
4927: width: 100%;
4928: border: 1px solid black;
4929: background: $pgbg;
4930: padding: 0px;
4931: border-spacing: 1px;
4932: }
4933: table#LC_helpmenu_links tr td {
4934: padding: 1px;
4935: background: $tabbg;
1.399 albertel 4936: text-align: center;
4937: font-weight: bold;
1.397 albertel 4938: }
1.396 albertel 4939:
1.397 albertel 4940: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4941: table#LC_helpmenu_links a:active {
4942: text-decoration: none;
4943: color: $font;
4944: }
4945: table#LC_helpmenu_links a:hover {
4946: text-decoration: underline;
4947: color: $vlink;
4948: }
1.396 albertel 4949:
1.417 albertel 4950: .LC_chrt_popup_exists {
4951: border: 1px solid #339933;
4952: margin: -1px;
4953: }
4954: .LC_chrt_popup_up {
4955: border: 1px solid yellow;
4956: margin: -1px;
4957: }
4958: .LC_chrt_popup {
4959: border: 1px solid #8888FF;
4960: background: #CCCCFF;
4961: }
1.421 albertel 4962: table.LC_pick_box {
4963: border-collapse: separate;
4964: background: white;
4965: border: 1px solid black;
4966: border-spacing: 1px;
4967: }
4968: table.LC_pick_box td.LC_pick_box_title {
4969: background: $tabbg;
4970: font-weight: bold;
4971: text-align: right;
4972: width: 184px;
4973: padding: 8px;
4974: }
1.645 raeburn 4975: table.LC_pick_box td.LC_selfenroll_pick_box_title {
4976: background: $tabbg;
4977: font-weight: bold;
4978: text-align: right;
4979: width: 350px;
4980: padding: 8px;
4981: }
4982:
1.579 raeburn 4983: table.LC_pick_box td.LC_pick_box_value {
4984: text-align: left;
4985: padding: 8px;
4986: }
4987: table.LC_pick_box td.LC_pick_box_select {
4988: text-align: left;
4989: padding: 8px;
4990: }
1.424 albertel 4991: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 4992: padding: 0px;
4993: height: 1px;
4994: background: black;
4995: }
4996: table.LC_pick_box td.LC_pick_box_submit {
4997: text-align: right;
4998: }
1.579 raeburn 4999: table.LC_pick_box td.LC_evenrow_value {
5000: text-align: left;
5001: padding: 8px;
5002: background-color: $data_table_light;
5003: }
5004: table.LC_pick_box td.LC_oddrow_value {
5005: text-align: left;
5006: padding: 8px;
5007: background-color: $data_table_light;
5008: }
5009: table.LC_helpform_receipt {
5010: width: 620px;
5011: border-collapse: separate;
5012: background: white;
5013: border: 1px solid black;
5014: border-spacing: 1px;
5015: }
5016: table.LC_helpform_receipt td.LC_pick_box_title {
5017: background: $tabbg;
5018: font-weight: bold;
5019: text-align: right;
5020: width: 184px;
5021: padding: 8px;
5022: }
5023: table.LC_helpform_receipt td.LC_evenrow_value {
5024: text-align: left;
5025: padding: 8px;
5026: background-color: $data_table_light;
5027: }
5028: table.LC_helpform_receipt td.LC_oddrow_value {
5029: text-align: left;
5030: padding: 8px;
5031: background-color: $data_table_light;
5032: }
5033: table.LC_helpform_receipt td.LC_pick_box_separator {
5034: padding: 0px;
5035: height: 1px;
5036: background: black;
5037: }
5038: span.LC_helpform_receipt_cat {
5039: font-weight: bold;
5040: }
1.424 albertel 5041: table.LC_group_priv_box {
5042: background: white;
5043: border: 1px solid black;
5044: border-spacing: 1px;
5045: }
5046: table.LC_group_priv_box td.LC_pick_box_title {
5047: background: $tabbg;
5048: font-weight: bold;
5049: text-align: right;
5050: width: 184px;
5051: }
5052: table.LC_group_priv_box td.LC_groups_fixed {
5053: background: $data_table_light;
5054: text-align: center;
5055: }
5056: table.LC_group_priv_box td.LC_groups_optional {
5057: background: $data_table_dark;
5058: text-align: center;
5059: }
5060: table.LC_group_priv_box td.LC_groups_functionality {
5061: background: $data_table_darker;
5062: text-align: center;
5063: font-weight: bold;
5064: }
5065: table.LC_group_priv td {
5066: text-align: left;
5067: padding: 0px;
5068: }
5069:
1.421 albertel 5070: table.LC_notify_front_page {
5071: background: white;
5072: border: 1px solid black;
5073: padding: 8px;
5074: }
5075: table.LC_notify_front_page td {
5076: padding: 8px;
5077: }
1.424 albertel 5078: .LC_navbuttons {
5079: margin: 2ex 0ex 2ex 0ex;
5080: }
1.423 albertel 5081: .LC_topic_bar {
5082: font-family: $sans;
5083: font-weight: bold;
5084: width: 100%;
5085: background: $tabbg;
5086: vertical-align: middle;
5087: margin: 2ex 0ex 2ex 0ex;
5088: }
5089: .LC_topic_bar span {
5090: vertical-align: middle;
5091: }
5092: .LC_topic_bar img {
5093: vertical-align: bottom;
5094: }
5095: table.LC_course_group_status {
5096: margin: 20px;
5097: }
5098: table.LC_status_selector td {
5099: vertical-align: top;
5100: text-align: center;
1.424 albertel 5101: padding: 4px;
5102: }
5103: table.LC_descriptive_input td.LC_description {
5104: vertical-align: top;
5105: text-align: right;
5106: font-weight: bold;
1.423 albertel 5107: }
1.599 albertel 5108: div.LC_feedback_link {
1.616 albertel 5109: clear: both;
1.599 albertel 5110: background: white;
5111: width: 100%;
1.489 raeburn 5112: }
5113: span.LC_feedback_link {
1.599 albertel 5114: background: $feedback_link_bg;
5115: font-size: larger;
5116: }
5117: span.LC_message_link {
5118: background: $feedback_link_bg;
5119: font-size: larger;
5120: position: absolute;
5121: right: 1em;
1.489 raeburn 5122: }
1.421 albertel 5123:
1.515 albertel 5124: table.LC_prior_tries {
1.524 albertel 5125: border: 1px solid #000000;
5126: border-collapse: separate;
5127: border-spacing: 1px;
1.515 albertel 5128: }
1.523 albertel 5129:
1.515 albertel 5130: table.LC_prior_tries td {
1.524 albertel 5131: padding: 2px;
1.515 albertel 5132: }
1.523 albertel 5133:
5134: .LC_answer_correct {
5135: background: #AAFFAA;
5136: color: black;
5137: }
5138: .LC_answer_charged_try {
5139: background: #FFAAAA ! important;
5140: color: black;
5141: }
5142: .LC_answer_not_charged_try,
5143: .LC_answer_no_grade,
5144: .LC_answer_late {
5145: background: #FFFFAA;
5146: color: black;
5147: }
5148: .LC_answer_previous {
5149: background: #AAAAFF;
5150: color: black;
5151: }
5152: .LC_answer_no_message {
5153: background: #FFFFFF;
5154: color: black;
5155: }
5156: .LC_answer_unknown {
5157: background: orange;
5158: color: black;
5159: }
5160:
5161:
1.529 albertel 5162: span.LC_prior_numerical,
5163: span.LC_prior_string,
5164: span.LC_prior_custom,
5165: span.LC_prior_reaction,
5166: span.LC_prior_math {
1.523 albertel 5167: font-family: monospace;
5168: white-space: pre;
5169: }
5170:
1.525 albertel 5171: span.LC_prior_string {
5172: font-family: monospace;
5173: white-space: pre;
5174: }
5175:
1.523 albertel 5176: table.LC_prior_option {
5177: width: 100%;
5178: border-collapse: collapse;
5179: }
1.528 albertel 5180: table.LC_prior_rank, table.LC_prior_match {
5181: border-collapse: collapse;
5182: }
5183: table.LC_prior_option tr td,
5184: table.LC_prior_rank tr td,
5185: table.LC_prior_match tr td {
1.524 albertel 5186: border: 1px solid #000000;
1.515 albertel 5187: }
5188:
1.519 raeburn 5189: span.LC_nobreak {
1.544 albertel 5190: white-space: nowrap;
1.519 raeburn 5191: }
5192:
1.576 raeburn 5193: span.LC_cusr_emph {
5194: font-style: italic;
5195: }
5196:
1.633 raeburn 5197: span.LC_cusr_subheading {
5198: font-weight: normal;
5199: font-size: 85%;
5200: }
5201:
1.545 albertel 5202: table.LC_docs_documents {
5203: background: #BBBBBB;
1.547 albertel 5204: border-width: 0px;
1.545 albertel 5205: border-collapse: collapse;
5206: }
5207:
5208: table.LC_docs_documents td.LC_docs_document {
5209: border: 2px solid black;
5210: padding: 4px;
5211: }
5212:
5213: .LC_docs_course_commands div {
5214: float: left;
5215: border: 4px solid #AAAAAA;
5216: padding: 4px;
5217: background: #DDDDCC;
5218: }
5219:
5220: .LC_docs_entry_move {
5221: border: 0px;
5222: border-collapse: collapse;
1.544 albertel 5223: }
5224:
1.545 albertel 5225: .LC_docs_entry_move td {
5226: border: 2px solid #BBBBBB;
5227: background: #DDDDDD;
5228: }
5229:
5230: .LC_docs_editor td.LC_docs_entry_commands {
5231: background: #DDDDDD;
5232: font-size: x-small;
5233: }
1.544 albertel 5234: .LC_docs_copy {
1.545 albertel 5235: color: #000099;
1.544 albertel 5236: }
5237: .LC_docs_cut {
1.545 albertel 5238: color: #550044;
1.544 albertel 5239: }
5240: .LC_docs_rename {
1.545 albertel 5241: color: #009900;
1.544 albertel 5242: }
5243: .LC_docs_remove {
1.545 albertel 5244: color: #990000;
5245: }
5246:
1.547 albertel 5247: .LC_docs_reinit_warn,
5248: .LC_docs_ext_edit {
5249: font-size: x-small;
5250: }
5251:
1.545 albertel 5252: .LC_docs_editor td.LC_docs_entry_title,
5253: .LC_docs_editor td.LC_docs_entry_icon {
5254: background: #FFFFBB;
5255: }
5256: .LC_docs_editor td.LC_docs_entry_parameter {
5257: background: #BBBBFF;
5258: font-size: x-small;
5259: white-space: nowrap;
5260: }
5261:
5262: table.LC_docs_adddocs td,
5263: table.LC_docs_adddocs th {
5264: border: 1px solid #BBBBBB;
5265: padding: 4px;
5266: background: #DDDDDD;
1.543 albertel 5267: }
5268:
1.584 albertel 5269: table.LC_sty_begin {
5270: background: #BBFFBB;
5271: }
5272: table.LC_sty_end {
5273: background: #FFBBBB;
5274: }
5275:
1.589 raeburn 5276: table.LC_double_column {
5277: border-width: 0px;
5278: border-collapse: collapse;
5279: width: 100%;
5280: padding: 2px;
5281: }
5282:
5283: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5284: top: 2px;
1.589 raeburn 5285: left: 2px;
5286: width: 47%;
5287: vertical-align: top;
5288: }
5289:
5290: table.LC_double_column tr td.LC_right_col {
5291: top: 2px;
5292: right: 2px;
5293: width: 47%;
5294: vertical-align: top;
5295: }
5296:
1.594 raeburn 5297: span.LC_role_level {
5298: font-weight: bold;
5299: }
5300:
1.591 raeburn 5301: div.LC_left_float {
5302: float: left;
5303: padding-right: 5%;
1.597 albertel 5304: padding-bottom: 4px;
1.591 raeburn 5305: }
5306:
5307: div.LC_clear_float_header {
1.597 albertel 5308: padding-bottom: 2px;
1.591 raeburn 5309: }
5310:
5311: div.LC_clear_float_footer {
1.597 albertel 5312: padding-top: 10px;
1.591 raeburn 5313: clear: both;
5314: }
5315:
1.597 albertel 5316:
1.601 albertel 5317: div.LC_grade_select_mode {
1.604 albertel 5318: font-family: $sans;
1.601 albertel 5319: }
5320: div.LC_grade_select_mode div div {
5321: margin: 5px;
5322: }
5323: div.LC_grade_select_mode_selector {
5324: margin: 5px;
5325: float: left;
5326: }
5327: div.LC_grade_select_mode_selector_header {
5328: font: bold medium $sans;
5329: }
5330: div.LC_grade_select_mode_type {
5331: clear: left;
5332: }
5333:
1.597 albertel 5334: div.LC_grade_show_user {
5335: margin-top: 20px;
5336: border: 1px solid black;
5337: }
5338: div.LC_grade_user_name {
5339: background: #DDDDEE;
5340: border-bottom: 1px solid black;
5341: font: bold large $sans;
5342: }
5343: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5344: background: #DDEEDD;
5345: }
5346:
5347: div.LC_grade_show_problem,
5348: div.LC_grade_submissions,
5349: div.LC_grade_message_center,
5350: div.LC_grade_info_links,
5351: div.LC_grade_assign {
5352: margin: 5px;
5353: width: 99%;
5354: background: #FFFFFF;
5355: }
5356: div.LC_grade_show_problem_header,
5357: div.LC_grade_submissions_header,
5358: div.LC_grade_message_center_header,
5359: div.LC_grade_assign_header {
5360: font: bold large $sans;
5361: }
5362: div.LC_grade_show_problem_problem,
5363: div.LC_grade_submissions_body,
5364: div.LC_grade_message_center_body,
5365: div.LC_grade_assign_body {
5366: border: 1px solid black;
5367: width: 99%;
5368: background: #FFFFFF;
5369: }
1.598 albertel 5370: span.LC_grade_check_note {
5371: font: normal medium $sans;
5372: display: inline;
5373: position: absolute;
5374: right: 1em;
5375: }
1.597 albertel 5376:
1.613 albertel 5377: table.LC_scantron_action {
5378: width: 100%;
5379: }
5380: table.LC_scantron_action tr th {
1.698 harmsja 5381: font-weight:bold;
5382: font-style:normal;
1.613 albertel 5383: }
1.698 harmsja 5384: .LC_edit_problem_header,
1.614 albertel 5385: div.LC_edit_problem_footer {
1.600 albertel 5386: font: normal medium $sans;
1.602 albertel 5387: margin: 2px;
1.600 albertel 5388: }
5389: div.LC_edit_problem_header,
1.602 albertel 5390: div.LC_edit_problem_header div,
1.614 albertel 5391: div.LC_edit_problem_footer,
5392: div.LC_edit_problem_footer div,
1.602 albertel 5393: div.LC_edit_problem_editxml_header,
5394: div.LC_edit_problem_editxml_header div {
1.600 albertel 5395: margin-top: 5px;
5396: }
1.602 albertel 5397: div.LC_edit_problem_header_edit_row {
5398: background: $tabbg;
5399: padding: 3px;
5400: margin-bottom: 5px;
5401: }
1.600 albertel 5402: div.LC_edit_problem_header_title {
1.602 albertel 5403: font: larger bold $sans;
5404: background: $tabbg;
5405: padding: 3px;
5406: }
5407: table.LC_edit_problem_header_title {
5408: font: larger bold $sans;
5409: width: 100%;
5410: border-color: $pgbg;
5411: border-style: solid;
5412: border-width: $border;
5413:
1.600 albertel 5414: background: $tabbg;
1.602 albertel 5415: border-collapse: collapse;
5416: padding: 0px
5417: }
5418:
5419: div.LC_edit_problem_discards {
5420: float: left;
5421: padding-bottom: 5px;
5422: }
5423: div.LC_edit_problem_saves {
5424: float: right;
5425: padding-bottom: 5px;
1.600 albertel 5426: }
5427: hr.LC_edit_problem_divide {
1.602 albertel 5428: clear: both;
1.600 albertel 5429: color: $tabbg;
5430: background-color: $tabbg;
5431: height: 3px;
5432: border: 0px;
5433: }
1.679 riegler 5434: img.stift{
1.678 riegler 5435: border-width:0;
1.679 riegler 5436: vertical-align:middle;
1.677 riegler 5437: }
1.680 riegler 5438:
1.681 riegler 5439: table#LC_mainmenu{
5440: margin-top:10px;
5441: width:80%;
5442:
5443: }
5444:
1.680 riegler 5445: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5446: vertical-align: top;
5447: width: 45%;
5448: }
5449: .LC_mainmenu_fieldset_category {
5450: color: $font;
5451: background: $pgbg;
5452: font-family: $sans;
5453: font-size: small;
5454: font-weight: bold;
5455: }
5456: fieldset#LC_mainmenu_fieldset {
1.681 riegler 5457: margin:0px 10px 10px 0px;
1.680 riegler 5458:
5459: }
1.693 droeschl 5460: /* ---- Remove when done ----
5461: # The following styles is part of the redesign of LON-CAPA and are
5462: # subject to change during this project.
5463: # Don't rely on their current functionality as they might be
5464: # changed or removed.
5465: # --------------------------*/
5466:
1.698 harmsja 5467: a:hover,
5468: ol.smallMenu a:hover,
5469: ol#MenuBreadcrumbs a:hover,
5470: ul#TabMainMenuContent a:hover,
5471: .FormSectionClearButton input:hover{
5472: color:#BF2317;
5473: text-decoration:none;
1.693 droeschl 5474: }
5475:
5476: h1 {
5477: padding:5px 10px 5px 20px;
5478: line-height:130%;
5479: }
1.698 harmsja 5480:
1.693 droeschl 5481: h2,h3,h4,h5,h6
5482: {
5483: margin:5px 0px 5px 0px;
5484: line-height:130%;
5485: }
1.698 harmsja 5486: .hcell{
5487: padding:3px 15px 3px 15px;
5488: margin:0px;
5489: background: $pgbg;
5490: border-bottom:solid 1px $lg_border_color;
5491: }
1.693 droeschl 5492: .right {
5493: text-align: right;
5494: }
5495: .left {
5496: text-align: left;
5497: }
1.698 harmsja 5498: .noBorder {
5499: border:0px;
5500: }
5501: /*
5502: .bgLightGrey { background:URL(images/TabMenuBG.png) repeat-x left top; }
5503: .bgLightGreyYellow {background-color:#EFECE0;}
5504: */
1.693 droeschl 5505:
5506:
1.698 harmsja 5507: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5508: .HeadRight {
5509: text-align: right;
5510: float: right;
5511: margin: 0px;
5512: padding: 0px;
1.698 harmsja 5513: right:0;
1.693 droeschl 5514: position:absolute;
1.698 harmsja 5515: overflow:hidden;
1.693 droeschl 5516: }
5517:
1.698 harmsja 5518: p {
5519: padding: 10px;
5520:
5521: }
5522: .FormSectionClearButton input {
5523: background-color:transparent;
5524: border:0px;
5525: cursor:pointer;
5526: text-decoration:underline;
1.693 droeschl 5527: }
5528:
5529:
1.698 harmsja 5530: dl,ul,div,fieldset {
5531: margin: 10px 10px 10px 0px;
1.693 droeschl 5532: overflow:hidden;
5533: }
1.698 harmsja 5534: ol.smallMenu {
5535: margin: 0px;
1.693 droeschl 5536: }
5537:
1.698 harmsja 5538: ol.smallMenu li {
1.693 droeschl 5539: display: inline;
5540: padding: 5px 5px 0px 10px;
5541: vertical-align: top;
5542: }
5543:
1.698 harmsja 5544: ol.smallMenu li img {
1.693 droeschl 5545: vertical-align: bottom;
5546: }
5547:
1.698 harmsja 5548: ol.smallMenu a {
1.693 droeschl 5549: font-size: 90%;
5550: color: RGB(80, 80, 80);
5551: text-decoration: none;
5552: }
5553:
1.698 harmsja 5554: ol#TabMainMenuContent {
1.693 droeschl 5555:
5556: margin: 0px 0px 10px 0px;
5557: padding: 0px;
5558: }
5559:
1.698 harmsja 5560: ol#TabMainMenuContent li {
1.693 droeschl 5561: display: inline;
5562: vertical-align: bottom;
5563: border-bottom: solid 1px RGB(175, 175, 175);
5564: border-right: solid 1px RGB(175, 175, 175);
5565: padding: 5px 15px 5px 15px;
5566: margin-right:4px;
5567: line-height: 140%;
5568: font-weight: bold;
5569: overflow:hidden;
1.698 harmsja 5570: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left top;*/
1.693 droeschl 5571: }
5572:
1.698 harmsja 5573: ol#TabMainMenuContent li a{
1.693 droeschl 5574: color: RGB(47, 47, 47);
5575: text-decoration: none;
5576: }
5577:
1.698 harmsja 5578: ol#TabMainMenuContent div.columnSection {
1.693 droeschl 5579: margin-bottom: 0px;
5580: }
5581:
1.698 harmsja 5582: ol#MenuBreadcrumbs, ol#PathBreadcrumbs {
1.693 droeschl 5583: border-top: solid 1px RGB(255, 255, 255);
5584: height: 20px;
5585: line-height: 20px;
5586: vertical-align: bottom;
5587: margin: 0px 0px 30px 0px;
5588: padding-left: 10px;
5589: list-style-position: inside;
1.698 harmsja 5590: /* background: RGB(211, 206, 205) URL(images/TabMenuBG.png) repeat-x left
5591: top;*/
1.693 droeschl 5592: }
5593:
1.698 harmsja 5594: ol#MenuBreadcrumbs li, ol#PathBreadcrumbs li {
5595: /* background: url(images/pfeil_white.png) no-repeat left center;*/
1.693 droeschl 5596: display: inline;
5597: padding: 0px 0px 0px 10px;
5598: vertical-align: bottom;
5599: overflow:hidden;
5600: }
5601:
1.698 harmsja 5602: ol#MenuBreadcrumbs li a {
1.693 droeschl 5603: text-decoration: none;
5604: font-size:90%;
5605: }
1.698 harmsja 5606: ol#PathBreadcrumbs li a{
5607: text-decoration:none;
5608: font-size:100%;
5609: font-weight:bold;
1.693 droeschl 5610: }
5611:
1.698 harmsja 5612: .ContentBoxSpecial
1.693 droeschl 5613: {
1.698 harmsja 5614: border: solid 1px $lg_border_color;
5615: }
5616: .ContentBox {
5617: padding:10px;
1.693 droeschl 5618: }
1.698 harmsja 5619: .PopUp
1.693 droeschl 5620: {
1.698 harmsja 5621: padding:10px;
5622: border-left:solid 1px $lg_border_color;
5623: border-top:solid 1px $lg_border_color;
5624: border-bottom:outset 1px $lg_border_color;
5625: border-right:outset 1px $lg_border_color;
5626: display:none;
5627: position:absolute;
5628: right:0;
5629: background-color:white;
5630: z-index:5;
1.693 droeschl 5631: }
5632:
1.698 harmsja 5633: dl.ListStyleClean dt {
1.693 droeschl 5634: padding-right: 5px;
5635: display: table-header-group;
5636: }
5637:
1.698 harmsja 5638: dl.ListStyleClean dd {
1.693 droeschl 5639: display: table-row;
5640: }
5641:
5642: .ListStyleClean,
5643: .ListStyleSimple,
5644: .ListStyleNormal,
5645: .ListStyleNormal_Border,
5646: .ListStyleSpecial
5647: {
5648: /*display:block; */
5649: list-style-position: inside;
5650: list-style-type: none;
5651: overflow: hidden;
5652: padding: 0px;
5653: }
5654:
5655: .ListStyleSimple li,
1.698 harmsja 5656: .ListStyleSimple dd,
1.693 droeschl 5657: .ListStyleNormal li,
1.698 harmsja 5658: .ListStyleNormal dd,
1.693 droeschl 5659: .ListStyleSpecial li,
1.698 harmsja 5660: .ListStyleSpecial dd
1.693 droeschl 5661: {
5662: margin: 0px;
5663: padding: 5px 5px 5px 10px;
5664: clear: both;
5665: /*display:block;*/
5666: }
5667:
1.698 harmsja 5668: .ListStyleClean li,
5669: .ListStyleClean dd {
1.693 droeschl 5670: padding-top: 0px;
5671: padding-bottom: 0px;
5672: }
5673:
1.698 harmsja 5674: .ListStyleSimple dd,
5675: .ListStyleSimple li{
5676: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5677: }
5678:
1.698 harmsja 5679: .ListStyleSpecial li,
5680: .ListStyleSpecial dd {
1.693 droeschl 5681: list-style-type: none;
5682: background-color: RGB(220, 220, 220);
5683: margin-bottom: 4px;
5684: }
5685:
1.698 harmsja 5686: table.SimpleTable {
5687: margin:5px;
5688: border:solid 1px $lg_border_color;
1.693 droeschl 5689: }
5690:
1.698 harmsja 5691: table.SimpleTable tr {
5692: padding:0px;
5693: border:solid 1px $lg_border_color;
1.693 droeschl 5694: }
5695: table.SimpleTable thead{
1.698 harmsja 5696: background:rgb(220,220,220);
1.693 droeschl 5697: }
5698:
1.698 harmsja 5699: div.columnSection {
1.693 droeschl 5700: display: block;
5701: clear: both;
5702: overflow: hidden;
5703: margin:0px;
5704: }
5705:
1.698 harmsja 5706: div.columnSection>* {
1.693 droeschl 5707: float: left;
5708: margin: 10px 20px 10px 0px;
5709: overflow:hidden;
5710: }
1.698 harmsja 5711: div.columnSection > .ContentBox,
5712: div.columnSection > .ContentBoxSpecial
1.693 droeschl 5713: {
1.698 harmsja 5714: width: 400px;
1.693 droeschl 5715:
5716: }
5717:
1.694 tempelho 5718: .LC_loginpage_container {
5719: text-align:left;
5720: margin : 0 auto;
5721: width:65%;
5722: padding: 10px;
5723: height: auto;
5724: background-color:#FFFFFF;
5725: border:1px solid #CCCCCC;
5726: }
5727:
5728:
5729: .LC_loginpage_loginContainer {
5730: float:left;
5731: width:60%;
5732: }
5733:
5734: .LC_loginpage_loginInfo {
5735: margin-top:20px;
5736: margin-left:20px;
5737: float:left;
5738: width:30%;
5739: border:1px solid #CCCCCC;
5740: padding:10px;
5741: }
5742:
5743: .LC_loginpage_space {
5744: clear:both;
5745: margin-bottom:20px;
5746: border-bottom: 1px solid #CCCCCC;
5747: }
5748:
5749: .LC_loginpage_fieldset{
5750: border: 1px solid #CCCCCC;
5751: margin: 0 auto;
5752: }
5753:
5754: .LC_loginpage_legend{
5755: padding: 2px;
5756: margin: 0px;
5757: font-size:14px;
5758: font-weight:bold;
5759: }
5760:
5761:
1.693 droeschl 5762:
1.343 albertel 5763: END
5764: }
5765:
1.306 albertel 5766: =pod
5767:
5768: =item * &headtag()
5769:
5770: Returns a uniform footer for LON-CAPA web pages.
5771:
1.307 albertel 5772: Inputs: $title - optional title for the head
5773: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5774: $args - optional arguments
1.319 albertel 5775: force_register - if is true call registerurl so the remote is
5776: informed
1.415 albertel 5777: redirect -> array ref of
5778: 1- seconds before redirect occurs
5779: 2- url to redirect to
5780: 3- whether the side effect should occur
1.315 albertel 5781: (side effect of setting
5782: $env{'internal.head.redirect'} to the url
5783: redirected too)
1.352 albertel 5784: domain -> force to color decorate a page for a specific
5785: domain
5786: function -> force usage of a specific rolish color scheme
5787: bgcolor -> override the default page bgcolor
1.460 albertel 5788: no_auto_mt_title
5789: -> prevent &mt()ing the title arg
1.464 albertel 5790:
1.306 albertel 5791: =cut
5792:
5793: sub headtag {
1.313 albertel 5794: my ($title,$head_extra,$args) = @_;
1.306 albertel 5795:
1.363 albertel 5796: my $function = $args->{'function'} || &get_users_function();
5797: my $domain = $args->{'domain'} || &determinedomain();
5798: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5799: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5800: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5801: #time(),
1.418 albertel 5802: $env{'environment.color.timestamp'},
1.363 albertel 5803: $function,$domain,$bgcolor);
5804:
1.369 www 5805: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5806:
1.308 albertel 5807: my $result =
5808: '<head>'.
1.461 albertel 5809: &font_settings();
1.319 albertel 5810:
1.461 albertel 5811: if (!$args->{'frameset'}) {
5812: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5813: }
1.319 albertel 5814: if ($args->{'force_register'}) {
5815: $result .= &Apache::lonmenu::registerurl(1);
5816: }
1.436 albertel 5817: if (!$args->{'no_nav_bar'}
5818: && !$args->{'only_body'}
5819: && !$args->{'frameset'}) {
5820: $result .= &help_menu_js();
5821: }
1.319 albertel 5822:
1.314 albertel 5823: if (ref($args->{'redirect'})) {
1.414 albertel 5824: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5825: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5826: if (!$inhibit_continue) {
5827: $env{'internal.head.redirect'} = $url;
5828: }
1.313 albertel 5829: $result.=<<ADDMETA
5830: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5831: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5832: ADDMETA
5833: }
1.306 albertel 5834: if (!defined($title)) {
5835: $title = 'The LearningOnline Network with CAPA';
5836: }
1.460 albertel 5837: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5838: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5839: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5840: .$head_extra;
1.306 albertel 5841: return $result;
5842: }
5843:
5844: =pod
5845:
1.340 albertel 5846: =item * &font_settings()
5847:
5848: Returns neccessary <meta> to set the proper encoding
5849:
5850: Inputs: none
5851:
5852: =cut
5853:
5854: sub font_settings {
5855: my $headerstring='';
1.647 www 5856: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5857: $headerstring.=
5858: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5859: }
5860: return $headerstring;
5861: }
5862:
1.341 albertel 5863: =pod
5864:
5865: =item * &xml_begin()
5866:
5867: Returns the needed doctype and <html>
5868:
5869: Inputs: none
5870:
5871: =cut
5872:
5873: sub xml_begin {
5874: my $output='';
5875:
1.592 albertel 5876: if ($env{'internal.start_page'}==1) {
5877: &Apache::lonhtmlcommon::init_htmlareafields();
5878: }
1.342 albertel 5879:
1.341 albertel 5880: if ($env{'browser.mathml'}) {
5881: $output='<?xml version="1.0"?>'
5882: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5883: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5884:
5885: # .'<!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">] >'
5886: .'<!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">'
5887: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5888: .'xmlns="http://www.w3.org/1999/xhtml">';
5889: } else {
5890: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5891: }
5892: return $output;
5893: }
1.340 albertel 5894:
5895: =pod
5896:
1.306 albertel 5897: =item * &endheadtag()
5898:
5899: Returns a uniform </head> for LON-CAPA web pages.
5900:
5901: Inputs: none
5902:
5903: =cut
5904:
5905: sub endheadtag {
5906: return '</head>';
5907: }
5908:
5909: =pod
5910:
5911: =item * &head()
5912:
5913: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5914:
1.648 raeburn 5915: Inputs:
5916:
5917: =over 4
5918:
5919: $title - optional title for the page
5920:
5921: $head_extra - optional extra HTML to put inside the <head>
5922:
5923: =back
1.405 albertel 5924:
1.306 albertel 5925: =cut
5926:
5927: sub head {
1.325 albertel 5928: my ($title,$head_extra,$args) = @_;
5929: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5930: }
5931:
5932: =pod
5933:
5934: =item * &start_page()
5935:
5936: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5937:
1.648 raeburn 5938: Inputs:
5939:
5940: =over 4
5941:
5942: $title - optional title for the page
5943:
5944: $head_extra - optional extra HTML to incude inside the <head>
5945:
5946: $args - additional optional args supported are:
5947:
5948: =over 8
5949:
5950: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 5951: arg on
1.648 raeburn 5952: no_nav_bar -> is true will set &bodytag() notopbar arg on
5953: add_entries -> additional attributes to add to the <body>
5954: domain -> force to color decorate a page for a
1.317 albertel 5955: specific domain
1.648 raeburn 5956: function -> force usage of a specific rolish color
1.317 albertel 5957: scheme
1.648 raeburn 5958: redirect -> see &headtag()
5959: bgcolor -> override the default page bg color
5960: js_ready -> return a string ready for being used in
1.317 albertel 5961: a javascript writeln
1.648 raeburn 5962: html_encode -> return a string ready for being used in
1.320 albertel 5963: a html attribute
1.648 raeburn 5964: force_register -> if is true will turn on the &bodytag()
1.317 albertel 5965: $forcereg arg
1.648 raeburn 5966: body_title -> alternate text to use instead of $title
1.326 albertel 5967: in the title box that appears, this text
5968: is not auto translated like the $title is
1.648 raeburn 5969: frameset -> if true will start with a <frameset>
1.330 albertel 5970: rather than <body>
1.648 raeburn 5971: no_title -> if true the title bar won't be shown
5972: skip_phases -> hash ref of
1.338 albertel 5973: head -> skip the <html><head> generation
5974: body -> skip all <body> generation
1.648 raeburn 5975: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 5976: 'Switch To Inline Menu' link
1.648 raeburn 5977: no_auto_mt_title -> prevent &mt()ing the title arg
5978: inherit_jsmath -> when creating popup window in a page,
5979: should it have jsmath forced on by the
5980: current page
1.361 albertel 5981:
1.648 raeburn 5982: =back
1.460 albertel 5983:
1.648 raeburn 5984: =back
1.562 albertel 5985:
1.306 albertel 5986: =cut
5987:
5988: sub start_page {
1.309 albertel 5989: my ($title,$head_extra,$args) = @_;
1.318 albertel 5990: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 5991: my %head_args;
1.352 albertel 5992: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 5993: 'bgcolor','frameset','no_nav_bar','only_body',
5994: 'no_auto_mt_title') {
1.319 albertel 5995: if (defined($args->{$arg})) {
1.324 raeburn 5996: $head_args{$arg} = $args->{$arg};
1.319 albertel 5997: }
1.313 albertel 5998: }
1.319 albertel 5999:
1.315 albertel 6000: $env{'internal.start_page'}++;
1.338 albertel 6001: my $result;
6002: if (! exists($args->{'skip_phases'}{'head'}) ) {
6003: $result.=
1.341 albertel 6004: &xml_begin().
1.338 albertel 6005: &headtag($title,$head_extra,\%head_args).&endheadtag();
6006: }
6007:
6008: if (! exists($args->{'skip_phases'}{'body'}) ) {
6009: if ($args->{'frameset'}) {
6010: my $attr_string = &make_attr_string($args->{'force_register'},
6011: $args->{'add_entries'});
6012: $result .= "\n<frameset $attr_string>\n";
6013: } else {
6014: $result .=
6015: &bodytag($title,
6016: $args->{'function'}, $args->{'add_entries'},
6017: $args->{'only_body'}, $args->{'domain'},
6018: $args->{'force_register'}, $args->{'body_title'},
6019: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6020: $args->{'no_title'}, $args->{'no_inline_link'},
6021: $args);
1.338 albertel 6022: }
1.330 albertel 6023: }
1.338 albertel 6024:
1.315 albertel 6025: if ($args->{'js_ready'}) {
1.317 albertel 6026: $result = &js_ready($result);
1.315 albertel 6027: }
1.320 albertel 6028: if ($args->{'html_encode'}) {
6029: $result = &html_encode($result);
6030: }
1.315 albertel 6031: return $result;
1.306 albertel 6032: }
6033:
1.330 albertel 6034:
1.306 albertel 6035: =pod
6036:
6037: =item * &head()
6038:
6039: Returns a complete </body></html> section for LON-CAPA web pages.
6040:
1.315 albertel 6041: Inputs: $args - additional optional args supported are:
6042: js_ready -> return a string ready for being used in
6043: a javascript writeln
1.320 albertel 6044: html_encode -> return a string ready for being used in
6045: a html attribute
1.330 albertel 6046: frameset -> if true will start with a <frameset>
6047: rather than <body>
1.493 albertel 6048: dicsussion -> if true will get discussion from
6049: lonxml::xmlend
6050: (you can pass the target and parser arguments
6051: through optional 'target' and 'parser' args
6052: to this routine)
1.306 albertel 6053:
6054: =cut
6055:
6056: sub end_page {
1.315 albertel 6057: my ($args) = @_;
6058: $env{'internal.end_page'}++;
1.330 albertel 6059: my $result;
1.335 albertel 6060: if ($args->{'discussion'}) {
6061: my ($target,$parser);
6062: if (ref($args->{'discussion'})) {
6063: ($target,$parser) =($args->{'discussion'}{'target'},
6064: $args->{'discussion'}{'parser'});
6065: }
6066: $result .= &Apache::lonxml::xmlend($target,$parser);
6067: }
6068:
1.330 albertel 6069: if ($args->{'frameset'}) {
6070: $result .= '</frameset>';
6071: } else {
1.635 raeburn 6072: $result .= &endbodytag($args);
1.330 albertel 6073: }
6074: $result .= "\n</html>";
6075:
1.315 albertel 6076: if ($args->{'js_ready'}) {
1.317 albertel 6077: $result = &js_ready($result);
1.315 albertel 6078: }
1.335 albertel 6079:
1.320 albertel 6080: if ($args->{'html_encode'}) {
6081: $result = &html_encode($result);
6082: }
1.335 albertel 6083:
1.315 albertel 6084: return $result;
6085: }
6086:
1.320 albertel 6087: sub html_encode {
6088: my ($result) = @_;
6089:
1.322 albertel 6090: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6091:
6092: return $result;
6093: }
1.317 albertel 6094: sub js_ready {
6095: my ($result) = @_;
6096:
1.323 albertel 6097: $result =~ s/[\n\r]/ /xmsg;
6098: $result =~ s/\\/\\\\/xmsg;
6099: $result =~ s/'/\\'/xmsg;
1.372 albertel 6100: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6101:
6102: return $result;
6103: }
6104:
1.315 albertel 6105: sub validate_page {
6106: if ( exists($env{'internal.start_page'})
1.316 albertel 6107: && $env{'internal.start_page'} > 1) {
6108: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6109: $env{'internal.start_page'}.' '.
1.316 albertel 6110: $ENV{'request.filename'});
1.315 albertel 6111: }
6112: if ( exists($env{'internal.end_page'})
1.316 albertel 6113: && $env{'internal.end_page'} > 1) {
6114: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6115: $env{'internal.end_page'}.' '.
1.316 albertel 6116: $env{'request.filename'});
1.315 albertel 6117: }
6118: if ( exists($env{'internal.start_page'})
6119: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6120: &Apache::lonnet::logthis('start_page called without end_page '.
6121: $env{'request.filename'});
1.315 albertel 6122: }
6123: if ( ! exists($env{'internal.start_page'})
6124: && exists($env{'internal.end_page'})) {
1.316 albertel 6125: &Apache::lonnet::logthis('end_page called without start_page'.
6126: $env{'request.filename'});
1.315 albertel 6127: }
1.306 albertel 6128: }
1.315 albertel 6129:
1.318 albertel 6130: sub simple_error_page {
6131: my ($r,$title,$msg) = @_;
6132: my $page =
6133: &Apache::loncommon::start_page($title).
6134: &mt($msg).
6135: &Apache::loncommon::end_page();
6136: if (ref($r)) {
6137: $r->print($page);
1.327 albertel 6138: return;
1.318 albertel 6139: }
6140: return $page;
6141: }
1.347 albertel 6142:
6143: {
1.610 albertel 6144: my @row_count;
1.347 albertel 6145: sub start_data_table {
1.422 albertel 6146: my ($add_class) = @_;
6147: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6148: unshift(@row_count,0);
1.422 albertel 6149: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6150: }
6151:
6152: sub end_data_table {
1.610 albertel 6153: shift(@row_count);
1.389 albertel 6154: return '</table>'."\n";;
1.347 albertel 6155: }
6156:
6157: sub start_data_table_row {
1.422 albertel 6158: my ($add_class) = @_;
1.610 albertel 6159: $row_count[0]++;
6160: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6161: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6162: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6163: }
1.471 banghart 6164:
6165: sub continue_data_table_row {
6166: my ($add_class) = @_;
1.610 albertel 6167: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6168: $css_class = (join(' ',$css_class,$add_class));
6169: return '<tr class="'.$css_class.'">'."\n";;
6170: }
1.347 albertel 6171:
6172: sub end_data_table_row {
1.389 albertel 6173: return '</tr>'."\n";;
1.347 albertel 6174: }
1.367 www 6175:
1.421 albertel 6176: sub start_data_table_empty_row {
1.610 albertel 6177: $row_count[0]++;
1.421 albertel 6178: return '<tr class="LC_empty_row" >'."\n";;
6179: }
6180:
6181: sub end_data_table_empty_row {
6182: return '</tr>'."\n";;
6183: }
6184:
1.367 www 6185: sub start_data_table_header_row {
1.389 albertel 6186: return '<tr class="LC_header_row">'."\n";;
1.367 www 6187: }
6188:
6189: sub end_data_table_header_row {
1.389 albertel 6190: return '</tr>'."\n";;
1.367 www 6191: }
1.347 albertel 6192: }
6193:
1.548 albertel 6194: =pod
6195:
6196: =item * &inhibit_menu_check($arg)
6197:
6198: Checks for a inhibitmenu state and generates output to preserve it
6199:
6200: Inputs: $arg - can be any of
6201: - undef - in which case the return value is a string
6202: to add into arguments list of a uri
6203: - 'input' - in which case the return value is a HTML
6204: <form> <input> field of type hidden to
6205: preserve the value
6206: - a url - in which case the return value is the url with
6207: the neccesary cgi args added to preserve the
6208: inhibitmenu state
6209: - a ref to a url - no return value, but the string is
6210: updated to include the neccessary cgi
6211: args to preserve the inhibitmenu state
6212:
6213: =cut
6214:
6215: sub inhibit_menu_check {
6216: my ($arg) = @_;
6217: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6218: if ($arg eq 'input') {
6219: if ($env{'form.inhibitmenu'}) {
6220: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6221: } else {
6222: return
6223: }
6224: }
6225: if ($env{'form.inhibitmenu'}) {
6226: if (ref($arg)) {
6227: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6228: } elsif ($arg eq '') {
6229: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6230: } else {
6231: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6232: }
6233: }
6234: if (!ref($arg)) {
6235: return $arg;
6236: }
6237: }
6238:
1.251 albertel 6239: ###############################################
1.182 matthew 6240:
6241: =pod
6242:
1.549 albertel 6243: =back
6244:
6245: =head1 User Information Routines
6246:
6247: =over 4
6248:
1.405 albertel 6249: =item * &get_users_function()
1.182 matthew 6250:
6251: Used by &bodytag to determine the current users primary role.
6252: Returns either 'student','coordinator','admin', or 'author'.
6253:
6254: =cut
6255:
6256: ###############################################
6257: sub get_users_function {
6258: my $function = 'student';
1.258 albertel 6259: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6260: $function='coordinator';
6261: }
1.258 albertel 6262: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6263: $function='admin';
6264: }
1.258 albertel 6265: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6266: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6267: $function='author';
6268: }
6269: return $function;
1.54 www 6270: }
1.99 www 6271:
6272: ###############################################
6273:
1.233 raeburn 6274: =pod
6275:
1.542 raeburn 6276: =item * &check_user_status()
1.274 raeburn 6277:
6278: Determines current status of supplied role for a
6279: specific user. Roles can be active, previous or future.
6280:
6281: Inputs:
6282: user's domain, user's username, course's domain,
1.375 raeburn 6283: course's number, optional section ID.
1.274 raeburn 6284:
6285: Outputs:
6286: role status: active, previous or future.
6287:
6288: =cut
6289:
6290: sub check_user_status {
1.412 raeburn 6291: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6292: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6293: my @uroles = keys %userinfo;
6294: my $srchstr;
6295: my $active_chk = 'none';
1.412 raeburn 6296: my $now = time;
1.274 raeburn 6297: if (@uroles > 0) {
1.412 raeburn 6298: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6299: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6300: } else {
1.412 raeburn 6301: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6302: }
6303: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6304: my $role_end = 0;
6305: my $role_start = 0;
6306: $active_chk = 'active';
1.412 raeburn 6307: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6308: $role_end = $1;
6309: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6310: $role_start = $1;
1.274 raeburn 6311: }
6312: }
6313: if ($role_start > 0) {
1.412 raeburn 6314: if ($now < $role_start) {
1.274 raeburn 6315: $active_chk = 'future';
6316: }
6317: }
6318: if ($role_end > 0) {
1.412 raeburn 6319: if ($now > $role_end) {
1.274 raeburn 6320: $active_chk = 'previous';
6321: }
6322: }
6323: }
6324: }
6325: return $active_chk;
6326: }
6327:
6328: ###############################################
6329:
6330: =pod
6331:
1.405 albertel 6332: =item * &get_sections()
1.233 raeburn 6333:
6334: Determines all the sections for a course including
6335: sections with students and sections containing other roles.
1.419 raeburn 6336: Incoming parameters:
6337:
6338: 1. domain
6339: 2. course number
6340: 3. reference to array containing roles for which sections should
6341: be gathered (optional).
6342: 4. reference to array containing status types for which sections
6343: should be gathered (optional).
6344:
6345: If the third argument is undefined, sections are gathered for any role.
6346: If the fourth argument is undefined, sections are gathered for any status.
6347: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6348:
1.374 raeburn 6349: Returns section hash (keys are section IDs, values are
6350: number of users in each section), subject to the
1.419 raeburn 6351: optional roles filter, optional status filter
1.233 raeburn 6352:
6353: =cut
6354:
6355: ###############################################
6356: sub get_sections {
1.419 raeburn 6357: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6358: if (!defined($cdom) || !defined($cnum)) {
6359: my $cid = $env{'request.course.id'};
6360:
6361: return if (!defined($cid));
6362:
6363: $cdom = $env{'course.'.$cid.'.domain'};
6364: $cnum = $env{'course.'.$cid.'.num'};
6365: }
6366:
6367: my %sectioncount;
1.419 raeburn 6368: my $now = time;
1.240 albertel 6369:
1.366 albertel 6370: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6371: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6372: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6373: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6374: my $start_index = &Apache::loncoursedata::CL_START();
6375: my $end_index = &Apache::loncoursedata::CL_END();
6376: my $status;
1.366 albertel 6377: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6378: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6379: $data->[$status_index],
6380: $data->[$start_index],
6381: $data->[$end_index]);
6382: if ($stu_status eq 'Active') {
6383: $status = 'active';
6384: } elsif ($end < $now) {
6385: $status = 'previous';
6386: } elsif ($start > $now) {
6387: $status = 'future';
6388: }
6389: if ($section ne '-1' && $section !~ /^\s*$/) {
6390: if ((!defined($possible_status)) || (($status ne '') &&
6391: (grep/^\Q$status\E$/,@{$possible_status}))) {
6392: $sectioncount{$section}++;
6393: }
1.240 albertel 6394: }
6395: }
6396: }
6397: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6398: foreach my $user (sort(keys(%courseroles))) {
6399: if ($user !~ /^(\w{2})/) { next; }
6400: my ($role) = ($user =~ /^(\w{2})/);
6401: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6402: my ($section,$status);
1.240 albertel 6403: if ($role eq 'cr' &&
6404: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6405: $section=$1;
6406: }
6407: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6408: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6409: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6410: if ($end == -1 && $start == -1) {
6411: next; #deleted role
6412: }
6413: if (!defined($possible_status)) {
6414: $sectioncount{$section}++;
6415: } else {
6416: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6417: $status = 'active';
6418: } elsif ($end < $now) {
6419: $status = 'future';
6420: } elsif ($start > $now) {
6421: $status = 'previous';
6422: }
6423: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6424: $sectioncount{$section}++;
6425: }
6426: }
1.233 raeburn 6427: }
1.366 albertel 6428: return %sectioncount;
1.233 raeburn 6429: }
6430:
1.274 raeburn 6431: ###############################################
1.294 raeburn 6432:
6433: =pod
1.405 albertel 6434:
6435: =item * &get_course_users()
6436:
1.275 raeburn 6437: Retrieves usernames:domains for users in the specified course
6438: with specific role(s), and access status.
6439:
6440: Incoming parameters:
1.277 albertel 6441: 1. course domain
6442: 2. course number
6443: 3. access status: users must have - either active,
1.275 raeburn 6444: previous, future, or all.
1.277 albertel 6445: 4. reference to array of permissible roles
1.288 raeburn 6446: 5. reference to array of section restrictions (optional)
6447: 6. reference to results object (hash of hashes).
6448: 7. reference to optional userdata hash
1.609 raeburn 6449: 8. reference to optional statushash
1.630 raeburn 6450: 9. flag if privileged users (except those set to unhide in
6451: course settings) should be excluded
1.609 raeburn 6452: Keys of top level results hash are roles.
1.275 raeburn 6453: Keys of inner hashes are username:domain, with
6454: values set to access type.
1.288 raeburn 6455: Optional userdata hash returns an array with arguments in the
6456: same order as loncoursedata::get_classlist() for student data.
6457:
1.609 raeburn 6458: Optional statushash returns
6459:
1.288 raeburn 6460: Entries for end, start, section and status are blank because
6461: of the possibility of multiple values for non-student roles.
6462:
1.275 raeburn 6463: =cut
1.405 albertel 6464:
1.275 raeburn 6465: ###############################################
1.405 albertel 6466:
1.275 raeburn 6467: sub get_course_users {
1.630 raeburn 6468: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6469: my %idx = ();
1.419 raeburn 6470: my %seclists;
1.288 raeburn 6471:
6472: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6473: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6474: $idx{end} = &Apache::loncoursedata::CL_END();
6475: $idx{start} = &Apache::loncoursedata::CL_START();
6476: $idx{id} = &Apache::loncoursedata::CL_ID();
6477: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6478: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6479: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6480:
1.290 albertel 6481: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6482: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6483: my $now = time;
1.277 albertel 6484: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6485: my $match = 0;
1.412 raeburn 6486: my $secmatch = 0;
1.419 raeburn 6487: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6488: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6489: if ($section eq '') {
6490: $section = 'none';
6491: }
1.291 albertel 6492: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6493: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6494: $secmatch = 1;
6495: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6496: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6497: $secmatch = 1;
6498: }
6499: } else {
1.419 raeburn 6500: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6501: $secmatch = 1;
6502: }
1.290 albertel 6503: }
1.412 raeburn 6504: if (!$secmatch) {
6505: next;
6506: }
1.419 raeburn 6507: }
1.275 raeburn 6508: if (defined($$types{'active'})) {
1.288 raeburn 6509: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6510: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6511: $match = 1;
1.275 raeburn 6512: }
6513: }
6514: if (defined($$types{'previous'})) {
1.609 raeburn 6515: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6516: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6517: $match = 1;
1.275 raeburn 6518: }
6519: }
6520: if (defined($$types{'future'})) {
1.609 raeburn 6521: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6522: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6523: $match = 1;
1.275 raeburn 6524: }
6525: }
1.609 raeburn 6526: if ($match) {
6527: push(@{$seclists{$student}},$section);
6528: if (ref($userdata) eq 'HASH') {
6529: $$userdata{$student} = $$classlist{$student};
6530: }
6531: if (ref($statushash) eq 'HASH') {
6532: $statushash->{$student}{'st'}{$section} = $status;
6533: }
1.288 raeburn 6534: }
1.275 raeburn 6535: }
6536: }
1.412 raeburn 6537: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6538: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6539: my $now = time;
1.609 raeburn 6540: my %displaystatus = ( previous => 'Expired',
6541: active => 'Active',
6542: future => 'Future',
6543: );
1.630 raeburn 6544: my %nothide;
6545: if ($hidepriv) {
6546: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6547: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6548: if ($user !~ /:/) {
6549: $nothide{join(':',split(/[\@]/,$user))}=1;
6550: } else {
6551: $nothide{$user} = 1;
6552: }
6553: }
6554: }
1.439 raeburn 6555: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6556: my $match = 0;
1.412 raeburn 6557: my $secmatch = 0;
1.439 raeburn 6558: my $status;
1.412 raeburn 6559: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6560: $user =~ s/:$//;
1.439 raeburn 6561: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6562: if ($end == -1 || $start == -1) {
6563: next;
6564: }
6565: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6566: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6567: my ($uname,$udom) = split(/:/,$user);
6568: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6569: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6570: $secmatch = 1;
6571: } elsif ($usec eq '') {
1.420 albertel 6572: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6573: $secmatch = 1;
6574: }
6575: } else {
6576: if (grep(/^\Q$usec\E$/,@{$sections})) {
6577: $secmatch = 1;
6578: }
6579: }
6580: if (!$secmatch) {
6581: next;
6582: }
1.288 raeburn 6583: }
1.419 raeburn 6584: if ($usec eq '') {
6585: $usec = 'none';
6586: }
1.275 raeburn 6587: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6588: if ($hidepriv) {
6589: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6590: (!$nothide{$uname.':'.$udom})) {
6591: next;
6592: }
6593: }
1.503 raeburn 6594: if ($end > 0 && $end < $now) {
1.439 raeburn 6595: $status = 'previous';
6596: } elsif ($start > $now) {
6597: $status = 'future';
6598: } else {
6599: $status = 'active';
6600: }
1.277 albertel 6601: foreach my $type (keys(%{$types})) {
1.275 raeburn 6602: if ($status eq $type) {
1.420 albertel 6603: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6604: push(@{$$users{$role}{$user}},$type);
6605: }
1.288 raeburn 6606: $match = 1;
6607: }
6608: }
1.419 raeburn 6609: if (($match) && (ref($userdata) eq 'HASH')) {
6610: if (!exists($$userdata{$uname.':'.$udom})) {
6611: &get_user_info($udom,$uname,\%idx,$userdata);
6612: }
1.420 albertel 6613: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6614: push(@{$seclists{$uname.':'.$udom}},$usec);
6615: }
1.609 raeburn 6616: if (ref($statushash) eq 'HASH') {
6617: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6618: }
1.275 raeburn 6619: }
6620: }
6621: }
6622: }
1.290 albertel 6623: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6624: if ((defined($cdom)) && (defined($cnum))) {
6625: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6626: if ( defined($csettings{'internal.courseowner'}) ) {
6627: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6628: next if ($owner eq '');
6629: my ($ownername,$ownerdom);
6630: if ($owner =~ /^([^:]+):([^:]+)$/) {
6631: $ownername = $1;
6632: $ownerdom = $2;
6633: } else {
6634: $ownername = $owner;
6635: $ownerdom = $cdom;
6636: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6637: }
6638: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6639: if (defined($userdata) &&
1.609 raeburn 6640: !exists($$userdata{$owner})) {
6641: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6642: if (!grep(/^none$/,@{$seclists{$owner}})) {
6643: push(@{$seclists{$owner}},'none');
6644: }
6645: if (ref($statushash) eq 'HASH') {
6646: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6647: }
1.290 albertel 6648: }
1.279 raeburn 6649: }
6650: }
6651: }
1.419 raeburn 6652: foreach my $user (keys(%seclists)) {
6653: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6654: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6655: }
1.275 raeburn 6656: }
6657: return;
6658: }
6659:
1.288 raeburn 6660: sub get_user_info {
6661: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6662: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6663: &plainname($uname,$udom,'lastname');
1.291 albertel 6664: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6665: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6666: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6667: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6668: return;
6669: }
1.275 raeburn 6670:
1.472 raeburn 6671: ###############################################
6672:
6673: =pod
6674:
6675: =item * &get_user_quota()
6676:
6677: Retrieves quota assigned for storage of portfolio files for a user
6678:
6679: Incoming parameters:
6680: 1. user's username
6681: 2. user's domain
6682:
6683: Returns:
1.536 raeburn 6684: 1. Disk quota (in Mb) assigned to student.
6685: 2. (Optional) Type of setting: custom or default
6686: (individually assigned or default for user's
6687: institutional status).
6688: 3. (Optional) - User's institutional status (e.g., faculty, staff
6689: or student - types as defined in localenroll::inst_usertypes
6690: for user's domain, which determines default quota for user.
6691: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6692:
6693: If a value has been stored in the user's environment,
1.536 raeburn 6694: it will return that, otherwise it returns the maximal default
6695: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6696:
6697: =cut
6698:
6699: ###############################################
6700:
6701:
6702: sub get_user_quota {
6703: my ($uname,$udom) = @_;
1.536 raeburn 6704: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6705: if (!defined($udom)) {
6706: $udom = $env{'user.domain'};
6707: }
6708: if (!defined($uname)) {
6709: $uname = $env{'user.name'};
6710: }
6711: if (($udom eq '' || $uname eq '') ||
6712: ($udom eq 'public') && ($uname eq 'public')) {
6713: $quota = 0;
1.536 raeburn 6714: $quotatype = 'default';
6715: $defquota = 0;
1.472 raeburn 6716: } else {
1.536 raeburn 6717: my $inststatus;
1.472 raeburn 6718: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6719: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6720: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6721: } else {
1.536 raeburn 6722: my %userenv =
6723: &Apache::lonnet::get('environment',['portfolioquota',
6724: 'inststatus'],$udom,$uname);
1.472 raeburn 6725: my ($tmp) = keys(%userenv);
6726: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6727: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6728: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6729: } else {
6730: undef(%userenv);
6731: }
6732: }
1.536 raeburn 6733: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6734: if ($quota eq '') {
1.536 raeburn 6735: $quota = $defquota;
6736: $quotatype = 'default';
6737: } else {
6738: $quotatype = 'custom';
1.472 raeburn 6739: }
6740: }
1.536 raeburn 6741: if (wantarray) {
6742: return ($quota,$quotatype,$settingstatus,$defquota);
6743: } else {
6744: return $quota;
6745: }
1.472 raeburn 6746: }
6747:
6748: ###############################################
6749:
6750: =pod
6751:
6752: =item * &default_quota()
6753:
1.536 raeburn 6754: Retrieves default quota assigned for storage of user portfolio files,
6755: given an (optional) user's institutional status.
1.472 raeburn 6756:
6757: Incoming parameters:
6758: 1. domain
1.536 raeburn 6759: 2. (Optional) institutional status(es). This is a : separated list of
6760: status types (e.g., faculty, staff, student etc.)
6761: which apply to the user for whom the default is being retrieved.
6762: If the institutional status string in undefined, the domain
6763: default quota will be returned.
1.472 raeburn 6764:
6765: Returns:
6766: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6767: 2. (Optional) institutional type which determined the value of the
6768: default quota.
1.472 raeburn 6769:
6770: If a value has been stored in the domain's configuration db,
6771: it will return that, otherwise it returns 20 (for backwards
6772: compatibility with domains which have not set up a configuration
6773: db file; the original statically defined portfolio quota was 20 Mb).
6774:
1.536 raeburn 6775: If the user's status includes multiple types (e.g., staff and student),
6776: the largest default quota which applies to the user determines the
6777: default quota returned.
6778:
1.472 raeburn 6779: =cut
6780:
6781: ###############################################
6782:
6783:
6784: sub default_quota {
1.536 raeburn 6785: my ($udom,$inststatus) = @_;
6786: my ($defquota,$settingstatus);
6787: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6788: ['quotas'],$udom);
6789: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6790: if ($inststatus ne '') {
6791: my @statuses = split(/:/,$inststatus);
6792: foreach my $item (@statuses) {
1.622 raeburn 6793: if ($quotahash{'quotas'}{$item} ne '') {
1.536 raeburn 6794: if ($defquota eq '') {
1.622 raeburn 6795: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6796: $settingstatus = $item;
1.622 raeburn 6797: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6798: $defquota = $quotahash{'quotas'}{$item};
1.536 raeburn 6799: $settingstatus = $item;
6800: }
6801: }
6802: }
6803: }
6804: if ($defquota eq '') {
1.622 raeburn 6805: $defquota = $quotahash{'quotas'}{'default'};
1.536 raeburn 6806: $settingstatus = 'default';
6807: }
6808: } else {
6809: $settingstatus = 'default';
6810: $defquota = 20;
6811: }
6812: if (wantarray) {
6813: return ($defquota,$settingstatus);
1.472 raeburn 6814: } else {
1.536 raeburn 6815: return $defquota;
1.472 raeburn 6816: }
6817: }
6818:
1.384 raeburn 6819: sub get_secgrprole_info {
6820: my ($cdom,$cnum,$needroles,$type) = @_;
6821: my %sections_count = &get_sections($cdom,$cnum);
6822: my @sections = (sort {$a <=> $b} keys(%sections_count));
6823: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6824: my @groups = sort(keys(%curr_groups));
6825: my $allroles = [];
6826: my $rolehash;
6827: my $accesshash = {
6828: active => 'Currently has access',
6829: future => 'Will have future access',
6830: previous => 'Previously had access',
6831: };
6832: if ($needroles) {
6833: $rolehash = {'all' => 'all'};
1.385 albertel 6834: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6835: if (&Apache::lonnet::error(%user_roles)) {
6836: undef(%user_roles);
6837: }
6838: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6839: my ($role)=split(/\:/,$item,2);
6840: if ($role eq 'cr') { next; }
6841: if ($role =~ /^cr/) {
6842: $$rolehash{$role} = (split('/',$role))[3];
6843: } else {
6844: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6845: }
6846: }
6847: foreach my $key (sort(keys(%{$rolehash}))) {
6848: push(@{$allroles},$key);
6849: }
6850: push (@{$allroles},'st');
6851: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6852: }
6853: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6854: }
6855:
1.555 raeburn 6856: sub user_picker {
1.627 raeburn 6857: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6858: my $currdom = $dom;
6859: my %curr_selected = (
6860: srchin => 'dom',
1.580 raeburn 6861: srchby => 'lastname',
1.555 raeburn 6862: );
6863: my $srchterm;
1.625 raeburn 6864: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6865: if ($srch->{'srchby'} ne '') {
6866: $curr_selected{'srchby'} = $srch->{'srchby'};
6867: }
6868: if ($srch->{'srchin'} ne '') {
6869: $curr_selected{'srchin'} = $srch->{'srchin'};
6870: }
6871: if ($srch->{'srchtype'} ne '') {
6872: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6873: }
6874: if ($srch->{'srchdomain'} ne '') {
6875: $currdom = $srch->{'srchdomain'};
6876: }
6877: $srchterm = $srch->{'srchterm'};
6878: }
6879: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6880: 'usr' => 'Search criteria',
1.563 raeburn 6881: 'doma' => 'Domain/institution to search',
1.558 albertel 6882: 'uname' => 'username',
6883: 'lastname' => 'last name',
1.555 raeburn 6884: 'lastfirst' => 'last name, first name',
1.558 albertel 6885: 'crs' => 'in this course',
1.576 raeburn 6886: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6887: 'alc' => 'all LON-CAPA',
1.573 raeburn 6888: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6889: 'exact' => 'is',
6890: 'contains' => 'contains',
1.569 raeburn 6891: 'begins' => 'begins with',
1.571 raeburn 6892: 'youm' => "You must include some text to search for.",
6893: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6894: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6895: 'yomc' => "You must choose a domain when using an institutional directory search.",
6896: 'ymcd' => "You must choose a domain when using a domain search.",
6897: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6898: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6899: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6900: );
1.563 raeburn 6901: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6902: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6903:
6904: my @srchins = ('crs','dom','alc','instd');
6905:
6906: foreach my $option (@srchins) {
6907: # FIXME 'alc' option unavailable until
6908: # loncreateuser::print_user_query_page()
6909: # has been completed.
6910: next if ($option eq 'alc');
6911: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6912: if ($curr_selected{'srchin'} eq $option) {
6913: $srchinsel .= '
6914: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6915: } else {
6916: $srchinsel .= '
6917: <option value="'.$option.'">'.$lt{$option}.'</option>';
6918: }
1.555 raeburn 6919: }
1.563 raeburn 6920: $srchinsel .= "\n </select>\n";
1.555 raeburn 6921:
6922: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6923: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6924: if ($curr_selected{'srchby'} eq $option) {
6925: $srchbysel .= '
6926: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6927: } else {
6928: $srchbysel .= '
6929: <option value="'.$option.'">'.$lt{$option}.'</option>';
6930: }
6931: }
6932: $srchbysel .= "\n </select>\n";
6933:
6934: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6935: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6936: if ($curr_selected{'srchtype'} eq $option) {
6937: $srchtypesel .= '
6938: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6939: } else {
6940: $srchtypesel .= '
6941: <option value="'.$option.'">'.$lt{$option}.'</option>';
6942: }
6943: }
6944: $srchtypesel .= "\n </select>\n";
6945:
1.558 albertel 6946: my ($newuserscript,$new_user_create);
1.556 raeburn 6947:
6948: if ($forcenewuser) {
1.576 raeburn 6949: if (ref($srch) eq 'HASH') {
6950: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6951: if ($cancreate) {
6952: $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>';
6953: } else {
6954: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6955: my %usertypetext = (
6956: official => 'institutional',
6957: unofficial => 'non-institutional',
6958: );
6959: $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 />';
6960: }
1.576 raeburn 6961: }
6962: }
6963:
1.556 raeburn 6964: $newuserscript = <<"ENDSCRIPT";
6965:
1.570 raeburn 6966: function setSearch(createnew,callingForm) {
1.556 raeburn 6967: if (createnew == 1) {
1.570 raeburn 6968: for (var i=0; i<callingForm.srchby.length; i++) {
6969: if (callingForm.srchby.options[i].value == 'uname') {
6970: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6971: }
6972: }
1.570 raeburn 6973: for (var i=0; i<callingForm.srchin.length; i++) {
6974: if ( callingForm.srchin.options[i].value == 'dom') {
6975: callingForm.srchin.selectedIndex = i;
1.556 raeburn 6976: }
6977: }
1.570 raeburn 6978: for (var i=0; i<callingForm.srchtype.length; i++) {
6979: if (callingForm.srchtype.options[i].value == 'exact') {
6980: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 6981: }
6982: }
1.570 raeburn 6983: for (var i=0; i<callingForm.srchdomain.length; i++) {
6984: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6985: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 6986: }
6987: }
6988: }
6989: }
6990: ENDSCRIPT
1.558 albertel 6991:
1.556 raeburn 6992: }
6993:
1.555 raeburn 6994: my $output = <<"END_BLOCK";
1.556 raeburn 6995: <script type="text/javascript">
1.570 raeburn 6996: function validateEntry(callingForm) {
1.558 albertel 6997:
1.556 raeburn 6998: var checkok = 1;
1.558 albertel 6999: var srchin;
1.570 raeburn 7000: for (var i=0; i<callingForm.srchin.length; i++) {
7001: if ( callingForm.srchin[i].checked ) {
7002: srchin = callingForm.srchin[i].value;
1.558 albertel 7003: }
7004: }
7005:
1.570 raeburn 7006: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7007: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7008: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7009: var srchterm = callingForm.srchterm.value;
7010: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7011: var msg = "";
7012:
7013: if (srchterm == "") {
7014: checkok = 0;
1.571 raeburn 7015: msg += "$lt{'youm'}\\n";
1.556 raeburn 7016: }
7017:
1.569 raeburn 7018: if (srchtype== 'begins') {
7019: if (srchterm.length < 2) {
7020: checkok = 0;
1.571 raeburn 7021: msg += "$lt{'thte'}\\n";
1.569 raeburn 7022: }
7023: }
7024:
1.556 raeburn 7025: if (srchtype== 'contains') {
7026: if (srchterm.length < 3) {
7027: checkok = 0;
1.571 raeburn 7028: msg += "$lt{'thet'}\\n";
1.556 raeburn 7029: }
7030: }
7031: if (srchin == 'instd') {
7032: if (srchdomain == '') {
7033: checkok = 0;
1.571 raeburn 7034: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7035: }
7036: }
7037: if (srchin == 'dom') {
7038: if (srchdomain == '') {
7039: checkok = 0;
1.571 raeburn 7040: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7041: }
7042: }
7043: if (srchby == 'lastfirst') {
7044: if (srchterm.indexOf(",") == -1) {
7045: checkok = 0;
1.571 raeburn 7046: msg += "$lt{'whus'}\\n";
1.556 raeburn 7047: }
7048: if (srchterm.indexOf(",") == srchterm.length -1) {
7049: checkok = 0;
1.571 raeburn 7050: msg += "$lt{'whse'}\\n";
1.556 raeburn 7051: }
7052: }
7053: if (checkok == 0) {
1.571 raeburn 7054: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7055: return;
7056: }
7057: if (checkok == 1) {
1.570 raeburn 7058: callingForm.submit();
1.556 raeburn 7059: }
7060: }
7061:
7062: $newuserscript
7063:
7064: </script>
1.558 albertel 7065:
7066: $new_user_create
7067:
1.555 raeburn 7068: <table>
1.558 albertel 7069: <tr>
1.573 raeburn 7070: <td>$lt{'doma'}:</td>
7071: <td>$domform</td>
7072: </td>
7073: </tr>
7074: <tr>
7075: <td>$lt{'usr'}:</td>
1.563 raeburn 7076: <td>$srchbysel
7077: $srchtypesel
7078: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7079: $srchinsel
1.563 raeburn 7080: </td>
7081: </tr>
1.555 raeburn 7082: </table>
7083: <br />
7084: END_BLOCK
1.558 albertel 7085:
1.555 raeburn 7086: return $output;
7087: }
7088:
1.612 raeburn 7089: sub user_rule_check {
1.615 raeburn 7090: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7091: my $response;
7092: if (ref($usershash) eq 'HASH') {
7093: foreach my $user (keys(%{$usershash})) {
7094: my ($uname,$udom) = split(/:/,$user);
7095: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7096: my ($id,$newuser);
1.612 raeburn 7097: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7098: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7099: $id = $usershash->{$user}->{'id'};
7100: }
7101: my $inst_response;
7102: if (ref($checks) eq 'HASH') {
7103: if (defined($checks->{'username'})) {
1.615 raeburn 7104: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7105: &Apache::lonnet::get_instuser($udom,$uname);
7106: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7107: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7108: &Apache::lonnet::get_instuser($udom,undef,$id);
7109: }
1.615 raeburn 7110: } else {
7111: ($inst_response,%{$inst_results->{$user}}) =
7112: &Apache::lonnet::get_instuser($udom,$uname);
7113: return;
1.612 raeburn 7114: }
1.615 raeburn 7115: if (!$got_rules->{$udom}) {
1.612 raeburn 7116: my %domconfig = &Apache::lonnet::get_dom('configuration',
7117: ['usercreation'],$udom);
7118: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7119: foreach my $item ('username','id') {
1.612 raeburn 7120: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7121: $$curr_rules{$udom}{$item} =
7122: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7123: }
7124: }
7125: }
1.615 raeburn 7126: $got_rules->{$udom} = 1;
1.585 raeburn 7127: }
1.612 raeburn 7128: foreach my $item (keys(%{$checks})) {
7129: if (ref($$curr_rules{$udom}) eq 'HASH') {
7130: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7131: if (@{$$curr_rules{$udom}{$item}} > 0) {
7132: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7133: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7134: if ($rule_check{$rule}) {
7135: $$rulematch{$user}{$item} = $rule;
7136: if ($inst_response eq 'ok') {
1.615 raeburn 7137: if (ref($inst_results) eq 'HASH') {
7138: if (ref($inst_results->{$user}) eq 'HASH') {
7139: if (keys(%{$inst_results->{$user}}) == 0) {
7140: $$alerts{$item}{$udom}{$uname} = 1;
7141: }
1.612 raeburn 7142: }
7143: }
1.615 raeburn 7144: }
7145: last;
1.585 raeburn 7146: }
7147: }
7148: }
7149: }
7150: }
7151: }
7152: }
7153: }
1.612 raeburn 7154: return;
7155: }
7156:
7157: sub user_rule_formats {
7158: my ($domain,$domdesc,$curr_rules,$check) = @_;
7159: my %text = (
7160: 'username' => 'Usernames',
7161: 'id' => 'IDs',
7162: );
7163: my $output;
7164: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7165: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7166: if (@{$ruleorder} > 0) {
7167: $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>';
7168: foreach my $rule (@{$ruleorder}) {
7169: if (ref($curr_rules) eq 'ARRAY') {
7170: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7171: if (ref($rules->{$rule}) eq 'HASH') {
7172: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7173: $rules->{$rule}{'desc'}.'</li>';
7174: }
7175: }
7176: }
7177: }
7178: $output .= '</ul>';
7179: }
7180: }
7181: return $output;
7182: }
7183:
7184: sub instrule_disallow_msg {
1.615 raeburn 7185: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7186: my $response;
7187: my %text = (
7188: item => 'username',
7189: items => 'usernames',
7190: match => 'matches',
7191: do => 'does',
7192: action => 'a username',
7193: one => 'one',
7194: );
7195: if ($count > 1) {
7196: $text{'item'} = 'usernames';
7197: $text{'match'} ='match';
7198: $text{'do'} = 'do';
7199: $text{'action'} = 'usernames',
7200: $text{'one'} = 'ones';
7201: }
7202: if ($checkitem eq 'id') {
7203: $text{'items'} = 'IDs';
7204: $text{'item'} = 'ID';
7205: $text{'action'} = 'an ID';
1.615 raeburn 7206: if ($count > 1) {
7207: $text{'item'} = 'IDs';
7208: $text{'action'} = 'IDs';
7209: }
1.612 raeburn 7210: }
1.674 bisitz 7211: $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 7212: if ($mode eq 'upload') {
7213: if ($checkitem eq 'username') {
7214: $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'}.");
7215: } elsif ($checkitem eq 'id') {
1.674 bisitz 7216: $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 7217: }
1.669 raeburn 7218: } elsif ($mode eq 'selfcreate') {
7219: if ($checkitem eq 'id') {
7220: $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.");
7221: }
1.615 raeburn 7222: } else {
7223: if ($checkitem eq 'username') {
7224: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7225: } elsif ($checkitem eq 'id') {
7226: $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.");
7227: }
1.612 raeburn 7228: }
7229: return $response;
1.585 raeburn 7230: }
7231:
1.624 raeburn 7232: sub personal_data_fieldtitles {
7233: my %fieldtitles = &Apache::lonlocal::texthash (
7234: id => 'Student/Employee ID',
7235: permanentemail => 'E-mail address',
7236: lastname => 'Last Name',
7237: firstname => 'First Name',
7238: middlename => 'Middle Name',
7239: generation => 'Generation',
7240: gen => 'Generation',
7241: );
7242: return %fieldtitles;
7243: }
7244:
1.642 raeburn 7245: sub sorted_inst_types {
7246: my ($dom) = @_;
7247: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7248: my $othertitle = &mt('All users');
7249: if ($env{'request.course.id'}) {
1.668 raeburn 7250: $othertitle = &mt('Any users');
1.642 raeburn 7251: }
7252: my @types;
7253: if (ref($order) eq 'ARRAY') {
7254: @types = @{$order};
7255: }
7256: if (@types == 0) {
7257: if (ref($usertypes) eq 'HASH') {
7258: @types = sort(keys(%{$usertypes}));
7259: }
7260: }
7261: if (keys(%{$usertypes}) > 0) {
7262: $othertitle = &mt('Other users');
7263: }
7264: return ($othertitle,$usertypes,\@types);
7265: }
7266:
1.645 raeburn 7267: sub get_institutional_codes {
7268: my ($settings,$allcourses,$LC_code) = @_;
7269: # Get complete list of course sections to update
7270: my @currsections = ();
7271: my @currxlists = ();
7272: my $coursecode = $$settings{'internal.coursecode'};
7273:
7274: if ($$settings{'internal.sectionnums'} ne '') {
7275: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7276: }
7277:
7278: if ($$settings{'internal.crosslistings'} ne '') {
7279: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7280: }
7281:
7282: if (@currxlists > 0) {
7283: foreach (@currxlists) {
7284: if (m/^([^:]+):(\w*)$/) {
7285: unless (grep/^$1$/,@{$allcourses}) {
7286: push @{$allcourses},$1;
7287: $$LC_code{$1} = $2;
7288: }
7289: }
7290: }
7291: }
7292:
7293: if (@currsections > 0) {
7294: foreach (@currsections) {
7295: if (m/^(\w+):(\w*)$/) {
7296: my $sec = $coursecode.$1;
7297: my $lc_sec = $2;
7298: unless (grep/^$sec$/,@{$allcourses}) {
7299: push @{$allcourses},$sec;
7300: $$LC_code{$sec} = $lc_sec;
7301: }
7302: }
7303: }
7304: }
7305: return;
7306: }
7307:
1.112 bowersj2 7308: =pod
7309:
1.549 albertel 7310: =back
7311:
7312: =head1 HTTP Helpers
7313:
7314: =over 4
7315:
1.648 raeburn 7316: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7317:
1.258 albertel 7318: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7319: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7320: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7321:
7322: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7323: $possible_names is an ref to an array of form element names. As an example:
7324: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7325: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7326:
7327: =cut
1.1 albertel 7328:
1.6 albertel 7329: sub get_unprocessed_cgi {
1.25 albertel 7330: my ($query,$possible_names)= @_;
1.26 matthew 7331: # $Apache::lonxml::debug=1;
1.356 albertel 7332: foreach my $pair (split(/&/,$query)) {
7333: my ($name, $value) = split(/=/,$pair);
1.369 www 7334: $name = &unescape($name);
1.25 albertel 7335: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7336: $value =~ tr/+/ /;
7337: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7338: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7339: }
1.16 harris41 7340: }
1.6 albertel 7341: }
7342:
1.112 bowersj2 7343: =pod
7344:
1.648 raeburn 7345: =item * &cacheheader()
1.112 bowersj2 7346:
7347: returns cache-controlling header code
7348:
7349: =cut
7350:
1.7 albertel 7351: sub cacheheader {
1.258 albertel 7352: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7353: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7354: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7355: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7356: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7357: return $output;
1.7 albertel 7358: }
7359:
1.112 bowersj2 7360: =pod
7361:
1.648 raeburn 7362: =item * &no_cache($r)
1.112 bowersj2 7363:
7364: specifies header code to not have cache
7365:
7366: =cut
7367:
1.9 albertel 7368: sub no_cache {
1.216 albertel 7369: my ($r) = @_;
7370: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7371: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7372: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7373: $r->no_cache(1);
7374: $r->header_out("Expires" => $date);
7375: $r->header_out("Pragma" => "no-cache");
1.123 www 7376: }
7377:
7378: sub content_type {
1.181 albertel 7379: my ($r,$type,$charset) = @_;
1.299 foxr 7380: if ($r) {
7381: # Note that printout.pl calls this with undef for $r.
7382: &no_cache($r);
7383: }
1.258 albertel 7384: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7385: unless ($charset) {
7386: $charset=&Apache::lonlocal::current_encoding;
7387: }
7388: if ($charset) { $type.='; charset='.$charset; }
7389: if ($r) {
7390: $r->content_type($type);
7391: } else {
7392: print("Content-type: $type\n\n");
7393: }
1.9 albertel 7394: }
1.25 albertel 7395:
1.112 bowersj2 7396: =pod
7397:
1.648 raeburn 7398: =item * &add_to_env($name,$value)
1.112 bowersj2 7399:
1.258 albertel 7400: adds $name to the %env hash with value
1.112 bowersj2 7401: $value, if $name already exists, the entry is converted to an array
7402: reference and $value is added to the array.
7403:
7404: =cut
7405:
1.25 albertel 7406: sub add_to_env {
7407: my ($name,$value)=@_;
1.258 albertel 7408: if (defined($env{$name})) {
7409: if (ref($env{$name})) {
1.25 albertel 7410: #already have multiple values
1.258 albertel 7411: push(@{ $env{$name} },$value);
1.25 albertel 7412: } else {
7413: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7414: my $first=$env{$name};
7415: undef($env{$name});
7416: push(@{ $env{$name} },$first,$value);
1.25 albertel 7417: }
7418: } else {
1.258 albertel 7419: $env{$name}=$value;
1.25 albertel 7420: }
1.31 albertel 7421: }
1.149 albertel 7422:
7423: =pod
7424:
1.648 raeburn 7425: =item * &get_env_multiple($name)
1.149 albertel 7426:
1.258 albertel 7427: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7428: values may be defined and end up as an array ref.
7429:
7430: returns an array of values
7431:
7432: =cut
7433:
7434: sub get_env_multiple {
7435: my ($name) = @_;
7436: my @values;
1.258 albertel 7437: if (defined($env{$name})) {
1.149 albertel 7438: # exists is it an array
1.258 albertel 7439: if (ref($env{$name})) {
7440: @values=@{ $env{$name} };
1.149 albertel 7441: } else {
1.258 albertel 7442: $values[0]=$env{$name};
1.149 albertel 7443: }
7444: }
7445: return(@values);
7446: }
7447:
1.660 raeburn 7448: sub ask_for_embedded_content {
7449: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7450: my $upload_output = '
7451: <form name="upload_embedded" action="'.$actionurl.'"
7452: method="post" enctype="multipart/form-data">';
7453: $upload_output .= $state;
1.661 raeburn 7454: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7455:
7456: my $num = 0;
7457: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7458: $upload_output .= &start_data_table_row().
7459: '<td>'.$embed_file.'</td><td>';
7460: if ($args->{'ignore_remote_references'}
7461: && $embed_file =~ m{^\w+://}) {
7462: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7463: } elsif ($args->{'error_on_invalid_names'}
7464: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7465:
7466: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7467:
7468: } else {
7469: $upload_output .='
1.661 raeburn 7470: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7471: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7472: my $attrib = join(':',@{$$allfiles{$embed_file}});
7473: $upload_output .=
7474: "\n\t\t".
7475: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7476: $attrib.'" />';
7477: if (exists($$codebase{$embed_file})) {
7478: $upload_output .=
7479: "\n\t\t".
7480: '<input name="codebase_'.$num.'" type="hidden" value="'.
7481: &escape($$codebase{$embed_file}).'" />';
7482: }
7483: }
7484: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7485: $num++;
7486: }
7487: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7488: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7489: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7490: '.&mt('(only files for which a location has been provided will be uploaded)').'
7491: </form>';
7492: return $upload_output;
7493: }
7494:
1.661 raeburn 7495: sub upload_embedded {
7496: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7497: $current_disk_usage) = @_;
7498: my $output;
7499: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7500: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7501: my $orig_uploaded_filename =
7502: $env{'form.embedded_item_'.$i.'.filename'};
7503:
7504: $env{'form.embedded_orig_'.$i} =
7505: &unescape($env{'form.embedded_orig_'.$i});
7506: my ($path,$fname) =
7507: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7508: # no path, whole string is fname
7509: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7510:
7511: $path = $env{'form.currentpath'}.$path;
7512: $fname = &Apache::lonnet::clean_filename($fname);
7513: # See if there is anything left
7514: next if ($fname eq '');
7515:
7516: # Check if file already exists as a file or directory.
7517: my ($state,$msg);
7518: if ($context eq 'portfolio') {
7519: my $port_path = $dirpath;
7520: if ($group ne '') {
7521: $port_path = "groups/$group/$port_path";
7522: }
7523: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7524: $dir_root,$port_path,$disk_quota,
7525: $current_disk_usage,$uname,$udom);
7526: if ($state eq 'will_exceed_quota'
7527: || $state eq 'file_locked'
7528: || $state eq 'file_exists' ) {
7529: $output .= $msg;
7530: next;
7531: }
7532: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7533: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7534: if ($state eq 'exists') {
7535: $output .= $msg;
7536: next;
7537: }
7538: }
7539: # Check if extension is valid
7540: if (($fname =~ /\.(\w+)$/) &&
7541: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7542: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7543: next;
7544: } elsif (($fname =~ /\.(\w+)$/) &&
7545: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7546: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7547: next;
7548: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7549: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7550: next;
7551: }
7552:
7553: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7554: if ($context eq 'portfolio') {
7555: my $result=
7556: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7557: $dirpath.$path);
7558: if ($result !~ m|^/uploaded/|) {
7559: $output .= '<span class="LC_error">'
7560: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7561: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7562: .'</span><br />';
7563: next;
7564: } else {
7565: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7566: $path.$fname.'</span>').'</p>';
7567: }
7568: } else {
7569: # Save the file
7570: my $target = $env{'form.embedded_item_'.$i};
7571: my $fullpath = $dir_root.$dirpath.'/'.$path;
7572: my $dest = $fullpath.$fname;
7573: my $url = $url_root.$dirpath.'/'.$path.$fname;
7574: my @parts=split(/\//,$fullpath);
7575: my $count;
7576: my $filepath = $dir_root;
7577: for ($count=4;$count<=$#parts;$count++) {
7578: $filepath .= "/$parts[$count]";
7579: if ((-e $filepath)!=1) {
7580: mkdir($filepath,0770);
7581: }
7582: }
7583: my $fh;
7584: if (!open($fh,'>'.$dest)) {
7585: &Apache::lonnet::logthis('Failed to create '.$dest);
7586: $output .= '<span class="LC_error">'.
7587: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7588: '</span><br />';
7589: } else {
7590: if (!print $fh $env{'form.embedded_item_'.$i}) {
7591: &Apache::lonnet::logthis('Failed to write to '.$dest);
7592: $output .= '<span class="LC_error">'.
7593: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7594: '</span><br />';
7595: } else {
7596: if ($context eq 'testbank') {
7597: $output .= &mt('Embedded file uploaded successfully:').
7598: ' <a href="'.$url.'">'.
7599: $orig_uploaded_filename.'</a><br />';
7600: } else {
7601: $output .= '<font size="+2">'.
7602: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
7603: $orig_uploaded_filename.'</a>').'</font><br />';
7604: }
7605: }
7606: close($fh);
7607: }
7608: }
7609: }
7610: return $output;
7611: }
7612:
7613: sub check_for_existing {
7614: my ($path,$fname,$element) = @_;
7615: my ($state,$msg);
7616: if (-d $path.'/'.$fname) {
7617: $state = 'exists';
7618: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7619: } elsif (-e $path.'/'.$fname) {
7620: $state = 'exists';
7621: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7622: }
7623: if ($state eq 'exists') {
7624: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7625: }
7626: return ($state,$msg);
7627: }
7628:
7629: sub check_for_upload {
7630: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7631: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7632: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7633: my $getpropath = 1;
7634: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7635: $getpropath);
7636: my $found_file = 0;
7637: my $locked_file = 0;
7638: foreach my $line (@dir_list) {
7639: my ($file_name)=split(/\&/,$line,2);
7640: if ($file_name eq $fname){
7641: $file_name = $path.$file_name;
7642: if ($group ne '') {
7643: $file_name = $group.$file_name;
7644: }
7645: $found_file = 1;
7646: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7647: $locked_file = 1;
7648: }
7649: }
7650: }
7651: if (($current_disk_usage + $filesize) > $disk_quota){
7652: my $msg = '<span class="LC_error">'.
7653: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7654: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7655: return ('will_exceed_quota',$msg);
7656: } elsif ($found_file) {
7657: if ($locked_file) {
7658: my $msg = '<span class="LC_error">';
7659: $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>');
7660: $msg .= '</span><br />';
7661: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7662: return ('file_locked',$msg);
7663: } else {
7664: my $msg = '<span class="LC_error">';
7665: $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'});
7666: $msg .= '</span>';
7667: $msg .= '<br />';
7668: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7669: return ('file_exists',$msg);
7670: }
7671: }
7672: }
7673:
1.31 albertel 7674:
1.41 ng 7675: =pod
1.45 matthew 7676:
1.464 albertel 7677: =back
1.41 ng 7678:
1.112 bowersj2 7679: =head1 CSV Upload/Handling functions
1.38 albertel 7680:
1.41 ng 7681: =over 4
7682:
1.648 raeburn 7683: =item * &upfile_store($r)
1.41 ng 7684:
7685: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7686: needs $env{'form.upfile'}
1.41 ng 7687: returns $datatoken to be put into hidden field
7688:
7689: =cut
1.31 albertel 7690:
7691: sub upfile_store {
7692: my $r=shift;
1.258 albertel 7693: $env{'form.upfile'}=~s/\r/\n/gs;
7694: $env{'form.upfile'}=~s/\f/\n/gs;
7695: $env{'form.upfile'}=~s/\n+/\n/gs;
7696: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7697:
1.258 albertel 7698: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7699: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7700: {
1.158 raeburn 7701: my $datafile = $r->dir_config('lonDaemons').
7702: '/tmp/'.$datatoken.'.tmp';
7703: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7704: print $fh $env{'form.upfile'};
1.158 raeburn 7705: close($fh);
7706: }
1.31 albertel 7707: }
7708: return $datatoken;
7709: }
7710:
1.56 matthew 7711: =pod
7712:
1.648 raeburn 7713: =item * &load_tmp_file($r)
1.41 ng 7714:
7715: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7716: needs $env{'form.datatoken'},
7717: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7718:
7719: =cut
1.31 albertel 7720:
7721: sub load_tmp_file {
7722: my $r=shift;
7723: my @studentdata=();
7724: {
1.158 raeburn 7725: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7726: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7727: if ( open(my $fh,"<$studentfile") ) {
7728: @studentdata=<$fh>;
7729: close($fh);
7730: }
1.31 albertel 7731: }
1.258 albertel 7732: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7733: }
7734:
1.56 matthew 7735: =pod
7736:
1.648 raeburn 7737: =item * &upfile_record_sep()
1.41 ng 7738:
7739: Separate uploaded file into records
7740: returns array of records,
1.258 albertel 7741: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7742:
7743: =cut
1.31 albertel 7744:
7745: sub upfile_record_sep {
1.258 albertel 7746: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7747: } else {
1.248 albertel 7748: my @records;
1.258 albertel 7749: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7750: if ($line=~/^\s*$/) { next; }
7751: push(@records,$line);
7752: }
7753: return @records;
1.31 albertel 7754: }
7755: }
7756:
1.56 matthew 7757: =pod
7758:
1.648 raeburn 7759: =item * &record_sep($record)
1.41 ng 7760:
1.258 albertel 7761: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7762:
7763: =cut
7764:
1.263 www 7765: sub takeleft {
7766: my $index=shift;
7767: return substr('0000'.$index,-4,4);
7768: }
7769:
1.31 albertel 7770: sub record_sep {
7771: my $record=shift;
7772: my %components=();
1.258 albertel 7773: if ($env{'form.upfiletype'} eq 'xml') {
7774: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7775: my $i=0;
1.356 albertel 7776: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7777: $field=~s/^(\"|\')//;
7778: $field=~s/(\"|\')$//;
1.263 www 7779: $components{&takeleft($i)}=$field;
1.31 albertel 7780: $i++;
7781: }
1.258 albertel 7782: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7783: my $i=0;
1.356 albertel 7784: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7785: $field=~s/^(\"|\')//;
7786: $field=~s/(\"|\')$//;
1.263 www 7787: $components{&takeleft($i)}=$field;
1.31 albertel 7788: $i++;
7789: }
7790: } else {
1.561 www 7791: my $separator=',';
1.480 banghart 7792: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7793: $separator=';';
1.480 banghart 7794: }
1.31 albertel 7795: my $i=0;
1.561 www 7796: # the character we are looking for to indicate the end of a quote or a record
7797: my $looking_for=$separator;
7798: # do not add the characters to the fields
7799: my $ignore=0;
7800: # we just encountered a separator (or the beginning of the record)
7801: my $just_found_separator=1;
7802: # store the field we are working on here
7803: my $field='';
7804: # work our way through all characters in record
7805: foreach my $character ($record=~/(.)/g) {
7806: if ($character eq $looking_for) {
7807: if ($character ne $separator) {
7808: # Found the end of a quote, again looking for separator
7809: $looking_for=$separator;
7810: $ignore=1;
7811: } else {
7812: # Found a separator, store away what we got
7813: $components{&takeleft($i)}=$field;
7814: $i++;
7815: $just_found_separator=1;
7816: $ignore=0;
7817: $field='';
7818: }
7819: next;
7820: }
7821: # single or double quotation marks after a separator indicate beginning of a quote
7822: # we are now looking for the end of the quote and need to ignore separators
7823: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7824: $looking_for=$character;
7825: next;
7826: }
7827: # ignore would be true after we reached the end of a quote
7828: if ($ignore) { next; }
7829: if (($just_found_separator) && ($character=~/\s/)) { next; }
7830: $field.=$character;
7831: $just_found_separator=0;
1.31 albertel 7832: }
1.561 www 7833: # catch the very last entry, since we never encountered the separator
7834: $components{&takeleft($i)}=$field;
1.31 albertel 7835: }
7836: return %components;
7837: }
7838:
1.144 matthew 7839: ######################################################
7840: ######################################################
7841:
1.56 matthew 7842: =pod
7843:
1.648 raeburn 7844: =item * &upfile_select_html()
1.41 ng 7845:
1.144 matthew 7846: Return HTML code to select a file from the users machine and specify
7847: the file type.
1.41 ng 7848:
7849: =cut
7850:
1.144 matthew 7851: ######################################################
7852: ######################################################
1.31 albertel 7853: sub upfile_select_html {
1.144 matthew 7854: my %Types = (
7855: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7856: semisv => &mt('Semicolon separated values'),
1.144 matthew 7857: space => &mt('Space separated'),
7858: tab => &mt('Tabulator separated'),
7859: # xml => &mt('HTML/XML'),
7860: );
7861: my $Str = '<input type="file" name="upfile" size="50" />'.
7862: '<br />Type: <select name="upfiletype">';
7863: foreach my $type (sort(keys(%Types))) {
7864: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7865: }
7866: $Str .= "</select>\n";
7867: return $Str;
1.31 albertel 7868: }
7869:
1.301 albertel 7870: sub get_samples {
7871: my ($records,$toget) = @_;
7872: my @samples=({});
7873: my $got=0;
7874: foreach my $rec (@$records) {
7875: my %temp = &record_sep($rec);
7876: if (! grep(/\S/, values(%temp))) { next; }
7877: if (%temp) {
7878: $samples[$got]=\%temp;
7879: $got++;
7880: if ($got == $toget) { last; }
7881: }
7882: }
7883: return \@samples;
7884: }
7885:
1.144 matthew 7886: ######################################################
7887: ######################################################
7888:
1.56 matthew 7889: =pod
7890:
1.648 raeburn 7891: =item * &csv_print_samples($r,$records)
1.41 ng 7892:
7893: Prints a table of sample values from each column uploaded $r is an
7894: Apache Request ref, $records is an arrayref from
7895: &Apache::loncommon::upfile_record_sep
7896:
7897: =cut
7898:
1.144 matthew 7899: ######################################################
7900: ######################################################
1.31 albertel 7901: sub csv_print_samples {
7902: my ($r,$records) = @_;
1.662 bisitz 7903: my $samples = &get_samples($records,5);
1.301 albertel 7904:
1.594 raeburn 7905: $r->print(&mt('Samples').'<br />'.&start_data_table().
7906: &start_data_table_header_row());
1.356 albertel 7907: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7908: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7909: $r->print(&end_data_table_header_row());
1.301 albertel 7910: foreach my $hash (@$samples) {
1.594 raeburn 7911: $r->print(&start_data_table_row());
1.356 albertel 7912: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7913: $r->print('<td>');
1.356 albertel 7914: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7915: $r->print('</td>');
7916: }
1.594 raeburn 7917: $r->print(&end_data_table_row());
1.31 albertel 7918: }
1.594 raeburn 7919: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7920: }
7921:
1.144 matthew 7922: ######################################################
7923: ######################################################
7924:
1.56 matthew 7925: =pod
7926:
1.648 raeburn 7927: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 7928:
7929: Prints a table to create associations between values and table columns.
1.144 matthew 7930:
1.41 ng 7931: $r is an Apache Request ref,
7932: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7933: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7934:
7935: =cut
7936:
1.144 matthew 7937: ######################################################
7938: ######################################################
1.31 albertel 7939: sub csv_print_select_table {
7940: my ($r,$records,$d) = @_;
1.301 albertel 7941: my $i=0;
7942: my $samples = &get_samples($records,1);
1.144 matthew 7943: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7944: &start_data_table().&start_data_table_header_row().
1.144 matthew 7945: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7946: '<th>'.&mt('Column').'</th>'.
7947: &end_data_table_header_row()."\n");
1.356 albertel 7948: foreach my $array_ref (@$d) {
7949: my ($value,$display,$defaultcol)=@{ $array_ref };
1.689 bisitz 7950: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 7951:
7952: $r->print('<td><select name=f'.$i.
1.32 matthew 7953: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7954: $r->print('<option value="none"></option>');
1.356 albertel 7955: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7956: $r->print('<option value="'.$sample.'"'.
7957: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 7958: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 7959: }
1.594 raeburn 7960: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7961: $i++;
7962: }
1.594 raeburn 7963: $r->print(&end_data_table());
1.31 albertel 7964: $i--;
7965: return $i;
7966: }
1.56 matthew 7967:
1.144 matthew 7968: ######################################################
7969: ######################################################
7970:
1.56 matthew 7971: =pod
1.31 albertel 7972:
1.648 raeburn 7973: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 7974:
7975: Prints a table of sample values from the upload and can make associate samples to internal names.
7976:
7977: $r is an Apache Request ref,
7978: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7979: $d is an array of 2 element arrays (internal name, displayed name)
7980:
7981: =cut
7982:
1.144 matthew 7983: ######################################################
7984: ######################################################
1.31 albertel 7985: sub csv_samples_select_table {
7986: my ($r,$records,$d) = @_;
7987: my $i=0;
1.144 matthew 7988: #
1.662 bisitz 7989: my $max_samples = 5;
7990: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 7991: $r->print(&start_data_table().
7992: &start_data_table_header_row().'<th>'.
7993: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
7994: &end_data_table_header_row());
1.301 albertel 7995:
7996: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 7997: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 7998: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 7999: foreach my $option (@$d) {
8000: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8001: $r->print('<option value="'.$value.'"'.
1.253 albertel 8002: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8003: $display.'</option>');
1.31 albertel 8004: }
8005: $r->print('</select></td><td>');
1.662 bisitz 8006: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8007: if (defined($samples->[$line]{$key})) {
8008: $r->print($samples->[$line]{$key}."<br />\n");
8009: }
8010: }
1.594 raeburn 8011: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8012: $i++;
8013: }
1.594 raeburn 8014: $r->print(&end_data_table());
1.31 albertel 8015: $i--;
8016: return($i);
1.115 matthew 8017: }
8018:
1.144 matthew 8019: ######################################################
8020: ######################################################
8021:
1.115 matthew 8022: =pod
8023:
1.648 raeburn 8024: =item * &clean_excel_name($name)
1.115 matthew 8025:
8026: Returns a replacement for $name which does not contain any illegal characters.
8027:
8028: =cut
8029:
1.144 matthew 8030: ######################################################
8031: ######################################################
1.115 matthew 8032: sub clean_excel_name {
8033: my ($name) = @_;
8034: $name =~ s/[:\*\?\/\\]//g;
8035: if (length($name) > 31) {
8036: $name = substr($name,0,31);
8037: }
8038: return $name;
1.25 albertel 8039: }
1.84 albertel 8040:
1.85 albertel 8041: =pod
8042:
1.648 raeburn 8043: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8044:
8045: Returns either 1 or undef
8046:
8047: 1 if the part is to be hidden, undef if it is to be shown
8048:
8049: Arguments are:
8050:
8051: $id the id of the part to be checked
8052: $symb, optional the symb of the resource to check
8053: $udom, optional the domain of the user to check for
8054: $uname, optional the username of the user to check for
8055:
8056: =cut
1.84 albertel 8057:
8058: sub check_if_partid_hidden {
8059: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8060: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8061: $symb,$udom,$uname);
1.141 albertel 8062: my $truth=1;
8063: #if the string starts with !, then the list is the list to show not hide
8064: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8065: my @hiddenlist=split(/,/,$hiddenparts);
8066: foreach my $checkid (@hiddenlist) {
1.141 albertel 8067: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8068: }
1.141 albertel 8069: return !$truth;
1.84 albertel 8070: }
1.127 matthew 8071:
1.138 matthew 8072:
8073: ############################################################
8074: ############################################################
8075:
8076: =pod
8077:
1.157 matthew 8078: =back
8079:
1.138 matthew 8080: =head1 cgi-bin script and graphing routines
8081:
1.157 matthew 8082: =over 4
8083:
1.648 raeburn 8084: =item * &get_cgi_id()
1.138 matthew 8085:
8086: Inputs: none
8087:
8088: Returns an id which can be used to pass environment variables
8089: to various cgi-bin scripts. These environment variables will
8090: be removed from the users environment after a given time by
8091: the routine &Apache::lonnet::transfer_profile_to_env.
8092:
8093: =cut
8094:
8095: ############################################################
8096: ############################################################
1.152 albertel 8097: my $uniq=0;
1.136 matthew 8098: sub get_cgi_id {
1.154 albertel 8099: $uniq=($uniq+1)%100000;
1.280 albertel 8100: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8101: }
8102:
1.127 matthew 8103: ############################################################
8104: ############################################################
8105:
8106: =pod
8107:
1.648 raeburn 8108: =item * &DrawBarGraph()
1.127 matthew 8109:
1.138 matthew 8110: Facilitates the plotting of data in a (stacked) bar graph.
8111: Puts plot definition data into the users environment in order for
8112: graph.png to plot it. Returns an <img> tag for the plot.
8113: The bars on the plot are labeled '1','2',...,'n'.
8114:
8115: Inputs:
8116:
8117: =over 4
8118:
8119: =item $Title: string, the title of the plot
8120:
8121: =item $xlabel: string, text describing the X-axis of the plot
8122:
8123: =item $ylabel: string, text describing the Y-axis of the plot
8124:
8125: =item $Max: scalar, the maximum Y value to use in the plot
8126: If $Max is < any data point, the graph will not be rendered.
8127:
1.140 matthew 8128: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8129: they are plotted. If undefined, default values will be used.
8130:
1.178 matthew 8131: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8132:
1.138 matthew 8133: =item @Values: An array of array references. Each array reference holds data
8134: to be plotted in a stacked bar chart.
8135:
1.239 matthew 8136: =item If the final element of @Values is a hash reference the key/value
8137: pairs will be added to the graph definition.
8138:
1.138 matthew 8139: =back
8140:
8141: Returns:
8142:
8143: An <img> tag which references graph.png and the appropriate identifying
8144: information for the plot.
8145:
1.127 matthew 8146: =cut
8147:
8148: ############################################################
8149: ############################################################
1.134 matthew 8150: sub DrawBarGraph {
1.178 matthew 8151: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8152: #
8153: if (! defined($colors)) {
8154: $colors = ['#33ff00',
8155: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8156: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8157: ];
8158: }
1.228 matthew 8159: my $extra_settings = {};
8160: if (ref($Values[-1]) eq 'HASH') {
8161: $extra_settings = pop(@Values);
8162: }
1.127 matthew 8163: #
1.136 matthew 8164: my $identifier = &get_cgi_id();
8165: my $id = 'cgi.'.$identifier;
1.129 matthew 8166: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8167: return '';
8168: }
1.225 matthew 8169: #
8170: my @Labels;
8171: if (defined($labels)) {
8172: @Labels = @$labels;
8173: } else {
8174: for (my $i=0;$i<@{$Values[0]};$i++) {
8175: push (@Labels,$i+1);
8176: }
8177: }
8178: #
1.129 matthew 8179: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8180: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8181: my %ValuesHash;
8182: my $NumSets=1;
8183: foreach my $array (@Values) {
8184: next if (! ref($array));
1.136 matthew 8185: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8186: join(',',@$array);
1.129 matthew 8187: }
1.127 matthew 8188: #
1.136 matthew 8189: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8190: if ($NumBars < 3) {
8191: $width = 120+$NumBars*32;
1.220 matthew 8192: $xskip = 1;
1.225 matthew 8193: $bar_width = 30;
8194: } elsif ($NumBars < 5) {
8195: $width = 120+$NumBars*20;
8196: $xskip = 1;
8197: $bar_width = 20;
1.220 matthew 8198: } elsif ($NumBars < 10) {
1.136 matthew 8199: $width = 120+$NumBars*15;
8200: $xskip = 1;
8201: $bar_width = 15;
8202: } elsif ($NumBars <= 25) {
8203: $width = 120+$NumBars*11;
8204: $xskip = 5;
8205: $bar_width = 8;
8206: } elsif ($NumBars <= 50) {
8207: $width = 120+$NumBars*8;
8208: $xskip = 5;
8209: $bar_width = 4;
8210: } else {
8211: $width = 120+$NumBars*8;
8212: $xskip = 5;
8213: $bar_width = 4;
8214: }
8215: #
1.137 matthew 8216: $Max = 1 if ($Max < 1);
8217: if ( int($Max) < $Max ) {
8218: $Max++;
8219: $Max = int($Max);
8220: }
1.127 matthew 8221: $Title = '' if (! defined($Title));
8222: $xlabel = '' if (! defined($xlabel));
8223: $ylabel = '' if (! defined($ylabel));
1.369 www 8224: $ValuesHash{$id.'.title'} = &escape($Title);
8225: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8226: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8227: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8228: $ValuesHash{$id.'.NumBars'} = $NumBars;
8229: $ValuesHash{$id.'.NumSets'} = $NumSets;
8230: $ValuesHash{$id.'.PlotType'} = 'bar';
8231: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8232: $ValuesHash{$id.'.height'} = $height;
8233: $ValuesHash{$id.'.width'} = $width;
8234: $ValuesHash{$id.'.xskip'} = $xskip;
8235: $ValuesHash{$id.'.bar_width'} = $bar_width;
8236: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8237: #
1.228 matthew 8238: # Deal with other parameters
8239: while (my ($key,$value) = each(%$extra_settings)) {
8240: $ValuesHash{$id.'.'.$key} = $value;
8241: }
8242: #
1.646 raeburn 8243: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8244: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8245: }
8246:
8247: ############################################################
8248: ############################################################
8249:
8250: =pod
8251:
1.648 raeburn 8252: =item * &DrawXYGraph()
1.137 matthew 8253:
1.138 matthew 8254: Facilitates the plotting of data in an XY graph.
8255: Puts plot definition data into the users environment in order for
8256: graph.png to plot it. Returns an <img> tag for the plot.
8257:
8258: Inputs:
8259:
8260: =over 4
8261:
8262: =item $Title: string, the title of the plot
8263:
8264: =item $xlabel: string, text describing the X-axis of the plot
8265:
8266: =item $ylabel: string, text describing the Y-axis of the plot
8267:
8268: =item $Max: scalar, the maximum Y value to use in the plot
8269: If $Max is < any data point, the graph will not be rendered.
8270:
8271: =item $colors: Array ref containing the hex color codes for the data to be
8272: plotted in. If undefined, default values will be used.
8273:
8274: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8275:
8276: =item $Ydata: Array ref containing Array refs.
1.185 www 8277: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8278:
8279: =item %Values: hash indicating or overriding any default values which are
8280: passed to graph.png.
8281: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8282:
8283: =back
8284:
8285: Returns:
8286:
8287: An <img> tag which references graph.png and the appropriate identifying
8288: information for the plot.
8289:
1.137 matthew 8290: =cut
8291:
8292: ############################################################
8293: ############################################################
8294: sub DrawXYGraph {
8295: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8296: #
8297: # Create the identifier for the graph
8298: my $identifier = &get_cgi_id();
8299: my $id = 'cgi.'.$identifier;
8300: #
8301: $Title = '' if (! defined($Title));
8302: $xlabel = '' if (! defined($xlabel));
8303: $ylabel = '' if (! defined($ylabel));
8304: my %ValuesHash =
8305: (
1.369 www 8306: $id.'.title' => &escape($Title),
8307: $id.'.xlabel' => &escape($xlabel),
8308: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8309: $id.'.y_max_value'=> $Max,
8310: $id.'.labels' => join(',',@$Xlabels),
8311: $id.'.PlotType' => 'XY',
8312: );
8313: #
8314: if (defined($colors) && ref($colors) eq 'ARRAY') {
8315: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8316: }
8317: #
8318: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8319: return '';
8320: }
8321: my $NumSets=1;
1.138 matthew 8322: foreach my $array (@{$Ydata}){
1.137 matthew 8323: next if (! ref($array));
8324: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8325: }
1.138 matthew 8326: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8327: #
8328: # Deal with other parameters
8329: while (my ($key,$value) = each(%Values)) {
8330: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8331: }
8332: #
1.646 raeburn 8333: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8334: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8335: }
8336:
8337: ############################################################
8338: ############################################################
8339:
8340: =pod
8341:
1.648 raeburn 8342: =item * &DrawXYYGraph()
1.138 matthew 8343:
8344: Facilitates the plotting of data in an XY graph with two Y axes.
8345: Puts plot definition data into the users environment in order for
8346: graph.png to plot it. Returns an <img> tag for the plot.
8347:
8348: Inputs:
8349:
8350: =over 4
8351:
8352: =item $Title: string, the title of the plot
8353:
8354: =item $xlabel: string, text describing the X-axis of the plot
8355:
8356: =item $ylabel: string, text describing the Y-axis of the plot
8357:
8358: =item $colors: Array ref containing the hex color codes for the data to be
8359: plotted in. If undefined, default values will be used.
8360:
8361: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8362:
8363: =item $Ydata1: The first data set
8364:
8365: =item $Min1: The minimum value of the left Y-axis
8366:
8367: =item $Max1: The maximum value of the left Y-axis
8368:
8369: =item $Ydata2: The second data set
8370:
8371: =item $Min2: The minimum value of the right Y-axis
8372:
8373: =item $Max2: The maximum value of the left Y-axis
8374:
8375: =item %Values: hash indicating or overriding any default values which are
8376: passed to graph.png.
8377: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8378:
8379: =back
8380:
8381: Returns:
8382:
8383: An <img> tag which references graph.png and the appropriate identifying
8384: information for the plot.
1.136 matthew 8385:
8386: =cut
8387:
8388: ############################################################
8389: ############################################################
1.137 matthew 8390: sub DrawXYYGraph {
8391: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8392: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8393: #
8394: # Create the identifier for the graph
8395: my $identifier = &get_cgi_id();
8396: my $id = 'cgi.'.$identifier;
8397: #
8398: $Title = '' if (! defined($Title));
8399: $xlabel = '' if (! defined($xlabel));
8400: $ylabel = '' if (! defined($ylabel));
8401: my %ValuesHash =
8402: (
1.369 www 8403: $id.'.title' => &escape($Title),
8404: $id.'.xlabel' => &escape($xlabel),
8405: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8406: $id.'.labels' => join(',',@$Xlabels),
8407: $id.'.PlotType' => 'XY',
8408: $id.'.NumSets' => 2,
1.137 matthew 8409: $id.'.two_axes' => 1,
8410: $id.'.y1_max_value' => $Max1,
8411: $id.'.y1_min_value' => $Min1,
8412: $id.'.y2_max_value' => $Max2,
8413: $id.'.y2_min_value' => $Min2,
1.136 matthew 8414: );
8415: #
1.137 matthew 8416: if (defined($colors) && ref($colors) eq 'ARRAY') {
8417: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8418: }
8419: #
8420: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8421: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8422: return '';
8423: }
8424: my $NumSets=1;
1.137 matthew 8425: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8426: next if (! ref($array));
8427: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8428: }
8429: #
8430: # Deal with other parameters
8431: while (my ($key,$value) = each(%Values)) {
8432: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8433: }
8434: #
1.646 raeburn 8435: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8436: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8437: }
8438:
8439: ############################################################
8440: ############################################################
8441:
8442: =pod
8443:
1.157 matthew 8444: =back
8445:
1.139 matthew 8446: =head1 Statistics helper routines?
8447:
8448: Bad place for them but what the hell.
8449:
1.157 matthew 8450: =over 4
8451:
1.648 raeburn 8452: =item * &chartlink()
1.139 matthew 8453:
8454: Returns a link to the chart for a specific student.
8455:
8456: Inputs:
8457:
8458: =over 4
8459:
8460: =item $linktext: The text of the link
8461:
8462: =item $sname: The students username
8463:
8464: =item $sdomain: The students domain
8465:
8466: =back
8467:
1.157 matthew 8468: =back
8469:
1.139 matthew 8470: =cut
8471:
8472: ############################################################
8473: ############################################################
8474: sub chartlink {
8475: my ($linktext, $sname, $sdomain) = @_;
8476: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8477: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8478: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8479: '">'.$linktext.'</a>';
1.153 matthew 8480: }
8481:
8482: #######################################################
8483: #######################################################
8484:
8485: =pod
8486:
8487: =head1 Course Environment Routines
1.157 matthew 8488:
8489: =over 4
1.153 matthew 8490:
1.648 raeburn 8491: =item * &restore_course_settings()
1.153 matthew 8492:
1.648 raeburn 8493: =item * &store_course_settings()
1.153 matthew 8494:
8495: Restores/Store indicated form parameters from the course environment.
8496: Will not overwrite existing values of the form parameters.
8497:
8498: Inputs:
8499: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8500:
8501: a hash ref describing the data to be stored. For example:
8502:
8503: %Save_Parameters = ('Status' => 'scalar',
8504: 'chartoutputmode' => 'scalar',
8505: 'chartoutputdata' => 'scalar',
8506: 'Section' => 'array',
1.373 raeburn 8507: 'Group' => 'array',
1.153 matthew 8508: 'StudentData' => 'array',
8509: 'Maps' => 'array');
8510:
8511: Returns: both routines return nothing
8512:
1.631 raeburn 8513: =back
8514:
1.153 matthew 8515: =cut
8516:
8517: #######################################################
8518: #######################################################
8519: sub store_course_settings {
1.496 albertel 8520: return &store_settings($env{'request.course.id'},@_);
8521: }
8522:
8523: sub store_settings {
1.153 matthew 8524: # save to the environment
8525: # appenv the same items, just to be safe
1.300 albertel 8526: my $udom = $env{'user.domain'};
8527: my $uname = $env{'user.name'};
1.496 albertel 8528: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8529: my %SaveHash;
8530: my %AppHash;
8531: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8532: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8533: my $envname = 'environment.'.$basename;
1.258 albertel 8534: if (exists($env{'form.'.$setting})) {
1.153 matthew 8535: # Save this value away
8536: if ($type eq 'scalar' &&
1.258 albertel 8537: (! exists($env{$envname}) ||
8538: $env{$envname} ne $env{'form.'.$setting})) {
8539: $SaveHash{$basename} = $env{'form.'.$setting};
8540: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8541: } elsif ($type eq 'array') {
8542: my $stored_form;
1.258 albertel 8543: if (ref($env{'form.'.$setting})) {
1.153 matthew 8544: $stored_form = join(',',
8545: map {
1.369 www 8546: &escape($_);
1.258 albertel 8547: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8548: } else {
8549: $stored_form =
1.369 www 8550: &escape($env{'form.'.$setting});
1.153 matthew 8551: }
8552: # Determine if the array contents are the same.
1.258 albertel 8553: if ($stored_form ne $env{$envname}) {
1.153 matthew 8554: $SaveHash{$basename} = $stored_form;
8555: $AppHash{$envname} = $stored_form;
8556: }
8557: }
8558: }
8559: }
8560: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8561: $udom,$uname);
1.153 matthew 8562: if ($put_result !~ /^(ok|delayed)/) {
8563: &Apache::lonnet::logthis('unable to save form parameters, '.
8564: 'got error:'.$put_result);
8565: }
8566: # Make sure these settings stick around in this session, too
1.646 raeburn 8567: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8568: return;
8569: }
8570:
8571: sub restore_course_settings {
1.499 albertel 8572: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8573: }
8574:
8575: sub restore_settings {
8576: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8577: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8578: next if (exists($env{'form.'.$setting}));
1.496 albertel 8579: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8580: '.'.$setting;
1.258 albertel 8581: if (exists($env{$envname})) {
1.153 matthew 8582: if ($type eq 'scalar') {
1.258 albertel 8583: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8584: } elsif ($type eq 'array') {
1.258 albertel 8585: $env{'form.'.$setting} = [
1.153 matthew 8586: map {
1.369 www 8587: &unescape($_);
1.258 albertel 8588: } split(',',$env{$envname})
1.153 matthew 8589: ];
8590: }
8591: }
8592: }
1.127 matthew 8593: }
8594:
1.618 raeburn 8595: #######################################################
8596: #######################################################
8597:
8598: =pod
8599:
8600: =head1 Domain E-mail Routines
8601:
8602: =over 4
8603:
1.648 raeburn 8604: =item * &build_recipient_list()
1.618 raeburn 8605:
8606: Build recipient lists for three types of e-mail:
8607: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8608: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8609:
8610: Inputs:
1.619 raeburn 8611: defmail (scalar - email address of default recipient),
1.618 raeburn 8612: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8613: defdom (domain for which to retrieve configuration settings),
8614: origmail (scalar - email address of recipient from loncapa.conf,
8615: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8616:
1.655 raeburn 8617: Returns: comma separated list of addresses to which to send e-mail.
8618:
8619: =back
1.618 raeburn 8620:
8621: =cut
8622:
8623: ############################################################
8624: ############################################################
8625: sub build_recipient_list {
1.619 raeburn 8626: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8627: my @recipients;
8628: my $otheremails;
8629: my %domconfig =
8630: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8631: if (ref($domconfig{'contacts'}) eq 'HASH') {
8632: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8633: my @contacts = ('adminemail','supportemail');
8634: foreach my $item (@contacts) {
8635: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8636: my $addr = $domconfig{'contacts'}{$item};
8637: if (!grep(/^\Q$addr\E$/,@recipients)) {
8638: push(@recipients,$addr);
8639: }
1.618 raeburn 8640: }
8641: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8642: }
8643: }
1.619 raeburn 8644: } elsif ($origmail ne '') {
8645: push(@recipients,$origmail);
1.618 raeburn 8646: }
1.688 raeburn 8647: if (defined($defmail)) {
8648: if ($defmail ne '') {
8649: push(@recipients,$defmail);
8650: }
1.618 raeburn 8651: }
8652: if ($otheremails) {
1.619 raeburn 8653: my @others;
8654: if ($otheremails =~ /,/) {
8655: @others = split(/,/,$otheremails);
1.618 raeburn 8656: } else {
1.619 raeburn 8657: push(@others,$otheremails);
8658: }
8659: foreach my $addr (@others) {
8660: if (!grep(/^\Q$addr\E$/,@recipients)) {
8661: push(@recipients,$addr);
8662: }
1.618 raeburn 8663: }
8664: }
1.619 raeburn 8665: my $recipientlist = join(',',@recipients);
1.618 raeburn 8666: return $recipientlist;
8667: }
8668:
1.127 matthew 8669: ############################################################
8670: ############################################################
1.154 albertel 8671:
1.655 raeburn 8672: =pod
8673:
8674: =head1 Course Catalog Routines
8675:
8676: =over 4
8677:
8678: =item * &gather_categories()
8679:
8680: Converts category definitions - keys of categories hash stored in
8681: coursecategories in configuration.db on the primary library server in a
8682: domain - to an array. Also generates javascript and idx hash used to
8683: generate Domain Coordinator interface for editing Course Categories.
8684:
8685: Inputs:
1.663 raeburn 8686:
1.655 raeburn 8687: categories (reference to hash of category definitions).
1.663 raeburn 8688:
1.655 raeburn 8689: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8690: categories and subcategories).
1.663 raeburn 8691:
1.655 raeburn 8692: idx (reference to hash of counters used in Domain Coordinator interface for
8693: editing Course Categories).
1.663 raeburn 8694:
1.655 raeburn 8695: jsarray (reference to array of categories used to create Javascript arrays for
8696: Domain Coordinator interface for editing Course Categories).
8697:
8698: Returns: nothing
8699:
8700: Side effects: populates cats, idx and jsarray.
8701:
8702: =cut
8703:
8704: sub gather_categories {
8705: my ($categories,$cats,$idx,$jsarray) = @_;
8706: my %counters;
8707: my $num = 0;
8708: foreach my $item (keys(%{$categories})) {
8709: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8710: if ($container eq '' && $depth == 0) {
8711: $cats->[$depth][$categories->{$item}] = $cat;
8712: } else {
8713: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8714: }
8715: my ($escitem,$tail) = split(/:/,$item,2);
8716: if ($counters{$tail} eq '') {
8717: $counters{$tail} = $num;
8718: $num ++;
8719: }
8720: if (ref($idx) eq 'HASH') {
8721: $idx->{$item} = $counters{$tail};
8722: }
8723: if (ref($jsarray) eq 'ARRAY') {
8724: push(@{$jsarray->[$counters{$tail}]},$item);
8725: }
8726: }
8727: return;
8728: }
8729:
8730: =pod
8731:
8732: =item * &extract_categories()
8733:
8734: Used to generate breadcrumb trails for course categories.
8735:
8736: Inputs:
1.663 raeburn 8737:
1.655 raeburn 8738: categories (reference to hash of category definitions).
1.663 raeburn 8739:
1.655 raeburn 8740: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8741: categories and subcategories).
1.663 raeburn 8742:
1.655 raeburn 8743: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8744:
1.655 raeburn 8745: allitems (reference to hash - key is category key
8746: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8747:
1.655 raeburn 8748: idx (reference to hash of counters used in Domain Coordinator interface for
8749: editing Course Categories).
1.663 raeburn 8750:
1.655 raeburn 8751: jsarray (reference to array of categories used to create Javascript arrays for
8752: Domain Coordinator interface for editing Course Categories).
8753:
1.665 raeburn 8754: subcats (reference to hash of arrays containing all subcategories within each
8755: category, -recursive)
8756:
1.655 raeburn 8757: Returns: nothing
8758:
8759: Side effects: populates trails and allitems hash references.
8760:
8761: =cut
8762:
8763: sub extract_categories {
1.665 raeburn 8764: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8765: if (ref($categories) eq 'HASH') {
8766: &gather_categories($categories,$cats,$idx,$jsarray);
8767: if (ref($cats->[0]) eq 'ARRAY') {
8768: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8769: my $name = $cats->[0][$i];
8770: my $item = &escape($name).'::0';
8771: my $trailstr;
8772: if ($name eq 'instcode') {
8773: $trailstr = &mt('Official courses (with institutional codes)');
8774: } else {
8775: $trailstr = $name;
8776: }
8777: if ($allitems->{$item} eq '') {
8778: push(@{$trails},$trailstr);
8779: $allitems->{$item} = scalar(@{$trails})-1;
8780: }
8781: my @parents = ($name);
8782: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8783: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8784: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8785: if (ref($subcats) eq 'HASH') {
8786: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8787: }
8788: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8789: }
8790: } else {
8791: if (ref($subcats) eq 'HASH') {
8792: $subcats->{$item} = [];
1.655 raeburn 8793: }
8794: }
8795: }
8796: }
8797: }
8798: return;
8799: }
8800:
8801: =pod
8802:
8803: =item *&recurse_categories()
8804:
8805: Recursively used to generate breadcrumb trails for course categories.
8806:
8807: Inputs:
1.663 raeburn 8808:
1.655 raeburn 8809: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8810: categories and subcategories).
1.663 raeburn 8811:
1.655 raeburn 8812: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8813:
8814: category (current course category, for which breadcrumb trail is being generated).
8815:
8816: trails (reference to array of breadcrumb trails for each category).
8817:
1.655 raeburn 8818: allitems (reference to hash - key is category key
8819: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8820:
1.655 raeburn 8821: parents (array containing containers directories for current category,
8822: back to top level).
8823:
8824: Returns: nothing
8825:
8826: Side effects: populates trails and allitems hash references
8827:
8828: =cut
8829:
8830: sub recurse_categories {
1.665 raeburn 8831: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8832: my $shallower = $depth - 1;
8833: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8834: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8835: my $name = $cats->[$depth]{$category}[$k];
8836: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8837: my $trailstr = join(' -> ',(@{$parents},$category));
8838: if ($allitems->{$item} eq '') {
8839: push(@{$trails},$trailstr);
8840: $allitems->{$item} = scalar(@{$trails})-1;
8841: }
8842: my $deeper = $depth+1;
8843: push(@{$parents},$category);
1.665 raeburn 8844: if (ref($subcats) eq 'HASH') {
8845: my $subcat = &escape($name).':'.$category.':'.$depth;
8846: for (my $j=@{$parents}; $j>=0; $j--) {
8847: my $higher;
8848: if ($j > 0) {
8849: $higher = &escape($parents->[$j]).':'.
8850: &escape($parents->[$j-1]).':'.$j;
8851: } else {
8852: $higher = &escape($parents->[$j]).'::'.$j;
8853: }
8854: push(@{$subcats->{$higher}},$subcat);
8855: }
8856: }
8857: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8858: $subcats);
1.655 raeburn 8859: pop(@{$parents});
8860: }
8861: } else {
8862: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8863: my $trailstr = join(' -> ',(@{$parents},$category));
8864: if ($allitems->{$item} eq '') {
8865: push(@{$trails},$trailstr);
8866: $allitems->{$item} = scalar(@{$trails})-1;
8867: }
8868: }
8869: return;
8870: }
8871:
1.663 raeburn 8872: =pod
8873:
8874: =item *&assign_categories_table()
8875:
8876: Create a datatable for display of hierarchical categories in a domain,
8877: with checkboxes to allow a course to be categorized.
8878:
8879: Inputs:
8880:
8881: cathash - reference to hash of categories defined for the domain (from
8882: configuration.db)
8883:
8884: currcat - scalar with an & separated list of categories assigned to a course.
8885:
8886: Returns: $output (markup to be displayed)
8887:
8888: =cut
8889:
8890: sub assign_categories_table {
8891: my ($cathash,$currcat) = @_;
8892: my $output;
8893: if (ref($cathash) eq 'HASH') {
8894: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
8895: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
8896: $maxdepth = scalar(@cats);
8897: if (@cats > 0) {
8898: my $itemcount = 0;
8899: if (ref($cats[0]) eq 'ARRAY') {
8900: $output = &Apache::loncommon::start_data_table();
8901: my @currcategories;
8902: if ($currcat ne '') {
8903: @currcategories = split('&',$currcat);
8904: }
8905: for (my $i=0; $i<@{$cats[0]}; $i++) {
8906: my $parent = $cats[0][$i];
8907: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8908: next if ($parent eq 'instcode');
8909: my $item = &escape($parent).'::0';
8910: my $checked = '';
8911: if (@currcategories > 0) {
8912: if (grep(/^\Q$item\E$/,@currcategories)) {
8913: $checked = ' checked="checked" ';
8914: }
8915: }
1.675 raeburn 8916: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
8917: '<input type="checkbox" name="usecategory" value="'.
8918: $item.'"'.$checked.' />'.$parent.'</span>'.
8919: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 8920: my $depth = 1;
8921: push(@path,$parent);
8922: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
8923: pop(@path);
8924: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
8925: $itemcount ++;
8926: }
8927: $output .= &Apache::loncommon::end_data_table();
8928: }
8929: }
8930: }
8931: return $output;
8932: }
8933:
8934: =pod
8935:
8936: =item *&assign_category_rows()
8937:
8938: Create a datatable row for display of nested categories in a domain,
8939: with checkboxes to allow a course to be categorized,called recursively.
8940:
8941: Inputs:
8942:
8943: itemcount - track row number for alternating colors
8944:
8945: cats - reference to array of arrays/hashes which encapsulates hierarchy of
8946: categories and subcategories.
8947:
8948: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
8949:
8950: parent - parent of current category item
8951:
8952: path - Array containing all categories back up through the hierarchy from the
8953: current category to the top level.
8954:
8955: currcategories - reference to array of current categories assigned to the course
8956:
8957: Returns: $output (markup to be displayed).
8958:
8959: =cut
8960:
8961: sub assign_category_rows {
8962: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
8963: my ($text,$name,$item,$chgstr);
8964: if (ref($cats) eq 'ARRAY') {
8965: my $maxdepth = scalar(@{$cats});
8966: if (ref($cats->[$depth]) eq 'HASH') {
8967: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
8968: my $numchildren = @{$cats->[$depth]{$parent}};
8969: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8970: $text .= '<td><table class="LC_datatable">';
8971: for (my $j=0; $j<$numchildren; $j++) {
8972: $name = $cats->[$depth]{$parent}[$j];
8973: $item = &escape($name).':'.&escape($parent).':'.$depth;
8974: my $deeper = $depth+1;
8975: my $checked = '';
8976: if (ref($currcategories) eq 'ARRAY') {
8977: if (@{$currcategories} > 0) {
8978: if (grep(/^\Q$item\E$/,@{$currcategories})) {
8979: $checked = ' checked="checked" ';
8980: }
8981: }
8982: }
1.664 raeburn 8983: $text .= '<tr><td><span class="LC_nobreak"><label>'.
8984: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 8985: $item.'"'.$checked.' />'.$name.'</label></span>'.
8986: '<input type="hidden" name="catname" value="'.$name.'" />'.
8987: '</td><td>';
1.663 raeburn 8988: if (ref($path) eq 'ARRAY') {
8989: push(@{$path},$name);
8990: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
8991: pop(@{$path});
8992: }
8993: $text .= '</td></tr>';
8994: }
8995: $text .= '</table></td>';
8996: }
8997: }
8998: }
8999: return $text;
9000: }
9001:
1.655 raeburn 9002: ############################################################
9003: ############################################################
9004:
9005:
1.443 albertel 9006: sub commit_customrole {
1.664 raeburn 9007: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9008: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9009: ($start?', '.&mt('starting').' '.localtime($start):'').
9010: ($end?', ending '.localtime($end):'').': <b>'.
9011: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9012: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9013: '</b><br />';
9014: return $output;
9015: }
9016:
9017: sub commit_standardrole {
1.541 raeburn 9018: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9019: my ($output,$logmsg,$linefeed);
9020: if ($context eq 'auto') {
9021: $linefeed = "\n";
9022: } else {
9023: $linefeed = "<br />\n";
9024: }
1.443 albertel 9025: if ($three eq 'st') {
1.541 raeburn 9026: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9027: $one,$two,$sec,$context);
9028: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9029: ($result eq 'unknown_course') || ($result eq 'refused')) {
9030: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9031: } else {
1.541 raeburn 9032: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9033: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9034: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9035: if ($context eq 'auto') {
9036: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9037: } else {
9038: $output .= '<b>'.$result.'</b>'.$linefeed.
9039: &mt('Add to classlist').': <b>ok</b>';
9040: }
9041: $output .= $linefeed;
1.443 albertel 9042: }
9043: } else {
9044: $output = &mt('Assigning').' '.$three.' in '.$url.
9045: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9046: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9047: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9048: if ($context eq 'auto') {
9049: $output .= $result.$linefeed;
9050: } else {
9051: $output .= '<b>'.$result.'</b>'.$linefeed;
9052: }
1.443 albertel 9053: }
9054: return $output;
9055: }
9056:
9057: sub commit_studentrole {
1.541 raeburn 9058: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9059: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9060: if ($context eq 'auto') {
9061: $linefeed = "\n";
9062: } else {
9063: $linefeed = '<br />'."\n";
9064: }
1.443 albertel 9065: if (defined($one) && defined($two)) {
9066: my $cid=$one.'_'.$two;
9067: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9068: my $secchange = 0;
9069: my $expire_role_result;
9070: my $modify_section_result;
1.628 raeburn 9071: if ($oldsec ne '-1') {
9072: if ($oldsec ne $sec) {
1.443 albertel 9073: $secchange = 1;
1.628 raeburn 9074: my $now = time;
1.443 albertel 9075: my $uurl='/'.$cid;
9076: $uurl=~s/\_/\//g;
9077: if ($oldsec) {
9078: $uurl.='/'.$oldsec;
9079: }
1.626 raeburn 9080: $oldsecurl = $uurl;
1.628 raeburn 9081: $expire_role_result =
1.652 raeburn 9082: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9083: if ($env{'request.course.sec'} ne '') {
9084: if ($expire_role_result eq 'refused') {
9085: my @roles = ('st');
9086: my @statuses = ('previous');
9087: my @roledoms = ($one);
9088: my $withsec = 1;
9089: my %roleshash =
9090: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9091: \@statuses,\@roles,\@roledoms,$withsec);
9092: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9093: my ($oldstart,$oldend) =
9094: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9095: if ($oldend > 0 && $oldend <= $now) {
9096: $expire_role_result = 'ok';
9097: }
9098: }
9099: }
9100: }
1.443 albertel 9101: $result = $expire_role_result;
9102: }
9103: }
9104: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9105: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9106: if ($modify_section_result =~ /^ok/) {
9107: if ($secchange == 1) {
1.628 raeburn 9108: if ($sec eq '') {
9109: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9110: } else {
9111: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9112: }
1.443 albertel 9113: } elsif ($oldsec eq '-1') {
1.628 raeburn 9114: if ($sec eq '') {
9115: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9116: } else {
9117: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9118: }
1.443 albertel 9119: } else {
1.628 raeburn 9120: if ($sec eq '') {
9121: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9122: } else {
9123: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9124: }
1.443 albertel 9125: }
9126: } else {
1.628 raeburn 9127: if ($secchange) {
9128: $$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;
9129: } else {
9130: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9131: }
1.443 albertel 9132: }
9133: $result = $modify_section_result;
9134: } elsif ($secchange == 1) {
1.628 raeburn 9135: if ($oldsec eq '') {
9136: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9137: } else {
9138: $$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;
9139: }
1.626 raeburn 9140: if ($expire_role_result eq 'refused') {
9141: my $newsecurl = '/'.$cid;
9142: $newsecurl =~ s/\_/\//g;
9143: if ($sec ne '') {
9144: $newsecurl.='/'.$sec;
9145: }
9146: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9147: if ($sec eq '') {
9148: $$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;
9149: } else {
9150: $$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;
9151: }
9152: }
9153: }
1.443 albertel 9154: }
9155: } else {
1.626 raeburn 9156: $$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 9157: $result = "error: incomplete course id\n";
9158: }
9159: return $result;
9160: }
9161:
9162: ############################################################
9163: ############################################################
9164:
1.566 albertel 9165: sub check_clone {
1.578 raeburn 9166: my ($args,$linefeed) = @_;
1.566 albertel 9167: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9168: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9169: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9170: my $clonemsg;
9171: my $can_clone = 0;
9172:
9173: if ($clonehome eq 'no_host') {
1.578 raeburn 9174: $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 9175: } else {
9176: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9177: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9178: $can_clone = 1;
9179: } else {
9180: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9181: $args->{'clonedomain'},$args->{'clonecourse'});
9182: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9183: if (grep(/^\*$/,@cloners)) {
9184: $can_clone = 1;
9185: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9186: $can_clone = 1;
9187: } else {
9188: my %roleshash =
9189: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9190: $args->{'ccdomain'},
9191: 'userroles',['active'],['cc'],
9192: [$args->{'clonedomain'}]);
9193: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9194: $can_clone = 1;
9195: } else {
9196: $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'});
9197: }
1.566 albertel 9198: }
1.578 raeburn 9199: }
1.566 albertel 9200: }
9201: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9202: }
9203:
1.444 albertel 9204: sub construct_course {
1.541 raeburn 9205: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9206: my $outcome;
1.541 raeburn 9207: my $linefeed = '<br />'."\n";
9208: if ($context eq 'auto') {
9209: $linefeed = "\n";
9210: }
1.566 albertel 9211:
9212: #
9213: # Are we cloning?
9214: #
9215: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9216: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9217: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9218: if ($context ne 'auto') {
1.578 raeburn 9219: if ($clonemsg ne '') {
9220: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9221: }
1.566 albertel 9222: }
9223: $outcome .= $clonemsg.$linefeed;
9224:
9225: if (!$can_clone) {
9226: return (0,$outcome);
9227: }
9228: }
9229:
1.444 albertel 9230: #
9231: # Open course
9232: #
9233: my $crstype = lc($args->{'crstype'});
9234: my %cenv=();
9235: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9236: $args->{'cdescr'},
9237: $args->{'curl'},
9238: $args->{'course_home'},
9239: $args->{'nonstandard'},
9240: $args->{'crscode'},
9241: $args->{'ccuname'}.':'.
9242: $args->{'ccdomain'},
9243: $args->{'crstype'});
9244:
9245: # Note: The testing routines depend on this being output; see
9246: # Utils::Course. This needs to at least be output as a comment
9247: # if anyone ever decides to not show this, and Utils::Course::new
9248: # will need to be suitably modified.
1.541 raeburn 9249: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9250: #
9251: # Check if created correctly
9252: #
1.479 albertel 9253: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9254: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9255: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9256:
1.444 albertel 9257: #
1.566 albertel 9258: # Do the cloning
9259: #
9260: if ($can_clone && $cloneid) {
9261: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9262: if ($context ne 'auto') {
9263: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9264: }
9265: $outcome .= $clonemsg.$linefeed;
9266: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9267: # Copy all files
1.637 www 9268: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9269: # Restore URL
1.566 albertel 9270: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9271: # Restore title
1.566 albertel 9272: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9273: # Mark as cloned
1.566 albertel 9274: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9275: # Need to clone grading mode
9276: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9277: $cenv{'grading'}=$newenv{'grading'};
9278: # Do not clone these environment entries
9279: &Apache::lonnet::del('environment',
9280: ['default_enrollment_start_date',
9281: 'default_enrollment_end_date',
9282: 'question.email',
9283: 'policy.email',
9284: 'comment.email',
9285: 'pch.users.denied',
9286: 'plc.users.denied'],
9287: $$crsudom,$$crsunum);
1.444 albertel 9288: }
1.566 albertel 9289:
1.444 albertel 9290: #
9291: # Set environment (will override cloned, if existing)
9292: #
9293: my @sections = ();
9294: my @xlists = ();
9295: if ($args->{'crstype'}) {
9296: $cenv{'type'}=$args->{'crstype'};
9297: }
9298: if ($args->{'crsid'}) {
9299: $cenv{'courseid'}=$args->{'crsid'};
9300: }
9301: if ($args->{'crscode'}) {
9302: $cenv{'internal.coursecode'}=$args->{'crscode'};
9303: }
9304: if ($args->{'crsquota'} ne '') {
9305: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9306: } else {
9307: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9308: }
9309: if ($args->{'ccuname'}) {
9310: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9311: ':'.$args->{'ccdomain'};
9312: } else {
9313: $cenv{'internal.courseowner'} = $args->{'curruser'};
9314: }
9315: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9316: if ($args->{'crssections'}) {
9317: $cenv{'internal.sectionnums'} = '';
9318: if ($args->{'crssections'} =~ m/,/) {
9319: @sections = split/,/,$args->{'crssections'};
9320: } else {
9321: $sections[0] = $args->{'crssections'};
9322: }
9323: if (@sections > 0) {
9324: foreach my $item (@sections) {
9325: my ($sec,$gp) = split/:/,$item;
9326: my $class = $args->{'crscode'}.$sec;
9327: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9328: $cenv{'internal.sectionnums'} .= $item.',';
9329: unless ($addcheck eq 'ok') {
9330: push @badclasses, $class;
9331: }
9332: }
9333: $cenv{'internal.sectionnums'} =~ s/,$//;
9334: }
9335: }
9336: # do not hide course coordinator from staff listing,
9337: # even if privileged
9338: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9339: # add crosslistings
9340: if ($args->{'crsxlist'}) {
9341: $cenv{'internal.crosslistings'}='';
9342: if ($args->{'crsxlist'} =~ m/,/) {
9343: @xlists = split/,/,$args->{'crsxlist'};
9344: } else {
9345: $xlists[0] = $args->{'crsxlist'};
9346: }
9347: if (@xlists > 0) {
9348: foreach my $item (@xlists) {
9349: my ($xl,$gp) = split/:/,$item;
9350: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9351: $cenv{'internal.crosslistings'} .= $item.',';
9352: unless ($addcheck eq 'ok') {
9353: push @badclasses, $xl;
9354: }
9355: }
9356: $cenv{'internal.crosslistings'} =~ s/,$//;
9357: }
9358: }
9359: if ($args->{'autoadds'}) {
9360: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9361: }
9362: if ($args->{'autodrops'}) {
9363: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9364: }
9365: # check for notification of enrollment changes
9366: my @notified = ();
9367: if ($args->{'notify_owner'}) {
9368: if ($args->{'ccuname'} ne '') {
9369: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9370: }
9371: }
9372: if ($args->{'notify_dc'}) {
9373: if ($uname ne '') {
1.630 raeburn 9374: push(@notified,$uname.':'.$udom);
1.444 albertel 9375: }
9376: }
9377: if (@notified > 0) {
9378: my $notifylist;
9379: if (@notified > 1) {
9380: $notifylist = join(',',@notified);
9381: } else {
9382: $notifylist = $notified[0];
9383: }
9384: $cenv{'internal.notifylist'} = $notifylist;
9385: }
9386: if (@badclasses > 0) {
9387: my %lt=&Apache::lonlocal::texthash(
9388: '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',
9389: 'dnhr' => 'does not have rights to access enrollment in these classes',
9390: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9391: );
1.541 raeburn 9392: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9393: ' ('.$lt{'adby'}.')';
9394: if ($context eq 'auto') {
9395: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9396: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9397: foreach my $item (@badclasses) {
9398: if ($context eq 'auto') {
9399: $outcome .= " - $item\n";
9400: } else {
9401: $outcome .= "<li>$item</li>\n";
9402: }
9403: }
9404: if ($context eq 'auto') {
9405: $outcome .= $linefeed;
9406: } else {
1.566 albertel 9407: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9408: }
9409: }
1.444 albertel 9410: }
9411: if ($args->{'no_end_date'}) {
9412: $args->{'endaccess'} = 0;
9413: }
9414: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9415: $cenv{'internal.autoend'}=$args->{'enrollend'};
9416: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9417: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9418: if ($args->{'showphotos'}) {
9419: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9420: }
9421: $cenv{'internal.authtype'} = $args->{'authtype'};
9422: $cenv{'internal.autharg'} = $args->{'autharg'};
9423: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9424: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9425: 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');
9426: if ($context eq 'auto') {
9427: $outcome .= $krb_msg;
9428: } else {
1.566 albertel 9429: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9430: }
9431: $outcome .= $linefeed;
1.444 albertel 9432: }
9433: }
9434: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9435: if ($args->{'setpolicy'}) {
9436: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9437: }
9438: if ($args->{'setcontent'}) {
9439: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9440: }
9441: }
9442: if ($args->{'reshome'}) {
9443: $cenv{'reshome'}=$args->{'reshome'}.'/';
9444: $cenv{'reshome'}=~s/\/+$/\//;
9445: }
9446: #
9447: # course has keyed access
9448: #
9449: if ($args->{'setkeys'}) {
9450: $cenv{'keyaccess'}='yes';
9451: }
9452: # if specified, key authority is not course, but user
9453: # only active if keyaccess is yes
9454: if ($args->{'keyauth'}) {
1.487 albertel 9455: my ($user,$domain) = split(':',$args->{'keyauth'});
9456: $user = &LONCAPA::clean_username($user);
9457: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9458: if ($user ne '' && $domain ne '') {
1.487 albertel 9459: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9460: }
9461: }
9462:
9463: if ($args->{'disresdis'}) {
9464: $cenv{'pch.roles.denied'}='st';
9465: }
9466: if ($args->{'disablechat'}) {
9467: $cenv{'plc.roles.denied'}='st';
9468: }
9469:
9470: # Record we've not yet viewed the Course Initialization Helper for this
9471: # course
9472: $cenv{'course.helper.not.run'} = 1;
9473: #
9474: # Use new Randomseed
9475: #
9476: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9477: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9478: #
9479: # The encryption code and receipt prefix for this course
9480: #
9481: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9482: $cenv{'internal.encpref'}=100+int(9*rand(99));
9483: #
9484: # By default, use standard grading
9485: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9486:
1.541 raeburn 9487: $outcome .= $linefeed.&mt('Setting environment').': '.
9488: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9489: #
9490: # Open all assignments
9491: #
9492: if ($args->{'openall'}) {
9493: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9494: my %storecontent = ($storeunder => time,
9495: $storeunder.'.type' => 'date_start');
9496:
9497: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9498: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9499: }
9500: #
9501: # Set first page
9502: #
9503: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9504: || ($cloneid)) {
1.445 albertel 9505: use LONCAPA::map;
1.444 albertel 9506: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9507:
9508: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9509: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9510:
1.444 albertel 9511: $outcome .= ($fatal?$errtext:'read ok').' - ';
9512: my $title; my $url;
9513: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9514: $title=&mt('Syllabus');
1.444 albertel 9515: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9516: } else {
1.690 bisitz 9517: $title=&mt('Navigate Contents');
1.444 albertel 9518: $url='/adm/navmaps';
9519: }
1.445 albertel 9520:
9521: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9522: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9523:
9524: if ($errtext) { $fatal=2; }
1.541 raeburn 9525: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9526: }
1.566 albertel 9527:
9528: return (1,$outcome);
1.444 albertel 9529: }
9530:
9531: ############################################################
9532: ############################################################
9533:
1.378 raeburn 9534: sub course_type {
9535: my ($cid) = @_;
9536: if (!defined($cid)) {
9537: $cid = $env{'request.course.id'};
9538: }
1.404 albertel 9539: if (defined($env{'course.'.$cid.'.type'})) {
9540: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9541: } else {
9542: return 'Course';
1.377 raeburn 9543: }
9544: }
1.156 albertel 9545:
1.406 raeburn 9546: sub group_term {
9547: my $crstype = &course_type();
9548: my %names = (
9549: 'Course' => 'group',
9550: 'Group' => 'team',
9551: );
9552: return $names{$crstype};
9553: }
9554:
1.156 albertel 9555: sub icon {
9556: my ($file)=@_;
1.505 albertel 9557: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9558: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9559: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9560: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9561: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9562: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9563: $curfext.".gif") {
9564: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9565: $curfext.".gif";
9566: }
9567: }
1.249 albertel 9568: return &lonhttpdurl($iconname);
1.154 albertel 9569: }
1.84 albertel 9570:
1.575 albertel 9571: sub lonhttpdurl {
1.692 www 9572: #
9573: # Had been used for "small fry" static images on separate port 8080.
9574: # Modify here if lightweight http functionality desired again.
9575: # Currently eliminated due to increasing firewall issues.
9576: #
1.575 albertel 9577: my ($url)=@_;
1.692 www 9578: return $url;
1.215 albertel 9579: }
9580:
1.213 albertel 9581: sub connection_aborted {
9582: my ($r)=@_;
9583: $r->print(" ");$r->rflush();
9584: my $c = $r->connection;
9585: return $c->aborted();
9586: }
9587:
1.221 foxr 9588: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9589: # strings as 'strings'.
9590: sub escape_single {
1.221 foxr 9591: my ($input) = @_;
1.223 albertel 9592: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9593: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9594: return $input;
9595: }
1.223 albertel 9596:
1.222 foxr 9597: # Same as escape_single, but escape's "'s This
9598: # can be used for "strings"
9599: sub escape_double {
9600: my ($input) = @_;
9601: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9602: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9603: return $input;
9604: }
1.223 albertel 9605:
1.222 foxr 9606: # Escapes the last element of a full URL.
9607: sub escape_url {
9608: my ($url) = @_;
1.238 raeburn 9609: my @urlslices = split(/\//, $url,-1);
1.369 www 9610: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9611: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9612: }
1.462 albertel 9613:
9614: # -------------------------------------------------------- Initliaze user login
9615: sub init_user_environment {
1.463 albertel 9616: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9617: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9618:
9619: my $public=($username eq 'public' && $domain eq 'public');
9620:
9621: # See if old ID present, if so, remove
9622:
9623: my ($filename,$cookie,$userroles);
9624: my $now=time;
9625:
9626: if ($public) {
9627: my $max_public=100;
9628: my $oldest;
9629: my $oldest_time=0;
9630: for(my $next=1;$next<=$max_public;$next++) {
9631: if (-e $lonids."/publicuser_$next.id") {
9632: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9633: if ($mtime<$oldest_time || !$oldest_time) {
9634: $oldest_time=$mtime;
9635: $oldest=$next;
9636: }
9637: } else {
9638: $cookie="publicuser_$next";
9639: last;
9640: }
9641: }
9642: if (!$cookie) { $cookie="publicuser_$oldest"; }
9643: } else {
1.463 albertel 9644: # if this isn't a robot, kill any existing non-robot sessions
9645: if (!$args->{'robot'}) {
9646: opendir(DIR,$lonids);
9647: while ($filename=readdir(DIR)) {
9648: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9649: unlink($lonids.'/'.$filename);
9650: }
1.462 albertel 9651: }
1.463 albertel 9652: closedir(DIR);
1.462 albertel 9653: }
9654: # Give them a new cookie
1.463 albertel 9655: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9656: : $now.$$.int(rand(10000)));
1.463 albertel 9657: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9658:
9659: # Initialize roles
9660:
9661: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9662: }
9663: # ------------------------------------ Check browser type and MathML capability
9664:
9665: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9666: $clientunicode,$clientos) = &decode_user_agent($r);
9667:
9668: # -------------------------------------- Any accessibility options to remember?
9669: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9670: foreach my $option ('imagesuppress','appletsuppress',
9671: 'embedsuppress','fontenhance','blackwhite') {
9672: if ($form->{$option} eq 'true') {
9673: &Apache::lonnet::put('environment',{$option => 'on'},
9674: $domain,$username);
9675: } else {
9676: &Apache::lonnet::del('environment',[$option],
9677: $domain,$username);
9678: }
9679: }
9680: }
9681: # ------------------------------------------------------------- Get environment
9682:
9683: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9684: my ($tmp) = keys(%userenv);
9685: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9686: # default remote control to off
9687: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9688: } else {
9689: undef(%userenv);
9690: }
9691: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9692: $form->{'interface'}=$userenv{'interface'};
9693: }
9694: $env{'environment.remote'}=$userenv{'remote'};
9695: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9696:
9697: # --------------- Do not trust query string to be put directly into environment
9698: foreach my $option ('imagesuppress','appletsuppress',
9699: 'embedsuppress','fontenhance','blackwhite',
9700: 'interface','localpath','localres') {
9701: $form->{$option}=~s/[\n\r\=]//gs;
9702: }
9703: # --------------------------------------------------------- Write first profile
9704:
9705: {
9706: my %initial_env =
9707: ("user.name" => $username,
9708: "user.domain" => $domain,
9709: "user.home" => $authhost,
9710: "browser.type" => $clientbrowser,
9711: "browser.version" => $clientversion,
9712: "browser.mathml" => $clientmathml,
9713: "browser.unicode" => $clientunicode,
9714: "browser.os" => $clientos,
9715: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9716: "request.course.fn" => '',
9717: "request.course.uri" => '',
9718: "request.course.sec" => '',
9719: "request.role" => 'cm',
9720: "request.role.adv" => $env{'user.adv'},
9721: "request.host" => $ENV{'REMOTE_ADDR'},);
9722:
9723: if ($form->{'localpath'}) {
9724: $initial_env{"browser.localpath"} = $form->{'localpath'};
9725: $initial_env{"browser.localres"} = $form->{'localres'};
9726: }
9727:
9728: if ($public) {
9729: $initial_env{"environment.remote"} = "off";
9730: }
9731: if ($form->{'interface'}) {
9732: $form->{'interface'}=~s/\W//gs;
9733: $initial_env{"browser.interface"} = $form->{'interface'};
9734: $env{'browser.interface'}=$form->{'interface'};
9735: foreach my $option ('imagesuppress','appletsuppress',
9736: 'embedsuppress','fontenhance','blackwhite') {
9737: if (($form->{$option} eq 'true') ||
9738: ($userenv{$option} eq 'on')) {
9739: $initial_env{"browser.$option"} = "on";
9740: }
9741: }
9742: }
9743:
9744: $env{'user.environment'} = "$lonids/$cookie.id";
9745:
9746: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9747: &GDBM_WRCREAT(),0640)) {
9748: &_add_to_env(\%disk_env,\%initial_env);
9749: &_add_to_env(\%disk_env,\%userenv,'environment.');
9750: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9751: if (ref($args->{'extra_env'})) {
9752: &_add_to_env(\%disk_env,$args->{'extra_env'});
9753: }
1.462 albertel 9754: untie(%disk_env);
9755: } else {
9756: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
9757: 'Could not create environment storage in lonauth: '.$!.'</font>');
9758: return 'error: '.$!;
9759: }
9760: }
9761: $env{'request.role'}='cm';
9762: $env{'request.role.adv'}=$env{'user.adv'};
9763: $env{'browser.type'}=$clientbrowser;
9764:
9765: return $cookie;
9766:
9767: }
9768:
9769: sub _add_to_env {
9770: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9771: if (ref($env_data) eq 'HASH') {
9772: while (my ($key,$value) = each(%$env_data)) {
9773: $idf->{$prefix.$key} = $value;
9774: $env{$prefix.$key} = $value;
9775: }
1.462 albertel 9776: }
9777: }
9778:
1.685 tempelho 9779: # --- Get the symbolic name of a problem and the url
9780: sub get_symb {
9781: my ($request,$silent) = @_;
9782: (my $url=$env{'form.url'}) =~ s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
9783: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9784: if ($symb eq '') {
9785: if (!$silent) {
9786: $request->print("Unable to handle ambiguous references:$url:.");
9787: return ();
9788: }
9789: }
9790: &Apache::lonenc::check_decrypt(\$symb);
9791: return ($symb);
9792: }
9793:
9794: # --------------------------------------------------------------Get annotation
9795:
9796: sub get_annotation {
9797: my ($symb,$enc) = @_;
9798:
9799: my $key = $symb;
9800: if (!$enc) {
9801: $key =
9802: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9803: }
9804: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9805: return $annotation{$key};
9806: }
9807:
9808: sub clean_symb {
9809: my ($symb) = @_;
9810:
9811: &Apache::lonenc::check_decrypt(\$symb);
9812: my $enc = $env{'request.enc'};
9813: delete($env{'request.enc'});
9814:
9815: return ($symb,$enc);
9816: }
1.462 albertel 9817:
1.41 ng 9818: =pod
9819:
9820: =back
9821:
1.112 bowersj2 9822: =cut
1.41 ng 9823:
1.112 bowersj2 9824: 1;
9825: __END__;
1.41 ng 9826:
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