Annotation of loncom/interface/loncommon.pm, revision 1.757
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.757 ! schulted 4: # $Id: loncommon.pm,v 1.756 2009/02/25 14:09:03 weissno 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.755 neumanie 926: if ($text ne "") {
927: $template.="<a style=\"background-color:#3333AA;\" target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;\">$text</span></a>";
1.48 bowersj2 928: }
929:
930: # Add the graphic
1.179 matthew 931: my $title = &mt('Online Help');
1.667 raeburn 932: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 933: $template .= <<"ENDTEMPLATE";
1.436 albertel 934: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 935: ENDTEMPLATE
1.755 neumanie 936:
1.44 bowersj2 937: return $template;
938:
1.106 bowersj2 939: }
940:
941: # This is a quicky function for Latex cheatsheet editing, since it
942: # appears in at least four places
943: sub helpLatexCheatsheet {
1.732 raeburn 944: my ($topic,$text,$not_author) = @_;
945: my $out;
1.106 bowersj2 946: my $addOther = '';
1.732 raeburn 947: if ($topic) {
948: $addOther = &Apache::loncommon::help_open_topic($topic,$text,
949: undef, undef, 600).
1.106 bowersj2 950: '</td><td>';
951: }
1.732 raeburn 952: $out = '<table><tr><td>'.
953: $addOther .
954: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
955: undef,undef,600).
956: '</td><td>'.
957: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
958: undef,undef,600).
959: '</td>';
960: unless ($not_author) {
961: $out .= '<td>'.
962: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
963: undef,undef,600).
964: '</td>';
965: }
966: $out .= '</tr></table>';
967: return $out;
1.172 www 968: }
969:
1.430 albertel 970: sub general_help {
971: my $helptopic='Student_Intro';
972: if ($env{'request.role'}=~/^(ca|au)/) {
973: $helptopic='Authoring_Intro';
974: } elsif ($env{'request.role'}=~/^cc/) {
975: $helptopic='Course_Coordination_Intro';
1.672 raeburn 976: } elsif ($env{'request.role'}=~/^dc/) {
977: $helptopic='Domain_Coordination_Intro';
1.430 albertel 978: }
979: return $helptopic;
980: }
981:
982: sub update_help_link {
983: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
984: my $origurl = $ENV{'REQUEST_URI'};
985: $origurl=~s|^/~|/priv/|;
986: my $timestamp = time;
987: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
988: $$datum = &escape($$datum);
989: }
990:
991: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
992: my $output .= <<"ENDOUTPUT";
993: <script type="text/javascript">
994: banner_link = '$banner_link';
995: </script>
996: ENDOUTPUT
997: return $output;
998: }
999:
1000: # now just updates the help link and generates a blue icon
1.193 raeburn 1001: sub help_open_menu {
1.430 albertel 1002: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1003: = @_;
1.430 albertel 1004: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1005: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1006: # if environment.remote is on (using remote control UI)
1.572 banghart 1007: if ($env{'browser.interface'} eq 'textual' ||
1008: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1009: $stayOnPage=1;
1.430 albertel 1010: }
1011: my $output;
1012: if ($component_help) {
1013: if (!$text) {
1014: $output=&help_open_topic($component_help,undef,$stayOnPage,
1015: $width,$height);
1016: } else {
1017: my $help_text;
1018: $help_text=&unescape($topic);
1019: $output='<table><tr><td>'.
1020: &help_open_topic($component_help,$help_text,$stayOnPage,
1021: $width,$height).'</td></tr></table>';
1022: }
1023: }
1024: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1025: return $output.$banner_link;
1026: }
1027:
1028: sub top_nav_help {
1029: my ($text) = @_;
1.436 albertel 1030: $text = &mt($text);
1.572 banghart 1031: my $stay_on_page =
1.436 albertel 1032: ($env{'browser.interface'} eq 'textual' ||
1033: $env{'environment.remote'} eq 'off' );
1.572 banghart 1034: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1035: : "javascript:helpMenu('open')";
1.572 banghart 1036: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1037:
1.201 raeburn 1038: my $title = &mt('Get help');
1.436 albertel 1039:
1040: return <<"END";
1041: $banner_link
1042: <a href="$link" title="$title">$text</a>
1043: END
1044: }
1045:
1046: sub help_menu_js {
1047: my ($text) = @_;
1048:
1049: my $stayOnPage =
1050: ($env{'browser.interface'} eq 'textual' ||
1051: $env{'environment.remote'} eq 'off' );
1052:
1053: my $width = 620;
1054: my $height = 600;
1.430 albertel 1055: my $helptopic=&general_help();
1056: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1057: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1058: my $start_page =
1059: &Apache::loncommon::start_page('Help Menu', undef,
1060: {'frameset' => 1,
1061: 'js_ready' => 1,
1062: 'add_entries' => {
1063: 'border' => '0',
1.579 raeburn 1064: 'rows' => "110,*",},});
1.331 albertel 1065: my $end_page =
1066: &Apache::loncommon::end_page({'frameset' => 1,
1067: 'js_ready' => 1,});
1068:
1.436 albertel 1069: my $template .= <<"ENDTEMPLATE";
1070: <script type="text/javascript">
1.253 albertel 1071: // <!-- BEGIN LON-CAPA Internal
1072: // <![CDATA[
1.430 albertel 1073: var banner_link = '';
1.243 raeburn 1074: function helpMenu(target) {
1075: var caller = this;
1076: if (target == 'open') {
1077: var newWindow = null;
1078: try {
1.262 albertel 1079: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1080: }
1081: catch(error) {
1082: writeHelp(caller);
1083: return;
1084: }
1085: if (newWindow) {
1086: caller = newWindow;
1087: }
1.193 raeburn 1088: }
1.243 raeburn 1089: writeHelp(caller);
1090: return;
1091: }
1092: function writeHelp(caller) {
1.430 albertel 1093: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1094: caller.document.close()
1095: caller.focus()
1.193 raeburn 1096: }
1.253 albertel 1097: // ]]>
1.219 albertel 1098: // END LON-CAPA Internal -->
1.436 albertel 1099: </script>
1.193 raeburn 1100: ENDTEMPLATE
1101: return $template;
1102: }
1103:
1.172 www 1104: sub help_open_bug {
1105: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1106: unless ($env{'user.adv'}) { return ''; }
1.172 www 1107: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1108: $text = "" if (not defined $text);
1109: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1110: if ($env{'browser.interface'} eq 'textual' ||
1111: $env{'environment.remote'} eq 'off' ) {
1.172 www 1112: $stayOnPage=1;
1113: }
1.184 albertel 1114: $width = 600 if (not defined $width);
1115: $height = 600 if (not defined $height);
1.172 www 1116:
1117: $topic=~s/\W+/\+/g;
1118: my $link='';
1119: my $template='';
1.379 albertel 1120: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1121: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1122: if (!$stayOnPage)
1123: {
1124: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1125: }
1126: else
1127: {
1128: $link = $url;
1129: }
1130: # Add the text
1131: if ($text ne "")
1132: {
1133: $template .=
1134: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1135: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1136: }
1137:
1138: # Add the graphic
1.179 matthew 1139: my $title = &mt('Report a Bug');
1.215 albertel 1140: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1141: $template .= <<"ENDTEMPLATE";
1.436 albertel 1142: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1143: ENDTEMPLATE
1144: if ($text ne '') { $template.='</td></tr></table>' };
1145: return $template;
1146:
1147: }
1148:
1149: sub help_open_faq {
1150: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1151: unless ($env{'user.adv'}) { return ''; }
1.172 www 1152: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1153: $text = "" if (not defined $text);
1154: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1155: if ($env{'browser.interface'} eq 'textual' ||
1156: $env{'environment.remote'} eq 'off' ) {
1.172 www 1157: $stayOnPage=1;
1158: }
1159: $width = 350 if (not defined $width);
1160: $height = 400 if (not defined $height);
1161:
1162: $topic=~s/\W+/\+/g;
1163: my $link='';
1164: my $template='';
1165: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1166: if (!$stayOnPage)
1167: {
1168: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1169: }
1170: else
1171: {
1172: $link = $url;
1173: }
1174:
1175: # Add the text
1176: if ($text ne "")
1177: {
1178: $template .=
1.173 www 1179: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1180: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1181: }
1182:
1183: # Add the graphic
1.179 matthew 1184: my $title = &mt('View the FAQ');
1.215 albertel 1185: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1186: $template .= <<"ENDTEMPLATE";
1.436 albertel 1187: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1188: ENDTEMPLATE
1189: if ($text ne '') { $template.='</td></tr></table>' };
1190: return $template;
1191:
1.44 bowersj2 1192: }
1.37 matthew 1193:
1.180 matthew 1194: ###############################################################
1195: ###############################################################
1196:
1.45 matthew 1197: =pod
1198:
1.648 raeburn 1199: =item * &change_content_javascript():
1.256 matthew 1200:
1201: This and the next function allow you to create small sections of an
1202: otherwise static HTML page that you can update on the fly with
1203: Javascript, even in Netscape 4.
1204:
1205: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1206: must be written to the HTML page once. It will prove the Javascript
1207: function "change(name, content)". Calling the change function with the
1208: name of the section
1209: you want to update, matching the name passed to C<changable_area>, and
1210: the new content you want to put in there, will put the content into
1211: that area.
1212:
1213: B<Note>: Netscape 4 only reserves enough space for the changable area
1214: to contain room for the original contents. You need to "make space"
1215: for whatever changes you wish to make, and be B<sure> to check your
1216: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1217: it's adequate for updating a one-line status display, but little more.
1218: This script will set the space to 100% width, so you only need to
1219: worry about height in Netscape 4.
1220:
1221: Modern browsers are much less limiting, and if you can commit to the
1222: user not using Netscape 4, this feature may be used freely with
1223: pretty much any HTML.
1224:
1225: =cut
1226:
1227: sub change_content_javascript {
1228: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1229: if ($env{'browser.type'} eq 'netscape' &&
1230: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1231: return (<<NETSCAPE4);
1232: function change(name, content) {
1233: doc = document.layers[name+"___escape"].layers[0].document;
1234: doc.open();
1235: doc.write(content);
1236: doc.close();
1237: }
1238: NETSCAPE4
1239: } else {
1240: # Otherwise, we need to use semi-standards-compliant code
1241: # (technically, "innerHTML" isn't standard but the equivalent
1242: # is really scary, and every useful browser supports it
1243: return (<<DOMBASED);
1244: function change(name, content) {
1245: element = document.getElementById(name);
1246: element.innerHTML = content;
1247: }
1248: DOMBASED
1249: }
1250: }
1251:
1252: =pod
1253:
1.648 raeburn 1254: =item * &changable_area($name,$origContent):
1.256 matthew 1255:
1256: This provides a "changable area" that can be modified on the fly via
1257: the Javascript code provided in C<change_content_javascript>. $name is
1258: the name you will use to reference the area later; do not repeat the
1259: same name on a given HTML page more then once. $origContent is what
1260: the area will originally contain, which can be left blank.
1261:
1262: =cut
1263:
1264: sub changable_area {
1265: my ($name, $origContent) = @_;
1266:
1.258 albertel 1267: if ($env{'browser.type'} eq 'netscape' &&
1268: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1269: # If this is netscape 4, we need to use the Layer tag
1270: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1271: } else {
1272: return "<span id='$name'>$origContent</span>";
1273: }
1274: }
1275:
1276: =pod
1277:
1.648 raeburn 1278: =item * &viewport_geometry_js
1.590 raeburn 1279:
1280: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1281:
1282: =cut
1283:
1284:
1285: sub viewport_geometry_js {
1286: return <<"GEOMETRY";
1287: var Geometry = {};
1288: function init_geometry() {
1289: if (Geometry.init) { return };
1290: Geometry.init=1;
1291: if (window.innerHeight) {
1292: Geometry.getViewportHeight = function() { return window.innerHeight; };
1293: Geometry.getViewportWidth = function() { return window.innerWidth; };
1294: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1295: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1296: }
1297: else if (document.documentElement && document.documentElement.clientHeight) {
1298: Geometry.getViewportHeight =
1299: function() { return document.documentElement.clientHeight; };
1300: Geometry.getViewportWidth =
1301: function() { return document.documentElement.clientWidth; };
1302:
1303: Geometry.getHorizontalScroll =
1304: function() { return document.documentElement.scrollLeft; };
1305: Geometry.getVerticalScroll =
1306: function() { return document.documentElement.scrollTop; };
1307: }
1308: else if (document.body.clientHeight) {
1309: Geometry.getViewportHeight =
1310: function() { return document.body.clientHeight; };
1311: Geometry.getViewportWidth =
1312: function() { return document.body.clientWidth; };
1313: Geometry.getHorizontalScroll =
1314: function() { return document.body.scrollLeft; };
1315: Geometry.getVerticalScroll =
1316: function() { return document.body.scrollTop; };
1317: }
1318: }
1319:
1320: GEOMETRY
1321: }
1322:
1323: =pod
1324:
1.648 raeburn 1325: =item * &viewport_size_js()
1.590 raeburn 1326:
1327: 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.
1328:
1329: =cut
1330:
1331: sub viewport_size_js {
1332: my $geometry = &viewport_geometry_js();
1333: return <<"DIMS";
1334:
1335: $geometry
1336:
1337: function getViewportDims(width,height) {
1338: init_geometry();
1339: width.value = Geometry.getViewportWidth();
1340: height.value = Geometry.getViewportHeight();
1341: return;
1342: }
1343:
1344: DIMS
1345: }
1346:
1347: =pod
1348:
1.648 raeburn 1349: =item * &resize_textarea_js()
1.565 albertel 1350:
1351: emits the needed javascript to resize a textarea to be as big as possible
1352:
1353: creates a function resize_textrea that takes two IDs first should be
1354: the id of the element to resize, second should be the id of a div that
1355: surrounds everything that comes after the textarea, this routine needs
1356: to be attached to the <body> for the onload and onresize events.
1357:
1.648 raeburn 1358: =back
1.565 albertel 1359:
1360: =cut
1361:
1362: sub resize_textarea_js {
1.590 raeburn 1363: my $geometry = &viewport_geometry_js();
1.565 albertel 1364: return <<"RESIZE";
1365: <script type="text/javascript">
1.590 raeburn 1366: $geometry
1.565 albertel 1367:
1.588 albertel 1368: function getX(element) {
1369: var x = 0;
1370: while (element) {
1371: x += element.offsetLeft;
1372: element = element.offsetParent;
1373: }
1374: return x;
1375: }
1376: function getY(element) {
1377: var y = 0;
1378: while (element) {
1379: y += element.offsetTop;
1380: element = element.offsetParent;
1381: }
1382: return y;
1383: }
1384:
1385:
1.565 albertel 1386: function resize_textarea(textarea_id,bottom_id) {
1387: init_geometry();
1388: var textarea = document.getElementById(textarea_id);
1389: //alert(textarea);
1390:
1.588 albertel 1391: var textarea_top = getY(textarea);
1.565 albertel 1392: var textarea_height = textarea.offsetHeight;
1393: var bottom = document.getElementById(bottom_id);
1.588 albertel 1394: var bottom_top = getY(bottom);
1.565 albertel 1395: var bottom_height = bottom.offsetHeight;
1396: var window_height = Geometry.getViewportHeight();
1.588 albertel 1397: var fudge = 23;
1.565 albertel 1398: var new_height = window_height-fudge-textarea_top-bottom_height;
1399: if (new_height < 300) {
1400: new_height = 300;
1401: }
1402: textarea.style.height=new_height+'px';
1403: }
1404: </script>
1405: RESIZE
1406:
1407: }
1408:
1409: =pod
1410:
1.256 matthew 1411: =head1 Excel and CSV file utility routines
1412:
1413: =over 4
1414:
1415: =cut
1416:
1417: ###############################################################
1418: ###############################################################
1419:
1420: =pod
1421:
1.648 raeburn 1422: =item * &csv_translate($text)
1.37 matthew 1423:
1.185 www 1424: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1425: format.
1426:
1427: =cut
1428:
1.180 matthew 1429: ###############################################################
1430: ###############################################################
1.37 matthew 1431: sub csv_translate {
1432: my $text = shift;
1433: $text =~ s/\"/\"\"/g;
1.209 albertel 1434: $text =~ s/\n/ /g;
1.37 matthew 1435: return $text;
1436: }
1.180 matthew 1437:
1438: ###############################################################
1439: ###############################################################
1440:
1441: =pod
1442:
1.648 raeburn 1443: =item * &define_excel_formats()
1.180 matthew 1444:
1445: Define some commonly used Excel cell formats.
1446:
1447: Currently supported formats:
1448:
1449: =over 4
1450:
1451: =item header
1452:
1453: =item bold
1454:
1455: =item h1
1456:
1457: =item h2
1458:
1459: =item h3
1460:
1.256 matthew 1461: =item h4
1462:
1463: =item i
1464:
1.180 matthew 1465: =item date
1466:
1467: =back
1468:
1469: Inputs: $workbook
1470:
1471: Returns: $format, a hash reference.
1472:
1473: =cut
1474:
1475: ###############################################################
1476: ###############################################################
1477: sub define_excel_formats {
1478: my ($workbook) = @_;
1479: my $format;
1480: $format->{'header'} = $workbook->add_format(bold => 1,
1481: bottom => 1,
1482: align => 'center');
1483: $format->{'bold'} = $workbook->add_format(bold=>1);
1484: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1485: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1486: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1487: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1488: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1489: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1490: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1491: return $format;
1492: }
1493:
1494: ###############################################################
1495: ###############################################################
1.113 bowersj2 1496:
1497: =pod
1498:
1.648 raeburn 1499: =item * &create_workbook()
1.255 matthew 1500:
1501: Create an Excel worksheet. If it fails, output message on the
1502: request object and return undefs.
1503:
1504: Inputs: Apache request object
1505:
1506: Returns (undef) on failure,
1507: Excel worksheet object, scalar with filename, and formats
1508: from &Apache::loncommon::define_excel_formats on success
1509:
1510: =cut
1511:
1512: ###############################################################
1513: ###############################################################
1514: sub create_workbook {
1515: my ($r) = @_;
1516: #
1517: # Create the excel spreadsheet
1518: my $filename = '/prtspool/'.
1.258 albertel 1519: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1520: time.'_'.rand(1000000000).'.xls';
1521: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1522: if (! defined($workbook)) {
1523: $r->log_error("Error creating excel spreadsheet $filename: $!");
1524: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1525: "This error has been logged. ".
1526: "Please alert your LON-CAPA administrator").
1527: '</p>');
1528: return (undef);
1529: }
1530: #
1531: $workbook->set_tempdir('/home/httpd/perl/tmp');
1532: #
1533: my $format = &Apache::loncommon::define_excel_formats($workbook);
1534: return ($workbook,$filename,$format);
1535: }
1536:
1537: ###############################################################
1538: ###############################################################
1539:
1540: =pod
1541:
1.648 raeburn 1542: =item * &create_text_file()
1.113 bowersj2 1543:
1.542 raeburn 1544: Create a file to write to and eventually make available to the user.
1.256 matthew 1545: If file creation fails, outputs an error message on the request object and
1546: return undefs.
1.113 bowersj2 1547:
1.256 matthew 1548: Inputs: Apache request object, and file suffix
1.113 bowersj2 1549:
1.256 matthew 1550: Returns (undef) on failure,
1551: Filehandle and filename on success.
1.113 bowersj2 1552:
1553: =cut
1554:
1.256 matthew 1555: ###############################################################
1556: ###############################################################
1557: sub create_text_file {
1558: my ($r,$suffix) = @_;
1559: if (! defined($suffix)) { $suffix = 'txt'; };
1560: my $fh;
1561: my $filename = '/prtspool/'.
1.258 albertel 1562: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1563: time.'_'.rand(1000000000).'.'.$suffix;
1564: $fh = Apache::File->new('>/home/httpd'.$filename);
1565: if (! defined($fh)) {
1566: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1567: $r->print(&mt('Problems occurred in creating the output file. '
1568: .'This error has been logged. '
1569: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1570: }
1.256 matthew 1571: return ($fh,$filename)
1.113 bowersj2 1572: }
1573:
1574:
1.256 matthew 1575: =pod
1.113 bowersj2 1576:
1577: =back
1578:
1579: =cut
1.37 matthew 1580:
1581: ###############################################################
1.33 matthew 1582: ## Home server <option> list generating code ##
1583: ###############################################################
1.35 matthew 1584:
1.169 www 1585: # ------------------------------------------
1586:
1587: sub domain_select {
1588: my ($name,$value,$multiple)=@_;
1589: my %domains=map {
1.514 albertel 1590: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1591: } &Apache::lonnet::all_domains();
1.169 www 1592: if ($multiple) {
1593: $domains{''}=&mt('Any domain');
1.550 albertel 1594: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1595: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1596: } else {
1.550 albertel 1597: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1598: return &select_form($name,$value,%domains);
1599: }
1600: }
1601:
1.282 albertel 1602: #-------------------------------------------
1603:
1604: =pod
1605:
1.519 raeburn 1606: =head1 Routines for form select boxes
1607:
1608: =over 4
1609:
1.648 raeburn 1610: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1611:
1612: Returns a string containing a <select> element int multiple mode
1613:
1614:
1615: Args:
1616: $name - name of the <select> element
1.506 raeburn 1617: $value - scalar or array ref of values that should already be selected
1.282 albertel 1618: $size - number of rows long the select element is
1.283 albertel 1619: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1620: (shown text should already have been &mt())
1.506 raeburn 1621: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1622:
1.282 albertel 1623: =cut
1624:
1625: #-------------------------------------------
1.169 www 1626: sub multiple_select_form {
1.284 albertel 1627: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1628: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1629: my $output='';
1.191 matthew 1630: if (! defined($size)) {
1631: $size = 4;
1.283 albertel 1632: if (scalar(keys(%$hash))<4) {
1633: $size = scalar(keys(%$hash));
1.191 matthew 1634: }
1635: }
1.734 bisitz 1636: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1637: my @order;
1.506 raeburn 1638: if (ref($order) eq 'ARRAY') {
1639: @order = @{$order};
1640: } else {
1641: @order = sort(keys(%$hash));
1.501 banghart 1642: }
1643: if (exists($$hash{'select_form_order'})) {
1644: @order = @{$$hash{'select_form_order'}};
1645: }
1646:
1.284 albertel 1647: foreach my $key (@order) {
1.356 albertel 1648: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1649: $output.='selected="selected" ' if ($selected{$key});
1650: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1651: }
1652: $output.="</select>\n";
1653: return $output;
1654: }
1655:
1.88 www 1656: #-------------------------------------------
1657:
1658: =pod
1659:
1.648 raeburn 1660: =item * &select_form($defdom,$name,%hash)
1.88 www 1661:
1662: Returns a string containing a <select name='$name' size='1'> form to
1663: allow a user to select options from a hash option_name => displayed text.
1664: See lonrights.pm for an example invocation and use.
1665:
1666: =cut
1667:
1668: #-------------------------------------------
1669: sub select_form {
1670: my ($def,$name,%hash) = @_;
1671: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1672: my @keys;
1673: if (exists($hash{'select_form_order'})) {
1674: @keys=@{$hash{'select_form_order'}};
1675: } else {
1676: @keys=sort(keys(%hash));
1677: }
1.356 albertel 1678: foreach my $key (@keys) {
1679: $selectform.=
1680: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1681: ($key eq $def ? 'selected="selected" ' : '').
1682: ">".&mt($hash{$key})."</option>\n";
1.88 www 1683: }
1684: $selectform.="</select>";
1685: return $selectform;
1686: }
1687:
1.475 www 1688: # For display filters
1689:
1690: sub display_filter {
1691: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1692: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1693: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1694: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1695: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1696: '</label></span> <span class="LC_nobreak">'.
1.475 www 1697: &mt('Filter [_1]',
1.477 www 1698: &select_form($env{'form.displayfilter'},
1699: 'displayfilter',
1700: ('currentfolder' => 'Current folder/page',
1701: 'containing' => 'Containing phrase',
1702: 'none' => 'None'))).
1.714 bisitz 1703: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1704: }
1705:
1.167 www 1706: sub gradeleveldescription {
1707: my $gradelevel=shift;
1708: my %gradelevels=(0 => 'Not specified',
1709: 1 => 'Grade 1',
1710: 2 => 'Grade 2',
1711: 3 => 'Grade 3',
1712: 4 => 'Grade 4',
1713: 5 => 'Grade 5',
1714: 6 => 'Grade 6',
1715: 7 => 'Grade 7',
1716: 8 => 'Grade 8',
1717: 9 => 'Grade 9',
1718: 10 => 'Grade 10',
1719: 11 => 'Grade 11',
1720: 12 => 'Grade 12',
1721: 13 => 'Grade 13',
1722: 14 => '100 Level',
1723: 15 => '200 Level',
1724: 16 => '300 Level',
1725: 17 => '400 Level',
1726: 18 => 'Graduate Level');
1727: return &mt($gradelevels{$gradelevel});
1728: }
1729:
1.163 www 1730: sub select_level_form {
1731: my ($deflevel,$name)=@_;
1732: unless ($deflevel) { $deflevel=0; }
1.167 www 1733: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1734: for (my $i=0; $i<=18; $i++) {
1735: $selectform.="<option value=\"$i\" ".
1.253 albertel 1736: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1737: ">".&gradeleveldescription($i)."</option>\n";
1738: }
1739: $selectform.="</select>";
1740: return $selectform;
1.163 www 1741: }
1.167 www 1742:
1.35 matthew 1743: #-------------------------------------------
1744:
1.45 matthew 1745: =pod
1746:
1.743 raeburn 1747: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1748:
1749: Returns a string containing a <select name='$name' size='1'> form to
1750: allow a user to select the domain to preform an operation in.
1751: See loncreateuser.pm for an example invocation and use.
1752:
1.90 www 1753: If the $includeempty flag is set, it also includes an empty choice ("no domain
1754: selected");
1755:
1.743 raeburn 1756: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1757:
1758: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1759:
1.35 matthew 1760: =cut
1761:
1762: #-------------------------------------------
1.34 matthew 1763: sub select_dom_form {
1.743 raeburn 1764: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1765: my $onchange;
1766: if ($autosubmit) {
1767: $onchange = ' onchange="this.form.submit()"';
1768: }
1.550 albertel 1769: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1770: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1771: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1772: foreach my $dom (@domains) {
1773: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1774: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1775: if ($showdomdesc) {
1776: if ($dom ne '') {
1777: my $domdesc = &Apache::lonnet::domain($dom,'description');
1778: if ($domdesc ne '') {
1779: $selectdomain .= ' ('.$domdesc.')';
1780: }
1781: }
1782: }
1783: $selectdomain .= "</option>\n";
1.34 matthew 1784: }
1785: $selectdomain.="</select>";
1786: return $selectdomain;
1787: }
1788:
1.35 matthew 1789: #-------------------------------------------
1790:
1.45 matthew 1791: =pod
1792:
1.648 raeburn 1793: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1794:
1.586 raeburn 1795: input: 4 arguments (two required, two optional) -
1796: $domain - domain of new user
1797: $name - name of form element
1798: $default - Value of 'default' causes a default item to be first
1799: option, and selected by default.
1800: $hide - Value of 'hide' causes hiding of the name of the server,
1801: if 1 server found, or default, if 0 found.
1.594 raeburn 1802: output: returns 2 items:
1.586 raeburn 1803: (a) form element which contains either:
1804: (i) <select name="$name">
1805: <option value="$hostid1">$hostid $servers{$hostid}</option>
1806: <option value="$hostid2">$hostid $servers{$hostid}</option>
1807: </select>
1808: form item if there are multiple library servers in $domain, or
1809: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1810: if there is only one library server in $domain.
1811:
1812: (b) number of library servers found.
1813:
1814: See loncreateuser.pm for example of use.
1.35 matthew 1815:
1816: =cut
1817:
1818: #-------------------------------------------
1.586 raeburn 1819: sub home_server_form_item {
1820: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1821: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1822: my $result;
1823: my $numlib = keys(%servers);
1824: if ($numlib > 1) {
1825: $result .= '<select name="'.$name.'" />'."\n";
1826: if ($default) {
1827: $result .= '<option value="default" selected>'.&mt('default').
1828: '</option>'."\n";
1829: }
1830: foreach my $hostid (sort(keys(%servers))) {
1831: $result.= '<option value="'.$hostid.'">'.
1832: $hostid.' '.$servers{$hostid}."</option>\n";
1833: }
1834: $result .= '</select>'."\n";
1835: } elsif ($numlib == 1) {
1836: my $hostid;
1837: foreach my $item (keys(%servers)) {
1838: $hostid = $item;
1839: }
1840: $result .= '<input type="hidden" name="'.$name.'" value="'.
1841: $hostid.'" />';
1842: if (!$hide) {
1843: $result .= $hostid.' '.$servers{$hostid};
1844: }
1845: $result .= "\n";
1846: } elsif ($default) {
1847: $result .= '<input type="hidden" name="'.$name.
1848: '" value="default" />';
1849: if (!$hide) {
1850: $result .= &mt('default');
1851: }
1852: $result .= "\n";
1.33 matthew 1853: }
1.586 raeburn 1854: return ($result,$numlib);
1.33 matthew 1855: }
1.112 bowersj2 1856:
1857: =pod
1858:
1.534 albertel 1859: =back
1860:
1.112 bowersj2 1861: =cut
1.87 matthew 1862:
1863: ###############################################################
1.112 bowersj2 1864: ## Decoding User Agent ##
1.87 matthew 1865: ###############################################################
1866:
1867: =pod
1868:
1.112 bowersj2 1869: =head1 Decoding the User Agent
1870:
1871: =over 4
1872:
1873: =item * &decode_user_agent()
1.87 matthew 1874:
1875: Inputs: $r
1876:
1877: Outputs:
1878:
1879: =over 4
1880:
1.112 bowersj2 1881: =item * $httpbrowser
1.87 matthew 1882:
1.112 bowersj2 1883: =item * $clientbrowser
1.87 matthew 1884:
1.112 bowersj2 1885: =item * $clientversion
1.87 matthew 1886:
1.112 bowersj2 1887: =item * $clientmathml
1.87 matthew 1888:
1.112 bowersj2 1889: =item * $clientunicode
1.87 matthew 1890:
1.112 bowersj2 1891: =item * $clientos
1.87 matthew 1892:
1893: =back
1894:
1.157 matthew 1895: =back
1896:
1.87 matthew 1897: =cut
1898:
1899: ###############################################################
1900: ###############################################################
1901: sub decode_user_agent {
1.247 albertel 1902: my ($r)=@_;
1.87 matthew 1903: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1904: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1905: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1906: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1907: my $clientbrowser='unknown';
1908: my $clientversion='0';
1909: my $clientmathml='';
1910: my $clientunicode='0';
1911: for (my $i=0;$i<=$#browsertype;$i++) {
1912: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1913: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1914: $clientbrowser=$bname;
1915: $httpbrowser=~/$vreg/i;
1916: $clientversion=$1;
1917: $clientmathml=($clientversion>=$minv);
1918: $clientunicode=($clientversion>=$univ);
1919: }
1920: }
1921: my $clientos='unknown';
1922: if (($httpbrowser=~/linux/i) ||
1923: ($httpbrowser=~/unix/i) ||
1924: ($httpbrowser=~/ux/i) ||
1925: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1926: if (($httpbrowser=~/vax/i) ||
1927: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1928: if ($httpbrowser=~/next/i) { $clientos='next'; }
1929: if (($httpbrowser=~/mac/i) ||
1930: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1931: if ($httpbrowser=~/win/i) { $clientos='win'; }
1932: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1933: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1934: $clientunicode,$clientos,);
1935: }
1936:
1.32 matthew 1937: ###############################################################
1938: ## Authentication changing form generation subroutines ##
1939: ###############################################################
1940: ##
1941: ## All of the authform_xxxxxxx subroutines take their inputs in a
1942: ## hash, and have reasonable default values.
1943: ##
1944: ## formname = the name given in the <form> tag.
1.35 matthew 1945: #-------------------------------------------
1946:
1.45 matthew 1947: =pod
1948:
1.112 bowersj2 1949: =head1 Authentication Routines
1950:
1951: =over 4
1952:
1.648 raeburn 1953: =item * &authform_xxxxxx()
1.35 matthew 1954:
1955: The authform_xxxxxx subroutines provide javascript and html forms which
1956: handle some of the conveniences required for authentication forms.
1957: This is not an optimal method, but it works.
1958:
1959: =over 4
1960:
1.112 bowersj2 1961: =item * authform_header
1.35 matthew 1962:
1.112 bowersj2 1963: =item * authform_authorwarning
1.35 matthew 1964:
1.112 bowersj2 1965: =item * authform_nochange
1.35 matthew 1966:
1.112 bowersj2 1967: =item * authform_kerberos
1.35 matthew 1968:
1.112 bowersj2 1969: =item * authform_internal
1.35 matthew 1970:
1.112 bowersj2 1971: =item * authform_filesystem
1.35 matthew 1972:
1973: =back
1974:
1.648 raeburn 1975: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1976:
1.35 matthew 1977: =cut
1978:
1979: #-------------------------------------------
1.32 matthew 1980: sub authform_header{
1981: my %in = (
1982: formname => 'cu',
1.80 albertel 1983: kerb_def_dom => '',
1.32 matthew 1984: @_,
1985: );
1986: $in{'formname'} = 'document.' . $in{'formname'};
1987: my $result='';
1.80 albertel 1988:
1989: #---------------------------------------------- Code for upper case translation
1990: my $Javascript_toUpperCase;
1991: unless ($in{kerb_def_dom}) {
1992: $Javascript_toUpperCase =<<"END";
1993: switch (choice) {
1994: case 'krb': currentform.elements[choicearg].value =
1995: currentform.elements[choicearg].value.toUpperCase();
1996: break;
1997: default:
1998: }
1999: END
2000: } else {
2001: $Javascript_toUpperCase = "";
2002: }
2003:
1.165 raeburn 2004: my $radioval = "'nochange'";
1.591 raeburn 2005: if (defined($in{'curr_authtype'})) {
2006: if ($in{'curr_authtype'} ne '') {
2007: $radioval = "'".$in{'curr_authtype'}."arg'";
2008: }
1.174 matthew 2009: }
1.165 raeburn 2010: my $argfield = 'null';
1.591 raeburn 2011: if (defined($in{'mode'})) {
1.165 raeburn 2012: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2013: if (defined($in{'curr_autharg'})) {
2014: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2015: $argfield = "'$in{'curr_autharg'}'";
2016: }
2017: }
2018: }
2019: }
2020:
1.32 matthew 2021: $result.=<<"END";
2022: var current = new Object();
1.165 raeburn 2023: current.radiovalue = $radioval;
2024: current.argfield = $argfield;
1.32 matthew 2025:
2026: function changed_radio(choice,currentform) {
2027: var choicearg = choice + 'arg';
2028: // If a radio button in changed, we need to change the argfield
2029: if (current.radiovalue != choice) {
2030: current.radiovalue = choice;
2031: if (current.argfield != null) {
2032: currentform.elements[current.argfield].value = '';
2033: }
2034: if (choice == 'nochange') {
2035: current.argfield = null;
2036: } else {
2037: current.argfield = choicearg;
2038: switch(choice) {
2039: case 'krb':
2040: currentform.elements[current.argfield].value =
2041: "$in{'kerb_def_dom'}";
2042: break;
2043: default:
2044: break;
2045: }
2046: }
2047: }
2048: return;
2049: }
1.22 www 2050:
1.32 matthew 2051: function changed_text(choice,currentform) {
2052: var choicearg = choice + 'arg';
2053: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2054: $Javascript_toUpperCase
1.32 matthew 2055: // clear old field
2056: if ((current.argfield != choicearg) && (current.argfield != null)) {
2057: currentform.elements[current.argfield].value = '';
2058: }
2059: current.argfield = choicearg;
2060: }
2061: set_auth_radio_buttons(choice,currentform);
2062: return;
1.20 www 2063: }
1.32 matthew 2064:
2065: function set_auth_radio_buttons(newvalue,currentform) {
2066: var i=0;
2067: while (i < currentform.login.length) {
2068: if (currentform.login[i].value == newvalue) { break; }
2069: i++;
2070: }
2071: if (i == currentform.login.length) {
2072: return;
2073: }
2074: current.radiovalue = newvalue;
2075: currentform.login[i].checked = true;
2076: return;
2077: }
2078: END
2079: return $result;
2080: }
2081:
2082: sub authform_authorwarning{
2083: my $result='';
1.144 matthew 2084: $result='<i>'.
2085: &mt('As a general rule, only authors or co-authors should be '.
2086: 'filesystem authenticated '.
2087: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2088: return $result;
2089: }
2090:
2091: sub authform_nochange{
2092: my %in = (
2093: formname => 'document.cu',
2094: kerb_def_dom => 'MSU.EDU',
2095: @_,
2096: );
1.586 raeburn 2097: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2098: my $result;
2099: if (keys(%can_assign) == 0) {
2100: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2101: } else {
2102: $result = '<label>'.&mt('[_1] Do not change login data',
2103: '<input type="radio" name="login" value="nochange" '.
2104: 'checked="checked" onclick="'.
1.281 albertel 2105: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2106: '</label>';
1.586 raeburn 2107: }
1.32 matthew 2108: return $result;
2109: }
2110:
1.591 raeburn 2111: sub authform_kerberos {
1.32 matthew 2112: my %in = (
2113: formname => 'document.cu',
2114: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2115: kerb_def_auth => 'krb4',
1.32 matthew 2116: @_,
2117: );
1.586 raeburn 2118: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2119: $autharg,$jscall);
2120: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2121: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2122: $check5 = ' checked="on"';
1.80 albertel 2123: } else {
1.586 raeburn 2124: $check4 = ' checked="on"';
1.80 albertel 2125: }
1.165 raeburn 2126: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2127: if (defined($in{'curr_authtype'})) {
2128: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2129: $krbcheck = ' checked="on"';
1.623 raeburn 2130: if (defined($in{'mode'})) {
2131: if ($in{'mode'} eq 'modifyuser') {
2132: $krbcheck = '';
2133: }
2134: }
1.591 raeburn 2135: if (defined($in{'curr_kerb_ver'})) {
2136: if ($in{'curr_krb_ver'} eq '5') {
2137: $check5 = ' checked="on"';
2138: $check4 = '';
2139: } else {
2140: $check4 = ' checked="on"';
2141: $check5 = '';
2142: }
1.586 raeburn 2143: }
1.591 raeburn 2144: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2145: $krbarg = $in{'curr_autharg'};
2146: }
1.586 raeburn 2147: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2148: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2149: $result =
2150: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2151: $in{'curr_autharg'},$krbver);
2152: } else {
2153: $result =
2154: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2155: }
2156: return $result;
2157: }
2158: }
2159: } else {
2160: if ($authnum == 1) {
2161: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2162: }
2163: }
1.586 raeburn 2164: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2165: return;
1.587 raeburn 2166: } elsif ($authtype eq '') {
1.591 raeburn 2167: if (defined($in{'mode'})) {
1.587 raeburn 2168: if ($in{'mode'} eq 'modifycourse') {
2169: if ($authnum == 1) {
2170: $authtype = '<input type="hidden" name="login" value="krb">';
2171: }
2172: }
2173: }
1.586 raeburn 2174: }
2175: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2176: if ($authtype eq '') {
2177: $authtype = '<input type="radio" name="login" value="krb" '.
2178: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2179: $krbcheck.' />';
2180: }
2181: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2182: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2183: $in{'curr_authtype'} eq 'krb5') ||
2184: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2185: $in{'curr_authtype'} eq 'krb4')) {
2186: $result .= &mt
1.144 matthew 2187: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2188: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2189: '<label>'.$authtype,
1.281 albertel 2190: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2191: 'value="'.$krbarg.'" '.
1.144 matthew 2192: 'onchange="'.$jscall.'" />',
1.281 albertel 2193: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2194: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2195: '</label>');
1.586 raeburn 2196: } elsif ($can_assign{'krb4'}) {
2197: $result .= &mt
2198: ('[_1] Kerberos authenticated with domain [_2] '.
2199: '[_3] Version 4 [_4]',
2200: '<label>'.$authtype,
2201: '</label><input type="text" size="10" name="krbarg" '.
2202: 'value="'.$krbarg.'" '.
2203: 'onchange="'.$jscall.'" />',
2204: '<label><input type="hidden" name="krbver" value="4" />',
2205: '</label>');
2206: } elsif ($can_assign{'krb5'}) {
2207: $result .= &mt
2208: ('[_1] Kerberos authenticated with domain [_2] '.
2209: '[_3] Version 5 [_4]',
2210: '<label>'.$authtype,
2211: '</label><input type="text" size="10" name="krbarg" '.
2212: 'value="'.$krbarg.'" '.
2213: 'onchange="'.$jscall.'" />',
2214: '<label><input type="hidden" name="krbver" value="5" />',
2215: '</label>');
2216: }
1.32 matthew 2217: return $result;
2218: }
2219:
2220: sub authform_internal{
1.586 raeburn 2221: my %in = (
1.32 matthew 2222: formname => 'document.cu',
2223: kerb_def_dom => 'MSU.EDU',
2224: @_,
2225: );
1.586 raeburn 2226: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2227: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2228: if (defined($in{'curr_authtype'})) {
2229: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2230: if ($can_assign{'int'}) {
2231: $intcheck = 'checked="on" ';
1.623 raeburn 2232: if (defined($in{'mode'})) {
2233: if ($in{'mode'} eq 'modifyuser') {
2234: $intcheck = '';
2235: }
2236: }
1.591 raeburn 2237: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2238: $intarg = $in{'curr_autharg'};
2239: }
2240: } else {
2241: $result = &mt('Currently internally authenticated.');
2242: return $result;
1.165 raeburn 2243: }
2244: }
1.586 raeburn 2245: } else {
2246: if ($authnum == 1) {
2247: $authtype = '<input type="hidden" name="login" value="int">';
2248: }
2249: }
2250: if (!$can_assign{'int'}) {
2251: return;
1.587 raeburn 2252: } elsif ($authtype eq '') {
1.591 raeburn 2253: if (defined($in{'mode'})) {
1.587 raeburn 2254: if ($in{'mode'} eq 'modifycourse') {
2255: if ($authnum == 1) {
2256: $authtype = '<input type="hidden" name="login" value="int">';
2257: }
2258: }
2259: }
1.165 raeburn 2260: }
1.586 raeburn 2261: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2262: if ($authtype eq '') {
2263: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2264: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2265: }
1.605 bisitz 2266: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2267: $intarg.'" onchange="'.$jscall.'" />';
2268: $result = &mt
1.144 matthew 2269: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2270: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2271: $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 2272: return $result;
2273: }
2274:
2275: sub authform_local{
2276: my %in = (
2277: formname => 'document.cu',
2278: kerb_def_dom => 'MSU.EDU',
2279: @_,
2280: );
1.586 raeburn 2281: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2282: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2283: if (defined($in{'curr_authtype'})) {
2284: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2285: if ($can_assign{'loc'}) {
2286: $loccheck = 'checked="on" ';
1.623 raeburn 2287: if (defined($in{'mode'})) {
2288: if ($in{'mode'} eq 'modifyuser') {
2289: $loccheck = '';
2290: }
2291: }
1.591 raeburn 2292: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2293: $locarg = $in{'curr_autharg'};
2294: }
2295: } else {
2296: $result = &mt('Currently using local (institutional) authentication.');
2297: return $result;
1.165 raeburn 2298: }
2299: }
1.586 raeburn 2300: } else {
2301: if ($authnum == 1) {
2302: $authtype = '<input type="hidden" name="login" value="loc">';
2303: }
2304: }
2305: if (!$can_assign{'loc'}) {
2306: return;
1.587 raeburn 2307: } elsif ($authtype eq '') {
1.591 raeburn 2308: if (defined($in{'mode'})) {
1.587 raeburn 2309: if ($in{'mode'} eq 'modifycourse') {
2310: if ($authnum == 1) {
2311: $authtype = '<input type="hidden" name="login" value="loc">';
2312: }
2313: }
2314: }
1.165 raeburn 2315: }
1.586 raeburn 2316: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2317: if ($authtype eq '') {
2318: $authtype = '<input type="radio" name="login" value="loc" '.
2319: $loccheck.' onchange="'.$jscall.'" onclick="'.
2320: $jscall.'" />';
2321: }
2322: $autharg = '<input type="text" size="10" name="locarg" value="'.
2323: $locarg.'" onchange="'.$jscall.'" />';
2324: $result = &mt('[_1] Local Authentication with argument [_2]',
2325: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2326: return $result;
2327: }
2328:
2329: sub authform_filesystem{
2330: my %in = (
2331: formname => 'document.cu',
2332: kerb_def_dom => 'MSU.EDU',
2333: @_,
2334: );
1.586 raeburn 2335: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2336: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2337: if (defined($in{'curr_authtype'})) {
2338: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2339: if ($can_assign{'fsys'}) {
2340: $fsyscheck = 'checked="on" ';
1.623 raeburn 2341: if (defined($in{'mode'})) {
2342: if ($in{'mode'} eq 'modifyuser') {
2343: $fsyscheck = '';
2344: }
2345: }
1.586 raeburn 2346: } else {
2347: $result = &mt('Currently Filesystem Authenticated.');
2348: return $result;
2349: }
2350: }
2351: } else {
2352: if ($authnum == 1) {
2353: $authtype = '<input type="hidden" name="login" value="fsys">';
2354: }
2355: }
2356: if (!$can_assign{'fsys'}) {
2357: return;
1.587 raeburn 2358: } elsif ($authtype eq '') {
1.591 raeburn 2359: if (defined($in{'mode'})) {
1.587 raeburn 2360: if ($in{'mode'} eq 'modifycourse') {
2361: if ($authnum == 1) {
2362: $authtype = '<input type="hidden" name="login" value="fsys">';
2363: }
2364: }
2365: }
1.586 raeburn 2366: }
2367: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2368: if ($authtype eq '') {
2369: $authtype = '<input type="radio" name="login" value="fsys" '.
2370: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2371: $jscall.'" />';
2372: }
2373: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2374: ' onchange="'.$jscall.'" />';
2375: $result = &mt
1.144 matthew 2376: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2377: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2378: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2379: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2380: 'onchange="'.$jscall.'" />');
1.32 matthew 2381: return $result;
2382: }
2383:
1.586 raeburn 2384: sub get_assignable_auth {
2385: my ($dom) = @_;
2386: if ($dom eq '') {
2387: $dom = $env{'request.role.domain'};
2388: }
2389: my %can_assign = (
2390: krb4 => 1,
2391: krb5 => 1,
2392: int => 1,
2393: loc => 1,
2394: );
2395: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2396: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2397: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2398: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2399: my $context;
2400: if ($env{'request.role'} =~ /^au/) {
2401: $context = 'author';
2402: } elsif ($env{'request.role'} =~ /^dc/) {
2403: $context = 'domain';
2404: } elsif ($env{'request.course.id'}) {
2405: $context = 'course';
2406: }
2407: if ($context) {
2408: if (ref($authhash->{$context}) eq 'HASH') {
2409: %can_assign = %{$authhash->{$context}};
2410: }
2411: }
2412: }
2413: }
2414: my $authnum = 0;
2415: foreach my $key (keys(%can_assign)) {
2416: if ($can_assign{$key}) {
2417: $authnum ++;
2418: }
2419: }
2420: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2421: $authnum --;
2422: }
2423: return ($authnum,%can_assign);
2424: }
2425:
1.80 albertel 2426: ###############################################################
2427: ## Get Kerberos Defaults for Domain ##
2428: ###############################################################
2429: ##
2430: ## Returns default kerberos version and an associated argument
2431: ## as listed in file domain.tab. If not listed, provides
2432: ## appropriate default domain and kerberos version.
2433: ##
2434: #-------------------------------------------
2435:
2436: =pod
2437:
1.648 raeburn 2438: =item * &get_kerberos_defaults()
1.80 albertel 2439:
2440: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2441: version and domain. If not found, it defaults to version 4 and the
2442: domain of the server.
1.80 albertel 2443:
1.648 raeburn 2444: =over 4
2445:
1.80 albertel 2446: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2447:
1.648 raeburn 2448: =back
2449:
2450: =back
2451:
1.80 albertel 2452: =cut
2453:
2454: #-------------------------------------------
2455: sub get_kerberos_defaults {
2456: my $domain=shift;
1.641 raeburn 2457: my ($krbdef,$krbdefdom);
2458: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2459: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2460: $krbdef = $domdefaults{'auth_def'};
2461: $krbdefdom = $domdefaults{'auth_arg_def'};
2462: } else {
1.80 albertel 2463: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2464: my $krbdefdom=$1;
2465: $krbdefdom=~tr/a-z/A-Z/;
2466: $krbdef = "krb4";
2467: }
2468: return ($krbdef,$krbdefdom);
2469: }
1.112 bowersj2 2470:
1.32 matthew 2471:
1.46 matthew 2472: ###############################################################
2473: ## Thesaurus Functions ##
2474: ###############################################################
1.20 www 2475:
1.46 matthew 2476: =pod
1.20 www 2477:
1.112 bowersj2 2478: =head1 Thesaurus Functions
2479:
2480: =over 4
2481:
1.648 raeburn 2482: =item * &initialize_keywords()
1.46 matthew 2483:
2484: Initializes the package variable %Keywords if it is empty. Uses the
2485: package variable $thesaurus_db_file.
2486:
2487: =cut
2488:
2489: ###################################################
2490:
2491: sub initialize_keywords {
2492: return 1 if (scalar keys(%Keywords));
2493: # If we are here, %Keywords is empty, so fill it up
2494: # Make sure the file we need exists...
2495: if (! -e $thesaurus_db_file) {
2496: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2497: " failed because it does not exist");
2498: return 0;
2499: }
2500: # Set up the hash as a database
2501: my %thesaurus_db;
2502: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2503: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2504: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2505: $thesaurus_db_file);
2506: return 0;
2507: }
2508: # Get the average number of appearances of a word.
2509: my $avecount = $thesaurus_db{'average.count'};
2510: # Put keywords (those that appear > average) into %Keywords
2511: while (my ($word,$data)=each (%thesaurus_db)) {
2512: my ($count,undef) = split /:/,$data;
2513: $Keywords{$word}++ if ($count > $avecount);
2514: }
2515: untie %thesaurus_db;
2516: # Remove special values from %Keywords.
1.356 albertel 2517: foreach my $value ('total.count','average.count') {
2518: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2519: }
1.46 matthew 2520: return 1;
2521: }
2522:
2523: ###################################################
2524:
2525: =pod
2526:
1.648 raeburn 2527: =item * &keyword($word)
1.46 matthew 2528:
2529: Returns true if $word is a keyword. A keyword is a word that appears more
2530: than the average number of times in the thesaurus database. Calls
2531: &initialize_keywords
2532:
2533: =cut
2534:
2535: ###################################################
1.20 www 2536:
2537: sub keyword {
1.46 matthew 2538: return if (!&initialize_keywords());
2539: my $word=lc(shift());
2540: $word=~s/\W//g;
2541: return exists($Keywords{$word});
1.20 www 2542: }
1.46 matthew 2543:
2544: ###############################################################
2545:
2546: =pod
1.20 www 2547:
1.648 raeburn 2548: =item * &get_related_words()
1.46 matthew 2549:
1.160 matthew 2550: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2551: an array of words. If the keyword is not in the thesaurus, an empty array
2552: will be returned. The order of the words returned is determined by the
2553: database which holds them.
2554:
2555: Uses global $thesaurus_db_file.
2556:
2557: =cut
2558:
2559: ###############################################################
2560: sub get_related_words {
2561: my $keyword = shift;
2562: my %thesaurus_db;
2563: if (! -e $thesaurus_db_file) {
2564: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2565: "failed because the file does not exist");
2566: return ();
2567: }
2568: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2569: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2570: return ();
2571: }
2572: my @Words=();
1.429 www 2573: my $count=0;
1.46 matthew 2574: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2575: # The first element is the number of times
2576: # the word appears. We do not need it now.
1.429 www 2577: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2578: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2579: my $threshold=$mostfrequentcount/10;
2580: foreach my $possibleword (@RelatedWords) {
2581: my ($word,$wordcount)=split(/\,/,$possibleword);
2582: if ($wordcount>$threshold) {
2583: push(@Words,$word);
2584: $count++;
2585: if ($count>10) { last; }
2586: }
1.20 www 2587: }
2588: }
1.46 matthew 2589: untie %thesaurus_db;
2590: return @Words;
1.14 harris41 2591: }
1.46 matthew 2592:
1.112 bowersj2 2593: =pod
2594:
2595: =back
2596:
2597: =cut
1.61 www 2598:
2599: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2600: =pod
2601:
1.112 bowersj2 2602: =head1 User Name Functions
2603:
2604: =over 4
2605:
1.648 raeburn 2606: =item * &plainname($uname,$udom,$first)
1.81 albertel 2607:
1.112 bowersj2 2608: Takes a users logon name and returns it as a string in
1.226 albertel 2609: "first middle last generation" form
2610: if $first is set to 'lastname' then it returns it as
2611: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2612:
2613: =cut
1.61 www 2614:
1.295 www 2615:
1.81 albertel 2616: ###############################################################
1.61 www 2617: sub plainname {
1.226 albertel 2618: my ($uname,$udom,$first)=@_;
1.537 albertel 2619: return if (!defined($uname) || !defined($udom));
1.295 www 2620: my %names=&getnames($uname,$udom);
1.226 albertel 2621: my $name=&Apache::lonnet::format_name($names{'firstname'},
2622: $names{'middlename'},
2623: $names{'lastname'},
2624: $names{'generation'},$first);
2625: $name=~s/^\s+//;
1.62 www 2626: $name=~s/\s+$//;
2627: $name=~s/\s+/ /g;
1.353 albertel 2628: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2629: return $name;
1.61 www 2630: }
1.66 www 2631:
2632: # -------------------------------------------------------------------- Nickname
1.81 albertel 2633: =pod
2634:
1.648 raeburn 2635: =item * &nickname($uname,$udom)
1.81 albertel 2636:
2637: Gets a users name and returns it as a string as
2638:
2639: ""nickname""
1.66 www 2640:
1.81 albertel 2641: if the user has a nickname or
2642:
2643: "first middle last generation"
2644:
2645: if the user does not
2646:
2647: =cut
1.66 www 2648:
2649: sub nickname {
2650: my ($uname,$udom)=@_;
1.537 albertel 2651: return if (!defined($uname) || !defined($udom));
1.295 www 2652: my %names=&getnames($uname,$udom);
1.68 albertel 2653: my $name=$names{'nickname'};
1.66 www 2654: if ($name) {
2655: $name='"'.$name.'"';
2656: } else {
2657: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2658: $names{'lastname'}.' '.$names{'generation'};
2659: $name=~s/\s+$//;
2660: $name=~s/\s+/ /g;
2661: }
2662: return $name;
2663: }
2664:
1.295 www 2665: sub getnames {
2666: my ($uname,$udom)=@_;
1.537 albertel 2667: return if (!defined($uname) || !defined($udom));
1.433 albertel 2668: if ($udom eq 'public' && $uname eq 'public') {
2669: return ('lastname' => &mt('Public'));
2670: }
1.295 www 2671: my $id=$uname.':'.$udom;
2672: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2673: if ($cached) {
2674: return %{$names};
2675: } else {
2676: my %loadnames=&Apache::lonnet::get('environment',
2677: ['firstname','middlename','lastname','generation','nickname'],
2678: $udom,$uname);
2679: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2680: return %loadnames;
2681: }
2682: }
1.61 www 2683:
1.542 raeburn 2684: # -------------------------------------------------------------------- getemails
1.648 raeburn 2685:
1.542 raeburn 2686: =pod
2687:
1.648 raeburn 2688: =item * &getemails($uname,$udom)
1.542 raeburn 2689:
2690: Gets a user's email information and returns it as a hash with keys:
2691: notification, critnotification, permanentemail
2692:
2693: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2694: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2695:
1.648 raeburn 2696:
1.542 raeburn 2697: =cut
2698:
1.648 raeburn 2699:
1.466 albertel 2700: sub getemails {
2701: my ($uname,$udom)=@_;
2702: if ($udom eq 'public' && $uname eq 'public') {
2703: return;
2704: }
1.467 www 2705: if (!$udom) { $udom=$env{'user.domain'}; }
2706: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2707: my $id=$uname.':'.$udom;
2708: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2709: if ($cached) {
2710: return %{$names};
2711: } else {
2712: my %loadnames=&Apache::lonnet::get('environment',
2713: ['notification','critnotification',
2714: 'permanentemail'],
2715: $udom,$uname);
2716: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2717: return %loadnames;
2718: }
2719: }
2720:
1.551 albertel 2721: sub flush_email_cache {
2722: my ($uname,$udom)=@_;
2723: if (!$udom) { $udom =$env{'user.domain'}; }
2724: if (!$uname) { $uname=$env{'user.name'}; }
2725: return if ($udom eq 'public' && $uname eq 'public');
2726: my $id=$uname.':'.$udom;
2727: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2728: }
2729:
1.728 raeburn 2730: # -------------------------------------------------------------------- getlangs
2731:
2732: =pod
2733:
2734: =item * &getlangs($uname,$udom)
2735:
2736: Gets a user's language preference and returns it as a hash with key:
2737: language.
2738:
2739: =cut
2740:
2741:
2742: sub getlangs {
2743: my ($uname,$udom) = @_;
2744: if (!$udom) { $udom =$env{'user.domain'}; }
2745: if (!$uname) { $uname=$env{'user.name'}; }
2746: my $id=$uname.':'.$udom;
2747: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2748: if ($cached) {
2749: return %{$langs};
2750: } else {
2751: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2752: $udom,$uname);
2753: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2754: return %loadlangs;
2755: }
2756: }
2757:
2758: sub flush_langs_cache {
2759: my ($uname,$udom)=@_;
2760: if (!$udom) { $udom =$env{'user.domain'}; }
2761: if (!$uname) { $uname=$env{'user.name'}; }
2762: return if ($udom eq 'public' && $uname eq 'public');
2763: my $id=$uname.':'.$udom;
2764: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2765: }
2766:
1.61 www 2767: # ------------------------------------------------------------------ Screenname
1.81 albertel 2768:
2769: =pod
2770:
1.648 raeburn 2771: =item * &screenname($uname,$udom)
1.81 albertel 2772:
2773: Gets a users screenname and returns it as a string
2774:
2775: =cut
1.61 www 2776:
2777: sub screenname {
2778: my ($uname,$udom)=@_;
1.258 albertel 2779: if ($uname eq $env{'user.name'} &&
2780: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2781: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2782: return $names{'screenname'};
1.62 www 2783: }
2784:
1.212 albertel 2785:
1.62 www 2786: # ------------------------------------------------------------- Message Wrapper
2787:
2788: sub messagewrapper {
1.369 www 2789: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2790: return
1.441 albertel 2791: '<a href="/adm/email?compose=individual&'.
2792: 'recname='.$username.'&recdom='.$domain.
2793: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2794: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2795: }
2796: # --------------------------------------------------------------- Notes Wrapper
2797:
2798: sub noteswrapper {
2799: my ($link,$un,$do)=@_;
2800: return
2801: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2802: }
2803: # ------------------------------------------------------------- Aboutme Wrapper
2804:
2805: sub aboutmewrapper {
1.166 www 2806: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2807: if (!defined($username) && !defined($domain)) {
2808: return;
2809: }
1.205 www 2810: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756 weissno 2811: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 2812: }
2813:
2814: # ------------------------------------------------------------ Syllabus Wrapper
2815:
2816:
2817: sub syllabuswrapper {
1.707 bisitz 2818: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2819: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2820: }
1.14 harris41 2821:
1.208 matthew 2822: sub track_student_link {
1.268 albertel 2823: my ($linktext,$sname,$sdom,$target,$start) = @_;
2824: my $link ="/adm/trackstudent?";
1.208 matthew 2825: my $title = 'View recent activity';
2826: if (defined($sname) && $sname !~ /^\s*$/ &&
2827: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2828: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2829: $title .= ' of this student';
1.268 albertel 2830: }
1.208 matthew 2831: if (defined($target) && $target !~ /^\s*$/) {
2832: $target = qq{target="$target"};
2833: } else {
2834: $target = '';
2835: }
1.268 albertel 2836: if ($start) { $link.='&start='.$start; }
1.554 albertel 2837: $title = &mt($title);
2838: $linktext = &mt($linktext);
1.448 albertel 2839: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2840: &help_open_topic('View_recent_activity');
1.208 matthew 2841: }
2842:
1.508 www 2843: # ===================================================== Display a student photo
2844:
2845:
1.509 albertel 2846: sub student_image_tag {
1.508 www 2847: my ($domain,$user)=@_;
2848: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2849: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2850: return '<img src="'.$imgsrc.'" align="right" />';
2851: } else {
2852: return '';
2853: }
2854: }
2855:
1.112 bowersj2 2856: =pod
2857:
2858: =back
2859:
2860: =head1 Access .tab File Data
2861:
2862: =over 4
2863:
1.648 raeburn 2864: =item * &languageids()
1.112 bowersj2 2865:
2866: returns list of all language ids
2867:
2868: =cut
2869:
1.14 harris41 2870: sub languageids {
1.16 harris41 2871: return sort(keys(%language));
1.14 harris41 2872: }
2873:
1.112 bowersj2 2874: =pod
2875:
1.648 raeburn 2876: =item * &languagedescription()
1.112 bowersj2 2877:
2878: returns description of a specified language id
2879:
2880: =cut
2881:
1.14 harris41 2882: sub languagedescription {
1.125 www 2883: my $code=shift;
2884: return ($supported_language{$code}?'* ':'').
2885: $language{$code}.
1.126 www 2886: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2887: }
2888:
2889: sub plainlanguagedescription {
2890: my $code=shift;
2891: return $language{$code};
2892: }
2893:
2894: sub supportedlanguagecode {
2895: my $code=shift;
2896: return $supported_language{$code};
1.97 www 2897: }
2898:
1.112 bowersj2 2899: =pod
2900:
1.648 raeburn 2901: =item * ©rightids()
1.112 bowersj2 2902:
2903: returns list of all copyrights
2904:
2905: =cut
2906:
2907: sub copyrightids {
2908: return sort(keys(%cprtag));
2909: }
2910:
2911: =pod
2912:
1.648 raeburn 2913: =item * ©rightdescription()
1.112 bowersj2 2914:
2915: returns description of a specified copyright id
2916:
2917: =cut
2918:
2919: sub copyrightdescription {
1.166 www 2920: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2921: }
1.197 matthew 2922:
2923: =pod
2924:
1.648 raeburn 2925: =item * &source_copyrightids()
1.192 taceyjo1 2926:
2927: returns list of all source copyrights
2928:
2929: =cut
2930:
2931: sub source_copyrightids {
2932: return sort(keys(%scprtag));
2933: }
2934:
2935: =pod
2936:
1.648 raeburn 2937: =item * &source_copyrightdescription()
1.192 taceyjo1 2938:
2939: returns description of a specified source copyright id
2940:
2941: =cut
2942:
2943: sub source_copyrightdescription {
2944: return &mt($scprtag{shift(@_)});
2945: }
1.112 bowersj2 2946:
2947: =pod
2948:
1.648 raeburn 2949: =item * &filecategories()
1.112 bowersj2 2950:
2951: returns list of all file categories
2952:
2953: =cut
2954:
2955: sub filecategories {
2956: return sort(keys(%category_extensions));
2957: }
2958:
2959: =pod
2960:
1.648 raeburn 2961: =item * &filecategorytypes()
1.112 bowersj2 2962:
2963: returns list of file types belonging to a given file
2964: category
2965:
2966: =cut
2967:
2968: sub filecategorytypes {
1.356 albertel 2969: my ($cat) = @_;
2970: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2971: }
2972:
2973: =pod
2974:
1.648 raeburn 2975: =item * &fileembstyle()
1.112 bowersj2 2976:
2977: returns embedding style for a specified file type
2978:
2979: =cut
2980:
2981: sub fileembstyle {
2982: return $fe{lc(shift(@_))};
1.169 www 2983: }
2984:
1.351 www 2985: sub filemimetype {
2986: return $fm{lc(shift(@_))};
2987: }
2988:
1.169 www 2989:
2990: sub filecategoryselect {
2991: my ($name,$value)=@_;
1.189 matthew 2992: return &select_form($value,$name,
1.169 www 2993: '' => &mt('Any category'),
2994: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2995: }
2996:
2997: =pod
2998:
1.648 raeburn 2999: =item * &filedescription()
1.112 bowersj2 3000:
3001: returns description for a specified file type
3002:
3003: =cut
3004:
3005: sub filedescription {
1.188 matthew 3006: my $file_description = $fd{lc(shift())};
3007: $file_description =~ s:([\[\]]):~$1:g;
3008: return &mt($file_description);
1.112 bowersj2 3009: }
3010:
3011: =pod
3012:
1.648 raeburn 3013: =item * &filedescriptionex()
1.112 bowersj2 3014:
3015: returns description for a specified file type with
3016: extra formatting
3017:
3018: =cut
3019:
3020: sub filedescriptionex {
3021: my $ex=shift;
1.188 matthew 3022: my $file_description = $fd{lc($ex)};
3023: $file_description =~ s:([\[\]]):~$1:g;
3024: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3025: }
3026:
3027: # End of .tab access
3028: =pod
3029:
3030: =back
3031:
3032: =cut
3033:
3034: # ------------------------------------------------------------------ File Types
3035: sub fileextensions {
3036: return sort(keys(%fe));
3037: }
3038:
1.97 www 3039: # ----------------------------------------------------------- Display Languages
3040: # returns a hash with all desired display languages
3041: #
3042:
3043: sub display_languages {
3044: my %languages=();
1.695 raeburn 3045: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3046: $languages{$lang}=1;
1.97 www 3047: }
3048: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3049: if ($env{'form.displaylanguage'}) {
1.356 albertel 3050: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3051: $languages{$lang}=1;
1.97 www 3052: }
3053: }
3054: return %languages;
1.14 harris41 3055: }
3056:
1.582 albertel 3057: sub languages {
3058: my ($possible_langs) = @_;
1.695 raeburn 3059: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3060: if (!ref($possible_langs)) {
3061: if( wantarray ) {
3062: return @preferred_langs;
3063: } else {
3064: return $preferred_langs[0];
3065: }
3066: }
3067: my %possibilities = map { $_ => 1 } (@$possible_langs);
3068: my @preferred_possibilities;
3069: foreach my $preferred_lang (@preferred_langs) {
3070: if (exists($possibilities{$preferred_lang})) {
3071: push(@preferred_possibilities, $preferred_lang);
3072: }
3073: }
3074: if( wantarray ) {
3075: return @preferred_possibilities;
3076: }
3077: return $preferred_possibilities[0];
3078: }
3079:
1.742 raeburn 3080: sub user_lang {
3081: my ($touname,$toudom,$fromcid) = @_;
3082: my @userlangs;
3083: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3084: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3085: $env{'course.'.$fromcid.'.languages'}));
3086: } else {
3087: my %langhash = &getlangs($touname,$toudom);
3088: if ($langhash{'languages'} ne '') {
3089: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3090: } else {
3091: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3092: if ($domdefs{'lang_def'} ne '') {
3093: @userlangs = ($domdefs{'lang_def'});
3094: }
3095: }
3096: }
3097: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3098: my $user_lh = Apache::localize->get_handle(@languages);
3099: return $user_lh;
3100: }
3101:
3102:
1.112 bowersj2 3103: ###############################################################
3104: ## Student Answer Attempts ##
3105: ###############################################################
3106:
3107: =pod
3108:
3109: =head1 Alternate Problem Views
3110:
3111: =over 4
3112:
1.648 raeburn 3113: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3114: $getattempt, $regexp, $gradesub)
3115:
3116: Return string with previous attempt on problem. Arguments:
3117:
3118: =over 4
3119:
3120: =item * $symb: Problem, including path
3121:
3122: =item * $username: username of the desired student
3123:
3124: =item * $domain: domain of the desired student
1.14 harris41 3125:
1.112 bowersj2 3126: =item * $course: Course ID
1.14 harris41 3127:
1.112 bowersj2 3128: =item * $getattempt: Leave blank for all attempts, otherwise put
3129: something
1.14 harris41 3130:
1.112 bowersj2 3131: =item * $regexp: if string matches this regexp, the string will be
3132: sent to $gradesub
1.14 harris41 3133:
1.112 bowersj2 3134: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3135:
1.112 bowersj2 3136: =back
1.14 harris41 3137:
1.112 bowersj2 3138: The output string is a table containing all desired attempts, if any.
1.16 harris41 3139:
1.112 bowersj2 3140: =cut
1.1 albertel 3141:
3142: sub get_previous_attempt {
1.43 ng 3143: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3144: my $prevattempts='';
1.43 ng 3145: no strict 'refs';
1.1 albertel 3146: if ($symb) {
1.3 albertel 3147: my (%returnhash)=
3148: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3149: if ($returnhash{'version'}) {
3150: my %lasthash=();
3151: my $version;
3152: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3153: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3154: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3155: }
1.1 albertel 3156: }
1.596 albertel 3157: $prevattempts=&start_data_table().&start_data_table_header_row();
3158: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3159: foreach my $key (sort(keys(%lasthash))) {
3160: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3161: if ($#parts > 0) {
1.31 albertel 3162: my $data=$parts[-1];
3163: pop(@parts);
1.596 albertel 3164: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3165: } else {
1.41 ng 3166: if ($#parts == 0) {
3167: $prevattempts.='<th>'.$parts[0].'</th>';
3168: } else {
3169: $prevattempts.='<th>'.$ign.'</th>';
3170: }
1.31 albertel 3171: }
1.16 harris41 3172: }
1.596 albertel 3173: $prevattempts.=&end_data_table_header_row();
1.40 ng 3174: if ($getattempt eq '') {
3175: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3176: $prevattempts.=&start_data_table_row().
3177: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3178: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3179: my $value = &format_previous_attempt_value($key,
3180: $returnhash{$version.':'.$key});
3181: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3182: }
1.596 albertel 3183: $prevattempts.=&end_data_table_row();
1.40 ng 3184: }
1.1 albertel 3185: }
1.596 albertel 3186: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3187: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3188: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3189: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3190: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3191: }
1.596 albertel 3192: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3193: } else {
1.596 albertel 3194: $prevattempts=
3195: &start_data_table().&start_data_table_row().
3196: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3197: &end_data_table_row().&end_data_table();
1.1 albertel 3198: }
3199: } else {
1.596 albertel 3200: $prevattempts=
3201: &start_data_table().&start_data_table_row().
3202: '<td>'.&mt('No data.').'</td>'.
3203: &end_data_table_row().&end_data_table();
1.1 albertel 3204: }
1.10 albertel 3205: }
3206:
1.581 albertel 3207: sub format_previous_attempt_value {
3208: my ($key,$value) = @_;
3209: if ($key =~ /timestamp/) {
3210: $value = &Apache::lonlocal::locallocaltime($value);
3211: } elsif (ref($value) eq 'ARRAY') {
3212: $value = '('.join(', ', @{ $value }).')';
3213: } else {
3214: $value = &unescape($value);
3215: }
3216: return $value;
3217: }
3218:
3219:
1.107 albertel 3220: sub relative_to_absolute {
3221: my ($url,$output)=@_;
3222: my $parser=HTML::TokeParser->new(\$output);
3223: my $token;
3224: my $thisdir=$url;
3225: my @rlinks=();
3226: while ($token=$parser->get_token) {
3227: if ($token->[0] eq 'S') {
3228: if ($token->[1] eq 'a') {
3229: if ($token->[2]->{'href'}) {
3230: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3231: }
3232: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3233: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3234: } elsif ($token->[1] eq 'base') {
3235: $thisdir=$token->[2]->{'href'};
3236: }
3237: }
3238: }
3239: $thisdir=~s-/[^/]*$--;
1.356 albertel 3240: foreach my $link (@rlinks) {
1.726 raeburn 3241: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3242: ($link=~/^\//) ||
3243: ($link=~/^javascript:/i) ||
3244: ($link=~/^mailto:/i) ||
3245: ($link=~/^\#/)) {
3246: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3247: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3248: }
3249: }
3250: # -------------------------------------------------- Deal with Applet codebases
3251: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3252: return $output;
3253: }
3254:
1.112 bowersj2 3255: =pod
3256:
1.648 raeburn 3257: =item * &get_student_view()
1.112 bowersj2 3258:
3259: show a snapshot of what student was looking at
3260:
3261: =cut
3262:
1.10 albertel 3263: sub get_student_view {
1.186 albertel 3264: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3265: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3266: my (%form);
1.10 albertel 3267: my @elements=('symb','courseid','domain','username');
3268: foreach my $element (@elements) {
1.186 albertel 3269: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3270: }
1.186 albertel 3271: if (defined($moreenv)) {
3272: %form=(%form,%{$moreenv});
3273: }
1.236 albertel 3274: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3275: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3276: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3277: $userview=~s/\<body[^\>]*\>//gi;
3278: $userview=~s/\<\/body\>//gi;
3279: $userview=~s/\<html\>//gi;
3280: $userview=~s/\<\/html\>//gi;
3281: $userview=~s/\<head\>//gi;
3282: $userview=~s/\<\/head\>//gi;
3283: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3284: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3285: if (wantarray) {
3286: return ($userview,$response);
3287: } else {
3288: return $userview;
3289: }
3290: }
3291:
3292: sub get_student_view_with_retries {
3293: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3294:
3295: my $ok = 0; # True if we got a good response.
3296: my $content;
3297: my $response;
3298:
3299: # Try to get the student_view done. within the retries count:
3300:
3301: do {
3302: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3303: $ok = $response->is_success;
3304: if (!$ok) {
3305: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3306: }
3307: $retries--;
3308: } while (!$ok && ($retries > 0));
3309:
3310: if (!$ok) {
3311: $content = ''; # On error return an empty content.
3312: }
1.651 www 3313: if (wantarray) {
3314: return ($content, $response);
3315: } else {
3316: return $content;
3317: }
1.11 albertel 3318: }
3319:
1.112 bowersj2 3320: =pod
3321:
1.648 raeburn 3322: =item * &get_student_answers()
1.112 bowersj2 3323:
3324: show a snapshot of how student was answering problem
3325:
3326: =cut
3327:
1.11 albertel 3328: sub get_student_answers {
1.100 sakharuk 3329: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3330: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3331: my (%moreenv);
1.11 albertel 3332: my @elements=('symb','courseid','domain','username');
3333: foreach my $element (@elements) {
1.186 albertel 3334: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3335: }
1.186 albertel 3336: $moreenv{'grade_target'}='answer';
3337: %moreenv=(%form,%moreenv);
1.497 raeburn 3338: $feedurl = &Apache::lonnet::clutter($feedurl);
3339: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3340: return $userview;
1.1 albertel 3341: }
1.116 albertel 3342:
3343: =pod
3344:
3345: =item * &submlink()
3346:
1.242 albertel 3347: Inputs: $text $uname $udom $symb $target
1.116 albertel 3348:
3349: Returns: A link to grades.pm such as to see the SUBM view of a student
3350:
3351: =cut
3352:
3353: ###############################################
3354: sub submlink {
1.242 albertel 3355: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3356: if (!($uname && $udom)) {
3357: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3358: &Apache::lonnet::whichuser($symb);
1.116 albertel 3359: if (!$symb) { $symb=$cursymb; }
3360: }
1.254 matthew 3361: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3362: $symb=&escape($symb);
1.242 albertel 3363: if ($target) { $target="target=\"$target\""; }
3364: return '<a href="/adm/grades?&command=submission&'.
3365: 'symb='.$symb.'&student='.$uname.
3366: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3367: }
3368: ##############################################
3369:
3370: =pod
3371:
3372: =item * &pgrdlink()
3373:
3374: Inputs: $text $uname $udom $symb $target
3375:
3376: Returns: A link to grades.pm such as to see the PGRD view of a student
3377:
3378: =cut
3379:
3380: ###############################################
3381: sub pgrdlink {
3382: my $link=&submlink(@_);
3383: $link=~s/(&command=submission)/$1&showgrading=yes/;
3384: return $link;
3385: }
3386: ##############################################
3387:
3388: =pod
3389:
3390: =item * &pprmlink()
3391:
3392: Inputs: $text $uname $udom $symb $target
3393:
3394: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3395: student and a specific resource
1.242 albertel 3396:
3397: =cut
3398:
3399: ###############################################
3400: sub pprmlink {
3401: my ($text,$uname,$udom,$symb,$target)=@_;
3402: if (!($uname && $udom)) {
3403: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3404: &Apache::lonnet::whichuser($symb);
1.242 albertel 3405: if (!$symb) { $symb=$cursymb; }
3406: }
1.254 matthew 3407: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3408: $symb=&escape($symb);
1.242 albertel 3409: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3410: return '<a href="/adm/parmset?command=set&'.
3411: 'symb='.$symb.'&uname='.$uname.
3412: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3413: }
3414: ##############################################
1.37 matthew 3415:
1.112 bowersj2 3416: =pod
3417:
3418: =back
3419:
3420: =cut
3421:
1.37 matthew 3422: ###############################################
1.51 www 3423:
3424:
3425: sub timehash {
1.687 raeburn 3426: my ($thistime) = @_;
3427: my $timezone = &Apache::lonlocal::gettimezone();
3428: my $dt = DateTime->from_epoch(epoch => $thistime)
3429: ->set_time_zone($timezone);
3430: my $wday = $dt->day_of_week();
3431: if ($wday == 7) { $wday = 0; }
3432: return ( 'second' => $dt->second(),
3433: 'minute' => $dt->minute(),
3434: 'hour' => $dt->hour(),
3435: 'day' => $dt->day_of_month(),
3436: 'month' => $dt->month(),
3437: 'year' => $dt->year(),
3438: 'weekday' => $wday,
3439: 'dayyear' => $dt->day_of_year(),
3440: 'dlsav' => $dt->is_dst() );
1.51 www 3441: }
3442:
1.370 www 3443: sub utc_string {
3444: my ($date)=@_;
1.371 www 3445: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3446: }
3447:
1.51 www 3448: sub maketime {
3449: my %th=@_;
1.687 raeburn 3450: my ($epoch_time,$timezone,$dt);
3451: $timezone = &Apache::lonlocal::gettimezone();
3452: eval {
3453: $dt = DateTime->new( year => $th{'year'},
3454: month => $th{'month'},
3455: day => $th{'day'},
3456: hour => $th{'hour'},
3457: minute => $th{'minute'},
3458: second => $th{'second'},
3459: time_zone => $timezone,
3460: );
3461: };
3462: if (!$@) {
3463: $epoch_time = $dt->epoch;
3464: if ($epoch_time) {
3465: return $epoch_time;
3466: }
3467: }
1.51 www 3468: return POSIX::mktime(
3469: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3470: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3471: }
3472:
3473: #########################################
1.51 www 3474:
3475: sub findallcourses {
1.482 raeburn 3476: my ($roles,$uname,$udom) = @_;
1.355 albertel 3477: my %roles;
3478: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3479: my %courses;
1.51 www 3480: my $now=time;
1.482 raeburn 3481: if (!defined($uname)) {
3482: $uname = $env{'user.name'};
3483: }
3484: if (!defined($udom)) {
3485: $udom = $env{'user.domain'};
3486: }
3487: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3488: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3489: if (!%roles) {
3490: %roles = (
3491: cc => 1,
3492: in => 1,
3493: ep => 1,
3494: ta => 1,
3495: cr => 1,
3496: st => 1,
3497: );
3498: }
3499: foreach my $entry (keys(%roleshash)) {
3500: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3501: if ($trole =~ /^cr/) {
3502: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3503: } else {
3504: next if (!exists($roles{$trole}));
3505: }
3506: if ($tend) {
3507: next if ($tend < $now);
3508: }
3509: if ($tstart) {
3510: next if ($tstart > $now);
3511: }
3512: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3513: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3514: if ($secpart eq '') {
3515: ($cnum,$role) = split(/_/,$cnumpart);
3516: $sec = 'none';
3517: $realsec = '';
3518: } else {
3519: $cnum = $cnumpart;
3520: ($sec,$role) = split(/_/,$secpart);
3521: $realsec = $sec;
1.490 raeburn 3522: }
1.482 raeburn 3523: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3524: }
3525: } else {
3526: foreach my $key (keys(%env)) {
1.483 albertel 3527: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3528: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3529: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3530: next if ($role eq 'ca' || $role eq 'aa');
3531: next if (%roles && !exists($roles{$role}));
3532: my ($starttime,$endtime)=split(/\./,$env{$key});
3533: my $active=1;
3534: if ($starttime) {
3535: if ($now<$starttime) { $active=0; }
3536: }
3537: if ($endtime) {
3538: if ($now>$endtime) { $active=0; }
3539: }
3540: if ($active) {
3541: if ($sec eq '') {
3542: $sec = 'none';
3543: }
3544: $courses{$cdom.'_'.$cnum}{$sec} =
3545: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3546: }
3547: }
1.51 www 3548: }
3549: }
1.474 raeburn 3550: return %courses;
1.51 www 3551: }
1.37 matthew 3552:
1.54 www 3553: ###############################################
1.474 raeburn 3554:
3555: sub blockcheck {
1.482 raeburn 3556: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3557:
3558: if (!defined($udom)) {
3559: $udom = $env{'user.domain'};
3560: }
3561: if (!defined($uname)) {
3562: $uname = $env{'user.name'};
3563: }
3564:
3565: # If uname and udom are for a course, check for blocks in the course.
3566:
3567: if (&Apache::lonnet::is_course($udom,$uname)) {
3568: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3569: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3570: return ($startblock,$endblock);
3571: }
1.474 raeburn 3572:
1.502 raeburn 3573: my $startblock = 0;
3574: my $endblock = 0;
1.482 raeburn 3575: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3576:
1.490 raeburn 3577: # If uname is for a user, and activity is course-specific, i.e.,
3578: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3579:
1.490 raeburn 3580: if (($activity eq 'boards' || $activity eq 'chat' ||
3581: $activity eq 'groups') && ($env{'request.course.id'})) {
3582: foreach my $key (keys(%live_courses)) {
3583: if ($key ne $env{'request.course.id'}) {
3584: delete($live_courses{$key});
3585: }
3586: }
3587: }
3588:
3589: my $otheruser = 0;
3590: my %own_courses;
3591: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3592: # Resource belongs to user other than current user.
3593: $otheruser = 1;
3594: # Gather courses for current user
3595: %own_courses =
3596: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3597: }
3598:
3599: # Gather active course roles - course coordinator, instructor,
3600: # exam proctor, ta, student, or custom role.
1.474 raeburn 3601:
3602: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3603: my ($cdom,$cnum);
3604: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3605: $cdom = $env{'course.'.$course.'.domain'};
3606: $cnum = $env{'course.'.$course.'.num'};
3607: } else {
1.490 raeburn 3608: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3609: }
3610: my $no_ownblock = 0;
3611: my $no_userblock = 0;
1.533 raeburn 3612: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3613: # Check if current user has 'evb' priv for this
3614: if (defined($own_courses{$course})) {
3615: foreach my $sec (keys(%{$own_courses{$course}})) {
3616: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3617: if ($sec ne 'none') {
3618: $checkrole .= '/'.$sec;
3619: }
3620: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3621: $no_ownblock = 1;
3622: last;
3623: }
3624: }
3625: }
3626: # if they have 'evb' priv and are currently not playing student
3627: next if (($no_ownblock) &&
3628: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3629: }
1.474 raeburn 3630: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3631: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3632: if ($sec ne 'none') {
1.482 raeburn 3633: $checkrole .= '/'.$sec;
1.474 raeburn 3634: }
1.490 raeburn 3635: if ($otheruser) {
3636: # Resource belongs to user other than current user.
3637: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3638: my ($trole,$tdom,$tnum,$tsec);
3639: my $entry = $live_courses{$course}{$sec};
3640: if ($entry =~ /^cr/) {
3641: ($trole,$tdom,$tnum,$tsec) =
3642: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3643: } else {
3644: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3645: }
3646: my ($spec,$area,$trest,%allroles,%userroles);
3647: $area = '/'.$tdom.'/'.$tnum;
3648: $trest = $tnum;
3649: if ($tsec ne '') {
3650: $area .= '/'.$tsec;
3651: $trest .= '/'.$tsec;
3652: }
3653: $spec = $trole.'.'.$area;
3654: if ($trole =~ /^cr/) {
3655: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3656: $tdom,$spec,$trest,$area);
3657: } else {
3658: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3659: $tdom,$spec,$trest,$area);
3660: }
3661: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3662: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3663: if ($1) {
3664: $no_userblock = 1;
3665: last;
3666: }
3667: }
1.490 raeburn 3668: } else {
3669: # Resource belongs to current user
3670: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3671: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3672: $no_ownblock = 1;
3673: last;
3674: }
1.474 raeburn 3675: }
3676: }
3677: # if they have the evb priv and are currently not playing student
1.482 raeburn 3678: next if (($no_ownblock) &&
1.491 albertel 3679: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3680: next if ($no_userblock);
1.474 raeburn 3681:
1.490 raeburn 3682: # Retrieve blocking times and identity of blocker for course
3683: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3684:
3685: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3686: if (($start != 0) &&
3687: (($startblock == 0) || ($startblock > $start))) {
3688: $startblock = $start;
3689: }
3690: if (($end != 0) &&
3691: (($endblock == 0) || ($endblock < $end))) {
3692: $endblock = $end;
3693: }
1.490 raeburn 3694: }
3695: return ($startblock,$endblock);
3696: }
3697:
3698: sub get_blocks {
3699: my ($setters,$activity,$cdom,$cnum) = @_;
3700: my $startblock = 0;
3701: my $endblock = 0;
3702: my $course = $cdom.'_'.$cnum;
3703: $setters->{$course} = {};
3704: $setters->{$course}{'staff'} = [];
3705: $setters->{$course}{'times'} = [];
3706: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3707: foreach my $record (keys(%records)) {
3708: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3709: if ($start <= time && $end >= time) {
3710: my ($staff_name,$staff_dom,$title,$blocks) =
3711: &parse_block_record($records{$record});
3712: if ($blocks->{$activity} eq 'on') {
3713: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3714: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3715: if ( ($startblock == 0) || ($startblock > $start) ) {
3716: $startblock = $start;
1.490 raeburn 3717: }
1.491 albertel 3718: if ( ($endblock == 0) || ($endblock < $end) ) {
3719: $endblock = $end;
1.474 raeburn 3720: }
3721: }
3722: }
3723: }
3724: return ($startblock,$endblock);
3725: }
3726:
3727: sub parse_block_record {
3728: my ($record) = @_;
3729: my ($setuname,$setudom,$title,$blocks);
3730: if (ref($record) eq 'HASH') {
3731: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3732: $title = &unescape($record->{'event'});
3733: $blocks = $record->{'blocks'};
3734: } else {
3735: my @data = split(/:/,$record,3);
3736: if (scalar(@data) eq 2) {
3737: $title = $data[1];
3738: ($setuname,$setudom) = split(/@/,$data[0]);
3739: } else {
3740: ($setuname,$setudom,$title) = @data;
3741: }
3742: $blocks = { 'com' => 'on' };
3743: }
3744: return ($setuname,$setudom,$title,$blocks);
3745: }
3746:
3747: sub build_block_table {
3748: my ($startblock,$endblock,$setters) = @_;
3749: my %lt = &Apache::lonlocal::texthash(
3750: 'cacb' => 'Currently active communication blocks',
3751: 'cour' => 'Course',
3752: 'dura' => 'Duration',
3753: 'blse' => 'Block set by'
3754: );
3755: my $output;
1.476 raeburn 3756: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3757: $output .= &start_data_table();
3758: $output .= '
3759: <tr>
3760: <th>'.$lt{'cour'}.'</th>
3761: <th>'.$lt{'dura'}.'</th>
3762: <th>'.$lt{'blse'}.'</th>
3763: </tr>
3764: ';
3765: foreach my $course (keys(%{$setters})) {
3766: my %courseinfo=&Apache::lonnet::coursedescription($course);
3767: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3768: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3769: my $fullname = &plainname($uname,$udom);
3770: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3771: && $env{'user.name'} ne 'public'
3772: && $env{'user.domain'} ne 'public') {
3773: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3774: }
1.474 raeburn 3775: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3776: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3777: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3778: $output .= &Apache::loncommon::start_data_table_row().
3779: '<td>'.$courseinfo{'description'}.'</td>'.
3780: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3781: '<td>'.$fullname.'</td>'.
1.474 raeburn 3782: &Apache::loncommon::end_data_table_row();
3783: }
3784: }
3785: $output .= &end_data_table();
3786: }
3787:
1.490 raeburn 3788: sub blocking_status {
3789: my ($activity,$uname,$udom) = @_;
3790: my %setters;
3791: my ($blocked,$output,$ownitem,$is_course);
3792: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3793: if ($startblock && $endblock) {
3794: $blocked = 1;
3795: if (wantarray) {
3796: my $category;
3797: if ($activity eq 'boards') {
3798: $category = 'Discussion posts in this course';
3799: } elsif ($activity eq 'blogs') {
3800: $category = 'Blogs';
3801: } elsif ($activity eq 'port') {
3802: if (defined($uname) && defined($udom)) {
3803: if ($uname eq $env{'user.name'} &&
3804: $udom eq $env{'user.domain'}) {
3805: $ownitem = 1;
3806: }
3807: }
3808: $is_course = &Apache::lonnet::is_course($udom,$uname);
3809: if ($ownitem) {
3810: $category = 'Your portfolio files';
3811: } elsif ($is_course) {
3812: my $coursedesc;
3813: foreach my $course (keys(%setters)) {
3814: my %courseinfo =
3815: &Apache::lonnet::coursedescription($course);
3816: $coursedesc = $courseinfo{'description'};
3817: }
3818: $category = "Group files in the course '$coursedesc'";
3819: } else {
3820: $category = 'Portfolio files belonging to ';
3821: if ($env{'user.name'} eq 'public' &&
3822: $env{'user.domain'} eq 'public') {
3823: $category .= &plainname($uname,$udom);
3824: } else {
3825: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3826: }
3827: }
3828: } elsif ($activity eq 'groups') {
3829: $category = 'Groups in this course';
3830: }
3831: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3832: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3833: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3834: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3835: $output .= &build_block_table($startblock,$endblock,\%setters);
3836: }
3837: }
3838: }
3839: if (wantarray) {
3840: return ($blocked,$output);
3841: } else {
3842: return $blocked;
3843: }
3844: }
3845:
1.60 matthew 3846: ###############################################
3847:
1.682 raeburn 3848: sub check_ip_acc {
3849: my ($acc)=@_;
3850: &Apache::lonxml::debug("acc is $acc");
3851: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3852: return 1;
3853: }
3854: my $allowed=0;
3855: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3856:
3857: my $name;
3858: foreach my $pattern (split(',',$acc)) {
3859: $pattern =~ s/^\s*//;
3860: $pattern =~ s/\s*$//;
3861: if ($pattern =~ /\*$/) {
3862: #35.8.*
3863: $pattern=~s/\*//;
3864: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3865: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3866: #35.8.3.[34-56]
3867: my $low=$2;
3868: my $high=$3;
3869: $pattern=$1;
3870: if ($ip =~ /^\Q$pattern\E/) {
3871: my $last=(split(/\./,$ip))[3];
3872: if ($last <=$high && $last >=$low) { $allowed=1; }
3873: }
3874: } elsif ($pattern =~ /^\*/) {
3875: #*.msu.edu
3876: $pattern=~s/\*//;
3877: if (!defined($name)) {
3878: use Socket;
3879: my $netaddr=inet_aton($ip);
3880: ($name)=gethostbyaddr($netaddr,AF_INET);
3881: }
3882: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3883: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3884: #127.0.0.1
3885: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3886: } else {
3887: #some.name.com
3888: if (!defined($name)) {
3889: use Socket;
3890: my $netaddr=inet_aton($ip);
3891: ($name)=gethostbyaddr($netaddr,AF_INET);
3892: }
3893: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3894: }
3895: if ($allowed) { last; }
3896: }
3897: return $allowed;
3898: }
3899:
3900: ###############################################
3901:
1.60 matthew 3902: =pod
3903:
1.112 bowersj2 3904: =head1 Domain Template Functions
3905:
3906: =over 4
3907:
3908: =item * &determinedomain()
1.60 matthew 3909:
3910: Inputs: $domain (usually will be undef)
3911:
1.63 www 3912: Returns: Determines which domain should be used for designs
1.60 matthew 3913:
3914: =cut
1.54 www 3915:
1.60 matthew 3916: ###############################################
1.63 www 3917: sub determinedomain {
3918: my $domain=shift;
1.531 albertel 3919: if (! $domain) {
1.60 matthew 3920: # Determine domain if we have not been given one
3921: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3922: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3923: if ($env{'request.role.domain'}) {
3924: $domain=$env{'request.role.domain'};
1.60 matthew 3925: }
3926: }
1.63 www 3927: return $domain;
3928: }
3929: ###############################################
1.517 raeburn 3930:
1.518 albertel 3931: sub devalidate_domconfig_cache {
3932: my ($udom)=@_;
3933: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3934: }
3935:
3936: # ---------------------- Get domain configuration for a domain
3937: sub get_domainconf {
3938: my ($udom) = @_;
3939: my $cachetime=1800;
3940: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3941: if (defined($cached)) { return %{$result}; }
3942:
3943: my %domconfig = &Apache::lonnet::get_dom('configuration',
3944: ['login','rolecolors'],$udom);
1.632 raeburn 3945: my (%designhash,%legacy);
1.518 albertel 3946: if (keys(%domconfig) > 0) {
3947: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3948: if (keys(%{$domconfig{'login'}})) {
3949: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3950: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3951: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3952: $designhash{$udom.'.login.'.$key.'_'.$img} =
3953: $domconfig{'login'}{$key}{$img};
3954: }
3955: } else {
3956: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3957: }
1.632 raeburn 3958: }
3959: } else {
3960: $legacy{'login'} = 1;
1.518 albertel 3961: }
1.632 raeburn 3962: } else {
3963: $legacy{'login'} = 1;
1.518 albertel 3964: }
3965: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3966: if (keys(%{$domconfig{'rolecolors'}})) {
3967: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3968: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3969: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3970: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3971: }
1.518 albertel 3972: }
3973: }
1.632 raeburn 3974: } else {
3975: $legacy{'rolecolors'} = 1;
1.518 albertel 3976: }
1.632 raeburn 3977: } else {
3978: $legacy{'rolecolors'} = 1;
1.518 albertel 3979: }
1.632 raeburn 3980: if (keys(%legacy) > 0) {
3981: my %legacyhash = &get_legacy_domconf($udom);
3982: foreach my $item (keys(%legacyhash)) {
3983: if ($item =~ /^\Q$udom\E\.login/) {
3984: if ($legacy{'login'}) {
3985: $designhash{$item} = $legacyhash{$item};
3986: }
3987: } else {
3988: if ($legacy{'rolecolors'}) {
3989: $designhash{$item} = $legacyhash{$item};
3990: }
1.518 albertel 3991: }
3992: }
3993: }
1.632 raeburn 3994: } else {
3995: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3996: }
3997: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3998: $cachetime);
3999: return %designhash;
4000: }
4001:
1.632 raeburn 4002: sub get_legacy_domconf {
4003: my ($udom) = @_;
4004: my %legacyhash;
4005: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4006: my $designfile = $designdir.'/'.$udom.'.tab';
4007: if (-e $designfile) {
4008: if ( open (my $fh,"<$designfile") ) {
4009: while (my $line = <$fh>) {
4010: next if ($line =~ /^\#/);
4011: chomp($line);
4012: my ($key,$val)=(split(/\=/,$line));
4013: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4014: }
4015: close($fh);
4016: }
4017: }
4018: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4019: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4020: }
4021: return %legacyhash;
4022: }
4023:
1.63 www 4024: =pod
4025:
1.112 bowersj2 4026: =item * &domainlogo()
1.63 www 4027:
4028: Inputs: $domain (usually will be undef)
4029:
4030: Returns: A link to a domain logo, if the domain logo exists.
4031: If the domain logo does not exist, a description of the domain.
4032:
4033: =cut
1.112 bowersj2 4034:
1.63 www 4035: ###############################################
4036: sub domainlogo {
1.517 raeburn 4037: my $domain = &determinedomain(shift);
1.518 albertel 4038: my %designhash = &get_domainconf($domain);
1.517 raeburn 4039: # See if there is a logo
4040: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4041: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4042: if ($imgsrc =~ m{^/(adm|res)/}) {
4043: if ($imgsrc =~ m{^/res/}) {
4044: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4045: &Apache::lonnet::repcopy($local_name);
4046: }
4047: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4048: }
4049: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4050: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4051: return &Apache::lonnet::domain($domain,'description');
1.59 www 4052: } else {
1.60 matthew 4053: return '';
1.59 www 4054: }
4055: }
1.63 www 4056: ##############################################
4057:
4058: =pod
4059:
1.112 bowersj2 4060: =item * &designparm()
1.63 www 4061:
4062: Inputs: $which parameter; $domain (usually will be undef)
4063:
4064: Returns: value of designparamter $which
4065:
4066: =cut
1.112 bowersj2 4067:
1.397 albertel 4068:
1.400 albertel 4069: ##############################################
1.397 albertel 4070: sub designparm {
4071: my ($which,$domain)=@_;
1.258 albertel 4072: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4073: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4074: return '#000000';
4075: }
1.635 raeburn 4076: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4077: return '#FFFFFF';
4078: }
4079: if ($which=~/\.tabbg$/) {
4080: return '#CCCCCC';
4081: }
4082: }
1.397 albertel 4083: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4084: return $env{'environment.color.'.$which};
1.96 www 4085: }
1.63 www 4086: $domain=&determinedomain($domain);
1.518 albertel 4087: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4088: my $output;
1.517 raeburn 4089: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4090: $output = $domdesign{$domain.'.'.$which};
1.63 www 4091: } else {
1.520 raeburn 4092: $output = $defaultdesign{$which};
4093: }
4094: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4095: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4096: if ($output =~ m{^/(adm|res)/}) {
4097: if ($output =~ m{^/res/}) {
4098: my $local_name = &Apache::lonnet::filelocation('',$output);
4099: &Apache::lonnet::repcopy($local_name);
4100: }
1.520 raeburn 4101: $output = &lonhttpdurl($output);
4102: }
1.63 www 4103: }
1.520 raeburn 4104: return $output;
1.63 www 4105: }
1.59 www 4106:
1.60 matthew 4107: ###############################################
4108: ###############################################
4109:
4110: =pod
4111:
1.112 bowersj2 4112: =back
4113:
1.549 albertel 4114: =head1 HTML Helpers
1.112 bowersj2 4115:
4116: =over 4
4117:
4118: =item * &bodytag()
1.60 matthew 4119:
4120: Returns a uniform header for LON-CAPA web pages.
4121:
4122: Inputs:
4123:
1.112 bowersj2 4124: =over 4
4125:
4126: =item * $title, A title to be displayed on the page.
4127:
4128: =item * $function, the current role (can be undef).
4129:
4130: =item * $addentries, extra parameters for the <body> tag.
4131:
4132: =item * $bodyonly, if defined, only return the <body> tag.
4133:
4134: =item * $domain, if defined, force a given domain.
4135:
4136: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4137: text interface only)
1.60 matthew 4138:
1.326 albertel 4139: =item * $customtitle, alternate text to use instead of $title
4140: in the title box that appears, this text
4141: is not auto translated like the $title is
1.309 albertel 4142:
4143: =item * $notopbar, if true, keep the 'what is this' info but remove the
4144: navigational links
1.317 albertel 4145:
1.338 albertel 4146: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4147:
4148: =item * $notitle, if true keep the nav controls, but remove the title bar
4149:
1.361 albertel 4150: =item * $no_inline_link, if true and in remote mode, don't show the
4151: 'Switch To Inline Menu' link
4152:
1.460 albertel 4153: =item * $args, optional argument valid values are
4154: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4155: inherit_jsmath -> when creating popup window in a page,
4156: should it have jsmath forced on by the
4157: current page
1.460 albertel 4158:
1.112 bowersj2 4159: =back
4160:
1.60 matthew 4161: Returns: A uniform header for LON-CAPA web pages.
4162: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4163: If $bodyonly is undef or zero, an html string containing a <body> tag and
4164: other decorations will be returned.
4165:
4166: =cut
4167:
1.54 www 4168: sub bodytag {
1.309 albertel 4169: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4170: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4171:
1.460 albertel 4172: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4173:
1.183 matthew 4174: $function = &get_users_function() if (!$function);
1.339 albertel 4175: my $img = &designparm($function.'.img',$domain);
4176: my $font = &designparm($function.'.font',$domain);
4177: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4178:
4179: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4180: 'bgcolor' => $pgbg,
1.339 albertel 4181: 'text' => $font,
4182: 'alink' => &designparm($function.'.alink',$domain),
4183: 'vlink' => &designparm($function.'.vlink',$domain),
4184: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4185: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4186:
1.63 www 4187: # role and realm
1.378 raeburn 4188: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4189: if ($role eq 'ca') {
1.479 albertel 4190: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4191: $realm = &plainname($rname,$rdom);
1.378 raeburn 4192: }
1.55 www 4193: # realm
1.258 albertel 4194: if ($env{'request.course.id'}) {
1.378 raeburn 4195: if ($env{'request.role'} !~ /^cr/) {
4196: $role = &Apache::lonnet::plaintext($role,&course_type());
4197: }
1.359 albertel 4198: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4199: } else {
4200: $role = &Apache::lonnet::plaintext($role);
1.54 www 4201: }
1.433 albertel 4202:
1.359 albertel 4203: if (!$realm) { $realm=' '; }
1.55 www 4204: # Set messages
1.60 matthew 4205: my $messages=&domainlogo($domain);
1.330 albertel 4206:
1.438 albertel 4207: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4208:
1.101 www 4209: # construct main body tag
1.359 albertel 4210: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4211: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4212:
1.530 albertel 4213: if ($bodyonly) {
1.60 matthew 4214: return $bodytag;
1.258 albertel 4215: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4216: # Accessibility
1.224 raeburn 4217:
1.337 albertel 4218: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4219: if (!$notitle) {
1.337 albertel 4220: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4221: }
4222: return $bodytag;
1.359 albertel 4223: }
4224:
1.410 albertel 4225: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4226: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4227: undef($role);
1.434 albertel 4228: } else {
4229: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4230: }
1.359 albertel 4231:
4232: my $roleinfo=(<<ENDROLE);
4233: <td class="LC_title_bar_who">
4234: <div class="LC_title_bar_name">
1.410 albertel 4235: $name
1.361 albertel 4236:
1.359 albertel 4237: </div>
4238: <div class="LC_title_bar_role">
1.361 albertel 4239: $role
1.359 albertel 4240: </div>
4241: <div class="LC_title_bar_realm">
1.361 albertel 4242: $realm
1.359 albertel 4243: </div>
1.206 albertel 4244: </td>
4245: ENDROLE
1.235 raeburn 4246:
1.359 albertel 4247: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4248: if ($customtitle) {
4249: $titleinfo = $customtitle;
4250: }
4251: #
4252: # Extra info if you are the DC
4253: my $dc_info = '';
4254: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4255: $env{'course.'.$env{'request.course.id'}.
4256: '.domain'}.'/'})) {
4257: my $cid = $env{'request.course.id'};
4258: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4259: $dc_info =~ s/\s+$//;
1.359 albertel 4260: $dc_info = '('.$dc_info.')';
4261: }
4262:
1.644 www 4263: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4264: # No Remote
1.258 albertel 4265: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4266: $forcereg=1;
4267: }
4268:
4269: if (!$customtitle && $env{'request.state'} eq 'construct') {
4270: # this is for resources; directories have customtitle, and crumbs
4271: # and select recent are created in lonpubdir.pm
1.229 albertel 4272: my ($uname,$thisdisfn)=
1.258 albertel 4273: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4274: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4275: $formaction=~s/\/+/\//g;
4276:
1.359 albertel 4277: my $parentpath = '';
4278: my $lastitem = '';
4279: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4280: $parentpath = $1;
4281: $lastitem = $2;
4282: } else {
4283: $lastitem = $thisdisfn;
4284: }
4285: $titleinfo =
1.640 bisitz 4286: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4287: .'<b>'.&mt('Construction Space').'</b>: '
4288: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4289: .'" target="_top"><tt><b>'
1.705 tempelho 4290: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4291: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4292: .'</form>'
4293: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4294: }
1.359 albertel 4295:
1.337 albertel 4296: my $titletable;
1.338 albertel 4297: if (!$notitle) {
1.337 albertel 4298: $titletable =
1.359 albertel 4299: '<table id="LC_title_bar">'.
4300: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4301: '</tr></table>';
1.337 albertel 4302: }
1.359 albertel 4303: if ($notopbar) {
4304: $bodytag .= $titletable;
4305: } else {
4306: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4307: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4308: $titletable);
1.272 raeburn 4309: } else {
1.336 albertel 4310: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4311: $titletable;
1.272 raeburn 4312: }
1.235 raeburn 4313: }
4314: return $bodytag;
1.94 www 4315: }
1.95 www 4316:
1.93 www 4317: #
1.95 www 4318: # Top frame rendering, Remote is up
1.93 www 4319: #
1.359 albertel 4320:
1.517 raeburn 4321: my $imgsrc = $img;
4322: if ($img =~ /^\/adm/) {
1.575 albertel 4323: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4324: }
4325: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4326:
1.305 www 4327: # Explicit link to get inline menu
1.361 albertel 4328: my $menu= ($no_inline_link?''
4329: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4330: #
1.338 albertel 4331: if ($notitle) {
1.337 albertel 4332: return $bodytag;
4333: }
1.94 www 4334: return(<<ENDBODY);
1.60 matthew 4335: $bodytag
1.359 albertel 4336: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4337: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4338: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4339: </tr>
1.359 albertel 4340: <tr><td>$titleinfo $dc_info $menu</td>
4341: $roleinfo
1.368 albertel 4342: </tr>
1.356 albertel 4343: </table>
1.54 www 4344: ENDBODY
1.182 matthew 4345: }
4346:
1.330 albertel 4347: sub make_attr_string {
4348: my ($register,$attr_ref) = @_;
4349:
4350: if ($attr_ref && !ref($attr_ref)) {
4351: die("addentries Must be a hash ref ".
4352: join(':',caller(1))." ".
4353: join(':',caller(0))." ");
4354: }
4355:
4356: if ($register) {
1.339 albertel 4357: my ($on_load,$on_unload);
4358: foreach my $key (keys(%{$attr_ref})) {
4359: if (lc($key) eq 'onload') {
4360: $on_load.=$attr_ref->{$key}.';';
4361: delete($attr_ref->{$key});
4362:
4363: } elsif (lc($key) eq 'onunload') {
4364: $on_unload.=$attr_ref->{$key}.';';
4365: delete($attr_ref->{$key});
4366: }
4367: }
4368: $attr_ref->{'onload'} =
4369: &Apache::lonmenu::loadevents(). $on_load;
4370: $attr_ref->{'onunload'}=
4371: &Apache::lonmenu::unloadevents().$on_unload;
4372: }
4373:
4374: # Accessibility font enhance
4375: if ($env{'browser.fontenhance'} eq 'on') {
4376: my $style;
4377: foreach my $key (keys(%{$attr_ref})) {
4378: if (lc($key) eq 'style') {
4379: $style.=$attr_ref->{$key}.';';
4380: delete($attr_ref->{$key});
4381: }
4382: }
4383: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4384: }
1.339 albertel 4385:
4386: if ($env{'browser.blackwhite'} eq 'on') {
4387: delete($attr_ref->{'font'});
4388: delete($attr_ref->{'link'});
4389: delete($attr_ref->{'alink'});
4390: delete($attr_ref->{'vlink'});
4391: delete($attr_ref->{'bgcolor'});
4392: delete($attr_ref->{'background'});
4393: }
4394:
1.330 albertel 4395: my $attr_string;
4396: foreach my $attr (keys(%$attr_ref)) {
4397: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4398: }
4399: return $attr_string;
4400: }
4401:
4402:
1.182 matthew 4403: ###############################################
1.251 albertel 4404: ###############################################
4405:
4406: =pod
4407:
4408: =item * &endbodytag()
4409:
4410: Returns a uniform footer for LON-CAPA web pages.
4411:
1.635 raeburn 4412: Inputs: 1 - optional reference to an args hash
4413: If in the hash, key for noredirectlink has a value which evaluates to true,
4414: a 'Continue' link is not displayed if the page contains an
4415: internal redirect in the <head></head> section,
4416: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4417:
4418: =cut
4419:
4420: sub endbodytag {
1.635 raeburn 4421: my ($args) = @_;
1.251 albertel 4422: my $endbodytag='</body>';
1.269 albertel 4423: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4424: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4425: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4426: $endbodytag=
4427: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4428: &mt('Continue').'</a>'.
4429: $endbodytag;
4430: }
1.315 albertel 4431: }
1.251 albertel 4432: return $endbodytag;
4433: }
4434:
1.352 albertel 4435: =pod
4436:
4437: =item * &standard_css()
4438:
4439: Returns a style sheet
4440:
4441: Inputs: (all optional)
4442: domain -> force to color decorate a page for a specific
4443: domain
4444: function -> force usage of a specific rolish color scheme
4445: bgcolor -> override the default page bgcolor
4446:
4447: =cut
4448:
1.343 albertel 4449: sub standard_css {
1.345 albertel 4450: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4451: $function = &get_users_function() if (!$function);
4452: my $img = &designparm($function.'.img', $domain);
4453: my $tabbg = &designparm($function.'.tabbg', $domain);
4454: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4455: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4456: my $pgbg_or_bgcolor =
4457: $bgcolor ||
1.352 albertel 4458: &designparm($function.'.pgbg', $domain);
1.382 albertel 4459: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4460: my $alink = &designparm($function.'.alink', $domain);
4461: my $vlink = &designparm($function.'.vlink', $domain);
4462: my $link = &designparm($function.'.link', $domain);
4463:
1.704 muellerd 4464: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4465: my $bgcol = &designparm('login.bgcol',$domain);
4466: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4467:
1.602 albertel 4468: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4469: my $mono = 'monospace';
1.352 albertel 4470: my $data_table_head = $tabbg;
4471: my $data_table_light = '#EEEEEE';
1.470 banghart 4472: my $data_table_dark = '#DDDDDD';
4473: my $data_table_darker = '#CCCCCC';
1.349 albertel 4474: my $data_table_highlight = '#FFFF00';
1.352 albertel 4475: my $mail_new = '#FFBB77';
4476: my $mail_new_hover = '#DD9955';
4477: my $mail_read = '#BBBB77';
4478: my $mail_read_hover = '#999944';
4479: my $mail_replied = '#AAAA88';
4480: my $mail_replied_hover = '#888855';
4481: my $mail_other = '#99BBBB';
4482: my $mail_other_hover = '#669999';
1.391 albertel 4483: my $table_header = '#DDDDDD';
1.489 raeburn 4484: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4485: my $lg_border_color = '#C8C8C8';
1.392 albertel 4486:
1.608 albertel 4487: my $border = ($env{'browser.type'} eq 'explorer' ||
4488: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4489: : '0px 3px 0px 4px';
1.448 albertel 4490:
1.523 albertel 4491:
1.343 albertel 4492: return <<END;
1.698 harmsja 4493: body{
4494: font-family: $sans;
4495: line-height:130%;
1.701 harmsja 4496: font-size:0.83em;
1.698 harmsja 4497: color:$font;
4498: }
1.701 harmsja 4499: a:link, a:visited { font-size:100%; }
1.698 harmsja 4500:
1.343 albertel 4501: a:focus { color: red; background: yellow }
1.510 albertel 4502: table.thinborder,
4503: table.thinborder tr th {
4504: border-style: solid;
4505: border-width: 1px;
1.698 harmsja 4506: border-color: $lg_border_color;
1.510 albertel 4507: background: $tabbg;
4508: }
1.523 albertel 4509: table.thinborder tr td {
1.510 albertel 4510: border-style: solid;
1.698 harmsja 4511: border-width: 1px;
4512: border-color: $lg_border_color;
1.510 albertel 4513: }
1.426 albertel 4514:
1.343 albertel 4515: form, .inline { display: inline; }
1.721 harmsja 4516:
4517: .LC_center { text-align: center; }
4518: .LC_left { text-align:left; }
4519: .LC_right {text-align:right;}
4520: .LC_middle {vertical-align:middle;}
4521: .LC_top {vertical-align:top;}
4522: .LC_bottom {vertical-align:bottom;}
4523:
4524: /* just for tests */
4525: .LC_300Box { width:300px; }
1.754 droeschl 4526: .LC_400Box {width:400px; }
1.721 harmsja 4527: .LC_500Box {width:500px; }
4528: .LC_600Box {width:600px; }
1.741 harmsja 4529: .LC_800Box {width:800px;}
1.721 harmsja 4530: /* end */
4531:
1.593 albertel 4532: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4533: .LC_error {
4534: color: red;
4535: font-size: larger;
4536: }
1.457 albertel 4537: .LC_warning,
4538: .LC_diff_removed {
1.733 bisitz 4539: color: red;
1.394 albertel 4540: }
1.532 albertel 4541:
4542: .LC_info,
1.457 albertel 4543: .LC_success,
4544: .LC_diff_added {
1.350 albertel 4545: color: green;
4546: }
1.543 albertel 4547: .LC_unknown {
4548: color: yellow;
4549: }
4550:
1.440 albertel 4551: .LC_icon {
4552: border: 0px;
4553: }
1.539 albertel 4554: .LC_indexer_icon {
4555: border: 0px;
4556: height: 22px;
4557: }
1.543 albertel 4558: .LC_docs_spacer {
4559: width: 25px;
4560: height: 1px;
4561: border: 0px;
4562: }
1.346 albertel 4563:
1.532 albertel 4564: .LC_internal_info {
1.735 bisitz 4565: color: #999999;
1.532 albertel 4566: }
4567:
1.458 albertel 4568: table.LC_pastsubmission {
4569: border: 1px solid black;
4570: margin: 2px;
4571: }
4572:
1.606 albertel 4573: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4574: width: 100%;
4575: background: $pgbg;
1.392 albertel 4576: border: 2px;
1.402 albertel 4577: border-collapse: separate;
1.403 albertel 4578: padding: 0px;
1.345 albertel 4579: }
1.392 albertel 4580:
1.606 albertel 4581: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4582: table#LC_title_bar.LC_with_remote {
1.359 albertel 4583: width: 100%;
1.392 albertel 4584: border-color: $pgbg;
4585: border-style: solid;
4586: border-width: $border;
4587:
1.379 albertel 4588: background: $pgbg;
4589: font-family: $sans;
1.392 albertel 4590: border-collapse: collapse;
1.403 albertel 4591: padding: 0px;
1.359 albertel 4592: }
1.409 albertel 4593: table.LC_docs_path {
4594: width: 100%;
4595: border: 0;
4596: background: $pgbg;
4597: font-family: $sans;
4598: border-collapse: collapse;
4599: padding: 0px;
4600: }
4601:
1.359 albertel 4602: table#LC_title_bar td {
4603: background: $tabbg;
4604: }
4605: table#LC_title_bar td.LC_title_bar_who {
4606: background: $tabbg;
4607: color: $font;
1.427 albertel 4608: font: small $sans;
1.359 albertel 4609: text-align: right;
4610: }
1.469 banghart 4611: span.LC_metadata {
4612: font-family: $sans;
4613: }
1.359 albertel 4614: span.LC_title_bar_title {
1.416 albertel 4615: font: bold x-large $sans;
1.359 albertel 4616: }
4617: table#LC_title_bar td.LC_title_bar_domain_logo {
4618: background: $sidebg;
4619: text-align: right;
1.368 albertel 4620: padding: 0px;
4621: }
4622: table#LC_title_bar td.LC_title_bar_role_logo {
4623: background: $sidebg;
4624: padding: 0px;
1.359 albertel 4625: }
4626:
1.706 harmsja 4627: table#LC_menubuttons img{
1.346 albertel 4628: border: 0px;
4629: }
1.345 albertel 4630: table#LC_top_nav td {
4631: background: $tabbg;
1.392 albertel 4632: border: 0px;
1.407 albertel 4633: font-size: small;
1.706 harmsja 4634: vertical-align:top;
4635: padding:2px 5px 2px 5px;
1.345 albertel 4636: }
4637: table#LC_top_nav td a, div#LC_top_nav a {
4638: color: $font;
4639: font-family: $sans;
4640: }
1.364 albertel 4641: table#LC_top_nav td.LC_top_nav_logo {
4642: background: $tabbg;
1.432 albertel 4643: text-align: left;
1.408 albertel 4644: white-space: nowrap;
1.432 albertel 4645: width: 31px;
1.408 albertel 4646: }
4647: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4648: border: 0px;
1.408 albertel 4649: vertical-align: bottom;
1.364 albertel 4650: }
1.432 albertel 4651: table#LC_top_nav td.LC_top_nav_exit,
4652: table#LC_top_nav td.LC_top_nav_help {
4653: width: 2.0em;
4654: }
1.442 albertel 4655: table#LC_top_nav td.LC_top_nav_login {
4656: width: 4.0em;
4657: text-align: center;
4658: }
1.409 albertel 4659: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4660: background: $tabbg;
4661: color: $font;
4662: font-family: $sans;
1.358 albertel 4663: font-size: smaller;
1.357 albertel 4664: }
1.411 albertel 4665: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4666: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4667: background: $tabbg;
4668: color: $font;
4669: font-family: $sans;
4670: font-size: larger;
4671: text-align: right;
4672: }
1.383 albertel 4673: td.LC_table_cell_checkbox {
4674: text-align: center;
4675: }
1.522 albertel 4676: table#LC_mainmenu td.LC_mainmenu_column {
4677: vertical-align: top;
4678: }
4679:
1.705 tempelho 4680: .LC_fontsize_small
4681: {
4682: font-size: 70%;
4683: }
4684:
4685: .LC_fontsize_medium
4686: {
4687: font-size: 85%;
4688: }
4689:
4690: .LC_fontsize_large
4691: {
4692: font-size: 120%;
4693: }
4694:
4695: .LC_fontcolor_red
4696: {
4697: color: #FF0000;
4698: }
4699:
1.346 albertel 4700: .LC_menubuttons_inline_text {
4701: color: $font;
4702: font-family: $sans;
1.698 harmsja 4703: font-size: 90%;
1.701 harmsja 4704: padding-left:3px;
1.346 albertel 4705: }
4706:
1.526 www 4707: .LC_menubuttons_link {
4708: text-decoration: none;
4709: }
1.698 harmsja 4710: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4711: .LC_menubuttons_category {
1.521 www 4712: color: $font;
1.526 www 4713: background: $pgbg;
1.521 www 4714: font-family: $sans;
4715: font-size: larger;
4716: font-weight: bold;
4717: }
4718:
1.346 albertel 4719: td.LC_menubuttons_text {
1.701 harmsja 4720: color: $font;
1.346 albertel 4721: }
1.706 harmsja 4722:
4723:
1.526 www 4724:
1.346 albertel 4725: .LC_current_location {
4726: font-family: $sans;
4727: background: $tabbg;
4728: }
4729: .LC_new_mail {
4730: font-family: $sans;
1.634 www 4731: background: $tabbg;
1.346 albertel 4732: font-weight: bold;
4733: }
1.347 albertel 4734:
1.526 www 4735:
1.527 www 4736: .LC_dropadd_labeltext {
4737: font-family: $sans;
4738: text-align: right;
4739: }
4740:
4741: .LC_preferences_labeltext {
4742: font-family: $sans;
4743: text-align: right;
4744: }
4745:
1.666 raeburn 4746: .LC_roleslog_note {
1.701 harmsja 4747: font-size: small;
1.666 raeburn 4748: }
4749:
1.715 raeburn 4750: .LC_mail_functions {
4751: font-weight: bold;
4752: }
4753:
1.440 albertel 4754: table.LC_aboutme_port {
4755: border: 0px;
4756: border-collapse: collapse;
4757: border-spacing: 0px;
4758: }
1.349 albertel 4759: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4760: border: 1px solid #000000;
1.402 albertel 4761: border-collapse: separate;
1.426 albertel 4762: border-spacing: 1px;
1.610 albertel 4763: background: $pgbg;
1.347 albertel 4764: }
1.422 albertel 4765: .LC_data_table_dense {
4766: font-size: small;
4767: }
1.507 raeburn 4768: table.LC_nested_outer {
4769: border: 1px solid #000000;
1.589 raeburn 4770: border-collapse: collapse;
1.507 raeburn 4771: border-spacing: 0px;
4772: width: 100%;
4773: }
4774: table.LC_nested {
4775: border: 0px;
1.589 raeburn 4776: border-collapse: collapse;
1.507 raeburn 4777: border-spacing: 0px;
4778: width: 100%;
4779: }
1.523 albertel 4780: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4781: table.LC_prior_tries tr th {
1.349 albertel 4782: font-weight: bold;
4783: background-color: $data_table_head;
1.701 harmsja 4784: font-size:90%;
1.347 albertel 4785: }
1.711 raeburn 4786: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4787: background-color: #CCCCCC;
1.711 raeburn 4788: font-weight: bold;
4789: text-align: left;
4790: }
1.610 albertel 4791: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4792: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4793: table.LC_aboutme_port tr td {
1.349 albertel 4794: background-color: $data_table_light;
1.425 albertel 4795: padding: 2px;
1.347 albertel 4796: }
1.610 albertel 4797: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4798: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4799: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4800: background-color: $data_table_dark;
1.709 bisitz 4801: padding: 2px;
1.347 albertel 4802: }
1.425 albertel 4803: table.LC_data_table tr.LC_data_table_highlight td {
4804: background-color: $data_table_darker;
4805: }
1.639 raeburn 4806: table.LC_data_table tr td.LC_leftcol_header {
4807: background-color: $data_table_head;
4808: font-weight: bold;
4809: }
1.451 albertel 4810: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4811: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4812: background-color: #FFFFFF;
1.421 albertel 4813: font-weight: bold;
4814: font-style: italic;
4815: text-align: center;
4816: padding: 8px;
1.347 albertel 4817: }
1.507 raeburn 4818: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4819: padding: 4ex
4820: }
1.507 raeburn 4821: table.LC_nested_outer tr th {
4822: font-weight: bold;
4823: background-color: $data_table_head;
1.701 harmsja 4824: font-size: small;
1.507 raeburn 4825: border-bottom: 1px solid #000000;
4826: }
4827: table.LC_nested_outer tr td.LC_subheader {
4828: background-color: $data_table_head;
4829: font-weight: bold;
4830: font-size: small;
4831: border-bottom: 1px solid #000000;
4832: text-align: right;
1.451 albertel 4833: }
1.507 raeburn 4834: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4835: background-color: #CCCCCC;
1.451 albertel 4836: font-weight: bold;
4837: font-size: small;
1.507 raeburn 4838: text-align: center;
4839: }
1.589 raeburn 4840: table.LC_nested tr.LC_info_row td.LC_left_item,
4841: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4842: text-align: left;
1.451 albertel 4843: }
1.507 raeburn 4844: table.LC_nested td {
1.735 bisitz 4845: background-color: #FFFFFF;
1.451 albertel 4846: font-size: small;
1.507 raeburn 4847: }
4848: table.LC_nested_outer tr th.LC_right_item,
4849: table.LC_nested tr.LC_info_row td.LC_right_item,
4850: table.LC_nested tr.LC_odd_row td.LC_right_item,
4851: table.LC_nested tr td.LC_right_item {
1.451 albertel 4852: text-align: right;
4853: }
4854:
1.507 raeburn 4855: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4856: background-color: #EEEEEE;
1.451 albertel 4857: }
4858:
1.473 raeburn 4859: table.LC_createuser {
4860: }
4861:
4862: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4863: font-size: small;
1.473 raeburn 4864: }
4865:
4866: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 4867: background-color: #CCCCCC;
1.473 raeburn 4868: font-weight: bold;
4869: text-align: center;
4870: }
4871:
1.349 albertel 4872: table.LC_calendar {
4873: border: 1px solid #000000;
4874: border-collapse: collapse;
4875: }
4876: table.LC_calendar_pickdate {
4877: font-size: xx-small;
4878: }
4879: table.LC_calendar tr td {
4880: border: 1px solid #000000;
4881: vertical-align: top;
4882: }
4883: table.LC_calendar tr td.LC_calendar_day_empty {
4884: background-color: $data_table_dark;
4885: }
4886: table.LC_calendar tr td.LC_calendar_day_current {
4887: background-color: $data_table_highlight;
4888: }
4889:
4890: table.LC_mail_list tr.LC_mail_new {
4891: background-color: $mail_new;
4892: }
4893: table.LC_mail_list tr.LC_mail_new:hover {
4894: background-color: $mail_new_hover;
4895: }
4896: table.LC_mail_list tr.LC_mail_read {
4897: background-color: $mail_read;
4898: }
4899: table.LC_mail_list tr.LC_mail_read:hover {
4900: background-color: $mail_read_hover;
4901: }
4902: table.LC_mail_list tr.LC_mail_replied {
4903: background-color: $mail_replied;
4904: }
4905: table.LC_mail_list tr.LC_mail_replied:hover {
4906: background-color: $mail_replied_hover;
4907: }
4908: table.LC_mail_list tr.LC_mail_other {
4909: background-color: $mail_other;
4910: }
4911: table.LC_mail_list tr.LC_mail_other:hover {
4912: background-color: $mail_other_hover;
4913: }
1.494 raeburn 4914: table.LC_mail_list tr.LC_mail_even {
4915: }
4916: table.LC_mail_list tr.LC_mail_odd {
4917: }
4918:
1.696 bisitz 4919: table.LC_data_table tr > td.LC_browser_file,
4920: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4921: background: #CCFF88;
4922: }
1.696 bisitz 4923: table.LC_data_table tr > td.LC_browser_file_locked,
4924: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4925: background: #FFAA99;
1.387 albertel 4926: }
1.696 bisitz 4927: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.389 albertel 4928: background: #AAAAAA;
1.387 albertel 4929: }
1.696 bisitz 4930: table.LC_data_table tr > td.LC_browser_file_modified,
4931: table.LC_data_table tr > td.LC_browser_file_metamodified {
1.389 albertel 4932: background: #FFFF77;
1.387 albertel 4933: }
1.696 bisitz 4934: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4935: background: #CCCCFF;
1.387 albertel 4936: }
1.696 bisitz 4937:
1.707 bisitz 4938: table.LC_data_table tr > td.LC_roles_is {
4939: /* background: #77FF77; */
4940: }
4941: table.LC_data_table tr > td.LC_roles_future {
4942: background: #FFFF77;
4943: }
4944: table.LC_data_table tr > td.LC_roles_will {
4945: background: #FFAA77;
4946: }
4947: table.LC_data_table tr > td.LC_roles_expired {
4948: background: #FF7777;
4949: }
4950: table.LC_data_table tr > td.LC_roles_will_not {
4951: background: #AAFF77;
4952: }
4953: table.LC_data_table tr > td.LC_roles_selected {
4954: background: #11CC55;
4955: }
4956:
1.388 albertel 4957: span.LC_current_location {
1.701 harmsja 4958: font-size:larger;
1.388 albertel 4959: background: $pgbg;
4960: }
1.387 albertel 4961:
1.395 albertel 4962: span.LC_parm_menu_item {
4963: font-size: larger;
4964: font-family: $sans;
4965: }
4966: span.LC_parm_scope_all {
4967: color: red;
4968: }
4969: span.LC_parm_scope_folder {
4970: color: green;
4971: }
4972: span.LC_parm_scope_resource {
4973: color: orange;
4974: }
4975: span.LC_parm_part {
4976: color: blue;
4977: }
4978: span.LC_parm_folder, span.LC_parm_symb {
4979: font-size: x-small;
4980: font-family: $mono;
4981: color: #AAAAAA;
4982: }
4983:
1.396 albertel 4984: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4985: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4986: border: 1px solid black;
4987: border-collapse: collapse;
4988: }
4989: table.LC_parm_overview_restrictions td {
4990: border-width: 1px 4px 1px 4px;
4991: border-style: solid;
4992: border-color: $pgbg;
4993: text-align: center;
4994: }
4995: table.LC_parm_overview_restrictions th {
4996: background: $tabbg;
4997: border-width: 1px 4px 1px 4px;
4998: border-style: solid;
4999: border-color: $pgbg;
5000: }
1.398 albertel 5001: table#LC_helpmenu {
5002: border: 0px;
5003: height: 55px;
5004: border-spacing: 0px;
5005: }
5006:
5007: table#LC_helpmenu fieldset legend {
5008: font-size: larger;
5009: font-weight: bold;
5010: }
1.397 albertel 5011: table#LC_helpmenu_links {
5012: width: 100%;
5013: border: 1px solid black;
5014: background: $pgbg;
5015: padding: 0px;
5016: border-spacing: 1px;
5017: }
5018: table#LC_helpmenu_links tr td {
5019: padding: 1px;
5020: background: $tabbg;
1.399 albertel 5021: text-align: center;
5022: font-weight: bold;
1.397 albertel 5023: }
1.396 albertel 5024:
1.397 albertel 5025: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5026: table#LC_helpmenu_links a:active {
5027: text-decoration: none;
5028: color: $font;
5029: }
5030: table#LC_helpmenu_links a:hover {
5031: text-decoration: underline;
5032: color: $vlink;
5033: }
1.396 albertel 5034:
1.417 albertel 5035: .LC_chrt_popup_exists {
5036: border: 1px solid #339933;
5037: margin: -1px;
5038: }
5039: .LC_chrt_popup_up {
5040: border: 1px solid yellow;
5041: margin: -1px;
5042: }
5043: .LC_chrt_popup {
5044: border: 1px solid #8888FF;
5045: background: #CCCCFF;
5046: }
1.421 albertel 5047: table.LC_pick_box {
5048: border-collapse: separate;
5049: background: white;
5050: border: 1px solid black;
5051: border-spacing: 1px;
5052: }
5053: table.LC_pick_box td.LC_pick_box_title {
5054: background: $tabbg;
5055: font-weight: bold;
5056: text-align: right;
1.740 bisitz 5057: vertical-align: top;
1.421 albertel 5058: width: 184px;
5059: padding: 8px;
5060: }
1.645 raeburn 5061: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5062: background: $tabbg;
5063: font-weight: bold;
5064: text-align: right;
5065: width: 350px;
5066: padding: 8px;
5067: }
5068:
1.579 raeburn 5069: table.LC_pick_box td.LC_pick_box_value {
5070: text-align: left;
5071: padding: 8px;
5072: }
5073: table.LC_pick_box td.LC_pick_box_select {
5074: text-align: left;
5075: padding: 8px;
5076: }
1.424 albertel 5077: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5078: padding: 0px;
5079: height: 1px;
5080: background: black;
5081: }
5082: table.LC_pick_box td.LC_pick_box_submit {
5083: text-align: right;
5084: }
1.579 raeburn 5085: table.LC_pick_box td.LC_evenrow_value {
5086: text-align: left;
5087: padding: 8px;
5088: background-color: $data_table_light;
5089: }
5090: table.LC_pick_box td.LC_oddrow_value {
5091: text-align: left;
5092: padding: 8px;
5093: background-color: $data_table_light;
5094: }
5095: table.LC_helpform_receipt {
5096: width: 620px;
5097: border-collapse: separate;
5098: background: white;
5099: border: 1px solid black;
5100: border-spacing: 1px;
5101: }
5102: table.LC_helpform_receipt td.LC_pick_box_title {
5103: background: $tabbg;
5104: font-weight: bold;
5105: text-align: right;
5106: width: 184px;
5107: padding: 8px;
5108: }
5109: table.LC_helpform_receipt td.LC_evenrow_value {
5110: text-align: left;
5111: padding: 8px;
5112: background-color: $data_table_light;
5113: }
5114: table.LC_helpform_receipt td.LC_oddrow_value {
5115: text-align: left;
5116: padding: 8px;
5117: background-color: $data_table_light;
5118: }
5119: table.LC_helpform_receipt td.LC_pick_box_separator {
5120: padding: 0px;
5121: height: 1px;
5122: background: black;
5123: }
5124: span.LC_helpform_receipt_cat {
5125: font-weight: bold;
5126: }
1.424 albertel 5127: table.LC_group_priv_box {
5128: background: white;
5129: border: 1px solid black;
5130: border-spacing: 1px;
5131: }
5132: table.LC_group_priv_box td.LC_pick_box_title {
5133: background: $tabbg;
5134: font-weight: bold;
5135: text-align: right;
5136: width: 184px;
5137: }
5138: table.LC_group_priv_box td.LC_groups_fixed {
5139: background: $data_table_light;
5140: text-align: center;
5141: }
5142: table.LC_group_priv_box td.LC_groups_optional {
5143: background: $data_table_dark;
5144: text-align: center;
5145: }
5146: table.LC_group_priv_box td.LC_groups_functionality {
5147: background: $data_table_darker;
5148: text-align: center;
5149: font-weight: bold;
5150: }
5151: table.LC_group_priv td {
5152: text-align: left;
5153: padding: 0px;
5154: }
5155:
1.421 albertel 5156: table.LC_notify_front_page {
5157: background: white;
5158: border: 1px solid black;
5159: padding: 8px;
5160: }
5161: table.LC_notify_front_page td {
5162: padding: 8px;
5163: }
1.424 albertel 5164: .LC_navbuttons {
5165: margin: 2ex 0ex 2ex 0ex;
5166: }
1.423 albertel 5167: .LC_topic_bar {
5168: font-family: $sans;
5169: font-weight: bold;
5170: width: 100%;
5171: background: $tabbg;
5172: vertical-align: middle;
5173: margin: 2ex 0ex 2ex 0ex;
5174: }
5175: .LC_topic_bar span {
5176: vertical-align: middle;
5177: }
5178: .LC_topic_bar img {
5179: vertical-align: bottom;
5180: }
5181: table.LC_course_group_status {
5182: margin: 20px;
5183: }
5184: table.LC_status_selector td {
5185: vertical-align: top;
5186: text-align: center;
1.424 albertel 5187: padding: 4px;
5188: }
5189: table.LC_descriptive_input td.LC_description {
5190: vertical-align: top;
5191: text-align: right;
5192: font-weight: bold;
1.423 albertel 5193: }
1.599 albertel 5194: div.LC_feedback_link {
1.616 albertel 5195: clear: both;
1.599 albertel 5196: background: white;
5197: width: 100%;
1.489 raeburn 5198: }
5199: span.LC_feedback_link {
1.599 albertel 5200: background: $feedback_link_bg;
5201: font-size: larger;
5202: }
5203: span.LC_message_link {
5204: background: $feedback_link_bg;
5205: font-size: larger;
5206: position: absolute;
5207: right: 1em;
1.489 raeburn 5208: }
1.421 albertel 5209:
1.515 albertel 5210: table.LC_prior_tries {
1.524 albertel 5211: border: 1px solid #000000;
5212: border-collapse: separate;
5213: border-spacing: 1px;
1.515 albertel 5214: }
1.523 albertel 5215:
1.515 albertel 5216: table.LC_prior_tries td {
1.524 albertel 5217: padding: 2px;
1.515 albertel 5218: }
1.523 albertel 5219:
5220: .LC_answer_correct {
5221: background: #AAFFAA;
5222: color: black;
5223: }
5224: .LC_answer_charged_try {
5225: background: #FFAAAA ! important;
5226: color: black;
5227: }
5228: .LC_answer_not_charged_try,
5229: .LC_answer_no_grade,
5230: .LC_answer_late {
5231: background: #FFFFAA;
5232: color: black;
5233: }
5234: .LC_answer_previous {
5235: background: #AAAAFF;
5236: color: black;
5237: }
5238: .LC_answer_no_message {
5239: background: #FFFFFF;
5240: color: black;
5241: }
5242: .LC_answer_unknown {
5243: background: orange;
5244: color: black;
5245: }
5246:
5247:
1.529 albertel 5248: span.LC_prior_numerical,
5249: span.LC_prior_string,
5250: span.LC_prior_custom,
5251: span.LC_prior_reaction,
5252: span.LC_prior_math {
1.523 albertel 5253: font-family: monospace;
5254: white-space: pre;
5255: }
5256:
1.525 albertel 5257: span.LC_prior_string {
5258: font-family: monospace;
5259: white-space: pre;
5260: }
5261:
1.523 albertel 5262: table.LC_prior_option {
5263: width: 100%;
5264: border-collapse: collapse;
5265: }
1.528 albertel 5266: table.LC_prior_rank, table.LC_prior_match {
5267: border-collapse: collapse;
5268: }
5269: table.LC_prior_option tr td,
5270: table.LC_prior_rank tr td,
5271: table.LC_prior_match tr td {
1.524 albertel 5272: border: 1px solid #000000;
1.515 albertel 5273: }
5274:
1.519 raeburn 5275: span.LC_nobreak {
1.544 albertel 5276: white-space: nowrap;
1.519 raeburn 5277: }
5278:
1.576 raeburn 5279: span.LC_cusr_emph {
5280: font-style: italic;
5281: }
5282:
1.633 raeburn 5283: span.LC_cusr_subheading {
5284: font-weight: normal;
5285: font-size: 85%;
5286: }
5287:
1.545 albertel 5288: table.LC_docs_documents {
5289: background: #BBBBBB;
1.547 albertel 5290: border-width: 0px;
1.545 albertel 5291: border-collapse: collapse;
5292: }
5293:
5294: table.LC_docs_documents td.LC_docs_document {
5295: border: 2px solid black;
5296: padding: 4px;
5297: }
5298:
5299: .LC_docs_entry_move {
5300: border: 0px;
5301: border-collapse: collapse;
1.544 albertel 5302: }
5303:
1.545 albertel 5304: .LC_docs_entry_move td {
5305: border: 2px solid #BBBBBB;
5306: background: #DDDDDD;
5307: }
5308:
5309: .LC_docs_editor td.LC_docs_entry_commands {
5310: background: #DDDDDD;
5311: font-size: x-small;
5312: }
1.544 albertel 5313: .LC_docs_copy {
1.545 albertel 5314: color: #000099;
1.544 albertel 5315: }
5316: .LC_docs_cut {
1.545 albertel 5317: color: #550044;
1.544 albertel 5318: }
5319: .LC_docs_rename {
1.545 albertel 5320: color: #009900;
1.544 albertel 5321: }
5322: .LC_docs_remove {
1.545 albertel 5323: color: #990000;
5324: }
5325:
1.547 albertel 5326: .LC_docs_reinit_warn,
5327: .LC_docs_ext_edit {
5328: font-size: x-small;
5329: }
5330:
1.545 albertel 5331: .LC_docs_editor td.LC_docs_entry_title,
5332: .LC_docs_editor td.LC_docs_entry_icon {
5333: background: #FFFFBB;
5334: }
5335: .LC_docs_editor td.LC_docs_entry_parameter {
5336: background: #BBBBFF;
5337: font-size: x-small;
5338: white-space: nowrap;
5339: }
5340:
5341: table.LC_docs_adddocs td,
5342: table.LC_docs_adddocs th {
5343: border: 1px solid #BBBBBB;
5344: padding: 4px;
5345: background: #DDDDDD;
1.543 albertel 5346: }
5347:
1.584 albertel 5348: table.LC_sty_begin {
5349: background: #BBFFBB;
5350: }
5351: table.LC_sty_end {
5352: background: #FFBBBB;
5353: }
5354:
1.589 raeburn 5355: table.LC_double_column {
5356: border-width: 0px;
5357: border-collapse: collapse;
5358: width: 100%;
5359: padding: 2px;
5360: }
5361:
5362: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5363: top: 2px;
1.589 raeburn 5364: left: 2px;
5365: width: 47%;
5366: vertical-align: top;
5367: }
5368:
5369: table.LC_double_column tr td.LC_right_col {
5370: top: 2px;
5371: right: 2px;
5372: width: 47%;
5373: vertical-align: top;
5374: }
5375:
1.594 raeburn 5376: span.LC_role_level {
5377: font-weight: bold;
5378: }
5379:
1.591 raeburn 5380: div.LC_left_float {
5381: float: left;
5382: padding-right: 5%;
1.597 albertel 5383: padding-bottom: 4px;
1.591 raeburn 5384: }
5385:
5386: div.LC_clear_float_header {
1.597 albertel 5387: padding-bottom: 2px;
1.591 raeburn 5388: }
5389:
5390: div.LC_clear_float_footer {
1.597 albertel 5391: padding-top: 10px;
1.591 raeburn 5392: clear: both;
5393: }
5394:
1.597 albertel 5395:
5396: div.LC_grade_show_user {
5397: margin-top: 20px;
5398: border: 1px solid black;
5399: }
5400: div.LC_grade_user_name {
5401: background: #DDDDEE;
5402: border-bottom: 1px solid black;
1.705 tempelho 5403: font-weight: bold;
5404: font-size: large;
1.597 albertel 5405: }
5406: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5407: background: #DDEEDD;
5408: }
5409:
5410: div.LC_grade_show_problem,
5411: div.LC_grade_submissions,
5412: div.LC_grade_message_center,
5413: div.LC_grade_info_links,
5414: div.LC_grade_assign {
5415: margin: 5px;
5416: width: 99%;
5417: background: #FFFFFF;
5418: }
5419: div.LC_grade_show_problem_header,
5420: div.LC_grade_submissions_header,
5421: div.LC_grade_message_center_header,
5422: div.LC_grade_assign_header {
1.705 tempelho 5423: font-weight: bold;
5424: font-size: large;
1.597 albertel 5425: }
5426: div.LC_grade_show_problem_problem,
5427: div.LC_grade_submissions_body,
5428: div.LC_grade_message_center_body,
5429: div.LC_grade_assign_body {
5430: border: 1px solid black;
5431: width: 99%;
5432: background: #FFFFFF;
5433: }
1.598 albertel 5434: span.LC_grade_check_note {
1.705 tempelho 5435: font-weight: normal;
5436: font-size: medium;
1.598 albertel 5437: display: inline;
5438: position: absolute;
5439: right: 1em;
5440: }
1.597 albertel 5441:
1.613 albertel 5442: table.LC_scantron_action {
5443: width: 100%;
5444: }
5445: table.LC_scantron_action tr th {
1.698 harmsja 5446: font-weight:bold;
5447: font-style:normal;
1.613 albertel 5448: }
1.698 harmsja 5449: .LC_edit_problem_header,
1.614 albertel 5450: div.LC_edit_problem_footer {
1.705 tempelho 5451: font-weight: normal;
5452: font-size: medium;
1.602 albertel 5453: margin: 2px;
1.600 albertel 5454: }
5455: div.LC_edit_problem_header,
1.602 albertel 5456: div.LC_edit_problem_header div,
1.614 albertel 5457: div.LC_edit_problem_footer,
5458: div.LC_edit_problem_footer div,
1.602 albertel 5459: div.LC_edit_problem_editxml_header,
5460: div.LC_edit_problem_editxml_header div {
1.600 albertel 5461: margin-top: 5px;
5462: }
1.602 albertel 5463: div.LC_edit_problem_header_edit_row {
5464: background: $tabbg;
5465: padding: 3px;
5466: margin-bottom: 5px;
5467: }
1.600 albertel 5468: div.LC_edit_problem_header_title {
1.705 tempelho 5469: font-weight: bold;
5470: font-size: larger;
1.602 albertel 5471: background: $tabbg;
5472: padding: 3px;
5473: }
5474: table.LC_edit_problem_header_title {
1.705 tempelho 5475: font-size: larger;
5476: font-weight: bold;
1.602 albertel 5477: width: 100%;
5478: border-color: $pgbg;
5479: border-style: solid;
5480: border-width: $border;
5481:
1.600 albertel 5482: background: $tabbg;
1.602 albertel 5483: border-collapse: collapse;
5484: padding: 0px
5485: }
5486:
5487: div.LC_edit_problem_discards {
5488: float: left;
5489: padding-bottom: 5px;
5490: }
5491: div.LC_edit_problem_saves {
5492: float: right;
5493: padding-bottom: 5px;
1.600 albertel 5494: }
5495: hr.LC_edit_problem_divide {
1.602 albertel 5496: clear: both;
1.600 albertel 5497: color: $tabbg;
5498: background-color: $tabbg;
5499: height: 3px;
5500: border: 0px;
5501: }
1.679 riegler 5502: img.stift{
1.678 riegler 5503: border-width:0;
1.679 riegler 5504: vertical-align:middle;
1.677 riegler 5505: }
1.680 riegler 5506:
1.681 riegler 5507: table#LC_mainmenu{
5508: margin-top:10px;
5509: width:80%;
5510:
5511: }
5512:
1.680 riegler 5513: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5514: vertical-align: top;
5515: width: 45%;
5516: }
5517: .LC_mainmenu_fieldset_category {
5518: color: $font;
5519: background: $pgbg;
5520: font-family: $sans;
5521: font-size: small;
5522: font-weight: bold;
5523: }
5524:
1.716 raeburn 5525: div.LC_createcourse {
5526: margin: 10px 10px 10px 10px;
5527: }
5528:
1.693 droeschl 5529: /* ---- Remove when done ----
5530: # The following styles is part of the redesign of LON-CAPA and are
5531: # subject to change during this project.
5532: # Don't rely on their current functionality as they might be
5533: # changed or removed.
5534: # --------------------------*/
5535:
1.698 harmsja 5536: a:hover,
1.721 harmsja 5537: ol.LC_smallMenu a:hover,
5538: ol#LC_MenuBreadcrumbs a:hover,
5539: ol#LC_PathBreadcrumbs a:hover,
5540: ul#LC_TabMainMenuContent a:hover,
5541: .LC_FormSectionClearButton input:hover
5542: ul.LC_TabContent li:hover a{
1.698 harmsja 5543: color:#BF2317;
5544: text-decoration:none;
1.693 droeschl 5545: }
5546:
5547: h1 {
1.721 harmsja 5548: padding:5px 10px 5px 20px;
1.693 droeschl 5549: line-height:130%;
5550: }
1.698 harmsja 5551:
1.693 droeschl 5552: h2,h3,h4,h5,h6
5553: {
1.721 harmsja 5554: margin:5px 0px 5px 0px;
5555: padding:0px;
5556: line-height:130%;
1.693 droeschl 5557: }
1.721 harmsja 5558: .LC_hcell{
1.698 harmsja 5559: padding:3px 15px 3px 15px;
5560: margin:0px;
1.703 harmsja 5561: background-color:$tabbg;
5562: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5563: }
1.721 harmsja 5564: .LC_noBorder {
1.698 harmsja 5565: border:0px;
5566: }
1.693 droeschl 5567:
1.722 harmsja 5568: .LC_bgLightGrey{
1.741 harmsja 5569: background:URL(/adm/lonIcons/lightGreyBG.png) repeat-x left bottom;
1.722 harmsja 5570: }
1.741 harmsja 5571:
1.693 droeschl 5572:
1.698 harmsja 5573: /* Main Header with discription of Person, Course, etc. */
1.721 harmsja 5574: .LC_HeadRight {
1.693 droeschl 5575: text-align: right;
5576: float: right;
5577: margin: 0px;
5578: padding: 0px;
1.698 harmsja 5579: right:0;
1.693 droeschl 5580: position:absolute;
1.698 harmsja 5581: overflow:hidden;
1.693 droeschl 5582: }
5583:
1.721 harmsja 5584: p, .LC_ContentBox {
1.698 harmsja 5585: padding: 10px;
5586:
5587: }
1.721 harmsja 5588: .LC_FormSectionClearButton input {
1.741 harmsja 5589: background-color:transparent;
1.698 harmsja 5590: border:0px;
5591: cursor:pointer;
5592: text-decoration:underline;
1.693 droeschl 5593: }
5594:
5595:
1.698 harmsja 5596: dl,ul,div,fieldset {
5597: margin: 10px 10px 10px 0px;
1.693 droeschl 5598: overflow:hidden;
5599: }
1.721 harmsja 5600: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698 harmsja 5601: margin: 0px;
1.693 droeschl 5602: }
5603:
1.721 harmsja 5604: ol.LC_smallMenu li {
1.693 droeschl 5605: display: inline;
5606: padding: 5px 5px 0px 10px;
5607: vertical-align: top;
5608: }
5609:
1.721 harmsja 5610: ol.LC_smallMenu li img {
1.693 droeschl 5611: vertical-align: bottom;
5612: }
5613:
1.721 harmsja 5614: ol.LC_smallMenu a {
1.693 droeschl 5615: font-size: 90%;
5616: color: RGB(80, 80, 80);
5617: text-decoration: none;
5618: }
1.744 ehlerst 5619: ol#LC_TabMainMenueContent, ul.LC_TabContent ,
1.741 harmsja 5620: ul.LC_TabContentBigger {
1.721 harmsja 5621: display:block;
5622: list-style:none;
1.741 harmsja 5623: margin: 0px;
1.693 droeschl 5624: padding: 0px;
5625: }
5626:
1.744 ehlerst 5627: ol#LC_TabMainMenuContent li, ul.LC_TabContent li,
1.741 harmsja 5628: ul.LC_TabContentBigger li{
1.693 droeschl 5629: display: inline;
1.741 harmsja 5630: border-right: solid 1px $lg_border_color;
5631: float:left;
5632: line-height:140%;
5633: white-space:nowrap;
5634: }
5635: ol#LC_TabMainMenuContent li{
1.693 droeschl 5636: vertical-align: bottom;
5637: border-bottom: solid 1px RGB(175, 175, 175);
1.721 harmsja 5638: padding: 5px 10px 5px 10px;
1.741 harmsja 5639: margin-right:5px;
5640: margin-bottom:3px;
1.693 droeschl 5641: font-weight: bold;
1.723 riegler 5642: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5643: }
5644:
1.721 harmsja 5645: ol#LC_TabMainMenuContent li a{
1.693 droeschl 5646: color: RGB(47, 47, 47);
5647: text-decoration: none;
5648: }
1.721 harmsja 5649: ul.LC_TabContent {
1.741 harmsja 5650: min-height:1.6em;
1.721 harmsja 5651: }
5652: ul.LC_TabContent li{
1.741 harmsja 5653: vertical-align:middle;
5654: padding:0px 10px 0px 10px;
1.745 ehlerst 5655: background-color:$tabbg;
5656: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5657: }
1.744 ehlerst 5658: ul.LC_TabContent li a, ul.LC_TabContent li{
1.721 harmsja 5659: color:rgb(47,47,47);
5660: text-decoration:none;
5661: font-size:95%;
5662: font-weight:bold;
5663: }
1.744 ehlerst 5664: ul.LC_TabContent li:hover, ul.LC_TabContent li.active{
5665: background-color:#FFFFFF;
1.745 ehlerst 5666: border-bottom:solid 1px #FFFFFF;
1.744 ehlerst 5667: }
1.741 harmsja 5668: ul.LC_TabContentBigger li{
5669: vertical-align:bottom;
5670: border-top:solid 1px $lg_border_color;
5671: border-left:solid 1px $lg_border_color;
5672: padding:5px 10px 5px 10px;
5673: margin-left:2px;
5674: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5675: }
1.744 ehlerst 5676: ul.LC_TabContentBigger li:hover, ul.LC_TabContentBigger li.active{
5677: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5678: }
1.741 harmsja 5679: ul.LC_TabContentBigger li, ul.LC_TabContentBigger li a{
5680: font-size:110%;
5681: font-weight:bold;
5682: }
5683: #LC_CourseDocuments, #LC_SupplementalCourseDocuments
5684: {
5685: margin:0px;
1.737 tempelho 5686: }
5687:
1.721 harmsja 5688: .LC_hideThis
5689: {
5690: display:none;
5691: visibility:hidden;
1.693 droeschl 5692: }
5693:
1.721 harmsja 5694: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs {
1.693 droeschl 5695: border-top: solid 1px RGB(255, 255, 255);
5696: height: 20px;
5697: line-height: 20px;
5698: vertical-align: bottom;
5699: margin: 0px 0px 30px 0px;
5700: padding-left: 10px;
5701: list-style-position: inside;
1.723 riegler 5702: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5703: }
5704:
1.721 harmsja 5705: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li {
1.741 harmsja 5706: /*
1.723 riegler 5707: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.741 harmsja 5708: */
1.693 droeschl 5709: display: inline;
5710: padding: 0px 0px 0px 10px;
5711: vertical-align: bottom;
5712: overflow:hidden;
5713: }
5714:
1.721 harmsja 5715: ol#LC_MenuBreadcrumbs li a {
1.693 droeschl 5716: text-decoration: none;
5717: font-size:90%;
5718: }
1.721 harmsja 5719: ol#LC_PathBreadcrumbs li a{
1.698 harmsja 5720: text-decoration:none;
5721: font-size:100%;
5722: font-weight:bold;
1.693 droeschl 5723: }
1.721 harmsja 5724: .LC_ContentBoxSpecial
1.693 droeschl 5725: {
1.701 harmsja 5726: border: solid 1px $lg_border_color;
1.746 neumanie 5727: }
5728: .LC_ContentBoxSpecialContactInfo
5729: {
5730: border: solid 1px $lg_border_color;
5731: max-width:25%;
5732: min-width:25%;
1.698 harmsja 5733: }
1.747 neumanie 5734: .LC_AboutMe_Image
5735: {
5736: float:left;
5737: margin-right:10px;
5738: }
5739: .LC_Clear_AboutMe_Image
5740: {
5741: clear:left;
5742: }
1.721 harmsja 5743: dl.LC_ListStyleClean dt {
1.693 droeschl 5744: padding-right: 5px;
5745: display: table-header-group;
5746: }
5747:
1.721 harmsja 5748: dl.LC_ListStyleClean dd {
1.693 droeschl 5749: display: table-row;
5750: }
5751:
1.721 harmsja 5752: .LC_ListStyleClean,
5753: .LC_ListStyleSimple,
5754: .LC_ListStyleNormal,
5755: .LC_ListStyleNormal_Border,
5756: .LC_ListStyleSpecial
1.693 droeschl 5757: {
5758: /*display:block; */
5759: list-style-position: inside;
5760: list-style-type: none;
5761: overflow: hidden;
5762: padding: 0px;
5763: }
5764:
1.721 harmsja 5765: .LC_ListStyleSimple li,
5766: .LC_ListStyleSimple dd,
5767: .LC_ListStyleNormal li,
5768: .LC_ListStyleNormal dd,
5769: .LC_ListStyleSpecial li,
5770: .LC_ListStyleSpecial dd
1.693 droeschl 5771: {
5772: margin: 0px;
5773: padding: 5px 5px 5px 10px;
5774: clear: both;
5775: }
5776:
1.721 harmsja 5777: .LC_ListStyleClean li,
5778: .LC_ListStyleClean dd {
1.693 droeschl 5779: padding-top: 0px;
5780: padding-bottom: 0px;
5781: }
5782:
1.721 harmsja 5783: .LC_ListStyleSimple dd,
5784: .LC_ListStyleSimple li{
1.698 harmsja 5785: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5786: }
5787:
1.721 harmsja 5788: .LC_ListStyleSpecial li,
5789: .LC_ListStyleSpecial dd {
1.693 droeschl 5790: list-style-type: none;
5791: background-color: RGB(220, 220, 220);
5792: margin-bottom: 4px;
5793: }
5794:
1.721 harmsja 5795: table.LC_SimpleTable {
1.698 harmsja 5796: margin:5px;
5797: border:solid 1px $lg_border_color;
1.693 droeschl 5798: }
5799:
1.721 harmsja 5800: table.LC_SimpleTable tr {
1.698 harmsja 5801: padding:0px;
5802: border:solid 1px $lg_border_color;
1.693 droeschl 5803: }
1.721 harmsja 5804: table.LC_SimpleTable thead{
1.698 harmsja 5805: background:rgb(220,220,220);
1.693 droeschl 5806: }
5807:
1.721 harmsja 5808: div.LC_columnSection {
1.693 droeschl 5809: display: block;
5810: clear: both;
5811: overflow: hidden;
5812: margin:0px;
5813: }
5814:
1.721 harmsja 5815: div.LC_columnSection>* {
1.693 droeschl 5816: float: left;
5817: margin: 10px 20px 10px 0px;
1.747 neumanie 5818: overflow:hidden;
1.693 droeschl 5819: }
1.721 harmsja 5820:
1.719 ehlerst 5821: .ContentBoxSpecialTemplate
5822: {
1.747 neumanie 5823: border: solid 1px $lg_border_color;
1.719 ehlerst 5824: }
5825: .ContentBoxTemplate {
5826: padding:10px;
5827: }
5828:
1.721 harmsja 5829: div.LC_columnSection > .ContentBoxTemplate,
5830: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719 ehlerst 5831: {
5832: width: 600px;
5833: }
1.753 droeschl 5834:
1.720 ehlerst 5835: .clear{
5836: clear: both;
5837: line-height: 0px;
5838: font-size: 0px;
5839: height: 0px;
5840: }
1.693 droeschl 5841:
1.694 tempelho 5842: .LC_loginpage_container {
5843: text-align:left;
5844: margin : 0 auto;
5845: width:65%;
5846: padding: 10px;
5847: height: auto;
1.712 muellerd 5848: background-color:#FFFFFF;
1.694 tempelho 5849: border:1px solid #CCCCCC;
5850: }
5851:
5852:
5853: .LC_loginpage_loginContainer {
5854: float:left;
1.712 muellerd 5855: width: 182px;
5856: border:1px solid #CCCCCC;
5857: background-color:$loginbg;
1.694 tempelho 5858: }
5859:
1.717 tempelho 5860: .LC_loginpage_loginContainer h2{
1.712 muellerd 5861: margin-top:0;
5862: display:block;
5863: background:$bgcol;
5864: color:$textcol;
5865: padding-left:5px;
5866: }
1.694 tempelho 5867: .LC_loginpage_loginInfo {
5868: margin-left:20px;
5869: float:left;
5870: width:30%;
5871: border:1px solid #CCCCCC;
5872: padding:10px;
5873: }
5874:
1.712 muellerd 5875: .LC_loginpage_loginDomain {
5876: margin-right:20px;
5877: width:20%;
5878: float:left;
5879: padding:10px;
5880: }
5881:
1.694 tempelho 5882: .LC_loginpage_space {
1.754 droeschl 5883: clear: both;
5884: margin-bottom: 20px;
1.694 tempelho 5885: border-bottom: 1px solid #CCCCCC;
5886: }
5887:
1.748 schulted 5888: table em{
1.754 droeschl 5889: font-weight: bold;
5890: font-style: normal;
1.748 schulted 5891: }
5892:
1.753 droeschl 5893: table#LC_tableOfContent{
5894: border-collapse: collapse;
1.754 droeschl 5895: border-spacing: 0;
5896: padding: 3px;
5897: border: 0;
5898: background-color: #FFFFFF;
5899: font-size: 90%;
1.753 droeschl 5900: }
5901: table#LC_tableOfContent a {
5902: text-decoration: none;
5903: }
5904:
5905: table#LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 5906: background-color: #EEEEEE;
1.753 droeschl 5907: }
5908:
5909: table#LC_tableOfContent img{
5910: border: none;
5911: height: 1.3em;
5912: vertical-align: text-bottom;
5913: margin-right: 0.3em;
5914: }
1.757 ! schulted 5915:
! 5916: a#LC_content_toolbar_firsthomework{
! 5917: background-image:url(/res/adm/pages/open-first-problem.gif);
! 5918: }
! 5919:
! 5920: a#LC_content_toolbar_launchnav{
! 5921: background-image:url(/res/adm/pages/start-navigation.gif);
! 5922: }
! 5923:
! 5924: a#LC_content_toolbar_closenav{
! 5925: background-image:url(/res/adm/pages/close-navigation.gif);
! 5926: }
! 5927:
! 5928: a#LC_content_toolbar_everything{
! 5929: background-image:url(/res/adm/pages/show-all.gif);
! 5930: }
! 5931:
! 5932: a#LC_content_toolbar_uncompleted{
! 5933: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
! 5934: }
! 5935:
! 5936: #LC_content_toolbar_clearbubbles{
! 5937: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
! 5938: }
! 5939:
! 5940: a#LC_content_toolbar_changefolder{
! 5941: background : url(/res/adm/pages/close-all-folders.gif) top center ;
! 5942: }
! 5943:
! 5944: a#LC_content_toolbar_changefolder_toggled{
! 5945: background-image:url(/res/adm/pages/open-all-folders.gif);
! 5946: }
! 5947:
! 5948: ul#LC_toolbar li a:hover{
! 5949: background-position: bottom center;
! 5950: }
! 5951:
! 5952: ul#LC_toolbar{
! 5953: padding:0;
! 5954: margin: 2px;
! 5955: list-style:none;
! 5956: position:relative;
! 5957: background-color:white;
! 5958: }
! 5959:
! 5960: ul#LC_toolbar li{
! 5961: border:1px solid white;
! 5962: padding:0;
! 5963: margin: 0;
! 5964: display:inline-block;
! 5965: vertical-align:middle;
! 5966: }
! 5967:
! 5968: a.LC_toolbarItem{
! 5969: display:inline-block;
! 5970: padding:0;
! 5971: margin:0;
! 5972: height: 32px;
! 5973: width: 32px;
! 5974: color:white;
! 5975: border:0 none;
! 5976: background-repeat:no-repeat;
! 5977: background-color:transparent;
! 5978: }
! 5979:
! 5980:
1.343 albertel 5981: END
5982: }
5983:
1.306 albertel 5984: =pod
5985:
5986: =item * &headtag()
5987:
5988: Returns a uniform footer for LON-CAPA web pages.
5989:
1.307 albertel 5990: Inputs: $title - optional title for the head
5991: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5992: $args - optional arguments
1.319 albertel 5993: force_register - if is true call registerurl so the remote is
5994: informed
1.415 albertel 5995: redirect -> array ref of
5996: 1- seconds before redirect occurs
5997: 2- url to redirect to
5998: 3- whether the side effect should occur
1.315 albertel 5999: (side effect of setting
6000: $env{'internal.head.redirect'} to the url
6001: redirected too)
1.352 albertel 6002: domain -> force to color decorate a page for a specific
6003: domain
6004: function -> force usage of a specific rolish color scheme
6005: bgcolor -> override the default page bgcolor
1.460 albertel 6006: no_auto_mt_title
6007: -> prevent &mt()ing the title arg
1.464 albertel 6008:
1.306 albertel 6009: =cut
6010:
6011: sub headtag {
1.313 albertel 6012: my ($title,$head_extra,$args) = @_;
1.306 albertel 6013:
1.363 albertel 6014: my $function = $args->{'function'} || &get_users_function();
6015: my $domain = $args->{'domain'} || &determinedomain();
6016: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6017: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6018: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6019: #time(),
1.418 albertel 6020: $env{'environment.color.timestamp'},
1.363 albertel 6021: $function,$domain,$bgcolor);
6022:
1.369 www 6023: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6024:
1.308 albertel 6025: my $result =
6026: '<head>'.
1.461 albertel 6027: &font_settings();
1.319 albertel 6028:
1.461 albertel 6029: if (!$args->{'frameset'}) {
6030: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6031: }
1.319 albertel 6032: if ($args->{'force_register'}) {
6033: $result .= &Apache::lonmenu::registerurl(1);
6034: }
1.436 albertel 6035: if (!$args->{'no_nav_bar'}
6036: && !$args->{'only_body'}
6037: && !$args->{'frameset'}) {
6038: $result .= &help_menu_js();
6039: }
1.319 albertel 6040:
1.314 albertel 6041: if (ref($args->{'redirect'})) {
1.414 albertel 6042: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6043: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6044: if (!$inhibit_continue) {
6045: $env{'internal.head.redirect'} = $url;
6046: }
1.313 albertel 6047: $result.=<<ADDMETA
6048: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6049: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6050: ADDMETA
6051: }
1.306 albertel 6052: if (!defined($title)) {
6053: $title = 'The LearningOnline Network with CAPA';
6054: }
1.460 albertel 6055: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6056: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6057: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6058: .$head_extra;
1.306 albertel 6059: return $result;
6060: }
6061:
6062: =pod
6063:
1.340 albertel 6064: =item * &font_settings()
6065:
6066: Returns neccessary <meta> to set the proper encoding
6067:
6068: Inputs: none
6069:
6070: =cut
6071:
6072: sub font_settings {
6073: my $headerstring='';
1.647 www 6074: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6075: $headerstring.=
6076: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6077: }
6078: return $headerstring;
6079: }
6080:
1.341 albertel 6081: =pod
6082:
6083: =item * &xml_begin()
6084:
6085: Returns the needed doctype and <html>
6086:
6087: Inputs: none
6088:
6089: =cut
6090:
6091: sub xml_begin {
6092: my $output='';
6093:
1.592 albertel 6094: if ($env{'internal.start_page'}==1) {
6095: &Apache::lonhtmlcommon::init_htmlareafields();
6096: }
1.342 albertel 6097:
1.341 albertel 6098: if ($env{'browser.mathml'}) {
6099: $output='<?xml version="1.0"?>'
6100: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6101: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6102:
6103: # .'<!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">] >'
6104: .'<!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">'
6105: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6106: .'xmlns="http://www.w3.org/1999/xhtml">';
6107: } else {
6108: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6109: }
6110: return $output;
6111: }
1.340 albertel 6112:
6113: =pod
6114:
1.306 albertel 6115: =item * &endheadtag()
6116:
6117: Returns a uniform </head> for LON-CAPA web pages.
6118:
6119: Inputs: none
6120:
6121: =cut
6122:
6123: sub endheadtag {
6124: return '</head>';
6125: }
6126:
6127: =pod
6128:
6129: =item * &head()
6130:
6131: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6132:
1.648 raeburn 6133: Inputs:
6134:
6135: =over 4
6136:
6137: $title - optional title for the page
6138:
6139: $head_extra - optional extra HTML to put inside the <head>
6140:
6141: =back
1.405 albertel 6142:
1.306 albertel 6143: =cut
6144:
6145: sub head {
1.325 albertel 6146: my ($title,$head_extra,$args) = @_;
6147: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6148: }
6149:
6150: =pod
6151:
6152: =item * &start_page()
6153:
6154: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6155:
1.648 raeburn 6156: Inputs:
6157:
6158: =over 4
6159:
6160: $title - optional title for the page
6161:
6162: $head_extra - optional extra HTML to incude inside the <head>
6163:
6164: $args - additional optional args supported are:
6165:
6166: =over 8
6167:
6168: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6169: arg on
1.648 raeburn 6170: no_nav_bar -> is true will set &bodytag() notopbar arg on
6171: add_entries -> additional attributes to add to the <body>
6172: domain -> force to color decorate a page for a
1.317 albertel 6173: specific domain
1.648 raeburn 6174: function -> force usage of a specific rolish color
1.317 albertel 6175: scheme
1.648 raeburn 6176: redirect -> see &headtag()
6177: bgcolor -> override the default page bg color
6178: js_ready -> return a string ready for being used in
1.317 albertel 6179: a javascript writeln
1.648 raeburn 6180: html_encode -> return a string ready for being used in
1.320 albertel 6181: a html attribute
1.648 raeburn 6182: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6183: $forcereg arg
1.648 raeburn 6184: body_title -> alternate text to use instead of $title
1.326 albertel 6185: in the title box that appears, this text
6186: is not auto translated like the $title is
1.648 raeburn 6187: frameset -> if true will start with a <frameset>
1.330 albertel 6188: rather than <body>
1.648 raeburn 6189: no_title -> if true the title bar won't be shown
6190: skip_phases -> hash ref of
1.338 albertel 6191: head -> skip the <html><head> generation
6192: body -> skip all <body> generation
1.648 raeburn 6193: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6194: 'Switch To Inline Menu' link
1.648 raeburn 6195: no_auto_mt_title -> prevent &mt()ing the title arg
6196: inherit_jsmath -> when creating popup window in a page,
6197: should it have jsmath forced on by the
6198: current page
1.361 albertel 6199:
1.648 raeburn 6200: =back
1.460 albertel 6201:
1.648 raeburn 6202: =back
1.562 albertel 6203:
1.306 albertel 6204: =cut
6205:
6206: sub start_page {
1.309 albertel 6207: my ($title,$head_extra,$args) = @_;
1.318 albertel 6208: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6209: my %head_args;
1.352 albertel 6210: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6211: 'bgcolor','frameset','no_nav_bar','only_body',
6212: 'no_auto_mt_title') {
1.319 albertel 6213: if (defined($args->{$arg})) {
1.324 raeburn 6214: $head_args{$arg} = $args->{$arg};
1.319 albertel 6215: }
1.313 albertel 6216: }
1.319 albertel 6217:
1.315 albertel 6218: $env{'internal.start_page'}++;
1.338 albertel 6219: my $result;
6220: if (! exists($args->{'skip_phases'}{'head'}) ) {
6221: $result.=
1.341 albertel 6222: &xml_begin().
1.338 albertel 6223: &headtag($title,$head_extra,\%head_args).&endheadtag();
6224: }
6225:
6226: if (! exists($args->{'skip_phases'}{'body'}) ) {
6227: if ($args->{'frameset'}) {
6228: my $attr_string = &make_attr_string($args->{'force_register'},
6229: $args->{'add_entries'});
6230: $result .= "\n<frameset $attr_string>\n";
6231: } else {
6232: $result .=
6233: &bodytag($title,
6234: $args->{'function'}, $args->{'add_entries'},
6235: $args->{'only_body'}, $args->{'domain'},
6236: $args->{'force_register'}, $args->{'body_title'},
6237: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6238: $args->{'no_title'}, $args->{'no_inline_link'},
6239: $args);
1.338 albertel 6240: }
1.330 albertel 6241: }
1.338 albertel 6242:
1.315 albertel 6243: if ($args->{'js_ready'}) {
1.713 kaisler 6244: $result = &js_ready($result);
1.315 albertel 6245: }
1.320 albertel 6246: if ($args->{'html_encode'}) {
1.713 kaisler 6247: $result = &html_encode($result);
6248: }
6249:
1.718 raeburn 6250: if (exists($args->{'bread_crumbs'})) {
6251: &Apache::lonhtmlcommon::clear_breadcrumbs();
6252: if (ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6253: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6254: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6255: }
6256: }
6257: $result .= &Apache::lonhtmlcommon::breadcrumbs();
1.320 albertel 6258: }
1.713 kaisler 6259:
1.315 albertel 6260: return $result;
1.306 albertel 6261: }
6262:
1.330 albertel 6263:
1.306 albertel 6264: =pod
6265:
6266: =item * &head()
6267:
6268: Returns a complete </body></html> section for LON-CAPA web pages.
6269:
1.315 albertel 6270: Inputs: $args - additional optional args supported are:
6271: js_ready -> return a string ready for being used in
6272: a javascript writeln
1.320 albertel 6273: html_encode -> return a string ready for being used in
6274: a html attribute
1.330 albertel 6275: frameset -> if true will start with a <frameset>
6276: rather than <body>
1.493 albertel 6277: dicsussion -> if true will get discussion from
6278: lonxml::xmlend
6279: (you can pass the target and parser arguments
6280: through optional 'target' and 'parser' args
6281: to this routine)
1.306 albertel 6282:
6283: =cut
6284:
6285: sub end_page {
1.315 albertel 6286: my ($args) = @_;
6287: $env{'internal.end_page'}++;
1.330 albertel 6288: my $result;
1.335 albertel 6289: if ($args->{'discussion'}) {
6290: my ($target,$parser);
6291: if (ref($args->{'discussion'})) {
6292: ($target,$parser) =($args->{'discussion'}{'target'},
6293: $args->{'discussion'}{'parser'});
6294: }
6295: $result .= &Apache::lonxml::xmlend($target,$parser);
6296: }
6297:
1.330 albertel 6298: if ($args->{'frameset'}) {
6299: $result .= '</frameset>';
6300: } else {
1.635 raeburn 6301: $result .= &endbodytag($args);
1.330 albertel 6302: }
6303: $result .= "\n</html>";
6304:
1.315 albertel 6305: if ($args->{'js_ready'}) {
1.317 albertel 6306: $result = &js_ready($result);
1.315 albertel 6307: }
1.335 albertel 6308:
1.320 albertel 6309: if ($args->{'html_encode'}) {
6310: $result = &html_encode($result);
6311: }
1.335 albertel 6312:
1.315 albertel 6313: return $result;
6314: }
6315:
1.320 albertel 6316: sub html_encode {
6317: my ($result) = @_;
6318:
1.322 albertel 6319: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6320:
6321: return $result;
6322: }
1.317 albertel 6323: sub js_ready {
6324: my ($result) = @_;
6325:
1.323 albertel 6326: $result =~ s/[\n\r]/ /xmsg;
6327: $result =~ s/\\/\\\\/xmsg;
6328: $result =~ s/'/\\'/xmsg;
1.372 albertel 6329: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6330:
6331: return $result;
6332: }
6333:
1.315 albertel 6334: sub validate_page {
6335: if ( exists($env{'internal.start_page'})
1.316 albertel 6336: && $env{'internal.start_page'} > 1) {
6337: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6338: $env{'internal.start_page'}.' '.
1.316 albertel 6339: $ENV{'request.filename'});
1.315 albertel 6340: }
6341: if ( exists($env{'internal.end_page'})
1.316 albertel 6342: && $env{'internal.end_page'} > 1) {
6343: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6344: $env{'internal.end_page'}.' '.
1.316 albertel 6345: $env{'request.filename'});
1.315 albertel 6346: }
6347: if ( exists($env{'internal.start_page'})
6348: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6349: &Apache::lonnet::logthis('start_page called without end_page '.
6350: $env{'request.filename'});
1.315 albertel 6351: }
6352: if ( ! exists($env{'internal.start_page'})
6353: && exists($env{'internal.end_page'})) {
1.316 albertel 6354: &Apache::lonnet::logthis('end_page called without start_page'.
6355: $env{'request.filename'});
1.315 albertel 6356: }
1.306 albertel 6357: }
1.315 albertel 6358:
1.318 albertel 6359: sub simple_error_page {
6360: my ($r,$title,$msg) = @_;
6361: my $page =
6362: &Apache::loncommon::start_page($title).
6363: &mt($msg).
6364: &Apache::loncommon::end_page();
6365: if (ref($r)) {
6366: $r->print($page);
1.327 albertel 6367: return;
1.318 albertel 6368: }
6369: return $page;
6370: }
1.347 albertel 6371:
6372: {
1.610 albertel 6373: my @row_count;
1.347 albertel 6374: sub start_data_table {
1.422 albertel 6375: my ($add_class) = @_;
6376: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6377: unshift(@row_count,0);
1.422 albertel 6378: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6379: }
6380:
6381: sub end_data_table {
1.610 albertel 6382: shift(@row_count);
1.389 albertel 6383: return '</table>'."\n";;
1.347 albertel 6384: }
6385:
6386: sub start_data_table_row {
1.422 albertel 6387: my ($add_class) = @_;
1.610 albertel 6388: $row_count[0]++;
6389: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6390: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6391: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6392: }
1.471 banghart 6393:
6394: sub continue_data_table_row {
6395: my ($add_class) = @_;
1.610 albertel 6396: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6397: $css_class = (join(' ',$css_class,$add_class));
6398: return '<tr class="'.$css_class.'">'."\n";;
6399: }
1.347 albertel 6400:
6401: sub end_data_table_row {
1.389 albertel 6402: return '</tr>'."\n";;
1.347 albertel 6403: }
1.367 www 6404:
1.421 albertel 6405: sub start_data_table_empty_row {
1.707 bisitz 6406: # $row_count[0]++;
1.421 albertel 6407: return '<tr class="LC_empty_row" >'."\n";;
6408: }
6409:
6410: sub end_data_table_empty_row {
6411: return '</tr>'."\n";;
6412: }
6413:
1.367 www 6414: sub start_data_table_header_row {
1.389 albertel 6415: return '<tr class="LC_header_row">'."\n";;
1.367 www 6416: }
6417:
6418: sub end_data_table_header_row {
1.389 albertel 6419: return '</tr>'."\n";;
1.367 www 6420: }
1.347 albertel 6421: }
6422:
1.548 albertel 6423: =pod
6424:
6425: =item * &inhibit_menu_check($arg)
6426:
6427: Checks for a inhibitmenu state and generates output to preserve it
6428:
6429: Inputs: $arg - can be any of
6430: - undef - in which case the return value is a string
6431: to add into arguments list of a uri
6432: - 'input' - in which case the return value is a HTML
6433: <form> <input> field of type hidden to
6434: preserve the value
6435: - a url - in which case the return value is the url with
6436: the neccesary cgi args added to preserve the
6437: inhibitmenu state
6438: - a ref to a url - no return value, but the string is
6439: updated to include the neccessary cgi
6440: args to preserve the inhibitmenu state
6441:
6442: =cut
6443:
6444: sub inhibit_menu_check {
6445: my ($arg) = @_;
6446: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6447: if ($arg eq 'input') {
6448: if ($env{'form.inhibitmenu'}) {
6449: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6450: } else {
6451: return
6452: }
6453: }
6454: if ($env{'form.inhibitmenu'}) {
6455: if (ref($arg)) {
6456: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6457: } elsif ($arg eq '') {
6458: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6459: } else {
6460: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6461: }
6462: }
6463: if (!ref($arg)) {
6464: return $arg;
6465: }
6466: }
6467:
1.251 albertel 6468: ###############################################
1.182 matthew 6469:
6470: =pod
6471:
1.549 albertel 6472: =back
6473:
6474: =head1 User Information Routines
6475:
6476: =over 4
6477:
1.405 albertel 6478: =item * &get_users_function()
1.182 matthew 6479:
6480: Used by &bodytag to determine the current users primary role.
6481: Returns either 'student','coordinator','admin', or 'author'.
6482:
6483: =cut
6484:
6485: ###############################################
6486: sub get_users_function {
6487: my $function = 'student';
1.258 albertel 6488: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6489: $function='coordinator';
6490: }
1.258 albertel 6491: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6492: $function='admin';
6493: }
1.258 albertel 6494: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6495: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6496: $function='author';
6497: }
6498: return $function;
1.54 www 6499: }
1.99 www 6500:
6501: ###############################################
6502:
1.233 raeburn 6503: =pod
6504:
1.542 raeburn 6505: =item * &check_user_status()
1.274 raeburn 6506:
6507: Determines current status of supplied role for a
6508: specific user. Roles can be active, previous or future.
6509:
6510: Inputs:
6511: user's domain, user's username, course's domain,
1.375 raeburn 6512: course's number, optional section ID.
1.274 raeburn 6513:
6514: Outputs:
6515: role status: active, previous or future.
6516:
6517: =cut
6518:
6519: sub check_user_status {
1.412 raeburn 6520: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6521: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6522: my @uroles = keys %userinfo;
6523: my $srchstr;
6524: my $active_chk = 'none';
1.412 raeburn 6525: my $now = time;
1.274 raeburn 6526: if (@uroles > 0) {
1.412 raeburn 6527: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6528: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6529: } else {
1.412 raeburn 6530: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6531: }
6532: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6533: my $role_end = 0;
6534: my $role_start = 0;
6535: $active_chk = 'active';
1.412 raeburn 6536: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6537: $role_end = $1;
6538: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6539: $role_start = $1;
1.274 raeburn 6540: }
6541: }
6542: if ($role_start > 0) {
1.412 raeburn 6543: if ($now < $role_start) {
1.274 raeburn 6544: $active_chk = 'future';
6545: }
6546: }
6547: if ($role_end > 0) {
1.412 raeburn 6548: if ($now > $role_end) {
1.274 raeburn 6549: $active_chk = 'previous';
6550: }
6551: }
6552: }
6553: }
6554: return $active_chk;
6555: }
6556:
6557: ###############################################
6558:
6559: =pod
6560:
1.405 albertel 6561: =item * &get_sections()
1.233 raeburn 6562:
6563: Determines all the sections for a course including
6564: sections with students and sections containing other roles.
1.419 raeburn 6565: Incoming parameters:
6566:
6567: 1. domain
6568: 2. course number
6569: 3. reference to array containing roles for which sections should
6570: be gathered (optional).
6571: 4. reference to array containing status types for which sections
6572: should be gathered (optional).
6573:
6574: If the third argument is undefined, sections are gathered for any role.
6575: If the fourth argument is undefined, sections are gathered for any status.
6576: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6577:
1.374 raeburn 6578: Returns section hash (keys are section IDs, values are
6579: number of users in each section), subject to the
1.419 raeburn 6580: optional roles filter, optional status filter
1.233 raeburn 6581:
6582: =cut
6583:
6584: ###############################################
6585: sub get_sections {
1.419 raeburn 6586: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6587: if (!defined($cdom) || !defined($cnum)) {
6588: my $cid = $env{'request.course.id'};
6589:
6590: return if (!defined($cid));
6591:
6592: $cdom = $env{'course.'.$cid.'.domain'};
6593: $cnum = $env{'course.'.$cid.'.num'};
6594: }
6595:
6596: my %sectioncount;
1.419 raeburn 6597: my $now = time;
1.240 albertel 6598:
1.366 albertel 6599: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6600: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6601: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6602: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6603: my $start_index = &Apache::loncoursedata::CL_START();
6604: my $end_index = &Apache::loncoursedata::CL_END();
6605: my $status;
1.366 albertel 6606: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6607: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6608: $data->[$status_index],
6609: $data->[$start_index],
6610: $data->[$end_index]);
6611: if ($stu_status eq 'Active') {
6612: $status = 'active';
6613: } elsif ($end < $now) {
6614: $status = 'previous';
6615: } elsif ($start > $now) {
6616: $status = 'future';
6617: }
6618: if ($section ne '-1' && $section !~ /^\s*$/) {
6619: if ((!defined($possible_status)) || (($status ne '') &&
6620: (grep/^\Q$status\E$/,@{$possible_status}))) {
6621: $sectioncount{$section}++;
6622: }
1.240 albertel 6623: }
6624: }
6625: }
6626: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6627: foreach my $user (sort(keys(%courseroles))) {
6628: if ($user !~ /^(\w{2})/) { next; }
6629: my ($role) = ($user =~ /^(\w{2})/);
6630: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6631: my ($section,$status);
1.240 albertel 6632: if ($role eq 'cr' &&
6633: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6634: $section=$1;
6635: }
6636: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6637: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6638: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6639: if ($end == -1 && $start == -1) {
6640: next; #deleted role
6641: }
6642: if (!defined($possible_status)) {
6643: $sectioncount{$section}++;
6644: } else {
6645: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6646: $status = 'active';
6647: } elsif ($end < $now) {
6648: $status = 'future';
6649: } elsif ($start > $now) {
6650: $status = 'previous';
6651: }
6652: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6653: $sectioncount{$section}++;
6654: }
6655: }
1.233 raeburn 6656: }
1.366 albertel 6657: return %sectioncount;
1.233 raeburn 6658: }
6659:
1.274 raeburn 6660: ###############################################
1.294 raeburn 6661:
6662: =pod
1.405 albertel 6663:
6664: =item * &get_course_users()
6665:
1.275 raeburn 6666: Retrieves usernames:domains for users in the specified course
6667: with specific role(s), and access status.
6668:
6669: Incoming parameters:
1.277 albertel 6670: 1. course domain
6671: 2. course number
6672: 3. access status: users must have - either active,
1.275 raeburn 6673: previous, future, or all.
1.277 albertel 6674: 4. reference to array of permissible roles
1.288 raeburn 6675: 5. reference to array of section restrictions (optional)
6676: 6. reference to results object (hash of hashes).
6677: 7. reference to optional userdata hash
1.609 raeburn 6678: 8. reference to optional statushash
1.630 raeburn 6679: 9. flag if privileged users (except those set to unhide in
6680: course settings) should be excluded
1.609 raeburn 6681: Keys of top level results hash are roles.
1.275 raeburn 6682: Keys of inner hashes are username:domain, with
6683: values set to access type.
1.288 raeburn 6684: Optional userdata hash returns an array with arguments in the
6685: same order as loncoursedata::get_classlist() for student data.
6686:
1.609 raeburn 6687: Optional statushash returns
6688:
1.288 raeburn 6689: Entries for end, start, section and status are blank because
6690: of the possibility of multiple values for non-student roles.
6691:
1.275 raeburn 6692: =cut
1.405 albertel 6693:
1.275 raeburn 6694: ###############################################
1.405 albertel 6695:
1.275 raeburn 6696: sub get_course_users {
1.630 raeburn 6697: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6698: my %idx = ();
1.419 raeburn 6699: my %seclists;
1.288 raeburn 6700:
6701: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6702: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6703: $idx{end} = &Apache::loncoursedata::CL_END();
6704: $idx{start} = &Apache::loncoursedata::CL_START();
6705: $idx{id} = &Apache::loncoursedata::CL_ID();
6706: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6707: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6708: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6709:
1.290 albertel 6710: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6711: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6712: my $now = time;
1.277 albertel 6713: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6714: my $match = 0;
1.412 raeburn 6715: my $secmatch = 0;
1.419 raeburn 6716: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6717: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6718: if ($section eq '') {
6719: $section = 'none';
6720: }
1.291 albertel 6721: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6722: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6723: $secmatch = 1;
6724: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6725: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6726: $secmatch = 1;
6727: }
6728: } else {
1.419 raeburn 6729: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6730: $secmatch = 1;
6731: }
1.290 albertel 6732: }
1.412 raeburn 6733: if (!$secmatch) {
6734: next;
6735: }
1.419 raeburn 6736: }
1.275 raeburn 6737: if (defined($$types{'active'})) {
1.288 raeburn 6738: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6739: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6740: $match = 1;
1.275 raeburn 6741: }
6742: }
6743: if (defined($$types{'previous'})) {
1.609 raeburn 6744: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6745: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6746: $match = 1;
1.275 raeburn 6747: }
6748: }
6749: if (defined($$types{'future'})) {
1.609 raeburn 6750: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6751: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6752: $match = 1;
1.275 raeburn 6753: }
6754: }
1.609 raeburn 6755: if ($match) {
6756: push(@{$seclists{$student}},$section);
6757: if (ref($userdata) eq 'HASH') {
6758: $$userdata{$student} = $$classlist{$student};
6759: }
6760: if (ref($statushash) eq 'HASH') {
6761: $statushash->{$student}{'st'}{$section} = $status;
6762: }
1.288 raeburn 6763: }
1.275 raeburn 6764: }
6765: }
1.412 raeburn 6766: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6767: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6768: my $now = time;
1.609 raeburn 6769: my %displaystatus = ( previous => 'Expired',
6770: active => 'Active',
6771: future => 'Future',
6772: );
1.630 raeburn 6773: my %nothide;
6774: if ($hidepriv) {
6775: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6776: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6777: if ($user !~ /:/) {
6778: $nothide{join(':',split(/[\@]/,$user))}=1;
6779: } else {
6780: $nothide{$user} = 1;
6781: }
6782: }
6783: }
1.439 raeburn 6784: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6785: my $match = 0;
1.412 raeburn 6786: my $secmatch = 0;
1.439 raeburn 6787: my $status;
1.412 raeburn 6788: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6789: $user =~ s/:$//;
1.439 raeburn 6790: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6791: if ($end == -1 || $start == -1) {
6792: next;
6793: }
6794: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6795: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6796: my ($uname,$udom) = split(/:/,$user);
6797: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6798: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6799: $secmatch = 1;
6800: } elsif ($usec eq '') {
1.420 albertel 6801: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6802: $secmatch = 1;
6803: }
6804: } else {
6805: if (grep(/^\Q$usec\E$/,@{$sections})) {
6806: $secmatch = 1;
6807: }
6808: }
6809: if (!$secmatch) {
6810: next;
6811: }
1.288 raeburn 6812: }
1.419 raeburn 6813: if ($usec eq '') {
6814: $usec = 'none';
6815: }
1.275 raeburn 6816: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6817: if ($hidepriv) {
6818: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6819: (!$nothide{$uname.':'.$udom})) {
6820: next;
6821: }
6822: }
1.503 raeburn 6823: if ($end > 0 && $end < $now) {
1.439 raeburn 6824: $status = 'previous';
6825: } elsif ($start > $now) {
6826: $status = 'future';
6827: } else {
6828: $status = 'active';
6829: }
1.277 albertel 6830: foreach my $type (keys(%{$types})) {
1.275 raeburn 6831: if ($status eq $type) {
1.420 albertel 6832: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6833: push(@{$$users{$role}{$user}},$type);
6834: }
1.288 raeburn 6835: $match = 1;
6836: }
6837: }
1.419 raeburn 6838: if (($match) && (ref($userdata) eq 'HASH')) {
6839: if (!exists($$userdata{$uname.':'.$udom})) {
6840: &get_user_info($udom,$uname,\%idx,$userdata);
6841: }
1.420 albertel 6842: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6843: push(@{$seclists{$uname.':'.$udom}},$usec);
6844: }
1.609 raeburn 6845: if (ref($statushash) eq 'HASH') {
6846: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6847: }
1.275 raeburn 6848: }
6849: }
6850: }
6851: }
1.290 albertel 6852: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6853: if ((defined($cdom)) && (defined($cnum))) {
6854: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6855: if ( defined($csettings{'internal.courseowner'}) ) {
6856: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6857: next if ($owner eq '');
6858: my ($ownername,$ownerdom);
6859: if ($owner =~ /^([^:]+):([^:]+)$/) {
6860: $ownername = $1;
6861: $ownerdom = $2;
6862: } else {
6863: $ownername = $owner;
6864: $ownerdom = $cdom;
6865: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6866: }
6867: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6868: if (defined($userdata) &&
1.609 raeburn 6869: !exists($$userdata{$owner})) {
6870: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6871: if (!grep(/^none$/,@{$seclists{$owner}})) {
6872: push(@{$seclists{$owner}},'none');
6873: }
6874: if (ref($statushash) eq 'HASH') {
6875: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6876: }
1.290 albertel 6877: }
1.279 raeburn 6878: }
6879: }
6880: }
1.419 raeburn 6881: foreach my $user (keys(%seclists)) {
6882: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6883: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6884: }
1.275 raeburn 6885: }
6886: return;
6887: }
6888:
1.288 raeburn 6889: sub get_user_info {
6890: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6891: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6892: &plainname($uname,$udom,'lastname');
1.291 albertel 6893: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6894: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6895: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6896: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6897: return;
6898: }
1.275 raeburn 6899:
1.472 raeburn 6900: ###############################################
6901:
6902: =pod
6903:
6904: =item * &get_user_quota()
6905:
6906: Retrieves quota assigned for storage of portfolio files for a user
6907:
6908: Incoming parameters:
6909: 1. user's username
6910: 2. user's domain
6911:
6912: Returns:
1.536 raeburn 6913: 1. Disk quota (in Mb) assigned to student.
6914: 2. (Optional) Type of setting: custom or default
6915: (individually assigned or default for user's
6916: institutional status).
6917: 3. (Optional) - User's institutional status (e.g., faculty, staff
6918: or student - types as defined in localenroll::inst_usertypes
6919: for user's domain, which determines default quota for user.
6920: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6921:
6922: If a value has been stored in the user's environment,
1.536 raeburn 6923: it will return that, otherwise it returns the maximal default
6924: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6925:
6926: =cut
6927:
6928: ###############################################
6929:
6930:
6931: sub get_user_quota {
6932: my ($uname,$udom) = @_;
1.536 raeburn 6933: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6934: if (!defined($udom)) {
6935: $udom = $env{'user.domain'};
6936: }
6937: if (!defined($uname)) {
6938: $uname = $env{'user.name'};
6939: }
6940: if (($udom eq '' || $uname eq '') ||
6941: ($udom eq 'public') && ($uname eq 'public')) {
6942: $quota = 0;
1.536 raeburn 6943: $quotatype = 'default';
6944: $defquota = 0;
1.472 raeburn 6945: } else {
1.536 raeburn 6946: my $inststatus;
1.472 raeburn 6947: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6948: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6949: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6950: } else {
1.536 raeburn 6951: my %userenv =
6952: &Apache::lonnet::get('environment',['portfolioquota',
6953: 'inststatus'],$udom,$uname);
1.472 raeburn 6954: my ($tmp) = keys(%userenv);
6955: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6956: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6957: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6958: } else {
6959: undef(%userenv);
6960: }
6961: }
1.536 raeburn 6962: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6963: if ($quota eq '') {
1.536 raeburn 6964: $quota = $defquota;
6965: $quotatype = 'default';
6966: } else {
6967: $quotatype = 'custom';
1.472 raeburn 6968: }
6969: }
1.536 raeburn 6970: if (wantarray) {
6971: return ($quota,$quotatype,$settingstatus,$defquota);
6972: } else {
6973: return $quota;
6974: }
1.472 raeburn 6975: }
6976:
6977: ###############################################
6978:
6979: =pod
6980:
6981: =item * &default_quota()
6982:
1.536 raeburn 6983: Retrieves default quota assigned for storage of user portfolio files,
6984: given an (optional) user's institutional status.
1.472 raeburn 6985:
6986: Incoming parameters:
6987: 1. domain
1.536 raeburn 6988: 2. (Optional) institutional status(es). This is a : separated list of
6989: status types (e.g., faculty, staff, student etc.)
6990: which apply to the user for whom the default is being retrieved.
6991: If the institutional status string in undefined, the domain
6992: default quota will be returned.
1.472 raeburn 6993:
6994: Returns:
6995: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6996: 2. (Optional) institutional type which determined the value of the
6997: default quota.
1.472 raeburn 6998:
6999: If a value has been stored in the domain's configuration db,
7000: it will return that, otherwise it returns 20 (for backwards
7001: compatibility with domains which have not set up a configuration
7002: db file; the original statically defined portfolio quota was 20 Mb).
7003:
1.536 raeburn 7004: If the user's status includes multiple types (e.g., staff and student),
7005: the largest default quota which applies to the user determines the
7006: default quota returned.
7007:
1.472 raeburn 7008: =cut
7009:
7010: ###############################################
7011:
7012:
7013: sub default_quota {
1.536 raeburn 7014: my ($udom,$inststatus) = @_;
7015: my ($defquota,$settingstatus);
7016: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7017: ['quotas'],$udom);
7018: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7019: if ($inststatus ne '') {
7020: my @statuses = split(/:/,$inststatus);
7021: foreach my $item (@statuses) {
1.711 raeburn 7022: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7023: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7024: if ($defquota eq '') {
7025: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7026: $settingstatus = $item;
7027: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7028: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7029: $settingstatus = $item;
7030: }
7031: }
7032: } else {
7033: if ($quotahash{'quotas'}{$item} ne '') {
7034: if ($defquota eq '') {
7035: $defquota = $quotahash{'quotas'}{$item};
7036: $settingstatus = $item;
7037: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7038: $defquota = $quotahash{'quotas'}{$item};
7039: $settingstatus = $item;
7040: }
1.536 raeburn 7041: }
7042: }
7043: }
7044: }
7045: if ($defquota eq '') {
1.711 raeburn 7046: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7047: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7048: } else {
7049: $defquota = $quotahash{'quotas'}{'default'};
7050: }
1.536 raeburn 7051: $settingstatus = 'default';
7052: }
7053: } else {
7054: $settingstatus = 'default';
7055: $defquota = 20;
7056: }
7057: if (wantarray) {
7058: return ($defquota,$settingstatus);
1.472 raeburn 7059: } else {
1.536 raeburn 7060: return $defquota;
1.472 raeburn 7061: }
7062: }
7063:
1.384 raeburn 7064: sub get_secgrprole_info {
7065: my ($cdom,$cnum,$needroles,$type) = @_;
7066: my %sections_count = &get_sections($cdom,$cnum);
7067: my @sections = (sort {$a <=> $b} keys(%sections_count));
7068: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7069: my @groups = sort(keys(%curr_groups));
7070: my $allroles = [];
7071: my $rolehash;
7072: my $accesshash = {
7073: active => 'Currently has access',
7074: future => 'Will have future access',
7075: previous => 'Previously had access',
7076: };
7077: if ($needroles) {
7078: $rolehash = {'all' => 'all'};
1.385 albertel 7079: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7080: if (&Apache::lonnet::error(%user_roles)) {
7081: undef(%user_roles);
7082: }
7083: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7084: my ($role)=split(/\:/,$item,2);
7085: if ($role eq 'cr') { next; }
7086: if ($role =~ /^cr/) {
7087: $$rolehash{$role} = (split('/',$role))[3];
7088: } else {
7089: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7090: }
7091: }
7092: foreach my $key (sort(keys(%{$rolehash}))) {
7093: push(@{$allroles},$key);
7094: }
7095: push (@{$allroles},'st');
7096: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7097: }
7098: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7099: }
7100:
1.555 raeburn 7101: sub user_picker {
1.627 raeburn 7102: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7103: my $currdom = $dom;
7104: my %curr_selected = (
7105: srchin => 'dom',
1.580 raeburn 7106: srchby => 'lastname',
1.555 raeburn 7107: );
7108: my $srchterm;
1.625 raeburn 7109: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7110: if ($srch->{'srchby'} ne '') {
7111: $curr_selected{'srchby'} = $srch->{'srchby'};
7112: }
7113: if ($srch->{'srchin'} ne '') {
7114: $curr_selected{'srchin'} = $srch->{'srchin'};
7115: }
7116: if ($srch->{'srchtype'} ne '') {
7117: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7118: }
7119: if ($srch->{'srchdomain'} ne '') {
7120: $currdom = $srch->{'srchdomain'};
7121: }
7122: $srchterm = $srch->{'srchterm'};
7123: }
7124: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7125: 'usr' => 'Search criteria',
1.563 raeburn 7126: 'doma' => 'Domain/institution to search',
1.558 albertel 7127: 'uname' => 'username',
7128: 'lastname' => 'last name',
1.555 raeburn 7129: 'lastfirst' => 'last name, first name',
1.558 albertel 7130: 'crs' => 'in this course',
1.576 raeburn 7131: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7132: 'alc' => 'all LON-CAPA',
1.573 raeburn 7133: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7134: 'exact' => 'is',
7135: 'contains' => 'contains',
1.569 raeburn 7136: 'begins' => 'begins with',
1.571 raeburn 7137: 'youm' => "You must include some text to search for.",
7138: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7139: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7140: 'yomc' => "You must choose a domain when using an institutional directory search.",
7141: 'ymcd' => "You must choose a domain when using a domain search.",
7142: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7143: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7144: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7145: );
1.563 raeburn 7146: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7147: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7148:
7149: my @srchins = ('crs','dom','alc','instd');
7150:
7151: foreach my $option (@srchins) {
7152: # FIXME 'alc' option unavailable until
7153: # loncreateuser::print_user_query_page()
7154: # has been completed.
7155: next if ($option eq 'alc');
7156: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7157: if ($curr_selected{'srchin'} eq $option) {
7158: $srchinsel .= '
7159: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7160: } else {
7161: $srchinsel .= '
7162: <option value="'.$option.'">'.$lt{$option}.'</option>';
7163: }
1.555 raeburn 7164: }
1.563 raeburn 7165: $srchinsel .= "\n </select>\n";
1.555 raeburn 7166:
7167: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7168: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7169: if ($curr_selected{'srchby'} eq $option) {
7170: $srchbysel .= '
7171: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7172: } else {
7173: $srchbysel .= '
7174: <option value="'.$option.'">'.$lt{$option}.'</option>';
7175: }
7176: }
7177: $srchbysel .= "\n </select>\n";
7178:
7179: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7180: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7181: if ($curr_selected{'srchtype'} eq $option) {
7182: $srchtypesel .= '
7183: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7184: } else {
7185: $srchtypesel .= '
7186: <option value="'.$option.'">'.$lt{$option}.'</option>';
7187: }
7188: }
7189: $srchtypesel .= "\n </select>\n";
7190:
1.558 albertel 7191: my ($newuserscript,$new_user_create);
1.556 raeburn 7192:
7193: if ($forcenewuser) {
1.576 raeburn 7194: if (ref($srch) eq 'HASH') {
7195: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7196: if ($cancreate) {
7197: $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>';
7198: } else {
7199: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
7200: my %usertypetext = (
7201: official => 'institutional',
7202: unofficial => 'non-institutional',
7203: );
7204: $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 />';
7205: }
1.576 raeburn 7206: }
7207: }
7208:
1.556 raeburn 7209: $newuserscript = <<"ENDSCRIPT";
7210:
1.570 raeburn 7211: function setSearch(createnew,callingForm) {
1.556 raeburn 7212: if (createnew == 1) {
1.570 raeburn 7213: for (var i=0; i<callingForm.srchby.length; i++) {
7214: if (callingForm.srchby.options[i].value == 'uname') {
7215: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7216: }
7217: }
1.570 raeburn 7218: for (var i=0; i<callingForm.srchin.length; i++) {
7219: if ( callingForm.srchin.options[i].value == 'dom') {
7220: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7221: }
7222: }
1.570 raeburn 7223: for (var i=0; i<callingForm.srchtype.length; i++) {
7224: if (callingForm.srchtype.options[i].value == 'exact') {
7225: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7226: }
7227: }
1.570 raeburn 7228: for (var i=0; i<callingForm.srchdomain.length; i++) {
7229: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7230: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7231: }
7232: }
7233: }
7234: }
7235: ENDSCRIPT
1.558 albertel 7236:
1.556 raeburn 7237: }
7238:
1.555 raeburn 7239: my $output = <<"END_BLOCK";
1.556 raeburn 7240: <script type="text/javascript">
1.570 raeburn 7241: function validateEntry(callingForm) {
1.558 albertel 7242:
1.556 raeburn 7243: var checkok = 1;
1.558 albertel 7244: var srchin;
1.570 raeburn 7245: for (var i=0; i<callingForm.srchin.length; i++) {
7246: if ( callingForm.srchin[i].checked ) {
7247: srchin = callingForm.srchin[i].value;
1.558 albertel 7248: }
7249: }
7250:
1.570 raeburn 7251: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7252: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7253: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7254: var srchterm = callingForm.srchterm.value;
7255: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7256: var msg = "";
7257:
7258: if (srchterm == "") {
7259: checkok = 0;
1.571 raeburn 7260: msg += "$lt{'youm'}\\n";
1.556 raeburn 7261: }
7262:
1.569 raeburn 7263: if (srchtype== 'begins') {
7264: if (srchterm.length < 2) {
7265: checkok = 0;
1.571 raeburn 7266: msg += "$lt{'thte'}\\n";
1.569 raeburn 7267: }
7268: }
7269:
1.556 raeburn 7270: if (srchtype== 'contains') {
7271: if (srchterm.length < 3) {
7272: checkok = 0;
1.571 raeburn 7273: msg += "$lt{'thet'}\\n";
1.556 raeburn 7274: }
7275: }
7276: if (srchin == 'instd') {
7277: if (srchdomain == '') {
7278: checkok = 0;
1.571 raeburn 7279: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7280: }
7281: }
7282: if (srchin == 'dom') {
7283: if (srchdomain == '') {
7284: checkok = 0;
1.571 raeburn 7285: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7286: }
7287: }
7288: if (srchby == 'lastfirst') {
7289: if (srchterm.indexOf(",") == -1) {
7290: checkok = 0;
1.571 raeburn 7291: msg += "$lt{'whus'}\\n";
1.556 raeburn 7292: }
7293: if (srchterm.indexOf(",") == srchterm.length -1) {
7294: checkok = 0;
1.571 raeburn 7295: msg += "$lt{'whse'}\\n";
1.556 raeburn 7296: }
7297: }
7298: if (checkok == 0) {
1.571 raeburn 7299: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7300: return;
7301: }
7302: if (checkok == 1) {
1.570 raeburn 7303: callingForm.submit();
1.556 raeburn 7304: }
7305: }
7306:
7307: $newuserscript
7308:
7309: </script>
1.558 albertel 7310:
7311: $new_user_create
7312:
1.555 raeburn 7313: <table>
1.558 albertel 7314: <tr>
1.573 raeburn 7315: <td>$lt{'doma'}:</td>
7316: <td>$domform</td>
7317: </td>
7318: </tr>
7319: <tr>
7320: <td>$lt{'usr'}:</td>
1.563 raeburn 7321: <td>$srchbysel
7322: $srchtypesel
7323: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7324: $srchinsel
1.563 raeburn 7325: </td>
7326: </tr>
1.555 raeburn 7327: </table>
7328: <br />
7329: END_BLOCK
1.558 albertel 7330:
1.555 raeburn 7331: return $output;
7332: }
7333:
1.612 raeburn 7334: sub user_rule_check {
1.615 raeburn 7335: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7336: my $response;
7337: if (ref($usershash) eq 'HASH') {
7338: foreach my $user (keys(%{$usershash})) {
7339: my ($uname,$udom) = split(/:/,$user);
7340: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7341: my ($id,$newuser);
1.612 raeburn 7342: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7343: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7344: $id = $usershash->{$user}->{'id'};
7345: }
7346: my $inst_response;
7347: if (ref($checks) eq 'HASH') {
7348: if (defined($checks->{'username'})) {
1.615 raeburn 7349: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7350: &Apache::lonnet::get_instuser($udom,$uname);
7351: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7352: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7353: &Apache::lonnet::get_instuser($udom,undef,$id);
7354: }
1.615 raeburn 7355: } else {
7356: ($inst_response,%{$inst_results->{$user}}) =
7357: &Apache::lonnet::get_instuser($udom,$uname);
7358: return;
1.612 raeburn 7359: }
1.615 raeburn 7360: if (!$got_rules->{$udom}) {
1.612 raeburn 7361: my %domconfig = &Apache::lonnet::get_dom('configuration',
7362: ['usercreation'],$udom);
7363: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7364: foreach my $item ('username','id') {
1.612 raeburn 7365: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7366: $$curr_rules{$udom}{$item} =
7367: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7368: }
7369: }
7370: }
1.615 raeburn 7371: $got_rules->{$udom} = 1;
1.585 raeburn 7372: }
1.612 raeburn 7373: foreach my $item (keys(%{$checks})) {
7374: if (ref($$curr_rules{$udom}) eq 'HASH') {
7375: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7376: if (@{$$curr_rules{$udom}{$item}} > 0) {
7377: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7378: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7379: if ($rule_check{$rule}) {
7380: $$rulematch{$user}{$item} = $rule;
7381: if ($inst_response eq 'ok') {
1.615 raeburn 7382: if (ref($inst_results) eq 'HASH') {
7383: if (ref($inst_results->{$user}) eq 'HASH') {
7384: if (keys(%{$inst_results->{$user}}) == 0) {
7385: $$alerts{$item}{$udom}{$uname} = 1;
7386: }
1.612 raeburn 7387: }
7388: }
1.615 raeburn 7389: }
7390: last;
1.585 raeburn 7391: }
7392: }
7393: }
7394: }
7395: }
7396: }
7397: }
7398: }
1.612 raeburn 7399: return;
7400: }
7401:
7402: sub user_rule_formats {
7403: my ($domain,$domdesc,$curr_rules,$check) = @_;
7404: my %text = (
7405: 'username' => 'Usernames',
7406: 'id' => 'IDs',
7407: );
7408: my $output;
7409: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7410: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7411: if (@{$ruleorder} > 0) {
7412: $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>';
7413: foreach my $rule (@{$ruleorder}) {
7414: if (ref($curr_rules) eq 'ARRAY') {
7415: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7416: if (ref($rules->{$rule}) eq 'HASH') {
7417: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7418: $rules->{$rule}{'desc'}.'</li>';
7419: }
7420: }
7421: }
7422: }
7423: $output .= '</ul>';
7424: }
7425: }
7426: return $output;
7427: }
7428:
7429: sub instrule_disallow_msg {
1.615 raeburn 7430: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7431: my $response;
7432: my %text = (
7433: item => 'username',
7434: items => 'usernames',
7435: match => 'matches',
7436: do => 'does',
7437: action => 'a username',
7438: one => 'one',
7439: );
7440: if ($count > 1) {
7441: $text{'item'} = 'usernames';
7442: $text{'match'} ='match';
7443: $text{'do'} = 'do';
7444: $text{'action'} = 'usernames',
7445: $text{'one'} = 'ones';
7446: }
7447: if ($checkitem eq 'id') {
7448: $text{'items'} = 'IDs';
7449: $text{'item'} = 'ID';
7450: $text{'action'} = 'an ID';
1.615 raeburn 7451: if ($count > 1) {
7452: $text{'item'} = 'IDs';
7453: $text{'action'} = 'IDs';
7454: }
1.612 raeburn 7455: }
1.674 bisitz 7456: $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 7457: if ($mode eq 'upload') {
7458: if ($checkitem eq 'username') {
7459: $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'}.");
7460: } elsif ($checkitem eq 'id') {
1.674 bisitz 7461: $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 7462: }
1.669 raeburn 7463: } elsif ($mode eq 'selfcreate') {
7464: if ($checkitem eq 'id') {
7465: $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.");
7466: }
1.615 raeburn 7467: } else {
7468: if ($checkitem eq 'username') {
7469: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7470: } elsif ($checkitem eq 'id') {
7471: $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.");
7472: }
1.612 raeburn 7473: }
7474: return $response;
1.585 raeburn 7475: }
7476:
1.624 raeburn 7477: sub personal_data_fieldtitles {
7478: my %fieldtitles = &Apache::lonlocal::texthash (
7479: id => 'Student/Employee ID',
7480: permanentemail => 'E-mail address',
7481: lastname => 'Last Name',
7482: firstname => 'First Name',
7483: middlename => 'Middle Name',
7484: generation => 'Generation',
7485: gen => 'Generation',
7486: );
7487: return %fieldtitles;
7488: }
7489:
1.642 raeburn 7490: sub sorted_inst_types {
7491: my ($dom) = @_;
7492: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7493: my $othertitle = &mt('All users');
7494: if ($env{'request.course.id'}) {
1.668 raeburn 7495: $othertitle = &mt('Any users');
1.642 raeburn 7496: }
7497: my @types;
7498: if (ref($order) eq 'ARRAY') {
7499: @types = @{$order};
7500: }
7501: if (@types == 0) {
7502: if (ref($usertypes) eq 'HASH') {
7503: @types = sort(keys(%{$usertypes}));
7504: }
7505: }
7506: if (keys(%{$usertypes}) > 0) {
7507: $othertitle = &mt('Other users');
7508: }
7509: return ($othertitle,$usertypes,\@types);
7510: }
7511:
1.645 raeburn 7512: sub get_institutional_codes {
7513: my ($settings,$allcourses,$LC_code) = @_;
7514: # Get complete list of course sections to update
7515: my @currsections = ();
7516: my @currxlists = ();
7517: my $coursecode = $$settings{'internal.coursecode'};
7518:
7519: if ($$settings{'internal.sectionnums'} ne '') {
7520: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7521: }
7522:
7523: if ($$settings{'internal.crosslistings'} ne '') {
7524: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7525: }
7526:
7527: if (@currxlists > 0) {
7528: foreach (@currxlists) {
7529: if (m/^([^:]+):(\w*)$/) {
7530: unless (grep/^$1$/,@{$allcourses}) {
7531: push @{$allcourses},$1;
7532: $$LC_code{$1} = $2;
7533: }
7534: }
7535: }
7536: }
7537:
7538: if (@currsections > 0) {
7539: foreach (@currsections) {
7540: if (m/^(\w+):(\w*)$/) {
7541: my $sec = $coursecode.$1;
7542: my $lc_sec = $2;
7543: unless (grep/^$sec$/,@{$allcourses}) {
7544: push @{$allcourses},$sec;
7545: $$LC_code{$sec} = $lc_sec;
7546: }
7547: }
7548: }
7549: }
7550: return;
7551: }
7552:
1.112 bowersj2 7553: =pod
7554:
1.549 albertel 7555: =back
7556:
7557: =head1 HTTP Helpers
7558:
7559: =over 4
7560:
1.648 raeburn 7561: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7562:
1.258 albertel 7563: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7564: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7565: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7566:
7567: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7568: $possible_names is an ref to an array of form element names. As an example:
7569: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7570: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7571:
7572: =cut
1.1 albertel 7573:
1.6 albertel 7574: sub get_unprocessed_cgi {
1.25 albertel 7575: my ($query,$possible_names)= @_;
1.26 matthew 7576: # $Apache::lonxml::debug=1;
1.356 albertel 7577: foreach my $pair (split(/&/,$query)) {
7578: my ($name, $value) = split(/=/,$pair);
1.369 www 7579: $name = &unescape($name);
1.25 albertel 7580: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7581: $value =~ tr/+/ /;
7582: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7583: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7584: }
1.16 harris41 7585: }
1.6 albertel 7586: }
7587:
1.112 bowersj2 7588: =pod
7589:
1.648 raeburn 7590: =item * &cacheheader()
1.112 bowersj2 7591:
7592: returns cache-controlling header code
7593:
7594: =cut
7595:
1.7 albertel 7596: sub cacheheader {
1.258 albertel 7597: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7598: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7599: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7600: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7601: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7602: return $output;
1.7 albertel 7603: }
7604:
1.112 bowersj2 7605: =pod
7606:
1.648 raeburn 7607: =item * &no_cache($r)
1.112 bowersj2 7608:
7609: specifies header code to not have cache
7610:
7611: =cut
7612:
1.9 albertel 7613: sub no_cache {
1.216 albertel 7614: my ($r) = @_;
7615: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7616: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7617: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7618: $r->no_cache(1);
7619: $r->header_out("Expires" => $date);
7620: $r->header_out("Pragma" => "no-cache");
1.123 www 7621: }
7622:
7623: sub content_type {
1.181 albertel 7624: my ($r,$type,$charset) = @_;
1.299 foxr 7625: if ($r) {
7626: # Note that printout.pl calls this with undef for $r.
7627: &no_cache($r);
7628: }
1.258 albertel 7629: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7630: unless ($charset) {
7631: $charset=&Apache::lonlocal::current_encoding;
7632: }
7633: if ($charset) { $type.='; charset='.$charset; }
7634: if ($r) {
7635: $r->content_type($type);
7636: } else {
7637: print("Content-type: $type\n\n");
7638: }
1.9 albertel 7639: }
1.25 albertel 7640:
1.112 bowersj2 7641: =pod
7642:
1.648 raeburn 7643: =item * &add_to_env($name,$value)
1.112 bowersj2 7644:
1.258 albertel 7645: adds $name to the %env hash with value
1.112 bowersj2 7646: $value, if $name already exists, the entry is converted to an array
7647: reference and $value is added to the array.
7648:
7649: =cut
7650:
1.25 albertel 7651: sub add_to_env {
7652: my ($name,$value)=@_;
1.258 albertel 7653: if (defined($env{$name})) {
7654: if (ref($env{$name})) {
1.25 albertel 7655: #already have multiple values
1.258 albertel 7656: push(@{ $env{$name} },$value);
1.25 albertel 7657: } else {
7658: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7659: my $first=$env{$name};
7660: undef($env{$name});
7661: push(@{ $env{$name} },$first,$value);
1.25 albertel 7662: }
7663: } else {
1.258 albertel 7664: $env{$name}=$value;
1.25 albertel 7665: }
1.31 albertel 7666: }
1.149 albertel 7667:
7668: =pod
7669:
1.648 raeburn 7670: =item * &get_env_multiple($name)
1.149 albertel 7671:
1.258 albertel 7672: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7673: values may be defined and end up as an array ref.
7674:
7675: returns an array of values
7676:
7677: =cut
7678:
7679: sub get_env_multiple {
7680: my ($name) = @_;
7681: my @values;
1.258 albertel 7682: if (defined($env{$name})) {
1.149 albertel 7683: # exists is it an array
1.258 albertel 7684: if (ref($env{$name})) {
7685: @values=@{ $env{$name} };
1.149 albertel 7686: } else {
1.258 albertel 7687: $values[0]=$env{$name};
1.149 albertel 7688: }
7689: }
7690: return(@values);
7691: }
7692:
1.660 raeburn 7693: sub ask_for_embedded_content {
7694: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7695: my $upload_output = '
7696: <form name="upload_embedded" action="'.$actionurl.'"
7697: method="post" enctype="multipart/form-data">';
7698: $upload_output .= $state;
1.661 raeburn 7699: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7700:
7701: my $num = 0;
7702: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7703: $upload_output .= &start_data_table_row().
7704: '<td>'.$embed_file.'</td><td>';
7705: if ($args->{'ignore_remote_references'}
7706: && $embed_file =~ m{^\w+://}) {
7707: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7708: } elsif ($args->{'error_on_invalid_names'}
7709: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7710:
7711: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7712:
7713: } else {
7714: $upload_output .='
1.661 raeburn 7715: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7716: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7717: my $attrib = join(':',@{$$allfiles{$embed_file}});
7718: $upload_output .=
7719: "\n\t\t".
7720: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7721: $attrib.'" />';
7722: if (exists($$codebase{$embed_file})) {
7723: $upload_output .=
7724: "\n\t\t".
7725: '<input name="codebase_'.$num.'" type="hidden" value="'.
7726: &escape($$codebase{$embed_file}).'" />';
7727: }
7728: }
7729: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7730: $num++;
7731: }
7732: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7733: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7734: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7735: '.&mt('(only files for which a location has been provided will be uploaded)').'
7736: </form>';
7737: return $upload_output;
7738: }
7739:
1.661 raeburn 7740: sub upload_embedded {
7741: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7742: $current_disk_usage) = @_;
7743: my $output;
7744: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7745: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7746: my $orig_uploaded_filename =
7747: $env{'form.embedded_item_'.$i.'.filename'};
7748:
7749: $env{'form.embedded_orig_'.$i} =
7750: &unescape($env{'form.embedded_orig_'.$i});
7751: my ($path,$fname) =
7752: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7753: # no path, whole string is fname
7754: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7755:
7756: $path = $env{'form.currentpath'}.$path;
7757: $fname = &Apache::lonnet::clean_filename($fname);
7758: # See if there is anything left
7759: next if ($fname eq '');
7760:
7761: # Check if file already exists as a file or directory.
7762: my ($state,$msg);
7763: if ($context eq 'portfolio') {
7764: my $port_path = $dirpath;
7765: if ($group ne '') {
7766: $port_path = "groups/$group/$port_path";
7767: }
7768: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7769: $dir_root,$port_path,$disk_quota,
7770: $current_disk_usage,$uname,$udom);
7771: if ($state eq 'will_exceed_quota'
7772: || $state eq 'file_locked'
7773: || $state eq 'file_exists' ) {
7774: $output .= $msg;
7775: next;
7776: }
7777: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7778: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7779: if ($state eq 'exists') {
7780: $output .= $msg;
7781: next;
7782: }
7783: }
7784: # Check if extension is valid
7785: if (($fname =~ /\.(\w+)$/) &&
7786: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7787: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7788: next;
7789: } elsif (($fname =~ /\.(\w+)$/) &&
7790: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7791: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7792: next;
7793: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7794: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7795: next;
7796: }
7797:
7798: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7799: if ($context eq 'portfolio') {
7800: my $result=
7801: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7802: $dirpath.$path);
7803: if ($result !~ m|^/uploaded/|) {
7804: $output .= '<span class="LC_error">'
7805: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7806: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7807: .'</span><br />';
7808: next;
7809: } else {
7810: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7811: $path.$fname.'</span>').'</p>';
7812: }
7813: } else {
7814: # Save the file
7815: my $target = $env{'form.embedded_item_'.$i};
7816: my $fullpath = $dir_root.$dirpath.'/'.$path;
7817: my $dest = $fullpath.$fname;
7818: my $url = $url_root.$dirpath.'/'.$path.$fname;
7819: my @parts=split(/\//,$fullpath);
7820: my $count;
7821: my $filepath = $dir_root;
7822: for ($count=4;$count<=$#parts;$count++) {
7823: $filepath .= "/$parts[$count]";
7824: if ((-e $filepath)!=1) {
7825: mkdir($filepath,0770);
7826: }
7827: }
7828: my $fh;
7829: if (!open($fh,'>'.$dest)) {
7830: &Apache::lonnet::logthis('Failed to create '.$dest);
7831: $output .= '<span class="LC_error">'.
7832: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7833: '</span><br />';
7834: } else {
7835: if (!print $fh $env{'form.embedded_item_'.$i}) {
7836: &Apache::lonnet::logthis('Failed to write to '.$dest);
7837: $output .= '<span class="LC_error">'.
7838: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7839: '</span><br />';
7840: } else {
7841: if ($context eq 'testbank') {
7842: $output .= &mt('Embedded file uploaded successfully:').
7843: ' <a href="'.$url.'">'.
7844: $orig_uploaded_filename.'</a><br />';
7845: } else {
1.705 tempelho 7846: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7847: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7848: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7849: }
7850: }
7851: close($fh);
7852: }
7853: }
7854: }
7855: return $output;
7856: }
7857:
7858: sub check_for_existing {
7859: my ($path,$fname,$element) = @_;
7860: my ($state,$msg);
7861: if (-d $path.'/'.$fname) {
7862: $state = 'exists';
7863: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7864: } elsif (-e $path.'/'.$fname) {
7865: $state = 'exists';
7866: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7867: }
7868: if ($state eq 'exists') {
7869: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7870: }
7871: return ($state,$msg);
7872: }
7873:
7874: sub check_for_upload {
7875: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7876: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7877: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7878: my $getpropath = 1;
7879: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7880: $getpropath);
7881: my $found_file = 0;
7882: my $locked_file = 0;
7883: foreach my $line (@dir_list) {
7884: my ($file_name)=split(/\&/,$line,2);
7885: if ($file_name eq $fname){
7886: $file_name = $path.$file_name;
7887: if ($group ne '') {
7888: $file_name = $group.$file_name;
7889: }
7890: $found_file = 1;
7891: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7892: $locked_file = 1;
7893: }
7894: }
7895: }
7896: if (($current_disk_usage + $filesize) > $disk_quota){
7897: my $msg = '<span class="LC_error">'.
7898: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7899: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7900: return ('will_exceed_quota',$msg);
7901: } elsif ($found_file) {
7902: if ($locked_file) {
7903: my $msg = '<span class="LC_error">';
7904: $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>');
7905: $msg .= '</span><br />';
7906: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7907: return ('file_locked',$msg);
7908: } else {
7909: my $msg = '<span class="LC_error">';
7910: $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'});
7911: $msg .= '</span>';
7912: $msg .= '<br />';
7913: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7914: return ('file_exists',$msg);
7915: }
7916: }
7917: }
7918:
1.31 albertel 7919:
1.41 ng 7920: =pod
1.45 matthew 7921:
1.464 albertel 7922: =back
1.41 ng 7923:
1.112 bowersj2 7924: =head1 CSV Upload/Handling functions
1.38 albertel 7925:
1.41 ng 7926: =over 4
7927:
1.648 raeburn 7928: =item * &upfile_store($r)
1.41 ng 7929:
7930: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7931: needs $env{'form.upfile'}
1.41 ng 7932: returns $datatoken to be put into hidden field
7933:
7934: =cut
1.31 albertel 7935:
7936: sub upfile_store {
7937: my $r=shift;
1.258 albertel 7938: $env{'form.upfile'}=~s/\r/\n/gs;
7939: $env{'form.upfile'}=~s/\f/\n/gs;
7940: $env{'form.upfile'}=~s/\n+/\n/gs;
7941: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7942:
1.258 albertel 7943: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7944: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7945: {
1.158 raeburn 7946: my $datafile = $r->dir_config('lonDaemons').
7947: '/tmp/'.$datatoken.'.tmp';
7948: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7949: print $fh $env{'form.upfile'};
1.158 raeburn 7950: close($fh);
7951: }
1.31 albertel 7952: }
7953: return $datatoken;
7954: }
7955:
1.56 matthew 7956: =pod
7957:
1.648 raeburn 7958: =item * &load_tmp_file($r)
1.41 ng 7959:
7960: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7961: needs $env{'form.datatoken'},
7962: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7963:
7964: =cut
1.31 albertel 7965:
7966: sub load_tmp_file {
7967: my $r=shift;
7968: my @studentdata=();
7969: {
1.158 raeburn 7970: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7971: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7972: if ( open(my $fh,"<$studentfile") ) {
7973: @studentdata=<$fh>;
7974: close($fh);
7975: }
1.31 albertel 7976: }
1.258 albertel 7977: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7978: }
7979:
1.56 matthew 7980: =pod
7981:
1.648 raeburn 7982: =item * &upfile_record_sep()
1.41 ng 7983:
7984: Separate uploaded file into records
7985: returns array of records,
1.258 albertel 7986: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7987:
7988: =cut
1.31 albertel 7989:
7990: sub upfile_record_sep {
1.258 albertel 7991: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7992: } else {
1.248 albertel 7993: my @records;
1.258 albertel 7994: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7995: if ($line=~/^\s*$/) { next; }
7996: push(@records,$line);
7997: }
7998: return @records;
1.31 albertel 7999: }
8000: }
8001:
1.56 matthew 8002: =pod
8003:
1.648 raeburn 8004: =item * &record_sep($record)
1.41 ng 8005:
1.258 albertel 8006: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8007:
8008: =cut
8009:
1.263 www 8010: sub takeleft {
8011: my $index=shift;
8012: return substr('0000'.$index,-4,4);
8013: }
8014:
1.31 albertel 8015: sub record_sep {
8016: my $record=shift;
8017: my %components=();
1.258 albertel 8018: if ($env{'form.upfiletype'} eq 'xml') {
8019: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8020: my $i=0;
1.356 albertel 8021: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8022: $field=~s/^(\"|\')//;
8023: $field=~s/(\"|\')$//;
1.263 www 8024: $components{&takeleft($i)}=$field;
1.31 albertel 8025: $i++;
8026: }
1.258 albertel 8027: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8028: my $i=0;
1.356 albertel 8029: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8030: $field=~s/^(\"|\')//;
8031: $field=~s/(\"|\')$//;
1.263 www 8032: $components{&takeleft($i)}=$field;
1.31 albertel 8033: $i++;
8034: }
8035: } else {
1.561 www 8036: my $separator=',';
1.480 banghart 8037: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8038: $separator=';';
1.480 banghart 8039: }
1.31 albertel 8040: my $i=0;
1.561 www 8041: # the character we are looking for to indicate the end of a quote or a record
8042: my $looking_for=$separator;
8043: # do not add the characters to the fields
8044: my $ignore=0;
8045: # we just encountered a separator (or the beginning of the record)
8046: my $just_found_separator=1;
8047: # store the field we are working on here
8048: my $field='';
8049: # work our way through all characters in record
8050: foreach my $character ($record=~/(.)/g) {
8051: if ($character eq $looking_for) {
8052: if ($character ne $separator) {
8053: # Found the end of a quote, again looking for separator
8054: $looking_for=$separator;
8055: $ignore=1;
8056: } else {
8057: # Found a separator, store away what we got
8058: $components{&takeleft($i)}=$field;
8059: $i++;
8060: $just_found_separator=1;
8061: $ignore=0;
8062: $field='';
8063: }
8064: next;
8065: }
8066: # single or double quotation marks after a separator indicate beginning of a quote
8067: # we are now looking for the end of the quote and need to ignore separators
8068: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8069: $looking_for=$character;
8070: next;
8071: }
8072: # ignore would be true after we reached the end of a quote
8073: if ($ignore) { next; }
8074: if (($just_found_separator) && ($character=~/\s/)) { next; }
8075: $field.=$character;
8076: $just_found_separator=0;
1.31 albertel 8077: }
1.561 www 8078: # catch the very last entry, since we never encountered the separator
8079: $components{&takeleft($i)}=$field;
1.31 albertel 8080: }
8081: return %components;
8082: }
8083:
1.144 matthew 8084: ######################################################
8085: ######################################################
8086:
1.56 matthew 8087: =pod
8088:
1.648 raeburn 8089: =item * &upfile_select_html()
1.41 ng 8090:
1.144 matthew 8091: Return HTML code to select a file from the users machine and specify
8092: the file type.
1.41 ng 8093:
8094: =cut
8095:
1.144 matthew 8096: ######################################################
8097: ######################################################
1.31 albertel 8098: sub upfile_select_html {
1.144 matthew 8099: my %Types = (
8100: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8101: semisv => &mt('Semicolon separated values'),
1.144 matthew 8102: space => &mt('Space separated'),
8103: tab => &mt('Tabulator separated'),
8104: # xml => &mt('HTML/XML'),
8105: );
8106: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8107: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8108: foreach my $type (sort(keys(%Types))) {
8109: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8110: }
8111: $Str .= "</select>\n";
8112: return $Str;
1.31 albertel 8113: }
8114:
1.301 albertel 8115: sub get_samples {
8116: my ($records,$toget) = @_;
8117: my @samples=({});
8118: my $got=0;
8119: foreach my $rec (@$records) {
8120: my %temp = &record_sep($rec);
8121: if (! grep(/\S/, values(%temp))) { next; }
8122: if (%temp) {
8123: $samples[$got]=\%temp;
8124: $got++;
8125: if ($got == $toget) { last; }
8126: }
8127: }
8128: return \@samples;
8129: }
8130:
1.144 matthew 8131: ######################################################
8132: ######################################################
8133:
1.56 matthew 8134: =pod
8135:
1.648 raeburn 8136: =item * &csv_print_samples($r,$records)
1.41 ng 8137:
8138: Prints a table of sample values from each column uploaded $r is an
8139: Apache Request ref, $records is an arrayref from
8140: &Apache::loncommon::upfile_record_sep
8141:
8142: =cut
8143:
1.144 matthew 8144: ######################################################
8145: ######################################################
1.31 albertel 8146: sub csv_print_samples {
8147: my ($r,$records) = @_;
1.662 bisitz 8148: my $samples = &get_samples($records,5);
1.301 albertel 8149:
1.594 raeburn 8150: $r->print(&mt('Samples').'<br />'.&start_data_table().
8151: &start_data_table_header_row());
1.356 albertel 8152: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8153: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8154: $r->print(&end_data_table_header_row());
1.301 albertel 8155: foreach my $hash (@$samples) {
1.594 raeburn 8156: $r->print(&start_data_table_row());
1.356 albertel 8157: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8158: $r->print('<td>');
1.356 albertel 8159: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8160: $r->print('</td>');
8161: }
1.594 raeburn 8162: $r->print(&end_data_table_row());
1.31 albertel 8163: }
1.594 raeburn 8164: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8165: }
8166:
1.144 matthew 8167: ######################################################
8168: ######################################################
8169:
1.56 matthew 8170: =pod
8171:
1.648 raeburn 8172: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8173:
8174: Prints a table to create associations between values and table columns.
1.144 matthew 8175:
1.41 ng 8176: $r is an Apache Request ref,
8177: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8178: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8179:
8180: =cut
8181:
1.144 matthew 8182: ######################################################
8183: ######################################################
1.31 albertel 8184: sub csv_print_select_table {
8185: my ($r,$records,$d) = @_;
1.301 albertel 8186: my $i=0;
8187: my $samples = &get_samples($records,1);
1.144 matthew 8188: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8189: &start_data_table().&start_data_table_header_row().
1.144 matthew 8190: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8191: '<th>'.&mt('Column').'</th>'.
8192: &end_data_table_header_row()."\n");
1.356 albertel 8193: foreach my $array_ref (@$d) {
8194: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8195: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8196:
8197: $r->print('<td><select name=f'.$i.
1.32 matthew 8198: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8199: $r->print('<option value="none"></option>');
1.356 albertel 8200: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8201: $r->print('<option value="'.$sample.'"'.
8202: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8203: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8204: }
1.594 raeburn 8205: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8206: $i++;
8207: }
1.594 raeburn 8208: $r->print(&end_data_table());
1.31 albertel 8209: $i--;
8210: return $i;
8211: }
1.56 matthew 8212:
1.144 matthew 8213: ######################################################
8214: ######################################################
8215:
1.56 matthew 8216: =pod
1.31 albertel 8217:
1.648 raeburn 8218: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8219:
8220: Prints a table of sample values from the upload and can make associate samples to internal names.
8221:
8222: $r is an Apache Request ref,
8223: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8224: $d is an array of 2 element arrays (internal name, displayed name)
8225:
8226: =cut
8227:
1.144 matthew 8228: ######################################################
8229: ######################################################
1.31 albertel 8230: sub csv_samples_select_table {
8231: my ($r,$records,$d) = @_;
8232: my $i=0;
1.144 matthew 8233: #
1.662 bisitz 8234: my $max_samples = 5;
8235: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8236: $r->print(&start_data_table().
8237: &start_data_table_header_row().'<th>'.
8238: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8239: &end_data_table_header_row());
1.301 albertel 8240:
8241: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8242: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8243: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8244: foreach my $option (@$d) {
8245: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8246: $r->print('<option value="'.$value.'"'.
1.253 albertel 8247: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8248: $display.'</option>');
1.31 albertel 8249: }
8250: $r->print('</select></td><td>');
1.662 bisitz 8251: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8252: if (defined($samples->[$line]{$key})) {
8253: $r->print($samples->[$line]{$key}."<br />\n");
8254: }
8255: }
1.594 raeburn 8256: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8257: $i++;
8258: }
1.594 raeburn 8259: $r->print(&end_data_table());
1.31 albertel 8260: $i--;
8261: return($i);
1.115 matthew 8262: }
8263:
1.144 matthew 8264: ######################################################
8265: ######################################################
8266:
1.115 matthew 8267: =pod
8268:
1.648 raeburn 8269: =item * &clean_excel_name($name)
1.115 matthew 8270:
8271: Returns a replacement for $name which does not contain any illegal characters.
8272:
8273: =cut
8274:
1.144 matthew 8275: ######################################################
8276: ######################################################
1.115 matthew 8277: sub clean_excel_name {
8278: my ($name) = @_;
8279: $name =~ s/[:\*\?\/\\]//g;
8280: if (length($name) > 31) {
8281: $name = substr($name,0,31);
8282: }
8283: return $name;
1.25 albertel 8284: }
1.84 albertel 8285:
1.85 albertel 8286: =pod
8287:
1.648 raeburn 8288: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8289:
8290: Returns either 1 or undef
8291:
8292: 1 if the part is to be hidden, undef if it is to be shown
8293:
8294: Arguments are:
8295:
8296: $id the id of the part to be checked
8297: $symb, optional the symb of the resource to check
8298: $udom, optional the domain of the user to check for
8299: $uname, optional the username of the user to check for
8300:
8301: =cut
1.84 albertel 8302:
8303: sub check_if_partid_hidden {
8304: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8305: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8306: $symb,$udom,$uname);
1.141 albertel 8307: my $truth=1;
8308: #if the string starts with !, then the list is the list to show not hide
8309: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8310: my @hiddenlist=split(/,/,$hiddenparts);
8311: foreach my $checkid (@hiddenlist) {
1.141 albertel 8312: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8313: }
1.141 albertel 8314: return !$truth;
1.84 albertel 8315: }
1.127 matthew 8316:
1.138 matthew 8317:
8318: ############################################################
8319: ############################################################
8320:
8321: =pod
8322:
1.157 matthew 8323: =back
8324:
1.138 matthew 8325: =head1 cgi-bin script and graphing routines
8326:
1.157 matthew 8327: =over 4
8328:
1.648 raeburn 8329: =item * &get_cgi_id()
1.138 matthew 8330:
8331: Inputs: none
8332:
8333: Returns an id which can be used to pass environment variables
8334: to various cgi-bin scripts. These environment variables will
8335: be removed from the users environment after a given time by
8336: the routine &Apache::lonnet::transfer_profile_to_env.
8337:
8338: =cut
8339:
8340: ############################################################
8341: ############################################################
1.152 albertel 8342: my $uniq=0;
1.136 matthew 8343: sub get_cgi_id {
1.154 albertel 8344: $uniq=($uniq+1)%100000;
1.280 albertel 8345: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8346: }
8347:
1.127 matthew 8348: ############################################################
8349: ############################################################
8350:
8351: =pod
8352:
1.648 raeburn 8353: =item * &DrawBarGraph()
1.127 matthew 8354:
1.138 matthew 8355: Facilitates the plotting of data in a (stacked) bar graph.
8356: Puts plot definition data into the users environment in order for
8357: graph.png to plot it. Returns an <img> tag for the plot.
8358: The bars on the plot are labeled '1','2',...,'n'.
8359:
8360: Inputs:
8361:
8362: =over 4
8363:
8364: =item $Title: string, the title of the plot
8365:
8366: =item $xlabel: string, text describing the X-axis of the plot
8367:
8368: =item $ylabel: string, text describing the Y-axis of the plot
8369:
8370: =item $Max: scalar, the maximum Y value to use in the plot
8371: If $Max is < any data point, the graph will not be rendered.
8372:
1.140 matthew 8373: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8374: they are plotted. If undefined, default values will be used.
8375:
1.178 matthew 8376: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8377:
1.138 matthew 8378: =item @Values: An array of array references. Each array reference holds data
8379: to be plotted in a stacked bar chart.
8380:
1.239 matthew 8381: =item If the final element of @Values is a hash reference the key/value
8382: pairs will be added to the graph definition.
8383:
1.138 matthew 8384: =back
8385:
8386: Returns:
8387:
8388: An <img> tag which references graph.png and the appropriate identifying
8389: information for the plot.
8390:
1.127 matthew 8391: =cut
8392:
8393: ############################################################
8394: ############################################################
1.134 matthew 8395: sub DrawBarGraph {
1.178 matthew 8396: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8397: #
8398: if (! defined($colors)) {
8399: $colors = ['#33ff00',
8400: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8401: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8402: ];
8403: }
1.228 matthew 8404: my $extra_settings = {};
8405: if (ref($Values[-1]) eq 'HASH') {
8406: $extra_settings = pop(@Values);
8407: }
1.127 matthew 8408: #
1.136 matthew 8409: my $identifier = &get_cgi_id();
8410: my $id = 'cgi.'.$identifier;
1.129 matthew 8411: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8412: return '';
8413: }
1.225 matthew 8414: #
8415: my @Labels;
8416: if (defined($labels)) {
8417: @Labels = @$labels;
8418: } else {
8419: for (my $i=0;$i<@{$Values[0]};$i++) {
8420: push (@Labels,$i+1);
8421: }
8422: }
8423: #
1.129 matthew 8424: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8425: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8426: my %ValuesHash;
8427: my $NumSets=1;
8428: foreach my $array (@Values) {
8429: next if (! ref($array));
1.136 matthew 8430: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8431: join(',',@$array);
1.129 matthew 8432: }
1.127 matthew 8433: #
1.136 matthew 8434: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8435: if ($NumBars < 3) {
8436: $width = 120+$NumBars*32;
1.220 matthew 8437: $xskip = 1;
1.225 matthew 8438: $bar_width = 30;
8439: } elsif ($NumBars < 5) {
8440: $width = 120+$NumBars*20;
8441: $xskip = 1;
8442: $bar_width = 20;
1.220 matthew 8443: } elsif ($NumBars < 10) {
1.136 matthew 8444: $width = 120+$NumBars*15;
8445: $xskip = 1;
8446: $bar_width = 15;
8447: } elsif ($NumBars <= 25) {
8448: $width = 120+$NumBars*11;
8449: $xskip = 5;
8450: $bar_width = 8;
8451: } elsif ($NumBars <= 50) {
8452: $width = 120+$NumBars*8;
8453: $xskip = 5;
8454: $bar_width = 4;
8455: } else {
8456: $width = 120+$NumBars*8;
8457: $xskip = 5;
8458: $bar_width = 4;
8459: }
8460: #
1.137 matthew 8461: $Max = 1 if ($Max < 1);
8462: if ( int($Max) < $Max ) {
8463: $Max++;
8464: $Max = int($Max);
8465: }
1.127 matthew 8466: $Title = '' if (! defined($Title));
8467: $xlabel = '' if (! defined($xlabel));
8468: $ylabel = '' if (! defined($ylabel));
1.369 www 8469: $ValuesHash{$id.'.title'} = &escape($Title);
8470: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8471: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8472: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8473: $ValuesHash{$id.'.NumBars'} = $NumBars;
8474: $ValuesHash{$id.'.NumSets'} = $NumSets;
8475: $ValuesHash{$id.'.PlotType'} = 'bar';
8476: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8477: $ValuesHash{$id.'.height'} = $height;
8478: $ValuesHash{$id.'.width'} = $width;
8479: $ValuesHash{$id.'.xskip'} = $xskip;
8480: $ValuesHash{$id.'.bar_width'} = $bar_width;
8481: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8482: #
1.228 matthew 8483: # Deal with other parameters
8484: while (my ($key,$value) = each(%$extra_settings)) {
8485: $ValuesHash{$id.'.'.$key} = $value;
8486: }
8487: #
1.646 raeburn 8488: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8489: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8490: }
8491:
8492: ############################################################
8493: ############################################################
8494:
8495: =pod
8496:
1.648 raeburn 8497: =item * &DrawXYGraph()
1.137 matthew 8498:
1.138 matthew 8499: Facilitates the plotting of data in an XY graph.
8500: Puts plot definition data into the users environment in order for
8501: graph.png to plot it. Returns an <img> tag for the plot.
8502:
8503: Inputs:
8504:
8505: =over 4
8506:
8507: =item $Title: string, the title of the plot
8508:
8509: =item $xlabel: string, text describing the X-axis of the plot
8510:
8511: =item $ylabel: string, text describing the Y-axis of the plot
8512:
8513: =item $Max: scalar, the maximum Y value to use in the plot
8514: If $Max is < any data point, the graph will not be rendered.
8515:
8516: =item $colors: Array ref containing the hex color codes for the data to be
8517: plotted in. If undefined, default values will be used.
8518:
8519: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8520:
8521: =item $Ydata: Array ref containing Array refs.
1.185 www 8522: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8523:
8524: =item %Values: hash indicating or overriding any default values which are
8525: passed to graph.png.
8526: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8527:
8528: =back
8529:
8530: Returns:
8531:
8532: An <img> tag which references graph.png and the appropriate identifying
8533: information for the plot.
8534:
1.137 matthew 8535: =cut
8536:
8537: ############################################################
8538: ############################################################
8539: sub DrawXYGraph {
8540: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8541: #
8542: # Create the identifier for the graph
8543: my $identifier = &get_cgi_id();
8544: my $id = 'cgi.'.$identifier;
8545: #
8546: $Title = '' if (! defined($Title));
8547: $xlabel = '' if (! defined($xlabel));
8548: $ylabel = '' if (! defined($ylabel));
8549: my %ValuesHash =
8550: (
1.369 www 8551: $id.'.title' => &escape($Title),
8552: $id.'.xlabel' => &escape($xlabel),
8553: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8554: $id.'.y_max_value'=> $Max,
8555: $id.'.labels' => join(',',@$Xlabels),
8556: $id.'.PlotType' => 'XY',
8557: );
8558: #
8559: if (defined($colors) && ref($colors) eq 'ARRAY') {
8560: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8561: }
8562: #
8563: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8564: return '';
8565: }
8566: my $NumSets=1;
1.138 matthew 8567: foreach my $array (@{$Ydata}){
1.137 matthew 8568: next if (! ref($array));
8569: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8570: }
1.138 matthew 8571: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8572: #
8573: # Deal with other parameters
8574: while (my ($key,$value) = each(%Values)) {
8575: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8576: }
8577: #
1.646 raeburn 8578: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8579: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8580: }
8581:
8582: ############################################################
8583: ############################################################
8584:
8585: =pod
8586:
1.648 raeburn 8587: =item * &DrawXYYGraph()
1.138 matthew 8588:
8589: Facilitates the plotting of data in an XY graph with two Y axes.
8590: Puts plot definition data into the users environment in order for
8591: graph.png to plot it. Returns an <img> tag for the plot.
8592:
8593: Inputs:
8594:
8595: =over 4
8596:
8597: =item $Title: string, the title of the plot
8598:
8599: =item $xlabel: string, text describing the X-axis of the plot
8600:
8601: =item $ylabel: string, text describing the Y-axis of the plot
8602:
8603: =item $colors: Array ref containing the hex color codes for the data to be
8604: plotted in. If undefined, default values will be used.
8605:
8606: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8607:
8608: =item $Ydata1: The first data set
8609:
8610: =item $Min1: The minimum value of the left Y-axis
8611:
8612: =item $Max1: The maximum value of the left Y-axis
8613:
8614: =item $Ydata2: The second data set
8615:
8616: =item $Min2: The minimum value of the right Y-axis
8617:
8618: =item $Max2: The maximum value of the left Y-axis
8619:
8620: =item %Values: hash indicating or overriding any default values which are
8621: passed to graph.png.
8622: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8623:
8624: =back
8625:
8626: Returns:
8627:
8628: An <img> tag which references graph.png and the appropriate identifying
8629: information for the plot.
1.136 matthew 8630:
8631: =cut
8632:
8633: ############################################################
8634: ############################################################
1.137 matthew 8635: sub DrawXYYGraph {
8636: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8637: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8638: #
8639: # Create the identifier for the graph
8640: my $identifier = &get_cgi_id();
8641: my $id = 'cgi.'.$identifier;
8642: #
8643: $Title = '' if (! defined($Title));
8644: $xlabel = '' if (! defined($xlabel));
8645: $ylabel = '' if (! defined($ylabel));
8646: my %ValuesHash =
8647: (
1.369 www 8648: $id.'.title' => &escape($Title),
8649: $id.'.xlabel' => &escape($xlabel),
8650: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8651: $id.'.labels' => join(',',@$Xlabels),
8652: $id.'.PlotType' => 'XY',
8653: $id.'.NumSets' => 2,
1.137 matthew 8654: $id.'.two_axes' => 1,
8655: $id.'.y1_max_value' => $Max1,
8656: $id.'.y1_min_value' => $Min1,
8657: $id.'.y2_max_value' => $Max2,
8658: $id.'.y2_min_value' => $Min2,
1.136 matthew 8659: );
8660: #
1.137 matthew 8661: if (defined($colors) && ref($colors) eq 'ARRAY') {
8662: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8663: }
8664: #
8665: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8666: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8667: return '';
8668: }
8669: my $NumSets=1;
1.137 matthew 8670: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8671: next if (! ref($array));
8672: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8673: }
8674: #
8675: # Deal with other parameters
8676: while (my ($key,$value) = each(%Values)) {
8677: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8678: }
8679: #
1.646 raeburn 8680: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8681: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8682: }
8683:
8684: ############################################################
8685: ############################################################
8686:
8687: =pod
8688:
1.157 matthew 8689: =back
8690:
1.139 matthew 8691: =head1 Statistics helper routines?
8692:
8693: Bad place for them but what the hell.
8694:
1.157 matthew 8695: =over 4
8696:
1.648 raeburn 8697: =item * &chartlink()
1.139 matthew 8698:
8699: Returns a link to the chart for a specific student.
8700:
8701: Inputs:
8702:
8703: =over 4
8704:
8705: =item $linktext: The text of the link
8706:
8707: =item $sname: The students username
8708:
8709: =item $sdomain: The students domain
8710:
8711: =back
8712:
1.157 matthew 8713: =back
8714:
1.139 matthew 8715: =cut
8716:
8717: ############################################################
8718: ############################################################
8719: sub chartlink {
8720: my ($linktext, $sname, $sdomain) = @_;
8721: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8722: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8723: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8724: '">'.$linktext.'</a>';
1.153 matthew 8725: }
8726:
8727: #######################################################
8728: #######################################################
8729:
8730: =pod
8731:
8732: =head1 Course Environment Routines
1.157 matthew 8733:
8734: =over 4
1.153 matthew 8735:
1.648 raeburn 8736: =item * &restore_course_settings()
1.153 matthew 8737:
1.648 raeburn 8738: =item * &store_course_settings()
1.153 matthew 8739:
8740: Restores/Store indicated form parameters from the course environment.
8741: Will not overwrite existing values of the form parameters.
8742:
8743: Inputs:
8744: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8745:
8746: a hash ref describing the data to be stored. For example:
8747:
8748: %Save_Parameters = ('Status' => 'scalar',
8749: 'chartoutputmode' => 'scalar',
8750: 'chartoutputdata' => 'scalar',
8751: 'Section' => 'array',
1.373 raeburn 8752: 'Group' => 'array',
1.153 matthew 8753: 'StudentData' => 'array',
8754: 'Maps' => 'array');
8755:
8756: Returns: both routines return nothing
8757:
1.631 raeburn 8758: =back
8759:
1.153 matthew 8760: =cut
8761:
8762: #######################################################
8763: #######################################################
8764: sub store_course_settings {
1.496 albertel 8765: return &store_settings($env{'request.course.id'},@_);
8766: }
8767:
8768: sub store_settings {
1.153 matthew 8769: # save to the environment
8770: # appenv the same items, just to be safe
1.300 albertel 8771: my $udom = $env{'user.domain'};
8772: my $uname = $env{'user.name'};
1.496 albertel 8773: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8774: my %SaveHash;
8775: my %AppHash;
8776: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8777: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8778: my $envname = 'environment.'.$basename;
1.258 albertel 8779: if (exists($env{'form.'.$setting})) {
1.153 matthew 8780: # Save this value away
8781: if ($type eq 'scalar' &&
1.258 albertel 8782: (! exists($env{$envname}) ||
8783: $env{$envname} ne $env{'form.'.$setting})) {
8784: $SaveHash{$basename} = $env{'form.'.$setting};
8785: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8786: } elsif ($type eq 'array') {
8787: my $stored_form;
1.258 albertel 8788: if (ref($env{'form.'.$setting})) {
1.153 matthew 8789: $stored_form = join(',',
8790: map {
1.369 www 8791: &escape($_);
1.258 albertel 8792: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8793: } else {
8794: $stored_form =
1.369 www 8795: &escape($env{'form.'.$setting});
1.153 matthew 8796: }
8797: # Determine if the array contents are the same.
1.258 albertel 8798: if ($stored_form ne $env{$envname}) {
1.153 matthew 8799: $SaveHash{$basename} = $stored_form;
8800: $AppHash{$envname} = $stored_form;
8801: }
8802: }
8803: }
8804: }
8805: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8806: $udom,$uname);
1.153 matthew 8807: if ($put_result !~ /^(ok|delayed)/) {
8808: &Apache::lonnet::logthis('unable to save form parameters, '.
8809: 'got error:'.$put_result);
8810: }
8811: # Make sure these settings stick around in this session, too
1.646 raeburn 8812: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8813: return;
8814: }
8815:
8816: sub restore_course_settings {
1.499 albertel 8817: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8818: }
8819:
8820: sub restore_settings {
8821: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8822: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8823: next if (exists($env{'form.'.$setting}));
1.496 albertel 8824: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8825: '.'.$setting;
1.258 albertel 8826: if (exists($env{$envname})) {
1.153 matthew 8827: if ($type eq 'scalar') {
1.258 albertel 8828: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8829: } elsif ($type eq 'array') {
1.258 albertel 8830: $env{'form.'.$setting} = [
1.153 matthew 8831: map {
1.369 www 8832: &unescape($_);
1.258 albertel 8833: } split(',',$env{$envname})
1.153 matthew 8834: ];
8835: }
8836: }
8837: }
1.127 matthew 8838: }
8839:
1.618 raeburn 8840: #######################################################
8841: #######################################################
8842:
8843: =pod
8844:
8845: =head1 Domain E-mail Routines
8846:
8847: =over 4
8848:
1.648 raeburn 8849: =item * &build_recipient_list()
1.618 raeburn 8850:
8851: Build recipient lists for three types of e-mail:
8852: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8853: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8854:
8855: Inputs:
1.619 raeburn 8856: defmail (scalar - email address of default recipient),
1.618 raeburn 8857: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8858: defdom (domain for which to retrieve configuration settings),
8859: origmail (scalar - email address of recipient from loncapa.conf,
8860: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8861:
1.655 raeburn 8862: Returns: comma separated list of addresses to which to send e-mail.
8863:
8864: =back
1.618 raeburn 8865:
8866: =cut
8867:
8868: ############################################################
8869: ############################################################
8870: sub build_recipient_list {
1.619 raeburn 8871: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8872: my @recipients;
8873: my $otheremails;
8874: my %domconfig =
8875: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8876: if (ref($domconfig{'contacts'}) eq 'HASH') {
8877: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8878: my @contacts = ('adminemail','supportemail');
8879: foreach my $item (@contacts) {
8880: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8881: my $addr = $domconfig{'contacts'}{$item};
8882: if (!grep(/^\Q$addr\E$/,@recipients)) {
8883: push(@recipients,$addr);
8884: }
1.618 raeburn 8885: }
8886: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8887: }
8888: }
1.619 raeburn 8889: } elsif ($origmail ne '') {
8890: push(@recipients,$origmail);
1.618 raeburn 8891: }
1.688 raeburn 8892: if (defined($defmail)) {
8893: if ($defmail ne '') {
8894: push(@recipients,$defmail);
8895: }
1.618 raeburn 8896: }
8897: if ($otheremails) {
1.619 raeburn 8898: my @others;
8899: if ($otheremails =~ /,/) {
8900: @others = split(/,/,$otheremails);
1.618 raeburn 8901: } else {
1.619 raeburn 8902: push(@others,$otheremails);
8903: }
8904: foreach my $addr (@others) {
8905: if (!grep(/^\Q$addr\E$/,@recipients)) {
8906: push(@recipients,$addr);
8907: }
1.618 raeburn 8908: }
8909: }
1.619 raeburn 8910: my $recipientlist = join(',',@recipients);
1.618 raeburn 8911: return $recipientlist;
8912: }
8913:
1.127 matthew 8914: ############################################################
8915: ############################################################
1.154 albertel 8916:
1.655 raeburn 8917: =pod
8918:
8919: =head1 Course Catalog Routines
8920:
8921: =over 4
8922:
8923: =item * &gather_categories()
8924:
8925: Converts category definitions - keys of categories hash stored in
8926: coursecategories in configuration.db on the primary library server in a
8927: domain - to an array. Also generates javascript and idx hash used to
8928: generate Domain Coordinator interface for editing Course Categories.
8929:
8930: Inputs:
1.663 raeburn 8931:
1.655 raeburn 8932: categories (reference to hash of category definitions).
1.663 raeburn 8933:
1.655 raeburn 8934: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8935: categories and subcategories).
1.663 raeburn 8936:
1.655 raeburn 8937: idx (reference to hash of counters used in Domain Coordinator interface for
8938: editing Course Categories).
1.663 raeburn 8939:
1.655 raeburn 8940: jsarray (reference to array of categories used to create Javascript arrays for
8941: Domain Coordinator interface for editing Course Categories).
8942:
8943: Returns: nothing
8944:
8945: Side effects: populates cats, idx and jsarray.
8946:
8947: =cut
8948:
8949: sub gather_categories {
8950: my ($categories,$cats,$idx,$jsarray) = @_;
8951: my %counters;
8952: my $num = 0;
8953: foreach my $item (keys(%{$categories})) {
8954: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8955: if ($container eq '' && $depth == 0) {
8956: $cats->[$depth][$categories->{$item}] = $cat;
8957: } else {
8958: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8959: }
8960: my ($escitem,$tail) = split(/:/,$item,2);
8961: if ($counters{$tail} eq '') {
8962: $counters{$tail} = $num;
8963: $num ++;
8964: }
8965: if (ref($idx) eq 'HASH') {
8966: $idx->{$item} = $counters{$tail};
8967: }
8968: if (ref($jsarray) eq 'ARRAY') {
8969: push(@{$jsarray->[$counters{$tail}]},$item);
8970: }
8971: }
8972: return;
8973: }
8974:
8975: =pod
8976:
8977: =item * &extract_categories()
8978:
8979: Used to generate breadcrumb trails for course categories.
8980:
8981: Inputs:
1.663 raeburn 8982:
1.655 raeburn 8983: categories (reference to hash of category definitions).
1.663 raeburn 8984:
1.655 raeburn 8985: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8986: categories and subcategories).
1.663 raeburn 8987:
1.655 raeburn 8988: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8989:
1.655 raeburn 8990: allitems (reference to hash - key is category key
8991: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8992:
1.655 raeburn 8993: idx (reference to hash of counters used in Domain Coordinator interface for
8994: editing Course Categories).
1.663 raeburn 8995:
1.655 raeburn 8996: jsarray (reference to array of categories used to create Javascript arrays for
8997: Domain Coordinator interface for editing Course Categories).
8998:
1.665 raeburn 8999: subcats (reference to hash of arrays containing all subcategories within each
9000: category, -recursive)
9001:
1.655 raeburn 9002: Returns: nothing
9003:
9004: Side effects: populates trails and allitems hash references.
9005:
9006: =cut
9007:
9008: sub extract_categories {
1.665 raeburn 9009: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9010: if (ref($categories) eq 'HASH') {
9011: &gather_categories($categories,$cats,$idx,$jsarray);
9012: if (ref($cats->[0]) eq 'ARRAY') {
9013: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9014: my $name = $cats->[0][$i];
9015: my $item = &escape($name).'::0';
9016: my $trailstr;
9017: if ($name eq 'instcode') {
9018: $trailstr = &mt('Official courses (with institutional codes)');
9019: } else {
9020: $trailstr = $name;
9021: }
9022: if ($allitems->{$item} eq '') {
9023: push(@{$trails},$trailstr);
9024: $allitems->{$item} = scalar(@{$trails})-1;
9025: }
9026: my @parents = ($name);
9027: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9028: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9029: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9030: if (ref($subcats) eq 'HASH') {
9031: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9032: }
9033: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9034: }
9035: } else {
9036: if (ref($subcats) eq 'HASH') {
9037: $subcats->{$item} = [];
1.655 raeburn 9038: }
9039: }
9040: }
9041: }
9042: }
9043: return;
9044: }
9045:
9046: =pod
9047:
9048: =item *&recurse_categories()
9049:
9050: Recursively used to generate breadcrumb trails for course categories.
9051:
9052: Inputs:
1.663 raeburn 9053:
1.655 raeburn 9054: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9055: categories and subcategories).
1.663 raeburn 9056:
1.655 raeburn 9057: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9058:
9059: category (current course category, for which breadcrumb trail is being generated).
9060:
9061: trails (reference to array of breadcrumb trails for each category).
9062:
1.655 raeburn 9063: allitems (reference to hash - key is category key
9064: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9065:
1.655 raeburn 9066: parents (array containing containers directories for current category,
9067: back to top level).
9068:
9069: Returns: nothing
9070:
9071: Side effects: populates trails and allitems hash references
9072:
9073: =cut
9074:
9075: sub recurse_categories {
1.665 raeburn 9076: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9077: my $shallower = $depth - 1;
9078: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9079: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9080: my $name = $cats->[$depth]{$category}[$k];
9081: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9082: my $trailstr = join(' -> ',(@{$parents},$category));
9083: if ($allitems->{$item} eq '') {
9084: push(@{$trails},$trailstr);
9085: $allitems->{$item} = scalar(@{$trails})-1;
9086: }
9087: my $deeper = $depth+1;
9088: push(@{$parents},$category);
1.665 raeburn 9089: if (ref($subcats) eq 'HASH') {
9090: my $subcat = &escape($name).':'.$category.':'.$depth;
9091: for (my $j=@{$parents}; $j>=0; $j--) {
9092: my $higher;
9093: if ($j > 0) {
9094: $higher = &escape($parents->[$j]).':'.
9095: &escape($parents->[$j-1]).':'.$j;
9096: } else {
9097: $higher = &escape($parents->[$j]).'::'.$j;
9098: }
9099: push(@{$subcats->{$higher}},$subcat);
9100: }
9101: }
9102: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9103: $subcats);
1.655 raeburn 9104: pop(@{$parents});
9105: }
9106: } else {
9107: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9108: my $trailstr = join(' -> ',(@{$parents},$category));
9109: if ($allitems->{$item} eq '') {
9110: push(@{$trails},$trailstr);
9111: $allitems->{$item} = scalar(@{$trails})-1;
9112: }
9113: }
9114: return;
9115: }
9116:
1.663 raeburn 9117: =pod
9118:
9119: =item *&assign_categories_table()
9120:
9121: Create a datatable for display of hierarchical categories in a domain,
9122: with checkboxes to allow a course to be categorized.
9123:
9124: Inputs:
9125:
9126: cathash - reference to hash of categories defined for the domain (from
9127: configuration.db)
9128:
9129: currcat - scalar with an & separated list of categories assigned to a course.
9130:
9131: Returns: $output (markup to be displayed)
9132:
9133: =cut
9134:
9135: sub assign_categories_table {
9136: my ($cathash,$currcat) = @_;
9137: my $output;
9138: if (ref($cathash) eq 'HASH') {
9139: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9140: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9141: $maxdepth = scalar(@cats);
9142: if (@cats > 0) {
9143: my $itemcount = 0;
9144: if (ref($cats[0]) eq 'ARRAY') {
9145: $output = &Apache::loncommon::start_data_table();
9146: my @currcategories;
9147: if ($currcat ne '') {
9148: @currcategories = split('&',$currcat);
9149: }
9150: for (my $i=0; $i<@{$cats[0]}; $i++) {
9151: my $parent = $cats[0][$i];
9152: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9153: next if ($parent eq 'instcode');
9154: my $item = &escape($parent).'::0';
9155: my $checked = '';
9156: if (@currcategories > 0) {
9157: if (grep(/^\Q$item\E$/,@currcategories)) {
9158: $checked = ' checked="checked" ';
9159: }
9160: }
1.675 raeburn 9161: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9162: '<input type="checkbox" name="usecategory" value="'.
9163: $item.'"'.$checked.' />'.$parent.'</span>'.
9164: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9165: my $depth = 1;
9166: push(@path,$parent);
9167: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9168: pop(@path);
9169: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9170: $itemcount ++;
9171: }
9172: $output .= &Apache::loncommon::end_data_table();
9173: }
9174: }
9175: }
9176: return $output;
9177: }
9178:
9179: =pod
9180:
9181: =item *&assign_category_rows()
9182:
9183: Create a datatable row for display of nested categories in a domain,
9184: with checkboxes to allow a course to be categorized,called recursively.
9185:
9186: Inputs:
9187:
9188: itemcount - track row number for alternating colors
9189:
9190: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9191: categories and subcategories.
9192:
9193: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9194:
9195: parent - parent of current category item
9196:
9197: path - Array containing all categories back up through the hierarchy from the
9198: current category to the top level.
9199:
9200: currcategories - reference to array of current categories assigned to the course
9201:
9202: Returns: $output (markup to be displayed).
9203:
9204: =cut
9205:
9206: sub assign_category_rows {
9207: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9208: my ($text,$name,$item,$chgstr);
9209: if (ref($cats) eq 'ARRAY') {
9210: my $maxdepth = scalar(@{$cats});
9211: if (ref($cats->[$depth]) eq 'HASH') {
9212: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9213: my $numchildren = @{$cats->[$depth]{$parent}};
9214: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9215: $text .= '<td><table class="LC_datatable">';
9216: for (my $j=0; $j<$numchildren; $j++) {
9217: $name = $cats->[$depth]{$parent}[$j];
9218: $item = &escape($name).':'.&escape($parent).':'.$depth;
9219: my $deeper = $depth+1;
9220: my $checked = '';
9221: if (ref($currcategories) eq 'ARRAY') {
9222: if (@{$currcategories} > 0) {
9223: if (grep(/^\Q$item\E$/,@{$currcategories})) {
9224: $checked = ' checked="checked" ';
9225: }
9226: }
9227: }
1.664 raeburn 9228: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9229: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9230: $item.'"'.$checked.' />'.$name.'</label></span>'.
9231: '<input type="hidden" name="catname" value="'.$name.'" />'.
9232: '</td><td>';
1.663 raeburn 9233: if (ref($path) eq 'ARRAY') {
9234: push(@{$path},$name);
9235: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9236: pop(@{$path});
9237: }
9238: $text .= '</td></tr>';
9239: }
9240: $text .= '</table></td>';
9241: }
9242: }
9243: }
9244: return $text;
9245: }
9246:
1.655 raeburn 9247: ############################################################
9248: ############################################################
9249:
9250:
1.443 albertel 9251: sub commit_customrole {
1.664 raeburn 9252: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9253: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9254: ($start?', '.&mt('starting').' '.localtime($start):'').
9255: ($end?', ending '.localtime($end):'').': <b>'.
9256: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9257: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9258: '</b><br />';
9259: return $output;
9260: }
9261:
9262: sub commit_standardrole {
1.541 raeburn 9263: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9264: my ($output,$logmsg,$linefeed);
9265: if ($context eq 'auto') {
9266: $linefeed = "\n";
9267: } else {
9268: $linefeed = "<br />\n";
9269: }
1.443 albertel 9270: if ($three eq 'st') {
1.541 raeburn 9271: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9272: $one,$two,$sec,$context);
9273: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9274: ($result eq 'unknown_course') || ($result eq 'refused')) {
9275: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9276: } else {
1.541 raeburn 9277: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9278: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9279: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9280: if ($context eq 'auto') {
9281: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9282: } else {
9283: $output .= '<b>'.$result.'</b>'.$linefeed.
9284: &mt('Add to classlist').': <b>ok</b>';
9285: }
9286: $output .= $linefeed;
1.443 albertel 9287: }
9288: } else {
9289: $output = &mt('Assigning').' '.$three.' in '.$url.
9290: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9291: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9292: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9293: if ($context eq 'auto') {
9294: $output .= $result.$linefeed;
9295: } else {
9296: $output .= '<b>'.$result.'</b>'.$linefeed;
9297: }
1.443 albertel 9298: }
9299: return $output;
9300: }
9301:
9302: sub commit_studentrole {
1.541 raeburn 9303: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9304: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9305: if ($context eq 'auto') {
9306: $linefeed = "\n";
9307: } else {
9308: $linefeed = '<br />'."\n";
9309: }
1.443 albertel 9310: if (defined($one) && defined($two)) {
9311: my $cid=$one.'_'.$two;
9312: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9313: my $secchange = 0;
9314: my $expire_role_result;
9315: my $modify_section_result;
1.628 raeburn 9316: if ($oldsec ne '-1') {
9317: if ($oldsec ne $sec) {
1.443 albertel 9318: $secchange = 1;
1.628 raeburn 9319: my $now = time;
1.443 albertel 9320: my $uurl='/'.$cid;
9321: $uurl=~s/\_/\//g;
9322: if ($oldsec) {
9323: $uurl.='/'.$oldsec;
9324: }
1.626 raeburn 9325: $oldsecurl = $uurl;
1.628 raeburn 9326: $expire_role_result =
1.652 raeburn 9327: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9328: if ($env{'request.course.sec'} ne '') {
9329: if ($expire_role_result eq 'refused') {
9330: my @roles = ('st');
9331: my @statuses = ('previous');
9332: my @roledoms = ($one);
9333: my $withsec = 1;
9334: my %roleshash =
9335: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9336: \@statuses,\@roles,\@roledoms,$withsec);
9337: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9338: my ($oldstart,$oldend) =
9339: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9340: if ($oldend > 0 && $oldend <= $now) {
9341: $expire_role_result = 'ok';
9342: }
9343: }
9344: }
9345: }
1.443 albertel 9346: $result = $expire_role_result;
9347: }
9348: }
9349: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9350: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9351: if ($modify_section_result =~ /^ok/) {
9352: if ($secchange == 1) {
1.628 raeburn 9353: if ($sec eq '') {
9354: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9355: } else {
9356: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9357: }
1.443 albertel 9358: } elsif ($oldsec eq '-1') {
1.628 raeburn 9359: if ($sec eq '') {
9360: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9361: } else {
9362: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9363: }
1.443 albertel 9364: } else {
1.628 raeburn 9365: if ($sec eq '') {
9366: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9367: } else {
9368: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9369: }
1.443 albertel 9370: }
9371: } else {
1.628 raeburn 9372: if ($secchange) {
9373: $$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;
9374: } else {
9375: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9376: }
1.443 albertel 9377: }
9378: $result = $modify_section_result;
9379: } elsif ($secchange == 1) {
1.628 raeburn 9380: if ($oldsec eq '') {
9381: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9382: } else {
9383: $$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;
9384: }
1.626 raeburn 9385: if ($expire_role_result eq 'refused') {
9386: my $newsecurl = '/'.$cid;
9387: $newsecurl =~ s/\_/\//g;
9388: if ($sec ne '') {
9389: $newsecurl.='/'.$sec;
9390: }
9391: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9392: if ($sec eq '') {
9393: $$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;
9394: } else {
9395: $$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;
9396: }
9397: }
9398: }
1.443 albertel 9399: }
9400: } else {
1.626 raeburn 9401: $$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 9402: $result = "error: incomplete course id\n";
9403: }
9404: return $result;
9405: }
9406:
9407: ############################################################
9408: ############################################################
9409:
1.566 albertel 9410: sub check_clone {
1.578 raeburn 9411: my ($args,$linefeed) = @_;
1.566 albertel 9412: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9413: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9414: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9415: my $clonemsg;
9416: my $can_clone = 0;
9417:
9418: if ($clonehome eq 'no_host') {
1.578 raeburn 9419: $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 9420: } else {
9421: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9422: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9423: $can_clone = 1;
9424: } else {
9425: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9426: $args->{'clonedomain'},$args->{'clonecourse'});
9427: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9428: if (grep(/^\*$/,@cloners)) {
9429: $can_clone = 1;
9430: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9431: $can_clone = 1;
9432: } else {
9433: my %roleshash =
9434: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9435: $args->{'ccdomain'},
9436: 'userroles',['active'],['cc'],
9437: [$args->{'clonedomain'}]);
9438: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9439: $can_clone = 1;
9440: } else {
9441: $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'});
9442: }
1.566 albertel 9443: }
1.578 raeburn 9444: }
1.566 albertel 9445: }
9446: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9447: }
9448:
1.444 albertel 9449: sub construct_course {
1.541 raeburn 9450: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9451: my $outcome;
1.541 raeburn 9452: my $linefeed = '<br />'."\n";
9453: if ($context eq 'auto') {
9454: $linefeed = "\n";
9455: }
1.566 albertel 9456:
9457: #
9458: # Are we cloning?
9459: #
9460: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9461: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9462: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9463: if ($context ne 'auto') {
1.578 raeburn 9464: if ($clonemsg ne '') {
9465: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9466: }
1.566 albertel 9467: }
9468: $outcome .= $clonemsg.$linefeed;
9469:
9470: if (!$can_clone) {
9471: return (0,$outcome);
9472: }
9473: }
9474:
1.444 albertel 9475: #
9476: # Open course
9477: #
9478: my $crstype = lc($args->{'crstype'});
9479: my %cenv=();
9480: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9481: $args->{'cdescr'},
9482: $args->{'curl'},
9483: $args->{'course_home'},
9484: $args->{'nonstandard'},
9485: $args->{'crscode'},
9486: $args->{'ccuname'}.':'.
9487: $args->{'ccdomain'},
9488: $args->{'crstype'});
9489:
9490: # Note: The testing routines depend on this being output; see
9491: # Utils::Course. This needs to at least be output as a comment
9492: # if anyone ever decides to not show this, and Utils::Course::new
9493: # will need to be suitably modified.
1.541 raeburn 9494: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9495: #
9496: # Check if created correctly
9497: #
1.479 albertel 9498: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9499: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9500: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9501:
1.444 albertel 9502: #
1.566 albertel 9503: # Do the cloning
9504: #
9505: if ($can_clone && $cloneid) {
9506: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9507: if ($context ne 'auto') {
9508: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9509: }
9510: $outcome .= $clonemsg.$linefeed;
9511: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9512: # Copy all files
1.637 www 9513: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9514: # Restore URL
1.566 albertel 9515: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9516: # Restore title
1.566 albertel 9517: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9518: # Mark as cloned
1.566 albertel 9519: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9520: # Need to clone grading mode
9521: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9522: $cenv{'grading'}=$newenv{'grading'};
9523: # Do not clone these environment entries
9524: &Apache::lonnet::del('environment',
9525: ['default_enrollment_start_date',
9526: 'default_enrollment_end_date',
9527: 'question.email',
9528: 'policy.email',
9529: 'comment.email',
9530: 'pch.users.denied',
1.725 raeburn 9531: 'plc.users.denied',
9532: 'hidefromcat',
9533: 'categories'],
1.638 www 9534: $$crsudom,$$crsunum);
1.444 albertel 9535: }
1.566 albertel 9536:
1.444 albertel 9537: #
9538: # Set environment (will override cloned, if existing)
9539: #
9540: my @sections = ();
9541: my @xlists = ();
9542: if ($args->{'crstype'}) {
9543: $cenv{'type'}=$args->{'crstype'};
9544: }
9545: if ($args->{'crsid'}) {
9546: $cenv{'courseid'}=$args->{'crsid'};
9547: }
9548: if ($args->{'crscode'}) {
9549: $cenv{'internal.coursecode'}=$args->{'crscode'};
9550: }
9551: if ($args->{'crsquota'} ne '') {
9552: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9553: } else {
9554: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9555: }
9556: if ($args->{'ccuname'}) {
9557: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9558: ':'.$args->{'ccdomain'};
9559: } else {
9560: $cenv{'internal.courseowner'} = $args->{'curruser'};
9561: }
9562: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9563: if ($args->{'crssections'}) {
9564: $cenv{'internal.sectionnums'} = '';
9565: if ($args->{'crssections'} =~ m/,/) {
9566: @sections = split/,/,$args->{'crssections'};
9567: } else {
9568: $sections[0] = $args->{'crssections'};
9569: }
9570: if (@sections > 0) {
9571: foreach my $item (@sections) {
9572: my ($sec,$gp) = split/:/,$item;
9573: my $class = $args->{'crscode'}.$sec;
9574: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9575: $cenv{'internal.sectionnums'} .= $item.',';
9576: unless ($addcheck eq 'ok') {
9577: push @badclasses, $class;
9578: }
9579: }
9580: $cenv{'internal.sectionnums'} =~ s/,$//;
9581: }
9582: }
9583: # do not hide course coordinator from staff listing,
9584: # even if privileged
9585: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9586: # add crosslistings
9587: if ($args->{'crsxlist'}) {
9588: $cenv{'internal.crosslistings'}='';
9589: if ($args->{'crsxlist'} =~ m/,/) {
9590: @xlists = split/,/,$args->{'crsxlist'};
9591: } else {
9592: $xlists[0] = $args->{'crsxlist'};
9593: }
9594: if (@xlists > 0) {
9595: foreach my $item (@xlists) {
9596: my ($xl,$gp) = split/:/,$item;
9597: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9598: $cenv{'internal.crosslistings'} .= $item.',';
9599: unless ($addcheck eq 'ok') {
9600: push @badclasses, $xl;
9601: }
9602: }
9603: $cenv{'internal.crosslistings'} =~ s/,$//;
9604: }
9605: }
9606: if ($args->{'autoadds'}) {
9607: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9608: }
9609: if ($args->{'autodrops'}) {
9610: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9611: }
9612: # check for notification of enrollment changes
9613: my @notified = ();
9614: if ($args->{'notify_owner'}) {
9615: if ($args->{'ccuname'} ne '') {
9616: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9617: }
9618: }
9619: if ($args->{'notify_dc'}) {
9620: if ($uname ne '') {
1.630 raeburn 9621: push(@notified,$uname.':'.$udom);
1.444 albertel 9622: }
9623: }
9624: if (@notified > 0) {
9625: my $notifylist;
9626: if (@notified > 1) {
9627: $notifylist = join(',',@notified);
9628: } else {
9629: $notifylist = $notified[0];
9630: }
9631: $cenv{'internal.notifylist'} = $notifylist;
9632: }
9633: if (@badclasses > 0) {
9634: my %lt=&Apache::lonlocal::texthash(
9635: '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',
9636: 'dnhr' => 'does not have rights to access enrollment in these classes',
9637: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9638: );
1.541 raeburn 9639: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9640: ' ('.$lt{'adby'}.')';
9641: if ($context eq 'auto') {
9642: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9643: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9644: foreach my $item (@badclasses) {
9645: if ($context eq 'auto') {
9646: $outcome .= " - $item\n";
9647: } else {
9648: $outcome .= "<li>$item</li>\n";
9649: }
9650: }
9651: if ($context eq 'auto') {
9652: $outcome .= $linefeed;
9653: } else {
1.566 albertel 9654: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9655: }
9656: }
1.444 albertel 9657: }
9658: if ($args->{'no_end_date'}) {
9659: $args->{'endaccess'} = 0;
9660: }
9661: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9662: $cenv{'internal.autoend'}=$args->{'enrollend'};
9663: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9664: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9665: if ($args->{'showphotos'}) {
9666: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9667: }
9668: $cenv{'internal.authtype'} = $args->{'authtype'};
9669: $cenv{'internal.autharg'} = $args->{'autharg'};
9670: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9671: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9672: 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');
9673: if ($context eq 'auto') {
9674: $outcome .= $krb_msg;
9675: } else {
1.566 albertel 9676: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9677: }
9678: $outcome .= $linefeed;
1.444 albertel 9679: }
9680: }
9681: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9682: if ($args->{'setpolicy'}) {
9683: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9684: }
9685: if ($args->{'setcontent'}) {
9686: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9687: }
9688: }
9689: if ($args->{'reshome'}) {
9690: $cenv{'reshome'}=$args->{'reshome'}.'/';
9691: $cenv{'reshome'}=~s/\/+$/\//;
9692: }
9693: #
9694: # course has keyed access
9695: #
9696: if ($args->{'setkeys'}) {
9697: $cenv{'keyaccess'}='yes';
9698: }
9699: # if specified, key authority is not course, but user
9700: # only active if keyaccess is yes
9701: if ($args->{'keyauth'}) {
1.487 albertel 9702: my ($user,$domain) = split(':',$args->{'keyauth'});
9703: $user = &LONCAPA::clean_username($user);
9704: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9705: if ($user ne '' && $domain ne '') {
1.487 albertel 9706: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9707: }
9708: }
9709:
9710: if ($args->{'disresdis'}) {
9711: $cenv{'pch.roles.denied'}='st';
9712: }
9713: if ($args->{'disablechat'}) {
9714: $cenv{'plc.roles.denied'}='st';
9715: }
9716:
9717: # Record we've not yet viewed the Course Initialization Helper for this
9718: # course
9719: $cenv{'course.helper.not.run'} = 1;
9720: #
9721: # Use new Randomseed
9722: #
9723: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9724: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9725: #
9726: # The encryption code and receipt prefix for this course
9727: #
9728: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9729: $cenv{'internal.encpref'}=100+int(9*rand(99));
9730: #
9731: # By default, use standard grading
9732: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9733:
1.541 raeburn 9734: $outcome .= $linefeed.&mt('Setting environment').': '.
9735: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9736: #
9737: # Open all assignments
9738: #
9739: if ($args->{'openall'}) {
9740: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9741: my %storecontent = ($storeunder => time,
9742: $storeunder.'.type' => 'date_start');
9743:
9744: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9745: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9746: }
9747: #
9748: # Set first page
9749: #
9750: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9751: || ($cloneid)) {
1.445 albertel 9752: use LONCAPA::map;
1.444 albertel 9753: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9754:
9755: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9756: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9757:
1.444 albertel 9758: $outcome .= ($fatal?$errtext:'read ok').' - ';
9759: my $title; my $url;
9760: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9761: $title=&mt('Syllabus');
1.444 albertel 9762: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9763: } else {
1.690 bisitz 9764: $title=&mt('Navigate Contents');
1.444 albertel 9765: $url='/adm/navmaps';
9766: }
1.445 albertel 9767:
9768: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9769: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9770:
9771: if ($errtext) { $fatal=2; }
1.541 raeburn 9772: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9773: }
1.566 albertel 9774:
9775: return (1,$outcome);
1.444 albertel 9776: }
9777:
9778: ############################################################
9779: ############################################################
9780:
1.378 raeburn 9781: sub course_type {
9782: my ($cid) = @_;
9783: if (!defined($cid)) {
9784: $cid = $env{'request.course.id'};
9785: }
1.404 albertel 9786: if (defined($env{'course.'.$cid.'.type'})) {
9787: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9788: } else {
9789: return 'Course';
1.377 raeburn 9790: }
9791: }
1.156 albertel 9792:
1.406 raeburn 9793: sub group_term {
9794: my $crstype = &course_type();
9795: my %names = (
9796: 'Course' => 'group',
9797: 'Group' => 'team',
9798: );
9799: return $names{$crstype};
9800: }
9801:
1.156 albertel 9802: sub icon {
9803: my ($file)=@_;
1.505 albertel 9804: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9805: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9806: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9807: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9808: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9809: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9810: $curfext.".gif") {
9811: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9812: $curfext.".gif";
9813: }
9814: }
1.249 albertel 9815: return &lonhttpdurl($iconname);
1.154 albertel 9816: }
1.84 albertel 9817:
1.575 albertel 9818: sub lonhttpdurl {
1.692 www 9819: #
9820: # Had been used for "small fry" static images on separate port 8080.
9821: # Modify here if lightweight http functionality desired again.
9822: # Currently eliminated due to increasing firewall issues.
9823: #
1.575 albertel 9824: my ($url)=@_;
1.692 www 9825: return $url;
1.215 albertel 9826: }
9827:
1.213 albertel 9828: sub connection_aborted {
9829: my ($r)=@_;
9830: $r->print(" ");$r->rflush();
9831: my $c = $r->connection;
9832: return $c->aborted();
9833: }
9834:
1.221 foxr 9835: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9836: # strings as 'strings'.
9837: sub escape_single {
1.221 foxr 9838: my ($input) = @_;
1.223 albertel 9839: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9840: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9841: return $input;
9842: }
1.223 albertel 9843:
1.222 foxr 9844: # Same as escape_single, but escape's "'s This
9845: # can be used for "strings"
9846: sub escape_double {
9847: my ($input) = @_;
9848: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9849: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9850: return $input;
9851: }
1.223 albertel 9852:
1.222 foxr 9853: # Escapes the last element of a full URL.
9854: sub escape_url {
9855: my ($url) = @_;
1.238 raeburn 9856: my @urlslices = split(/\//, $url,-1);
1.369 www 9857: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9858: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9859: }
1.462 albertel 9860:
9861: # -------------------------------------------------------- Initliaze user login
9862: sub init_user_environment {
1.463 albertel 9863: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9864: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9865:
9866: my $public=($username eq 'public' && $domain eq 'public');
9867:
9868: # See if old ID present, if so, remove
9869:
9870: my ($filename,$cookie,$userroles);
9871: my $now=time;
9872:
9873: if ($public) {
9874: my $max_public=100;
9875: my $oldest;
9876: my $oldest_time=0;
9877: for(my $next=1;$next<=$max_public;$next++) {
9878: if (-e $lonids."/publicuser_$next.id") {
9879: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9880: if ($mtime<$oldest_time || !$oldest_time) {
9881: $oldest_time=$mtime;
9882: $oldest=$next;
9883: }
9884: } else {
9885: $cookie="publicuser_$next";
9886: last;
9887: }
9888: }
9889: if (!$cookie) { $cookie="publicuser_$oldest"; }
9890: } else {
1.463 albertel 9891: # if this isn't a robot, kill any existing non-robot sessions
9892: if (!$args->{'robot'}) {
9893: opendir(DIR,$lonids);
9894: while ($filename=readdir(DIR)) {
9895: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9896: unlink($lonids.'/'.$filename);
9897: }
1.462 albertel 9898: }
1.463 albertel 9899: closedir(DIR);
1.462 albertel 9900: }
9901: # Give them a new cookie
1.463 albertel 9902: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9903: : $now.$$.int(rand(10000)));
1.463 albertel 9904: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9905:
9906: # Initialize roles
9907:
9908: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9909: }
9910: # ------------------------------------ Check browser type and MathML capability
9911:
9912: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9913: $clientunicode,$clientos) = &decode_user_agent($r);
9914:
9915: # -------------------------------------- Any accessibility options to remember?
9916: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9917: foreach my $option ('imagesuppress','appletsuppress',
9918: 'embedsuppress','fontenhance','blackwhite') {
9919: if ($form->{$option} eq 'true') {
9920: &Apache::lonnet::put('environment',{$option => 'on'},
9921: $domain,$username);
9922: } else {
9923: &Apache::lonnet::del('environment',[$option],
9924: $domain,$username);
9925: }
9926: }
9927: }
9928: # ------------------------------------------------------------- Get environment
9929:
9930: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9931: my ($tmp) = keys(%userenv);
9932: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9933: # default remote control to off
9934: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9935: } else {
9936: undef(%userenv);
9937: }
9938: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9939: $form->{'interface'}=$userenv{'interface'};
9940: }
9941: $env{'environment.remote'}=$userenv{'remote'};
9942: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9943:
9944: # --------------- Do not trust query string to be put directly into environment
9945: foreach my $option ('imagesuppress','appletsuppress',
9946: 'embedsuppress','fontenhance','blackwhite',
9947: 'interface','localpath','localres') {
9948: $form->{$option}=~s/[\n\r\=]//gs;
9949: }
9950: # --------------------------------------------------------- Write first profile
9951:
9952: {
9953: my %initial_env =
9954: ("user.name" => $username,
9955: "user.domain" => $domain,
9956: "user.home" => $authhost,
9957: "browser.type" => $clientbrowser,
9958: "browser.version" => $clientversion,
9959: "browser.mathml" => $clientmathml,
9960: "browser.unicode" => $clientunicode,
9961: "browser.os" => $clientos,
9962: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9963: "request.course.fn" => '',
9964: "request.course.uri" => '',
9965: "request.course.sec" => '',
9966: "request.role" => 'cm',
9967: "request.role.adv" => $env{'user.adv'},
9968: "request.host" => $ENV{'REMOTE_ADDR'},);
9969:
9970: if ($form->{'localpath'}) {
9971: $initial_env{"browser.localpath"} = $form->{'localpath'};
9972: $initial_env{"browser.localres"} = $form->{'localres'};
9973: }
9974:
9975: if ($public) {
9976: $initial_env{"environment.remote"} = "off";
9977: }
9978: if ($form->{'interface'}) {
9979: $form->{'interface'}=~s/\W//gs;
9980: $initial_env{"browser.interface"} = $form->{'interface'};
9981: $env{'browser.interface'}=$form->{'interface'};
9982: foreach my $option ('imagesuppress','appletsuppress',
9983: 'embedsuppress','fontenhance','blackwhite') {
9984: if (($form->{$option} eq 'true') ||
9985: ($userenv{$option} eq 'on')) {
9986: $initial_env{"browser.$option"} = "on";
9987: }
9988: }
9989: }
9990:
1.724 raeburn 9991: foreach my $tool ('aboutme','blog','portfolio') {
9992: $userenv{'availabletools.'.$tool} =
9993: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
9994: }
9995:
1.462 albertel 9996: $env{'user.environment'} = "$lonids/$cookie.id";
9997:
9998: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9999: &GDBM_WRCREAT(),0640)) {
10000: &_add_to_env(\%disk_env,\%initial_env);
10001: &_add_to_env(\%disk_env,\%userenv,'environment.');
10002: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10003: if (ref($args->{'extra_env'})) {
10004: &_add_to_env(\%disk_env,$args->{'extra_env'});
10005: }
1.462 albertel 10006: untie(%disk_env);
10007: } else {
1.705 tempelho 10008: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10009: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10010: return 'error: '.$!;
10011: }
10012: }
10013: $env{'request.role'}='cm';
10014: $env{'request.role.adv'}=$env{'user.adv'};
10015: $env{'browser.type'}=$clientbrowser;
10016:
10017: return $cookie;
10018:
10019: }
10020:
10021: sub _add_to_env {
10022: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10023: if (ref($env_data) eq 'HASH') {
10024: while (my ($key,$value) = each(%$env_data)) {
10025: $idf->{$prefix.$key} = $value;
10026: $env{$prefix.$key} = $value;
10027: }
1.462 albertel 10028: }
10029: }
10030:
1.685 tempelho 10031: # --- Get the symbolic name of a problem and the url
10032: sub get_symb {
10033: my ($request,$silent) = @_;
1.726 raeburn 10034: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10035: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10036: if ($symb eq '') {
10037: if (!$silent) {
10038: $request->print("Unable to handle ambiguous references:$url:.");
10039: return ();
10040: }
10041: }
10042: &Apache::lonenc::check_decrypt(\$symb);
10043: return ($symb);
10044: }
10045:
10046: # --------------------------------------------------------------Get annotation
10047:
10048: sub get_annotation {
10049: my ($symb,$enc) = @_;
10050:
10051: my $key = $symb;
10052: if (!$enc) {
10053: $key =
10054: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10055: }
10056: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10057: return $annotation{$key};
10058: }
10059:
10060: sub clean_symb {
1.731 raeburn 10061: my ($symb,$delete_enc) = @_;
1.685 tempelho 10062:
10063: &Apache::lonenc::check_decrypt(\$symb);
10064: my $enc = $env{'request.enc'};
1.731 raeburn 10065: if ($delete_enc) {
1.730 raeburn 10066: delete($env{'request.enc'});
10067: }
1.685 tempelho 10068:
10069: return ($symb,$enc);
10070: }
1.462 albertel 10071:
1.41 ng 10072: =pod
10073:
10074: =back
10075:
1.112 bowersj2 10076: =cut
1.41 ng 10077:
1.112 bowersj2 10078: 1;
10079: __END__;
1.41 ng 10080:
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