Annotation of loncom/interface/loncommon.pm, revision 1.750
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.750 ! weissno 4: # $Id: loncommon.pm,v 1.750 2009/02/17 10:00:35 weiss Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.705 tempelho 274: "<span style='color:yellow;'>INFO: Read file types</span>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
1.558 albertel 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 412: var url = '/adm/pickstudent?';
413: var filter;
1.558 albertel 414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
1.74 www 417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
1.111 www 424: if (roleflag) { url+="&roles=1"; }
1.102 www 425: var title = 'Student_Browser';
1.74 www 426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
1.42 matthew 434:
1.74 www 435: sub selectstudent_link {
1.111 www 436: my ($form,$unameele,$udomele)=@_;
1.258 albertel 437: if ($env{'request.course.id'}) {
1.302 albertel 438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
1.111 www 441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 445: }
1.258 albertel 446: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 449: }
450: return '';
1.91 www 451: }
452:
1.653 raeburn 453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
1.91 www 472: sub coursebrowser_javascript {
1.468 raeburn 473: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 474: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 475: my $output = '
1.538 albertel 476: <script type="text/javascript">
1.468 raeburn 477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
1.377 raeburn 479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 480: var url = '/adm/pickcourse?';
1.468 raeburn 481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
1.91 www 493: }
1.128 albertel 494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
1.91 www 499: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
1.468 raeburn 502: if (extra_element !=null && extra_element != '') {
1.594 raeburn 503: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
1.234 raeburn 508: }
1.468 raeburn 509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
1.230 raeburn 514: }
1.293 raeburn 515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
1.377 raeburn 518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
1.102 www 530: var title = 'Course_Browser';
1.91 www 531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
1.468 raeburn 536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
1.91 www 554: ENDSTDBRW
1.468 raeburn 555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
1.629 raeburn 567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
1.468 raeburn 571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
1.91 www 597: }
1.468 raeburn 598: |;
599: return $setsections;
600: }
601:
1.91 www 602:
603: sub selectcourse_link {
1.377 raeburn 604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 607: }
1.42 matthew 608:
1.653 raeburn 609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
1.273 raeburn 615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
1.543 albertel 631: }
632: } else {
1.273 raeburn 633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
1.656 www 640: sub select_timezone {
1.659 raeburn 641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
1.657 raeburn 650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
1.656 www 657: }
658: $output.="</select>";
659: return $output;
660: }
1.273 raeburn 661:
1.687 raeburn 662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
1.695 raeburn 680: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
1.42 matthew 713: =pod
1.36 matthew 714:
1.648 raeburn 715: =item * &linked_select_forms(...)
1.36 matthew 716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 721: order unless a defined order is provided.
1.36 matthew 722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
1.112 bowersj2 727: =item * $formname, the name of the <form> tag
1.36 matthew 728:
1.112 bowersj2 729: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 730:
1.112 bowersj2 731: =item * $firstdefault, the default value for the first menu
1.36 matthew 732:
1.112 bowersj2 733: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 734:
1.112 bowersj2 735: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 736:
1.112 bowersj2 737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 738:
1.609 raeburn 739: =item * $menuorder, the order of values in the first menu
740:
1.41 ng 741: =back
742:
1.36 matthew 743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
1.41 ng 746: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
1.112 bowersj2 750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
1.609 raeburn 757: },
758: order => ['B4','B3','B1','B2'],
1.112 bowersj2 759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
1.609 raeburn 766: },
767: order => ['C2','C1','C3'],
1.112 bowersj2 768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
1.609 raeburn 779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 781: }
782: );
1.36 matthew 783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
1.609 raeburn 792: $hashref,
793: $menuorder,
1.36 matthew 794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
1.219 albertel 799: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 807: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
1.36 matthew 812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
1.143 matthew 838: $second.options[i].value = values[i];
1.36 matthew 839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
1.36 matthew 854: $result.=" <option value=\"$value\" ";
1.253 albertel 855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
1.36 matthew 869: $result.=" <option value=\"$value\" ";
1.253 albertel 870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 871: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
1.45 matthew 878: =pod
1.44 bowersj2 879:
1.648 raeburn 880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 881:
1.112 bowersj2 882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
1.44 bowersj2 899:
900: =cut
901:
902: sub help_open_topic {
1.48 bowersj2 903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
1.44 bowersj2 905: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 906: if ($env{'browser.interface'} eq 'textual') {
1.79 www 907: $stayOnPage=1;
908: }
1.44 bowersj2 909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
1.48 bowersj2 914: my $template = "";
915: my $link;
1.572 banghart 916:
1.159 www 917: $topic=~s/\W/\_/g;
1.44 bowersj2 918:
1.572 banghart 919: if (!$stayOnPage) {
1.72 bowersj2 920: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 921: } else {
1.48 bowersj2 922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
1.572 banghart 926: if ($text ne "") {
1.77 www 927: $template .=
1.572 banghart 928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 929: "<td bgcolor='#5555FF'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.48 bowersj2 930: }
931:
932: # Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 935: $template .= <<"ENDTEMPLATE";
1.436 albertel 936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 937: ENDTEMPLATE
1.705 tempelho 938: if ($text ne '') { $template.='</td></tr></table>' };
1.44 bowersj2 939: return $template;
940:
1.106 bowersj2 941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
1.732 raeburn 946: my ($topic,$text,$not_author) = @_;
947: my $out;
1.106 bowersj2 948: my $addOther = '';
1.732 raeburn 949: if ($topic) {
950: $addOther = &Apache::loncommon::help_open_topic($topic,$text,
951: undef, undef, 600).
1.106 bowersj2 952: '</td><td>';
953: }
1.732 raeburn 954: $out = '<table><tr><td>'.
955: $addOther .
956: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
957: undef,undef,600).
958: '</td><td>'.
959: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
960: undef,undef,600).
961: '</td>';
962: unless ($not_author) {
963: $out .= '<td>'.
964: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
965: undef,undef,600).
966: '</td>';
967: }
968: $out .= '</tr></table>';
969: return $out;
1.172 www 970: }
971:
1.430 albertel 972: sub general_help {
973: my $helptopic='Student_Intro';
974: if ($env{'request.role'}=~/^(ca|au)/) {
975: $helptopic='Authoring_Intro';
976: } elsif ($env{'request.role'}=~/^cc/) {
977: $helptopic='Course_Coordination_Intro';
1.672 raeburn 978: } elsif ($env{'request.role'}=~/^dc/) {
979: $helptopic='Domain_Coordination_Intro';
1.430 albertel 980: }
981: return $helptopic;
982: }
983:
984: sub update_help_link {
985: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
986: my $origurl = $ENV{'REQUEST_URI'};
987: $origurl=~s|^/~|/priv/|;
988: my $timestamp = time;
989: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
990: $$datum = &escape($$datum);
991: }
992:
993: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
994: my $output .= <<"ENDOUTPUT";
995: <script type="text/javascript">
996: banner_link = '$banner_link';
997: </script>
998: ENDOUTPUT
999: return $output;
1000: }
1001:
1002: # now just updates the help link and generates a blue icon
1.193 raeburn 1003: sub help_open_menu {
1.430 albertel 1004: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1005: = @_;
1.430 albertel 1006: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1007: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1008: # if environment.remote is on (using remote control UI)
1.572 banghart 1009: if ($env{'browser.interface'} eq 'textual' ||
1010: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1011: $stayOnPage=1;
1.430 albertel 1012: }
1013: my $output;
1014: if ($component_help) {
1015: if (!$text) {
1016: $output=&help_open_topic($component_help,undef,$stayOnPage,
1017: $width,$height);
1018: } else {
1019: my $help_text;
1020: $help_text=&unescape($topic);
1021: $output='<table><tr><td>'.
1022: &help_open_topic($component_help,$help_text,$stayOnPage,
1023: $width,$height).'</td></tr></table>';
1024: }
1025: }
1026: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1027: return $output.$banner_link;
1028: }
1029:
1030: sub top_nav_help {
1031: my ($text) = @_;
1.436 albertel 1032: $text = &mt($text);
1.572 banghart 1033: my $stay_on_page =
1.436 albertel 1034: ($env{'browser.interface'} eq 'textual' ||
1035: $env{'environment.remote'} eq 'off' );
1.572 banghart 1036: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1037: : "javascript:helpMenu('open')";
1.572 banghart 1038: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1039:
1.201 raeburn 1040: my $title = &mt('Get help');
1.436 albertel 1041:
1042: return <<"END";
1043: $banner_link
1044: <a href="$link" title="$title">$text</a>
1045: END
1046: }
1047:
1048: sub help_menu_js {
1049: my ($text) = @_;
1050:
1051: my $stayOnPage =
1052: ($env{'browser.interface'} eq 'textual' ||
1053: $env{'environment.remote'} eq 'off' );
1054:
1055: my $width = 620;
1056: my $height = 600;
1.430 albertel 1057: my $helptopic=&general_help();
1058: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1059: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1060: my $start_page =
1061: &Apache::loncommon::start_page('Help Menu', undef,
1062: {'frameset' => 1,
1063: 'js_ready' => 1,
1064: 'add_entries' => {
1065: 'border' => '0',
1.579 raeburn 1066: 'rows' => "110,*",},});
1.331 albertel 1067: my $end_page =
1068: &Apache::loncommon::end_page({'frameset' => 1,
1069: 'js_ready' => 1,});
1070:
1.436 albertel 1071: my $template .= <<"ENDTEMPLATE";
1072: <script type="text/javascript">
1.253 albertel 1073: // <!-- BEGIN LON-CAPA Internal
1074: // <![CDATA[
1.430 albertel 1075: var banner_link = '';
1.243 raeburn 1076: function helpMenu(target) {
1077: var caller = this;
1078: if (target == 'open') {
1079: var newWindow = null;
1080: try {
1.262 albertel 1081: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1082: }
1083: catch(error) {
1084: writeHelp(caller);
1085: return;
1086: }
1087: if (newWindow) {
1088: caller = newWindow;
1089: }
1.193 raeburn 1090: }
1.243 raeburn 1091: writeHelp(caller);
1092: return;
1093: }
1094: function writeHelp(caller) {
1.430 albertel 1095: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1096: caller.document.close()
1097: caller.focus()
1.193 raeburn 1098: }
1.253 albertel 1099: // ]]>
1.219 albertel 1100: // END LON-CAPA Internal -->
1.436 albertel 1101: </script>
1.193 raeburn 1102: ENDTEMPLATE
1103: return $template;
1104: }
1105:
1.172 www 1106: sub help_open_bug {
1107: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1108: unless ($env{'user.adv'}) { return ''; }
1.172 www 1109: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1110: $text = "" if (not defined $text);
1111: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1112: if ($env{'browser.interface'} eq 'textual' ||
1113: $env{'environment.remote'} eq 'off' ) {
1.172 www 1114: $stayOnPage=1;
1115: }
1.184 albertel 1116: $width = 600 if (not defined $width);
1117: $height = 600 if (not defined $height);
1.172 www 1118:
1119: $topic=~s/\W+/\+/g;
1120: my $link='';
1121: my $template='';
1.379 albertel 1122: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1123: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1124: if (!$stayOnPage)
1125: {
1126: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1127: }
1128: else
1129: {
1130: $link = $url;
1131: }
1132: # Add the text
1133: if ($text ne "")
1134: {
1135: $template .=
1136: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1137: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1138: }
1139:
1140: # Add the graphic
1.179 matthew 1141: my $title = &mt('Report a Bug');
1.215 albertel 1142: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1143: $template .= <<"ENDTEMPLATE";
1.436 albertel 1144: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1145: ENDTEMPLATE
1146: if ($text ne '') { $template.='</td></tr></table>' };
1147: return $template;
1148:
1149: }
1150:
1151: sub help_open_faq {
1152: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1153: unless ($env{'user.adv'}) { return ''; }
1.172 www 1154: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1155: $text = "" if (not defined $text);
1156: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1157: if ($env{'browser.interface'} eq 'textual' ||
1158: $env{'environment.remote'} eq 'off' ) {
1.172 www 1159: $stayOnPage=1;
1160: }
1161: $width = 350 if (not defined $width);
1162: $height = 400 if (not defined $height);
1163:
1164: $topic=~s/\W+/\+/g;
1165: my $link='';
1166: my $template='';
1167: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1168: if (!$stayOnPage)
1169: {
1170: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1171: }
1172: else
1173: {
1174: $link = $url;
1175: }
1176:
1177: # Add the text
1178: if ($text ne "")
1179: {
1180: $template .=
1.173 www 1181: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1182: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1183: }
1184:
1185: # Add the graphic
1.179 matthew 1186: my $title = &mt('View the FAQ');
1.215 albertel 1187: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1188: $template .= <<"ENDTEMPLATE";
1.436 albertel 1189: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1190: ENDTEMPLATE
1191: if ($text ne '') { $template.='</td></tr></table>' };
1192: return $template;
1193:
1.44 bowersj2 1194: }
1.37 matthew 1195:
1.180 matthew 1196: ###############################################################
1197: ###############################################################
1198:
1.45 matthew 1199: =pod
1200:
1.648 raeburn 1201: =item * &change_content_javascript():
1.256 matthew 1202:
1203: This and the next function allow you to create small sections of an
1204: otherwise static HTML page that you can update on the fly with
1205: Javascript, even in Netscape 4.
1206:
1207: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1208: must be written to the HTML page once. It will prove the Javascript
1209: function "change(name, content)". Calling the change function with the
1210: name of the section
1211: you want to update, matching the name passed to C<changable_area>, and
1212: the new content you want to put in there, will put the content into
1213: that area.
1214:
1215: B<Note>: Netscape 4 only reserves enough space for the changable area
1216: to contain room for the original contents. You need to "make space"
1217: for whatever changes you wish to make, and be B<sure> to check your
1218: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1219: it's adequate for updating a one-line status display, but little more.
1220: This script will set the space to 100% width, so you only need to
1221: worry about height in Netscape 4.
1222:
1223: Modern browsers are much less limiting, and if you can commit to the
1224: user not using Netscape 4, this feature may be used freely with
1225: pretty much any HTML.
1226:
1227: =cut
1228:
1229: sub change_content_javascript {
1230: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1231: if ($env{'browser.type'} eq 'netscape' &&
1232: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1233: return (<<NETSCAPE4);
1234: function change(name, content) {
1235: doc = document.layers[name+"___escape"].layers[0].document;
1236: doc.open();
1237: doc.write(content);
1238: doc.close();
1239: }
1240: NETSCAPE4
1241: } else {
1242: # Otherwise, we need to use semi-standards-compliant code
1243: # (technically, "innerHTML" isn't standard but the equivalent
1244: # is really scary, and every useful browser supports it
1245: return (<<DOMBASED);
1246: function change(name, content) {
1247: element = document.getElementById(name);
1248: element.innerHTML = content;
1249: }
1250: DOMBASED
1251: }
1252: }
1253:
1254: =pod
1255:
1.648 raeburn 1256: =item * &changable_area($name,$origContent):
1.256 matthew 1257:
1258: This provides a "changable area" that can be modified on the fly via
1259: the Javascript code provided in C<change_content_javascript>. $name is
1260: the name you will use to reference the area later; do not repeat the
1261: same name on a given HTML page more then once. $origContent is what
1262: the area will originally contain, which can be left blank.
1263:
1264: =cut
1265:
1266: sub changable_area {
1267: my ($name, $origContent) = @_;
1268:
1.258 albertel 1269: if ($env{'browser.type'} eq 'netscape' &&
1270: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1271: # If this is netscape 4, we need to use the Layer tag
1272: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1273: } else {
1274: return "<span id='$name'>$origContent</span>";
1275: }
1276: }
1277:
1278: =pod
1279:
1.648 raeburn 1280: =item * &viewport_geometry_js
1.590 raeburn 1281:
1282: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1283:
1284: =cut
1285:
1286:
1287: sub viewport_geometry_js {
1288: return <<"GEOMETRY";
1289: var Geometry = {};
1290: function init_geometry() {
1291: if (Geometry.init) { return };
1292: Geometry.init=1;
1293: if (window.innerHeight) {
1294: Geometry.getViewportHeight = function() { return window.innerHeight; };
1295: Geometry.getViewportWidth = function() { return window.innerWidth; };
1296: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1297: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1298: }
1299: else if (document.documentElement && document.documentElement.clientHeight) {
1300: Geometry.getViewportHeight =
1301: function() { return document.documentElement.clientHeight; };
1302: Geometry.getViewportWidth =
1303: function() { return document.documentElement.clientWidth; };
1304:
1305: Geometry.getHorizontalScroll =
1306: function() { return document.documentElement.scrollLeft; };
1307: Geometry.getVerticalScroll =
1308: function() { return document.documentElement.scrollTop; };
1309: }
1310: else if (document.body.clientHeight) {
1311: Geometry.getViewportHeight =
1312: function() { return document.body.clientHeight; };
1313: Geometry.getViewportWidth =
1314: function() { return document.body.clientWidth; };
1315: Geometry.getHorizontalScroll =
1316: function() { return document.body.scrollLeft; };
1317: Geometry.getVerticalScroll =
1318: function() { return document.body.scrollTop; };
1319: }
1320: }
1321:
1322: GEOMETRY
1323: }
1324:
1325: =pod
1326:
1.648 raeburn 1327: =item * &viewport_size_js()
1.590 raeburn 1328:
1329: 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.
1330:
1331: =cut
1332:
1333: sub viewport_size_js {
1334: my $geometry = &viewport_geometry_js();
1335: return <<"DIMS";
1336:
1337: $geometry
1338:
1339: function getViewportDims(width,height) {
1340: init_geometry();
1341: width.value = Geometry.getViewportWidth();
1342: height.value = Geometry.getViewportHeight();
1343: return;
1344: }
1345:
1346: DIMS
1347: }
1348:
1349: =pod
1350:
1.648 raeburn 1351: =item * &resize_textarea_js()
1.565 albertel 1352:
1353: emits the needed javascript to resize a textarea to be as big as possible
1354:
1355: creates a function resize_textrea that takes two IDs first should be
1356: the id of the element to resize, second should be the id of a div that
1357: surrounds everything that comes after the textarea, this routine needs
1358: to be attached to the <body> for the onload and onresize events.
1359:
1.648 raeburn 1360: =back
1.565 albertel 1361:
1362: =cut
1363:
1364: sub resize_textarea_js {
1.590 raeburn 1365: my $geometry = &viewport_geometry_js();
1.565 albertel 1366: return <<"RESIZE";
1367: <script type="text/javascript">
1.590 raeburn 1368: $geometry
1.565 albertel 1369:
1.588 albertel 1370: function getX(element) {
1371: var x = 0;
1372: while (element) {
1373: x += element.offsetLeft;
1374: element = element.offsetParent;
1375: }
1376: return x;
1377: }
1378: function getY(element) {
1379: var y = 0;
1380: while (element) {
1381: y += element.offsetTop;
1382: element = element.offsetParent;
1383: }
1384: return y;
1385: }
1386:
1387:
1.565 albertel 1388: function resize_textarea(textarea_id,bottom_id) {
1389: init_geometry();
1390: var textarea = document.getElementById(textarea_id);
1391: //alert(textarea);
1392:
1.588 albertel 1393: var textarea_top = getY(textarea);
1.565 albertel 1394: var textarea_height = textarea.offsetHeight;
1395: var bottom = document.getElementById(bottom_id);
1.588 albertel 1396: var bottom_top = getY(bottom);
1.565 albertel 1397: var bottom_height = bottom.offsetHeight;
1398: var window_height = Geometry.getViewportHeight();
1.588 albertel 1399: var fudge = 23;
1.565 albertel 1400: var new_height = window_height-fudge-textarea_top-bottom_height;
1401: if (new_height < 300) {
1402: new_height = 300;
1403: }
1404: textarea.style.height=new_height+'px';
1405: }
1406: </script>
1407: RESIZE
1408:
1409: }
1410:
1411: =pod
1412:
1.256 matthew 1413: =head1 Excel and CSV file utility routines
1414:
1415: =over 4
1416:
1417: =cut
1418:
1419: ###############################################################
1420: ###############################################################
1421:
1422: =pod
1423:
1.648 raeburn 1424: =item * &csv_translate($text)
1.37 matthew 1425:
1.185 www 1426: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1427: format.
1428:
1429: =cut
1430:
1.180 matthew 1431: ###############################################################
1432: ###############################################################
1.37 matthew 1433: sub csv_translate {
1434: my $text = shift;
1435: $text =~ s/\"/\"\"/g;
1.209 albertel 1436: $text =~ s/\n/ /g;
1.37 matthew 1437: return $text;
1438: }
1.180 matthew 1439:
1440: ###############################################################
1441: ###############################################################
1442:
1443: =pod
1444:
1.648 raeburn 1445: =item * &define_excel_formats()
1.180 matthew 1446:
1447: Define some commonly used Excel cell formats.
1448:
1449: Currently supported formats:
1450:
1451: =over 4
1452:
1453: =item header
1454:
1455: =item bold
1456:
1457: =item h1
1458:
1459: =item h2
1460:
1461: =item h3
1462:
1.256 matthew 1463: =item h4
1464:
1465: =item i
1466:
1.180 matthew 1467: =item date
1468:
1469: =back
1470:
1471: Inputs: $workbook
1472:
1473: Returns: $format, a hash reference.
1474:
1475: =cut
1476:
1477: ###############################################################
1478: ###############################################################
1479: sub define_excel_formats {
1480: my ($workbook) = @_;
1481: my $format;
1482: $format->{'header'} = $workbook->add_format(bold => 1,
1483: bottom => 1,
1484: align => 'center');
1485: $format->{'bold'} = $workbook->add_format(bold=>1);
1486: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1487: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1488: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1489: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1490: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1491: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1492: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1493: return $format;
1494: }
1495:
1496: ###############################################################
1497: ###############################################################
1.113 bowersj2 1498:
1499: =pod
1500:
1.648 raeburn 1501: =item * &create_workbook()
1.255 matthew 1502:
1503: Create an Excel worksheet. If it fails, output message on the
1504: request object and return undefs.
1505:
1506: Inputs: Apache request object
1507:
1508: Returns (undef) on failure,
1509: Excel worksheet object, scalar with filename, and formats
1510: from &Apache::loncommon::define_excel_formats on success
1511:
1512: =cut
1513:
1514: ###############################################################
1515: ###############################################################
1516: sub create_workbook {
1517: my ($r) = @_;
1518: #
1519: # Create the excel spreadsheet
1520: my $filename = '/prtspool/'.
1.258 albertel 1521: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1522: time.'_'.rand(1000000000).'.xls';
1523: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1524: if (! defined($workbook)) {
1525: $r->log_error("Error creating excel spreadsheet $filename: $!");
1526: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1527: "This error has been logged. ".
1528: "Please alert your LON-CAPA administrator").
1529: '</p>');
1530: return (undef);
1531: }
1532: #
1533: $workbook->set_tempdir('/home/httpd/perl/tmp');
1534: #
1535: my $format = &Apache::loncommon::define_excel_formats($workbook);
1536: return ($workbook,$filename,$format);
1537: }
1538:
1539: ###############################################################
1540: ###############################################################
1541:
1542: =pod
1543:
1.648 raeburn 1544: =item * &create_text_file()
1.113 bowersj2 1545:
1.542 raeburn 1546: Create a file to write to and eventually make available to the user.
1.256 matthew 1547: If file creation fails, outputs an error message on the request object and
1548: return undefs.
1.113 bowersj2 1549:
1.256 matthew 1550: Inputs: Apache request object, and file suffix
1.113 bowersj2 1551:
1.256 matthew 1552: Returns (undef) on failure,
1553: Filehandle and filename on success.
1.113 bowersj2 1554:
1555: =cut
1556:
1.256 matthew 1557: ###############################################################
1558: ###############################################################
1559: sub create_text_file {
1560: my ($r,$suffix) = @_;
1561: if (! defined($suffix)) { $suffix = 'txt'; };
1562: my $fh;
1563: my $filename = '/prtspool/'.
1.258 albertel 1564: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1565: time.'_'.rand(1000000000).'.'.$suffix;
1566: $fh = Apache::File->new('>/home/httpd'.$filename);
1567: if (! defined($fh)) {
1568: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1569: $r->print(&mt('Problems occurred in creating the output file. '
1570: .'This error has been logged. '
1571: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1572: }
1.256 matthew 1573: return ($fh,$filename)
1.113 bowersj2 1574: }
1575:
1576:
1.256 matthew 1577: =pod
1.113 bowersj2 1578:
1579: =back
1580:
1581: =cut
1.37 matthew 1582:
1583: ###############################################################
1.33 matthew 1584: ## Home server <option> list generating code ##
1585: ###############################################################
1.35 matthew 1586:
1.169 www 1587: # ------------------------------------------
1588:
1589: sub domain_select {
1590: my ($name,$value,$multiple)=@_;
1591: my %domains=map {
1.514 albertel 1592: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1593: } &Apache::lonnet::all_domains();
1.169 www 1594: if ($multiple) {
1595: $domains{''}=&mt('Any domain');
1.550 albertel 1596: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1597: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1598: } else {
1.550 albertel 1599: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1600: return &select_form($name,$value,%domains);
1601: }
1602: }
1603:
1.282 albertel 1604: #-------------------------------------------
1605:
1606: =pod
1607:
1.519 raeburn 1608: =head1 Routines for form select boxes
1609:
1610: =over 4
1611:
1.648 raeburn 1612: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1613:
1614: Returns a string containing a <select> element int multiple mode
1615:
1616:
1617: Args:
1618: $name - name of the <select> element
1.506 raeburn 1619: $value - scalar or array ref of values that should already be selected
1.282 albertel 1620: $size - number of rows long the select element is
1.283 albertel 1621: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1622: (shown text should already have been &mt())
1.506 raeburn 1623: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1624:
1.282 albertel 1625: =cut
1626:
1627: #-------------------------------------------
1.169 www 1628: sub multiple_select_form {
1.284 albertel 1629: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1630: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1631: my $output='';
1.191 matthew 1632: if (! defined($size)) {
1633: $size = 4;
1.283 albertel 1634: if (scalar(keys(%$hash))<4) {
1635: $size = scalar(keys(%$hash));
1.191 matthew 1636: }
1637: }
1.734 bisitz 1638: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1639: my @order;
1.506 raeburn 1640: if (ref($order) eq 'ARRAY') {
1641: @order = @{$order};
1642: } else {
1643: @order = sort(keys(%$hash));
1.501 banghart 1644: }
1645: if (exists($$hash{'select_form_order'})) {
1646: @order = @{$$hash{'select_form_order'}};
1647: }
1648:
1.284 albertel 1649: foreach my $key (@order) {
1.356 albertel 1650: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1651: $output.='selected="selected" ' if ($selected{$key});
1652: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1653: }
1654: $output.="</select>\n";
1655: return $output;
1656: }
1657:
1.88 www 1658: #-------------------------------------------
1659:
1660: =pod
1661:
1.648 raeburn 1662: =item * &select_form($defdom,$name,%hash)
1.88 www 1663:
1664: Returns a string containing a <select name='$name' size='1'> form to
1665: allow a user to select options from a hash option_name => displayed text.
1666: See lonrights.pm for an example invocation and use.
1667:
1668: =cut
1669:
1670: #-------------------------------------------
1671: sub select_form {
1672: my ($def,$name,%hash) = @_;
1673: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1674: my @keys;
1675: if (exists($hash{'select_form_order'})) {
1676: @keys=@{$hash{'select_form_order'}};
1677: } else {
1678: @keys=sort(keys(%hash));
1679: }
1.356 albertel 1680: foreach my $key (@keys) {
1681: $selectform.=
1682: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1683: ($key eq $def ? 'selected="selected" ' : '').
1684: ">".&mt($hash{$key})."</option>\n";
1.88 www 1685: }
1686: $selectform.="</select>";
1687: return $selectform;
1688: }
1689:
1.475 www 1690: # For display filters
1691:
1692: sub display_filter {
1693: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1694: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1695: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1696: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1697: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1698: '</label></span> <span class="LC_nobreak">'.
1.475 www 1699: &mt('Filter [_1]',
1.477 www 1700: &select_form($env{'form.displayfilter'},
1701: 'displayfilter',
1702: ('currentfolder' => 'Current folder/page',
1703: 'containing' => 'Containing phrase',
1704: 'none' => 'None'))).
1.714 bisitz 1705: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1706: }
1707:
1.167 www 1708: sub gradeleveldescription {
1709: my $gradelevel=shift;
1710: my %gradelevels=(0 => 'Not specified',
1711: 1 => 'Grade 1',
1712: 2 => 'Grade 2',
1713: 3 => 'Grade 3',
1714: 4 => 'Grade 4',
1715: 5 => 'Grade 5',
1716: 6 => 'Grade 6',
1717: 7 => 'Grade 7',
1718: 8 => 'Grade 8',
1719: 9 => 'Grade 9',
1720: 10 => 'Grade 10',
1721: 11 => 'Grade 11',
1722: 12 => 'Grade 12',
1723: 13 => 'Grade 13',
1724: 14 => '100 Level',
1725: 15 => '200 Level',
1726: 16 => '300 Level',
1727: 17 => '400 Level',
1728: 18 => 'Graduate Level');
1729: return &mt($gradelevels{$gradelevel});
1730: }
1731:
1.163 www 1732: sub select_level_form {
1733: my ($deflevel,$name)=@_;
1734: unless ($deflevel) { $deflevel=0; }
1.167 www 1735: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1736: for (my $i=0; $i<=18; $i++) {
1737: $selectform.="<option value=\"$i\" ".
1.253 albertel 1738: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1739: ">".&gradeleveldescription($i)."</option>\n";
1740: }
1741: $selectform.="</select>";
1742: return $selectform;
1.163 www 1743: }
1.167 www 1744:
1.35 matthew 1745: #-------------------------------------------
1746:
1.45 matthew 1747: =pod
1748:
1.743 raeburn 1749: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1750:
1751: Returns a string containing a <select name='$name' size='1'> form to
1752: allow a user to select the domain to preform an operation in.
1753: See loncreateuser.pm for an example invocation and use.
1754:
1.90 www 1755: If the $includeempty flag is set, it also includes an empty choice ("no domain
1756: selected");
1757:
1.743 raeburn 1758: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1759:
1760: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1761:
1.35 matthew 1762: =cut
1763:
1764: #-------------------------------------------
1.34 matthew 1765: sub select_dom_form {
1.743 raeburn 1766: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1767: my $onchange;
1768: if ($autosubmit) {
1769: $onchange = ' onchange="this.form.submit()"';
1770: }
1.550 albertel 1771: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1772: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1773: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1774: foreach my $dom (@domains) {
1775: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1776: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1777: if ($showdomdesc) {
1778: if ($dom ne '') {
1779: my $domdesc = &Apache::lonnet::domain($dom,'description');
1780: if ($domdesc ne '') {
1781: $selectdomain .= ' ('.$domdesc.')';
1782: }
1783: }
1784: }
1785: $selectdomain .= "</option>\n";
1.34 matthew 1786: }
1787: $selectdomain.="</select>";
1788: return $selectdomain;
1789: }
1790:
1.35 matthew 1791: #-------------------------------------------
1792:
1.45 matthew 1793: =pod
1794:
1.648 raeburn 1795: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1796:
1.586 raeburn 1797: input: 4 arguments (two required, two optional) -
1798: $domain - domain of new user
1799: $name - name of form element
1800: $default - Value of 'default' causes a default item to be first
1801: option, and selected by default.
1802: $hide - Value of 'hide' causes hiding of the name of the server,
1803: if 1 server found, or default, if 0 found.
1.594 raeburn 1804: output: returns 2 items:
1.586 raeburn 1805: (a) form element which contains either:
1806: (i) <select name="$name">
1807: <option value="$hostid1">$hostid $servers{$hostid}</option>
1808: <option value="$hostid2">$hostid $servers{$hostid}</option>
1809: </select>
1810: form item if there are multiple library servers in $domain, or
1811: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1812: if there is only one library server in $domain.
1813:
1814: (b) number of library servers found.
1815:
1816: See loncreateuser.pm for example of use.
1.35 matthew 1817:
1818: =cut
1819:
1820: #-------------------------------------------
1.586 raeburn 1821: sub home_server_form_item {
1822: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1823: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1824: my $result;
1825: my $numlib = keys(%servers);
1826: if ($numlib > 1) {
1827: $result .= '<select name="'.$name.'" />'."\n";
1828: if ($default) {
1829: $result .= '<option value="default" selected>'.&mt('default').
1830: '</option>'."\n";
1831: }
1832: foreach my $hostid (sort(keys(%servers))) {
1833: $result.= '<option value="'.$hostid.'">'.
1834: $hostid.' '.$servers{$hostid}."</option>\n";
1835: }
1836: $result .= '</select>'."\n";
1837: } elsif ($numlib == 1) {
1838: my $hostid;
1839: foreach my $item (keys(%servers)) {
1840: $hostid = $item;
1841: }
1842: $result .= '<input type="hidden" name="'.$name.'" value="'.
1843: $hostid.'" />';
1844: if (!$hide) {
1845: $result .= $hostid.' '.$servers{$hostid};
1846: }
1847: $result .= "\n";
1848: } elsif ($default) {
1849: $result .= '<input type="hidden" name="'.$name.
1850: '" value="default" />';
1851: if (!$hide) {
1852: $result .= &mt('default');
1853: }
1854: $result .= "\n";
1.33 matthew 1855: }
1.586 raeburn 1856: return ($result,$numlib);
1.33 matthew 1857: }
1.112 bowersj2 1858:
1859: =pod
1860:
1.534 albertel 1861: =back
1862:
1.112 bowersj2 1863: =cut
1.87 matthew 1864:
1865: ###############################################################
1.112 bowersj2 1866: ## Decoding User Agent ##
1.87 matthew 1867: ###############################################################
1868:
1869: =pod
1870:
1.112 bowersj2 1871: =head1 Decoding the User Agent
1872:
1873: =over 4
1874:
1875: =item * &decode_user_agent()
1.87 matthew 1876:
1877: Inputs: $r
1878:
1879: Outputs:
1880:
1881: =over 4
1882:
1.112 bowersj2 1883: =item * $httpbrowser
1.87 matthew 1884:
1.112 bowersj2 1885: =item * $clientbrowser
1.87 matthew 1886:
1.112 bowersj2 1887: =item * $clientversion
1.87 matthew 1888:
1.112 bowersj2 1889: =item * $clientmathml
1.87 matthew 1890:
1.112 bowersj2 1891: =item * $clientunicode
1.87 matthew 1892:
1.112 bowersj2 1893: =item * $clientos
1.87 matthew 1894:
1895: =back
1896:
1.157 matthew 1897: =back
1898:
1.87 matthew 1899: =cut
1900:
1901: ###############################################################
1902: ###############################################################
1903: sub decode_user_agent {
1.247 albertel 1904: my ($r)=@_;
1.87 matthew 1905: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1906: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1907: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1908: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1909: my $clientbrowser='unknown';
1910: my $clientversion='0';
1911: my $clientmathml='';
1912: my $clientunicode='0';
1913: for (my $i=0;$i<=$#browsertype;$i++) {
1914: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1915: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1916: $clientbrowser=$bname;
1917: $httpbrowser=~/$vreg/i;
1918: $clientversion=$1;
1919: $clientmathml=($clientversion>=$minv);
1920: $clientunicode=($clientversion>=$univ);
1921: }
1922: }
1923: my $clientos='unknown';
1924: if (($httpbrowser=~/linux/i) ||
1925: ($httpbrowser=~/unix/i) ||
1926: ($httpbrowser=~/ux/i) ||
1927: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1928: if (($httpbrowser=~/vax/i) ||
1929: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1930: if ($httpbrowser=~/next/i) { $clientos='next'; }
1931: if (($httpbrowser=~/mac/i) ||
1932: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1933: if ($httpbrowser=~/win/i) { $clientos='win'; }
1934: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1935: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1936: $clientunicode,$clientos,);
1937: }
1938:
1.32 matthew 1939: ###############################################################
1940: ## Authentication changing form generation subroutines ##
1941: ###############################################################
1942: ##
1943: ## All of the authform_xxxxxxx subroutines take their inputs in a
1944: ## hash, and have reasonable default values.
1945: ##
1946: ## formname = the name given in the <form> tag.
1.35 matthew 1947: #-------------------------------------------
1948:
1.45 matthew 1949: =pod
1950:
1.112 bowersj2 1951: =head1 Authentication Routines
1952:
1953: =over 4
1954:
1.648 raeburn 1955: =item * &authform_xxxxxx()
1.35 matthew 1956:
1957: The authform_xxxxxx subroutines provide javascript and html forms which
1958: handle some of the conveniences required for authentication forms.
1959: This is not an optimal method, but it works.
1960:
1961: =over 4
1962:
1.112 bowersj2 1963: =item * authform_header
1.35 matthew 1964:
1.112 bowersj2 1965: =item * authform_authorwarning
1.35 matthew 1966:
1.112 bowersj2 1967: =item * authform_nochange
1.35 matthew 1968:
1.112 bowersj2 1969: =item * authform_kerberos
1.35 matthew 1970:
1.112 bowersj2 1971: =item * authform_internal
1.35 matthew 1972:
1.112 bowersj2 1973: =item * authform_filesystem
1.35 matthew 1974:
1975: =back
1976:
1.648 raeburn 1977: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1978:
1.35 matthew 1979: =cut
1980:
1981: #-------------------------------------------
1.32 matthew 1982: sub authform_header{
1983: my %in = (
1984: formname => 'cu',
1.80 albertel 1985: kerb_def_dom => '',
1.32 matthew 1986: @_,
1987: );
1988: $in{'formname'} = 'document.' . $in{'formname'};
1989: my $result='';
1.80 albertel 1990:
1991: #---------------------------------------------- Code for upper case translation
1992: my $Javascript_toUpperCase;
1993: unless ($in{kerb_def_dom}) {
1994: $Javascript_toUpperCase =<<"END";
1995: switch (choice) {
1996: case 'krb': currentform.elements[choicearg].value =
1997: currentform.elements[choicearg].value.toUpperCase();
1998: break;
1999: default:
2000: }
2001: END
2002: } else {
2003: $Javascript_toUpperCase = "";
2004: }
2005:
1.165 raeburn 2006: my $radioval = "'nochange'";
1.591 raeburn 2007: if (defined($in{'curr_authtype'})) {
2008: if ($in{'curr_authtype'} ne '') {
2009: $radioval = "'".$in{'curr_authtype'}."arg'";
2010: }
1.174 matthew 2011: }
1.165 raeburn 2012: my $argfield = 'null';
1.591 raeburn 2013: if (defined($in{'mode'})) {
1.165 raeburn 2014: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2015: if (defined($in{'curr_autharg'})) {
2016: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2017: $argfield = "'$in{'curr_autharg'}'";
2018: }
2019: }
2020: }
2021: }
2022:
1.32 matthew 2023: $result.=<<"END";
2024: var current = new Object();
1.165 raeburn 2025: current.radiovalue = $radioval;
2026: current.argfield = $argfield;
1.32 matthew 2027:
2028: function changed_radio(choice,currentform) {
2029: var choicearg = choice + 'arg';
2030: // If a radio button in changed, we need to change the argfield
2031: if (current.radiovalue != choice) {
2032: current.radiovalue = choice;
2033: if (current.argfield != null) {
2034: currentform.elements[current.argfield].value = '';
2035: }
2036: if (choice == 'nochange') {
2037: current.argfield = null;
2038: } else {
2039: current.argfield = choicearg;
2040: switch(choice) {
2041: case 'krb':
2042: currentform.elements[current.argfield].value =
2043: "$in{'kerb_def_dom'}";
2044: break;
2045: default:
2046: break;
2047: }
2048: }
2049: }
2050: return;
2051: }
1.22 www 2052:
1.32 matthew 2053: function changed_text(choice,currentform) {
2054: var choicearg = choice + 'arg';
2055: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2056: $Javascript_toUpperCase
1.32 matthew 2057: // clear old field
2058: if ((current.argfield != choicearg) && (current.argfield != null)) {
2059: currentform.elements[current.argfield].value = '';
2060: }
2061: current.argfield = choicearg;
2062: }
2063: set_auth_radio_buttons(choice,currentform);
2064: return;
1.20 www 2065: }
1.32 matthew 2066:
2067: function set_auth_radio_buttons(newvalue,currentform) {
2068: var i=0;
2069: while (i < currentform.login.length) {
2070: if (currentform.login[i].value == newvalue) { break; }
2071: i++;
2072: }
2073: if (i == currentform.login.length) {
2074: return;
2075: }
2076: current.radiovalue = newvalue;
2077: currentform.login[i].checked = true;
2078: return;
2079: }
2080: END
2081: return $result;
2082: }
2083:
2084: sub authform_authorwarning{
2085: my $result='';
1.144 matthew 2086: $result='<i>'.
2087: &mt('As a general rule, only authors or co-authors should be '.
2088: 'filesystem authenticated '.
2089: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2090: return $result;
2091: }
2092:
2093: sub authform_nochange{
2094: my %in = (
2095: formname => 'document.cu',
2096: kerb_def_dom => 'MSU.EDU',
2097: @_,
2098: );
1.586 raeburn 2099: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2100: my $result;
2101: if (keys(%can_assign) == 0) {
2102: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2103: } else {
2104: $result = '<label>'.&mt('[_1] Do not change login data',
2105: '<input type="radio" name="login" value="nochange" '.
2106: 'checked="checked" onclick="'.
1.281 albertel 2107: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2108: '</label>';
1.586 raeburn 2109: }
1.32 matthew 2110: return $result;
2111: }
2112:
1.591 raeburn 2113: sub authform_kerberos {
1.32 matthew 2114: my %in = (
2115: formname => 'document.cu',
2116: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2117: kerb_def_auth => 'krb4',
1.32 matthew 2118: @_,
2119: );
1.586 raeburn 2120: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2121: $autharg,$jscall);
2122: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2123: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2124: $check5 = ' checked="on"';
1.80 albertel 2125: } else {
1.586 raeburn 2126: $check4 = ' checked="on"';
1.80 albertel 2127: }
1.165 raeburn 2128: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2129: if (defined($in{'curr_authtype'})) {
2130: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2131: $krbcheck = ' checked="on"';
1.623 raeburn 2132: if (defined($in{'mode'})) {
2133: if ($in{'mode'} eq 'modifyuser') {
2134: $krbcheck = '';
2135: }
2136: }
1.591 raeburn 2137: if (defined($in{'curr_kerb_ver'})) {
2138: if ($in{'curr_krb_ver'} eq '5') {
2139: $check5 = ' checked="on"';
2140: $check4 = '';
2141: } else {
2142: $check4 = ' checked="on"';
2143: $check5 = '';
2144: }
1.586 raeburn 2145: }
1.591 raeburn 2146: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2147: $krbarg = $in{'curr_autharg'};
2148: }
1.586 raeburn 2149: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2150: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2151: $result =
2152: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2153: $in{'curr_autharg'},$krbver);
2154: } else {
2155: $result =
2156: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2157: }
2158: return $result;
2159: }
2160: }
2161: } else {
2162: if ($authnum == 1) {
2163: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2164: }
2165: }
1.586 raeburn 2166: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2167: return;
1.587 raeburn 2168: } elsif ($authtype eq '') {
1.591 raeburn 2169: if (defined($in{'mode'})) {
1.587 raeburn 2170: if ($in{'mode'} eq 'modifycourse') {
2171: if ($authnum == 1) {
2172: $authtype = '<input type="hidden" name="login" value="krb">';
2173: }
2174: }
2175: }
1.586 raeburn 2176: }
2177: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2178: if ($authtype eq '') {
2179: $authtype = '<input type="radio" name="login" value="krb" '.
2180: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2181: $krbcheck.' />';
2182: }
2183: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2184: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2185: $in{'curr_authtype'} eq 'krb5') ||
2186: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2187: $in{'curr_authtype'} eq 'krb4')) {
2188: $result .= &mt
1.144 matthew 2189: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2190: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2191: '<label>'.$authtype,
1.281 albertel 2192: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2193: 'value="'.$krbarg.'" '.
1.144 matthew 2194: 'onchange="'.$jscall.'" />',
1.281 albertel 2195: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2196: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2197: '</label>');
1.586 raeburn 2198: } elsif ($can_assign{'krb4'}) {
2199: $result .= &mt
2200: ('[_1] Kerberos authenticated with domain [_2] '.
2201: '[_3] Version 4 [_4]',
2202: '<label>'.$authtype,
2203: '</label><input type="text" size="10" name="krbarg" '.
2204: 'value="'.$krbarg.'" '.
2205: 'onchange="'.$jscall.'" />',
2206: '<label><input type="hidden" name="krbver" value="4" />',
2207: '</label>');
2208: } elsif ($can_assign{'krb5'}) {
2209: $result .= &mt
2210: ('[_1] Kerberos authenticated with domain [_2] '.
2211: '[_3] Version 5 [_4]',
2212: '<label>'.$authtype,
2213: '</label><input type="text" size="10" name="krbarg" '.
2214: 'value="'.$krbarg.'" '.
2215: 'onchange="'.$jscall.'" />',
2216: '<label><input type="hidden" name="krbver" value="5" />',
2217: '</label>');
2218: }
1.32 matthew 2219: return $result;
2220: }
2221:
2222: sub authform_internal{
1.586 raeburn 2223: my %in = (
1.32 matthew 2224: formname => 'document.cu',
2225: kerb_def_dom => 'MSU.EDU',
2226: @_,
2227: );
1.586 raeburn 2228: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2229: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2230: if (defined($in{'curr_authtype'})) {
2231: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2232: if ($can_assign{'int'}) {
2233: $intcheck = 'checked="on" ';
1.623 raeburn 2234: if (defined($in{'mode'})) {
2235: if ($in{'mode'} eq 'modifyuser') {
2236: $intcheck = '';
2237: }
2238: }
1.591 raeburn 2239: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2240: $intarg = $in{'curr_autharg'};
2241: }
2242: } else {
2243: $result = &mt('Currently internally authenticated.');
2244: return $result;
1.165 raeburn 2245: }
2246: }
1.586 raeburn 2247: } else {
2248: if ($authnum == 1) {
2249: $authtype = '<input type="hidden" name="login" value="int">';
2250: }
2251: }
2252: if (!$can_assign{'int'}) {
2253: return;
1.587 raeburn 2254: } elsif ($authtype eq '') {
1.591 raeburn 2255: if (defined($in{'mode'})) {
1.587 raeburn 2256: if ($in{'mode'} eq 'modifycourse') {
2257: if ($authnum == 1) {
2258: $authtype = '<input type="hidden" name="login" value="int">';
2259: }
2260: }
2261: }
1.165 raeburn 2262: }
1.586 raeburn 2263: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2264: if ($authtype eq '') {
2265: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2266: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2267: }
1.605 bisitz 2268: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2269: $intarg.'" onchange="'.$jscall.'" />';
2270: $result = &mt
1.144 matthew 2271: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2272: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2273: $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 2274: return $result;
2275: }
2276:
2277: sub authform_local{
2278: my %in = (
2279: formname => 'document.cu',
2280: kerb_def_dom => 'MSU.EDU',
2281: @_,
2282: );
1.586 raeburn 2283: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2284: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2285: if (defined($in{'curr_authtype'})) {
2286: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2287: if ($can_assign{'loc'}) {
2288: $loccheck = 'checked="on" ';
1.623 raeburn 2289: if (defined($in{'mode'})) {
2290: if ($in{'mode'} eq 'modifyuser') {
2291: $loccheck = '';
2292: }
2293: }
1.591 raeburn 2294: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2295: $locarg = $in{'curr_autharg'};
2296: }
2297: } else {
2298: $result = &mt('Currently using local (institutional) authentication.');
2299: return $result;
1.165 raeburn 2300: }
2301: }
1.586 raeburn 2302: } else {
2303: if ($authnum == 1) {
2304: $authtype = '<input type="hidden" name="login" value="loc">';
2305: }
2306: }
2307: if (!$can_assign{'loc'}) {
2308: return;
1.587 raeburn 2309: } elsif ($authtype eq '') {
1.591 raeburn 2310: if (defined($in{'mode'})) {
1.587 raeburn 2311: if ($in{'mode'} eq 'modifycourse') {
2312: if ($authnum == 1) {
2313: $authtype = '<input type="hidden" name="login" value="loc">';
2314: }
2315: }
2316: }
1.165 raeburn 2317: }
1.586 raeburn 2318: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2319: if ($authtype eq '') {
2320: $authtype = '<input type="radio" name="login" value="loc" '.
2321: $loccheck.' onchange="'.$jscall.'" onclick="'.
2322: $jscall.'" />';
2323: }
2324: $autharg = '<input type="text" size="10" name="locarg" value="'.
2325: $locarg.'" onchange="'.$jscall.'" />';
2326: $result = &mt('[_1] Local Authentication with argument [_2]',
2327: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2328: return $result;
2329: }
2330:
2331: sub authform_filesystem{
2332: my %in = (
2333: formname => 'document.cu',
2334: kerb_def_dom => 'MSU.EDU',
2335: @_,
2336: );
1.586 raeburn 2337: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2338: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2339: if (defined($in{'curr_authtype'})) {
2340: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2341: if ($can_assign{'fsys'}) {
2342: $fsyscheck = 'checked="on" ';
1.623 raeburn 2343: if (defined($in{'mode'})) {
2344: if ($in{'mode'} eq 'modifyuser') {
2345: $fsyscheck = '';
2346: }
2347: }
1.586 raeburn 2348: } else {
2349: $result = &mt('Currently Filesystem Authenticated.');
2350: return $result;
2351: }
2352: }
2353: } else {
2354: if ($authnum == 1) {
2355: $authtype = '<input type="hidden" name="login" value="fsys">';
2356: }
2357: }
2358: if (!$can_assign{'fsys'}) {
2359: return;
1.587 raeburn 2360: } elsif ($authtype eq '') {
1.591 raeburn 2361: if (defined($in{'mode'})) {
1.587 raeburn 2362: if ($in{'mode'} eq 'modifycourse') {
2363: if ($authnum == 1) {
2364: $authtype = '<input type="hidden" name="login" value="fsys">';
2365: }
2366: }
2367: }
1.586 raeburn 2368: }
2369: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2370: if ($authtype eq '') {
2371: $authtype = '<input type="radio" name="login" value="fsys" '.
2372: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2373: $jscall.'" />';
2374: }
2375: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2376: ' onchange="'.$jscall.'" />';
2377: $result = &mt
1.144 matthew 2378: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2379: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2380: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2381: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2382: 'onchange="'.$jscall.'" />');
1.32 matthew 2383: return $result;
2384: }
2385:
1.586 raeburn 2386: sub get_assignable_auth {
2387: my ($dom) = @_;
2388: if ($dom eq '') {
2389: $dom = $env{'request.role.domain'};
2390: }
2391: my %can_assign = (
2392: krb4 => 1,
2393: krb5 => 1,
2394: int => 1,
2395: loc => 1,
2396: );
2397: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2398: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2399: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2400: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2401: my $context;
2402: if ($env{'request.role'} =~ /^au/) {
2403: $context = 'author';
2404: } elsif ($env{'request.role'} =~ /^dc/) {
2405: $context = 'domain';
2406: } elsif ($env{'request.course.id'}) {
2407: $context = 'course';
2408: }
2409: if ($context) {
2410: if (ref($authhash->{$context}) eq 'HASH') {
2411: %can_assign = %{$authhash->{$context}};
2412: }
2413: }
2414: }
2415: }
2416: my $authnum = 0;
2417: foreach my $key (keys(%can_assign)) {
2418: if ($can_assign{$key}) {
2419: $authnum ++;
2420: }
2421: }
2422: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2423: $authnum --;
2424: }
2425: return ($authnum,%can_assign);
2426: }
2427:
1.80 albertel 2428: ###############################################################
2429: ## Get Kerberos Defaults for Domain ##
2430: ###############################################################
2431: ##
2432: ## Returns default kerberos version and an associated argument
2433: ## as listed in file domain.tab. If not listed, provides
2434: ## appropriate default domain and kerberos version.
2435: ##
2436: #-------------------------------------------
2437:
2438: =pod
2439:
1.648 raeburn 2440: =item * &get_kerberos_defaults()
1.80 albertel 2441:
2442: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2443: version and domain. If not found, it defaults to version 4 and the
2444: domain of the server.
1.80 albertel 2445:
1.648 raeburn 2446: =over 4
2447:
1.80 albertel 2448: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2449:
1.648 raeburn 2450: =back
2451:
2452: =back
2453:
1.80 albertel 2454: =cut
2455:
2456: #-------------------------------------------
2457: sub get_kerberos_defaults {
2458: my $domain=shift;
1.641 raeburn 2459: my ($krbdef,$krbdefdom);
2460: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2461: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2462: $krbdef = $domdefaults{'auth_def'};
2463: $krbdefdom = $domdefaults{'auth_arg_def'};
2464: } else {
1.80 albertel 2465: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2466: my $krbdefdom=$1;
2467: $krbdefdom=~tr/a-z/A-Z/;
2468: $krbdef = "krb4";
2469: }
2470: return ($krbdef,$krbdefdom);
2471: }
1.112 bowersj2 2472:
1.32 matthew 2473:
1.46 matthew 2474: ###############################################################
2475: ## Thesaurus Functions ##
2476: ###############################################################
1.20 www 2477:
1.46 matthew 2478: =pod
1.20 www 2479:
1.112 bowersj2 2480: =head1 Thesaurus Functions
2481:
2482: =over 4
2483:
1.648 raeburn 2484: =item * &initialize_keywords()
1.46 matthew 2485:
2486: Initializes the package variable %Keywords if it is empty. Uses the
2487: package variable $thesaurus_db_file.
2488:
2489: =cut
2490:
2491: ###################################################
2492:
2493: sub initialize_keywords {
2494: return 1 if (scalar keys(%Keywords));
2495: # If we are here, %Keywords is empty, so fill it up
2496: # Make sure the file we need exists...
2497: if (! -e $thesaurus_db_file) {
2498: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2499: " failed because it does not exist");
2500: return 0;
2501: }
2502: # Set up the hash as a database
2503: my %thesaurus_db;
2504: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2505: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2506: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2507: $thesaurus_db_file);
2508: return 0;
2509: }
2510: # Get the average number of appearances of a word.
2511: my $avecount = $thesaurus_db{'average.count'};
2512: # Put keywords (those that appear > average) into %Keywords
2513: while (my ($word,$data)=each (%thesaurus_db)) {
2514: my ($count,undef) = split /:/,$data;
2515: $Keywords{$word}++ if ($count > $avecount);
2516: }
2517: untie %thesaurus_db;
2518: # Remove special values from %Keywords.
1.356 albertel 2519: foreach my $value ('total.count','average.count') {
2520: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2521: }
1.46 matthew 2522: return 1;
2523: }
2524:
2525: ###################################################
2526:
2527: =pod
2528:
1.648 raeburn 2529: =item * &keyword($word)
1.46 matthew 2530:
2531: Returns true if $word is a keyword. A keyword is a word that appears more
2532: than the average number of times in the thesaurus database. Calls
2533: &initialize_keywords
2534:
2535: =cut
2536:
2537: ###################################################
1.20 www 2538:
2539: sub keyword {
1.46 matthew 2540: return if (!&initialize_keywords());
2541: my $word=lc(shift());
2542: $word=~s/\W//g;
2543: return exists($Keywords{$word});
1.20 www 2544: }
1.46 matthew 2545:
2546: ###############################################################
2547:
2548: =pod
1.20 www 2549:
1.648 raeburn 2550: =item * &get_related_words()
1.46 matthew 2551:
1.160 matthew 2552: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2553: an array of words. If the keyword is not in the thesaurus, an empty array
2554: will be returned. The order of the words returned is determined by the
2555: database which holds them.
2556:
2557: Uses global $thesaurus_db_file.
2558:
2559: =cut
2560:
2561: ###############################################################
2562: sub get_related_words {
2563: my $keyword = shift;
2564: my %thesaurus_db;
2565: if (! -e $thesaurus_db_file) {
2566: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2567: "failed because the file does not exist");
2568: return ();
2569: }
2570: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2571: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2572: return ();
2573: }
2574: my @Words=();
1.429 www 2575: my $count=0;
1.46 matthew 2576: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2577: # The first element is the number of times
2578: # the word appears. We do not need it now.
1.429 www 2579: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2580: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2581: my $threshold=$mostfrequentcount/10;
2582: foreach my $possibleword (@RelatedWords) {
2583: my ($word,$wordcount)=split(/\,/,$possibleword);
2584: if ($wordcount>$threshold) {
2585: push(@Words,$word);
2586: $count++;
2587: if ($count>10) { last; }
2588: }
1.20 www 2589: }
2590: }
1.46 matthew 2591: untie %thesaurus_db;
2592: return @Words;
1.14 harris41 2593: }
1.46 matthew 2594:
1.112 bowersj2 2595: =pod
2596:
2597: =back
2598:
2599: =cut
1.61 www 2600:
2601: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2602: =pod
2603:
1.112 bowersj2 2604: =head1 User Name Functions
2605:
2606: =over 4
2607:
1.648 raeburn 2608: =item * &plainname($uname,$udom,$first)
1.81 albertel 2609:
1.112 bowersj2 2610: Takes a users logon name and returns it as a string in
1.226 albertel 2611: "first middle last generation" form
2612: if $first is set to 'lastname' then it returns it as
2613: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2614:
2615: =cut
1.61 www 2616:
1.295 www 2617:
1.81 albertel 2618: ###############################################################
1.61 www 2619: sub plainname {
1.226 albertel 2620: my ($uname,$udom,$first)=@_;
1.537 albertel 2621: return if (!defined($uname) || !defined($udom));
1.295 www 2622: my %names=&getnames($uname,$udom);
1.226 albertel 2623: my $name=&Apache::lonnet::format_name($names{'firstname'},
2624: $names{'middlename'},
2625: $names{'lastname'},
2626: $names{'generation'},$first);
2627: $name=~s/^\s+//;
1.62 www 2628: $name=~s/\s+$//;
2629: $name=~s/\s+/ /g;
1.353 albertel 2630: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2631: return $name;
1.61 www 2632: }
1.66 www 2633:
2634: # -------------------------------------------------------------------- Nickname
1.81 albertel 2635: =pod
2636:
1.648 raeburn 2637: =item * &nickname($uname,$udom)
1.81 albertel 2638:
2639: Gets a users name and returns it as a string as
2640:
2641: ""nickname""
1.66 www 2642:
1.81 albertel 2643: if the user has a nickname or
2644:
2645: "first middle last generation"
2646:
2647: if the user does not
2648:
2649: =cut
1.66 www 2650:
2651: sub nickname {
2652: my ($uname,$udom)=@_;
1.537 albertel 2653: return if (!defined($uname) || !defined($udom));
1.295 www 2654: my %names=&getnames($uname,$udom);
1.68 albertel 2655: my $name=$names{'nickname'};
1.66 www 2656: if ($name) {
2657: $name='"'.$name.'"';
2658: } else {
2659: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2660: $names{'lastname'}.' '.$names{'generation'};
2661: $name=~s/\s+$//;
2662: $name=~s/\s+/ /g;
2663: }
2664: return $name;
2665: }
2666:
1.295 www 2667: sub getnames {
2668: my ($uname,$udom)=@_;
1.537 albertel 2669: return if (!defined($uname) || !defined($udom));
1.433 albertel 2670: if ($udom eq 'public' && $uname eq 'public') {
2671: return ('lastname' => &mt('Public'));
2672: }
1.295 www 2673: my $id=$uname.':'.$udom;
2674: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2675: if ($cached) {
2676: return %{$names};
2677: } else {
2678: my %loadnames=&Apache::lonnet::get('environment',
2679: ['firstname','middlename','lastname','generation','nickname'],
2680: $udom,$uname);
2681: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2682: return %loadnames;
2683: }
2684: }
1.61 www 2685:
1.542 raeburn 2686: # -------------------------------------------------------------------- getemails
1.648 raeburn 2687:
1.542 raeburn 2688: =pod
2689:
1.648 raeburn 2690: =item * &getemails($uname,$udom)
1.542 raeburn 2691:
2692: Gets a user's email information and returns it as a hash with keys:
2693: notification, critnotification, permanentemail
2694:
2695: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2696: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2697:
1.648 raeburn 2698:
1.542 raeburn 2699: =cut
2700:
1.648 raeburn 2701:
1.466 albertel 2702: sub getemails {
2703: my ($uname,$udom)=@_;
2704: if ($udom eq 'public' && $uname eq 'public') {
2705: return;
2706: }
1.467 www 2707: if (!$udom) { $udom=$env{'user.domain'}; }
2708: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2709: my $id=$uname.':'.$udom;
2710: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2711: if ($cached) {
2712: return %{$names};
2713: } else {
2714: my %loadnames=&Apache::lonnet::get('environment',
2715: ['notification','critnotification',
2716: 'permanentemail'],
2717: $udom,$uname);
2718: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2719: return %loadnames;
2720: }
2721: }
2722:
1.551 albertel 2723: sub flush_email_cache {
2724: my ($uname,$udom)=@_;
2725: if (!$udom) { $udom =$env{'user.domain'}; }
2726: if (!$uname) { $uname=$env{'user.name'}; }
2727: return if ($udom eq 'public' && $uname eq 'public');
2728: my $id=$uname.':'.$udom;
2729: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2730: }
2731:
1.728 raeburn 2732: # -------------------------------------------------------------------- getlangs
2733:
2734: =pod
2735:
2736: =item * &getlangs($uname,$udom)
2737:
2738: Gets a user's language preference and returns it as a hash with key:
2739: language.
2740:
2741: =cut
2742:
2743:
2744: sub getlangs {
2745: my ($uname,$udom) = @_;
2746: if (!$udom) { $udom =$env{'user.domain'}; }
2747: if (!$uname) { $uname=$env{'user.name'}; }
2748: my $id=$uname.':'.$udom;
2749: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2750: if ($cached) {
2751: return %{$langs};
2752: } else {
2753: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2754: $udom,$uname);
2755: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2756: return %loadlangs;
2757: }
2758: }
2759:
2760: sub flush_langs_cache {
2761: my ($uname,$udom)=@_;
2762: if (!$udom) { $udom =$env{'user.domain'}; }
2763: if (!$uname) { $uname=$env{'user.name'}; }
2764: return if ($udom eq 'public' && $uname eq 'public');
2765: my $id=$uname.':'.$udom;
2766: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2767: }
2768:
1.61 www 2769: # ------------------------------------------------------------------ Screenname
1.81 albertel 2770:
2771: =pod
2772:
1.648 raeburn 2773: =item * &screenname($uname,$udom)
1.81 albertel 2774:
2775: Gets a users screenname and returns it as a string
2776:
2777: =cut
1.61 www 2778:
2779: sub screenname {
2780: my ($uname,$udom)=@_;
1.258 albertel 2781: if ($uname eq $env{'user.name'} &&
2782: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2783: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2784: return $names{'screenname'};
1.62 www 2785: }
2786:
1.212 albertel 2787:
1.62 www 2788: # ------------------------------------------------------------- Message Wrapper
2789:
2790: sub messagewrapper {
1.369 www 2791: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2792: return
1.441 albertel 2793: '<a href="/adm/email?compose=individual&'.
2794: 'recname='.$username.'&recdom='.$domain.
2795: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2796: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2797: }
2798: # --------------------------------------------------------------- Notes Wrapper
2799:
2800: sub noteswrapper {
2801: my ($link,$un,$do)=@_;
2802: return
2803: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2804: }
2805: # ------------------------------------------------------------- Aboutme Wrapper
2806:
2807: sub aboutmewrapper {
1.166 www 2808: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2809: if (!defined($username) && !defined($domain)) {
2810: return;
2811: }
1.205 www 2812: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.750 ! weissno 2813: ($target?' target="$target"':'').' title="'.&mt("View this user's personal
! 2814: homepage").'">'.$link.'</a>';
1.62 www 2815: }
2816:
2817: # ------------------------------------------------------------ Syllabus Wrapper
2818:
2819:
2820: sub syllabuswrapper {
1.707 bisitz 2821: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2822: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2823: }
1.14 harris41 2824:
1.208 matthew 2825: sub track_student_link {
1.268 albertel 2826: my ($linktext,$sname,$sdom,$target,$start) = @_;
2827: my $link ="/adm/trackstudent?";
1.208 matthew 2828: my $title = 'View recent activity';
2829: if (defined($sname) && $sname !~ /^\s*$/ &&
2830: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2831: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2832: $title .= ' of this student';
1.268 albertel 2833: }
1.208 matthew 2834: if (defined($target) && $target !~ /^\s*$/) {
2835: $target = qq{target="$target"};
2836: } else {
2837: $target = '';
2838: }
1.268 albertel 2839: if ($start) { $link.='&start='.$start; }
1.554 albertel 2840: $title = &mt($title);
2841: $linktext = &mt($linktext);
1.448 albertel 2842: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2843: &help_open_topic('View_recent_activity');
1.208 matthew 2844: }
2845:
1.508 www 2846: # ===================================================== Display a student photo
2847:
2848:
1.509 albertel 2849: sub student_image_tag {
1.508 www 2850: my ($domain,$user)=@_;
2851: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2852: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2853: return '<img src="'.$imgsrc.'" align="right" />';
2854: } else {
2855: return '';
2856: }
2857: }
2858:
1.112 bowersj2 2859: =pod
2860:
2861: =back
2862:
2863: =head1 Access .tab File Data
2864:
2865: =over 4
2866:
1.648 raeburn 2867: =item * &languageids()
1.112 bowersj2 2868:
2869: returns list of all language ids
2870:
2871: =cut
2872:
1.14 harris41 2873: sub languageids {
1.16 harris41 2874: return sort(keys(%language));
1.14 harris41 2875: }
2876:
1.112 bowersj2 2877: =pod
2878:
1.648 raeburn 2879: =item * &languagedescription()
1.112 bowersj2 2880:
2881: returns description of a specified language id
2882:
2883: =cut
2884:
1.14 harris41 2885: sub languagedescription {
1.125 www 2886: my $code=shift;
2887: return ($supported_language{$code}?'* ':'').
2888: $language{$code}.
1.126 www 2889: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2890: }
2891:
2892: sub plainlanguagedescription {
2893: my $code=shift;
2894: return $language{$code};
2895: }
2896:
2897: sub supportedlanguagecode {
2898: my $code=shift;
2899: return $supported_language{$code};
1.97 www 2900: }
2901:
1.112 bowersj2 2902: =pod
2903:
1.648 raeburn 2904: =item * ©rightids()
1.112 bowersj2 2905:
2906: returns list of all copyrights
2907:
2908: =cut
2909:
2910: sub copyrightids {
2911: return sort(keys(%cprtag));
2912: }
2913:
2914: =pod
2915:
1.648 raeburn 2916: =item * ©rightdescription()
1.112 bowersj2 2917:
2918: returns description of a specified copyright id
2919:
2920: =cut
2921:
2922: sub copyrightdescription {
1.166 www 2923: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2924: }
1.197 matthew 2925:
2926: =pod
2927:
1.648 raeburn 2928: =item * &source_copyrightids()
1.192 taceyjo1 2929:
2930: returns list of all source copyrights
2931:
2932: =cut
2933:
2934: sub source_copyrightids {
2935: return sort(keys(%scprtag));
2936: }
2937:
2938: =pod
2939:
1.648 raeburn 2940: =item * &source_copyrightdescription()
1.192 taceyjo1 2941:
2942: returns description of a specified source copyright id
2943:
2944: =cut
2945:
2946: sub source_copyrightdescription {
2947: return &mt($scprtag{shift(@_)});
2948: }
1.112 bowersj2 2949:
2950: =pod
2951:
1.648 raeburn 2952: =item * &filecategories()
1.112 bowersj2 2953:
2954: returns list of all file categories
2955:
2956: =cut
2957:
2958: sub filecategories {
2959: return sort(keys(%category_extensions));
2960: }
2961:
2962: =pod
2963:
1.648 raeburn 2964: =item * &filecategorytypes()
1.112 bowersj2 2965:
2966: returns list of file types belonging to a given file
2967: category
2968:
2969: =cut
2970:
2971: sub filecategorytypes {
1.356 albertel 2972: my ($cat) = @_;
2973: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2974: }
2975:
2976: =pod
2977:
1.648 raeburn 2978: =item * &fileembstyle()
1.112 bowersj2 2979:
2980: returns embedding style for a specified file type
2981:
2982: =cut
2983:
2984: sub fileembstyle {
2985: return $fe{lc(shift(@_))};
1.169 www 2986: }
2987:
1.351 www 2988: sub filemimetype {
2989: return $fm{lc(shift(@_))};
2990: }
2991:
1.169 www 2992:
2993: sub filecategoryselect {
2994: my ($name,$value)=@_;
1.189 matthew 2995: return &select_form($value,$name,
1.169 www 2996: '' => &mt('Any category'),
2997: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2998: }
2999:
3000: =pod
3001:
1.648 raeburn 3002: =item * &filedescription()
1.112 bowersj2 3003:
3004: returns description for a specified file type
3005:
3006: =cut
3007:
3008: sub filedescription {
1.188 matthew 3009: my $file_description = $fd{lc(shift())};
3010: $file_description =~ s:([\[\]]):~$1:g;
3011: return &mt($file_description);
1.112 bowersj2 3012: }
3013:
3014: =pod
3015:
1.648 raeburn 3016: =item * &filedescriptionex()
1.112 bowersj2 3017:
3018: returns description for a specified file type with
3019: extra formatting
3020:
3021: =cut
3022:
3023: sub filedescriptionex {
3024: my $ex=shift;
1.188 matthew 3025: my $file_description = $fd{lc($ex)};
3026: $file_description =~ s:([\[\]]):~$1:g;
3027: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3028: }
3029:
3030: # End of .tab access
3031: =pod
3032:
3033: =back
3034:
3035: =cut
3036:
3037: # ------------------------------------------------------------------ File Types
3038: sub fileextensions {
3039: return sort(keys(%fe));
3040: }
3041:
1.97 www 3042: # ----------------------------------------------------------- Display Languages
3043: # returns a hash with all desired display languages
3044: #
3045:
3046: sub display_languages {
3047: my %languages=();
1.695 raeburn 3048: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3049: $languages{$lang}=1;
1.97 www 3050: }
3051: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3052: if ($env{'form.displaylanguage'}) {
1.356 albertel 3053: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3054: $languages{$lang}=1;
1.97 www 3055: }
3056: }
3057: return %languages;
1.14 harris41 3058: }
3059:
1.582 albertel 3060: sub languages {
3061: my ($possible_langs) = @_;
1.695 raeburn 3062: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3063: if (!ref($possible_langs)) {
3064: if( wantarray ) {
3065: return @preferred_langs;
3066: } else {
3067: return $preferred_langs[0];
3068: }
3069: }
3070: my %possibilities = map { $_ => 1 } (@$possible_langs);
3071: my @preferred_possibilities;
3072: foreach my $preferred_lang (@preferred_langs) {
3073: if (exists($possibilities{$preferred_lang})) {
3074: push(@preferred_possibilities, $preferred_lang);
3075: }
3076: }
3077: if( wantarray ) {
3078: return @preferred_possibilities;
3079: }
3080: return $preferred_possibilities[0];
3081: }
3082:
1.742 raeburn 3083: sub user_lang {
3084: my ($touname,$toudom,$fromcid) = @_;
3085: my @userlangs;
3086: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3087: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3088: $env{'course.'.$fromcid.'.languages'}));
3089: } else {
3090: my %langhash = &getlangs($touname,$toudom);
3091: if ($langhash{'languages'} ne '') {
3092: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3093: } else {
3094: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3095: if ($domdefs{'lang_def'} ne '') {
3096: @userlangs = ($domdefs{'lang_def'});
3097: }
3098: }
3099: }
3100: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3101: my $user_lh = Apache::localize->get_handle(@languages);
3102: return $user_lh;
3103: }
3104:
3105:
1.112 bowersj2 3106: ###############################################################
3107: ## Student Answer Attempts ##
3108: ###############################################################
3109:
3110: =pod
3111:
3112: =head1 Alternate Problem Views
3113:
3114: =over 4
3115:
1.648 raeburn 3116: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3117: $getattempt, $regexp, $gradesub)
3118:
3119: Return string with previous attempt on problem. Arguments:
3120:
3121: =over 4
3122:
3123: =item * $symb: Problem, including path
3124:
3125: =item * $username: username of the desired student
3126:
3127: =item * $domain: domain of the desired student
1.14 harris41 3128:
1.112 bowersj2 3129: =item * $course: Course ID
1.14 harris41 3130:
1.112 bowersj2 3131: =item * $getattempt: Leave blank for all attempts, otherwise put
3132: something
1.14 harris41 3133:
1.112 bowersj2 3134: =item * $regexp: if string matches this regexp, the string will be
3135: sent to $gradesub
1.14 harris41 3136:
1.112 bowersj2 3137: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3138:
1.112 bowersj2 3139: =back
1.14 harris41 3140:
1.112 bowersj2 3141: The output string is a table containing all desired attempts, if any.
1.16 harris41 3142:
1.112 bowersj2 3143: =cut
1.1 albertel 3144:
3145: sub get_previous_attempt {
1.43 ng 3146: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3147: my $prevattempts='';
1.43 ng 3148: no strict 'refs';
1.1 albertel 3149: if ($symb) {
1.3 albertel 3150: my (%returnhash)=
3151: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3152: if ($returnhash{'version'}) {
3153: my %lasthash=();
3154: my $version;
3155: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3156: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3157: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3158: }
1.1 albertel 3159: }
1.596 albertel 3160: $prevattempts=&start_data_table().&start_data_table_header_row();
3161: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3162: foreach my $key (sort(keys(%lasthash))) {
3163: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3164: if ($#parts > 0) {
1.31 albertel 3165: my $data=$parts[-1];
3166: pop(@parts);
1.596 albertel 3167: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3168: } else {
1.41 ng 3169: if ($#parts == 0) {
3170: $prevattempts.='<th>'.$parts[0].'</th>';
3171: } else {
3172: $prevattempts.='<th>'.$ign.'</th>';
3173: }
1.31 albertel 3174: }
1.16 harris41 3175: }
1.596 albertel 3176: $prevattempts.=&end_data_table_header_row();
1.40 ng 3177: if ($getattempt eq '') {
3178: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3179: $prevattempts.=&start_data_table_row().
3180: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3181: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3182: my $value = &format_previous_attempt_value($key,
3183: $returnhash{$version.':'.$key});
3184: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3185: }
1.596 albertel 3186: $prevattempts.=&end_data_table_row();
1.40 ng 3187: }
1.1 albertel 3188: }
1.596 albertel 3189: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3190: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3191: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3192: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3193: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3194: }
1.596 albertel 3195: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3196: } else {
1.596 albertel 3197: $prevattempts=
3198: &start_data_table().&start_data_table_row().
3199: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3200: &end_data_table_row().&end_data_table();
1.1 albertel 3201: }
3202: } else {
1.596 albertel 3203: $prevattempts=
3204: &start_data_table().&start_data_table_row().
3205: '<td>'.&mt('No data.').'</td>'.
3206: &end_data_table_row().&end_data_table();
1.1 albertel 3207: }
1.10 albertel 3208: }
3209:
1.581 albertel 3210: sub format_previous_attempt_value {
3211: my ($key,$value) = @_;
3212: if ($key =~ /timestamp/) {
3213: $value = &Apache::lonlocal::locallocaltime($value);
3214: } elsif (ref($value) eq 'ARRAY') {
3215: $value = '('.join(', ', @{ $value }).')';
3216: } else {
3217: $value = &unescape($value);
3218: }
3219: return $value;
3220: }
3221:
3222:
1.107 albertel 3223: sub relative_to_absolute {
3224: my ($url,$output)=@_;
3225: my $parser=HTML::TokeParser->new(\$output);
3226: my $token;
3227: my $thisdir=$url;
3228: my @rlinks=();
3229: while ($token=$parser->get_token) {
3230: if ($token->[0] eq 'S') {
3231: if ($token->[1] eq 'a') {
3232: if ($token->[2]->{'href'}) {
3233: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3234: }
3235: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3236: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3237: } elsif ($token->[1] eq 'base') {
3238: $thisdir=$token->[2]->{'href'};
3239: }
3240: }
3241: }
3242: $thisdir=~s-/[^/]*$--;
1.356 albertel 3243: foreach my $link (@rlinks) {
1.726 raeburn 3244: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3245: ($link=~/^\//) ||
3246: ($link=~/^javascript:/i) ||
3247: ($link=~/^mailto:/i) ||
3248: ($link=~/^\#/)) {
3249: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3250: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3251: }
3252: }
3253: # -------------------------------------------------- Deal with Applet codebases
3254: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3255: return $output;
3256: }
3257:
1.112 bowersj2 3258: =pod
3259:
1.648 raeburn 3260: =item * &get_student_view()
1.112 bowersj2 3261:
3262: show a snapshot of what student was looking at
3263:
3264: =cut
3265:
1.10 albertel 3266: sub get_student_view {
1.186 albertel 3267: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3268: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3269: my (%form);
1.10 albertel 3270: my @elements=('symb','courseid','domain','username');
3271: foreach my $element (@elements) {
1.186 albertel 3272: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3273: }
1.186 albertel 3274: if (defined($moreenv)) {
3275: %form=(%form,%{$moreenv});
3276: }
1.236 albertel 3277: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3278: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3279: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3280: $userview=~s/\<body[^\>]*\>//gi;
3281: $userview=~s/\<\/body\>//gi;
3282: $userview=~s/\<html\>//gi;
3283: $userview=~s/\<\/html\>//gi;
3284: $userview=~s/\<head\>//gi;
3285: $userview=~s/\<\/head\>//gi;
3286: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3287: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3288: if (wantarray) {
3289: return ($userview,$response);
3290: } else {
3291: return $userview;
3292: }
3293: }
3294:
3295: sub get_student_view_with_retries {
3296: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3297:
3298: my $ok = 0; # True if we got a good response.
3299: my $content;
3300: my $response;
3301:
3302: # Try to get the student_view done. within the retries count:
3303:
3304: do {
3305: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3306: $ok = $response->is_success;
3307: if (!$ok) {
3308: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3309: }
3310: $retries--;
3311: } while (!$ok && ($retries > 0));
3312:
3313: if (!$ok) {
3314: $content = ''; # On error return an empty content.
3315: }
1.651 www 3316: if (wantarray) {
3317: return ($content, $response);
3318: } else {
3319: return $content;
3320: }
1.11 albertel 3321: }
3322:
1.112 bowersj2 3323: =pod
3324:
1.648 raeburn 3325: =item * &get_student_answers()
1.112 bowersj2 3326:
3327: show a snapshot of how student was answering problem
3328:
3329: =cut
3330:
1.11 albertel 3331: sub get_student_answers {
1.100 sakharuk 3332: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3333: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3334: my (%moreenv);
1.11 albertel 3335: my @elements=('symb','courseid','domain','username');
3336: foreach my $element (@elements) {
1.186 albertel 3337: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3338: }
1.186 albertel 3339: $moreenv{'grade_target'}='answer';
3340: %moreenv=(%form,%moreenv);
1.497 raeburn 3341: $feedurl = &Apache::lonnet::clutter($feedurl);
3342: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3343: return $userview;
1.1 albertel 3344: }
1.116 albertel 3345:
3346: =pod
3347:
3348: =item * &submlink()
3349:
1.242 albertel 3350: Inputs: $text $uname $udom $symb $target
1.116 albertel 3351:
3352: Returns: A link to grades.pm such as to see the SUBM view of a student
3353:
3354: =cut
3355:
3356: ###############################################
3357: sub submlink {
1.242 albertel 3358: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3359: if (!($uname && $udom)) {
3360: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3361: &Apache::lonnet::whichuser($symb);
1.116 albertel 3362: if (!$symb) { $symb=$cursymb; }
3363: }
1.254 matthew 3364: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3365: $symb=&escape($symb);
1.242 albertel 3366: if ($target) { $target="target=\"$target\""; }
3367: return '<a href="/adm/grades?&command=submission&'.
3368: 'symb='.$symb.'&student='.$uname.
3369: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3370: }
3371: ##############################################
3372:
3373: =pod
3374:
3375: =item * &pgrdlink()
3376:
3377: Inputs: $text $uname $udom $symb $target
3378:
3379: Returns: A link to grades.pm such as to see the PGRD view of a student
3380:
3381: =cut
3382:
3383: ###############################################
3384: sub pgrdlink {
3385: my $link=&submlink(@_);
3386: $link=~s/(&command=submission)/$1&showgrading=yes/;
3387: return $link;
3388: }
3389: ##############################################
3390:
3391: =pod
3392:
3393: =item * &pprmlink()
3394:
3395: Inputs: $text $uname $udom $symb $target
3396:
3397: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3398: student and a specific resource
1.242 albertel 3399:
3400: =cut
3401:
3402: ###############################################
3403: sub pprmlink {
3404: my ($text,$uname,$udom,$symb,$target)=@_;
3405: if (!($uname && $udom)) {
3406: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3407: &Apache::lonnet::whichuser($symb);
1.242 albertel 3408: if (!$symb) { $symb=$cursymb; }
3409: }
1.254 matthew 3410: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3411: $symb=&escape($symb);
1.242 albertel 3412: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3413: return '<a href="/adm/parmset?command=set&'.
3414: 'symb='.$symb.'&uname='.$uname.
3415: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3416: }
3417: ##############################################
1.37 matthew 3418:
1.112 bowersj2 3419: =pod
3420:
3421: =back
3422:
3423: =cut
3424:
1.37 matthew 3425: ###############################################
1.51 www 3426:
3427:
3428: sub timehash {
1.687 raeburn 3429: my ($thistime) = @_;
3430: my $timezone = &Apache::lonlocal::gettimezone();
3431: my $dt = DateTime->from_epoch(epoch => $thistime)
3432: ->set_time_zone($timezone);
3433: my $wday = $dt->day_of_week();
3434: if ($wday == 7) { $wday = 0; }
3435: return ( 'second' => $dt->second(),
3436: 'minute' => $dt->minute(),
3437: 'hour' => $dt->hour(),
3438: 'day' => $dt->day_of_month(),
3439: 'month' => $dt->month(),
3440: 'year' => $dt->year(),
3441: 'weekday' => $wday,
3442: 'dayyear' => $dt->day_of_year(),
3443: 'dlsav' => $dt->is_dst() );
1.51 www 3444: }
3445:
1.370 www 3446: sub utc_string {
3447: my ($date)=@_;
1.371 www 3448: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3449: }
3450:
1.51 www 3451: sub maketime {
3452: my %th=@_;
1.687 raeburn 3453: my ($epoch_time,$timezone,$dt);
3454: $timezone = &Apache::lonlocal::gettimezone();
3455: eval {
3456: $dt = DateTime->new( year => $th{'year'},
3457: month => $th{'month'},
3458: day => $th{'day'},
3459: hour => $th{'hour'},
3460: minute => $th{'minute'},
3461: second => $th{'second'},
3462: time_zone => $timezone,
3463: );
3464: };
3465: if (!$@) {
3466: $epoch_time = $dt->epoch;
3467: if ($epoch_time) {
3468: return $epoch_time;
3469: }
3470: }
1.51 www 3471: return POSIX::mktime(
3472: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3473: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3474: }
3475:
3476: #########################################
1.51 www 3477:
3478: sub findallcourses {
1.482 raeburn 3479: my ($roles,$uname,$udom) = @_;
1.355 albertel 3480: my %roles;
3481: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3482: my %courses;
1.51 www 3483: my $now=time;
1.482 raeburn 3484: if (!defined($uname)) {
3485: $uname = $env{'user.name'};
3486: }
3487: if (!defined($udom)) {
3488: $udom = $env{'user.domain'};
3489: }
3490: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3491: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3492: if (!%roles) {
3493: %roles = (
3494: cc => 1,
3495: in => 1,
3496: ep => 1,
3497: ta => 1,
3498: cr => 1,
3499: st => 1,
3500: );
3501: }
3502: foreach my $entry (keys(%roleshash)) {
3503: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3504: if ($trole =~ /^cr/) {
3505: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3506: } else {
3507: next if (!exists($roles{$trole}));
3508: }
3509: if ($tend) {
3510: next if ($tend < $now);
3511: }
3512: if ($tstart) {
3513: next if ($tstart > $now);
3514: }
3515: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3516: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3517: if ($secpart eq '') {
3518: ($cnum,$role) = split(/_/,$cnumpart);
3519: $sec = 'none';
3520: $realsec = '';
3521: } else {
3522: $cnum = $cnumpart;
3523: ($sec,$role) = split(/_/,$secpart);
3524: $realsec = $sec;
1.490 raeburn 3525: }
1.482 raeburn 3526: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3527: }
3528: } else {
3529: foreach my $key (keys(%env)) {
1.483 albertel 3530: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3531: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3532: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3533: next if ($role eq 'ca' || $role eq 'aa');
3534: next if (%roles && !exists($roles{$role}));
3535: my ($starttime,$endtime)=split(/\./,$env{$key});
3536: my $active=1;
3537: if ($starttime) {
3538: if ($now<$starttime) { $active=0; }
3539: }
3540: if ($endtime) {
3541: if ($now>$endtime) { $active=0; }
3542: }
3543: if ($active) {
3544: if ($sec eq '') {
3545: $sec = 'none';
3546: }
3547: $courses{$cdom.'_'.$cnum}{$sec} =
3548: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3549: }
3550: }
1.51 www 3551: }
3552: }
1.474 raeburn 3553: return %courses;
1.51 www 3554: }
1.37 matthew 3555:
1.54 www 3556: ###############################################
1.474 raeburn 3557:
3558: sub blockcheck {
1.482 raeburn 3559: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3560:
3561: if (!defined($udom)) {
3562: $udom = $env{'user.domain'};
3563: }
3564: if (!defined($uname)) {
3565: $uname = $env{'user.name'};
3566: }
3567:
3568: # If uname and udom are for a course, check for blocks in the course.
3569:
3570: if (&Apache::lonnet::is_course($udom,$uname)) {
3571: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3572: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3573: return ($startblock,$endblock);
3574: }
1.474 raeburn 3575:
1.502 raeburn 3576: my $startblock = 0;
3577: my $endblock = 0;
1.482 raeburn 3578: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3579:
1.490 raeburn 3580: # If uname is for a user, and activity is course-specific, i.e.,
3581: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3582:
1.490 raeburn 3583: if (($activity eq 'boards' || $activity eq 'chat' ||
3584: $activity eq 'groups') && ($env{'request.course.id'})) {
3585: foreach my $key (keys(%live_courses)) {
3586: if ($key ne $env{'request.course.id'}) {
3587: delete($live_courses{$key});
3588: }
3589: }
3590: }
3591:
3592: my $otheruser = 0;
3593: my %own_courses;
3594: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3595: # Resource belongs to user other than current user.
3596: $otheruser = 1;
3597: # Gather courses for current user
3598: %own_courses =
3599: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3600: }
3601:
3602: # Gather active course roles - course coordinator, instructor,
3603: # exam proctor, ta, student, or custom role.
1.474 raeburn 3604:
3605: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3606: my ($cdom,$cnum);
3607: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3608: $cdom = $env{'course.'.$course.'.domain'};
3609: $cnum = $env{'course.'.$course.'.num'};
3610: } else {
1.490 raeburn 3611: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3612: }
3613: my $no_ownblock = 0;
3614: my $no_userblock = 0;
1.533 raeburn 3615: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3616: # Check if current user has 'evb' priv for this
3617: if (defined($own_courses{$course})) {
3618: foreach my $sec (keys(%{$own_courses{$course}})) {
3619: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3620: if ($sec ne 'none') {
3621: $checkrole .= '/'.$sec;
3622: }
3623: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3624: $no_ownblock = 1;
3625: last;
3626: }
3627: }
3628: }
3629: # if they have 'evb' priv and are currently not playing student
3630: next if (($no_ownblock) &&
3631: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3632: }
1.474 raeburn 3633: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3634: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3635: if ($sec ne 'none') {
1.482 raeburn 3636: $checkrole .= '/'.$sec;
1.474 raeburn 3637: }
1.490 raeburn 3638: if ($otheruser) {
3639: # Resource belongs to user other than current user.
3640: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3641: my ($trole,$tdom,$tnum,$tsec);
3642: my $entry = $live_courses{$course}{$sec};
3643: if ($entry =~ /^cr/) {
3644: ($trole,$tdom,$tnum,$tsec) =
3645: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3646: } else {
3647: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3648: }
3649: my ($spec,$area,$trest,%allroles,%userroles);
3650: $area = '/'.$tdom.'/'.$tnum;
3651: $trest = $tnum;
3652: if ($tsec ne '') {
3653: $area .= '/'.$tsec;
3654: $trest .= '/'.$tsec;
3655: }
3656: $spec = $trole.'.'.$area;
3657: if ($trole =~ /^cr/) {
3658: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3659: $tdom,$spec,$trest,$area);
3660: } else {
3661: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3662: $tdom,$spec,$trest,$area);
3663: }
3664: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3665: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3666: if ($1) {
3667: $no_userblock = 1;
3668: last;
3669: }
3670: }
1.490 raeburn 3671: } else {
3672: # Resource belongs to current user
3673: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3674: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3675: $no_ownblock = 1;
3676: last;
3677: }
1.474 raeburn 3678: }
3679: }
3680: # if they have the evb priv and are currently not playing student
1.482 raeburn 3681: next if (($no_ownblock) &&
1.491 albertel 3682: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3683: next if ($no_userblock);
1.474 raeburn 3684:
1.490 raeburn 3685: # Retrieve blocking times and identity of blocker for course
3686: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3687:
3688: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3689: if (($start != 0) &&
3690: (($startblock == 0) || ($startblock > $start))) {
3691: $startblock = $start;
3692: }
3693: if (($end != 0) &&
3694: (($endblock == 0) || ($endblock < $end))) {
3695: $endblock = $end;
3696: }
1.490 raeburn 3697: }
3698: return ($startblock,$endblock);
3699: }
3700:
3701: sub get_blocks {
3702: my ($setters,$activity,$cdom,$cnum) = @_;
3703: my $startblock = 0;
3704: my $endblock = 0;
3705: my $course = $cdom.'_'.$cnum;
3706: $setters->{$course} = {};
3707: $setters->{$course}{'staff'} = [];
3708: $setters->{$course}{'times'} = [];
3709: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3710: foreach my $record (keys(%records)) {
3711: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3712: if ($start <= time && $end >= time) {
3713: my ($staff_name,$staff_dom,$title,$blocks) =
3714: &parse_block_record($records{$record});
3715: if ($blocks->{$activity} eq 'on') {
3716: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3717: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3718: if ( ($startblock == 0) || ($startblock > $start) ) {
3719: $startblock = $start;
1.490 raeburn 3720: }
1.491 albertel 3721: if ( ($endblock == 0) || ($endblock < $end) ) {
3722: $endblock = $end;
1.474 raeburn 3723: }
3724: }
3725: }
3726: }
3727: return ($startblock,$endblock);
3728: }
3729:
3730: sub parse_block_record {
3731: my ($record) = @_;
3732: my ($setuname,$setudom,$title,$blocks);
3733: if (ref($record) eq 'HASH') {
3734: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3735: $title = &unescape($record->{'event'});
3736: $blocks = $record->{'blocks'};
3737: } else {
3738: my @data = split(/:/,$record,3);
3739: if (scalar(@data) eq 2) {
3740: $title = $data[1];
3741: ($setuname,$setudom) = split(/@/,$data[0]);
3742: } else {
3743: ($setuname,$setudom,$title) = @data;
3744: }
3745: $blocks = { 'com' => 'on' };
3746: }
3747: return ($setuname,$setudom,$title,$blocks);
3748: }
3749:
3750: sub build_block_table {
3751: my ($startblock,$endblock,$setters) = @_;
3752: my %lt = &Apache::lonlocal::texthash(
3753: 'cacb' => 'Currently active communication blocks',
3754: 'cour' => 'Course',
3755: 'dura' => 'Duration',
3756: 'blse' => 'Block set by'
3757: );
3758: my $output;
1.476 raeburn 3759: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3760: $output .= &start_data_table();
3761: $output .= '
3762: <tr>
3763: <th>'.$lt{'cour'}.'</th>
3764: <th>'.$lt{'dura'}.'</th>
3765: <th>'.$lt{'blse'}.'</th>
3766: </tr>
3767: ';
3768: foreach my $course (keys(%{$setters})) {
3769: my %courseinfo=&Apache::lonnet::coursedescription($course);
3770: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3771: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3772: my $fullname = &plainname($uname,$udom);
3773: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3774: && $env{'user.name'} ne 'public'
3775: && $env{'user.domain'} ne 'public') {
3776: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3777: }
1.474 raeburn 3778: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3779: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3780: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3781: $output .= &Apache::loncommon::start_data_table_row().
3782: '<td>'.$courseinfo{'description'}.'</td>'.
3783: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3784: '<td>'.$fullname.'</td>'.
1.474 raeburn 3785: &Apache::loncommon::end_data_table_row();
3786: }
3787: }
3788: $output .= &end_data_table();
3789: }
3790:
1.490 raeburn 3791: sub blocking_status {
3792: my ($activity,$uname,$udom) = @_;
3793: my %setters;
3794: my ($blocked,$output,$ownitem,$is_course);
3795: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3796: if ($startblock && $endblock) {
3797: $blocked = 1;
3798: if (wantarray) {
3799: my $category;
3800: if ($activity eq 'boards') {
3801: $category = 'Discussion posts in this course';
3802: } elsif ($activity eq 'blogs') {
3803: $category = 'Blogs';
3804: } elsif ($activity eq 'port') {
3805: if (defined($uname) && defined($udom)) {
3806: if ($uname eq $env{'user.name'} &&
3807: $udom eq $env{'user.domain'}) {
3808: $ownitem = 1;
3809: }
3810: }
3811: $is_course = &Apache::lonnet::is_course($udom,$uname);
3812: if ($ownitem) {
3813: $category = 'Your portfolio files';
3814: } elsif ($is_course) {
3815: my $coursedesc;
3816: foreach my $course (keys(%setters)) {
3817: my %courseinfo =
3818: &Apache::lonnet::coursedescription($course);
3819: $coursedesc = $courseinfo{'description'};
3820: }
3821: $category = "Group files in the course '$coursedesc'";
3822: } else {
3823: $category = 'Portfolio files belonging to ';
3824: if ($env{'user.name'} eq 'public' &&
3825: $env{'user.domain'} eq 'public') {
3826: $category .= &plainname($uname,$udom);
3827: } else {
3828: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3829: }
3830: }
3831: } elsif ($activity eq 'groups') {
3832: $category = 'Groups in this course';
3833: }
3834: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3835: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3836: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3837: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3838: $output .= &build_block_table($startblock,$endblock,\%setters);
3839: }
3840: }
3841: }
3842: if (wantarray) {
3843: return ($blocked,$output);
3844: } else {
3845: return $blocked;
3846: }
3847: }
3848:
1.60 matthew 3849: ###############################################
3850:
1.682 raeburn 3851: sub check_ip_acc {
3852: my ($acc)=@_;
3853: &Apache::lonxml::debug("acc is $acc");
3854: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3855: return 1;
3856: }
3857: my $allowed=0;
3858: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3859:
3860: my $name;
3861: foreach my $pattern (split(',',$acc)) {
3862: $pattern =~ s/^\s*//;
3863: $pattern =~ s/\s*$//;
3864: if ($pattern =~ /\*$/) {
3865: #35.8.*
3866: $pattern=~s/\*//;
3867: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3868: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3869: #35.8.3.[34-56]
3870: my $low=$2;
3871: my $high=$3;
3872: $pattern=$1;
3873: if ($ip =~ /^\Q$pattern\E/) {
3874: my $last=(split(/\./,$ip))[3];
3875: if ($last <=$high && $last >=$low) { $allowed=1; }
3876: }
3877: } elsif ($pattern =~ /^\*/) {
3878: #*.msu.edu
3879: $pattern=~s/\*//;
3880: if (!defined($name)) {
3881: use Socket;
3882: my $netaddr=inet_aton($ip);
3883: ($name)=gethostbyaddr($netaddr,AF_INET);
3884: }
3885: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3886: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3887: #127.0.0.1
3888: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3889: } else {
3890: #some.name.com
3891: if (!defined($name)) {
3892: use Socket;
3893: my $netaddr=inet_aton($ip);
3894: ($name)=gethostbyaddr($netaddr,AF_INET);
3895: }
3896: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3897: }
3898: if ($allowed) { last; }
3899: }
3900: return $allowed;
3901: }
3902:
3903: ###############################################
3904:
1.60 matthew 3905: =pod
3906:
1.112 bowersj2 3907: =head1 Domain Template Functions
3908:
3909: =over 4
3910:
3911: =item * &determinedomain()
1.60 matthew 3912:
3913: Inputs: $domain (usually will be undef)
3914:
1.63 www 3915: Returns: Determines which domain should be used for designs
1.60 matthew 3916:
3917: =cut
1.54 www 3918:
1.60 matthew 3919: ###############################################
1.63 www 3920: sub determinedomain {
3921: my $domain=shift;
1.531 albertel 3922: if (! $domain) {
1.60 matthew 3923: # Determine domain if we have not been given one
3924: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3925: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3926: if ($env{'request.role.domain'}) {
3927: $domain=$env{'request.role.domain'};
1.60 matthew 3928: }
3929: }
1.63 www 3930: return $domain;
3931: }
3932: ###############################################
1.517 raeburn 3933:
1.518 albertel 3934: sub devalidate_domconfig_cache {
3935: my ($udom)=@_;
3936: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3937: }
3938:
3939: # ---------------------- Get domain configuration for a domain
3940: sub get_domainconf {
3941: my ($udom) = @_;
3942: my $cachetime=1800;
3943: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3944: if (defined($cached)) { return %{$result}; }
3945:
3946: my %domconfig = &Apache::lonnet::get_dom('configuration',
3947: ['login','rolecolors'],$udom);
1.632 raeburn 3948: my (%designhash,%legacy);
1.518 albertel 3949: if (keys(%domconfig) > 0) {
3950: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3951: if (keys(%{$domconfig{'login'}})) {
3952: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3953: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3954: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3955: $designhash{$udom.'.login.'.$key.'_'.$img} =
3956: $domconfig{'login'}{$key}{$img};
3957: }
3958: } else {
3959: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3960: }
1.632 raeburn 3961: }
3962: } else {
3963: $legacy{'login'} = 1;
1.518 albertel 3964: }
1.632 raeburn 3965: } else {
3966: $legacy{'login'} = 1;
1.518 albertel 3967: }
3968: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3969: if (keys(%{$domconfig{'rolecolors'}})) {
3970: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3971: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3972: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3973: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3974: }
1.518 albertel 3975: }
3976: }
1.632 raeburn 3977: } else {
3978: $legacy{'rolecolors'} = 1;
1.518 albertel 3979: }
1.632 raeburn 3980: } else {
3981: $legacy{'rolecolors'} = 1;
1.518 albertel 3982: }
1.632 raeburn 3983: if (keys(%legacy) > 0) {
3984: my %legacyhash = &get_legacy_domconf($udom);
3985: foreach my $item (keys(%legacyhash)) {
3986: if ($item =~ /^\Q$udom\E\.login/) {
3987: if ($legacy{'login'}) {
3988: $designhash{$item} = $legacyhash{$item};
3989: }
3990: } else {
3991: if ($legacy{'rolecolors'}) {
3992: $designhash{$item} = $legacyhash{$item};
3993: }
1.518 albertel 3994: }
3995: }
3996: }
1.632 raeburn 3997: } else {
3998: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3999: }
4000: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4001: $cachetime);
4002: return %designhash;
4003: }
4004:
1.632 raeburn 4005: sub get_legacy_domconf {
4006: my ($udom) = @_;
4007: my %legacyhash;
4008: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4009: my $designfile = $designdir.'/'.$udom.'.tab';
4010: if (-e $designfile) {
4011: if ( open (my $fh,"<$designfile") ) {
4012: while (my $line = <$fh>) {
4013: next if ($line =~ /^\#/);
4014: chomp($line);
4015: my ($key,$val)=(split(/\=/,$line));
4016: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4017: }
4018: close($fh);
4019: }
4020: }
4021: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4022: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4023: }
4024: return %legacyhash;
4025: }
4026:
1.63 www 4027: =pod
4028:
1.112 bowersj2 4029: =item * &domainlogo()
1.63 www 4030:
4031: Inputs: $domain (usually will be undef)
4032:
4033: Returns: A link to a domain logo, if the domain logo exists.
4034: If the domain logo does not exist, a description of the domain.
4035:
4036: =cut
1.112 bowersj2 4037:
1.63 www 4038: ###############################################
4039: sub domainlogo {
1.517 raeburn 4040: my $domain = &determinedomain(shift);
1.518 albertel 4041: my %designhash = &get_domainconf($domain);
1.517 raeburn 4042: # See if there is a logo
4043: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4044: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4045: if ($imgsrc =~ m{^/(adm|res)/}) {
4046: if ($imgsrc =~ m{^/res/}) {
4047: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4048: &Apache::lonnet::repcopy($local_name);
4049: }
4050: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4051: }
4052: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4053: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4054: return &Apache::lonnet::domain($domain,'description');
1.59 www 4055: } else {
1.60 matthew 4056: return '';
1.59 www 4057: }
4058: }
1.63 www 4059: ##############################################
4060:
4061: =pod
4062:
1.112 bowersj2 4063: =item * &designparm()
1.63 www 4064:
4065: Inputs: $which parameter; $domain (usually will be undef)
4066:
4067: Returns: value of designparamter $which
4068:
4069: =cut
1.112 bowersj2 4070:
1.397 albertel 4071:
1.400 albertel 4072: ##############################################
1.397 albertel 4073: sub designparm {
4074: my ($which,$domain)=@_;
1.258 albertel 4075: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4076: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4077: return '#000000';
4078: }
1.635 raeburn 4079: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4080: return '#FFFFFF';
4081: }
4082: if ($which=~/\.tabbg$/) {
4083: return '#CCCCCC';
4084: }
4085: }
1.397 albertel 4086: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4087: return $env{'environment.color.'.$which};
1.96 www 4088: }
1.63 www 4089: $domain=&determinedomain($domain);
1.518 albertel 4090: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4091: my $output;
1.517 raeburn 4092: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4093: $output = $domdesign{$domain.'.'.$which};
1.63 www 4094: } else {
1.520 raeburn 4095: $output = $defaultdesign{$which};
4096: }
4097: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4098: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4099: if ($output =~ m{^/(adm|res)/}) {
4100: if ($output =~ m{^/res/}) {
4101: my $local_name = &Apache::lonnet::filelocation('',$output);
4102: &Apache::lonnet::repcopy($local_name);
4103: }
1.520 raeburn 4104: $output = &lonhttpdurl($output);
4105: }
1.63 www 4106: }
1.520 raeburn 4107: return $output;
1.63 www 4108: }
1.59 www 4109:
1.60 matthew 4110: ###############################################
4111: ###############################################
4112:
4113: =pod
4114:
1.112 bowersj2 4115: =back
4116:
1.549 albertel 4117: =head1 HTML Helpers
1.112 bowersj2 4118:
4119: =over 4
4120:
4121: =item * &bodytag()
1.60 matthew 4122:
4123: Returns a uniform header for LON-CAPA web pages.
4124:
4125: Inputs:
4126:
1.112 bowersj2 4127: =over 4
4128:
4129: =item * $title, A title to be displayed on the page.
4130:
4131: =item * $function, the current role (can be undef).
4132:
4133: =item * $addentries, extra parameters for the <body> tag.
4134:
4135: =item * $bodyonly, if defined, only return the <body> tag.
4136:
4137: =item * $domain, if defined, force a given domain.
4138:
4139: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4140: text interface only)
1.60 matthew 4141:
1.326 albertel 4142: =item * $customtitle, alternate text to use instead of $title
4143: in the title box that appears, this text
4144: is not auto translated like the $title is
1.309 albertel 4145:
4146: =item * $notopbar, if true, keep the 'what is this' info but remove the
4147: navigational links
1.317 albertel 4148:
1.338 albertel 4149: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4150:
4151: =item * $notitle, if true keep the nav controls, but remove the title bar
4152:
1.361 albertel 4153: =item * $no_inline_link, if true and in remote mode, don't show the
4154: 'Switch To Inline Menu' link
4155:
1.460 albertel 4156: =item * $args, optional argument valid values are
4157: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4158: inherit_jsmath -> when creating popup window in a page,
4159: should it have jsmath forced on by the
4160: current page
1.460 albertel 4161:
1.112 bowersj2 4162: =back
4163:
1.60 matthew 4164: Returns: A uniform header for LON-CAPA web pages.
4165: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4166: If $bodyonly is undef or zero, an html string containing a <body> tag and
4167: other decorations will be returned.
4168:
4169: =cut
4170:
1.54 www 4171: sub bodytag {
1.309 albertel 4172: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4173: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4174:
1.460 albertel 4175: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4176:
1.183 matthew 4177: $function = &get_users_function() if (!$function);
1.339 albertel 4178: my $img = &designparm($function.'.img',$domain);
4179: my $font = &designparm($function.'.font',$domain);
4180: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4181:
4182: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4183: 'bgcolor' => $pgbg,
1.339 albertel 4184: 'text' => $font,
4185: 'alink' => &designparm($function.'.alink',$domain),
4186: 'vlink' => &designparm($function.'.vlink',$domain),
4187: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4188: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4189:
1.63 www 4190: # role and realm
1.378 raeburn 4191: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4192: if ($role eq 'ca') {
1.479 albertel 4193: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4194: $realm = &plainname($rname,$rdom);
1.378 raeburn 4195: }
1.55 www 4196: # realm
1.258 albertel 4197: if ($env{'request.course.id'}) {
1.378 raeburn 4198: if ($env{'request.role'} !~ /^cr/) {
4199: $role = &Apache::lonnet::plaintext($role,&course_type());
4200: }
1.359 albertel 4201: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4202: } else {
4203: $role = &Apache::lonnet::plaintext($role);
1.54 www 4204: }
1.433 albertel 4205:
1.359 albertel 4206: if (!$realm) { $realm=' '; }
1.55 www 4207: # Set messages
1.60 matthew 4208: my $messages=&domainlogo($domain);
1.330 albertel 4209:
1.438 albertel 4210: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4211:
1.101 www 4212: # construct main body tag
1.359 albertel 4213: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4214: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4215:
1.530 albertel 4216: if ($bodyonly) {
1.60 matthew 4217: return $bodytag;
1.258 albertel 4218: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4219: # Accessibility
1.224 raeburn 4220:
1.337 albertel 4221: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4222: if (!$notitle) {
1.337 albertel 4223: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4224: }
4225: return $bodytag;
1.359 albertel 4226: }
4227:
1.410 albertel 4228: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4229: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4230: undef($role);
1.434 albertel 4231: } else {
4232: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4233: }
1.359 albertel 4234:
4235: my $roleinfo=(<<ENDROLE);
4236: <td class="LC_title_bar_who">
4237: <div class="LC_title_bar_name">
1.410 albertel 4238: $name
1.361 albertel 4239:
1.359 albertel 4240: </div>
4241: <div class="LC_title_bar_role">
1.361 albertel 4242: $role
1.359 albertel 4243: </div>
4244: <div class="LC_title_bar_realm">
1.361 albertel 4245: $realm
1.359 albertel 4246: </div>
1.206 albertel 4247: </td>
4248: ENDROLE
1.235 raeburn 4249:
1.359 albertel 4250: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4251: if ($customtitle) {
4252: $titleinfo = $customtitle;
4253: }
4254: #
4255: # Extra info if you are the DC
4256: my $dc_info = '';
4257: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4258: $env{'course.'.$env{'request.course.id'}.
4259: '.domain'}.'/'})) {
4260: my $cid = $env{'request.course.id'};
4261: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4262: $dc_info =~ s/\s+$//;
1.359 albertel 4263: $dc_info = '('.$dc_info.')';
4264: }
4265:
1.644 www 4266: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4267: # No Remote
1.258 albertel 4268: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4269: $forcereg=1;
4270: }
4271:
4272: if (!$customtitle && $env{'request.state'} eq 'construct') {
4273: # this is for resources; directories have customtitle, and crumbs
4274: # and select recent are created in lonpubdir.pm
1.229 albertel 4275: my ($uname,$thisdisfn)=
1.258 albertel 4276: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4277: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4278: $formaction=~s/\/+/\//g;
4279:
1.359 albertel 4280: my $parentpath = '';
4281: my $lastitem = '';
4282: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4283: $parentpath = $1;
4284: $lastitem = $2;
4285: } else {
4286: $lastitem = $thisdisfn;
4287: }
4288: $titleinfo =
1.640 bisitz 4289: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4290: .'<b>'.&mt('Construction Space').'</b>: '
4291: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4292: .'" target="_top"><tt><b>'
1.705 tempelho 4293: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4294: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4295: .'</form>'
4296: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4297: }
1.359 albertel 4298:
1.337 albertel 4299: my $titletable;
1.338 albertel 4300: if (!$notitle) {
1.337 albertel 4301: $titletable =
1.359 albertel 4302: '<table id="LC_title_bar">'.
4303: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4304: '</tr></table>';
1.337 albertel 4305: }
1.359 albertel 4306: if ($notopbar) {
4307: $bodytag .= $titletable;
4308: } else {
4309: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4310: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4311: $titletable);
1.272 raeburn 4312: } else {
1.336 albertel 4313: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4314: $titletable;
1.272 raeburn 4315: }
1.235 raeburn 4316: }
4317: return $bodytag;
1.94 www 4318: }
1.95 www 4319:
1.93 www 4320: #
1.95 www 4321: # Top frame rendering, Remote is up
1.93 www 4322: #
1.359 albertel 4323:
1.517 raeburn 4324: my $imgsrc = $img;
4325: if ($img =~ /^\/adm/) {
1.575 albertel 4326: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4327: }
4328: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4329:
1.305 www 4330: # Explicit link to get inline menu
1.361 albertel 4331: my $menu= ($no_inline_link?''
4332: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4333: #
1.338 albertel 4334: if ($notitle) {
1.337 albertel 4335: return $bodytag;
4336: }
1.94 www 4337: return(<<ENDBODY);
1.60 matthew 4338: $bodytag
1.359 albertel 4339: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4340: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4341: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4342: </tr>
1.359 albertel 4343: <tr><td>$titleinfo $dc_info $menu</td>
4344: $roleinfo
1.368 albertel 4345: </tr>
1.356 albertel 4346: </table>
1.54 www 4347: ENDBODY
1.182 matthew 4348: }
4349:
1.330 albertel 4350: sub make_attr_string {
4351: my ($register,$attr_ref) = @_;
4352:
4353: if ($attr_ref && !ref($attr_ref)) {
4354: die("addentries Must be a hash ref ".
4355: join(':',caller(1))." ".
4356: join(':',caller(0))." ");
4357: }
4358:
4359: if ($register) {
1.339 albertel 4360: my ($on_load,$on_unload);
4361: foreach my $key (keys(%{$attr_ref})) {
4362: if (lc($key) eq 'onload') {
4363: $on_load.=$attr_ref->{$key}.';';
4364: delete($attr_ref->{$key});
4365:
4366: } elsif (lc($key) eq 'onunload') {
4367: $on_unload.=$attr_ref->{$key}.';';
4368: delete($attr_ref->{$key});
4369: }
4370: }
4371: $attr_ref->{'onload'} =
4372: &Apache::lonmenu::loadevents(). $on_load;
4373: $attr_ref->{'onunload'}=
4374: &Apache::lonmenu::unloadevents().$on_unload;
4375: }
4376:
4377: # Accessibility font enhance
4378: if ($env{'browser.fontenhance'} eq 'on') {
4379: my $style;
4380: foreach my $key (keys(%{$attr_ref})) {
4381: if (lc($key) eq 'style') {
4382: $style.=$attr_ref->{$key}.';';
4383: delete($attr_ref->{$key});
4384: }
4385: }
4386: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4387: }
1.339 albertel 4388:
4389: if ($env{'browser.blackwhite'} eq 'on') {
4390: delete($attr_ref->{'font'});
4391: delete($attr_ref->{'link'});
4392: delete($attr_ref->{'alink'});
4393: delete($attr_ref->{'vlink'});
4394: delete($attr_ref->{'bgcolor'});
4395: delete($attr_ref->{'background'});
4396: }
4397:
1.330 albertel 4398: my $attr_string;
4399: foreach my $attr (keys(%$attr_ref)) {
4400: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4401: }
4402: return $attr_string;
4403: }
4404:
4405:
1.182 matthew 4406: ###############################################
1.251 albertel 4407: ###############################################
4408:
4409: =pod
4410:
4411: =item * &endbodytag()
4412:
4413: Returns a uniform footer for LON-CAPA web pages.
4414:
1.635 raeburn 4415: Inputs: 1 - optional reference to an args hash
4416: If in the hash, key for noredirectlink has a value which evaluates to true,
4417: a 'Continue' link is not displayed if the page contains an
4418: internal redirect in the <head></head> section,
4419: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4420:
4421: =cut
4422:
4423: sub endbodytag {
1.635 raeburn 4424: my ($args) = @_;
1.251 albertel 4425: my $endbodytag='</body>';
1.269 albertel 4426: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4427: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4428: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4429: $endbodytag=
4430: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4431: &mt('Continue').'</a>'.
4432: $endbodytag;
4433: }
1.315 albertel 4434: }
1.251 albertel 4435: return $endbodytag;
4436: }
4437:
1.352 albertel 4438: =pod
4439:
4440: =item * &standard_css()
4441:
4442: Returns a style sheet
4443:
4444: Inputs: (all optional)
4445: domain -> force to color decorate a page for a specific
4446: domain
4447: function -> force usage of a specific rolish color scheme
4448: bgcolor -> override the default page bgcolor
4449:
4450: =cut
4451:
1.343 albertel 4452: sub standard_css {
1.345 albertel 4453: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4454: $function = &get_users_function() if (!$function);
4455: my $img = &designparm($function.'.img', $domain);
4456: my $tabbg = &designparm($function.'.tabbg', $domain);
4457: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4458: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4459: my $pgbg_or_bgcolor =
4460: $bgcolor ||
1.352 albertel 4461: &designparm($function.'.pgbg', $domain);
1.382 albertel 4462: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4463: my $alink = &designparm($function.'.alink', $domain);
4464: my $vlink = &designparm($function.'.vlink', $domain);
4465: my $link = &designparm($function.'.link', $domain);
4466:
1.704 muellerd 4467: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4468: my $bgcol = &designparm('login.bgcol',$domain);
4469: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4470:
1.602 albertel 4471: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4472: my $mono = 'monospace';
1.352 albertel 4473: my $data_table_head = $tabbg;
4474: my $data_table_light = '#EEEEEE';
1.470 banghart 4475: my $data_table_dark = '#DDDDDD';
4476: my $data_table_darker = '#CCCCCC';
1.349 albertel 4477: my $data_table_highlight = '#FFFF00';
1.352 albertel 4478: my $mail_new = '#FFBB77';
4479: my $mail_new_hover = '#DD9955';
4480: my $mail_read = '#BBBB77';
4481: my $mail_read_hover = '#999944';
4482: my $mail_replied = '#AAAA88';
4483: my $mail_replied_hover = '#888855';
4484: my $mail_other = '#99BBBB';
4485: my $mail_other_hover = '#669999';
1.391 albertel 4486: my $table_header = '#DDDDDD';
1.489 raeburn 4487: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4488: my $lg_border_color = '#C8C8C8';
1.392 albertel 4489:
1.608 albertel 4490: my $border = ($env{'browser.type'} eq 'explorer' ||
4491: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4492: : '0px 3px 0px 4px';
1.448 albertel 4493:
1.523 albertel 4494:
1.343 albertel 4495: return <<END;
1.698 harmsja 4496: body{
4497: font-family: $sans;
4498: line-height:130%;
1.701 harmsja 4499: font-size:0.83em;
1.698 harmsja 4500: color:$font;
4501: }
1.701 harmsja 4502: a:link, a:visited { font-size:100%; }
1.698 harmsja 4503:
1.343 albertel 4504: a:focus { color: red; background: yellow }
1.510 albertel 4505: table.thinborder,
4506: table.thinborder tr th {
4507: border-style: solid;
4508: border-width: 1px;
1.698 harmsja 4509: border-color: $lg_border_color;
1.510 albertel 4510: background: $tabbg;
4511: }
1.523 albertel 4512: table.thinborder tr td {
1.510 albertel 4513: border-style: solid;
1.698 harmsja 4514: border-width: 1px;
4515: border-color: $lg_border_color;
1.510 albertel 4516: }
1.426 albertel 4517:
1.343 albertel 4518: form, .inline { display: inline; }
1.721 harmsja 4519:
4520: .LC_center { text-align: center; }
4521: .LC_left { text-align:left; }
4522: .LC_right {text-align:right;}
4523: .LC_middle {vertical-align:middle;}
4524: .LC_top {vertical-align:top;}
4525: .LC_bottom {vertical-align:bottom;}
4526:
4527: /* just for tests */
4528: .LC_300Box { width:300px; }
4529: .LC_200Box {width:200px; }
4530: .LC_500Box {width:500px; }
4531: .LC_600Box {width:600px; }
1.741 harmsja 4532: .LC_800Box {width:800px;}
1.721 harmsja 4533: /* end */
4534:
1.593 albertel 4535: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4536: .LC_error {
4537: color: red;
4538: font-size: larger;
4539: }
1.457 albertel 4540: .LC_warning,
4541: .LC_diff_removed {
1.733 bisitz 4542: color: red;
1.394 albertel 4543: }
1.532 albertel 4544:
4545: .LC_info,
1.457 albertel 4546: .LC_success,
4547: .LC_diff_added {
1.350 albertel 4548: color: green;
4549: }
1.543 albertel 4550: .LC_unknown {
4551: color: yellow;
4552: }
4553:
1.440 albertel 4554: .LC_icon {
4555: border: 0px;
4556: }
1.539 albertel 4557: .LC_indexer_icon {
4558: border: 0px;
4559: height: 22px;
4560: }
1.543 albertel 4561: .LC_docs_spacer {
4562: width: 25px;
4563: height: 1px;
4564: border: 0px;
4565: }
1.346 albertel 4566:
1.532 albertel 4567: .LC_internal_info {
1.735 bisitz 4568: color: #999999;
1.532 albertel 4569: }
4570:
1.458 albertel 4571: table.LC_pastsubmission {
4572: border: 1px solid black;
4573: margin: 2px;
4574: }
4575:
1.606 albertel 4576: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4577: width: 100%;
4578: background: $pgbg;
1.392 albertel 4579: border: 2px;
1.402 albertel 4580: border-collapse: separate;
1.403 albertel 4581: padding: 0px;
1.345 albertel 4582: }
1.392 albertel 4583:
1.606 albertel 4584: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4585: table#LC_title_bar.LC_with_remote {
1.359 albertel 4586: width: 100%;
1.392 albertel 4587: border-color: $pgbg;
4588: border-style: solid;
4589: border-width: $border;
4590:
1.379 albertel 4591: background: $pgbg;
4592: font-family: $sans;
1.392 albertel 4593: border-collapse: collapse;
1.403 albertel 4594: padding: 0px;
1.359 albertel 4595: }
1.409 albertel 4596: table.LC_docs_path {
4597: width: 100%;
4598: border: 0;
4599: background: $pgbg;
4600: font-family: $sans;
4601: border-collapse: collapse;
4602: padding: 0px;
4603: }
4604:
1.359 albertel 4605: table#LC_title_bar td {
4606: background: $tabbg;
4607: }
4608: table#LC_title_bar td.LC_title_bar_who {
4609: background: $tabbg;
4610: color: $font;
1.427 albertel 4611: font: small $sans;
1.359 albertel 4612: text-align: right;
4613: }
1.469 banghart 4614: span.LC_metadata {
4615: font-family: $sans;
4616: }
1.359 albertel 4617: span.LC_title_bar_title {
1.416 albertel 4618: font: bold x-large $sans;
1.359 albertel 4619: }
4620: table#LC_title_bar td.LC_title_bar_domain_logo {
4621: background: $sidebg;
4622: text-align: right;
1.368 albertel 4623: padding: 0px;
4624: }
4625: table#LC_title_bar td.LC_title_bar_role_logo {
4626: background: $sidebg;
4627: padding: 0px;
1.359 albertel 4628: }
4629:
1.706 harmsja 4630: table#LC_menubuttons img{
1.346 albertel 4631: border: 0px;
4632: }
1.345 albertel 4633: table#LC_top_nav td {
4634: background: $tabbg;
1.392 albertel 4635: border: 0px;
1.407 albertel 4636: font-size: small;
1.706 harmsja 4637: vertical-align:top;
4638: padding:2px 5px 2px 5px;
1.345 albertel 4639: }
4640: table#LC_top_nav td a, div#LC_top_nav a {
4641: color: $font;
4642: font-family: $sans;
4643: }
1.364 albertel 4644: table#LC_top_nav td.LC_top_nav_logo {
4645: background: $tabbg;
1.432 albertel 4646: text-align: left;
1.408 albertel 4647: white-space: nowrap;
1.432 albertel 4648: width: 31px;
1.408 albertel 4649: }
4650: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4651: border: 0px;
1.408 albertel 4652: vertical-align: bottom;
1.364 albertel 4653: }
1.432 albertel 4654: table#LC_top_nav td.LC_top_nav_exit,
4655: table#LC_top_nav td.LC_top_nav_help {
4656: width: 2.0em;
4657: }
1.442 albertel 4658: table#LC_top_nav td.LC_top_nav_login {
4659: width: 4.0em;
4660: text-align: center;
4661: }
1.409 albertel 4662: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4663: background: $tabbg;
4664: color: $font;
4665: font-family: $sans;
1.358 albertel 4666: font-size: smaller;
1.357 albertel 4667: }
1.411 albertel 4668: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4669: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4670: background: $tabbg;
4671: color: $font;
4672: font-family: $sans;
4673: font-size: larger;
4674: text-align: right;
4675: }
1.383 albertel 4676: td.LC_table_cell_checkbox {
4677: text-align: center;
4678: }
1.522 albertel 4679: table#LC_mainmenu td.LC_mainmenu_column {
4680: vertical-align: top;
4681: }
4682:
1.705 tempelho 4683: .LC_fontsize_small
4684: {
4685: font-size: 70%;
4686: }
4687:
4688: .LC_fontsize_medium
4689: {
4690: font-size: 85%;
4691: }
4692:
4693: .LC_fontsize_large
4694: {
4695: font-size: 120%;
4696: }
4697:
4698: .LC_fontcolor_red
4699: {
4700: color: #FF0000;
4701: }
4702:
1.346 albertel 4703: .LC_menubuttons_inline_text {
4704: color: $font;
4705: font-family: $sans;
1.698 harmsja 4706: font-size: 90%;
1.701 harmsja 4707: padding-left:3px;
1.346 albertel 4708: }
4709:
1.526 www 4710: .LC_menubuttons_link {
4711: text-decoration: none;
4712: }
1.698 harmsja 4713: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4714: .LC_menubuttons_category {
1.521 www 4715: color: $font;
1.526 www 4716: background: $pgbg;
1.521 www 4717: font-family: $sans;
4718: font-size: larger;
4719: font-weight: bold;
4720: }
4721:
1.346 albertel 4722: td.LC_menubuttons_text {
1.701 harmsja 4723: color: $font;
1.346 albertel 4724: }
1.706 harmsja 4725:
4726:
1.526 www 4727:
1.346 albertel 4728: .LC_current_location {
4729: font-family: $sans;
4730: background: $tabbg;
4731: }
4732: .LC_new_mail {
4733: font-family: $sans;
1.634 www 4734: background: $tabbg;
1.346 albertel 4735: font-weight: bold;
4736: }
1.347 albertel 4737:
1.526 www 4738:
1.527 www 4739: .LC_dropadd_labeltext {
4740: font-family: $sans;
4741: text-align: right;
4742: }
4743:
4744: .LC_preferences_labeltext {
4745: font-family: $sans;
4746: text-align: right;
4747: }
4748:
1.666 raeburn 4749: .LC_roleslog_note {
1.701 harmsja 4750: font-size: small;
1.666 raeburn 4751: }
4752:
1.715 raeburn 4753: .LC_mail_functions {
4754: font-weight: bold;
4755: }
4756:
1.440 albertel 4757: table.LC_aboutme_port {
4758: border: 0px;
4759: border-collapse: collapse;
4760: border-spacing: 0px;
4761: }
1.349 albertel 4762: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4763: border: 1px solid #000000;
1.402 albertel 4764: border-collapse: separate;
1.426 albertel 4765: border-spacing: 1px;
1.610 albertel 4766: background: $pgbg;
1.347 albertel 4767: }
1.422 albertel 4768: .LC_data_table_dense {
4769: font-size: small;
4770: }
1.507 raeburn 4771: table.LC_nested_outer {
4772: border: 1px solid #000000;
1.589 raeburn 4773: border-collapse: collapse;
1.507 raeburn 4774: border-spacing: 0px;
4775: width: 100%;
4776: }
4777: table.LC_nested {
4778: border: 0px;
1.589 raeburn 4779: border-collapse: collapse;
1.507 raeburn 4780: border-spacing: 0px;
4781: width: 100%;
4782: }
1.523 albertel 4783: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4784: table.LC_prior_tries tr th {
1.349 albertel 4785: font-weight: bold;
4786: background-color: $data_table_head;
1.701 harmsja 4787: font-size:90%;
1.347 albertel 4788: }
1.711 raeburn 4789: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4790: background-color: #CCCCCC;
1.711 raeburn 4791: font-weight: bold;
4792: text-align: left;
4793: }
1.610 albertel 4794: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4795: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4796: table.LC_aboutme_port tr td {
1.349 albertel 4797: background-color: $data_table_light;
1.425 albertel 4798: padding: 2px;
1.347 albertel 4799: }
1.610 albertel 4800: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4801: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4802: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4803: background-color: $data_table_dark;
1.709 bisitz 4804: padding: 2px;
1.347 albertel 4805: }
1.425 albertel 4806: table.LC_data_table tr.LC_data_table_highlight td {
4807: background-color: $data_table_darker;
4808: }
1.639 raeburn 4809: table.LC_data_table tr td.LC_leftcol_header {
4810: background-color: $data_table_head;
4811: font-weight: bold;
4812: }
1.451 albertel 4813: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4814: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4815: background-color: #FFFFFF;
1.421 albertel 4816: font-weight: bold;
4817: font-style: italic;
4818: text-align: center;
4819: padding: 8px;
1.347 albertel 4820: }
1.507 raeburn 4821: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4822: padding: 4ex
4823: }
1.507 raeburn 4824: table.LC_nested_outer tr th {
4825: font-weight: bold;
4826: background-color: $data_table_head;
1.701 harmsja 4827: font-size: small;
1.507 raeburn 4828: border-bottom: 1px solid #000000;
4829: }
4830: table.LC_nested_outer tr td.LC_subheader {
4831: background-color: $data_table_head;
4832: font-weight: bold;
4833: font-size: small;
4834: border-bottom: 1px solid #000000;
4835: text-align: right;
1.451 albertel 4836: }
1.507 raeburn 4837: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4838: background-color: #CCCCCC;
1.451 albertel 4839: font-weight: bold;
4840: font-size: small;
1.507 raeburn 4841: text-align: center;
4842: }
1.589 raeburn 4843: table.LC_nested tr.LC_info_row td.LC_left_item,
4844: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4845: text-align: left;
1.451 albertel 4846: }
1.507 raeburn 4847: table.LC_nested td {
1.735 bisitz 4848: background-color: #FFFFFF;
1.451 albertel 4849: font-size: small;
1.507 raeburn 4850: }
4851: table.LC_nested_outer tr th.LC_right_item,
4852: table.LC_nested tr.LC_info_row td.LC_right_item,
4853: table.LC_nested tr.LC_odd_row td.LC_right_item,
4854: table.LC_nested tr td.LC_right_item {
1.451 albertel 4855: text-align: right;
4856: }
4857:
1.507 raeburn 4858: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4859: background-color: #EEEEEE;
1.451 albertel 4860: }
4861:
1.473 raeburn 4862: table.LC_createuser {
4863: }
4864:
4865: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4866: font-size: small;
1.473 raeburn 4867: }
4868:
4869: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 4870: background-color: #CCCCCC;
1.473 raeburn 4871: font-weight: bold;
4872: text-align: center;
4873: }
4874:
1.349 albertel 4875: table.LC_calendar {
4876: border: 1px solid #000000;
4877: border-collapse: collapse;
4878: }
4879: table.LC_calendar_pickdate {
4880: font-size: xx-small;
4881: }
4882: table.LC_calendar tr td {
4883: border: 1px solid #000000;
4884: vertical-align: top;
4885: }
4886: table.LC_calendar tr td.LC_calendar_day_empty {
4887: background-color: $data_table_dark;
4888: }
4889: table.LC_calendar tr td.LC_calendar_day_current {
4890: background-color: $data_table_highlight;
4891: }
4892:
4893: table.LC_mail_list tr.LC_mail_new {
4894: background-color: $mail_new;
4895: }
4896: table.LC_mail_list tr.LC_mail_new:hover {
4897: background-color: $mail_new_hover;
4898: }
4899: table.LC_mail_list tr.LC_mail_read {
4900: background-color: $mail_read;
4901: }
4902: table.LC_mail_list tr.LC_mail_read:hover {
4903: background-color: $mail_read_hover;
4904: }
4905: table.LC_mail_list tr.LC_mail_replied {
4906: background-color: $mail_replied;
4907: }
4908: table.LC_mail_list tr.LC_mail_replied:hover {
4909: background-color: $mail_replied_hover;
4910: }
4911: table.LC_mail_list tr.LC_mail_other {
4912: background-color: $mail_other;
4913: }
4914: table.LC_mail_list tr.LC_mail_other:hover {
4915: background-color: $mail_other_hover;
4916: }
1.494 raeburn 4917: table.LC_mail_list tr.LC_mail_even {
4918: }
4919: table.LC_mail_list tr.LC_mail_odd {
4920: }
4921:
1.696 bisitz 4922: table.LC_data_table tr > td.LC_browser_file,
4923: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4924: background: #CCFF88;
4925: }
1.696 bisitz 4926: table.LC_data_table tr > td.LC_browser_file_locked,
4927: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4928: background: #FFAA99;
1.387 albertel 4929: }
1.696 bisitz 4930: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4931: background: #AAAAAA;
1.387 albertel 4932: }
1.696 bisitz 4933: table.LC_data_table tr > td.LC_browser_file_modified,
4934: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4935: background: #FFFF77;
1.387 albertel 4936: }
1.696 bisitz 4937: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4938: background: #CCCCFF;
1.387 albertel 4939: }
1.696 bisitz 4940:
1.707 bisitz 4941: table.LC_data_table tr > td.LC_roles_is {
4942: /* background: #77FF77; */
4943: }
4944: table.LC_data_table tr > td.LC_roles_future {
4945: background: #FFFF77;
4946: }
4947: table.LC_data_table tr > td.LC_roles_will {
4948: background: #FFAA77;
4949: }
4950: table.LC_data_table tr > td.LC_roles_expired {
4951: background: #FF7777;
4952: }
4953: table.LC_data_table tr > td.LC_roles_will_not {
4954: background: #AAFF77;
4955: }
4956: table.LC_data_table tr > td.LC_roles_selected {
4957: background: #11CC55;
4958: }
4959:
1.388 albertel 4960: span.LC_current_location {
1.701 harmsja 4961: font-size:larger;
1.388 albertel 4962: background: $pgbg;
4963: }
1.387 albertel 4964:
1.395 albertel 4965: span.LC_parm_menu_item {
4966: font-size: larger;
4967: font-family: $sans;
4968: }
4969: span.LC_parm_scope_all {
4970: color: red;
4971: }
4972: span.LC_parm_scope_folder {
4973: color: green;
4974: }
4975: span.LC_parm_scope_resource {
4976: color: orange;
4977: }
4978: span.LC_parm_part {
4979: color: blue;
4980: }
4981: span.LC_parm_folder, span.LC_parm_symb {
4982: font-size: x-small;
4983: font-family: $mono;
4984: color: #AAAAAA;
4985: }
4986:
1.396 albertel 4987: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4988: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4989: border: 1px solid black;
4990: border-collapse: collapse;
4991: }
4992: table.LC_parm_overview_restrictions td {
4993: border-width: 1px 4px 1px 4px;
4994: border-style: solid;
4995: border-color: $pgbg;
4996: text-align: center;
4997: }
4998: table.LC_parm_overview_restrictions th {
4999: background: $tabbg;
5000: border-width: 1px 4px 1px 4px;
5001: border-style: solid;
5002: border-color: $pgbg;
5003: }
1.398 albertel 5004: table#LC_helpmenu {
5005: border: 0px;
5006: height: 55px;
5007: border-spacing: 0px;
5008: }
5009:
5010: table#LC_helpmenu fieldset legend {
5011: font-size: larger;
5012: font-weight: bold;
5013: }
1.397 albertel 5014: table#LC_helpmenu_links {
5015: width: 100%;
5016: border: 1px solid black;
5017: background: $pgbg;
5018: padding: 0px;
5019: border-spacing: 1px;
5020: }
5021: table#LC_helpmenu_links tr td {
5022: padding: 1px;
5023: background: $tabbg;
1.399 albertel 5024: text-align: center;
5025: font-weight: bold;
1.397 albertel 5026: }
1.396 albertel 5027:
1.397 albertel 5028: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5029: table#LC_helpmenu_links a:active {
5030: text-decoration: none;
5031: color: $font;
5032: }
5033: table#LC_helpmenu_links a:hover {
5034: text-decoration: underline;
5035: color: $vlink;
5036: }
1.396 albertel 5037:
1.417 albertel 5038: .LC_chrt_popup_exists {
5039: border: 1px solid #339933;
5040: margin: -1px;
5041: }
5042: .LC_chrt_popup_up {
5043: border: 1px solid yellow;
5044: margin: -1px;
5045: }
5046: .LC_chrt_popup {
5047: border: 1px solid #8888FF;
5048: background: #CCCCFF;
5049: }
1.421 albertel 5050: table.LC_pick_box {
5051: border-collapse: separate;
5052: background: white;
5053: border: 1px solid black;
5054: border-spacing: 1px;
5055: }
5056: table.LC_pick_box td.LC_pick_box_title {
5057: background: $tabbg;
5058: font-weight: bold;
5059: text-align: right;
1.740 bisitz 5060: vertical-align: top;
1.421 albertel 5061: width: 184px;
5062: padding: 8px;
5063: }
1.645 raeburn 5064: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5065: background: $tabbg;
5066: font-weight: bold;
5067: text-align: right;
5068: width: 350px;
5069: padding: 8px;
5070: }
5071:
1.579 raeburn 5072: table.LC_pick_box td.LC_pick_box_value {
5073: text-align: left;
5074: padding: 8px;
5075: }
5076: table.LC_pick_box td.LC_pick_box_select {
5077: text-align: left;
5078: padding: 8px;
5079: }
1.424 albertel 5080: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5081: padding: 0px;
5082: height: 1px;
5083: background: black;
5084: }
5085: table.LC_pick_box td.LC_pick_box_submit {
5086: text-align: right;
5087: }
1.579 raeburn 5088: table.LC_pick_box td.LC_evenrow_value {
5089: text-align: left;
5090: padding: 8px;
5091: background-color: $data_table_light;
5092: }
5093: table.LC_pick_box td.LC_oddrow_value {
5094: text-align: left;
5095: padding: 8px;
5096: background-color: $data_table_light;
5097: }
5098: table.LC_helpform_receipt {
5099: width: 620px;
5100: border-collapse: separate;
5101: background: white;
5102: border: 1px solid black;
5103: border-spacing: 1px;
5104: }
5105: table.LC_helpform_receipt td.LC_pick_box_title {
5106: background: $tabbg;
5107: font-weight: bold;
5108: text-align: right;
5109: width: 184px;
5110: padding: 8px;
5111: }
5112: table.LC_helpform_receipt td.LC_evenrow_value {
5113: text-align: left;
5114: padding: 8px;
5115: background-color: $data_table_light;
5116: }
5117: table.LC_helpform_receipt td.LC_oddrow_value {
5118: text-align: left;
5119: padding: 8px;
5120: background-color: $data_table_light;
5121: }
5122: table.LC_helpform_receipt td.LC_pick_box_separator {
5123: padding: 0px;
5124: height: 1px;
5125: background: black;
5126: }
5127: span.LC_helpform_receipt_cat {
5128: font-weight: bold;
5129: }
1.424 albertel 5130: table.LC_group_priv_box {
5131: background: white;
5132: border: 1px solid black;
5133: border-spacing: 1px;
5134: }
5135: table.LC_group_priv_box td.LC_pick_box_title {
5136: background: $tabbg;
5137: font-weight: bold;
5138: text-align: right;
5139: width: 184px;
5140: }
5141: table.LC_group_priv_box td.LC_groups_fixed {
5142: background: $data_table_light;
5143: text-align: center;
5144: }
5145: table.LC_group_priv_box td.LC_groups_optional {
5146: background: $data_table_dark;
5147: text-align: center;
5148: }
5149: table.LC_group_priv_box td.LC_groups_functionality {
5150: background: $data_table_darker;
5151: text-align: center;
5152: font-weight: bold;
5153: }
5154: table.LC_group_priv td {
5155: text-align: left;
5156: padding: 0px;
5157: }
5158:
1.421 albertel 5159: table.LC_notify_front_page {
5160: background: white;
5161: border: 1px solid black;
5162: padding: 8px;
5163: }
5164: table.LC_notify_front_page td {
5165: padding: 8px;
5166: }
1.424 albertel 5167: .LC_navbuttons {
5168: margin: 2ex 0ex 2ex 0ex;
5169: }
1.423 albertel 5170: .LC_topic_bar {
5171: font-family: $sans;
5172: font-weight: bold;
5173: width: 100%;
5174: background: $tabbg;
5175: vertical-align: middle;
5176: margin: 2ex 0ex 2ex 0ex;
5177: }
5178: .LC_topic_bar span {
5179: vertical-align: middle;
5180: }
5181: .LC_topic_bar img {
5182: vertical-align: bottom;
5183: }
5184: table.LC_course_group_status {
5185: margin: 20px;
5186: }
5187: table.LC_status_selector td {
5188: vertical-align: top;
5189: text-align: center;
1.424 albertel 5190: padding: 4px;
5191: }
5192: table.LC_descriptive_input td.LC_description {
5193: vertical-align: top;
5194: text-align: right;
5195: font-weight: bold;
1.423 albertel 5196: }
1.599 albertel 5197: div.LC_feedback_link {
1.616 albertel 5198: clear: both;
1.599 albertel 5199: background: white;
5200: width: 100%;
1.489 raeburn 5201: }
5202: span.LC_feedback_link {
1.599 albertel 5203: background: $feedback_link_bg;
5204: font-size: larger;
5205: }
5206: span.LC_message_link {
5207: background: $feedback_link_bg;
5208: font-size: larger;
5209: position: absolute;
5210: right: 1em;
1.489 raeburn 5211: }
1.421 albertel 5212:
1.515 albertel 5213: table.LC_prior_tries {
1.524 albertel 5214: border: 1px solid #000000;
5215: border-collapse: separate;
5216: border-spacing: 1px;
1.515 albertel 5217: }
1.523 albertel 5218:
1.515 albertel 5219: table.LC_prior_tries td {
1.524 albertel 5220: padding: 2px;
1.515 albertel 5221: }
1.523 albertel 5222:
5223: .LC_answer_correct {
5224: background: #AAFFAA;
5225: color: black;
5226: }
5227: .LC_answer_charged_try {
5228: background: #FFAAAA ! important;
5229: color: black;
5230: }
5231: .LC_answer_not_charged_try,
5232: .LC_answer_no_grade,
5233: .LC_answer_late {
5234: background: #FFFFAA;
5235: color: black;
5236: }
5237: .LC_answer_previous {
5238: background: #AAAAFF;
5239: color: black;
5240: }
5241: .LC_answer_no_message {
5242: background: #FFFFFF;
5243: color: black;
5244: }
5245: .LC_answer_unknown {
5246: background: orange;
5247: color: black;
5248: }
5249:
5250:
1.529 albertel 5251: span.LC_prior_numerical,
5252: span.LC_prior_string,
5253: span.LC_prior_custom,
5254: span.LC_prior_reaction,
5255: span.LC_prior_math {
1.523 albertel 5256: font-family: monospace;
5257: white-space: pre;
5258: }
5259:
1.525 albertel 5260: span.LC_prior_string {
5261: font-family: monospace;
5262: white-space: pre;
5263: }
5264:
1.523 albertel 5265: table.LC_prior_option {
5266: width: 100%;
5267: border-collapse: collapse;
5268: }
1.528 albertel 5269: table.LC_prior_rank, table.LC_prior_match {
5270: border-collapse: collapse;
5271: }
5272: table.LC_prior_option tr td,
5273: table.LC_prior_rank tr td,
5274: table.LC_prior_match tr td {
1.524 albertel 5275: border: 1px solid #000000;
1.515 albertel 5276: }
5277:
1.519 raeburn 5278: span.LC_nobreak {
1.544 albertel 5279: white-space: nowrap;
1.519 raeburn 5280: }
5281:
1.576 raeburn 5282: span.LC_cusr_emph {
5283: font-style: italic;
5284: }
5285:
1.633 raeburn 5286: span.LC_cusr_subheading {
5287: font-weight: normal;
5288: font-size: 85%;
5289: }
5290:
1.545 albertel 5291: table.LC_docs_documents {
5292: background: #BBBBBB;
1.547 albertel 5293: border-width: 0px;
1.545 albertel 5294: border-collapse: collapse;
5295: }
5296:
5297: table.LC_docs_documents td.LC_docs_document {
5298: border: 2px solid black;
5299: padding: 4px;
5300: }
5301:
5302: .LC_docs_entry_move {
5303: border: 0px;
5304: border-collapse: collapse;
1.544 albertel 5305: }
5306:
1.545 albertel 5307: .LC_docs_entry_move td {
5308: border: 2px solid #BBBBBB;
5309: background: #DDDDDD;
5310: }
5311:
5312: .LC_docs_editor td.LC_docs_entry_commands {
5313: background: #DDDDDD;
5314: font-size: x-small;
5315: }
1.544 albertel 5316: .LC_docs_copy {
1.545 albertel 5317: color: #000099;
1.544 albertel 5318: }
5319: .LC_docs_cut {
1.545 albertel 5320: color: #550044;
1.544 albertel 5321: }
5322: .LC_docs_rename {
1.545 albertel 5323: color: #009900;
1.544 albertel 5324: }
5325: .LC_docs_remove {
1.545 albertel 5326: color: #990000;
5327: }
5328:
1.547 albertel 5329: .LC_docs_reinit_warn,
5330: .LC_docs_ext_edit {
5331: font-size: x-small;
5332: }
5333:
1.545 albertel 5334: .LC_docs_editor td.LC_docs_entry_title,
5335: .LC_docs_editor td.LC_docs_entry_icon {
5336: background: #FFFFBB;
5337: }
5338: .LC_docs_editor td.LC_docs_entry_parameter {
5339: background: #BBBBFF;
5340: font-size: x-small;
5341: white-space: nowrap;
5342: }
5343:
5344: table.LC_docs_adddocs td,
5345: table.LC_docs_adddocs th {
5346: border: 1px solid #BBBBBB;
5347: padding: 4px;
5348: background: #DDDDDD;
1.543 albertel 5349: }
5350:
1.584 albertel 5351: table.LC_sty_begin {
5352: background: #BBFFBB;
5353: }
5354: table.LC_sty_end {
5355: background: #FFBBBB;
5356: }
5357:
1.589 raeburn 5358: table.LC_double_column {
5359: border-width: 0px;
5360: border-collapse: collapse;
5361: width: 100%;
5362: padding: 2px;
5363: }
5364:
5365: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5366: top: 2px;
1.589 raeburn 5367: left: 2px;
5368: width: 47%;
5369: vertical-align: top;
5370: }
5371:
5372: table.LC_double_column tr td.LC_right_col {
5373: top: 2px;
5374: right: 2px;
5375: width: 47%;
5376: vertical-align: top;
5377: }
5378:
1.594 raeburn 5379: span.LC_role_level {
5380: font-weight: bold;
5381: }
5382:
1.591 raeburn 5383: div.LC_left_float {
5384: float: left;
5385: padding-right: 5%;
1.597 albertel 5386: padding-bottom: 4px;
1.591 raeburn 5387: }
5388:
5389: div.LC_clear_float_header {
1.597 albertel 5390: padding-bottom: 2px;
1.591 raeburn 5391: }
5392:
5393: div.LC_clear_float_footer {
1.597 albertel 5394: padding-top: 10px;
1.591 raeburn 5395: clear: both;
5396: }
5397:
1.597 albertel 5398:
5399: div.LC_grade_show_user {
5400: margin-top: 20px;
5401: border: 1px solid black;
5402: }
5403: div.LC_grade_user_name {
5404: background: #DDDDEE;
5405: border-bottom: 1px solid black;
1.705 tempelho 5406: font-weight: bold;
5407: font-size: large;
1.597 albertel 5408: }
5409: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5410: background: #DDEEDD;
5411: }
5412:
5413: div.LC_grade_show_problem,
5414: div.LC_grade_submissions,
5415: div.LC_grade_message_center,
5416: div.LC_grade_info_links,
5417: div.LC_grade_assign {
5418: margin: 5px;
5419: width: 99%;
5420: background: #FFFFFF;
5421: }
5422: div.LC_grade_show_problem_header,
5423: div.LC_grade_submissions_header,
5424: div.LC_grade_message_center_header,
5425: div.LC_grade_assign_header {
1.705 tempelho 5426: font-weight: bold;
5427: font-size: large;
1.597 albertel 5428: }
5429: div.LC_grade_show_problem_problem,
5430: div.LC_grade_submissions_body,
5431: div.LC_grade_message_center_body,
5432: div.LC_grade_assign_body {
5433: border: 1px solid black;
5434: width: 99%;
5435: background: #FFFFFF;
5436: }
1.598 albertel 5437: span.LC_grade_check_note {
1.705 tempelho 5438: font-weight: normal;
5439: font-size: medium;
1.598 albertel 5440: display: inline;
5441: position: absolute;
5442: right: 1em;
5443: }
1.597 albertel 5444:
1.613 albertel 5445: table.LC_scantron_action {
5446: width: 100%;
5447: }
5448: table.LC_scantron_action tr th {
1.698 harmsja 5449: font-weight:bold;
5450: font-style:normal;
1.613 albertel 5451: }
1.698 harmsja 5452: .LC_edit_problem_header,
1.614 albertel 5453: div.LC_edit_problem_footer {
1.705 tempelho 5454: font-weight: normal;
5455: font-size: medium;
1.602 albertel 5456: margin: 2px;
1.600 albertel 5457: }
5458: div.LC_edit_problem_header,
1.602 albertel 5459: div.LC_edit_problem_header div,
1.614 albertel 5460: div.LC_edit_problem_footer,
5461: div.LC_edit_problem_footer div,
1.602 albertel 5462: div.LC_edit_problem_editxml_header,
5463: div.LC_edit_problem_editxml_header div {
1.600 albertel 5464: margin-top: 5px;
5465: }
1.602 albertel 5466: div.LC_edit_problem_header_edit_row {
5467: background: $tabbg;
5468: padding: 3px;
5469: margin-bottom: 5px;
5470: }
1.600 albertel 5471: div.LC_edit_problem_header_title {
1.705 tempelho 5472: font-weight: bold;
5473: font-size: larger;
1.602 albertel 5474: background: $tabbg;
5475: padding: 3px;
5476: }
5477: table.LC_edit_problem_header_title {
1.705 tempelho 5478: font-size: larger;
5479: font-weight: bold;
1.602 albertel 5480: width: 100%;
5481: border-color: $pgbg;
5482: border-style: solid;
5483: border-width: $border;
5484:
1.600 albertel 5485: background: $tabbg;
1.602 albertel 5486: border-collapse: collapse;
5487: padding: 0px
5488: }
5489:
5490: div.LC_edit_problem_discards {
5491: float: left;
5492: padding-bottom: 5px;
5493: }
5494: div.LC_edit_problem_saves {
5495: float: right;
5496: padding-bottom: 5px;
1.600 albertel 5497: }
5498: hr.LC_edit_problem_divide {
1.602 albertel 5499: clear: both;
1.600 albertel 5500: color: $tabbg;
5501: background-color: $tabbg;
5502: height: 3px;
5503: border: 0px;
5504: }
1.679 riegler 5505: img.stift{
1.678 riegler 5506: border-width:0;
1.679 riegler 5507: vertical-align:middle;
1.677 riegler 5508: }
1.680 riegler 5509:
1.681 riegler 5510: table#LC_mainmenu{
5511: margin-top:10px;
5512: width:80%;
5513:
5514: }
5515:
1.680 riegler 5516: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5517: vertical-align: top;
5518: width: 45%;
5519: }
5520: .LC_mainmenu_fieldset_category {
5521: color: $font;
5522: background: $pgbg;
5523: font-family: $sans;
5524: font-size: small;
5525: font-weight: bold;
5526: }
5527:
1.716 raeburn 5528: div.LC_createcourse {
5529: margin: 10px 10px 10px 10px;
5530: }
5531:
1.693 droeschl 5532: /* ---- Remove when done ----
5533: # The following styles is part of the redesign of LON-CAPA and are
5534: # subject to change during this project.
5535: # Don't rely on their current functionality as they might be
5536: # changed or removed.
5537: # --------------------------*/
5538:
1.698 harmsja 5539: a:hover,
1.721 harmsja 5540: ol.LC_smallMenu a:hover,
5541: ol#LC_MenuBreadcrumbs a:hover,
5542: ol#LC_PathBreadcrumbs a:hover,
5543: ul#LC_TabMainMenuContent a:hover,
5544: .LC_FormSectionClearButton input:hover
5545: ul.LC_TabContent li:hover a{
1.698 harmsja 5546: color:#BF2317;
5547: text-decoration:none;
1.693 droeschl 5548: }
5549:
5550: h1 {
1.721 harmsja 5551: padding:5px 10px 5px 20px;
1.693 droeschl 5552: line-height:130%;
5553: }
1.698 harmsja 5554:
1.693 droeschl 5555: h2,h3,h4,h5,h6
5556: {
1.721 harmsja 5557: margin:5px 0px 5px 0px;
5558: padding:0px;
5559: line-height:130%;
1.693 droeschl 5560: }
1.721 harmsja 5561: .LC_hcell{
1.698 harmsja 5562: padding:3px 15px 3px 15px;
5563: margin:0px;
1.703 harmsja 5564: background-color:$tabbg;
5565: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5566: }
1.721 harmsja 5567: .LC_noBorder {
1.698 harmsja 5568: border:0px;
5569: }
1.693 droeschl 5570:
1.722 harmsja 5571: .LC_bgLightGrey{
1.741 harmsja 5572: background:URL(/adm/lonIcons/lightGreyBG.png) repeat-x left bottom;
1.722 harmsja 5573: }
1.741 harmsja 5574:
1.693 droeschl 5575:
1.698 harmsja 5576: /* Main Header with discription of Person, Course, etc. */
1.721 harmsja 5577: .LC_HeadRight {
1.693 droeschl 5578: text-align: right;
5579: float: right;
5580: margin: 0px;
5581: padding: 0px;
1.698 harmsja 5582: right:0;
1.693 droeschl 5583: position:absolute;
1.698 harmsja 5584: overflow:hidden;
1.693 droeschl 5585: }
5586:
1.721 harmsja 5587: p, .LC_ContentBox {
1.698 harmsja 5588: padding: 10px;
5589:
5590: }
1.721 harmsja 5591: .LC_FormSectionClearButton input {
1.741 harmsja 5592: background-color:transparent;
1.698 harmsja 5593: border:0px;
5594: cursor:pointer;
5595: text-decoration:underline;
1.693 droeschl 5596: }
5597:
5598:
1.698 harmsja 5599: dl,ul,div,fieldset {
5600: margin: 10px 10px 10px 0px;
1.693 droeschl 5601: overflow:hidden;
5602: }
1.721 harmsja 5603: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698 harmsja 5604: margin: 0px;
1.693 droeschl 5605: }
5606:
1.721 harmsja 5607: ol.LC_smallMenu li {
1.693 droeschl 5608: display: inline;
5609: padding: 5px 5px 0px 10px;
5610: vertical-align: top;
5611: }
5612:
1.721 harmsja 5613: ol.LC_smallMenu li img {
1.693 droeschl 5614: vertical-align: bottom;
5615: }
5616:
1.721 harmsja 5617: ol.LC_smallMenu a {
1.693 droeschl 5618: font-size: 90%;
5619: color: RGB(80, 80, 80);
5620: text-decoration: none;
5621: }
1.744 ehlerst 5622: ol#LC_TabMainMenueContent, ul.LC_TabContent ,
1.741 harmsja 5623: ul.LC_TabContentBigger {
1.721 harmsja 5624: display:block;
5625: list-style:none;
1.741 harmsja 5626: margin: 0px;
1.693 droeschl 5627: padding: 0px;
5628: }
5629:
1.744 ehlerst 5630: ol#LC_TabMainMenuContent li, ul.LC_TabContent li,
1.741 harmsja 5631: ul.LC_TabContentBigger li{
1.693 droeschl 5632: display: inline;
1.741 harmsja 5633: border-right: solid 1px $lg_border_color;
5634: float:left;
5635: line-height:140%;
5636: white-space:nowrap;
5637: }
5638: ol#LC_TabMainMenuContent li{
1.693 droeschl 5639: vertical-align: bottom;
5640: border-bottom: solid 1px RGB(175, 175, 175);
1.721 harmsja 5641: padding: 5px 10px 5px 10px;
1.741 harmsja 5642: margin-right:5px;
5643: margin-bottom:3px;
1.693 droeschl 5644: font-weight: bold;
1.723 riegler 5645: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5646: }
5647:
1.721 harmsja 5648: ol#LC_TabMainMenuContent li a{
1.693 droeschl 5649: color: RGB(47, 47, 47);
5650: text-decoration: none;
5651: }
1.721 harmsja 5652: ul.LC_TabContent {
1.741 harmsja 5653: min-height:1.6em;
1.721 harmsja 5654: }
5655: ul.LC_TabContent li{
1.741 harmsja 5656: vertical-align:middle;
5657: padding:0px 10px 0px 10px;
1.745 ehlerst 5658: background-color:$tabbg;
5659: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5660: }
1.744 ehlerst 5661: ul.LC_TabContent li a, ul.LC_TabContent li{
1.721 harmsja 5662: color:rgb(47,47,47);
5663: text-decoration:none;
5664: font-size:95%;
5665: font-weight:bold;
5666: }
1.744 ehlerst 5667: ul.LC_TabContent li:hover, ul.LC_TabContent li.active{
5668: background-color:#FFFFFF;
1.745 ehlerst 5669: border-bottom:solid 1px #FFFFFF;
1.744 ehlerst 5670: }
1.741 harmsja 5671: ul.LC_TabContentBigger li{
5672: vertical-align:bottom;
5673: border-top:solid 1px $lg_border_color;
5674: border-left:solid 1px $lg_border_color;
5675: padding:5px 10px 5px 10px;
5676: margin-left:2px;
5677: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5678: }
1.744 ehlerst 5679: ul.LC_TabContentBigger li:hover, ul.LC_TabContentBigger li.active{
5680: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5681: }
1.741 harmsja 5682: ul.LC_TabContentBigger li, ul.LC_TabContentBigger li a{
5683: font-size:110%;
5684: font-weight:bold;
5685: }
5686: #LC_CourseDocuments, #LC_SupplementalCourseDocuments
5687: {
5688: margin:0px;
1.737 tempelho 5689: }
5690:
1.721 harmsja 5691: .LC_hideThis
5692: {
5693: display:none;
5694: visibility:hidden;
1.693 droeschl 5695: }
5696:
1.721 harmsja 5697: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs {
1.693 droeschl 5698: border-top: solid 1px RGB(255, 255, 255);
5699: height: 20px;
5700: line-height: 20px;
5701: vertical-align: bottom;
5702: margin: 0px 0px 30px 0px;
5703: padding-left: 10px;
5704: list-style-position: inside;
1.723 riegler 5705: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5706: }
5707:
1.721 harmsja 5708: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li {
1.741 harmsja 5709: /*
1.723 riegler 5710: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.741 harmsja 5711: */
1.693 droeschl 5712: display: inline;
5713: padding: 0px 0px 0px 10px;
5714: vertical-align: bottom;
5715: overflow:hidden;
5716: }
5717:
1.721 harmsja 5718: ol#LC_MenuBreadcrumbs li a {
1.693 droeschl 5719: text-decoration: none;
5720: font-size:90%;
5721: }
1.721 harmsja 5722: ol#LC_PathBreadcrumbs li a{
1.698 harmsja 5723: text-decoration:none;
5724: font-size:100%;
5725: font-weight:bold;
1.693 droeschl 5726: }
1.721 harmsja 5727: .LC_ContentBoxSpecial
1.693 droeschl 5728: {
1.701 harmsja 5729: border: solid 1px $lg_border_color;
1.746 neumanie 5730: }
5731: .LC_ContentBoxSpecialContactInfo
5732: {
5733: border: solid 1px $lg_border_color;
5734: max-width:25%;
5735: min-width:25%;
1.698 harmsja 5736: }
1.747 neumanie 5737: .LC_AboutMe_Image
5738: {
5739: float:left;
5740: margin-right:10px;
5741: }
5742: .LC_Clear_AboutMe_Image
5743: {
5744: clear:left;
5745: }
1.721 harmsja 5746: dl.LC_ListStyleClean dt {
1.693 droeschl 5747: padding-right: 5px;
5748: display: table-header-group;
5749: }
5750:
1.721 harmsja 5751: dl.LC_ListStyleClean dd {
1.693 droeschl 5752: display: table-row;
5753: }
5754:
1.721 harmsja 5755: .LC_ListStyleClean,
5756: .LC_ListStyleSimple,
5757: .LC_ListStyleNormal,
5758: .LC_ListStyleNormal_Border,
5759: .LC_ListStyleSpecial
1.693 droeschl 5760: {
5761: /*display:block; */
5762: list-style-position: inside;
5763: list-style-type: none;
5764: overflow: hidden;
5765: padding: 0px;
5766: }
5767:
1.721 harmsja 5768: .LC_ListStyleSimple li,
5769: .LC_ListStyleSimple dd,
5770: .LC_ListStyleNormal li,
5771: .LC_ListStyleNormal dd,
5772: .LC_ListStyleSpecial li,
5773: .LC_ListStyleSpecial dd
1.693 droeschl 5774: {
5775: margin: 0px;
5776: padding: 5px 5px 5px 10px;
5777: clear: both;
5778: }
5779:
1.721 harmsja 5780: .LC_ListStyleClean li,
5781: .LC_ListStyleClean dd {
1.693 droeschl 5782: padding-top: 0px;
5783: padding-bottom: 0px;
5784: }
5785:
1.721 harmsja 5786: .LC_ListStyleSimple dd,
5787: .LC_ListStyleSimple li{
1.698 harmsja 5788: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5789: }
5790:
1.721 harmsja 5791: .LC_ListStyleSpecial li,
5792: .LC_ListStyleSpecial dd {
1.693 droeschl 5793: list-style-type: none;
5794: background-color: RGB(220, 220, 220);
5795: margin-bottom: 4px;
5796: }
5797:
1.721 harmsja 5798: table.LC_SimpleTable {
1.698 harmsja 5799: margin:5px;
5800: border:solid 1px $lg_border_color;
1.693 droeschl 5801: }
5802:
1.721 harmsja 5803: table.LC_SimpleTable tr {
1.698 harmsja 5804: padding:0px;
5805: border:solid 1px $lg_border_color;
1.693 droeschl 5806: }
1.721 harmsja 5807: table.LC_SimpleTable thead{
1.698 harmsja 5808: background:rgb(220,220,220);
1.693 droeschl 5809: }
5810:
1.721 harmsja 5811: div.LC_columnSection {
1.693 droeschl 5812: display: block;
5813: clear: both;
5814: overflow: hidden;
5815: margin:0px;
5816: }
5817:
1.721 harmsja 5818: div.LC_columnSection>* {
1.693 droeschl 5819: float: left;
5820: margin: 10px 20px 10px 0px;
1.747 neumanie 5821: overflow:hidden;
1.693 droeschl 5822: }
1.721 harmsja 5823: div.LC_columnSection > .LC_ContentBox,
5824: div.LC_columnSection > .LC_ContentBoxSpecial
1.693 droeschl 5825: {
1.747 neumanie 5826: width: 400px;
1.693 droeschl 5827: }
1.721 harmsja 5828:
1.719 ehlerst 5829: .ContentBoxSpecialTemplate
5830: {
1.747 neumanie 5831: border: solid 1px $lg_border_color;
1.719 ehlerst 5832: }
5833: .ContentBoxTemplate {
5834: padding:10px;
5835: }
5836:
1.721 harmsja 5837: div.LC_columnSection > .ContentBoxTemplate,
5838: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719 ehlerst 5839: {
5840: width: 600px;
5841:
5842: }
5843:
1.720 ehlerst 5844: .clear{
5845: clear: both;
5846: line-height: 0px;
5847: font-size: 0px;
5848: height: 0px;
5849: }
1.693 droeschl 5850:
1.694 tempelho 5851: .LC_loginpage_container {
5852: text-align:left;
5853: margin : 0 auto;
5854: width:65%;
5855: padding: 10px;
5856: height: auto;
1.712 muellerd 5857: background-color:#FFFFFF;
1.694 tempelho 5858: border:1px solid #CCCCCC;
5859: }
5860:
5861:
5862: .LC_loginpage_loginContainer {
5863: float:left;
1.712 muellerd 5864: width: 182px;
5865: border:1px solid #CCCCCC;
5866: background-color:$loginbg;
1.694 tempelho 5867: }
5868:
1.717 tempelho 5869: .LC_loginpage_loginContainer h2{
1.712 muellerd 5870: margin-top:0;
5871: display:block;
5872: background:$bgcol;
5873: color:$textcol;
5874: padding-left:5px;
5875: }
1.694 tempelho 5876: .LC_loginpage_loginInfo {
5877: margin-left:20px;
5878: float:left;
5879: width:30%;
5880: border:1px solid #CCCCCC;
5881: padding:10px;
5882: }
5883:
1.712 muellerd 5884: .LC_loginpage_loginDomain {
5885: margin-right:20px;
5886: width:20%;
5887: float:left;
5888: padding:10px;
5889: }
5890:
1.694 tempelho 5891: .LC_loginpage_space {
5892: clear:both;
5893: margin-bottom:20px;
5894: border-bottom: 1px solid #CCCCCC;
5895: }
5896:
1.748 schulted 5897: table em{
5898: font-weight:bold;
5899: font-style:normal;
5900: }
5901:
1.343 albertel 5902: END
5903: }
5904:
1.306 albertel 5905: =pod
5906:
5907: =item * &headtag()
5908:
5909: Returns a uniform footer for LON-CAPA web pages.
5910:
1.307 albertel 5911: Inputs: $title - optional title for the head
5912: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5913: $args - optional arguments
1.319 albertel 5914: force_register - if is true call registerurl so the remote is
5915: informed
1.415 albertel 5916: redirect -> array ref of
5917: 1- seconds before redirect occurs
5918: 2- url to redirect to
5919: 3- whether the side effect should occur
1.315 albertel 5920: (side effect of setting
5921: $env{'internal.head.redirect'} to the url
5922: redirected too)
1.352 albertel 5923: domain -> force to color decorate a page for a specific
5924: domain
5925: function -> force usage of a specific rolish color scheme
5926: bgcolor -> override the default page bgcolor
1.460 albertel 5927: no_auto_mt_title
5928: -> prevent &mt()ing the title arg
1.464 albertel 5929:
1.306 albertel 5930: =cut
5931:
5932: sub headtag {
1.313 albertel 5933: my ($title,$head_extra,$args) = @_;
1.306 albertel 5934:
1.363 albertel 5935: my $function = $args->{'function'} || &get_users_function();
5936: my $domain = $args->{'domain'} || &determinedomain();
5937: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5938: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5939: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5940: #time(),
1.418 albertel 5941: $env{'environment.color.timestamp'},
1.363 albertel 5942: $function,$domain,$bgcolor);
5943:
1.369 www 5944: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5945:
1.308 albertel 5946: my $result =
5947: '<head>'.
1.461 albertel 5948: &font_settings();
1.319 albertel 5949:
1.461 albertel 5950: if (!$args->{'frameset'}) {
5951: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5952: }
1.319 albertel 5953: if ($args->{'force_register'}) {
5954: $result .= &Apache::lonmenu::registerurl(1);
5955: }
1.436 albertel 5956: if (!$args->{'no_nav_bar'}
5957: && !$args->{'only_body'}
5958: && !$args->{'frameset'}) {
5959: $result .= &help_menu_js();
5960: }
1.319 albertel 5961:
1.314 albertel 5962: if (ref($args->{'redirect'})) {
1.414 albertel 5963: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5964: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5965: if (!$inhibit_continue) {
5966: $env{'internal.head.redirect'} = $url;
5967: }
1.313 albertel 5968: $result.=<<ADDMETA
5969: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5970: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5971: ADDMETA
5972: }
1.306 albertel 5973: if (!defined($title)) {
5974: $title = 'The LearningOnline Network with CAPA';
5975: }
1.460 albertel 5976: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5977: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5978: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5979: .$head_extra;
1.306 albertel 5980: return $result;
5981: }
5982:
5983: =pod
5984:
1.340 albertel 5985: =item * &font_settings()
5986:
5987: Returns neccessary <meta> to set the proper encoding
5988:
5989: Inputs: none
5990:
5991: =cut
5992:
5993: sub font_settings {
5994: my $headerstring='';
1.647 www 5995: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5996: $headerstring.=
5997: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5998: }
5999: return $headerstring;
6000: }
6001:
1.341 albertel 6002: =pod
6003:
6004: =item * &xml_begin()
6005:
6006: Returns the needed doctype and <html>
6007:
6008: Inputs: none
6009:
6010: =cut
6011:
6012: sub xml_begin {
6013: my $output='';
6014:
1.592 albertel 6015: if ($env{'internal.start_page'}==1) {
6016: &Apache::lonhtmlcommon::init_htmlareafields();
6017: }
1.342 albertel 6018:
1.341 albertel 6019: if ($env{'browser.mathml'}) {
6020: $output='<?xml version="1.0"?>'
6021: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6022: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6023:
6024: # .'<!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">] >'
6025: .'<!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">'
6026: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6027: .'xmlns="http://www.w3.org/1999/xhtml">';
6028: } else {
6029: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6030: }
6031: return $output;
6032: }
1.340 albertel 6033:
6034: =pod
6035:
1.306 albertel 6036: =item * &endheadtag()
6037:
6038: Returns a uniform </head> for LON-CAPA web pages.
6039:
6040: Inputs: none
6041:
6042: =cut
6043:
6044: sub endheadtag {
6045: return '</head>';
6046: }
6047:
6048: =pod
6049:
6050: =item * &head()
6051:
6052: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6053:
1.648 raeburn 6054: Inputs:
6055:
6056: =over 4
6057:
6058: $title - optional title for the page
6059:
6060: $head_extra - optional extra HTML to put inside the <head>
6061:
6062: =back
1.405 albertel 6063:
1.306 albertel 6064: =cut
6065:
6066: sub head {
1.325 albertel 6067: my ($title,$head_extra,$args) = @_;
6068: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6069: }
6070:
6071: =pod
6072:
6073: =item * &start_page()
6074:
6075: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6076:
1.648 raeburn 6077: Inputs:
6078:
6079: =over 4
6080:
6081: $title - optional title for the page
6082:
6083: $head_extra - optional extra HTML to incude inside the <head>
6084:
6085: $args - additional optional args supported are:
6086:
6087: =over 8
6088:
6089: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6090: arg on
1.648 raeburn 6091: no_nav_bar -> is true will set &bodytag() notopbar arg on
6092: add_entries -> additional attributes to add to the <body>
6093: domain -> force to color decorate a page for a
1.317 albertel 6094: specific domain
1.648 raeburn 6095: function -> force usage of a specific rolish color
1.317 albertel 6096: scheme
1.648 raeburn 6097: redirect -> see &headtag()
6098: bgcolor -> override the default page bg color
6099: js_ready -> return a string ready for being used in
1.317 albertel 6100: a javascript writeln
1.648 raeburn 6101: html_encode -> return a string ready for being used in
1.320 albertel 6102: a html attribute
1.648 raeburn 6103: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6104: $forcereg arg
1.648 raeburn 6105: body_title -> alternate text to use instead of $title
1.326 albertel 6106: in the title box that appears, this text
6107: is not auto translated like the $title is
1.648 raeburn 6108: frameset -> if true will start with a <frameset>
1.330 albertel 6109: rather than <body>
1.648 raeburn 6110: no_title -> if true the title bar won't be shown
6111: skip_phases -> hash ref of
1.338 albertel 6112: head -> skip the <html><head> generation
6113: body -> skip all <body> generation
1.648 raeburn 6114: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6115: 'Switch To Inline Menu' link
1.648 raeburn 6116: no_auto_mt_title -> prevent &mt()ing the title arg
6117: inherit_jsmath -> when creating popup window in a page,
6118: should it have jsmath forced on by the
6119: current page
1.361 albertel 6120:
1.648 raeburn 6121: =back
1.460 albertel 6122:
1.648 raeburn 6123: =back
1.562 albertel 6124:
1.306 albertel 6125: =cut
6126:
6127: sub start_page {
1.309 albertel 6128: my ($title,$head_extra,$args) = @_;
1.318 albertel 6129: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6130: my %head_args;
1.352 albertel 6131: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6132: 'bgcolor','frameset','no_nav_bar','only_body',
6133: 'no_auto_mt_title') {
1.319 albertel 6134: if (defined($args->{$arg})) {
1.324 raeburn 6135: $head_args{$arg} = $args->{$arg};
1.319 albertel 6136: }
1.313 albertel 6137: }
1.319 albertel 6138:
1.315 albertel 6139: $env{'internal.start_page'}++;
1.338 albertel 6140: my $result;
6141: if (! exists($args->{'skip_phases'}{'head'}) ) {
6142: $result.=
1.341 albertel 6143: &xml_begin().
1.338 albertel 6144: &headtag($title,$head_extra,\%head_args).&endheadtag();
6145: }
6146:
6147: if (! exists($args->{'skip_phases'}{'body'}) ) {
6148: if ($args->{'frameset'}) {
6149: my $attr_string = &make_attr_string($args->{'force_register'},
6150: $args->{'add_entries'});
6151: $result .= "\n<frameset $attr_string>\n";
6152: } else {
6153: $result .=
6154: &bodytag($title,
6155: $args->{'function'}, $args->{'add_entries'},
6156: $args->{'only_body'}, $args->{'domain'},
6157: $args->{'force_register'}, $args->{'body_title'},
6158: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6159: $args->{'no_title'}, $args->{'no_inline_link'},
6160: $args);
1.338 albertel 6161: }
1.330 albertel 6162: }
1.338 albertel 6163:
1.315 albertel 6164: if ($args->{'js_ready'}) {
1.713 kaisler 6165: $result = &js_ready($result);
1.315 albertel 6166: }
1.320 albertel 6167: if ($args->{'html_encode'}) {
1.713 kaisler 6168: $result = &html_encode($result);
6169: }
6170:
1.718 raeburn 6171: if (exists($args->{'bread_crumbs'})) {
6172: &Apache::lonhtmlcommon::clear_breadcrumbs();
6173: if (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6174: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6175: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6176: }
6177: }
6178: $result .= &Apache::lonhtmlcommon::breadcrumbs();
1.320 albertel 6179: }
1.713 kaisler 6180:
1.315 albertel 6181: return $result;
1.306 albertel 6182: }
6183:
1.330 albertel 6184:
1.306 albertel 6185: =pod
6186:
6187: =item * &head()
6188:
6189: Returns a complete </body></html> section for LON-CAPA web pages.
6190:
1.315 albertel 6191: Inputs: $args - additional optional args supported are:
6192: js_ready -> return a string ready for being used in
6193: a javascript writeln
1.320 albertel 6194: html_encode -> return a string ready for being used in
6195: a html attribute
1.330 albertel 6196: frameset -> if true will start with a <frameset>
6197: rather than <body>
1.493 albertel 6198: dicsussion -> if true will get discussion from
6199: lonxml::xmlend
6200: (you can pass the target and parser arguments
6201: through optional 'target' and 'parser' args
6202: to this routine)
1.306 albertel 6203:
6204: =cut
6205:
6206: sub end_page {
1.315 albertel 6207: my ($args) = @_;
6208: $env{'internal.end_page'}++;
1.330 albertel 6209: my $result;
1.335 albertel 6210: if ($args->{'discussion'}) {
6211: my ($target,$parser);
6212: if (ref($args->{'discussion'})) {
6213: ($target,$parser) =($args->{'discussion'}{'target'},
6214: $args->{'discussion'}{'parser'});
6215: }
6216: $result .= &Apache::lonxml::xmlend($target,$parser);
6217: }
6218:
1.330 albertel 6219: if ($args->{'frameset'}) {
6220: $result .= '</frameset>';
6221: } else {
1.635 raeburn 6222: $result .= &endbodytag($args);
1.330 albertel 6223: }
6224: $result .= "\n</html>";
6225:
1.315 albertel 6226: if ($args->{'js_ready'}) {
1.317 albertel 6227: $result = &js_ready($result);
1.315 albertel 6228: }
1.335 albertel 6229:
1.320 albertel 6230: if ($args->{'html_encode'}) {
6231: $result = &html_encode($result);
6232: }
1.335 albertel 6233:
1.315 albertel 6234: return $result;
6235: }
6236:
1.320 albertel 6237: sub html_encode {
6238: my ($result) = @_;
6239:
1.322 albertel 6240: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6241:
6242: return $result;
6243: }
1.317 albertel 6244: sub js_ready {
6245: my ($result) = @_;
6246:
1.323 albertel 6247: $result =~ s/[\n\r]/ /xmsg;
6248: $result =~ s/\\/\\\\/xmsg;
6249: $result =~ s/'/\\'/xmsg;
1.372 albertel 6250: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6251:
6252: return $result;
6253: }
6254:
1.315 albertel 6255: sub validate_page {
6256: if ( exists($env{'internal.start_page'})
1.316 albertel 6257: && $env{'internal.start_page'} > 1) {
6258: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6259: $env{'internal.start_page'}.' '.
1.316 albertel 6260: $ENV{'request.filename'});
1.315 albertel 6261: }
6262: if ( exists($env{'internal.end_page'})
1.316 albertel 6263: && $env{'internal.end_page'} > 1) {
6264: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6265: $env{'internal.end_page'}.' '.
1.316 albertel 6266: $env{'request.filename'});
1.315 albertel 6267: }
6268: if ( exists($env{'internal.start_page'})
6269: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6270: &Apache::lonnet::logthis('start_page called without end_page '.
6271: $env{'request.filename'});
1.315 albertel 6272: }
6273: if ( ! exists($env{'internal.start_page'})
6274: && exists($env{'internal.end_page'})) {
1.316 albertel 6275: &Apache::lonnet::logthis('end_page called without start_page'.
6276: $env{'request.filename'});
1.315 albertel 6277: }
1.306 albertel 6278: }
1.315 albertel 6279:
1.318 albertel 6280: sub simple_error_page {
6281: my ($r,$title,$msg) = @_;
6282: my $page =
6283: &Apache::loncommon::start_page($title).
6284: &mt($msg).
6285: &Apache::loncommon::end_page();
6286: if (ref($r)) {
6287: $r->print($page);
1.327 albertel 6288: return;
1.318 albertel 6289: }
6290: return $page;
6291: }
1.347 albertel 6292:
6293: {
1.610 albertel 6294: my @row_count;
1.347 albertel 6295: sub start_data_table {
1.422 albertel 6296: my ($add_class) = @_;
6297: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6298: unshift(@row_count,0);
1.422 albertel 6299: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6300: }
6301:
6302: sub end_data_table {
1.610 albertel 6303: shift(@row_count);
1.389 albertel 6304: return '</table>'."\n";;
1.347 albertel 6305: }
6306:
6307: sub start_data_table_row {
1.422 albertel 6308: my ($add_class) = @_;
1.610 albertel 6309: $row_count[0]++;
6310: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6311: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6312: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6313: }
1.471 banghart 6314:
6315: sub continue_data_table_row {
6316: my ($add_class) = @_;
1.610 albertel 6317: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6318: $css_class = (join(' ',$css_class,$add_class));
6319: return '<tr class="'.$css_class.'">'."\n";;
6320: }
1.347 albertel 6321:
6322: sub end_data_table_row {
1.389 albertel 6323: return '</tr>'."\n";;
1.347 albertel 6324: }
1.367 www 6325:
1.421 albertel 6326: sub start_data_table_empty_row {
1.707 bisitz 6327: # $row_count[0]++;
1.421 albertel 6328: return '<tr class="LC_empty_row" >'."\n";;
6329: }
6330:
6331: sub end_data_table_empty_row {
6332: return '</tr>'."\n";;
6333: }
6334:
1.367 www 6335: sub start_data_table_header_row {
1.389 albertel 6336: return '<tr class="LC_header_row">'."\n";;
1.367 www 6337: }
6338:
6339: sub end_data_table_header_row {
1.389 albertel 6340: return '</tr>'."\n";;
1.367 www 6341: }
1.347 albertel 6342: }
6343:
1.548 albertel 6344: =pod
6345:
6346: =item * &inhibit_menu_check($arg)
6347:
6348: Checks for a inhibitmenu state and generates output to preserve it
6349:
6350: Inputs: $arg - can be any of
6351: - undef - in which case the return value is a string
6352: to add into arguments list of a uri
6353: - 'input' - in which case the return value is a HTML
6354: <form> <input> field of type hidden to
6355: preserve the value
6356: - a url - in which case the return value is the url with
6357: the neccesary cgi args added to preserve the
6358: inhibitmenu state
6359: - a ref to a url - no return value, but the string is
6360: updated to include the neccessary cgi
6361: args to preserve the inhibitmenu state
6362:
6363: =cut
6364:
6365: sub inhibit_menu_check {
6366: my ($arg) = @_;
6367: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6368: if ($arg eq 'input') {
6369: if ($env{'form.inhibitmenu'}) {
6370: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6371: } else {
6372: return
6373: }
6374: }
6375: if ($env{'form.inhibitmenu'}) {
6376: if (ref($arg)) {
6377: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6378: } elsif ($arg eq '') {
6379: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6380: } else {
6381: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6382: }
6383: }
6384: if (!ref($arg)) {
6385: return $arg;
6386: }
6387: }
6388:
1.251 albertel 6389: ###############################################
1.182 matthew 6390:
6391: =pod
6392:
1.549 albertel 6393: =back
6394:
6395: =head1 User Information Routines
6396:
6397: =over 4
6398:
1.405 albertel 6399: =item * &get_users_function()
1.182 matthew 6400:
6401: Used by &bodytag to determine the current users primary role.
6402: Returns either 'student','coordinator','admin', or 'author'.
6403:
6404: =cut
6405:
6406: ###############################################
6407: sub get_users_function {
6408: my $function = 'student';
1.258 albertel 6409: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6410: $function='coordinator';
6411: }
1.258 albertel 6412: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6413: $function='admin';
6414: }
1.258 albertel 6415: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6416: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6417: $function='author';
6418: }
6419: return $function;
1.54 www 6420: }
1.99 www 6421:
6422: ###############################################
6423:
1.233 raeburn 6424: =pod
6425:
1.542 raeburn 6426: =item * &check_user_status()
1.274 raeburn 6427:
6428: Determines current status of supplied role for a
6429: specific user. Roles can be active, previous or future.
6430:
6431: Inputs:
6432: user's domain, user's username, course's domain,
1.375 raeburn 6433: course's number, optional section ID.
1.274 raeburn 6434:
6435: Outputs:
6436: role status: active, previous or future.
6437:
6438: =cut
6439:
6440: sub check_user_status {
1.412 raeburn 6441: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6442: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6443: my @uroles = keys %userinfo;
6444: my $srchstr;
6445: my $active_chk = 'none';
1.412 raeburn 6446: my $now = time;
1.274 raeburn 6447: if (@uroles > 0) {
1.412 raeburn 6448: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6449: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6450: } else {
1.412 raeburn 6451: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6452: }
6453: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6454: my $role_end = 0;
6455: my $role_start = 0;
6456: $active_chk = 'active';
1.412 raeburn 6457: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6458: $role_end = $1;
6459: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6460: $role_start = $1;
1.274 raeburn 6461: }
6462: }
6463: if ($role_start > 0) {
1.412 raeburn 6464: if ($now < $role_start) {
1.274 raeburn 6465: $active_chk = 'future';
6466: }
6467: }
6468: if ($role_end > 0) {
1.412 raeburn 6469: if ($now > $role_end) {
1.274 raeburn 6470: $active_chk = 'previous';
6471: }
6472: }
6473: }
6474: }
6475: return $active_chk;
6476: }
6477:
6478: ###############################################
6479:
6480: =pod
6481:
1.405 albertel 6482: =item * &get_sections()
1.233 raeburn 6483:
6484: Determines all the sections for a course including
6485: sections with students and sections containing other roles.
1.419 raeburn 6486: Incoming parameters:
6487:
6488: 1. domain
6489: 2. course number
6490: 3. reference to array containing roles for which sections should
6491: be gathered (optional).
6492: 4. reference to array containing status types for which sections
6493: should be gathered (optional).
6494:
6495: If the third argument is undefined, sections are gathered for any role.
6496: If the fourth argument is undefined, sections are gathered for any status.
6497: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6498:
1.374 raeburn 6499: Returns section hash (keys are section IDs, values are
6500: number of users in each section), subject to the
1.419 raeburn 6501: optional roles filter, optional status filter
1.233 raeburn 6502:
6503: =cut
6504:
6505: ###############################################
6506: sub get_sections {
1.419 raeburn 6507: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6508: if (!defined($cdom) || !defined($cnum)) {
6509: my $cid = $env{'request.course.id'};
6510:
6511: return if (!defined($cid));
6512:
6513: $cdom = $env{'course.'.$cid.'.domain'};
6514: $cnum = $env{'course.'.$cid.'.num'};
6515: }
6516:
6517: my %sectioncount;
1.419 raeburn 6518: my $now = time;
1.240 albertel 6519:
1.366 albertel 6520: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6521: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6522: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6523: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6524: my $start_index = &Apache::loncoursedata::CL_START();
6525: my $end_index = &Apache::loncoursedata::CL_END();
6526: my $status;
1.366 albertel 6527: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6528: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6529: $data->[$status_index],
6530: $data->[$start_index],
6531: $data->[$end_index]);
6532: if ($stu_status eq 'Active') {
6533: $status = 'active';
6534: } elsif ($end < $now) {
6535: $status = 'previous';
6536: } elsif ($start > $now) {
6537: $status = 'future';
6538: }
6539: if ($section ne '-1' && $section !~ /^\s*$/) {
6540: if ((!defined($possible_status)) || (($status ne '') &&
6541: (grep/^\Q$status\E$/,@{$possible_status}))) {
6542: $sectioncount{$section}++;
6543: }
1.240 albertel 6544: }
6545: }
6546: }
6547: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6548: foreach my $user (sort(keys(%courseroles))) {
6549: if ($user !~ /^(\w{2})/) { next; }
6550: my ($role) = ($user =~ /^(\w{2})/);
6551: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6552: my ($section,$status);
1.240 albertel 6553: if ($role eq 'cr' &&
6554: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6555: $section=$1;
6556: }
6557: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6558: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6559: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6560: if ($end == -1 && $start == -1) {
6561: next; #deleted role
6562: }
6563: if (!defined($possible_status)) {
6564: $sectioncount{$section}++;
6565: } else {
6566: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6567: $status = 'active';
6568: } elsif ($end < $now) {
6569: $status = 'future';
6570: } elsif ($start > $now) {
6571: $status = 'previous';
6572: }
6573: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6574: $sectioncount{$section}++;
6575: }
6576: }
1.233 raeburn 6577: }
1.366 albertel 6578: return %sectioncount;
1.233 raeburn 6579: }
6580:
1.274 raeburn 6581: ###############################################
1.294 raeburn 6582:
6583: =pod
1.405 albertel 6584:
6585: =item * &get_course_users()
6586:
1.275 raeburn 6587: Retrieves usernames:domains for users in the specified course
6588: with specific role(s), and access status.
6589:
6590: Incoming parameters:
1.277 albertel 6591: 1. course domain
6592: 2. course number
6593: 3. access status: users must have - either active,
1.275 raeburn 6594: previous, future, or all.
1.277 albertel 6595: 4. reference to array of permissible roles
1.288 raeburn 6596: 5. reference to array of section restrictions (optional)
6597: 6. reference to results object (hash of hashes).
6598: 7. reference to optional userdata hash
1.609 raeburn 6599: 8. reference to optional statushash
1.630 raeburn 6600: 9. flag if privileged users (except those set to unhide in
6601: course settings) should be excluded
1.609 raeburn 6602: Keys of top level results hash are roles.
1.275 raeburn 6603: Keys of inner hashes are username:domain, with
6604: values set to access type.
1.288 raeburn 6605: Optional userdata hash returns an array with arguments in the
6606: same order as loncoursedata::get_classlist() for student data.
6607:
1.609 raeburn 6608: Optional statushash returns
6609:
1.288 raeburn 6610: Entries for end, start, section and status are blank because
6611: of the possibility of multiple values for non-student roles.
6612:
1.275 raeburn 6613: =cut
1.405 albertel 6614:
1.275 raeburn 6615: ###############################################
1.405 albertel 6616:
1.275 raeburn 6617: sub get_course_users {
1.630 raeburn 6618: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6619: my %idx = ();
1.419 raeburn 6620: my %seclists;
1.288 raeburn 6621:
6622: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6623: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6624: $idx{end} = &Apache::loncoursedata::CL_END();
6625: $idx{start} = &Apache::loncoursedata::CL_START();
6626: $idx{id} = &Apache::loncoursedata::CL_ID();
6627: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6628: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6629: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6630:
1.290 albertel 6631: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6632: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6633: my $now = time;
1.277 albertel 6634: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6635: my $match = 0;
1.412 raeburn 6636: my $secmatch = 0;
1.419 raeburn 6637: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6638: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6639: if ($section eq '') {
6640: $section = 'none';
6641: }
1.291 albertel 6642: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6643: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6644: $secmatch = 1;
6645: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6646: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6647: $secmatch = 1;
6648: }
6649: } else {
1.419 raeburn 6650: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6651: $secmatch = 1;
6652: }
1.290 albertel 6653: }
1.412 raeburn 6654: if (!$secmatch) {
6655: next;
6656: }
1.419 raeburn 6657: }
1.275 raeburn 6658: if (defined($$types{'active'})) {
1.288 raeburn 6659: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6660: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6661: $match = 1;
1.275 raeburn 6662: }
6663: }
6664: if (defined($$types{'previous'})) {
1.609 raeburn 6665: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6666: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6667: $match = 1;
1.275 raeburn 6668: }
6669: }
6670: if (defined($$types{'future'})) {
1.609 raeburn 6671: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6672: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6673: $match = 1;
1.275 raeburn 6674: }
6675: }
1.609 raeburn 6676: if ($match) {
6677: push(@{$seclists{$student}},$section);
6678: if (ref($userdata) eq 'HASH') {
6679: $$userdata{$student} = $$classlist{$student};
6680: }
6681: if (ref($statushash) eq 'HASH') {
6682: $statushash->{$student}{'st'}{$section} = $status;
6683: }
1.288 raeburn 6684: }
1.275 raeburn 6685: }
6686: }
1.412 raeburn 6687: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6688: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6689: my $now = time;
1.609 raeburn 6690: my %displaystatus = ( previous => 'Expired',
6691: active => 'Active',
6692: future => 'Future',
6693: );
1.630 raeburn 6694: my %nothide;
6695: if ($hidepriv) {
6696: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6697: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6698: if ($user !~ /:/) {
6699: $nothide{join(':',split(/[\@]/,$user))}=1;
6700: } else {
6701: $nothide{$user} = 1;
6702: }
6703: }
6704: }
1.439 raeburn 6705: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6706: my $match = 0;
1.412 raeburn 6707: my $secmatch = 0;
1.439 raeburn 6708: my $status;
1.412 raeburn 6709: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6710: $user =~ s/:$//;
1.439 raeburn 6711: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6712: if ($end == -1 || $start == -1) {
6713: next;
6714: }
6715: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6716: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6717: my ($uname,$udom) = split(/:/,$user);
6718: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6719: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6720: $secmatch = 1;
6721: } elsif ($usec eq '') {
1.420 albertel 6722: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6723: $secmatch = 1;
6724: }
6725: } else {
6726: if (grep(/^\Q$usec\E$/,@{$sections})) {
6727: $secmatch = 1;
6728: }
6729: }
6730: if (!$secmatch) {
6731: next;
6732: }
1.288 raeburn 6733: }
1.419 raeburn 6734: if ($usec eq '') {
6735: $usec = 'none';
6736: }
1.275 raeburn 6737: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6738: if ($hidepriv) {
6739: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6740: (!$nothide{$uname.':'.$udom})) {
6741: next;
6742: }
6743: }
1.503 raeburn 6744: if ($end > 0 && $end < $now) {
1.439 raeburn 6745: $status = 'previous';
6746: } elsif ($start > $now) {
6747: $status = 'future';
6748: } else {
6749: $status = 'active';
6750: }
1.277 albertel 6751: foreach my $type (keys(%{$types})) {
1.275 raeburn 6752: if ($status eq $type) {
1.420 albertel 6753: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6754: push(@{$$users{$role}{$user}},$type);
6755: }
1.288 raeburn 6756: $match = 1;
6757: }
6758: }
1.419 raeburn 6759: if (($match) && (ref($userdata) eq 'HASH')) {
6760: if (!exists($$userdata{$uname.':'.$udom})) {
6761: &get_user_info($udom,$uname,\%idx,$userdata);
6762: }
1.420 albertel 6763: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6764: push(@{$seclists{$uname.':'.$udom}},$usec);
6765: }
1.609 raeburn 6766: if (ref($statushash) eq 'HASH') {
6767: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6768: }
1.275 raeburn 6769: }
6770: }
6771: }
6772: }
1.290 albertel 6773: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6774: if ((defined($cdom)) && (defined($cnum))) {
6775: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6776: if ( defined($csettings{'internal.courseowner'}) ) {
6777: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6778: next if ($owner eq '');
6779: my ($ownername,$ownerdom);
6780: if ($owner =~ /^([^:]+):([^:]+)$/) {
6781: $ownername = $1;
6782: $ownerdom = $2;
6783: } else {
6784: $ownername = $owner;
6785: $ownerdom = $cdom;
6786: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6787: }
6788: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6789: if (defined($userdata) &&
1.609 raeburn 6790: !exists($$userdata{$owner})) {
6791: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6792: if (!grep(/^none$/,@{$seclists{$owner}})) {
6793: push(@{$seclists{$owner}},'none');
6794: }
6795: if (ref($statushash) eq 'HASH') {
6796: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6797: }
1.290 albertel 6798: }
1.279 raeburn 6799: }
6800: }
6801: }
1.419 raeburn 6802: foreach my $user (keys(%seclists)) {
6803: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6804: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6805: }
1.275 raeburn 6806: }
6807: return;
6808: }
6809:
1.288 raeburn 6810: sub get_user_info {
6811: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6812: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6813: &plainname($uname,$udom,'lastname');
1.291 albertel 6814: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6815: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6816: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6817: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6818: return;
6819: }
1.275 raeburn 6820:
1.472 raeburn 6821: ###############################################
6822:
6823: =pod
6824:
6825: =item * &get_user_quota()
6826:
6827: Retrieves quota assigned for storage of portfolio files for a user
6828:
6829: Incoming parameters:
6830: 1. user's username
6831: 2. user's domain
6832:
6833: Returns:
1.536 raeburn 6834: 1. Disk quota (in Mb) assigned to student.
6835: 2. (Optional) Type of setting: custom or default
6836: (individually assigned or default for user's
6837: institutional status).
6838: 3. (Optional) - User's institutional status (e.g., faculty, staff
6839: or student - types as defined in localenroll::inst_usertypes
6840: for user's domain, which determines default quota for user.
6841: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6842:
6843: If a value has been stored in the user's environment,
1.536 raeburn 6844: it will return that, otherwise it returns the maximal default
6845: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6846:
6847: =cut
6848:
6849: ###############################################
6850:
6851:
6852: sub get_user_quota {
6853: my ($uname,$udom) = @_;
1.536 raeburn 6854: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6855: if (!defined($udom)) {
6856: $udom = $env{'user.domain'};
6857: }
6858: if (!defined($uname)) {
6859: $uname = $env{'user.name'};
6860: }
6861: if (($udom eq '' || $uname eq '') ||
6862: ($udom eq 'public') && ($uname eq 'public')) {
6863: $quota = 0;
1.536 raeburn 6864: $quotatype = 'default';
6865: $defquota = 0;
1.472 raeburn 6866: } else {
1.536 raeburn 6867: my $inststatus;
1.472 raeburn 6868: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6869: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6870: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6871: } else {
1.536 raeburn 6872: my %userenv =
6873: &Apache::lonnet::get('environment',['portfolioquota',
6874: 'inststatus'],$udom,$uname);
1.472 raeburn 6875: my ($tmp) = keys(%userenv);
6876: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6877: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6878: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6879: } else {
6880: undef(%userenv);
6881: }
6882: }
1.536 raeburn 6883: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6884: if ($quota eq '') {
1.536 raeburn 6885: $quota = $defquota;
6886: $quotatype = 'default';
6887: } else {
6888: $quotatype = 'custom';
1.472 raeburn 6889: }
6890: }
1.536 raeburn 6891: if (wantarray) {
6892: return ($quota,$quotatype,$settingstatus,$defquota);
6893: } else {
6894: return $quota;
6895: }
1.472 raeburn 6896: }
6897:
6898: ###############################################
6899:
6900: =pod
6901:
6902: =item * &default_quota()
6903:
1.536 raeburn 6904: Retrieves default quota assigned for storage of user portfolio files,
6905: given an (optional) user's institutional status.
1.472 raeburn 6906:
6907: Incoming parameters:
6908: 1. domain
1.536 raeburn 6909: 2. (Optional) institutional status(es). This is a : separated list of
6910: status types (e.g., faculty, staff, student etc.)
6911: which apply to the user for whom the default is being retrieved.
6912: If the institutional status string in undefined, the domain
6913: default quota will be returned.
1.472 raeburn 6914:
6915: Returns:
6916: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6917: 2. (Optional) institutional type which determined the value of the
6918: default quota.
1.472 raeburn 6919:
6920: If a value has been stored in the domain's configuration db,
6921: it will return that, otherwise it returns 20 (for backwards
6922: compatibility with domains which have not set up a configuration
6923: db file; the original statically defined portfolio quota was 20 Mb).
6924:
1.536 raeburn 6925: If the user's status includes multiple types (e.g., staff and student),
6926: the largest default quota which applies to the user determines the
6927: default quota returned.
6928:
1.472 raeburn 6929: =cut
6930:
6931: ###############################################
6932:
6933:
6934: sub default_quota {
1.536 raeburn 6935: my ($udom,$inststatus) = @_;
6936: my ($defquota,$settingstatus);
6937: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6938: ['quotas'],$udom);
6939: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6940: if ($inststatus ne '') {
6941: my @statuses = split(/:/,$inststatus);
6942: foreach my $item (@statuses) {
1.711 raeburn 6943: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
6944: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
6945: if ($defquota eq '') {
6946: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
6947: $settingstatus = $item;
6948: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
6949: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
6950: $settingstatus = $item;
6951: }
6952: }
6953: } else {
6954: if ($quotahash{'quotas'}{$item} ne '') {
6955: if ($defquota eq '') {
6956: $defquota = $quotahash{'quotas'}{$item};
6957: $settingstatus = $item;
6958: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
6959: $defquota = $quotahash{'quotas'}{$item};
6960: $settingstatus = $item;
6961: }
1.536 raeburn 6962: }
6963: }
6964: }
6965: }
6966: if ($defquota eq '') {
1.711 raeburn 6967: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
6968: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
6969: } else {
6970: $defquota = $quotahash{'quotas'}{'default'};
6971: }
1.536 raeburn 6972: $settingstatus = 'default';
6973: }
6974: } else {
6975: $settingstatus = 'default';
6976: $defquota = 20;
6977: }
6978: if (wantarray) {
6979: return ($defquota,$settingstatus);
1.472 raeburn 6980: } else {
1.536 raeburn 6981: return $defquota;
1.472 raeburn 6982: }
6983: }
6984:
1.384 raeburn 6985: sub get_secgrprole_info {
6986: my ($cdom,$cnum,$needroles,$type) = @_;
6987: my %sections_count = &get_sections($cdom,$cnum);
6988: my @sections = (sort {$a <=> $b} keys(%sections_count));
6989: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6990: my @groups = sort(keys(%curr_groups));
6991: my $allroles = [];
6992: my $rolehash;
6993: my $accesshash = {
6994: active => 'Currently has access',
6995: future => 'Will have future access',
6996: previous => 'Previously had access',
6997: };
6998: if ($needroles) {
6999: $rolehash = {'all' => 'all'};
1.385 albertel 7000: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7001: if (&Apache::lonnet::error(%user_roles)) {
7002: undef(%user_roles);
7003: }
7004: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7005: my ($role)=split(/\:/,$item,2);
7006: if ($role eq 'cr') { next; }
7007: if ($role =~ /^cr/) {
7008: $$rolehash{$role} = (split('/',$role))[3];
7009: } else {
7010: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7011: }
7012: }
7013: foreach my $key (sort(keys(%{$rolehash}))) {
7014: push(@{$allroles},$key);
7015: }
7016: push (@{$allroles},'st');
7017: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7018: }
7019: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7020: }
7021:
1.555 raeburn 7022: sub user_picker {
1.627 raeburn 7023: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7024: my $currdom = $dom;
7025: my %curr_selected = (
7026: srchin => 'dom',
1.580 raeburn 7027: srchby => 'lastname',
1.555 raeburn 7028: );
7029: my $srchterm;
1.625 raeburn 7030: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7031: if ($srch->{'srchby'} ne '') {
7032: $curr_selected{'srchby'} = $srch->{'srchby'};
7033: }
7034: if ($srch->{'srchin'} ne '') {
7035: $curr_selected{'srchin'} = $srch->{'srchin'};
7036: }
7037: if ($srch->{'srchtype'} ne '') {
7038: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7039: }
7040: if ($srch->{'srchdomain'} ne '') {
7041: $currdom = $srch->{'srchdomain'};
7042: }
7043: $srchterm = $srch->{'srchterm'};
7044: }
7045: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7046: 'usr' => 'Search criteria',
1.563 raeburn 7047: 'doma' => 'Domain/institution to search',
1.558 albertel 7048: 'uname' => 'username',
7049: 'lastname' => 'last name',
1.555 raeburn 7050: 'lastfirst' => 'last name, first name',
1.558 albertel 7051: 'crs' => 'in this course',
1.576 raeburn 7052: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7053: 'alc' => 'all LON-CAPA',
1.573 raeburn 7054: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7055: 'exact' => 'is',
7056: 'contains' => 'contains',
1.569 raeburn 7057: 'begins' => 'begins with',
1.571 raeburn 7058: 'youm' => "You must include some text to search for.",
7059: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7060: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7061: 'yomc' => "You must choose a domain when using an institutional directory search.",
7062: 'ymcd' => "You must choose a domain when using a domain search.",
7063: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7064: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7065: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7066: );
1.563 raeburn 7067: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7068: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7069:
7070: my @srchins = ('crs','dom','alc','instd');
7071:
7072: foreach my $option (@srchins) {
7073: # FIXME 'alc' option unavailable until
7074: # loncreateuser::print_user_query_page()
7075: # has been completed.
7076: next if ($option eq 'alc');
7077: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7078: if ($curr_selected{'srchin'} eq $option) {
7079: $srchinsel .= '
7080: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7081: } else {
7082: $srchinsel .= '
7083: <option value="'.$option.'">'.$lt{$option}.'</option>';
7084: }
1.555 raeburn 7085: }
1.563 raeburn 7086: $srchinsel .= "\n </select>\n";
1.555 raeburn 7087:
7088: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7089: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7090: if ($curr_selected{'srchby'} eq $option) {
7091: $srchbysel .= '
7092: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7093: } else {
7094: $srchbysel .= '
7095: <option value="'.$option.'">'.$lt{$option}.'</option>';
7096: }
7097: }
7098: $srchbysel .= "\n </select>\n";
7099:
7100: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7101: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7102: if ($curr_selected{'srchtype'} eq $option) {
7103: $srchtypesel .= '
7104: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7105: } else {
7106: $srchtypesel .= '
7107: <option value="'.$option.'">'.$lt{$option}.'</option>';
7108: }
7109: }
7110: $srchtypesel .= "\n </select>\n";
7111:
1.558 albertel 7112: my ($newuserscript,$new_user_create);
1.556 raeburn 7113:
7114: if ($forcenewuser) {
1.576 raeburn 7115: if (ref($srch) eq 'HASH') {
7116: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7117: if ($cancreate) {
7118: $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>';
7119: } else {
7120: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
7121: my %usertypetext = (
7122: official => 'institutional',
7123: unofficial => 'non-institutional',
7124: );
7125: $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 />';
7126: }
1.576 raeburn 7127: }
7128: }
7129:
1.556 raeburn 7130: $newuserscript = <<"ENDSCRIPT";
7131:
1.570 raeburn 7132: function setSearch(createnew,callingForm) {
1.556 raeburn 7133: if (createnew == 1) {
1.570 raeburn 7134: for (var i=0; i<callingForm.srchby.length; i++) {
7135: if (callingForm.srchby.options[i].value == 'uname') {
7136: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7137: }
7138: }
1.570 raeburn 7139: for (var i=0; i<callingForm.srchin.length; i++) {
7140: if ( callingForm.srchin.options[i].value == 'dom') {
7141: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7142: }
7143: }
1.570 raeburn 7144: for (var i=0; i<callingForm.srchtype.length; i++) {
7145: if (callingForm.srchtype.options[i].value == 'exact') {
7146: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7147: }
7148: }
1.570 raeburn 7149: for (var i=0; i<callingForm.srchdomain.length; i++) {
7150: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7151: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7152: }
7153: }
7154: }
7155: }
7156: ENDSCRIPT
1.558 albertel 7157:
1.556 raeburn 7158: }
7159:
1.555 raeburn 7160: my $output = <<"END_BLOCK";
1.556 raeburn 7161: <script type="text/javascript">
1.570 raeburn 7162: function validateEntry(callingForm) {
1.558 albertel 7163:
1.556 raeburn 7164: var checkok = 1;
1.558 albertel 7165: var srchin;
1.570 raeburn 7166: for (var i=0; i<callingForm.srchin.length; i++) {
7167: if ( callingForm.srchin[i].checked ) {
7168: srchin = callingForm.srchin[i].value;
1.558 albertel 7169: }
7170: }
7171:
1.570 raeburn 7172: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7173: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7174: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7175: var srchterm = callingForm.srchterm.value;
7176: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7177: var msg = "";
7178:
7179: if (srchterm == "") {
7180: checkok = 0;
1.571 raeburn 7181: msg += "$lt{'youm'}\\n";
1.556 raeburn 7182: }
7183:
1.569 raeburn 7184: if (srchtype== 'begins') {
7185: if (srchterm.length < 2) {
7186: checkok = 0;
1.571 raeburn 7187: msg += "$lt{'thte'}\\n";
1.569 raeburn 7188: }
7189: }
7190:
1.556 raeburn 7191: if (srchtype== 'contains') {
7192: if (srchterm.length < 3) {
7193: checkok = 0;
1.571 raeburn 7194: msg += "$lt{'thet'}\\n";
1.556 raeburn 7195: }
7196: }
7197: if (srchin == 'instd') {
7198: if (srchdomain == '') {
7199: checkok = 0;
1.571 raeburn 7200: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7201: }
7202: }
7203: if (srchin == 'dom') {
7204: if (srchdomain == '') {
7205: checkok = 0;
1.571 raeburn 7206: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7207: }
7208: }
7209: if (srchby == 'lastfirst') {
7210: if (srchterm.indexOf(",") == -1) {
7211: checkok = 0;
1.571 raeburn 7212: msg += "$lt{'whus'}\\n";
1.556 raeburn 7213: }
7214: if (srchterm.indexOf(",") == srchterm.length -1) {
7215: checkok = 0;
1.571 raeburn 7216: msg += "$lt{'whse'}\\n";
1.556 raeburn 7217: }
7218: }
7219: if (checkok == 0) {
1.571 raeburn 7220: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7221: return;
7222: }
7223: if (checkok == 1) {
1.570 raeburn 7224: callingForm.submit();
1.556 raeburn 7225: }
7226: }
7227:
7228: $newuserscript
7229:
7230: </script>
1.558 albertel 7231:
7232: $new_user_create
7233:
1.555 raeburn 7234: <table>
1.558 albertel 7235: <tr>
1.573 raeburn 7236: <td>$lt{'doma'}:</td>
7237: <td>$domform</td>
7238: </td>
7239: </tr>
7240: <tr>
7241: <td>$lt{'usr'}:</td>
1.563 raeburn 7242: <td>$srchbysel
7243: $srchtypesel
7244: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7245: $srchinsel
1.563 raeburn 7246: </td>
7247: </tr>
1.555 raeburn 7248: </table>
7249: <br />
7250: END_BLOCK
1.558 albertel 7251:
1.555 raeburn 7252: return $output;
7253: }
7254:
1.612 raeburn 7255: sub user_rule_check {
1.615 raeburn 7256: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7257: my $response;
7258: if (ref($usershash) eq 'HASH') {
7259: foreach my $user (keys(%{$usershash})) {
7260: my ($uname,$udom) = split(/:/,$user);
7261: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7262: my ($id,$newuser);
1.612 raeburn 7263: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7264: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7265: $id = $usershash->{$user}->{'id'};
7266: }
7267: my $inst_response;
7268: if (ref($checks) eq 'HASH') {
7269: if (defined($checks->{'username'})) {
1.615 raeburn 7270: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7271: &Apache::lonnet::get_instuser($udom,$uname);
7272: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7273: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7274: &Apache::lonnet::get_instuser($udom,undef,$id);
7275: }
1.615 raeburn 7276: } else {
7277: ($inst_response,%{$inst_results->{$user}}) =
7278: &Apache::lonnet::get_instuser($udom,$uname);
7279: return;
1.612 raeburn 7280: }
1.615 raeburn 7281: if (!$got_rules->{$udom}) {
1.612 raeburn 7282: my %domconfig = &Apache::lonnet::get_dom('configuration',
7283: ['usercreation'],$udom);
7284: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7285: foreach my $item ('username','id') {
1.612 raeburn 7286: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7287: $$curr_rules{$udom}{$item} =
7288: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7289: }
7290: }
7291: }
1.615 raeburn 7292: $got_rules->{$udom} = 1;
1.585 raeburn 7293: }
1.612 raeburn 7294: foreach my $item (keys(%{$checks})) {
7295: if (ref($$curr_rules{$udom}) eq 'HASH') {
7296: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7297: if (@{$$curr_rules{$udom}{$item}} > 0) {
7298: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7299: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7300: if ($rule_check{$rule}) {
7301: $$rulematch{$user}{$item} = $rule;
7302: if ($inst_response eq 'ok') {
1.615 raeburn 7303: if (ref($inst_results) eq 'HASH') {
7304: if (ref($inst_results->{$user}) eq 'HASH') {
7305: if (keys(%{$inst_results->{$user}}) == 0) {
7306: $$alerts{$item}{$udom}{$uname} = 1;
7307: }
1.612 raeburn 7308: }
7309: }
1.615 raeburn 7310: }
7311: last;
1.585 raeburn 7312: }
7313: }
7314: }
7315: }
7316: }
7317: }
7318: }
7319: }
1.612 raeburn 7320: return;
7321: }
7322:
7323: sub user_rule_formats {
7324: my ($domain,$domdesc,$curr_rules,$check) = @_;
7325: my %text = (
7326: 'username' => 'Usernames',
7327: 'id' => 'IDs',
7328: );
7329: my $output;
7330: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7331: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7332: if (@{$ruleorder} > 0) {
7333: $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>';
7334: foreach my $rule (@{$ruleorder}) {
7335: if (ref($curr_rules) eq 'ARRAY') {
7336: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7337: if (ref($rules->{$rule}) eq 'HASH') {
7338: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7339: $rules->{$rule}{'desc'}.'</li>';
7340: }
7341: }
7342: }
7343: }
7344: $output .= '</ul>';
7345: }
7346: }
7347: return $output;
7348: }
7349:
7350: sub instrule_disallow_msg {
1.615 raeburn 7351: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7352: my $response;
7353: my %text = (
7354: item => 'username',
7355: items => 'usernames',
7356: match => 'matches',
7357: do => 'does',
7358: action => 'a username',
7359: one => 'one',
7360: );
7361: if ($count > 1) {
7362: $text{'item'} = 'usernames';
7363: $text{'match'} ='match';
7364: $text{'do'} = 'do';
7365: $text{'action'} = 'usernames',
7366: $text{'one'} = 'ones';
7367: }
7368: if ($checkitem eq 'id') {
7369: $text{'items'} = 'IDs';
7370: $text{'item'} = 'ID';
7371: $text{'action'} = 'an ID';
1.615 raeburn 7372: if ($count > 1) {
7373: $text{'item'} = 'IDs';
7374: $text{'action'} = 'IDs';
7375: }
1.612 raeburn 7376: }
1.674 bisitz 7377: $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 7378: if ($mode eq 'upload') {
7379: if ($checkitem eq 'username') {
7380: $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'}.");
7381: } elsif ($checkitem eq 'id') {
1.674 bisitz 7382: $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 7383: }
1.669 raeburn 7384: } elsif ($mode eq 'selfcreate') {
7385: if ($checkitem eq 'id') {
7386: $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.");
7387: }
1.615 raeburn 7388: } else {
7389: if ($checkitem eq 'username') {
7390: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7391: } elsif ($checkitem eq 'id') {
7392: $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.");
7393: }
1.612 raeburn 7394: }
7395: return $response;
1.585 raeburn 7396: }
7397:
1.624 raeburn 7398: sub personal_data_fieldtitles {
7399: my %fieldtitles = &Apache::lonlocal::texthash (
7400: id => 'Student/Employee ID',
7401: permanentemail => 'E-mail address',
7402: lastname => 'Last Name',
7403: firstname => 'First Name',
7404: middlename => 'Middle Name',
7405: generation => 'Generation',
7406: gen => 'Generation',
7407: );
7408: return %fieldtitles;
7409: }
7410:
1.642 raeburn 7411: sub sorted_inst_types {
7412: my ($dom) = @_;
7413: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7414: my $othertitle = &mt('All users');
7415: if ($env{'request.course.id'}) {
1.668 raeburn 7416: $othertitle = &mt('Any users');
1.642 raeburn 7417: }
7418: my @types;
7419: if (ref($order) eq 'ARRAY') {
7420: @types = @{$order};
7421: }
7422: if (@types == 0) {
7423: if (ref($usertypes) eq 'HASH') {
7424: @types = sort(keys(%{$usertypes}));
7425: }
7426: }
7427: if (keys(%{$usertypes}) > 0) {
7428: $othertitle = &mt('Other users');
7429: }
7430: return ($othertitle,$usertypes,\@types);
7431: }
7432:
1.645 raeburn 7433: sub get_institutional_codes {
7434: my ($settings,$allcourses,$LC_code) = @_;
7435: # Get complete list of course sections to update
7436: my @currsections = ();
7437: my @currxlists = ();
7438: my $coursecode = $$settings{'internal.coursecode'};
7439:
7440: if ($$settings{'internal.sectionnums'} ne '') {
7441: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7442: }
7443:
7444: if ($$settings{'internal.crosslistings'} ne '') {
7445: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7446: }
7447:
7448: if (@currxlists > 0) {
7449: foreach (@currxlists) {
7450: if (m/^([^:]+):(\w*)$/) {
7451: unless (grep/^$1$/,@{$allcourses}) {
7452: push @{$allcourses},$1;
7453: $$LC_code{$1} = $2;
7454: }
7455: }
7456: }
7457: }
7458:
7459: if (@currsections > 0) {
7460: foreach (@currsections) {
7461: if (m/^(\w+):(\w*)$/) {
7462: my $sec = $coursecode.$1;
7463: my $lc_sec = $2;
7464: unless (grep/^$sec$/,@{$allcourses}) {
7465: push @{$allcourses},$sec;
7466: $$LC_code{$sec} = $lc_sec;
7467: }
7468: }
7469: }
7470: }
7471: return;
7472: }
7473:
1.112 bowersj2 7474: =pod
7475:
1.549 albertel 7476: =back
7477:
7478: =head1 HTTP Helpers
7479:
7480: =over 4
7481:
1.648 raeburn 7482: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7483:
1.258 albertel 7484: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7485: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7486: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7487:
7488: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7489: $possible_names is an ref to an array of form element names. As an example:
7490: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7491: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7492:
7493: =cut
1.1 albertel 7494:
1.6 albertel 7495: sub get_unprocessed_cgi {
1.25 albertel 7496: my ($query,$possible_names)= @_;
1.26 matthew 7497: # $Apache::lonxml::debug=1;
1.356 albertel 7498: foreach my $pair (split(/&/,$query)) {
7499: my ($name, $value) = split(/=/,$pair);
1.369 www 7500: $name = &unescape($name);
1.25 albertel 7501: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7502: $value =~ tr/+/ /;
7503: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7504: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7505: }
1.16 harris41 7506: }
1.6 albertel 7507: }
7508:
1.112 bowersj2 7509: =pod
7510:
1.648 raeburn 7511: =item * &cacheheader()
1.112 bowersj2 7512:
7513: returns cache-controlling header code
7514:
7515: =cut
7516:
1.7 albertel 7517: sub cacheheader {
1.258 albertel 7518: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7519: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7520: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7521: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7522: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7523: return $output;
1.7 albertel 7524: }
7525:
1.112 bowersj2 7526: =pod
7527:
1.648 raeburn 7528: =item * &no_cache($r)
1.112 bowersj2 7529:
7530: specifies header code to not have cache
7531:
7532: =cut
7533:
1.9 albertel 7534: sub no_cache {
1.216 albertel 7535: my ($r) = @_;
7536: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7537: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7538: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7539: $r->no_cache(1);
7540: $r->header_out("Expires" => $date);
7541: $r->header_out("Pragma" => "no-cache");
1.123 www 7542: }
7543:
7544: sub content_type {
1.181 albertel 7545: my ($r,$type,$charset) = @_;
1.299 foxr 7546: if ($r) {
7547: # Note that printout.pl calls this with undef for $r.
7548: &no_cache($r);
7549: }
1.258 albertel 7550: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7551: unless ($charset) {
7552: $charset=&Apache::lonlocal::current_encoding;
7553: }
7554: if ($charset) { $type.='; charset='.$charset; }
7555: if ($r) {
7556: $r->content_type($type);
7557: } else {
7558: print("Content-type: $type\n\n");
7559: }
1.9 albertel 7560: }
1.25 albertel 7561:
1.112 bowersj2 7562: =pod
7563:
1.648 raeburn 7564: =item * &add_to_env($name,$value)
1.112 bowersj2 7565:
1.258 albertel 7566: adds $name to the %env hash with value
1.112 bowersj2 7567: $value, if $name already exists, the entry is converted to an array
7568: reference and $value is added to the array.
7569:
7570: =cut
7571:
1.25 albertel 7572: sub add_to_env {
7573: my ($name,$value)=@_;
1.258 albertel 7574: if (defined($env{$name})) {
7575: if (ref($env{$name})) {
1.25 albertel 7576: #already have multiple values
1.258 albertel 7577: push(@{ $env{$name} },$value);
1.25 albertel 7578: } else {
7579: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7580: my $first=$env{$name};
7581: undef($env{$name});
7582: push(@{ $env{$name} },$first,$value);
1.25 albertel 7583: }
7584: } else {
1.258 albertel 7585: $env{$name}=$value;
1.25 albertel 7586: }
1.31 albertel 7587: }
1.149 albertel 7588:
7589: =pod
7590:
1.648 raeburn 7591: =item * &get_env_multiple($name)
1.149 albertel 7592:
1.258 albertel 7593: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7594: values may be defined and end up as an array ref.
7595:
7596: returns an array of values
7597:
7598: =cut
7599:
7600: sub get_env_multiple {
7601: my ($name) = @_;
7602: my @values;
1.258 albertel 7603: if (defined($env{$name})) {
1.149 albertel 7604: # exists is it an array
1.258 albertel 7605: if (ref($env{$name})) {
7606: @values=@{ $env{$name} };
1.149 albertel 7607: } else {
1.258 albertel 7608: $values[0]=$env{$name};
1.149 albertel 7609: }
7610: }
7611: return(@values);
7612: }
7613:
1.660 raeburn 7614: sub ask_for_embedded_content {
7615: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7616: my $upload_output = '
7617: <form name="upload_embedded" action="'.$actionurl.'"
7618: method="post" enctype="multipart/form-data">';
7619: $upload_output .= $state;
1.661 raeburn 7620: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7621:
7622: my $num = 0;
7623: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7624: $upload_output .= &start_data_table_row().
7625: '<td>'.$embed_file.'</td><td>';
7626: if ($args->{'ignore_remote_references'}
7627: && $embed_file =~ m{^\w+://}) {
7628: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7629: } elsif ($args->{'error_on_invalid_names'}
7630: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7631:
7632: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7633:
7634: } else {
7635: $upload_output .='
1.661 raeburn 7636: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7637: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7638: my $attrib = join(':',@{$$allfiles{$embed_file}});
7639: $upload_output .=
7640: "\n\t\t".
7641: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7642: $attrib.'" />';
7643: if (exists($$codebase{$embed_file})) {
7644: $upload_output .=
7645: "\n\t\t".
7646: '<input name="codebase_'.$num.'" type="hidden" value="'.
7647: &escape($$codebase{$embed_file}).'" />';
7648: }
7649: }
7650: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7651: $num++;
7652: }
7653: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7654: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7655: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7656: '.&mt('(only files for which a location has been provided will be uploaded)').'
7657: </form>';
7658: return $upload_output;
7659: }
7660:
1.661 raeburn 7661: sub upload_embedded {
7662: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7663: $current_disk_usage) = @_;
7664: my $output;
7665: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7666: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7667: my $orig_uploaded_filename =
7668: $env{'form.embedded_item_'.$i.'.filename'};
7669:
7670: $env{'form.embedded_orig_'.$i} =
7671: &unescape($env{'form.embedded_orig_'.$i});
7672: my ($path,$fname) =
7673: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7674: # no path, whole string is fname
7675: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7676:
7677: $path = $env{'form.currentpath'}.$path;
7678: $fname = &Apache::lonnet::clean_filename($fname);
7679: # See if there is anything left
7680: next if ($fname eq '');
7681:
7682: # Check if file already exists as a file or directory.
7683: my ($state,$msg);
7684: if ($context eq 'portfolio') {
7685: my $port_path = $dirpath;
7686: if ($group ne '') {
7687: $port_path = "groups/$group/$port_path";
7688: }
7689: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7690: $dir_root,$port_path,$disk_quota,
7691: $current_disk_usage,$uname,$udom);
7692: if ($state eq 'will_exceed_quota'
7693: || $state eq 'file_locked'
7694: || $state eq 'file_exists' ) {
7695: $output .= $msg;
7696: next;
7697: }
7698: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7699: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7700: if ($state eq 'exists') {
7701: $output .= $msg;
7702: next;
7703: }
7704: }
7705: # Check if extension is valid
7706: if (($fname =~ /\.(\w+)$/) &&
7707: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7708: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7709: next;
7710: } elsif (($fname =~ /\.(\w+)$/) &&
7711: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7712: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7713: next;
7714: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7715: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7716: next;
7717: }
7718:
7719: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7720: if ($context eq 'portfolio') {
7721: my $result=
7722: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7723: $dirpath.$path);
7724: if ($result !~ m|^/uploaded/|) {
7725: $output .= '<span class="LC_error">'
7726: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7727: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7728: .'</span><br />';
7729: next;
7730: } else {
7731: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7732: $path.$fname.'</span>').'</p>';
7733: }
7734: } else {
7735: # Save the file
7736: my $target = $env{'form.embedded_item_'.$i};
7737: my $fullpath = $dir_root.$dirpath.'/'.$path;
7738: my $dest = $fullpath.$fname;
7739: my $url = $url_root.$dirpath.'/'.$path.$fname;
7740: my @parts=split(/\//,$fullpath);
7741: my $count;
7742: my $filepath = $dir_root;
7743: for ($count=4;$count<=$#parts;$count++) {
7744: $filepath .= "/$parts[$count]";
7745: if ((-e $filepath)!=1) {
7746: mkdir($filepath,0770);
7747: }
7748: }
7749: my $fh;
7750: if (!open($fh,'>'.$dest)) {
7751: &Apache::lonnet::logthis('Failed to create '.$dest);
7752: $output .= '<span class="LC_error">'.
7753: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7754: '</span><br />';
7755: } else {
7756: if (!print $fh $env{'form.embedded_item_'.$i}) {
7757: &Apache::lonnet::logthis('Failed to write to '.$dest);
7758: $output .= '<span class="LC_error">'.
7759: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7760: '</span><br />';
7761: } else {
7762: if ($context eq 'testbank') {
7763: $output .= &mt('Embedded file uploaded successfully:').
7764: ' <a href="'.$url.'">'.
7765: $orig_uploaded_filename.'</a><br />';
7766: } else {
1.705 tempelho 7767: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7768: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7769: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7770: }
7771: }
7772: close($fh);
7773: }
7774: }
7775: }
7776: return $output;
7777: }
7778:
7779: sub check_for_existing {
7780: my ($path,$fname,$element) = @_;
7781: my ($state,$msg);
7782: if (-d $path.'/'.$fname) {
7783: $state = 'exists';
7784: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7785: } elsif (-e $path.'/'.$fname) {
7786: $state = 'exists';
7787: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7788: }
7789: if ($state eq 'exists') {
7790: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7791: }
7792: return ($state,$msg);
7793: }
7794:
7795: sub check_for_upload {
7796: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7797: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7798: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7799: my $getpropath = 1;
7800: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7801: $getpropath);
7802: my $found_file = 0;
7803: my $locked_file = 0;
7804: foreach my $line (@dir_list) {
7805: my ($file_name)=split(/\&/,$line,2);
7806: if ($file_name eq $fname){
7807: $file_name = $path.$file_name;
7808: if ($group ne '') {
7809: $file_name = $group.$file_name;
7810: }
7811: $found_file = 1;
7812: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7813: $locked_file = 1;
7814: }
7815: }
7816: }
7817: if (($current_disk_usage + $filesize) > $disk_quota){
7818: my $msg = '<span class="LC_error">'.
7819: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7820: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7821: return ('will_exceed_quota',$msg);
7822: } elsif ($found_file) {
7823: if ($locked_file) {
7824: my $msg = '<span class="LC_error">';
7825: $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>');
7826: $msg .= '</span><br />';
7827: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7828: return ('file_locked',$msg);
7829: } else {
7830: my $msg = '<span class="LC_error">';
7831: $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'});
7832: $msg .= '</span>';
7833: $msg .= '<br />';
7834: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7835: return ('file_exists',$msg);
7836: }
7837: }
7838: }
7839:
1.31 albertel 7840:
1.41 ng 7841: =pod
1.45 matthew 7842:
1.464 albertel 7843: =back
1.41 ng 7844:
1.112 bowersj2 7845: =head1 CSV Upload/Handling functions
1.38 albertel 7846:
1.41 ng 7847: =over 4
7848:
1.648 raeburn 7849: =item * &upfile_store($r)
1.41 ng 7850:
7851: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7852: needs $env{'form.upfile'}
1.41 ng 7853: returns $datatoken to be put into hidden field
7854:
7855: =cut
1.31 albertel 7856:
7857: sub upfile_store {
7858: my $r=shift;
1.258 albertel 7859: $env{'form.upfile'}=~s/\r/\n/gs;
7860: $env{'form.upfile'}=~s/\f/\n/gs;
7861: $env{'form.upfile'}=~s/\n+/\n/gs;
7862: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7863:
1.258 albertel 7864: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7865: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7866: {
1.158 raeburn 7867: my $datafile = $r->dir_config('lonDaemons').
7868: '/tmp/'.$datatoken.'.tmp';
7869: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7870: print $fh $env{'form.upfile'};
1.158 raeburn 7871: close($fh);
7872: }
1.31 albertel 7873: }
7874: return $datatoken;
7875: }
7876:
1.56 matthew 7877: =pod
7878:
1.648 raeburn 7879: =item * &load_tmp_file($r)
1.41 ng 7880:
7881: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7882: needs $env{'form.datatoken'},
7883: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7884:
7885: =cut
1.31 albertel 7886:
7887: sub load_tmp_file {
7888: my $r=shift;
7889: my @studentdata=();
7890: {
1.158 raeburn 7891: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7892: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7893: if ( open(my $fh,"<$studentfile") ) {
7894: @studentdata=<$fh>;
7895: close($fh);
7896: }
1.31 albertel 7897: }
1.258 albertel 7898: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7899: }
7900:
1.56 matthew 7901: =pod
7902:
1.648 raeburn 7903: =item * &upfile_record_sep()
1.41 ng 7904:
7905: Separate uploaded file into records
7906: returns array of records,
1.258 albertel 7907: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7908:
7909: =cut
1.31 albertel 7910:
7911: sub upfile_record_sep {
1.258 albertel 7912: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7913: } else {
1.248 albertel 7914: my @records;
1.258 albertel 7915: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7916: if ($line=~/^\s*$/) { next; }
7917: push(@records,$line);
7918: }
7919: return @records;
1.31 albertel 7920: }
7921: }
7922:
1.56 matthew 7923: =pod
7924:
1.648 raeburn 7925: =item * &record_sep($record)
1.41 ng 7926:
1.258 albertel 7927: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7928:
7929: =cut
7930:
1.263 www 7931: sub takeleft {
7932: my $index=shift;
7933: return substr('0000'.$index,-4,4);
7934: }
7935:
1.31 albertel 7936: sub record_sep {
7937: my $record=shift;
7938: my %components=();
1.258 albertel 7939: if ($env{'form.upfiletype'} eq 'xml') {
7940: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7941: my $i=0;
1.356 albertel 7942: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7943: $field=~s/^(\"|\')//;
7944: $field=~s/(\"|\')$//;
1.263 www 7945: $components{&takeleft($i)}=$field;
1.31 albertel 7946: $i++;
7947: }
1.258 albertel 7948: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7949: my $i=0;
1.356 albertel 7950: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7951: $field=~s/^(\"|\')//;
7952: $field=~s/(\"|\')$//;
1.263 www 7953: $components{&takeleft($i)}=$field;
1.31 albertel 7954: $i++;
7955: }
7956: } else {
1.561 www 7957: my $separator=',';
1.480 banghart 7958: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7959: $separator=';';
1.480 banghart 7960: }
1.31 albertel 7961: my $i=0;
1.561 www 7962: # the character we are looking for to indicate the end of a quote or a record
7963: my $looking_for=$separator;
7964: # do not add the characters to the fields
7965: my $ignore=0;
7966: # we just encountered a separator (or the beginning of the record)
7967: my $just_found_separator=1;
7968: # store the field we are working on here
7969: my $field='';
7970: # work our way through all characters in record
7971: foreach my $character ($record=~/(.)/g) {
7972: if ($character eq $looking_for) {
7973: if ($character ne $separator) {
7974: # Found the end of a quote, again looking for separator
7975: $looking_for=$separator;
7976: $ignore=1;
7977: } else {
7978: # Found a separator, store away what we got
7979: $components{&takeleft($i)}=$field;
7980: $i++;
7981: $just_found_separator=1;
7982: $ignore=0;
7983: $field='';
7984: }
7985: next;
7986: }
7987: # single or double quotation marks after a separator indicate beginning of a quote
7988: # we are now looking for the end of the quote and need to ignore separators
7989: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7990: $looking_for=$character;
7991: next;
7992: }
7993: # ignore would be true after we reached the end of a quote
7994: if ($ignore) { next; }
7995: if (($just_found_separator) && ($character=~/\s/)) { next; }
7996: $field.=$character;
7997: $just_found_separator=0;
1.31 albertel 7998: }
1.561 www 7999: # catch the very last entry, since we never encountered the separator
8000: $components{&takeleft($i)}=$field;
1.31 albertel 8001: }
8002: return %components;
8003: }
8004:
1.144 matthew 8005: ######################################################
8006: ######################################################
8007:
1.56 matthew 8008: =pod
8009:
1.648 raeburn 8010: =item * &upfile_select_html()
1.41 ng 8011:
1.144 matthew 8012: Return HTML code to select a file from the users machine and specify
8013: the file type.
1.41 ng 8014:
8015: =cut
8016:
1.144 matthew 8017: ######################################################
8018: ######################################################
1.31 albertel 8019: sub upfile_select_html {
1.144 matthew 8020: my %Types = (
8021: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8022: semisv => &mt('Semicolon separated values'),
1.144 matthew 8023: space => &mt('Space separated'),
8024: tab => &mt('Tabulator separated'),
8025: # xml => &mt('HTML/XML'),
8026: );
8027: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8028: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8029: foreach my $type (sort(keys(%Types))) {
8030: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8031: }
8032: $Str .= "</select>\n";
8033: return $Str;
1.31 albertel 8034: }
8035:
1.301 albertel 8036: sub get_samples {
8037: my ($records,$toget) = @_;
8038: my @samples=({});
8039: my $got=0;
8040: foreach my $rec (@$records) {
8041: my %temp = &record_sep($rec);
8042: if (! grep(/\S/, values(%temp))) { next; }
8043: if (%temp) {
8044: $samples[$got]=\%temp;
8045: $got++;
8046: if ($got == $toget) { last; }
8047: }
8048: }
8049: return \@samples;
8050: }
8051:
1.144 matthew 8052: ######################################################
8053: ######################################################
8054:
1.56 matthew 8055: =pod
8056:
1.648 raeburn 8057: =item * &csv_print_samples($r,$records)
1.41 ng 8058:
8059: Prints a table of sample values from each column uploaded $r is an
8060: Apache Request ref, $records is an arrayref from
8061: &Apache::loncommon::upfile_record_sep
8062:
8063: =cut
8064:
1.144 matthew 8065: ######################################################
8066: ######################################################
1.31 albertel 8067: sub csv_print_samples {
8068: my ($r,$records) = @_;
1.662 bisitz 8069: my $samples = &get_samples($records,5);
1.301 albertel 8070:
1.594 raeburn 8071: $r->print(&mt('Samples').'<br />'.&start_data_table().
8072: &start_data_table_header_row());
1.356 albertel 8073: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8074: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8075: $r->print(&end_data_table_header_row());
1.301 albertel 8076: foreach my $hash (@$samples) {
1.594 raeburn 8077: $r->print(&start_data_table_row());
1.356 albertel 8078: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8079: $r->print('<td>');
1.356 albertel 8080: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8081: $r->print('</td>');
8082: }
1.594 raeburn 8083: $r->print(&end_data_table_row());
1.31 albertel 8084: }
1.594 raeburn 8085: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8086: }
8087:
1.144 matthew 8088: ######################################################
8089: ######################################################
8090:
1.56 matthew 8091: =pod
8092:
1.648 raeburn 8093: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8094:
8095: Prints a table to create associations between values and table columns.
1.144 matthew 8096:
1.41 ng 8097: $r is an Apache Request ref,
8098: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8099: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8100:
8101: =cut
8102:
1.144 matthew 8103: ######################################################
8104: ######################################################
1.31 albertel 8105: sub csv_print_select_table {
8106: my ($r,$records,$d) = @_;
1.301 albertel 8107: my $i=0;
8108: my $samples = &get_samples($records,1);
1.144 matthew 8109: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8110: &start_data_table().&start_data_table_header_row().
1.144 matthew 8111: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8112: '<th>'.&mt('Column').'</th>'.
8113: &end_data_table_header_row()."\n");
1.356 albertel 8114: foreach my $array_ref (@$d) {
8115: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8116: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8117:
8118: $r->print('<td><select name=f'.$i.
1.32 matthew 8119: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8120: $r->print('<option value="none"></option>');
1.356 albertel 8121: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8122: $r->print('<option value="'.$sample.'"'.
8123: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8124: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8125: }
1.594 raeburn 8126: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8127: $i++;
8128: }
1.594 raeburn 8129: $r->print(&end_data_table());
1.31 albertel 8130: $i--;
8131: return $i;
8132: }
1.56 matthew 8133:
1.144 matthew 8134: ######################################################
8135: ######################################################
8136:
1.56 matthew 8137: =pod
1.31 albertel 8138:
1.648 raeburn 8139: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8140:
8141: Prints a table of sample values from the upload and can make associate samples to internal names.
8142:
8143: $r is an Apache Request ref,
8144: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8145: $d is an array of 2 element arrays (internal name, displayed name)
8146:
8147: =cut
8148:
1.144 matthew 8149: ######################################################
8150: ######################################################
1.31 albertel 8151: sub csv_samples_select_table {
8152: my ($r,$records,$d) = @_;
8153: my $i=0;
1.144 matthew 8154: #
1.662 bisitz 8155: my $max_samples = 5;
8156: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8157: $r->print(&start_data_table().
8158: &start_data_table_header_row().'<th>'.
8159: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8160: &end_data_table_header_row());
1.301 albertel 8161:
8162: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8163: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8164: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8165: foreach my $option (@$d) {
8166: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8167: $r->print('<option value="'.$value.'"'.
1.253 albertel 8168: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8169: $display.'</option>');
1.31 albertel 8170: }
8171: $r->print('</select></td><td>');
1.662 bisitz 8172: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8173: if (defined($samples->[$line]{$key})) {
8174: $r->print($samples->[$line]{$key}."<br />\n");
8175: }
8176: }
1.594 raeburn 8177: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8178: $i++;
8179: }
1.594 raeburn 8180: $r->print(&end_data_table());
1.31 albertel 8181: $i--;
8182: return($i);
1.115 matthew 8183: }
8184:
1.144 matthew 8185: ######################################################
8186: ######################################################
8187:
1.115 matthew 8188: =pod
8189:
1.648 raeburn 8190: =item * &clean_excel_name($name)
1.115 matthew 8191:
8192: Returns a replacement for $name which does not contain any illegal characters.
8193:
8194: =cut
8195:
1.144 matthew 8196: ######################################################
8197: ######################################################
1.115 matthew 8198: sub clean_excel_name {
8199: my ($name) = @_;
8200: $name =~ s/[:\*\?\/\\]//g;
8201: if (length($name) > 31) {
8202: $name = substr($name,0,31);
8203: }
8204: return $name;
1.25 albertel 8205: }
1.84 albertel 8206:
1.85 albertel 8207: =pod
8208:
1.648 raeburn 8209: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8210:
8211: Returns either 1 or undef
8212:
8213: 1 if the part is to be hidden, undef if it is to be shown
8214:
8215: Arguments are:
8216:
8217: $id the id of the part to be checked
8218: $symb, optional the symb of the resource to check
8219: $udom, optional the domain of the user to check for
8220: $uname, optional the username of the user to check for
8221:
8222: =cut
1.84 albertel 8223:
8224: sub check_if_partid_hidden {
8225: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8226: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8227: $symb,$udom,$uname);
1.141 albertel 8228: my $truth=1;
8229: #if the string starts with !, then the list is the list to show not hide
8230: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8231: my @hiddenlist=split(/,/,$hiddenparts);
8232: foreach my $checkid (@hiddenlist) {
1.141 albertel 8233: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8234: }
1.141 albertel 8235: return !$truth;
1.84 albertel 8236: }
1.127 matthew 8237:
1.138 matthew 8238:
8239: ############################################################
8240: ############################################################
8241:
8242: =pod
8243:
1.157 matthew 8244: =back
8245:
1.138 matthew 8246: =head1 cgi-bin script and graphing routines
8247:
1.157 matthew 8248: =over 4
8249:
1.648 raeburn 8250: =item * &get_cgi_id()
1.138 matthew 8251:
8252: Inputs: none
8253:
8254: Returns an id which can be used to pass environment variables
8255: to various cgi-bin scripts. These environment variables will
8256: be removed from the users environment after a given time by
8257: the routine &Apache::lonnet::transfer_profile_to_env.
8258:
8259: =cut
8260:
8261: ############################################################
8262: ############################################################
1.152 albertel 8263: my $uniq=0;
1.136 matthew 8264: sub get_cgi_id {
1.154 albertel 8265: $uniq=($uniq+1)%100000;
1.280 albertel 8266: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8267: }
8268:
1.127 matthew 8269: ############################################################
8270: ############################################################
8271:
8272: =pod
8273:
1.648 raeburn 8274: =item * &DrawBarGraph()
1.127 matthew 8275:
1.138 matthew 8276: Facilitates the plotting of data in a (stacked) bar graph.
8277: Puts plot definition data into the users environment in order for
8278: graph.png to plot it. Returns an <img> tag for the plot.
8279: The bars on the plot are labeled '1','2',...,'n'.
8280:
8281: Inputs:
8282:
8283: =over 4
8284:
8285: =item $Title: string, the title of the plot
8286:
8287: =item $xlabel: string, text describing the X-axis of the plot
8288:
8289: =item $ylabel: string, text describing the Y-axis of the plot
8290:
8291: =item $Max: scalar, the maximum Y value to use in the plot
8292: If $Max is < any data point, the graph will not be rendered.
8293:
1.140 matthew 8294: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8295: they are plotted. If undefined, default values will be used.
8296:
1.178 matthew 8297: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8298:
1.138 matthew 8299: =item @Values: An array of array references. Each array reference holds data
8300: to be plotted in a stacked bar chart.
8301:
1.239 matthew 8302: =item If the final element of @Values is a hash reference the key/value
8303: pairs will be added to the graph definition.
8304:
1.138 matthew 8305: =back
8306:
8307: Returns:
8308:
8309: An <img> tag which references graph.png and the appropriate identifying
8310: information for the plot.
8311:
1.127 matthew 8312: =cut
8313:
8314: ############################################################
8315: ############################################################
1.134 matthew 8316: sub DrawBarGraph {
1.178 matthew 8317: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8318: #
8319: if (! defined($colors)) {
8320: $colors = ['#33ff00',
8321: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8322: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8323: ];
8324: }
1.228 matthew 8325: my $extra_settings = {};
8326: if (ref($Values[-1]) eq 'HASH') {
8327: $extra_settings = pop(@Values);
8328: }
1.127 matthew 8329: #
1.136 matthew 8330: my $identifier = &get_cgi_id();
8331: my $id = 'cgi.'.$identifier;
1.129 matthew 8332: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8333: return '';
8334: }
1.225 matthew 8335: #
8336: my @Labels;
8337: if (defined($labels)) {
8338: @Labels = @$labels;
8339: } else {
8340: for (my $i=0;$i<@{$Values[0]};$i++) {
8341: push (@Labels,$i+1);
8342: }
8343: }
8344: #
1.129 matthew 8345: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8346: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8347: my %ValuesHash;
8348: my $NumSets=1;
8349: foreach my $array (@Values) {
8350: next if (! ref($array));
1.136 matthew 8351: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8352: join(',',@$array);
1.129 matthew 8353: }
1.127 matthew 8354: #
1.136 matthew 8355: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8356: if ($NumBars < 3) {
8357: $width = 120+$NumBars*32;
1.220 matthew 8358: $xskip = 1;
1.225 matthew 8359: $bar_width = 30;
8360: } elsif ($NumBars < 5) {
8361: $width = 120+$NumBars*20;
8362: $xskip = 1;
8363: $bar_width = 20;
1.220 matthew 8364: } elsif ($NumBars < 10) {
1.136 matthew 8365: $width = 120+$NumBars*15;
8366: $xskip = 1;
8367: $bar_width = 15;
8368: } elsif ($NumBars <= 25) {
8369: $width = 120+$NumBars*11;
8370: $xskip = 5;
8371: $bar_width = 8;
8372: } elsif ($NumBars <= 50) {
8373: $width = 120+$NumBars*8;
8374: $xskip = 5;
8375: $bar_width = 4;
8376: } else {
8377: $width = 120+$NumBars*8;
8378: $xskip = 5;
8379: $bar_width = 4;
8380: }
8381: #
1.137 matthew 8382: $Max = 1 if ($Max < 1);
8383: if ( int($Max) < $Max ) {
8384: $Max++;
8385: $Max = int($Max);
8386: }
1.127 matthew 8387: $Title = '' if (! defined($Title));
8388: $xlabel = '' if (! defined($xlabel));
8389: $ylabel = '' if (! defined($ylabel));
1.369 www 8390: $ValuesHash{$id.'.title'} = &escape($Title);
8391: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8392: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8393: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8394: $ValuesHash{$id.'.NumBars'} = $NumBars;
8395: $ValuesHash{$id.'.NumSets'} = $NumSets;
8396: $ValuesHash{$id.'.PlotType'} = 'bar';
8397: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8398: $ValuesHash{$id.'.height'} = $height;
8399: $ValuesHash{$id.'.width'} = $width;
8400: $ValuesHash{$id.'.xskip'} = $xskip;
8401: $ValuesHash{$id.'.bar_width'} = $bar_width;
8402: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8403: #
1.228 matthew 8404: # Deal with other parameters
8405: while (my ($key,$value) = each(%$extra_settings)) {
8406: $ValuesHash{$id.'.'.$key} = $value;
8407: }
8408: #
1.646 raeburn 8409: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8410: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8411: }
8412:
8413: ############################################################
8414: ############################################################
8415:
8416: =pod
8417:
1.648 raeburn 8418: =item * &DrawXYGraph()
1.137 matthew 8419:
1.138 matthew 8420: Facilitates the plotting of data in an XY graph.
8421: Puts plot definition data into the users environment in order for
8422: graph.png to plot it. Returns an <img> tag for the plot.
8423:
8424: Inputs:
8425:
8426: =over 4
8427:
8428: =item $Title: string, the title of the plot
8429:
8430: =item $xlabel: string, text describing the X-axis of the plot
8431:
8432: =item $ylabel: string, text describing the Y-axis of the plot
8433:
8434: =item $Max: scalar, the maximum Y value to use in the plot
8435: If $Max is < any data point, the graph will not be rendered.
8436:
8437: =item $colors: Array ref containing the hex color codes for the data to be
8438: plotted in. If undefined, default values will be used.
8439:
8440: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8441:
8442: =item $Ydata: Array ref containing Array refs.
1.185 www 8443: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8444:
8445: =item %Values: hash indicating or overriding any default values which are
8446: passed to graph.png.
8447: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8448:
8449: =back
8450:
8451: Returns:
8452:
8453: An <img> tag which references graph.png and the appropriate identifying
8454: information for the plot.
8455:
1.137 matthew 8456: =cut
8457:
8458: ############################################################
8459: ############################################################
8460: sub DrawXYGraph {
8461: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8462: #
8463: # Create the identifier for the graph
8464: my $identifier = &get_cgi_id();
8465: my $id = 'cgi.'.$identifier;
8466: #
8467: $Title = '' if (! defined($Title));
8468: $xlabel = '' if (! defined($xlabel));
8469: $ylabel = '' if (! defined($ylabel));
8470: my %ValuesHash =
8471: (
1.369 www 8472: $id.'.title' => &escape($Title),
8473: $id.'.xlabel' => &escape($xlabel),
8474: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8475: $id.'.y_max_value'=> $Max,
8476: $id.'.labels' => join(',',@$Xlabels),
8477: $id.'.PlotType' => 'XY',
8478: );
8479: #
8480: if (defined($colors) && ref($colors) eq 'ARRAY') {
8481: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8482: }
8483: #
8484: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8485: return '';
8486: }
8487: my $NumSets=1;
1.138 matthew 8488: foreach my $array (@{$Ydata}){
1.137 matthew 8489: next if (! ref($array));
8490: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8491: }
1.138 matthew 8492: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8493: #
8494: # Deal with other parameters
8495: while (my ($key,$value) = each(%Values)) {
8496: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8497: }
8498: #
1.646 raeburn 8499: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8500: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8501: }
8502:
8503: ############################################################
8504: ############################################################
8505:
8506: =pod
8507:
1.648 raeburn 8508: =item * &DrawXYYGraph()
1.138 matthew 8509:
8510: Facilitates the plotting of data in an XY graph with two Y axes.
8511: Puts plot definition data into the users environment in order for
8512: graph.png to plot it. Returns an <img> tag for the plot.
8513:
8514: Inputs:
8515:
8516: =over 4
8517:
8518: =item $Title: string, the title of the plot
8519:
8520: =item $xlabel: string, text describing the X-axis of the plot
8521:
8522: =item $ylabel: string, text describing the Y-axis of the plot
8523:
8524: =item $colors: Array ref containing the hex color codes for the data to be
8525: plotted in. If undefined, default values will be used.
8526:
8527: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8528:
8529: =item $Ydata1: The first data set
8530:
8531: =item $Min1: The minimum value of the left Y-axis
8532:
8533: =item $Max1: The maximum value of the left Y-axis
8534:
8535: =item $Ydata2: The second data set
8536:
8537: =item $Min2: The minimum value of the right Y-axis
8538:
8539: =item $Max2: The maximum value of the left Y-axis
8540:
8541: =item %Values: hash indicating or overriding any default values which are
8542: passed to graph.png.
8543: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8544:
8545: =back
8546:
8547: Returns:
8548:
8549: An <img> tag which references graph.png and the appropriate identifying
8550: information for the plot.
1.136 matthew 8551:
8552: =cut
8553:
8554: ############################################################
8555: ############################################################
1.137 matthew 8556: sub DrawXYYGraph {
8557: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8558: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8559: #
8560: # Create the identifier for the graph
8561: my $identifier = &get_cgi_id();
8562: my $id = 'cgi.'.$identifier;
8563: #
8564: $Title = '' if (! defined($Title));
8565: $xlabel = '' if (! defined($xlabel));
8566: $ylabel = '' if (! defined($ylabel));
8567: my %ValuesHash =
8568: (
1.369 www 8569: $id.'.title' => &escape($Title),
8570: $id.'.xlabel' => &escape($xlabel),
8571: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8572: $id.'.labels' => join(',',@$Xlabels),
8573: $id.'.PlotType' => 'XY',
8574: $id.'.NumSets' => 2,
1.137 matthew 8575: $id.'.two_axes' => 1,
8576: $id.'.y1_max_value' => $Max1,
8577: $id.'.y1_min_value' => $Min1,
8578: $id.'.y2_max_value' => $Max2,
8579: $id.'.y2_min_value' => $Min2,
1.136 matthew 8580: );
8581: #
1.137 matthew 8582: if (defined($colors) && ref($colors) eq 'ARRAY') {
8583: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8584: }
8585: #
8586: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8587: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8588: return '';
8589: }
8590: my $NumSets=1;
1.137 matthew 8591: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8592: next if (! ref($array));
8593: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8594: }
8595: #
8596: # Deal with other parameters
8597: while (my ($key,$value) = each(%Values)) {
8598: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8599: }
8600: #
1.646 raeburn 8601: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8602: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8603: }
8604:
8605: ############################################################
8606: ############################################################
8607:
8608: =pod
8609:
1.157 matthew 8610: =back
8611:
1.139 matthew 8612: =head1 Statistics helper routines?
8613:
8614: Bad place for them but what the hell.
8615:
1.157 matthew 8616: =over 4
8617:
1.648 raeburn 8618: =item * &chartlink()
1.139 matthew 8619:
8620: Returns a link to the chart for a specific student.
8621:
8622: Inputs:
8623:
8624: =over 4
8625:
8626: =item $linktext: The text of the link
8627:
8628: =item $sname: The students username
8629:
8630: =item $sdomain: The students domain
8631:
8632: =back
8633:
1.157 matthew 8634: =back
8635:
1.139 matthew 8636: =cut
8637:
8638: ############################################################
8639: ############################################################
8640: sub chartlink {
8641: my ($linktext, $sname, $sdomain) = @_;
8642: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8643: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8644: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8645: '">'.$linktext.'</a>';
1.153 matthew 8646: }
8647:
8648: #######################################################
8649: #######################################################
8650:
8651: =pod
8652:
8653: =head1 Course Environment Routines
1.157 matthew 8654:
8655: =over 4
1.153 matthew 8656:
1.648 raeburn 8657: =item * &restore_course_settings()
1.153 matthew 8658:
1.648 raeburn 8659: =item * &store_course_settings()
1.153 matthew 8660:
8661: Restores/Store indicated form parameters from the course environment.
8662: Will not overwrite existing values of the form parameters.
8663:
8664: Inputs:
8665: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8666:
8667: a hash ref describing the data to be stored. For example:
8668:
8669: %Save_Parameters = ('Status' => 'scalar',
8670: 'chartoutputmode' => 'scalar',
8671: 'chartoutputdata' => 'scalar',
8672: 'Section' => 'array',
1.373 raeburn 8673: 'Group' => 'array',
1.153 matthew 8674: 'StudentData' => 'array',
8675: 'Maps' => 'array');
8676:
8677: Returns: both routines return nothing
8678:
1.631 raeburn 8679: =back
8680:
1.153 matthew 8681: =cut
8682:
8683: #######################################################
8684: #######################################################
8685: sub store_course_settings {
1.496 albertel 8686: return &store_settings($env{'request.course.id'},@_);
8687: }
8688:
8689: sub store_settings {
1.153 matthew 8690: # save to the environment
8691: # appenv the same items, just to be safe
1.300 albertel 8692: my $udom = $env{'user.domain'};
8693: my $uname = $env{'user.name'};
1.496 albertel 8694: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8695: my %SaveHash;
8696: my %AppHash;
8697: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8698: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8699: my $envname = 'environment.'.$basename;
1.258 albertel 8700: if (exists($env{'form.'.$setting})) {
1.153 matthew 8701: # Save this value away
8702: if ($type eq 'scalar' &&
1.258 albertel 8703: (! exists($env{$envname}) ||
8704: $env{$envname} ne $env{'form.'.$setting})) {
8705: $SaveHash{$basename} = $env{'form.'.$setting};
8706: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8707: } elsif ($type eq 'array') {
8708: my $stored_form;
1.258 albertel 8709: if (ref($env{'form.'.$setting})) {
1.153 matthew 8710: $stored_form = join(',',
8711: map {
1.369 www 8712: &escape($_);
1.258 albertel 8713: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8714: } else {
8715: $stored_form =
1.369 www 8716: &escape($env{'form.'.$setting});
1.153 matthew 8717: }
8718: # Determine if the array contents are the same.
1.258 albertel 8719: if ($stored_form ne $env{$envname}) {
1.153 matthew 8720: $SaveHash{$basename} = $stored_form;
8721: $AppHash{$envname} = $stored_form;
8722: }
8723: }
8724: }
8725: }
8726: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8727: $udom,$uname);
1.153 matthew 8728: if ($put_result !~ /^(ok|delayed)/) {
8729: &Apache::lonnet::logthis('unable to save form parameters, '.
8730: 'got error:'.$put_result);
8731: }
8732: # Make sure these settings stick around in this session, too
1.646 raeburn 8733: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8734: return;
8735: }
8736:
8737: sub restore_course_settings {
1.499 albertel 8738: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8739: }
8740:
8741: sub restore_settings {
8742: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8743: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8744: next if (exists($env{'form.'.$setting}));
1.496 albertel 8745: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8746: '.'.$setting;
1.258 albertel 8747: if (exists($env{$envname})) {
1.153 matthew 8748: if ($type eq 'scalar') {
1.258 albertel 8749: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8750: } elsif ($type eq 'array') {
1.258 albertel 8751: $env{'form.'.$setting} = [
1.153 matthew 8752: map {
1.369 www 8753: &unescape($_);
1.258 albertel 8754: } split(',',$env{$envname})
1.153 matthew 8755: ];
8756: }
8757: }
8758: }
1.127 matthew 8759: }
8760:
1.618 raeburn 8761: #######################################################
8762: #######################################################
8763:
8764: =pod
8765:
8766: =head1 Domain E-mail Routines
8767:
8768: =over 4
8769:
1.648 raeburn 8770: =item * &build_recipient_list()
1.618 raeburn 8771:
8772: Build recipient lists for three types of e-mail:
8773: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8774: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8775:
8776: Inputs:
1.619 raeburn 8777: defmail (scalar - email address of default recipient),
1.618 raeburn 8778: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8779: defdom (domain for which to retrieve configuration settings),
8780: origmail (scalar - email address of recipient from loncapa.conf,
8781: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8782:
1.655 raeburn 8783: Returns: comma separated list of addresses to which to send e-mail.
8784:
8785: =back
1.618 raeburn 8786:
8787: =cut
8788:
8789: ############################################################
8790: ############################################################
8791: sub build_recipient_list {
1.619 raeburn 8792: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8793: my @recipients;
8794: my $otheremails;
8795: my %domconfig =
8796: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8797: if (ref($domconfig{'contacts'}) eq 'HASH') {
8798: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8799: my @contacts = ('adminemail','supportemail');
8800: foreach my $item (@contacts) {
8801: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8802: my $addr = $domconfig{'contacts'}{$item};
8803: if (!grep(/^\Q$addr\E$/,@recipients)) {
8804: push(@recipients,$addr);
8805: }
1.618 raeburn 8806: }
8807: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8808: }
8809: }
1.619 raeburn 8810: } elsif ($origmail ne '') {
8811: push(@recipients,$origmail);
1.618 raeburn 8812: }
1.688 raeburn 8813: if (defined($defmail)) {
8814: if ($defmail ne '') {
8815: push(@recipients,$defmail);
8816: }
1.618 raeburn 8817: }
8818: if ($otheremails) {
1.619 raeburn 8819: my @others;
8820: if ($otheremails =~ /,/) {
8821: @others = split(/,/,$otheremails);
1.618 raeburn 8822: } else {
1.619 raeburn 8823: push(@others,$otheremails);
8824: }
8825: foreach my $addr (@others) {
8826: if (!grep(/^\Q$addr\E$/,@recipients)) {
8827: push(@recipients,$addr);
8828: }
1.618 raeburn 8829: }
8830: }
1.619 raeburn 8831: my $recipientlist = join(',',@recipients);
1.618 raeburn 8832: return $recipientlist;
8833: }
8834:
1.127 matthew 8835: ############################################################
8836: ############################################################
1.154 albertel 8837:
1.655 raeburn 8838: =pod
8839:
8840: =head1 Course Catalog Routines
8841:
8842: =over 4
8843:
8844: =item * &gather_categories()
8845:
8846: Converts category definitions - keys of categories hash stored in
8847: coursecategories in configuration.db on the primary library server in a
8848: domain - to an array. Also generates javascript and idx hash used to
8849: generate Domain Coordinator interface for editing Course Categories.
8850:
8851: Inputs:
1.663 raeburn 8852:
1.655 raeburn 8853: categories (reference to hash of category definitions).
1.663 raeburn 8854:
1.655 raeburn 8855: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8856: categories and subcategories).
1.663 raeburn 8857:
1.655 raeburn 8858: idx (reference to hash of counters used in Domain Coordinator interface for
8859: editing Course Categories).
1.663 raeburn 8860:
1.655 raeburn 8861: jsarray (reference to array of categories used to create Javascript arrays for
8862: Domain Coordinator interface for editing Course Categories).
8863:
8864: Returns: nothing
8865:
8866: Side effects: populates cats, idx and jsarray.
8867:
8868: =cut
8869:
8870: sub gather_categories {
8871: my ($categories,$cats,$idx,$jsarray) = @_;
8872: my %counters;
8873: my $num = 0;
8874: foreach my $item (keys(%{$categories})) {
8875: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8876: if ($container eq '' && $depth == 0) {
8877: $cats->[$depth][$categories->{$item}] = $cat;
8878: } else {
8879: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8880: }
8881: my ($escitem,$tail) = split(/:/,$item,2);
8882: if ($counters{$tail} eq '') {
8883: $counters{$tail} = $num;
8884: $num ++;
8885: }
8886: if (ref($idx) eq 'HASH') {
8887: $idx->{$item} = $counters{$tail};
8888: }
8889: if (ref($jsarray) eq 'ARRAY') {
8890: push(@{$jsarray->[$counters{$tail}]},$item);
8891: }
8892: }
8893: return;
8894: }
8895:
8896: =pod
8897:
8898: =item * &extract_categories()
8899:
8900: Used to generate breadcrumb trails for course categories.
8901:
8902: Inputs:
1.663 raeburn 8903:
1.655 raeburn 8904: categories (reference to hash of category definitions).
1.663 raeburn 8905:
1.655 raeburn 8906: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8907: categories and subcategories).
1.663 raeburn 8908:
1.655 raeburn 8909: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8910:
1.655 raeburn 8911: allitems (reference to hash - key is category key
8912: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8913:
1.655 raeburn 8914: idx (reference to hash of counters used in Domain Coordinator interface for
8915: editing Course Categories).
1.663 raeburn 8916:
1.655 raeburn 8917: jsarray (reference to array of categories used to create Javascript arrays for
8918: Domain Coordinator interface for editing Course Categories).
8919:
1.665 raeburn 8920: subcats (reference to hash of arrays containing all subcategories within each
8921: category, -recursive)
8922:
1.655 raeburn 8923: Returns: nothing
8924:
8925: Side effects: populates trails and allitems hash references.
8926:
8927: =cut
8928:
8929: sub extract_categories {
1.665 raeburn 8930: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8931: if (ref($categories) eq 'HASH') {
8932: &gather_categories($categories,$cats,$idx,$jsarray);
8933: if (ref($cats->[0]) eq 'ARRAY') {
8934: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8935: my $name = $cats->[0][$i];
8936: my $item = &escape($name).'::0';
8937: my $trailstr;
8938: if ($name eq 'instcode') {
8939: $trailstr = &mt('Official courses (with institutional codes)');
8940: } else {
8941: $trailstr = $name;
8942: }
8943: if ($allitems->{$item} eq '') {
8944: push(@{$trails},$trailstr);
8945: $allitems->{$item} = scalar(@{$trails})-1;
8946: }
8947: my @parents = ($name);
8948: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8949: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8950: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8951: if (ref($subcats) eq 'HASH') {
8952: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8953: }
8954: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8955: }
8956: } else {
8957: if (ref($subcats) eq 'HASH') {
8958: $subcats->{$item} = [];
1.655 raeburn 8959: }
8960: }
8961: }
8962: }
8963: }
8964: return;
8965: }
8966:
8967: =pod
8968:
8969: =item *&recurse_categories()
8970:
8971: Recursively used to generate breadcrumb trails for course categories.
8972:
8973: Inputs:
1.663 raeburn 8974:
1.655 raeburn 8975: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8976: categories and subcategories).
1.663 raeburn 8977:
1.655 raeburn 8978: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8979:
8980: category (current course category, for which breadcrumb trail is being generated).
8981:
8982: trails (reference to array of breadcrumb trails for each category).
8983:
1.655 raeburn 8984: allitems (reference to hash - key is category key
8985: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8986:
1.655 raeburn 8987: parents (array containing containers directories for current category,
8988: back to top level).
8989:
8990: Returns: nothing
8991:
8992: Side effects: populates trails and allitems hash references
8993:
8994: =cut
8995:
8996: sub recurse_categories {
1.665 raeburn 8997: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8998: my $shallower = $depth - 1;
8999: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9000: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9001: my $name = $cats->[$depth]{$category}[$k];
9002: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9003: my $trailstr = join(' -> ',(@{$parents},$category));
9004: if ($allitems->{$item} eq '') {
9005: push(@{$trails},$trailstr);
9006: $allitems->{$item} = scalar(@{$trails})-1;
9007: }
9008: my $deeper = $depth+1;
9009: push(@{$parents},$category);
1.665 raeburn 9010: if (ref($subcats) eq 'HASH') {
9011: my $subcat = &escape($name).':'.$category.':'.$depth;
9012: for (my $j=@{$parents}; $j>=0; $j--) {
9013: my $higher;
9014: if ($j > 0) {
9015: $higher = &escape($parents->[$j]).':'.
9016: &escape($parents->[$j-1]).':'.$j;
9017: } else {
9018: $higher = &escape($parents->[$j]).'::'.$j;
9019: }
9020: push(@{$subcats->{$higher}},$subcat);
9021: }
9022: }
9023: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9024: $subcats);
1.655 raeburn 9025: pop(@{$parents});
9026: }
9027: } else {
9028: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9029: my $trailstr = join(' -> ',(@{$parents},$category));
9030: if ($allitems->{$item} eq '') {
9031: push(@{$trails},$trailstr);
9032: $allitems->{$item} = scalar(@{$trails})-1;
9033: }
9034: }
9035: return;
9036: }
9037:
1.663 raeburn 9038: =pod
9039:
9040: =item *&assign_categories_table()
9041:
9042: Create a datatable for display of hierarchical categories in a domain,
9043: with checkboxes to allow a course to be categorized.
9044:
9045: Inputs:
9046:
9047: cathash - reference to hash of categories defined for the domain (from
9048: configuration.db)
9049:
9050: currcat - scalar with an & separated list of categories assigned to a course.
9051:
9052: Returns: $output (markup to be displayed)
9053:
9054: =cut
9055:
9056: sub assign_categories_table {
9057: my ($cathash,$currcat) = @_;
9058: my $output;
9059: if (ref($cathash) eq 'HASH') {
9060: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9061: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9062: $maxdepth = scalar(@cats);
9063: if (@cats > 0) {
9064: my $itemcount = 0;
9065: if (ref($cats[0]) eq 'ARRAY') {
9066: $output = &Apache::loncommon::start_data_table();
9067: my @currcategories;
9068: if ($currcat ne '') {
9069: @currcategories = split('&',$currcat);
9070: }
9071: for (my $i=0; $i<@{$cats[0]}; $i++) {
9072: my $parent = $cats[0][$i];
9073: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9074: next if ($parent eq 'instcode');
9075: my $item = &escape($parent).'::0';
9076: my $checked = '';
9077: if (@currcategories > 0) {
9078: if (grep(/^\Q$item\E$/,@currcategories)) {
9079: $checked = ' checked="checked" ';
9080: }
9081: }
1.675 raeburn 9082: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9083: '<input type="checkbox" name="usecategory" value="'.
9084: $item.'"'.$checked.' />'.$parent.'</span>'.
9085: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9086: my $depth = 1;
9087: push(@path,$parent);
9088: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9089: pop(@path);
9090: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9091: $itemcount ++;
9092: }
9093: $output .= &Apache::loncommon::end_data_table();
9094: }
9095: }
9096: }
9097: return $output;
9098: }
9099:
9100: =pod
9101:
9102: =item *&assign_category_rows()
9103:
9104: Create a datatable row for display of nested categories in a domain,
9105: with checkboxes to allow a course to be categorized,called recursively.
9106:
9107: Inputs:
9108:
9109: itemcount - track row number for alternating colors
9110:
9111: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9112: categories and subcategories.
9113:
9114: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9115:
9116: parent - parent of current category item
9117:
9118: path - Array containing all categories back up through the hierarchy from the
9119: current category to the top level.
9120:
9121: currcategories - reference to array of current categories assigned to the course
9122:
9123: Returns: $output (markup to be displayed).
9124:
9125: =cut
9126:
9127: sub assign_category_rows {
9128: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9129: my ($text,$name,$item,$chgstr);
9130: if (ref($cats) eq 'ARRAY') {
9131: my $maxdepth = scalar(@{$cats});
9132: if (ref($cats->[$depth]) eq 'HASH') {
9133: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9134: my $numchildren = @{$cats->[$depth]{$parent}};
9135: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9136: $text .= '<td><table class="LC_datatable">';
9137: for (my $j=0; $j<$numchildren; $j++) {
9138: $name = $cats->[$depth]{$parent}[$j];
9139: $item = &escape($name).':'.&escape($parent).':'.$depth;
9140: my $deeper = $depth+1;
9141: my $checked = '';
9142: if (ref($currcategories) eq 'ARRAY') {
9143: if (@{$currcategories} > 0) {
9144: if (grep(/^\Q$item\E$/,@{$currcategories})) {
9145: $checked = ' checked="checked" ';
9146: }
9147: }
9148: }
1.664 raeburn 9149: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9150: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9151: $item.'"'.$checked.' />'.$name.'</label></span>'.
9152: '<input type="hidden" name="catname" value="'.$name.'" />'.
9153: '</td><td>';
1.663 raeburn 9154: if (ref($path) eq 'ARRAY') {
9155: push(@{$path},$name);
9156: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9157: pop(@{$path});
9158: }
9159: $text .= '</td></tr>';
9160: }
9161: $text .= '</table></td>';
9162: }
9163: }
9164: }
9165: return $text;
9166: }
9167:
1.655 raeburn 9168: ############################################################
9169: ############################################################
9170:
9171:
1.443 albertel 9172: sub commit_customrole {
1.664 raeburn 9173: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9174: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9175: ($start?', '.&mt('starting').' '.localtime($start):'').
9176: ($end?', ending '.localtime($end):'').': <b>'.
9177: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9178: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9179: '</b><br />';
9180: return $output;
9181: }
9182:
9183: sub commit_standardrole {
1.541 raeburn 9184: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9185: my ($output,$logmsg,$linefeed);
9186: if ($context eq 'auto') {
9187: $linefeed = "\n";
9188: } else {
9189: $linefeed = "<br />\n";
9190: }
1.443 albertel 9191: if ($three eq 'st') {
1.541 raeburn 9192: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9193: $one,$two,$sec,$context);
9194: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9195: ($result eq 'unknown_course') || ($result eq 'refused')) {
9196: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9197: } else {
1.541 raeburn 9198: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9199: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9200: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9201: if ($context eq 'auto') {
9202: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9203: } else {
9204: $output .= '<b>'.$result.'</b>'.$linefeed.
9205: &mt('Add to classlist').': <b>ok</b>';
9206: }
9207: $output .= $linefeed;
1.443 albertel 9208: }
9209: } else {
9210: $output = &mt('Assigning').' '.$three.' in '.$url.
9211: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9212: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9213: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9214: if ($context eq 'auto') {
9215: $output .= $result.$linefeed;
9216: } else {
9217: $output .= '<b>'.$result.'</b>'.$linefeed;
9218: }
1.443 albertel 9219: }
9220: return $output;
9221: }
9222:
9223: sub commit_studentrole {
1.541 raeburn 9224: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9225: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9226: if ($context eq 'auto') {
9227: $linefeed = "\n";
9228: } else {
9229: $linefeed = '<br />'."\n";
9230: }
1.443 albertel 9231: if (defined($one) && defined($two)) {
9232: my $cid=$one.'_'.$two;
9233: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9234: my $secchange = 0;
9235: my $expire_role_result;
9236: my $modify_section_result;
1.628 raeburn 9237: if ($oldsec ne '-1') {
9238: if ($oldsec ne $sec) {
1.443 albertel 9239: $secchange = 1;
1.628 raeburn 9240: my $now = time;
1.443 albertel 9241: my $uurl='/'.$cid;
9242: $uurl=~s/\_/\//g;
9243: if ($oldsec) {
9244: $uurl.='/'.$oldsec;
9245: }
1.626 raeburn 9246: $oldsecurl = $uurl;
1.628 raeburn 9247: $expire_role_result =
1.652 raeburn 9248: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9249: if ($env{'request.course.sec'} ne '') {
9250: if ($expire_role_result eq 'refused') {
9251: my @roles = ('st');
9252: my @statuses = ('previous');
9253: my @roledoms = ($one);
9254: my $withsec = 1;
9255: my %roleshash =
9256: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9257: \@statuses,\@roles,\@roledoms,$withsec);
9258: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9259: my ($oldstart,$oldend) =
9260: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9261: if ($oldend > 0 && $oldend <= $now) {
9262: $expire_role_result = 'ok';
9263: }
9264: }
9265: }
9266: }
1.443 albertel 9267: $result = $expire_role_result;
9268: }
9269: }
9270: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9271: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9272: if ($modify_section_result =~ /^ok/) {
9273: if ($secchange == 1) {
1.628 raeburn 9274: if ($sec eq '') {
9275: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9276: } else {
9277: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9278: }
1.443 albertel 9279: } elsif ($oldsec eq '-1') {
1.628 raeburn 9280: if ($sec eq '') {
9281: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9282: } else {
9283: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9284: }
1.443 albertel 9285: } else {
1.628 raeburn 9286: if ($sec eq '') {
9287: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9288: } else {
9289: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9290: }
1.443 albertel 9291: }
9292: } else {
1.628 raeburn 9293: if ($secchange) {
9294: $$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;
9295: } else {
9296: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9297: }
1.443 albertel 9298: }
9299: $result = $modify_section_result;
9300: } elsif ($secchange == 1) {
1.628 raeburn 9301: if ($oldsec eq '') {
9302: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9303: } else {
9304: $$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;
9305: }
1.626 raeburn 9306: if ($expire_role_result eq 'refused') {
9307: my $newsecurl = '/'.$cid;
9308: $newsecurl =~ s/\_/\//g;
9309: if ($sec ne '') {
9310: $newsecurl.='/'.$sec;
9311: }
9312: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9313: if ($sec eq '') {
9314: $$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;
9315: } else {
9316: $$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;
9317: }
9318: }
9319: }
1.443 albertel 9320: }
9321: } else {
1.626 raeburn 9322: $$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 9323: $result = "error: incomplete course id\n";
9324: }
9325: return $result;
9326: }
9327:
9328: ############################################################
9329: ############################################################
9330:
1.566 albertel 9331: sub check_clone {
1.578 raeburn 9332: my ($args,$linefeed) = @_;
1.566 albertel 9333: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9334: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9335: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9336: my $clonemsg;
9337: my $can_clone = 0;
9338:
9339: if ($clonehome eq 'no_host') {
1.578 raeburn 9340: $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 9341: } else {
9342: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9343: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9344: $can_clone = 1;
9345: } else {
9346: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9347: $args->{'clonedomain'},$args->{'clonecourse'});
9348: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9349: if (grep(/^\*$/,@cloners)) {
9350: $can_clone = 1;
9351: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9352: $can_clone = 1;
9353: } else {
9354: my %roleshash =
9355: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9356: $args->{'ccdomain'},
9357: 'userroles',['active'],['cc'],
9358: [$args->{'clonedomain'}]);
9359: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9360: $can_clone = 1;
9361: } else {
9362: $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'});
9363: }
1.566 albertel 9364: }
1.578 raeburn 9365: }
1.566 albertel 9366: }
9367: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9368: }
9369:
1.444 albertel 9370: sub construct_course {
1.541 raeburn 9371: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9372: my $outcome;
1.541 raeburn 9373: my $linefeed = '<br />'."\n";
9374: if ($context eq 'auto') {
9375: $linefeed = "\n";
9376: }
1.566 albertel 9377:
9378: #
9379: # Are we cloning?
9380: #
9381: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9382: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9383: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9384: if ($context ne 'auto') {
1.578 raeburn 9385: if ($clonemsg ne '') {
9386: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9387: }
1.566 albertel 9388: }
9389: $outcome .= $clonemsg.$linefeed;
9390:
9391: if (!$can_clone) {
9392: return (0,$outcome);
9393: }
9394: }
9395:
1.444 albertel 9396: #
9397: # Open course
9398: #
9399: my $crstype = lc($args->{'crstype'});
9400: my %cenv=();
9401: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9402: $args->{'cdescr'},
9403: $args->{'curl'},
9404: $args->{'course_home'},
9405: $args->{'nonstandard'},
9406: $args->{'crscode'},
9407: $args->{'ccuname'}.':'.
9408: $args->{'ccdomain'},
9409: $args->{'crstype'});
9410:
9411: # Note: The testing routines depend on this being output; see
9412: # Utils::Course. This needs to at least be output as a comment
9413: # if anyone ever decides to not show this, and Utils::Course::new
9414: # will need to be suitably modified.
1.541 raeburn 9415: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9416: #
9417: # Check if created correctly
9418: #
1.479 albertel 9419: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9420: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9421: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9422:
1.444 albertel 9423: #
1.566 albertel 9424: # Do the cloning
9425: #
9426: if ($can_clone && $cloneid) {
9427: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9428: if ($context ne 'auto') {
9429: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9430: }
9431: $outcome .= $clonemsg.$linefeed;
9432: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9433: # Copy all files
1.637 www 9434: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9435: # Restore URL
1.566 albertel 9436: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9437: # Restore title
1.566 albertel 9438: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9439: # Mark as cloned
1.566 albertel 9440: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9441: # Need to clone grading mode
9442: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9443: $cenv{'grading'}=$newenv{'grading'};
9444: # Do not clone these environment entries
9445: &Apache::lonnet::del('environment',
9446: ['default_enrollment_start_date',
9447: 'default_enrollment_end_date',
9448: 'question.email',
9449: 'policy.email',
9450: 'comment.email',
9451: 'pch.users.denied',
1.725 raeburn 9452: 'plc.users.denied',
9453: 'hidefromcat',
9454: 'categories'],
1.638 www 9455: $$crsudom,$$crsunum);
1.444 albertel 9456: }
1.566 albertel 9457:
1.444 albertel 9458: #
9459: # Set environment (will override cloned, if existing)
9460: #
9461: my @sections = ();
9462: my @xlists = ();
9463: if ($args->{'crstype'}) {
9464: $cenv{'type'}=$args->{'crstype'};
9465: }
9466: if ($args->{'crsid'}) {
9467: $cenv{'courseid'}=$args->{'crsid'};
9468: }
9469: if ($args->{'crscode'}) {
9470: $cenv{'internal.coursecode'}=$args->{'crscode'};
9471: }
9472: if ($args->{'crsquota'} ne '') {
9473: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9474: } else {
9475: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9476: }
9477: if ($args->{'ccuname'}) {
9478: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9479: ':'.$args->{'ccdomain'};
9480: } else {
9481: $cenv{'internal.courseowner'} = $args->{'curruser'};
9482: }
9483: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9484: if ($args->{'crssections'}) {
9485: $cenv{'internal.sectionnums'} = '';
9486: if ($args->{'crssections'} =~ m/,/) {
9487: @sections = split/,/,$args->{'crssections'};
9488: } else {
9489: $sections[0] = $args->{'crssections'};
9490: }
9491: if (@sections > 0) {
9492: foreach my $item (@sections) {
9493: my ($sec,$gp) = split/:/,$item;
9494: my $class = $args->{'crscode'}.$sec;
9495: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9496: $cenv{'internal.sectionnums'} .= $item.',';
9497: unless ($addcheck eq 'ok') {
9498: push @badclasses, $class;
9499: }
9500: }
9501: $cenv{'internal.sectionnums'} =~ s/,$//;
9502: }
9503: }
9504: # do not hide course coordinator from staff listing,
9505: # even if privileged
9506: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9507: # add crosslistings
9508: if ($args->{'crsxlist'}) {
9509: $cenv{'internal.crosslistings'}='';
9510: if ($args->{'crsxlist'} =~ m/,/) {
9511: @xlists = split/,/,$args->{'crsxlist'};
9512: } else {
9513: $xlists[0] = $args->{'crsxlist'};
9514: }
9515: if (@xlists > 0) {
9516: foreach my $item (@xlists) {
9517: my ($xl,$gp) = split/:/,$item;
9518: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9519: $cenv{'internal.crosslistings'} .= $item.',';
9520: unless ($addcheck eq 'ok') {
9521: push @badclasses, $xl;
9522: }
9523: }
9524: $cenv{'internal.crosslistings'} =~ s/,$//;
9525: }
9526: }
9527: if ($args->{'autoadds'}) {
9528: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9529: }
9530: if ($args->{'autodrops'}) {
9531: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9532: }
9533: # check for notification of enrollment changes
9534: my @notified = ();
9535: if ($args->{'notify_owner'}) {
9536: if ($args->{'ccuname'} ne '') {
9537: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9538: }
9539: }
9540: if ($args->{'notify_dc'}) {
9541: if ($uname ne '') {
1.630 raeburn 9542: push(@notified,$uname.':'.$udom);
1.444 albertel 9543: }
9544: }
9545: if (@notified > 0) {
9546: my $notifylist;
9547: if (@notified > 1) {
9548: $notifylist = join(',',@notified);
9549: } else {
9550: $notifylist = $notified[0];
9551: }
9552: $cenv{'internal.notifylist'} = $notifylist;
9553: }
9554: if (@badclasses > 0) {
9555: my %lt=&Apache::lonlocal::texthash(
9556: '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',
9557: 'dnhr' => 'does not have rights to access enrollment in these classes',
9558: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9559: );
1.541 raeburn 9560: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9561: ' ('.$lt{'adby'}.')';
9562: if ($context eq 'auto') {
9563: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9564: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9565: foreach my $item (@badclasses) {
9566: if ($context eq 'auto') {
9567: $outcome .= " - $item\n";
9568: } else {
9569: $outcome .= "<li>$item</li>\n";
9570: }
9571: }
9572: if ($context eq 'auto') {
9573: $outcome .= $linefeed;
9574: } else {
1.566 albertel 9575: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9576: }
9577: }
1.444 albertel 9578: }
9579: if ($args->{'no_end_date'}) {
9580: $args->{'endaccess'} = 0;
9581: }
9582: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9583: $cenv{'internal.autoend'}=$args->{'enrollend'};
9584: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9585: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9586: if ($args->{'showphotos'}) {
9587: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9588: }
9589: $cenv{'internal.authtype'} = $args->{'authtype'};
9590: $cenv{'internal.autharg'} = $args->{'autharg'};
9591: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9592: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9593: 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');
9594: if ($context eq 'auto') {
9595: $outcome .= $krb_msg;
9596: } else {
1.566 albertel 9597: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9598: }
9599: $outcome .= $linefeed;
1.444 albertel 9600: }
9601: }
9602: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9603: if ($args->{'setpolicy'}) {
9604: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9605: }
9606: if ($args->{'setcontent'}) {
9607: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9608: }
9609: }
9610: if ($args->{'reshome'}) {
9611: $cenv{'reshome'}=$args->{'reshome'}.'/';
9612: $cenv{'reshome'}=~s/\/+$/\//;
9613: }
9614: #
9615: # course has keyed access
9616: #
9617: if ($args->{'setkeys'}) {
9618: $cenv{'keyaccess'}='yes';
9619: }
9620: # if specified, key authority is not course, but user
9621: # only active if keyaccess is yes
9622: if ($args->{'keyauth'}) {
1.487 albertel 9623: my ($user,$domain) = split(':',$args->{'keyauth'});
9624: $user = &LONCAPA::clean_username($user);
9625: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9626: if ($user ne '' && $domain ne '') {
1.487 albertel 9627: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9628: }
9629: }
9630:
9631: if ($args->{'disresdis'}) {
9632: $cenv{'pch.roles.denied'}='st';
9633: }
9634: if ($args->{'disablechat'}) {
9635: $cenv{'plc.roles.denied'}='st';
9636: }
9637:
9638: # Record we've not yet viewed the Course Initialization Helper for this
9639: # course
9640: $cenv{'course.helper.not.run'} = 1;
9641: #
9642: # Use new Randomseed
9643: #
9644: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9645: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9646: #
9647: # The encryption code and receipt prefix for this course
9648: #
9649: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9650: $cenv{'internal.encpref'}=100+int(9*rand(99));
9651: #
9652: # By default, use standard grading
9653: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9654:
1.541 raeburn 9655: $outcome .= $linefeed.&mt('Setting environment').': '.
9656: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9657: #
9658: # Open all assignments
9659: #
9660: if ($args->{'openall'}) {
9661: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9662: my %storecontent = ($storeunder => time,
9663: $storeunder.'.type' => 'date_start');
9664:
9665: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9666: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9667: }
9668: #
9669: # Set first page
9670: #
9671: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9672: || ($cloneid)) {
1.445 albertel 9673: use LONCAPA::map;
1.444 albertel 9674: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9675:
9676: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9677: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9678:
1.444 albertel 9679: $outcome .= ($fatal?$errtext:'read ok').' - ';
9680: my $title; my $url;
9681: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9682: $title=&mt('Syllabus');
1.444 albertel 9683: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9684: } else {
1.690 bisitz 9685: $title=&mt('Navigate Contents');
1.444 albertel 9686: $url='/adm/navmaps';
9687: }
1.445 albertel 9688:
9689: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9690: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9691:
9692: if ($errtext) { $fatal=2; }
1.541 raeburn 9693: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9694: }
1.566 albertel 9695:
9696: return (1,$outcome);
1.444 albertel 9697: }
9698:
9699: ############################################################
9700: ############################################################
9701:
1.378 raeburn 9702: sub course_type {
9703: my ($cid) = @_;
9704: if (!defined($cid)) {
9705: $cid = $env{'request.course.id'};
9706: }
1.404 albertel 9707: if (defined($env{'course.'.$cid.'.type'})) {
9708: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9709: } else {
9710: return 'Course';
1.377 raeburn 9711: }
9712: }
1.156 albertel 9713:
1.406 raeburn 9714: sub group_term {
9715: my $crstype = &course_type();
9716: my %names = (
9717: 'Course' => 'group',
9718: 'Group' => 'team',
9719: );
9720: return $names{$crstype};
9721: }
9722:
1.156 albertel 9723: sub icon {
9724: my ($file)=@_;
1.505 albertel 9725: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9726: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9727: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9728: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9729: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9730: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9731: $curfext.".gif") {
9732: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9733: $curfext.".gif";
9734: }
9735: }
1.249 albertel 9736: return &lonhttpdurl($iconname);
1.154 albertel 9737: }
1.84 albertel 9738:
1.575 albertel 9739: sub lonhttpdurl {
1.692 www 9740: #
9741: # Had been used for "small fry" static images on separate port 8080.
9742: # Modify here if lightweight http functionality desired again.
9743: # Currently eliminated due to increasing firewall issues.
9744: #
1.575 albertel 9745: my ($url)=@_;
1.692 www 9746: return $url;
1.215 albertel 9747: }
9748:
1.213 albertel 9749: sub connection_aborted {
9750: my ($r)=@_;
9751: $r->print(" ");$r->rflush();
9752: my $c = $r->connection;
9753: return $c->aborted();
9754: }
9755:
1.221 foxr 9756: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9757: # strings as 'strings'.
9758: sub escape_single {
1.221 foxr 9759: my ($input) = @_;
1.223 albertel 9760: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9761: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9762: return $input;
9763: }
1.223 albertel 9764:
1.222 foxr 9765: # Same as escape_single, but escape's "'s This
9766: # can be used for "strings"
9767: sub escape_double {
9768: my ($input) = @_;
9769: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9770: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9771: return $input;
9772: }
1.223 albertel 9773:
1.222 foxr 9774: # Escapes the last element of a full URL.
9775: sub escape_url {
9776: my ($url) = @_;
1.238 raeburn 9777: my @urlslices = split(/\//, $url,-1);
1.369 www 9778: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9779: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9780: }
1.462 albertel 9781:
9782: # -------------------------------------------------------- Initliaze user login
9783: sub init_user_environment {
1.463 albertel 9784: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9785: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9786:
9787: my $public=($username eq 'public' && $domain eq 'public');
9788:
9789: # See if old ID present, if so, remove
9790:
9791: my ($filename,$cookie,$userroles);
9792: my $now=time;
9793:
9794: if ($public) {
9795: my $max_public=100;
9796: my $oldest;
9797: my $oldest_time=0;
9798: for(my $next=1;$next<=$max_public;$next++) {
9799: if (-e $lonids."/publicuser_$next.id") {
9800: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9801: if ($mtime<$oldest_time || !$oldest_time) {
9802: $oldest_time=$mtime;
9803: $oldest=$next;
9804: }
9805: } else {
9806: $cookie="publicuser_$next";
9807: last;
9808: }
9809: }
9810: if (!$cookie) { $cookie="publicuser_$oldest"; }
9811: } else {
1.463 albertel 9812: # if this isn't a robot, kill any existing non-robot sessions
9813: if (!$args->{'robot'}) {
9814: opendir(DIR,$lonids);
9815: while ($filename=readdir(DIR)) {
9816: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9817: unlink($lonids.'/'.$filename);
9818: }
1.462 albertel 9819: }
1.463 albertel 9820: closedir(DIR);
1.462 albertel 9821: }
9822: # Give them a new cookie
1.463 albertel 9823: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9824: : $now.$$.int(rand(10000)));
1.463 albertel 9825: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9826:
9827: # Initialize roles
9828:
9829: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9830: }
9831: # ------------------------------------ Check browser type and MathML capability
9832:
9833: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9834: $clientunicode,$clientos) = &decode_user_agent($r);
9835:
9836: # -------------------------------------- Any accessibility options to remember?
9837: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9838: foreach my $option ('imagesuppress','appletsuppress',
9839: 'embedsuppress','fontenhance','blackwhite') {
9840: if ($form->{$option} eq 'true') {
9841: &Apache::lonnet::put('environment',{$option => 'on'},
9842: $domain,$username);
9843: } else {
9844: &Apache::lonnet::del('environment',[$option],
9845: $domain,$username);
9846: }
9847: }
9848: }
9849: # ------------------------------------------------------------- Get environment
9850:
9851: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9852: my ($tmp) = keys(%userenv);
9853: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9854: # default remote control to off
9855: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9856: } else {
9857: undef(%userenv);
9858: }
9859: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9860: $form->{'interface'}=$userenv{'interface'};
9861: }
9862: $env{'environment.remote'}=$userenv{'remote'};
9863: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9864:
9865: # --------------- Do not trust query string to be put directly into environment
9866: foreach my $option ('imagesuppress','appletsuppress',
9867: 'embedsuppress','fontenhance','blackwhite',
9868: 'interface','localpath','localres') {
9869: $form->{$option}=~s/[\n\r\=]//gs;
9870: }
9871: # --------------------------------------------------------- Write first profile
9872:
9873: {
9874: my %initial_env =
9875: ("user.name" => $username,
9876: "user.domain" => $domain,
9877: "user.home" => $authhost,
9878: "browser.type" => $clientbrowser,
9879: "browser.version" => $clientversion,
9880: "browser.mathml" => $clientmathml,
9881: "browser.unicode" => $clientunicode,
9882: "browser.os" => $clientos,
9883: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9884: "request.course.fn" => '',
9885: "request.course.uri" => '',
9886: "request.course.sec" => '',
9887: "request.role" => 'cm',
9888: "request.role.adv" => $env{'user.adv'},
9889: "request.host" => $ENV{'REMOTE_ADDR'},);
9890:
9891: if ($form->{'localpath'}) {
9892: $initial_env{"browser.localpath"} = $form->{'localpath'};
9893: $initial_env{"browser.localres"} = $form->{'localres'};
9894: }
9895:
9896: if ($public) {
9897: $initial_env{"environment.remote"} = "off";
9898: }
9899: if ($form->{'interface'}) {
9900: $form->{'interface'}=~s/\W//gs;
9901: $initial_env{"browser.interface"} = $form->{'interface'};
9902: $env{'browser.interface'}=$form->{'interface'};
9903: foreach my $option ('imagesuppress','appletsuppress',
9904: 'embedsuppress','fontenhance','blackwhite') {
9905: if (($form->{$option} eq 'true') ||
9906: ($userenv{$option} eq 'on')) {
9907: $initial_env{"browser.$option"} = "on";
9908: }
9909: }
9910: }
9911:
1.724 raeburn 9912: foreach my $tool ('aboutme','blog','portfolio') {
9913: $userenv{'availabletools.'.$tool} =
9914: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
9915: }
9916:
1.462 albertel 9917: $env{'user.environment'} = "$lonids/$cookie.id";
9918:
9919: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9920: &GDBM_WRCREAT(),0640)) {
9921: &_add_to_env(\%disk_env,\%initial_env);
9922: &_add_to_env(\%disk_env,\%userenv,'environment.');
9923: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9924: if (ref($args->{'extra_env'})) {
9925: &_add_to_env(\%disk_env,$args->{'extra_env'});
9926: }
1.462 albertel 9927: untie(%disk_env);
9928: } else {
1.705 tempelho 9929: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
9930: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 9931: return 'error: '.$!;
9932: }
9933: }
9934: $env{'request.role'}='cm';
9935: $env{'request.role.adv'}=$env{'user.adv'};
9936: $env{'browser.type'}=$clientbrowser;
9937:
9938: return $cookie;
9939:
9940: }
9941:
9942: sub _add_to_env {
9943: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9944: if (ref($env_data) eq 'HASH') {
9945: while (my ($key,$value) = each(%$env_data)) {
9946: $idf->{$prefix.$key} = $value;
9947: $env{$prefix.$key} = $value;
9948: }
1.462 albertel 9949: }
9950: }
9951:
1.685 tempelho 9952: # --- Get the symbolic name of a problem and the url
9953: sub get_symb {
9954: my ($request,$silent) = @_;
1.726 raeburn 9955: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 9956: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9957: if ($symb eq '') {
9958: if (!$silent) {
9959: $request->print("Unable to handle ambiguous references:$url:.");
9960: return ();
9961: }
9962: }
9963: &Apache::lonenc::check_decrypt(\$symb);
9964: return ($symb);
9965: }
9966:
9967: # --------------------------------------------------------------Get annotation
9968:
9969: sub get_annotation {
9970: my ($symb,$enc) = @_;
9971:
9972: my $key = $symb;
9973: if (!$enc) {
9974: $key =
9975: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9976: }
9977: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9978: return $annotation{$key};
9979: }
9980:
9981: sub clean_symb {
1.731 raeburn 9982: my ($symb,$delete_enc) = @_;
1.685 tempelho 9983:
9984: &Apache::lonenc::check_decrypt(\$symb);
9985: my $enc = $env{'request.enc'};
1.731 raeburn 9986: if ($delete_enc) {
1.730 raeburn 9987: delete($env{'request.enc'});
9988: }
1.685 tempelho 9989:
9990: return ($symb,$enc);
9991: }
1.462 albertel 9992:
1.41 ng 9993: =pod
9994:
9995: =back
9996:
1.112 bowersj2 9997: =cut
1.41 ng 9998:
1.112 bowersj2 9999: 1;
10000: __END__;
1.41 ng 10001:
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