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