Annotation of loncom/interface/loncommon.pm, revision 1.779
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.779 ! bisitz 4: # $Id: loncommon.pm,v 1.778 2009/03/26 14:42:40 bisitz Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.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');
1.776 bisitz 409: <script type="text/javascript" language="Javascript">
1.74 www 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";
1.776 bisitz 455: <script type="text/javascript" language="JavaScript">
1.653 raeburn 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.776 bisitz 476: <script type="text/javascript" language="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.776 bisitz 799: $result.='<script type="text/javascript" language="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 "") {
1.763 bisitz 927: $template.='<span class="LC_help_open_topic">'
928: .'<a target="_top" href="'.$link.'">'
929: .$text.'</a>';
1.48 bowersj2 930: }
931:
1.763 bisitz 932: # (Always) Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.763 bisitz 935: $template.=' <a target="_top" href="'.$link.'" title="'.$title.'">'
936: .'<img src="'.$helpicon.'" border="0"'
937: .' alt="'.&mt('Help: [_1]',$topic).'"'
938: .' title="'.$title.'"'
939: .' /></a>';
940: if ($text ne "") {
941: $template.='</span>';
942: }
1.44 bowersj2 943: return $template;
944:
1.106 bowersj2 945: }
946:
947: # This is a quicky function for Latex cheatsheet editing, since it
948: # appears in at least four places
949: sub helpLatexCheatsheet {
1.732 raeburn 950: my ($topic,$text,$not_author) = @_;
951: my $out;
1.106 bowersj2 952: my $addOther = '';
1.732 raeburn 953: if ($topic) {
1.763 bisitz 954: $addOther = '<span>'.&Apache::loncommon::help_open_topic($topic,&mt($text),
955: undef, undef, 600).
956: '</span> ';
957: }
958: $out = '<span>' # Start cheatsheet
959: .$addOther
960: .'<span>'
961: .&Apache::loncommon::help_open_topic('Greek_Symbols',&mt('Greek Symbols'),
962: undef,undef,600)
963: .'</span> <span>'
964: .&Apache::loncommon::help_open_topic('Other_Symbols',&mt('Other Symbols'),
965: undef,undef,600)
966: .'</span>';
1.732 raeburn 967: unless ($not_author) {
1.763 bisitz 968: $out .= ' <span>'
969: .&Apache::loncommon::help_open_topic('Authoring_Output_Tags',&mt('Output Tags'),
970: undef,undef,600)
971: .'</span>';
1.732 raeburn 972: }
1.763 bisitz 973: $out .= '</span>'; # End cheatsheet
1.732 raeburn 974: return $out;
1.172 www 975: }
976:
1.430 albertel 977: sub general_help {
978: my $helptopic='Student_Intro';
979: if ($env{'request.role'}=~/^(ca|au)/) {
980: $helptopic='Authoring_Intro';
981: } elsif ($env{'request.role'}=~/^cc/) {
982: $helptopic='Course_Coordination_Intro';
1.672 raeburn 983: } elsif ($env{'request.role'}=~/^dc/) {
984: $helptopic='Domain_Coordination_Intro';
1.430 albertel 985: }
986: return $helptopic;
987: }
988:
989: sub update_help_link {
990: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
991: my $origurl = $ENV{'REQUEST_URI'};
992: $origurl=~s|^/~|/priv/|;
993: my $timestamp = time;
994: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
995: $$datum = &escape($$datum);
996: }
997:
998: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
999: my $output .= <<"ENDOUTPUT";
1000: <script type="text/javascript">
1001: banner_link = '$banner_link';
1002: </script>
1003: ENDOUTPUT
1004: return $output;
1005: }
1006:
1007: # now just updates the help link and generates a blue icon
1.193 raeburn 1008: sub help_open_menu {
1.430 albertel 1009: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 1010: = @_;
1.430 albertel 1011: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1012: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1013: # if environment.remote is on (using remote control UI)
1.572 banghart 1014: if ($env{'browser.interface'} eq 'textual' ||
1015: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1016: $stayOnPage=1;
1.430 albertel 1017: }
1018: my $output;
1019: if ($component_help) {
1020: if (!$text) {
1021: $output=&help_open_topic($component_help,undef,$stayOnPage,
1022: $width,$height);
1023: } else {
1024: my $help_text;
1025: $help_text=&unescape($topic);
1026: $output='<table><tr><td>'.
1027: &help_open_topic($component_help,$help_text,$stayOnPage,
1028: $width,$height).'</td></tr></table>';
1029: }
1030: }
1031: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1032: return $output.$banner_link;
1033: }
1034:
1035: sub top_nav_help {
1036: my ($text) = @_;
1.436 albertel 1037: $text = &mt($text);
1.572 banghart 1038: my $stay_on_page =
1.436 albertel 1039: ($env{'browser.interface'} eq 'textual' ||
1040: $env{'environment.remote'} eq 'off' );
1.572 banghart 1041: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1042: : "javascript:helpMenu('open')";
1.572 banghart 1043: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1044:
1.201 raeburn 1045: my $title = &mt('Get help');
1.436 albertel 1046:
1047: return <<"END";
1048: $banner_link
1049: <a href="$link" title="$title">$text</a>
1050: END
1051: }
1052:
1053: sub help_menu_js {
1054: my ($text) = @_;
1055:
1056: my $stayOnPage =
1057: ($env{'browser.interface'} eq 'textual' ||
1058: $env{'environment.remote'} eq 'off' );
1059:
1060: my $width = 620;
1061: my $height = 600;
1.430 albertel 1062: my $helptopic=&general_help();
1063: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1064: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1065: my $start_page =
1066: &Apache::loncommon::start_page('Help Menu', undef,
1067: {'frameset' => 1,
1068: 'js_ready' => 1,
1069: 'add_entries' => {
1070: 'border' => '0',
1.579 raeburn 1071: 'rows' => "110,*",},});
1.331 albertel 1072: my $end_page =
1073: &Apache::loncommon::end_page({'frameset' => 1,
1074: 'js_ready' => 1,});
1075:
1.436 albertel 1076: my $template .= <<"ENDTEMPLATE";
1077: <script type="text/javascript">
1.253 albertel 1078: // <!-- BEGIN LON-CAPA Internal
1079: // <![CDATA[
1.430 albertel 1080: var banner_link = '';
1.243 raeburn 1081: function helpMenu(target) {
1082: var caller = this;
1083: if (target == 'open') {
1084: var newWindow = null;
1085: try {
1.262 albertel 1086: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1087: }
1088: catch(error) {
1089: writeHelp(caller);
1090: return;
1091: }
1092: if (newWindow) {
1093: caller = newWindow;
1094: }
1.193 raeburn 1095: }
1.243 raeburn 1096: writeHelp(caller);
1097: return;
1098: }
1099: function writeHelp(caller) {
1.430 albertel 1100: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1101: caller.document.close()
1102: caller.focus()
1.193 raeburn 1103: }
1.253 albertel 1104: // ]]>
1.219 albertel 1105: // END LON-CAPA Internal -->
1.436 albertel 1106: </script>
1.193 raeburn 1107: ENDTEMPLATE
1108: return $template;
1109: }
1110:
1.172 www 1111: sub help_open_bug {
1112: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1113: unless ($env{'user.adv'}) { return ''; }
1.172 www 1114: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1115: $text = "" if (not defined $text);
1116: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1117: if ($env{'browser.interface'} eq 'textual' ||
1118: $env{'environment.remote'} eq 'off' ) {
1.172 www 1119: $stayOnPage=1;
1120: }
1.184 albertel 1121: $width = 600 if (not defined $width);
1122: $height = 600 if (not defined $height);
1.172 www 1123:
1124: $topic=~s/\W+/\+/g;
1125: my $link='';
1126: my $template='';
1.379 albertel 1127: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1128: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1129: if (!$stayOnPage)
1130: {
1131: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1132: }
1133: else
1134: {
1135: $link = $url;
1136: }
1137: # Add the text
1138: if ($text ne "")
1139: {
1140: $template .=
1141: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1142: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF;font-size:10pt;\">$text</span></a>";
1.172 www 1143: }
1144:
1145: # Add the graphic
1.179 matthew 1146: my $title = &mt('Report a Bug');
1.215 albertel 1147: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1148: $template .= <<"ENDTEMPLATE";
1.436 albertel 1149: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1150: ENDTEMPLATE
1151: if ($text ne '') { $template.='</td></tr></table>' };
1152: return $template;
1153:
1154: }
1155:
1156: sub help_open_faq {
1157: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1158: unless ($env{'user.adv'}) { return ''; }
1.172 www 1159: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1160: $text = "" if (not defined $text);
1161: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1162: if ($env{'browser.interface'} eq 'textual' ||
1163: $env{'environment.remote'} eq 'off' ) {
1.172 www 1164: $stayOnPage=1;
1165: }
1166: $width = 350 if (not defined $width);
1167: $height = 400 if (not defined $height);
1168:
1169: $topic=~s/\W+/\+/g;
1170: my $link='';
1171: my $template='';
1172: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1173: if (!$stayOnPage)
1174: {
1175: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1176: }
1177: else
1178: {
1179: $link = $url;
1180: }
1181:
1182: # Add the text
1183: if ($text ne "")
1184: {
1185: $template .=
1.173 www 1186: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.705 tempelho 1187: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><span style=\"color:#FFFFFF; font-size:10pt;\">$text</span></a>";
1.172 www 1188: }
1189:
1190: # Add the graphic
1.179 matthew 1191: my $title = &mt('View the FAQ');
1.215 albertel 1192: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1193: $template .= <<"ENDTEMPLATE";
1.436 albertel 1194: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1195: ENDTEMPLATE
1196: if ($text ne '') { $template.='</td></tr></table>' };
1197: return $template;
1198:
1.44 bowersj2 1199: }
1.37 matthew 1200:
1.180 matthew 1201: ###############################################################
1202: ###############################################################
1203:
1.45 matthew 1204: =pod
1205:
1.648 raeburn 1206: =item * &change_content_javascript():
1.256 matthew 1207:
1208: This and the next function allow you to create small sections of an
1209: otherwise static HTML page that you can update on the fly with
1210: Javascript, even in Netscape 4.
1211:
1212: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1213: must be written to the HTML page once. It will prove the Javascript
1214: function "change(name, content)". Calling the change function with the
1215: name of the section
1216: you want to update, matching the name passed to C<changable_area>, and
1217: the new content you want to put in there, will put the content into
1218: that area.
1219:
1220: B<Note>: Netscape 4 only reserves enough space for the changable area
1221: to contain room for the original contents. You need to "make space"
1222: for whatever changes you wish to make, and be B<sure> to check your
1223: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1224: it's adequate for updating a one-line status display, but little more.
1225: This script will set the space to 100% width, so you only need to
1226: worry about height in Netscape 4.
1227:
1228: Modern browsers are much less limiting, and if you can commit to the
1229: user not using Netscape 4, this feature may be used freely with
1230: pretty much any HTML.
1231:
1232: =cut
1233:
1234: sub change_content_javascript {
1235: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1236: if ($env{'browser.type'} eq 'netscape' &&
1237: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1238: return (<<NETSCAPE4);
1239: function change(name, content) {
1240: doc = document.layers[name+"___escape"].layers[0].document;
1241: doc.open();
1242: doc.write(content);
1243: doc.close();
1244: }
1245: NETSCAPE4
1246: } else {
1247: # Otherwise, we need to use semi-standards-compliant code
1248: # (technically, "innerHTML" isn't standard but the equivalent
1249: # is really scary, and every useful browser supports it
1250: return (<<DOMBASED);
1251: function change(name, content) {
1252: element = document.getElementById(name);
1253: element.innerHTML = content;
1254: }
1255: DOMBASED
1256: }
1257: }
1258:
1259: =pod
1260:
1.648 raeburn 1261: =item * &changable_area($name,$origContent):
1.256 matthew 1262:
1263: This provides a "changable area" that can be modified on the fly via
1264: the Javascript code provided in C<change_content_javascript>. $name is
1265: the name you will use to reference the area later; do not repeat the
1266: same name on a given HTML page more then once. $origContent is what
1267: the area will originally contain, which can be left blank.
1268:
1269: =cut
1270:
1271: sub changable_area {
1272: my ($name, $origContent) = @_;
1273:
1.258 albertel 1274: if ($env{'browser.type'} eq 'netscape' &&
1275: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1276: # If this is netscape 4, we need to use the Layer tag
1277: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1278: } else {
1279: return "<span id='$name'>$origContent</span>";
1280: }
1281: }
1282:
1283: =pod
1284:
1.648 raeburn 1285: =item * &viewport_geometry_js
1.590 raeburn 1286:
1287: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1288:
1289: =cut
1290:
1291:
1292: sub viewport_geometry_js {
1293: return <<"GEOMETRY";
1294: var Geometry = {};
1295: function init_geometry() {
1296: if (Geometry.init) { return };
1297: Geometry.init=1;
1298: if (window.innerHeight) {
1299: Geometry.getViewportHeight = function() { return window.innerHeight; };
1300: Geometry.getViewportWidth = function() { return window.innerWidth; };
1301: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1302: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1303: }
1304: else if (document.documentElement && document.documentElement.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.documentElement.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.documentElement.clientWidth; };
1309:
1310: Geometry.getHorizontalScroll =
1311: function() { return document.documentElement.scrollLeft; };
1312: Geometry.getVerticalScroll =
1313: function() { return document.documentElement.scrollTop; };
1314: }
1315: else if (document.body.clientHeight) {
1316: Geometry.getViewportHeight =
1317: function() { return document.body.clientHeight; };
1318: Geometry.getViewportWidth =
1319: function() { return document.body.clientWidth; };
1320: Geometry.getHorizontalScroll =
1321: function() { return document.body.scrollLeft; };
1322: Geometry.getVerticalScroll =
1323: function() { return document.body.scrollTop; };
1324: }
1325: }
1326:
1327: GEOMETRY
1328: }
1329:
1330: =pod
1331:
1.648 raeburn 1332: =item * &viewport_size_js()
1.590 raeburn 1333:
1334: 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.
1335:
1336: =cut
1337:
1338: sub viewport_size_js {
1339: my $geometry = &viewport_geometry_js();
1340: return <<"DIMS";
1341:
1342: $geometry
1343:
1344: function getViewportDims(width,height) {
1345: init_geometry();
1346: width.value = Geometry.getViewportWidth();
1347: height.value = Geometry.getViewportHeight();
1348: return;
1349: }
1350:
1351: DIMS
1352: }
1353:
1354: =pod
1355:
1.648 raeburn 1356: =item * &resize_textarea_js()
1.565 albertel 1357:
1358: emits the needed javascript to resize a textarea to be as big as possible
1359:
1360: creates a function resize_textrea that takes two IDs first should be
1361: the id of the element to resize, second should be the id of a div that
1362: surrounds everything that comes after the textarea, this routine needs
1363: to be attached to the <body> for the onload and onresize events.
1364:
1.648 raeburn 1365: =back
1.565 albertel 1366:
1367: =cut
1368:
1369: sub resize_textarea_js {
1.590 raeburn 1370: my $geometry = &viewport_geometry_js();
1.565 albertel 1371: return <<"RESIZE";
1372: <script type="text/javascript">
1.590 raeburn 1373: $geometry
1.565 albertel 1374:
1.588 albertel 1375: function getX(element) {
1376: var x = 0;
1377: while (element) {
1378: x += element.offsetLeft;
1379: element = element.offsetParent;
1380: }
1381: return x;
1382: }
1383: function getY(element) {
1384: var y = 0;
1385: while (element) {
1386: y += element.offsetTop;
1387: element = element.offsetParent;
1388: }
1389: return y;
1390: }
1391:
1392:
1.565 albertel 1393: function resize_textarea(textarea_id,bottom_id) {
1394: init_geometry();
1395: var textarea = document.getElementById(textarea_id);
1396: //alert(textarea);
1397:
1.588 albertel 1398: var textarea_top = getY(textarea);
1.565 albertel 1399: var textarea_height = textarea.offsetHeight;
1400: var bottom = document.getElementById(bottom_id);
1.588 albertel 1401: var bottom_top = getY(bottom);
1.565 albertel 1402: var bottom_height = bottom.offsetHeight;
1403: var window_height = Geometry.getViewportHeight();
1.588 albertel 1404: var fudge = 23;
1.565 albertel 1405: var new_height = window_height-fudge-textarea_top-bottom_height;
1406: if (new_height < 300) {
1407: new_height = 300;
1408: }
1409: textarea.style.height=new_height+'px';
1410: }
1411: </script>
1412: RESIZE
1413:
1414: }
1415:
1416: =pod
1417:
1.256 matthew 1418: =head1 Excel and CSV file utility routines
1419:
1420: =over 4
1421:
1422: =cut
1423:
1424: ###############################################################
1425: ###############################################################
1426:
1427: =pod
1428:
1.648 raeburn 1429: =item * &csv_translate($text)
1.37 matthew 1430:
1.185 www 1431: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1432: format.
1433:
1434: =cut
1435:
1.180 matthew 1436: ###############################################################
1437: ###############################################################
1.37 matthew 1438: sub csv_translate {
1439: my $text = shift;
1440: $text =~ s/\"/\"\"/g;
1.209 albertel 1441: $text =~ s/\n/ /g;
1.37 matthew 1442: return $text;
1443: }
1.180 matthew 1444:
1445: ###############################################################
1446: ###############################################################
1447:
1448: =pod
1449:
1.648 raeburn 1450: =item * &define_excel_formats()
1.180 matthew 1451:
1452: Define some commonly used Excel cell formats.
1453:
1454: Currently supported formats:
1455:
1456: =over 4
1457:
1458: =item header
1459:
1460: =item bold
1461:
1462: =item h1
1463:
1464: =item h2
1465:
1466: =item h3
1467:
1.256 matthew 1468: =item h4
1469:
1470: =item i
1471:
1.180 matthew 1472: =item date
1473:
1474: =back
1475:
1476: Inputs: $workbook
1477:
1478: Returns: $format, a hash reference.
1479:
1480: =cut
1481:
1482: ###############################################################
1483: ###############################################################
1484: sub define_excel_formats {
1485: my ($workbook) = @_;
1486: my $format;
1487: $format->{'header'} = $workbook->add_format(bold => 1,
1488: bottom => 1,
1489: align => 'center');
1490: $format->{'bold'} = $workbook->add_format(bold=>1);
1491: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1492: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1493: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1494: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1495: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1496: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1497: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1498: return $format;
1499: }
1500:
1501: ###############################################################
1502: ###############################################################
1.113 bowersj2 1503:
1504: =pod
1505:
1.648 raeburn 1506: =item * &create_workbook()
1.255 matthew 1507:
1508: Create an Excel worksheet. If it fails, output message on the
1509: request object and return undefs.
1510:
1511: Inputs: Apache request object
1512:
1513: Returns (undef) on failure,
1514: Excel worksheet object, scalar with filename, and formats
1515: from &Apache::loncommon::define_excel_formats on success
1516:
1517: =cut
1518:
1519: ###############################################################
1520: ###############################################################
1521: sub create_workbook {
1522: my ($r) = @_;
1523: #
1524: # Create the excel spreadsheet
1525: my $filename = '/prtspool/'.
1.258 albertel 1526: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1527: time.'_'.rand(1000000000).'.xls';
1528: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1529: if (! defined($workbook)) {
1530: $r->log_error("Error creating excel spreadsheet $filename: $!");
1531: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1532: "This error has been logged. ".
1533: "Please alert your LON-CAPA administrator").
1534: '</p>');
1535: return (undef);
1536: }
1537: #
1538: $workbook->set_tempdir('/home/httpd/perl/tmp');
1539: #
1540: my $format = &Apache::loncommon::define_excel_formats($workbook);
1541: return ($workbook,$filename,$format);
1542: }
1543:
1544: ###############################################################
1545: ###############################################################
1546:
1547: =pod
1548:
1.648 raeburn 1549: =item * &create_text_file()
1.113 bowersj2 1550:
1.542 raeburn 1551: Create a file to write to and eventually make available to the user.
1.256 matthew 1552: If file creation fails, outputs an error message on the request object and
1553: return undefs.
1.113 bowersj2 1554:
1.256 matthew 1555: Inputs: Apache request object, and file suffix
1.113 bowersj2 1556:
1.256 matthew 1557: Returns (undef) on failure,
1558: Filehandle and filename on success.
1.113 bowersj2 1559:
1560: =cut
1561:
1.256 matthew 1562: ###############################################################
1563: ###############################################################
1564: sub create_text_file {
1565: my ($r,$suffix) = @_;
1566: if (! defined($suffix)) { $suffix = 'txt'; };
1567: my $fh;
1568: my $filename = '/prtspool/'.
1.258 albertel 1569: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1570: time.'_'.rand(1000000000).'.'.$suffix;
1571: $fh = Apache::File->new('>/home/httpd'.$filename);
1572: if (! defined($fh)) {
1573: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1574: $r->print(&mt('Problems occurred in creating the output file. '
1575: .'This error has been logged. '
1576: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1577: }
1.256 matthew 1578: return ($fh,$filename)
1.113 bowersj2 1579: }
1580:
1581:
1.256 matthew 1582: =pod
1.113 bowersj2 1583:
1584: =back
1585:
1586: =cut
1.37 matthew 1587:
1588: ###############################################################
1.33 matthew 1589: ## Home server <option> list generating code ##
1590: ###############################################################
1.35 matthew 1591:
1.169 www 1592: # ------------------------------------------
1593:
1594: sub domain_select {
1595: my ($name,$value,$multiple)=@_;
1596: my %domains=map {
1.514 albertel 1597: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1598: } &Apache::lonnet::all_domains();
1.169 www 1599: if ($multiple) {
1600: $domains{''}=&mt('Any domain');
1.550 albertel 1601: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1602: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1603: } else {
1.550 albertel 1604: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1605: return &select_form($name,$value,%domains);
1606: }
1607: }
1608:
1.282 albertel 1609: #-------------------------------------------
1610:
1611: =pod
1612:
1.519 raeburn 1613: =head1 Routines for form select boxes
1614:
1615: =over 4
1616:
1.648 raeburn 1617: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1618:
1619: Returns a string containing a <select> element int multiple mode
1620:
1621:
1622: Args:
1623: $name - name of the <select> element
1.506 raeburn 1624: $value - scalar or array ref of values that should already be selected
1.282 albertel 1625: $size - number of rows long the select element is
1.283 albertel 1626: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1627: (shown text should already have been &mt())
1.506 raeburn 1628: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1629:
1.282 albertel 1630: =cut
1631:
1632: #-------------------------------------------
1.169 www 1633: sub multiple_select_form {
1.284 albertel 1634: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1635: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1636: my $output='';
1.191 matthew 1637: if (! defined($size)) {
1638: $size = 4;
1.283 albertel 1639: if (scalar(keys(%$hash))<4) {
1640: $size = scalar(keys(%$hash));
1.191 matthew 1641: }
1642: }
1.734 bisitz 1643: $output.="\n".'<select name="'.$name.'" size="'.$size.'" multiple="multiple">';
1.501 banghart 1644: my @order;
1.506 raeburn 1645: if (ref($order) eq 'ARRAY') {
1646: @order = @{$order};
1647: } else {
1648: @order = sort(keys(%$hash));
1.501 banghart 1649: }
1650: if (exists($$hash{'select_form_order'})) {
1651: @order = @{$$hash{'select_form_order'}};
1652: }
1653:
1.284 albertel 1654: foreach my $key (@order) {
1.356 albertel 1655: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1656: $output.='selected="selected" ' if ($selected{$key});
1657: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1658: }
1659: $output.="</select>\n";
1660: return $output;
1661: }
1662:
1.88 www 1663: #-------------------------------------------
1664:
1665: =pod
1666:
1.648 raeburn 1667: =item * &select_form($defdom,$name,%hash)
1.88 www 1668:
1669: Returns a string containing a <select name='$name' size='1'> form to
1670: allow a user to select options from a hash option_name => displayed text.
1671: See lonrights.pm for an example invocation and use.
1672:
1673: =cut
1674:
1675: #-------------------------------------------
1676: sub select_form {
1677: my ($def,$name,%hash) = @_;
1678: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1679: my @keys;
1680: if (exists($hash{'select_form_order'})) {
1681: @keys=@{$hash{'select_form_order'}};
1682: } else {
1683: @keys=sort(keys(%hash));
1684: }
1.356 albertel 1685: foreach my $key (@keys) {
1686: $selectform.=
1687: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1688: ($key eq $def ? 'selected="selected" ' : '').
1689: ">".&mt($hash{$key})."</option>\n";
1.88 www 1690: }
1691: $selectform.="</select>";
1692: return $selectform;
1693: }
1694:
1.475 www 1695: # For display filters
1696:
1697: sub display_filter {
1698: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1699: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.714 bisitz 1700: return '<span class="LC_nobreak"><label>'.&mt('Records [_1]',
1.475 www 1701: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1702: (&mt('all'),10,20,50,100,1000,10000))).
1.714 bisitz 1703: '</label></span> <span class="LC_nobreak">'.
1.475 www 1704: &mt('Filter [_1]',
1.477 www 1705: &select_form($env{'form.displayfilter'},
1706: 'displayfilter',
1707: ('currentfolder' => 'Current folder/page',
1708: 'containing' => 'Containing phrase',
1709: 'none' => 'None'))).
1.714 bisitz 1710: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></span>';
1.475 www 1711: }
1712:
1.167 www 1713: sub gradeleveldescription {
1714: my $gradelevel=shift;
1715: my %gradelevels=(0 => 'Not specified',
1716: 1 => 'Grade 1',
1717: 2 => 'Grade 2',
1718: 3 => 'Grade 3',
1719: 4 => 'Grade 4',
1720: 5 => 'Grade 5',
1721: 6 => 'Grade 6',
1722: 7 => 'Grade 7',
1723: 8 => 'Grade 8',
1724: 9 => 'Grade 9',
1725: 10 => 'Grade 10',
1726: 11 => 'Grade 11',
1727: 12 => 'Grade 12',
1728: 13 => 'Grade 13',
1729: 14 => '100 Level',
1730: 15 => '200 Level',
1731: 16 => '300 Level',
1732: 17 => '400 Level',
1733: 18 => 'Graduate Level');
1734: return &mt($gradelevels{$gradelevel});
1735: }
1736:
1.163 www 1737: sub select_level_form {
1738: my ($deflevel,$name)=@_;
1739: unless ($deflevel) { $deflevel=0; }
1.167 www 1740: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1741: for (my $i=0; $i<=18; $i++) {
1742: $selectform.="<option value=\"$i\" ".
1.253 albertel 1743: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1744: ">".&gradeleveldescription($i)."</option>\n";
1745: }
1746: $selectform.="</select>";
1747: return $selectform;
1.163 www 1748: }
1.167 www 1749:
1.35 matthew 1750: #-------------------------------------------
1751:
1.45 matthew 1752: =pod
1753:
1.743 raeburn 1754: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc,$autosubmit)
1.35 matthew 1755:
1756: Returns a string containing a <select name='$name' size='1'> form to
1757: allow a user to select the domain to preform an operation in.
1758: See loncreateuser.pm for an example invocation and use.
1759:
1.90 www 1760: If the $includeempty flag is set, it also includes an empty choice ("no domain
1761: selected");
1762:
1.743 raeburn 1763: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1764:
1765: If the $autosubmit flag is set, the form containing the domain selector will be auto-submitted by an onchange action.
1.563 raeburn 1766:
1.35 matthew 1767: =cut
1768:
1769: #-------------------------------------------
1.34 matthew 1770: sub select_dom_form {
1.743 raeburn 1771: my ($defdom,$name,$includeempty,$showdomdesc,$autosubmit) = @_;
1772: my $onchange;
1773: if ($autosubmit) {
1774: $onchange = ' onchange="this.form.submit()"';
1775: }
1.550 albertel 1776: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1777: if ($includeempty) { @domains=('',@domains); }
1.743 raeburn 1778: my $selectdomain = "<select name=\"$name\" size=\"1\"$onchange>\n";
1.356 albertel 1779: foreach my $dom (@domains) {
1780: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1781: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1782: if ($showdomdesc) {
1783: if ($dom ne '') {
1784: my $domdesc = &Apache::lonnet::domain($dom,'description');
1785: if ($domdesc ne '') {
1786: $selectdomain .= ' ('.$domdesc.')';
1787: }
1788: }
1789: }
1790: $selectdomain .= "</option>\n";
1.34 matthew 1791: }
1792: $selectdomain.="</select>";
1793: return $selectdomain;
1794: }
1795:
1.35 matthew 1796: #-------------------------------------------
1797:
1.45 matthew 1798: =pod
1799:
1.648 raeburn 1800: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1801:
1.586 raeburn 1802: input: 4 arguments (two required, two optional) -
1803: $domain - domain of new user
1804: $name - name of form element
1805: $default - Value of 'default' causes a default item to be first
1806: option, and selected by default.
1807: $hide - Value of 'hide' causes hiding of the name of the server,
1808: if 1 server found, or default, if 0 found.
1.594 raeburn 1809: output: returns 2 items:
1.586 raeburn 1810: (a) form element which contains either:
1811: (i) <select name="$name">
1812: <option value="$hostid1">$hostid $servers{$hostid}</option>
1813: <option value="$hostid2">$hostid $servers{$hostid}</option>
1814: </select>
1815: form item if there are multiple library servers in $domain, or
1816: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1817: if there is only one library server in $domain.
1818:
1819: (b) number of library servers found.
1820:
1821: See loncreateuser.pm for example of use.
1.35 matthew 1822:
1823: =cut
1824:
1825: #-------------------------------------------
1.586 raeburn 1826: sub home_server_form_item {
1827: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1828: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1829: my $result;
1830: my $numlib = keys(%servers);
1831: if ($numlib > 1) {
1832: $result .= '<select name="'.$name.'" />'."\n";
1833: if ($default) {
1834: $result .= '<option value="default" selected>'.&mt('default').
1835: '</option>'."\n";
1836: }
1837: foreach my $hostid (sort(keys(%servers))) {
1838: $result.= '<option value="'.$hostid.'">'.
1839: $hostid.' '.$servers{$hostid}."</option>\n";
1840: }
1841: $result .= '</select>'."\n";
1842: } elsif ($numlib == 1) {
1843: my $hostid;
1844: foreach my $item (keys(%servers)) {
1845: $hostid = $item;
1846: }
1847: $result .= '<input type="hidden" name="'.$name.'" value="'.
1848: $hostid.'" />';
1849: if (!$hide) {
1850: $result .= $hostid.' '.$servers{$hostid};
1851: }
1852: $result .= "\n";
1853: } elsif ($default) {
1854: $result .= '<input type="hidden" name="'.$name.
1855: '" value="default" />';
1856: if (!$hide) {
1857: $result .= &mt('default');
1858: }
1859: $result .= "\n";
1.33 matthew 1860: }
1.586 raeburn 1861: return ($result,$numlib);
1.33 matthew 1862: }
1.112 bowersj2 1863:
1864: =pod
1865:
1.534 albertel 1866: =back
1867:
1.112 bowersj2 1868: =cut
1.87 matthew 1869:
1870: ###############################################################
1.112 bowersj2 1871: ## Decoding User Agent ##
1.87 matthew 1872: ###############################################################
1873:
1874: =pod
1875:
1.112 bowersj2 1876: =head1 Decoding the User Agent
1877:
1878: =over 4
1879:
1880: =item * &decode_user_agent()
1.87 matthew 1881:
1882: Inputs: $r
1883:
1884: Outputs:
1885:
1886: =over 4
1887:
1.112 bowersj2 1888: =item * $httpbrowser
1.87 matthew 1889:
1.112 bowersj2 1890: =item * $clientbrowser
1.87 matthew 1891:
1.112 bowersj2 1892: =item * $clientversion
1.87 matthew 1893:
1.112 bowersj2 1894: =item * $clientmathml
1.87 matthew 1895:
1.112 bowersj2 1896: =item * $clientunicode
1.87 matthew 1897:
1.112 bowersj2 1898: =item * $clientos
1.87 matthew 1899:
1900: =back
1901:
1.157 matthew 1902: =back
1903:
1.87 matthew 1904: =cut
1905:
1906: ###############################################################
1907: ###############################################################
1908: sub decode_user_agent {
1.247 albertel 1909: my ($r)=@_;
1.87 matthew 1910: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1911: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1912: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1913: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1914: my $clientbrowser='unknown';
1915: my $clientversion='0';
1916: my $clientmathml='';
1917: my $clientunicode='0';
1918: for (my $i=0;$i<=$#browsertype;$i++) {
1919: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1920: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1921: $clientbrowser=$bname;
1922: $httpbrowser=~/$vreg/i;
1923: $clientversion=$1;
1924: $clientmathml=($clientversion>=$minv);
1925: $clientunicode=($clientversion>=$univ);
1926: }
1927: }
1928: my $clientos='unknown';
1929: if (($httpbrowser=~/linux/i) ||
1930: ($httpbrowser=~/unix/i) ||
1931: ($httpbrowser=~/ux/i) ||
1932: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1933: if (($httpbrowser=~/vax/i) ||
1934: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1935: if ($httpbrowser=~/next/i) { $clientos='next'; }
1936: if (($httpbrowser=~/mac/i) ||
1937: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1938: if ($httpbrowser=~/win/i) { $clientos='win'; }
1939: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1940: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1941: $clientunicode,$clientos,);
1942: }
1943:
1.32 matthew 1944: ###############################################################
1945: ## Authentication changing form generation subroutines ##
1946: ###############################################################
1947: ##
1948: ## All of the authform_xxxxxxx subroutines take their inputs in a
1949: ## hash, and have reasonable default values.
1950: ##
1951: ## formname = the name given in the <form> tag.
1.35 matthew 1952: #-------------------------------------------
1953:
1.45 matthew 1954: =pod
1955:
1.112 bowersj2 1956: =head1 Authentication Routines
1957:
1958: =over 4
1959:
1.648 raeburn 1960: =item * &authform_xxxxxx()
1.35 matthew 1961:
1962: The authform_xxxxxx subroutines provide javascript and html forms which
1963: handle some of the conveniences required for authentication forms.
1964: This is not an optimal method, but it works.
1965:
1966: =over 4
1967:
1.112 bowersj2 1968: =item * authform_header
1.35 matthew 1969:
1.112 bowersj2 1970: =item * authform_authorwarning
1.35 matthew 1971:
1.112 bowersj2 1972: =item * authform_nochange
1.35 matthew 1973:
1.112 bowersj2 1974: =item * authform_kerberos
1.35 matthew 1975:
1.112 bowersj2 1976: =item * authform_internal
1.35 matthew 1977:
1.112 bowersj2 1978: =item * authform_filesystem
1.35 matthew 1979:
1980: =back
1981:
1.648 raeburn 1982: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1983:
1.35 matthew 1984: =cut
1985:
1986: #-------------------------------------------
1.32 matthew 1987: sub authform_header{
1988: my %in = (
1989: formname => 'cu',
1.80 albertel 1990: kerb_def_dom => '',
1.32 matthew 1991: @_,
1992: );
1993: $in{'formname'} = 'document.' . $in{'formname'};
1994: my $result='';
1.80 albertel 1995:
1996: #---------------------------------------------- Code for upper case translation
1997: my $Javascript_toUpperCase;
1998: unless ($in{kerb_def_dom}) {
1999: $Javascript_toUpperCase =<<"END";
2000: switch (choice) {
2001: case 'krb': currentform.elements[choicearg].value =
2002: currentform.elements[choicearg].value.toUpperCase();
2003: break;
2004: default:
2005: }
2006: END
2007: } else {
2008: $Javascript_toUpperCase = "";
2009: }
2010:
1.165 raeburn 2011: my $radioval = "'nochange'";
1.591 raeburn 2012: if (defined($in{'curr_authtype'})) {
2013: if ($in{'curr_authtype'} ne '') {
2014: $radioval = "'".$in{'curr_authtype'}."arg'";
2015: }
1.174 matthew 2016: }
1.165 raeburn 2017: my $argfield = 'null';
1.591 raeburn 2018: if (defined($in{'mode'})) {
1.165 raeburn 2019: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2020: if (defined($in{'curr_autharg'})) {
2021: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2022: $argfield = "'$in{'curr_autharg'}'";
2023: }
2024: }
2025: }
2026: }
2027:
1.32 matthew 2028: $result.=<<"END";
2029: var current = new Object();
1.165 raeburn 2030: current.radiovalue = $radioval;
2031: current.argfield = $argfield;
1.32 matthew 2032:
2033: function changed_radio(choice,currentform) {
2034: var choicearg = choice + 'arg';
2035: // If a radio button in changed, we need to change the argfield
2036: if (current.radiovalue != choice) {
2037: current.radiovalue = choice;
2038: if (current.argfield != null) {
2039: currentform.elements[current.argfield].value = '';
2040: }
2041: if (choice == 'nochange') {
2042: current.argfield = null;
2043: } else {
2044: current.argfield = choicearg;
2045: switch(choice) {
2046: case 'krb':
2047: currentform.elements[current.argfield].value =
2048: "$in{'kerb_def_dom'}";
2049: break;
2050: default:
2051: break;
2052: }
2053: }
2054: }
2055: return;
2056: }
1.22 www 2057:
1.32 matthew 2058: function changed_text(choice,currentform) {
2059: var choicearg = choice + 'arg';
2060: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2061: $Javascript_toUpperCase
1.32 matthew 2062: // clear old field
2063: if ((current.argfield != choicearg) && (current.argfield != null)) {
2064: currentform.elements[current.argfield].value = '';
2065: }
2066: current.argfield = choicearg;
2067: }
2068: set_auth_radio_buttons(choice,currentform);
2069: return;
1.20 www 2070: }
1.32 matthew 2071:
2072: function set_auth_radio_buttons(newvalue,currentform) {
2073: var i=0;
2074: while (i < currentform.login.length) {
2075: if (currentform.login[i].value == newvalue) { break; }
2076: i++;
2077: }
2078: if (i == currentform.login.length) {
2079: return;
2080: }
2081: current.radiovalue = newvalue;
2082: currentform.login[i].checked = true;
2083: return;
2084: }
2085: END
2086: return $result;
2087: }
2088:
2089: sub authform_authorwarning{
2090: my $result='';
1.144 matthew 2091: $result='<i>'.
2092: &mt('As a general rule, only authors or co-authors should be '.
2093: 'filesystem authenticated '.
2094: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2095: return $result;
2096: }
2097:
2098: sub authform_nochange{
2099: my %in = (
2100: formname => 'document.cu',
2101: kerb_def_dom => 'MSU.EDU',
2102: @_,
2103: );
1.586 raeburn 2104: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2105: my $result;
2106: if (keys(%can_assign) == 0) {
2107: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2108: } else {
2109: $result = '<label>'.&mt('[_1] Do not change login data',
2110: '<input type="radio" name="login" value="nochange" '.
2111: 'checked="checked" onclick="'.
1.281 albertel 2112: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2113: '</label>';
1.586 raeburn 2114: }
1.32 matthew 2115: return $result;
2116: }
2117:
1.591 raeburn 2118: sub authform_kerberos {
1.32 matthew 2119: my %in = (
2120: formname => 'document.cu',
2121: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2122: kerb_def_auth => 'krb4',
1.32 matthew 2123: @_,
2124: );
1.586 raeburn 2125: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2126: $autharg,$jscall);
2127: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2128: if ($in{'kerb_def_auth'} eq 'krb5') {
1.772 bisitz 2129: $check5 = ' checked="checked"';
1.80 albertel 2130: } else {
1.772 bisitz 2131: $check4 = ' checked="checked"';
1.80 albertel 2132: }
1.165 raeburn 2133: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2134: if (defined($in{'curr_authtype'})) {
2135: if ($in{'curr_authtype'} eq 'krb') {
1.772 bisitz 2136: $krbcheck = ' checked="checked"';
1.623 raeburn 2137: if (defined($in{'mode'})) {
2138: if ($in{'mode'} eq 'modifyuser') {
2139: $krbcheck = '';
2140: }
2141: }
1.591 raeburn 2142: if (defined($in{'curr_kerb_ver'})) {
2143: if ($in{'curr_krb_ver'} eq '5') {
1.772 bisitz 2144: $check5 = ' checked="checked"';
1.591 raeburn 2145: $check4 = '';
2146: } else {
1.772 bisitz 2147: $check4 = ' checked="checked"';
1.591 raeburn 2148: $check5 = '';
2149: }
1.586 raeburn 2150: }
1.591 raeburn 2151: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2152: $krbarg = $in{'curr_autharg'};
2153: }
1.586 raeburn 2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2155: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2156: $result =
2157: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2158: $in{'curr_autharg'},$krbver);
2159: } else {
2160: $result =
2161: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2162: }
2163: return $result;
2164: }
2165: }
2166: } else {
2167: if ($authnum == 1) {
2168: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2169: }
2170: }
1.586 raeburn 2171: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2172: return;
1.587 raeburn 2173: } elsif ($authtype eq '') {
1.591 raeburn 2174: if (defined($in{'mode'})) {
1.587 raeburn 2175: if ($in{'mode'} eq 'modifycourse') {
2176: if ($authnum == 1) {
2177: $authtype = '<input type="hidden" name="login" value="krb">';
2178: }
2179: }
2180: }
1.586 raeburn 2181: }
2182: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2183: if ($authtype eq '') {
2184: $authtype = '<input type="radio" name="login" value="krb" '.
2185: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2186: $krbcheck.' />';
2187: }
2188: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2189: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2190: $in{'curr_authtype'} eq 'krb5') ||
2191: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2192: $in{'curr_authtype'} eq 'krb4')) {
2193: $result .= &mt
1.144 matthew 2194: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2195: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2196: '<label>'.$authtype,
1.281 albertel 2197: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2198: 'value="'.$krbarg.'" '.
1.144 matthew 2199: 'onchange="'.$jscall.'" />',
1.281 albertel 2200: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2201: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2202: '</label>');
1.586 raeburn 2203: } elsif ($can_assign{'krb4'}) {
2204: $result .= &mt
2205: ('[_1] Kerberos authenticated with domain [_2] '.
2206: '[_3] Version 4 [_4]',
2207: '<label>'.$authtype,
2208: '</label><input type="text" size="10" name="krbarg" '.
2209: 'value="'.$krbarg.'" '.
2210: 'onchange="'.$jscall.'" />',
2211: '<label><input type="hidden" name="krbver" value="4" />',
2212: '</label>');
2213: } elsif ($can_assign{'krb5'}) {
2214: $result .= &mt
2215: ('[_1] Kerberos authenticated with domain [_2] '.
2216: '[_3] Version 5 [_4]',
2217: '<label>'.$authtype,
2218: '</label><input type="text" size="10" name="krbarg" '.
2219: 'value="'.$krbarg.'" '.
2220: 'onchange="'.$jscall.'" />',
2221: '<label><input type="hidden" name="krbver" value="5" />',
2222: '</label>');
2223: }
1.32 matthew 2224: return $result;
2225: }
2226:
2227: sub authform_internal{
1.586 raeburn 2228: my %in = (
1.32 matthew 2229: formname => 'document.cu',
2230: kerb_def_dom => 'MSU.EDU',
2231: @_,
2232: );
1.586 raeburn 2233: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2234: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2235: if (defined($in{'curr_authtype'})) {
2236: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2237: if ($can_assign{'int'}) {
1.772 bisitz 2238: $intcheck = 'checked="checked" ';
1.623 raeburn 2239: if (defined($in{'mode'})) {
2240: if ($in{'mode'} eq 'modifyuser') {
2241: $intcheck = '';
2242: }
2243: }
1.591 raeburn 2244: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2245: $intarg = $in{'curr_autharg'};
2246: }
2247: } else {
2248: $result = &mt('Currently internally authenticated.');
2249: return $result;
1.165 raeburn 2250: }
2251: }
1.586 raeburn 2252: } else {
2253: if ($authnum == 1) {
2254: $authtype = '<input type="hidden" name="login" value="int">';
2255: }
2256: }
2257: if (!$can_assign{'int'}) {
2258: return;
1.587 raeburn 2259: } elsif ($authtype eq '') {
1.591 raeburn 2260: if (defined($in{'mode'})) {
1.587 raeburn 2261: if ($in{'mode'} eq 'modifycourse') {
2262: if ($authnum == 1) {
2263: $authtype = '<input type="hidden" name="login" value="int">';
2264: }
2265: }
2266: }
1.165 raeburn 2267: }
1.586 raeburn 2268: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2269: if ($authtype eq '') {
2270: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2271: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2272: }
1.605 bisitz 2273: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2274: $intarg.'" onchange="'.$jscall.'" />';
2275: $result = &mt
1.144 matthew 2276: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2277: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2278: $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 2279: return $result;
2280: }
2281:
2282: sub authform_local{
2283: my %in = (
2284: formname => 'document.cu',
2285: kerb_def_dom => 'MSU.EDU',
2286: @_,
2287: );
1.586 raeburn 2288: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2289: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2290: if (defined($in{'curr_authtype'})) {
2291: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2292: if ($can_assign{'loc'}) {
1.772 bisitz 2293: $loccheck = 'checked="checked" ';
1.623 raeburn 2294: if (defined($in{'mode'})) {
2295: if ($in{'mode'} eq 'modifyuser') {
2296: $loccheck = '';
2297: }
2298: }
1.591 raeburn 2299: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2300: $locarg = $in{'curr_autharg'};
2301: }
2302: } else {
2303: $result = &mt('Currently using local (institutional) authentication.');
2304: return $result;
1.165 raeburn 2305: }
2306: }
1.586 raeburn 2307: } else {
2308: if ($authnum == 1) {
2309: $authtype = '<input type="hidden" name="login" value="loc">';
2310: }
2311: }
2312: if (!$can_assign{'loc'}) {
2313: return;
1.587 raeburn 2314: } elsif ($authtype eq '') {
1.591 raeburn 2315: if (defined($in{'mode'})) {
1.587 raeburn 2316: if ($in{'mode'} eq 'modifycourse') {
2317: if ($authnum == 1) {
2318: $authtype = '<input type="hidden" name="login" value="loc">';
2319: }
2320: }
2321: }
1.165 raeburn 2322: }
1.586 raeburn 2323: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2324: if ($authtype eq '') {
2325: $authtype = '<input type="radio" name="login" value="loc" '.
2326: $loccheck.' onchange="'.$jscall.'" onclick="'.
2327: $jscall.'" />';
2328: }
2329: $autharg = '<input type="text" size="10" name="locarg" value="'.
2330: $locarg.'" onchange="'.$jscall.'" />';
2331: $result = &mt('[_1] Local Authentication with argument [_2]',
2332: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2333: return $result;
2334: }
2335:
2336: sub authform_filesystem{
2337: my %in = (
2338: formname => 'document.cu',
2339: kerb_def_dom => 'MSU.EDU',
2340: @_,
2341: );
1.586 raeburn 2342: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2343: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2344: if (defined($in{'curr_authtype'})) {
2345: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2346: if ($can_assign{'fsys'}) {
1.772 bisitz 2347: $fsyscheck = 'checked="checked" ';
1.623 raeburn 2348: if (defined($in{'mode'})) {
2349: if ($in{'mode'} eq 'modifyuser') {
2350: $fsyscheck = '';
2351: }
2352: }
1.586 raeburn 2353: } else {
2354: $result = &mt('Currently Filesystem Authenticated.');
2355: return $result;
2356: }
2357: }
2358: } else {
2359: if ($authnum == 1) {
2360: $authtype = '<input type="hidden" name="login" value="fsys">';
2361: }
2362: }
2363: if (!$can_assign{'fsys'}) {
2364: return;
1.587 raeburn 2365: } elsif ($authtype eq '') {
1.591 raeburn 2366: if (defined($in{'mode'})) {
1.587 raeburn 2367: if ($in{'mode'} eq 'modifycourse') {
2368: if ($authnum == 1) {
2369: $authtype = '<input type="hidden" name="login" value="fsys">';
2370: }
2371: }
2372: }
1.586 raeburn 2373: }
2374: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2375: if ($authtype eq '') {
2376: $authtype = '<input type="radio" name="login" value="fsys" '.
2377: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2378: $jscall.'" />';
2379: }
2380: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2381: ' onchange="'.$jscall.'" />';
2382: $result = &mt
1.144 matthew 2383: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2384: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2385: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2386: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2387: 'onchange="'.$jscall.'" />');
1.32 matthew 2388: return $result;
2389: }
2390:
1.586 raeburn 2391: sub get_assignable_auth {
2392: my ($dom) = @_;
2393: if ($dom eq '') {
2394: $dom = $env{'request.role.domain'};
2395: }
2396: my %can_assign = (
2397: krb4 => 1,
2398: krb5 => 1,
2399: int => 1,
2400: loc => 1,
2401: );
2402: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2403: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2404: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2405: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2406: my $context;
2407: if ($env{'request.role'} =~ /^au/) {
2408: $context = 'author';
2409: } elsif ($env{'request.role'} =~ /^dc/) {
2410: $context = 'domain';
2411: } elsif ($env{'request.course.id'}) {
2412: $context = 'course';
2413: }
2414: if ($context) {
2415: if (ref($authhash->{$context}) eq 'HASH') {
2416: %can_assign = %{$authhash->{$context}};
2417: }
2418: }
2419: }
2420: }
2421: my $authnum = 0;
2422: foreach my $key (keys(%can_assign)) {
2423: if ($can_assign{$key}) {
2424: $authnum ++;
2425: }
2426: }
2427: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2428: $authnum --;
2429: }
2430: return ($authnum,%can_assign);
2431: }
2432:
1.80 albertel 2433: ###############################################################
2434: ## Get Kerberos Defaults for Domain ##
2435: ###############################################################
2436: ##
2437: ## Returns default kerberos version and an associated argument
2438: ## as listed in file domain.tab. If not listed, provides
2439: ## appropriate default domain and kerberos version.
2440: ##
2441: #-------------------------------------------
2442:
2443: =pod
2444:
1.648 raeburn 2445: =item * &get_kerberos_defaults()
1.80 albertel 2446:
2447: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2448: version and domain. If not found, it defaults to version 4 and the
2449: domain of the server.
1.80 albertel 2450:
1.648 raeburn 2451: =over 4
2452:
1.80 albertel 2453: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2454:
1.648 raeburn 2455: =back
2456:
2457: =back
2458:
1.80 albertel 2459: =cut
2460:
2461: #-------------------------------------------
2462: sub get_kerberos_defaults {
2463: my $domain=shift;
1.641 raeburn 2464: my ($krbdef,$krbdefdom);
2465: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2466: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2467: $krbdef = $domdefaults{'auth_def'};
2468: $krbdefdom = $domdefaults{'auth_arg_def'};
2469: } else {
1.80 albertel 2470: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2471: my $krbdefdom=$1;
2472: $krbdefdom=~tr/a-z/A-Z/;
2473: $krbdef = "krb4";
2474: }
2475: return ($krbdef,$krbdefdom);
2476: }
1.112 bowersj2 2477:
1.32 matthew 2478:
1.46 matthew 2479: ###############################################################
2480: ## Thesaurus Functions ##
2481: ###############################################################
1.20 www 2482:
1.46 matthew 2483: =pod
1.20 www 2484:
1.112 bowersj2 2485: =head1 Thesaurus Functions
2486:
2487: =over 4
2488:
1.648 raeburn 2489: =item * &initialize_keywords()
1.46 matthew 2490:
2491: Initializes the package variable %Keywords if it is empty. Uses the
2492: package variable $thesaurus_db_file.
2493:
2494: =cut
2495:
2496: ###################################################
2497:
2498: sub initialize_keywords {
2499: return 1 if (scalar keys(%Keywords));
2500: # If we are here, %Keywords is empty, so fill it up
2501: # Make sure the file we need exists...
2502: if (! -e $thesaurus_db_file) {
2503: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2504: " failed because it does not exist");
2505: return 0;
2506: }
2507: # Set up the hash as a database
2508: my %thesaurus_db;
2509: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2510: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2511: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2512: $thesaurus_db_file);
2513: return 0;
2514: }
2515: # Get the average number of appearances of a word.
2516: my $avecount = $thesaurus_db{'average.count'};
2517: # Put keywords (those that appear > average) into %Keywords
2518: while (my ($word,$data)=each (%thesaurus_db)) {
2519: my ($count,undef) = split /:/,$data;
2520: $Keywords{$word}++ if ($count > $avecount);
2521: }
2522: untie %thesaurus_db;
2523: # Remove special values from %Keywords.
1.356 albertel 2524: foreach my $value ('total.count','average.count') {
2525: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2526: }
1.46 matthew 2527: return 1;
2528: }
2529:
2530: ###################################################
2531:
2532: =pod
2533:
1.648 raeburn 2534: =item * &keyword($word)
1.46 matthew 2535:
2536: Returns true if $word is a keyword. A keyword is a word that appears more
2537: than the average number of times in the thesaurus database. Calls
2538: &initialize_keywords
2539:
2540: =cut
2541:
2542: ###################################################
1.20 www 2543:
2544: sub keyword {
1.46 matthew 2545: return if (!&initialize_keywords());
2546: my $word=lc(shift());
2547: $word=~s/\W//g;
2548: return exists($Keywords{$word});
1.20 www 2549: }
1.46 matthew 2550:
2551: ###############################################################
2552:
2553: =pod
1.20 www 2554:
1.648 raeburn 2555: =item * &get_related_words()
1.46 matthew 2556:
1.160 matthew 2557: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2558: an array of words. If the keyword is not in the thesaurus, an empty array
2559: will be returned. The order of the words returned is determined by the
2560: database which holds them.
2561:
2562: Uses global $thesaurus_db_file.
2563:
2564: =cut
2565:
2566: ###############################################################
2567: sub get_related_words {
2568: my $keyword = shift;
2569: my %thesaurus_db;
2570: if (! -e $thesaurus_db_file) {
2571: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2572: "failed because the file does not exist");
2573: return ();
2574: }
2575: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2576: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2577: return ();
2578: }
2579: my @Words=();
1.429 www 2580: my $count=0;
1.46 matthew 2581: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2582: # The first element is the number of times
2583: # the word appears. We do not need it now.
1.429 www 2584: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2585: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2586: my $threshold=$mostfrequentcount/10;
2587: foreach my $possibleword (@RelatedWords) {
2588: my ($word,$wordcount)=split(/\,/,$possibleword);
2589: if ($wordcount>$threshold) {
2590: push(@Words,$word);
2591: $count++;
2592: if ($count>10) { last; }
2593: }
1.20 www 2594: }
2595: }
1.46 matthew 2596: untie %thesaurus_db;
2597: return @Words;
1.14 harris41 2598: }
1.46 matthew 2599:
1.112 bowersj2 2600: =pod
2601:
2602: =back
2603:
2604: =cut
1.61 www 2605:
2606: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2607: =pod
2608:
1.112 bowersj2 2609: =head1 User Name Functions
2610:
2611: =over 4
2612:
1.648 raeburn 2613: =item * &plainname($uname,$udom,$first)
1.81 albertel 2614:
1.112 bowersj2 2615: Takes a users logon name and returns it as a string in
1.226 albertel 2616: "first middle last generation" form
2617: if $first is set to 'lastname' then it returns it as
2618: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2619:
2620: =cut
1.61 www 2621:
1.295 www 2622:
1.81 albertel 2623: ###############################################################
1.61 www 2624: sub plainname {
1.226 albertel 2625: my ($uname,$udom,$first)=@_;
1.537 albertel 2626: return if (!defined($uname) || !defined($udom));
1.295 www 2627: my %names=&getnames($uname,$udom);
1.226 albertel 2628: my $name=&Apache::lonnet::format_name($names{'firstname'},
2629: $names{'middlename'},
2630: $names{'lastname'},
2631: $names{'generation'},$first);
2632: $name=~s/^\s+//;
1.62 www 2633: $name=~s/\s+$//;
2634: $name=~s/\s+/ /g;
1.353 albertel 2635: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2636: return $name;
1.61 www 2637: }
1.66 www 2638:
2639: # -------------------------------------------------------------------- Nickname
1.81 albertel 2640: =pod
2641:
1.648 raeburn 2642: =item * &nickname($uname,$udom)
1.81 albertel 2643:
2644: Gets a users name and returns it as a string as
2645:
2646: ""nickname""
1.66 www 2647:
1.81 albertel 2648: if the user has a nickname or
2649:
2650: "first middle last generation"
2651:
2652: if the user does not
2653:
2654: =cut
1.66 www 2655:
2656: sub nickname {
2657: my ($uname,$udom)=@_;
1.537 albertel 2658: return if (!defined($uname) || !defined($udom));
1.295 www 2659: my %names=&getnames($uname,$udom);
1.68 albertel 2660: my $name=$names{'nickname'};
1.66 www 2661: if ($name) {
2662: $name='"'.$name.'"';
2663: } else {
2664: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2665: $names{'lastname'}.' '.$names{'generation'};
2666: $name=~s/\s+$//;
2667: $name=~s/\s+/ /g;
2668: }
2669: return $name;
2670: }
2671:
1.295 www 2672: sub getnames {
2673: my ($uname,$udom)=@_;
1.537 albertel 2674: return if (!defined($uname) || !defined($udom));
1.433 albertel 2675: if ($udom eq 'public' && $uname eq 'public') {
2676: return ('lastname' => &mt('Public'));
2677: }
1.295 www 2678: my $id=$uname.':'.$udom;
2679: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2680: if ($cached) {
2681: return %{$names};
2682: } else {
2683: my %loadnames=&Apache::lonnet::get('environment',
2684: ['firstname','middlename','lastname','generation','nickname'],
2685: $udom,$uname);
2686: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2687: return %loadnames;
2688: }
2689: }
1.61 www 2690:
1.542 raeburn 2691: # -------------------------------------------------------------------- getemails
1.648 raeburn 2692:
1.542 raeburn 2693: =pod
2694:
1.648 raeburn 2695: =item * &getemails($uname,$udom)
1.542 raeburn 2696:
2697: Gets a user's email information and returns it as a hash with keys:
2698: notification, critnotification, permanentemail
2699:
2700: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2701: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2702:
1.648 raeburn 2703:
1.542 raeburn 2704: =cut
2705:
1.648 raeburn 2706:
1.466 albertel 2707: sub getemails {
2708: my ($uname,$udom)=@_;
2709: if ($udom eq 'public' && $uname eq 'public') {
2710: return;
2711: }
1.467 www 2712: if (!$udom) { $udom=$env{'user.domain'}; }
2713: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2714: my $id=$uname.':'.$udom;
2715: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2716: if ($cached) {
2717: return %{$names};
2718: } else {
2719: my %loadnames=&Apache::lonnet::get('environment',
2720: ['notification','critnotification',
2721: 'permanentemail'],
2722: $udom,$uname);
2723: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2724: return %loadnames;
2725: }
2726: }
2727:
1.551 albertel 2728: sub flush_email_cache {
2729: my ($uname,$udom)=@_;
2730: if (!$udom) { $udom =$env{'user.domain'}; }
2731: if (!$uname) { $uname=$env{'user.name'}; }
2732: return if ($udom eq 'public' && $uname eq 'public');
2733: my $id=$uname.':'.$udom;
2734: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2735: }
2736:
1.728 raeburn 2737: # -------------------------------------------------------------------- getlangs
2738:
2739: =pod
2740:
2741: =item * &getlangs($uname,$udom)
2742:
2743: Gets a user's language preference and returns it as a hash with key:
2744: language.
2745:
2746: =cut
2747:
2748:
2749: sub getlangs {
2750: my ($uname,$udom) = @_;
2751: if (!$udom) { $udom =$env{'user.domain'}; }
2752: if (!$uname) { $uname=$env{'user.name'}; }
2753: my $id=$uname.':'.$udom;
2754: my ($langs,$cached)=&Apache::lonnet::is_cached_new('userlangs',$id);
2755: if ($cached) {
2756: return %{$langs};
2757: } else {
2758: my %loadlangs=&Apache::lonnet::get('environment',['languages'],
2759: $udom,$uname);
2760: &Apache::lonnet::do_cache_new('userlangs',$id,\%loadlangs);
2761: return %loadlangs;
2762: }
2763: }
2764:
2765: sub flush_langs_cache {
2766: my ($uname,$udom)=@_;
2767: if (!$udom) { $udom =$env{'user.domain'}; }
2768: if (!$uname) { $uname=$env{'user.name'}; }
2769: return if ($udom eq 'public' && $uname eq 'public');
2770: my $id=$uname.':'.$udom;
2771: &Apache::lonnet::devalidate_cache_new('userlangs',$id);
2772: }
2773:
1.61 www 2774: # ------------------------------------------------------------------ Screenname
1.81 albertel 2775:
2776: =pod
2777:
1.648 raeburn 2778: =item * &screenname($uname,$udom)
1.81 albertel 2779:
2780: Gets a users screenname and returns it as a string
2781:
2782: =cut
1.61 www 2783:
2784: sub screenname {
2785: my ($uname,$udom)=@_;
1.258 albertel 2786: if ($uname eq $env{'user.name'} &&
2787: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2788: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2789: return $names{'screenname'};
1.62 www 2790: }
2791:
1.212 albertel 2792:
1.62 www 2793: # ------------------------------------------------------------- Message Wrapper
2794:
2795: sub messagewrapper {
1.369 www 2796: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2797: return
1.441 albertel 2798: '<a href="/adm/email?compose=individual&'.
2799: 'recname='.$username.'&recdom='.$domain.
2800: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2801: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2802: }
2803: # --------------------------------------------------------------- Notes Wrapper
2804:
2805: sub noteswrapper {
2806: my ($link,$un,$do)=@_;
2807: return
2808: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2809: }
2810: # ------------------------------------------------------------- Aboutme Wrapper
2811:
2812: sub aboutmewrapper {
1.166 www 2813: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2814: if (!defined($username) && !defined($domain)) {
2815: return;
2816: }
1.205 www 2817: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.756 weissno 2818: ($target?' target="$target"':'').' title="'.&mt("View this user's personal information page").'">'.$link.'</a>';
1.62 www 2819: }
2820:
2821: # ------------------------------------------------------------ Syllabus Wrapper
2822:
2823:
2824: sub syllabuswrapper {
1.707 bisitz 2825: my ($linktext,$coursedir,$domain)=@_;
1.208 matthew 2826: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2827: }
1.14 harris41 2828:
1.208 matthew 2829: sub track_student_link {
1.268 albertel 2830: my ($linktext,$sname,$sdom,$target,$start) = @_;
2831: my $link ="/adm/trackstudent?";
1.208 matthew 2832: my $title = 'View recent activity';
2833: if (defined($sname) && $sname !~ /^\s*$/ &&
2834: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2835: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2836: $title .= ' of this student';
1.268 albertel 2837: }
1.208 matthew 2838: if (defined($target) && $target !~ /^\s*$/) {
2839: $target = qq{target="$target"};
2840: } else {
2841: $target = '';
2842: }
1.268 albertel 2843: if ($start) { $link.='&start='.$start; }
1.554 albertel 2844: $title = &mt($title);
2845: $linktext = &mt($linktext);
1.448 albertel 2846: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2847: &help_open_topic('View_recent_activity');
1.208 matthew 2848: }
2849:
1.508 www 2850: # ===================================================== Display a student photo
2851:
2852:
1.509 albertel 2853: sub student_image_tag {
1.508 www 2854: my ($domain,$user)=@_;
2855: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2856: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2857: return '<img src="'.$imgsrc.'" align="right" />';
2858: } else {
2859: return '';
2860: }
2861: }
2862:
1.112 bowersj2 2863: =pod
2864:
2865: =back
2866:
2867: =head1 Access .tab File Data
2868:
2869: =over 4
2870:
1.648 raeburn 2871: =item * &languageids()
1.112 bowersj2 2872:
2873: returns list of all language ids
2874:
2875: =cut
2876:
1.14 harris41 2877: sub languageids {
1.16 harris41 2878: return sort(keys(%language));
1.14 harris41 2879: }
2880:
1.112 bowersj2 2881: =pod
2882:
1.648 raeburn 2883: =item * &languagedescription()
1.112 bowersj2 2884:
2885: returns description of a specified language id
2886:
2887: =cut
2888:
1.14 harris41 2889: sub languagedescription {
1.125 www 2890: my $code=shift;
2891: return ($supported_language{$code}?'* ':'').
2892: $language{$code}.
1.126 www 2893: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2894: }
2895:
2896: sub plainlanguagedescription {
2897: my $code=shift;
2898: return $language{$code};
2899: }
2900:
2901: sub supportedlanguagecode {
2902: my $code=shift;
2903: return $supported_language{$code};
1.97 www 2904: }
2905:
1.112 bowersj2 2906: =pod
2907:
1.648 raeburn 2908: =item * ©rightids()
1.112 bowersj2 2909:
2910: returns list of all copyrights
2911:
2912: =cut
2913:
2914: sub copyrightids {
2915: return sort(keys(%cprtag));
2916: }
2917:
2918: =pod
2919:
1.648 raeburn 2920: =item * ©rightdescription()
1.112 bowersj2 2921:
2922: returns description of a specified copyright id
2923:
2924: =cut
2925:
2926: sub copyrightdescription {
1.166 www 2927: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2928: }
1.197 matthew 2929:
2930: =pod
2931:
1.648 raeburn 2932: =item * &source_copyrightids()
1.192 taceyjo1 2933:
2934: returns list of all source copyrights
2935:
2936: =cut
2937:
2938: sub source_copyrightids {
2939: return sort(keys(%scprtag));
2940: }
2941:
2942: =pod
2943:
1.648 raeburn 2944: =item * &source_copyrightdescription()
1.192 taceyjo1 2945:
2946: returns description of a specified source copyright id
2947:
2948: =cut
2949:
2950: sub source_copyrightdescription {
2951: return &mt($scprtag{shift(@_)});
2952: }
1.112 bowersj2 2953:
2954: =pod
2955:
1.648 raeburn 2956: =item * &filecategories()
1.112 bowersj2 2957:
2958: returns list of all file categories
2959:
2960: =cut
2961:
2962: sub filecategories {
2963: return sort(keys(%category_extensions));
2964: }
2965:
2966: =pod
2967:
1.648 raeburn 2968: =item * &filecategorytypes()
1.112 bowersj2 2969:
2970: returns list of file types belonging to a given file
2971: category
2972:
2973: =cut
2974:
2975: sub filecategorytypes {
1.356 albertel 2976: my ($cat) = @_;
2977: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2978: }
2979:
2980: =pod
2981:
1.648 raeburn 2982: =item * &fileembstyle()
1.112 bowersj2 2983:
2984: returns embedding style for a specified file type
2985:
2986: =cut
2987:
2988: sub fileembstyle {
2989: return $fe{lc(shift(@_))};
1.169 www 2990: }
2991:
1.351 www 2992: sub filemimetype {
2993: return $fm{lc(shift(@_))};
2994: }
2995:
1.169 www 2996:
2997: sub filecategoryselect {
2998: my ($name,$value)=@_;
1.189 matthew 2999: return &select_form($value,$name,
1.169 www 3000: '' => &mt('Any category'),
3001: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 3002: }
3003:
3004: =pod
3005:
1.648 raeburn 3006: =item * &filedescription()
1.112 bowersj2 3007:
3008: returns description for a specified file type
3009:
3010: =cut
3011:
3012: sub filedescription {
1.188 matthew 3013: my $file_description = $fd{lc(shift())};
3014: $file_description =~ s:([\[\]]):~$1:g;
3015: return &mt($file_description);
1.112 bowersj2 3016: }
3017:
3018: =pod
3019:
1.648 raeburn 3020: =item * &filedescriptionex()
1.112 bowersj2 3021:
3022: returns description for a specified file type with
3023: extra formatting
3024:
3025: =cut
3026:
3027: sub filedescriptionex {
3028: my $ex=shift;
1.188 matthew 3029: my $file_description = $fd{lc($ex)};
3030: $file_description =~ s:([\[\]]):~$1:g;
3031: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 3032: }
3033:
3034: # End of .tab access
3035: =pod
3036:
3037: =back
3038:
3039: =cut
3040:
3041: # ------------------------------------------------------------------ File Types
3042: sub fileextensions {
3043: return sort(keys(%fe));
3044: }
3045:
1.97 www 3046: # ----------------------------------------------------------- Display Languages
3047: # returns a hash with all desired display languages
3048: #
3049:
3050: sub display_languages {
3051: my %languages=();
1.695 raeburn 3052: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3053: $languages{$lang}=1;
1.97 www 3054: }
3055: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3056: if ($env{'form.displaylanguage'}) {
1.356 albertel 3057: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3058: $languages{$lang}=1;
1.97 www 3059: }
3060: }
3061: return %languages;
1.14 harris41 3062: }
3063:
1.582 albertel 3064: sub languages {
3065: my ($possible_langs) = @_;
1.695 raeburn 3066: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3067: if (!ref($possible_langs)) {
3068: if( wantarray ) {
3069: return @preferred_langs;
3070: } else {
3071: return $preferred_langs[0];
3072: }
3073: }
3074: my %possibilities = map { $_ => 1 } (@$possible_langs);
3075: my @preferred_possibilities;
3076: foreach my $preferred_lang (@preferred_langs) {
3077: if (exists($possibilities{$preferred_lang})) {
3078: push(@preferred_possibilities, $preferred_lang);
3079: }
3080: }
3081: if( wantarray ) {
3082: return @preferred_possibilities;
3083: }
3084: return $preferred_possibilities[0];
3085: }
3086:
1.742 raeburn 3087: sub user_lang {
3088: my ($touname,$toudom,$fromcid) = @_;
3089: my @userlangs;
3090: if (($fromcid ne '') && ($env{'course.'.$fromcid.'.languages'} ne '')) {
3091: @userlangs=(@userlangs,split(/\s*(\,|\;|\:)\s*/,
3092: $env{'course.'.$fromcid.'.languages'}));
3093: } else {
3094: my %langhash = &getlangs($touname,$toudom);
3095: if ($langhash{'languages'} ne '') {
3096: @userlangs = split(/\s*(\,|\;|\:)\s*/,$langhash{'languages'});
3097: } else {
3098: my %domdefs = &Apache::lonnet::get_domain_defaults($toudom);
3099: if ($domdefs{'lang_def'} ne '') {
3100: @userlangs = ($domdefs{'lang_def'});
3101: }
3102: }
3103: }
3104: my @languages=&Apache::lonlocal::get_genlanguages(@userlangs);
3105: my $user_lh = Apache::localize->get_handle(@languages);
3106: return $user_lh;
3107: }
3108:
3109:
1.112 bowersj2 3110: ###############################################################
3111: ## Student Answer Attempts ##
3112: ###############################################################
3113:
3114: =pod
3115:
3116: =head1 Alternate Problem Views
3117:
3118: =over 4
3119:
1.648 raeburn 3120: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3121: $getattempt, $regexp, $gradesub)
3122:
3123: Return string with previous attempt on problem. Arguments:
3124:
3125: =over 4
3126:
3127: =item * $symb: Problem, including path
3128:
3129: =item * $username: username of the desired student
3130:
3131: =item * $domain: domain of the desired student
1.14 harris41 3132:
1.112 bowersj2 3133: =item * $course: Course ID
1.14 harris41 3134:
1.112 bowersj2 3135: =item * $getattempt: Leave blank for all attempts, otherwise put
3136: something
1.14 harris41 3137:
1.112 bowersj2 3138: =item * $regexp: if string matches this regexp, the string will be
3139: sent to $gradesub
1.14 harris41 3140:
1.112 bowersj2 3141: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3142:
1.112 bowersj2 3143: =back
1.14 harris41 3144:
1.112 bowersj2 3145: The output string is a table containing all desired attempts, if any.
1.16 harris41 3146:
1.112 bowersj2 3147: =cut
1.1 albertel 3148:
3149: sub get_previous_attempt {
1.43 ng 3150: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3151: my $prevattempts='';
1.43 ng 3152: no strict 'refs';
1.1 albertel 3153: if ($symb) {
1.3 albertel 3154: my (%returnhash)=
3155: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3156: if ($returnhash{'version'}) {
3157: my %lasthash=();
3158: my $version;
3159: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3160: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3161: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3162: }
1.1 albertel 3163: }
1.596 albertel 3164: $prevattempts=&start_data_table().&start_data_table_header_row();
3165: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3166: foreach my $key (sort(keys(%lasthash))) {
3167: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3168: if ($#parts > 0) {
1.31 albertel 3169: my $data=$parts[-1];
3170: pop(@parts);
1.596 albertel 3171: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3172: } else {
1.41 ng 3173: if ($#parts == 0) {
3174: $prevattempts.='<th>'.$parts[0].'</th>';
3175: } else {
3176: $prevattempts.='<th>'.$ign.'</th>';
3177: }
1.31 albertel 3178: }
1.16 harris41 3179: }
1.596 albertel 3180: $prevattempts.=&end_data_table_header_row();
1.40 ng 3181: if ($getattempt eq '') {
3182: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3183: $prevattempts.=&start_data_table_row().
3184: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3185: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3186: my $value = &format_previous_attempt_value($key,
3187: $returnhash{$version.':'.$key});
3188: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3189: }
1.596 albertel 3190: $prevattempts.=&end_data_table_row();
1.40 ng 3191: }
1.1 albertel 3192: }
1.596 albertel 3193: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3194: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3195: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3196: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3197: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3198: }
1.596 albertel 3199: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3200: } else {
1.596 albertel 3201: $prevattempts=
3202: &start_data_table().&start_data_table_row().
3203: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3204: &end_data_table_row().&end_data_table();
1.1 albertel 3205: }
3206: } else {
1.596 albertel 3207: $prevattempts=
3208: &start_data_table().&start_data_table_row().
3209: '<td>'.&mt('No data.').'</td>'.
3210: &end_data_table_row().&end_data_table();
1.1 albertel 3211: }
1.10 albertel 3212: }
3213:
1.581 albertel 3214: sub format_previous_attempt_value {
3215: my ($key,$value) = @_;
3216: if ($key =~ /timestamp/) {
3217: $value = &Apache::lonlocal::locallocaltime($value);
3218: } elsif (ref($value) eq 'ARRAY') {
3219: $value = '('.join(', ', @{ $value }).')';
3220: } else {
3221: $value = &unescape($value);
3222: }
3223: return $value;
3224: }
3225:
3226:
1.107 albertel 3227: sub relative_to_absolute {
3228: my ($url,$output)=@_;
3229: my $parser=HTML::TokeParser->new(\$output);
3230: my $token;
3231: my $thisdir=$url;
3232: my @rlinks=();
3233: while ($token=$parser->get_token) {
3234: if ($token->[0] eq 'S') {
3235: if ($token->[1] eq 'a') {
3236: if ($token->[2]->{'href'}) {
3237: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3238: }
3239: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3240: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3241: } elsif ($token->[1] eq 'base') {
3242: $thisdir=$token->[2]->{'href'};
3243: }
3244: }
3245: }
3246: $thisdir=~s-/[^/]*$--;
1.356 albertel 3247: foreach my $link (@rlinks) {
1.726 raeburn 3248: unless (($link=~/^https?\:\/\//i) ||
1.356 albertel 3249: ($link=~/^\//) ||
3250: ($link=~/^javascript:/i) ||
3251: ($link=~/^mailto:/i) ||
3252: ($link=~/^\#/)) {
3253: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3254: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3255: }
3256: }
3257: # -------------------------------------------------- Deal with Applet codebases
3258: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3259: return $output;
3260: }
3261:
1.112 bowersj2 3262: =pod
3263:
1.648 raeburn 3264: =item * &get_student_view()
1.112 bowersj2 3265:
3266: show a snapshot of what student was looking at
3267:
3268: =cut
3269:
1.10 albertel 3270: sub get_student_view {
1.186 albertel 3271: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3272: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3273: my (%form);
1.10 albertel 3274: my @elements=('symb','courseid','domain','username');
3275: foreach my $element (@elements) {
1.186 albertel 3276: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3277: }
1.186 albertel 3278: if (defined($moreenv)) {
3279: %form=(%form,%{$moreenv});
3280: }
1.236 albertel 3281: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3282: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3283: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3284: $userview=~s/\<body[^\>]*\>//gi;
3285: $userview=~s/\<\/body\>//gi;
3286: $userview=~s/\<html\>//gi;
3287: $userview=~s/\<\/html\>//gi;
3288: $userview=~s/\<head\>//gi;
3289: $userview=~s/\<\/head\>//gi;
3290: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3291: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3292: if (wantarray) {
3293: return ($userview,$response);
3294: } else {
3295: return $userview;
3296: }
3297: }
3298:
3299: sub get_student_view_with_retries {
3300: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3301:
3302: my $ok = 0; # True if we got a good response.
3303: my $content;
3304: my $response;
3305:
3306: # Try to get the student_view done. within the retries count:
3307:
3308: do {
3309: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3310: $ok = $response->is_success;
3311: if (!$ok) {
3312: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3313: }
3314: $retries--;
3315: } while (!$ok && ($retries > 0));
3316:
3317: if (!$ok) {
3318: $content = ''; # On error return an empty content.
3319: }
1.651 www 3320: if (wantarray) {
3321: return ($content, $response);
3322: } else {
3323: return $content;
3324: }
1.11 albertel 3325: }
3326:
1.112 bowersj2 3327: =pod
3328:
1.648 raeburn 3329: =item * &get_student_answers()
1.112 bowersj2 3330:
3331: show a snapshot of how student was answering problem
3332:
3333: =cut
3334:
1.11 albertel 3335: sub get_student_answers {
1.100 sakharuk 3336: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3337: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3338: my (%moreenv);
1.11 albertel 3339: my @elements=('symb','courseid','domain','username');
3340: foreach my $element (@elements) {
1.186 albertel 3341: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3342: }
1.186 albertel 3343: $moreenv{'grade_target'}='answer';
3344: %moreenv=(%form,%moreenv);
1.497 raeburn 3345: $feedurl = &Apache::lonnet::clutter($feedurl);
3346: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3347: return $userview;
1.1 albertel 3348: }
1.116 albertel 3349:
3350: =pod
3351:
3352: =item * &submlink()
3353:
1.242 albertel 3354: Inputs: $text $uname $udom $symb $target
1.116 albertel 3355:
3356: Returns: A link to grades.pm such as to see the SUBM view of a student
3357:
3358: =cut
3359:
3360: ###############################################
3361: sub submlink {
1.242 albertel 3362: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3363: if (!($uname && $udom)) {
3364: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3365: &Apache::lonnet::whichuser($symb);
1.116 albertel 3366: if (!$symb) { $symb=$cursymb; }
3367: }
1.254 matthew 3368: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3369: $symb=&escape($symb);
1.242 albertel 3370: if ($target) { $target="target=\"$target\""; }
3371: return '<a href="/adm/grades?&command=submission&'.
3372: 'symb='.$symb.'&student='.$uname.
3373: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3374: }
3375: ##############################################
3376:
3377: =pod
3378:
3379: =item * &pgrdlink()
3380:
3381: Inputs: $text $uname $udom $symb $target
3382:
3383: Returns: A link to grades.pm such as to see the PGRD view of a student
3384:
3385: =cut
3386:
3387: ###############################################
3388: sub pgrdlink {
3389: my $link=&submlink(@_);
3390: $link=~s/(&command=submission)/$1&showgrading=yes/;
3391: return $link;
3392: }
3393: ##############################################
3394:
3395: =pod
3396:
3397: =item * &pprmlink()
3398:
3399: Inputs: $text $uname $udom $symb $target
3400:
3401: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3402: student and a specific resource
1.242 albertel 3403:
3404: =cut
3405:
3406: ###############################################
3407: sub pprmlink {
3408: my ($text,$uname,$udom,$symb,$target)=@_;
3409: if (!($uname && $udom)) {
3410: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3411: &Apache::lonnet::whichuser($symb);
1.242 albertel 3412: if (!$symb) { $symb=$cursymb; }
3413: }
1.254 matthew 3414: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3415: $symb=&escape($symb);
1.242 albertel 3416: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3417: return '<a href="/adm/parmset?command=set&'.
3418: 'symb='.$symb.'&uname='.$uname.
3419: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3420: }
3421: ##############################################
1.37 matthew 3422:
1.112 bowersj2 3423: =pod
3424:
3425: =back
3426:
3427: =cut
3428:
1.37 matthew 3429: ###############################################
1.51 www 3430:
3431:
3432: sub timehash {
1.687 raeburn 3433: my ($thistime) = @_;
3434: my $timezone = &Apache::lonlocal::gettimezone();
3435: my $dt = DateTime->from_epoch(epoch => $thistime)
3436: ->set_time_zone($timezone);
3437: my $wday = $dt->day_of_week();
3438: if ($wday == 7) { $wday = 0; }
3439: return ( 'second' => $dt->second(),
3440: 'minute' => $dt->minute(),
3441: 'hour' => $dt->hour(),
3442: 'day' => $dt->day_of_month(),
3443: 'month' => $dt->month(),
3444: 'year' => $dt->year(),
3445: 'weekday' => $wday,
3446: 'dayyear' => $dt->day_of_year(),
3447: 'dlsav' => $dt->is_dst() );
1.51 www 3448: }
3449:
1.370 www 3450: sub utc_string {
3451: my ($date)=@_;
1.371 www 3452: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3453: }
3454:
1.51 www 3455: sub maketime {
3456: my %th=@_;
1.687 raeburn 3457: my ($epoch_time,$timezone,$dt);
3458: $timezone = &Apache::lonlocal::gettimezone();
3459: eval {
3460: $dt = DateTime->new( year => $th{'year'},
3461: month => $th{'month'},
3462: day => $th{'day'},
3463: hour => $th{'hour'},
3464: minute => $th{'minute'},
3465: second => $th{'second'},
3466: time_zone => $timezone,
3467: );
3468: };
3469: if (!$@) {
3470: $epoch_time = $dt->epoch;
3471: if ($epoch_time) {
3472: return $epoch_time;
3473: }
3474: }
1.51 www 3475: return POSIX::mktime(
3476: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3477: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3478: }
3479:
3480: #########################################
1.51 www 3481:
3482: sub findallcourses {
1.482 raeburn 3483: my ($roles,$uname,$udom) = @_;
1.355 albertel 3484: my %roles;
3485: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3486: my %courses;
1.51 www 3487: my $now=time;
1.482 raeburn 3488: if (!defined($uname)) {
3489: $uname = $env{'user.name'};
3490: }
3491: if (!defined($udom)) {
3492: $udom = $env{'user.domain'};
3493: }
3494: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3495: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3496: if (!%roles) {
3497: %roles = (
3498: cc => 1,
3499: in => 1,
3500: ep => 1,
3501: ta => 1,
3502: cr => 1,
3503: st => 1,
3504: );
3505: }
3506: foreach my $entry (keys(%roleshash)) {
3507: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3508: if ($trole =~ /^cr/) {
3509: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3510: } else {
3511: next if (!exists($roles{$trole}));
3512: }
3513: if ($tend) {
3514: next if ($tend < $now);
3515: }
3516: if ($tstart) {
3517: next if ($tstart > $now);
3518: }
3519: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3520: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3521: if ($secpart eq '') {
3522: ($cnum,$role) = split(/_/,$cnumpart);
3523: $sec = 'none';
3524: $realsec = '';
3525: } else {
3526: $cnum = $cnumpart;
3527: ($sec,$role) = split(/_/,$secpart);
3528: $realsec = $sec;
1.490 raeburn 3529: }
1.482 raeburn 3530: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3531: }
3532: } else {
3533: foreach my $key (keys(%env)) {
1.483 albertel 3534: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3535: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3536: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3537: next if ($role eq 'ca' || $role eq 'aa');
3538: next if (%roles && !exists($roles{$role}));
3539: my ($starttime,$endtime)=split(/\./,$env{$key});
3540: my $active=1;
3541: if ($starttime) {
3542: if ($now<$starttime) { $active=0; }
3543: }
3544: if ($endtime) {
3545: if ($now>$endtime) { $active=0; }
3546: }
3547: if ($active) {
3548: if ($sec eq '') {
3549: $sec = 'none';
3550: }
3551: $courses{$cdom.'_'.$cnum}{$sec} =
3552: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3553: }
3554: }
1.51 www 3555: }
3556: }
1.474 raeburn 3557: return %courses;
1.51 www 3558: }
1.37 matthew 3559:
1.54 www 3560: ###############################################
1.474 raeburn 3561:
3562: sub blockcheck {
1.482 raeburn 3563: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3564:
3565: if (!defined($udom)) {
3566: $udom = $env{'user.domain'};
3567: }
3568: if (!defined($uname)) {
3569: $uname = $env{'user.name'};
3570: }
3571:
3572: # If uname and udom are for a course, check for blocks in the course.
3573:
3574: if (&Apache::lonnet::is_course($udom,$uname)) {
3575: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3576: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3577: return ($startblock,$endblock);
3578: }
1.474 raeburn 3579:
1.502 raeburn 3580: my $startblock = 0;
3581: my $endblock = 0;
1.482 raeburn 3582: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3583:
1.490 raeburn 3584: # If uname is for a user, and activity is course-specific, i.e.,
3585: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3586:
1.490 raeburn 3587: if (($activity eq 'boards' || $activity eq 'chat' ||
3588: $activity eq 'groups') && ($env{'request.course.id'})) {
3589: foreach my $key (keys(%live_courses)) {
3590: if ($key ne $env{'request.course.id'}) {
3591: delete($live_courses{$key});
3592: }
3593: }
3594: }
3595:
3596: my $otheruser = 0;
3597: my %own_courses;
3598: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3599: # Resource belongs to user other than current user.
3600: $otheruser = 1;
3601: # Gather courses for current user
3602: %own_courses =
3603: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3604: }
3605:
3606: # Gather active course roles - course coordinator, instructor,
3607: # exam proctor, ta, student, or custom role.
1.474 raeburn 3608:
3609: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3610: my ($cdom,$cnum);
3611: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3612: $cdom = $env{'course.'.$course.'.domain'};
3613: $cnum = $env{'course.'.$course.'.num'};
3614: } else {
1.490 raeburn 3615: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3616: }
3617: my $no_ownblock = 0;
3618: my $no_userblock = 0;
1.533 raeburn 3619: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3620: # Check if current user has 'evb' priv for this
3621: if (defined($own_courses{$course})) {
3622: foreach my $sec (keys(%{$own_courses{$course}})) {
3623: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3624: if ($sec ne 'none') {
3625: $checkrole .= '/'.$sec;
3626: }
3627: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3628: $no_ownblock = 1;
3629: last;
3630: }
3631: }
3632: }
3633: # if they have 'evb' priv and are currently not playing student
3634: next if (($no_ownblock) &&
3635: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3636: }
1.474 raeburn 3637: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3638: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3639: if ($sec ne 'none') {
1.482 raeburn 3640: $checkrole .= '/'.$sec;
1.474 raeburn 3641: }
1.490 raeburn 3642: if ($otheruser) {
3643: # Resource belongs to user other than current user.
3644: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3645: my ($trole,$tdom,$tnum,$tsec);
3646: my $entry = $live_courses{$course}{$sec};
3647: if ($entry =~ /^cr/) {
3648: ($trole,$tdom,$tnum,$tsec) =
3649: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3650: } else {
3651: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3652: }
3653: my ($spec,$area,$trest,%allroles,%userroles);
3654: $area = '/'.$tdom.'/'.$tnum;
3655: $trest = $tnum;
3656: if ($tsec ne '') {
3657: $area .= '/'.$tsec;
3658: $trest .= '/'.$tsec;
3659: }
3660: $spec = $trole.'.'.$area;
3661: if ($trole =~ /^cr/) {
3662: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3663: $tdom,$spec,$trest,$area);
3664: } else {
3665: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3666: $tdom,$spec,$trest,$area);
3667: }
3668: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3669: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3670: if ($1) {
3671: $no_userblock = 1;
3672: last;
3673: }
3674: }
1.490 raeburn 3675: } else {
3676: # Resource belongs to current user
3677: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3678: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3679: $no_ownblock = 1;
3680: last;
3681: }
1.474 raeburn 3682: }
3683: }
3684: # if they have the evb priv and are currently not playing student
1.482 raeburn 3685: next if (($no_ownblock) &&
1.491 albertel 3686: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3687: next if ($no_userblock);
1.474 raeburn 3688:
1.490 raeburn 3689: # Retrieve blocking times and identity of blocker for course
3690: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3691:
3692: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3693: if (($start != 0) &&
3694: (($startblock == 0) || ($startblock > $start))) {
3695: $startblock = $start;
3696: }
3697: if (($end != 0) &&
3698: (($endblock == 0) || ($endblock < $end))) {
3699: $endblock = $end;
3700: }
1.490 raeburn 3701: }
3702: return ($startblock,$endblock);
3703: }
3704:
3705: sub get_blocks {
3706: my ($setters,$activity,$cdom,$cnum) = @_;
3707: my $startblock = 0;
3708: my $endblock = 0;
3709: my $course = $cdom.'_'.$cnum;
3710: $setters->{$course} = {};
3711: $setters->{$course}{'staff'} = [];
3712: $setters->{$course}{'times'} = [];
3713: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3714: foreach my $record (keys(%records)) {
3715: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3716: if ($start <= time && $end >= time) {
3717: my ($staff_name,$staff_dom,$title,$blocks) =
3718: &parse_block_record($records{$record});
3719: if ($blocks->{$activity} eq 'on') {
3720: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3721: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3722: if ( ($startblock == 0) || ($startblock > $start) ) {
3723: $startblock = $start;
1.490 raeburn 3724: }
1.491 albertel 3725: if ( ($endblock == 0) || ($endblock < $end) ) {
3726: $endblock = $end;
1.474 raeburn 3727: }
3728: }
3729: }
3730: }
3731: return ($startblock,$endblock);
3732: }
3733:
3734: sub parse_block_record {
3735: my ($record) = @_;
3736: my ($setuname,$setudom,$title,$blocks);
3737: if (ref($record) eq 'HASH') {
3738: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3739: $title = &unescape($record->{'event'});
3740: $blocks = $record->{'blocks'};
3741: } else {
3742: my @data = split(/:/,$record,3);
3743: if (scalar(@data) eq 2) {
3744: $title = $data[1];
3745: ($setuname,$setudom) = split(/@/,$data[0]);
3746: } else {
3747: ($setuname,$setudom,$title) = @data;
3748: }
3749: $blocks = { 'com' => 'on' };
3750: }
3751: return ($setuname,$setudom,$title,$blocks);
3752: }
3753:
3754: sub build_block_table {
3755: my ($startblock,$endblock,$setters) = @_;
3756: my %lt = &Apache::lonlocal::texthash(
3757: 'cacb' => 'Currently active communication blocks',
3758: 'cour' => 'Course',
3759: 'dura' => 'Duration',
3760: 'blse' => 'Block set by'
3761: );
3762: my $output;
1.476 raeburn 3763: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3764: $output .= &start_data_table();
3765: $output .= '
3766: <tr>
3767: <th>'.$lt{'cour'}.'</th>
3768: <th>'.$lt{'dura'}.'</th>
3769: <th>'.$lt{'blse'}.'</th>
3770: </tr>
3771: ';
3772: foreach my $course (keys(%{$setters})) {
3773: my %courseinfo=&Apache::lonnet::coursedescription($course);
3774: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3775: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3776: my $fullname = &plainname($uname,$udom);
3777: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3778: && $env{'user.name'} ne 'public'
3779: && $env{'user.domain'} ne 'public') {
3780: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3781: }
1.474 raeburn 3782: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3783: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3784: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3785: $output .= &Apache::loncommon::start_data_table_row().
3786: '<td>'.$courseinfo{'description'}.'</td>'.
3787: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3788: '<td>'.$fullname.'</td>'.
1.474 raeburn 3789: &Apache::loncommon::end_data_table_row();
3790: }
3791: }
3792: $output .= &end_data_table();
3793: }
3794:
1.490 raeburn 3795: sub blocking_status {
3796: my ($activity,$uname,$udom) = @_;
3797: my %setters;
3798: my ($blocked,$output,$ownitem,$is_course);
3799: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3800: if ($startblock && $endblock) {
3801: $blocked = 1;
3802: if (wantarray) {
3803: my $category;
3804: if ($activity eq 'boards') {
3805: $category = 'Discussion posts in this course';
3806: } elsif ($activity eq 'blogs') {
3807: $category = 'Blogs';
3808: } elsif ($activity eq 'port') {
3809: if (defined($uname) && defined($udom)) {
3810: if ($uname eq $env{'user.name'} &&
3811: $udom eq $env{'user.domain'}) {
3812: $ownitem = 1;
3813: }
3814: }
3815: $is_course = &Apache::lonnet::is_course($udom,$uname);
3816: if ($ownitem) {
3817: $category = 'Your portfolio files';
3818: } elsif ($is_course) {
3819: my $coursedesc;
3820: foreach my $course (keys(%setters)) {
3821: my %courseinfo =
3822: &Apache::lonnet::coursedescription($course);
3823: $coursedesc = $courseinfo{'description'};
3824: }
1.764 weissno 3825: $category = "Group portfolio in the course '$coursedesc'";
1.490 raeburn 3826: } else {
3827: $category = 'Portfolio files belonging to ';
3828: if ($env{'user.name'} eq 'public' &&
3829: $env{'user.domain'} eq 'public') {
3830: $category .= &plainname($uname,$udom);
3831: } else {
3832: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3833: }
3834: }
3835: } elsif ($activity eq 'groups') {
3836: $category = 'Groups in this course';
3837: }
3838: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3839: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3840: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3841: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3842: $output .= &build_block_table($startblock,$endblock,\%setters);
3843: }
3844: }
3845: }
3846: if (wantarray) {
3847: return ($blocked,$output);
3848: } else {
3849: return $blocked;
3850: }
3851: }
3852:
1.60 matthew 3853: ###############################################
3854:
1.682 raeburn 3855: sub check_ip_acc {
3856: my ($acc)=@_;
3857: &Apache::lonxml::debug("acc is $acc");
3858: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3859: return 1;
3860: }
3861: my $allowed=0;
3862: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3863:
3864: my $name;
3865: foreach my $pattern (split(',',$acc)) {
3866: $pattern =~ s/^\s*//;
3867: $pattern =~ s/\s*$//;
3868: if ($pattern =~ /\*$/) {
3869: #35.8.*
3870: $pattern=~s/\*//;
3871: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3872: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3873: #35.8.3.[34-56]
3874: my $low=$2;
3875: my $high=$3;
3876: $pattern=$1;
3877: if ($ip =~ /^\Q$pattern\E/) {
3878: my $last=(split(/\./,$ip))[3];
3879: if ($last <=$high && $last >=$low) { $allowed=1; }
3880: }
3881: } elsif ($pattern =~ /^\*/) {
3882: #*.msu.edu
3883: $pattern=~s/\*//;
3884: if (!defined($name)) {
3885: use Socket;
3886: my $netaddr=inet_aton($ip);
3887: ($name)=gethostbyaddr($netaddr,AF_INET);
3888: }
3889: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3890: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3891: #127.0.0.1
3892: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3893: } else {
3894: #some.name.com
3895: if (!defined($name)) {
3896: use Socket;
3897: my $netaddr=inet_aton($ip);
3898: ($name)=gethostbyaddr($netaddr,AF_INET);
3899: }
3900: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3901: }
3902: if ($allowed) { last; }
3903: }
3904: return $allowed;
3905: }
3906:
3907: ###############################################
3908:
1.60 matthew 3909: =pod
3910:
1.112 bowersj2 3911: =head1 Domain Template Functions
3912:
3913: =over 4
3914:
3915: =item * &determinedomain()
1.60 matthew 3916:
3917: Inputs: $domain (usually will be undef)
3918:
1.63 www 3919: Returns: Determines which domain should be used for designs
1.60 matthew 3920:
3921: =cut
1.54 www 3922:
1.60 matthew 3923: ###############################################
1.63 www 3924: sub determinedomain {
3925: my $domain=shift;
1.531 albertel 3926: if (! $domain) {
1.60 matthew 3927: # Determine domain if we have not been given one
3928: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3929: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3930: if ($env{'request.role.domain'}) {
3931: $domain=$env{'request.role.domain'};
1.60 matthew 3932: }
3933: }
1.63 www 3934: return $domain;
3935: }
3936: ###############################################
1.517 raeburn 3937:
1.518 albertel 3938: sub devalidate_domconfig_cache {
3939: my ($udom)=@_;
3940: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3941: }
3942:
3943: # ---------------------- Get domain configuration for a domain
3944: sub get_domainconf {
3945: my ($udom) = @_;
3946: my $cachetime=1800;
3947: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3948: if (defined($cached)) { return %{$result}; }
3949:
3950: my %domconfig = &Apache::lonnet::get_dom('configuration',
3951: ['login','rolecolors'],$udom);
1.632 raeburn 3952: my (%designhash,%legacy);
1.518 albertel 3953: if (keys(%domconfig) > 0) {
3954: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3955: if (keys(%{$domconfig{'login'}})) {
3956: foreach my $key (keys(%{$domconfig{'login'}})) {
1.699 raeburn 3957: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3958: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3959: $designhash{$udom.'.login.'.$key.'_'.$img} =
3960: $domconfig{'login'}{$key}{$img};
3961: }
3962: } else {
3963: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3964: }
1.632 raeburn 3965: }
3966: } else {
3967: $legacy{'login'} = 1;
1.518 albertel 3968: }
1.632 raeburn 3969: } else {
3970: $legacy{'login'} = 1;
1.518 albertel 3971: }
3972: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3973: if (keys(%{$domconfig{'rolecolors'}})) {
3974: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3975: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3976: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3977: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3978: }
1.518 albertel 3979: }
3980: }
1.632 raeburn 3981: } else {
3982: $legacy{'rolecolors'} = 1;
1.518 albertel 3983: }
1.632 raeburn 3984: } else {
3985: $legacy{'rolecolors'} = 1;
1.518 albertel 3986: }
1.632 raeburn 3987: if (keys(%legacy) > 0) {
3988: my %legacyhash = &get_legacy_domconf($udom);
3989: foreach my $item (keys(%legacyhash)) {
3990: if ($item =~ /^\Q$udom\E\.login/) {
3991: if ($legacy{'login'}) {
3992: $designhash{$item} = $legacyhash{$item};
3993: }
3994: } else {
3995: if ($legacy{'rolecolors'}) {
3996: $designhash{$item} = $legacyhash{$item};
3997: }
1.518 albertel 3998: }
3999: }
4000: }
1.632 raeburn 4001: } else {
4002: %designhash = &get_legacy_domconf($udom);
1.518 albertel 4003: }
4004: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
4005: $cachetime);
4006: return %designhash;
4007: }
4008:
1.632 raeburn 4009: sub get_legacy_domconf {
4010: my ($udom) = @_;
4011: my %legacyhash;
4012: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
4013: my $designfile = $designdir.'/'.$udom.'.tab';
4014: if (-e $designfile) {
4015: if ( open (my $fh,"<$designfile") ) {
4016: while (my $line = <$fh>) {
4017: next if ($line =~ /^\#/);
4018: chomp($line);
4019: my ($key,$val)=(split(/\=/,$line));
4020: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
4021: }
4022: close($fh);
4023: }
4024: }
4025: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
4026: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
4027: }
4028: return %legacyhash;
4029: }
4030:
1.63 www 4031: =pod
4032:
1.112 bowersj2 4033: =item * &domainlogo()
1.63 www 4034:
4035: Inputs: $domain (usually will be undef)
4036:
4037: Returns: A link to a domain logo, if the domain logo exists.
4038: If the domain logo does not exist, a description of the domain.
4039:
4040: =cut
1.112 bowersj2 4041:
1.63 www 4042: ###############################################
4043: sub domainlogo {
1.517 raeburn 4044: my $domain = &determinedomain(shift);
1.518 albertel 4045: my %designhash = &get_domainconf($domain);
1.517 raeburn 4046: # See if there is a logo
4047: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 4048: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 4049: if ($imgsrc =~ m{^/(adm|res)/}) {
4050: if ($imgsrc =~ m{^/res/}) {
4051: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
4052: &Apache::lonnet::repcopy($local_name);
4053: }
4054: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 4055: }
4056: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 4057: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
4058: return &Apache::lonnet::domain($domain,'description');
1.59 www 4059: } else {
1.60 matthew 4060: return '';
1.59 www 4061: }
4062: }
1.63 www 4063: ##############################################
4064:
4065: =pod
4066:
1.112 bowersj2 4067: =item * &designparm()
1.63 www 4068:
4069: Inputs: $which parameter; $domain (usually will be undef)
4070:
4071: Returns: value of designparamter $which
4072:
4073: =cut
1.112 bowersj2 4074:
1.397 albertel 4075:
1.400 albertel 4076: ##############################################
1.397 albertel 4077: sub designparm {
4078: my ($which,$domain)=@_;
1.258 albertel 4079: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4080: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4081: return '#000000';
4082: }
1.635 raeburn 4083: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4084: return '#FFFFFF';
4085: }
4086: if ($which=~/\.tabbg$/) {
4087: return '#CCCCCC';
4088: }
4089: }
1.397 albertel 4090: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4091: return $env{'environment.color.'.$which};
1.96 www 4092: }
1.63 www 4093: $domain=&determinedomain($domain);
1.518 albertel 4094: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4095: my $output;
1.517 raeburn 4096: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4097: $output = $domdesign{$domain.'.'.$which};
1.63 www 4098: } else {
1.520 raeburn 4099: $output = $defaultdesign{$which};
4100: }
4101: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4102: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4103: if ($output =~ m{^/(adm|res)/}) {
4104: if ($output =~ m{^/res/}) {
4105: my $local_name = &Apache::lonnet::filelocation('',$output);
4106: &Apache::lonnet::repcopy($local_name);
4107: }
1.520 raeburn 4108: $output = &lonhttpdurl($output);
4109: }
1.63 www 4110: }
1.520 raeburn 4111: return $output;
1.63 www 4112: }
1.59 www 4113:
1.60 matthew 4114: ###############################################
4115: ###############################################
4116:
4117: =pod
4118:
1.112 bowersj2 4119: =back
4120:
1.549 albertel 4121: =head1 HTML Helpers
1.112 bowersj2 4122:
4123: =over 4
4124:
4125: =item * &bodytag()
1.60 matthew 4126:
4127: Returns a uniform header for LON-CAPA web pages.
4128:
4129: Inputs:
4130:
1.112 bowersj2 4131: =over 4
4132:
4133: =item * $title, A title to be displayed on the page.
4134:
4135: =item * $function, the current role (can be undef).
4136:
4137: =item * $addentries, extra parameters for the <body> tag.
4138:
4139: =item * $bodyonly, if defined, only return the <body> tag.
4140:
4141: =item * $domain, if defined, force a given domain.
4142:
4143: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4144: text interface only)
1.60 matthew 4145:
1.326 albertel 4146: =item * $customtitle, alternate text to use instead of $title
4147: in the title box that appears, this text
4148: is not auto translated like the $title is
1.309 albertel 4149:
4150: =item * $notopbar, if true, keep the 'what is this' info but remove the
4151: navigational links
1.317 albertel 4152:
1.338 albertel 4153: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4154:
4155: =item * $notitle, if true keep the nav controls, but remove the title bar
4156:
1.361 albertel 4157: =item * $no_inline_link, if true and in remote mode, don't show the
4158: 'Switch To Inline Menu' link
4159:
1.460 albertel 4160: =item * $args, optional argument valid values are
4161: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4162: inherit_jsmath -> when creating popup window in a page,
4163: should it have jsmath forced on by the
4164: current page
1.460 albertel 4165:
1.112 bowersj2 4166: =back
4167:
1.60 matthew 4168: Returns: A uniform header for LON-CAPA web pages.
4169: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4170: If $bodyonly is undef or zero, an html string containing a <body> tag and
4171: other decorations will be returned.
4172:
4173: =cut
4174:
1.54 www 4175: sub bodytag {
1.309 albertel 4176: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4177: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4178:
1.460 albertel 4179: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4180:
1.183 matthew 4181: $function = &get_users_function() if (!$function);
1.339 albertel 4182: my $img = &designparm($function.'.img',$domain);
4183: my $font = &designparm($function.'.font',$domain);
4184: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4185:
4186: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4187: 'bgcolor' => $pgbg,
1.339 albertel 4188: 'text' => $font,
4189: 'alink' => &designparm($function.'.alink',$domain),
4190: 'vlink' => &designparm($function.'.vlink',$domain),
4191: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4192: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4193:
1.63 www 4194: # role and realm
1.378 raeburn 4195: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4196: if ($role eq 'ca') {
1.479 albertel 4197: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4198: $realm = &plainname($rname,$rdom);
1.378 raeburn 4199: }
1.55 www 4200: # realm
1.258 albertel 4201: if ($env{'request.course.id'}) {
1.378 raeburn 4202: if ($env{'request.role'} !~ /^cr/) {
4203: $role = &Apache::lonnet::plaintext($role,&course_type());
4204: }
1.359 albertel 4205: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4206: } else {
4207: $role = &Apache::lonnet::plaintext($role);
1.54 www 4208: }
1.433 albertel 4209:
1.359 albertel 4210: if (!$realm) { $realm=' '; }
1.55 www 4211: # Set messages
1.60 matthew 4212: my $messages=&domainlogo($domain);
1.330 albertel 4213:
1.438 albertel 4214: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4215:
1.101 www 4216: # construct main body tag
1.359 albertel 4217: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4218: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4219:
1.530 albertel 4220: if ($bodyonly) {
1.60 matthew 4221: return $bodytag;
1.258 albertel 4222: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4223: # Accessibility
1.224 raeburn 4224:
1.337 albertel 4225: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4226: if (!$notitle) {
1.337 albertel 4227: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4228: }
4229: return $bodytag;
1.359 albertel 4230: }
4231:
1.410 albertel 4232: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4233: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4234: undef($role);
1.434 albertel 4235: } else {
4236: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4237: }
1.359 albertel 4238:
4239: my $roleinfo=(<<ENDROLE);
4240: <td class="LC_title_bar_who">
4241: <div class="LC_title_bar_name">
1.410 albertel 4242: $name
1.361 albertel 4243:
1.359 albertel 4244: </div>
4245: <div class="LC_title_bar_role">
1.361 albertel 4246: $role
1.359 albertel 4247: </div>
4248: <div class="LC_title_bar_realm">
1.361 albertel 4249: $realm
1.359 albertel 4250: </div>
1.206 albertel 4251: </td>
4252: ENDROLE
1.235 raeburn 4253:
1.762 bisitz 4254: my $titleinfo = '<h1>'.$title.'</h1>';
1.359 albertel 4255: if ($customtitle) {
4256: $titleinfo = $customtitle;
4257: }
4258: #
4259: # Extra info if you are the DC
4260: my $dc_info = '';
4261: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4262: $env{'course.'.$env{'request.course.id'}.
4263: '.domain'}.'/'})) {
4264: my $cid = $env{'request.course.id'};
4265: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4266: $dc_info =~ s/\s+$//;
1.359 albertel 4267: $dc_info = '('.$dc_info.')';
4268: }
4269:
1.644 www 4270: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4271: # No Remote
1.258 albertel 4272: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4273: $forcereg=1;
4274: }
4275:
4276: if (!$customtitle && $env{'request.state'} eq 'construct') {
4277: # this is for resources; directories have customtitle, and crumbs
4278: # and select recent are created in lonpubdir.pm
1.229 albertel 4279: my ($uname,$thisdisfn)=
1.258 albertel 4280: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4281: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4282: $formaction=~s/\/+/\//g;
4283:
1.359 albertel 4284: my $parentpath = '';
4285: my $lastitem = '';
4286: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4287: $parentpath = $1;
4288: $lastitem = $2;
4289: } else {
4290: $lastitem = $thisdisfn;
4291: }
4292: $titleinfo =
1.640 bisitz 4293: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4294: .'<b>'.&mt('Construction Space').'</b>: '
4295: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4296: .'" target="_top"><tt><b>'
1.705 tempelho 4297: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<span class=\"LC_fontsize_big\">$lastitem</span></b></tt><br />"
1.359 albertel 4298: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4299: .'</form>'
4300: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4301: }
1.359 albertel 4302:
1.337 albertel 4303: my $titletable;
1.338 albertel 4304: if (!$notitle) {
1.337 albertel 4305: $titletable =
1.359 albertel 4306: '<table id="LC_title_bar">'.
4307: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4308: '</tr></table>';
1.337 albertel 4309: }
1.359 albertel 4310: if ($notopbar) {
4311: $bodytag .= $titletable;
4312: } else {
4313: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4314: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4315: $titletable);
1.272 raeburn 4316: } else {
1.336 albertel 4317: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4318: $titletable;
1.272 raeburn 4319: }
1.235 raeburn 4320: }
4321: return $bodytag;
1.94 www 4322: }
1.95 www 4323:
1.93 www 4324: #
1.95 www 4325: # Top frame rendering, Remote is up
1.93 www 4326: #
1.359 albertel 4327:
1.517 raeburn 4328: my $imgsrc = $img;
4329: if ($img =~ /^\/adm/) {
1.575 albertel 4330: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4331: }
4332: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4333:
1.305 www 4334: # Explicit link to get inline menu
1.361 albertel 4335: my $menu= ($no_inline_link?''
4336: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4337: #
1.338 albertel 4338: if ($notitle) {
1.337 albertel 4339: return $bodytag;
4340: }
1.94 www 4341: return(<<ENDBODY);
1.60 matthew 4342: $bodytag
1.359 albertel 4343: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4344: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4345: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4346: </tr>
1.359 albertel 4347: <tr><td>$titleinfo $dc_info $menu</td>
4348: $roleinfo
1.368 albertel 4349: </tr>
1.356 albertel 4350: </table>
1.54 www 4351: ENDBODY
1.182 matthew 4352: }
4353:
1.330 albertel 4354: sub make_attr_string {
4355: my ($register,$attr_ref) = @_;
4356:
4357: if ($attr_ref && !ref($attr_ref)) {
4358: die("addentries Must be a hash ref ".
4359: join(':',caller(1))." ".
4360: join(':',caller(0))." ");
4361: }
4362:
4363: if ($register) {
1.339 albertel 4364: my ($on_load,$on_unload);
4365: foreach my $key (keys(%{$attr_ref})) {
4366: if (lc($key) eq 'onload') {
4367: $on_load.=$attr_ref->{$key}.';';
4368: delete($attr_ref->{$key});
4369:
4370: } elsif (lc($key) eq 'onunload') {
4371: $on_unload.=$attr_ref->{$key}.';';
4372: delete($attr_ref->{$key});
4373: }
4374: }
4375: $attr_ref->{'onload'} =
4376: &Apache::lonmenu::loadevents(). $on_load;
4377: $attr_ref->{'onunload'}=
4378: &Apache::lonmenu::unloadevents().$on_unload;
4379: }
4380:
4381: # Accessibility font enhance
4382: if ($env{'browser.fontenhance'} eq 'on') {
4383: my $style;
4384: foreach my $key (keys(%{$attr_ref})) {
4385: if (lc($key) eq 'style') {
4386: $style.=$attr_ref->{$key}.';';
4387: delete($attr_ref->{$key});
4388: }
4389: }
4390: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4391: }
1.339 albertel 4392:
4393: if ($env{'browser.blackwhite'} eq 'on') {
4394: delete($attr_ref->{'font'});
4395: delete($attr_ref->{'link'});
4396: delete($attr_ref->{'alink'});
4397: delete($attr_ref->{'vlink'});
4398: delete($attr_ref->{'bgcolor'});
4399: delete($attr_ref->{'background'});
4400: }
4401:
1.330 albertel 4402: my $attr_string;
4403: foreach my $attr (keys(%$attr_ref)) {
4404: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4405: }
4406: return $attr_string;
4407: }
4408:
4409:
1.182 matthew 4410: ###############################################
1.251 albertel 4411: ###############################################
4412:
4413: =pod
4414:
4415: =item * &endbodytag()
4416:
4417: Returns a uniform footer for LON-CAPA web pages.
4418:
1.635 raeburn 4419: Inputs: 1 - optional reference to an args hash
4420: If in the hash, key for noredirectlink has a value which evaluates to true,
4421: a 'Continue' link is not displayed if the page contains an
4422: internal redirect in the <head></head> section,
4423: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4424:
4425: =cut
4426:
4427: sub endbodytag {
1.635 raeburn 4428: my ($args) = @_;
1.251 albertel 4429: my $endbodytag='</body>';
1.269 albertel 4430: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4431: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4432: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4433: $endbodytag=
4434: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4435: &mt('Continue').'</a>'.
4436: $endbodytag;
4437: }
1.315 albertel 4438: }
1.251 albertel 4439: return $endbodytag;
4440: }
4441:
1.352 albertel 4442: =pod
4443:
4444: =item * &standard_css()
4445:
4446: Returns a style sheet
4447:
4448: Inputs: (all optional)
4449: domain -> force to color decorate a page for a specific
4450: domain
4451: function -> force usage of a specific rolish color scheme
4452: bgcolor -> override the default page bgcolor
4453:
4454: =cut
4455:
1.343 albertel 4456: sub standard_css {
1.345 albertel 4457: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4458: $function = &get_users_function() if (!$function);
4459: my $img = &designparm($function.'.img', $domain);
4460: my $tabbg = &designparm($function.'.tabbg', $domain);
4461: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4462: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4463: my $pgbg_or_bgcolor =
4464: $bgcolor ||
1.352 albertel 4465: &designparm($function.'.pgbg', $domain);
1.382 albertel 4466: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4467: my $alink = &designparm($function.'.alink', $domain);
4468: my $vlink = &designparm($function.'.vlink', $domain);
4469: my $link = &designparm($function.'.link', $domain);
4470:
1.704 muellerd 4471: my $loginbg = &designparm('login.sidebg',$domain);
1.712 muellerd 4472: my $bgcol = &designparm('login.bgcol',$domain);
4473: my $textcol = &designparm('login.textcol',$domain);
1.704 muellerd 4474:
1.602 albertel 4475: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4476: my $mono = 'monospace';
1.352 albertel 4477: my $data_table_head = $tabbg;
4478: my $data_table_light = '#EEEEEE';
1.470 banghart 4479: my $data_table_dark = '#DDDDDD';
4480: my $data_table_darker = '#CCCCCC';
1.349 albertel 4481: my $data_table_highlight = '#FFFF00';
1.352 albertel 4482: my $mail_new = '#FFBB77';
4483: my $mail_new_hover = '#DD9955';
4484: my $mail_read = '#BBBB77';
4485: my $mail_read_hover = '#999944';
4486: my $mail_replied = '#AAAA88';
4487: my $mail_replied_hover = '#888855';
4488: my $mail_other = '#99BBBB';
4489: my $mail_other_hover = '#669999';
1.391 albertel 4490: my $table_header = '#DDDDDD';
1.489 raeburn 4491: my $feedback_link_bg = '#BBBBBB';
1.701 harmsja 4492: my $lg_border_color = '#C8C8C8';
1.392 albertel 4493:
1.608 albertel 4494: my $border = ($env{'browser.type'} eq 'explorer' ||
4495: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4496: : '0px 3px 0px 4px';
1.448 albertel 4497:
1.523 albertel 4498:
1.343 albertel 4499: return <<END;
1.698 harmsja 4500: body{
4501: font-family: $sans;
4502: line-height:130%;
1.701 harmsja 4503: font-size:0.83em;
1.698 harmsja 4504: color:$font;
4505: }
1.701 harmsja 4506: a:link, a:visited { font-size:100%; }
1.698 harmsja 4507:
1.779 ! bisitz 4508: a:focus { color: red; background: yellow }
1.510 albertel 4509: table.thinborder,
4510: table.thinborder tr th {
4511: border-style: solid;
4512: border-width: 1px;
1.698 harmsja 4513: border-color: $lg_border_color;
1.510 albertel 4514: background: $tabbg;
4515: }
1.523 albertel 4516: table.thinborder tr td {
1.510 albertel 4517: border-style: solid;
1.698 harmsja 4518: border-width: 1px;
4519: border-color: $lg_border_color;
1.510 albertel 4520: }
1.426 albertel 4521:
1.343 albertel 4522: form, .inline { display: inline; }
1.721 harmsja 4523:
4524: .LC_right {text-align:right;}
4525: .LC_middle {vertical-align:middle;}
4526:
4527: /* just for tests */
1.754 droeschl 4528: .LC_400Box {width:400px; }
1.721 harmsja 4529: /* end */
4530:
1.778 bisitz 4531: .LC_filename {
4532: font-family: $mono;
4533: white-space:pre;
4534: }
4535:
4536: .LC_fileicon {
4537: border: none;
4538: height: 1.3em;
4539: vertical-align: text-bottom;
4540: margin-right: 0.3em;
4541: text-decoration:none;
4542: }
4543:
1.350 albertel 4544: .LC_error {
4545: color: red;
4546: font-size: larger;
4547: }
1.457 albertel 4548: .LC_warning,
4549: .LC_diff_removed {
1.733 bisitz 4550: color: red;
1.394 albertel 4551: }
1.532 albertel 4552:
4553: .LC_info,
1.457 albertel 4554: .LC_success,
4555: .LC_diff_added {
1.350 albertel 4556: color: green;
4557: }
1.543 albertel 4558: .LC_unknown {
4559: color: yellow;
4560: }
4561:
1.440 albertel 4562: .LC_icon {
1.771 droeschl 4563: border: none;
4564: }
4565:
1.539 albertel 4566: .LC_indexer_icon {
4567: border: 0px;
4568: height: 22px;
4569: }
1.543 albertel 4570: .LC_docs_spacer {
4571: width: 25px;
4572: height: 1px;
1.771 droeschl 4573: border: none;
1.543 albertel 4574: }
1.346 albertel 4575:
1.532 albertel 4576: .LC_internal_info {
1.735 bisitz 4577: color: #999999;
1.532 albertel 4578: }
4579:
1.458 albertel 4580: table.LC_pastsubmission {
4581: border: 1px solid black;
4582: margin: 2px;
4583: }
4584:
1.606 albertel 4585: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4586: width: 100%;
4587: background: $pgbg;
1.392 albertel 4588: border: 2px;
1.402 albertel 4589: border-collapse: separate;
1.403 albertel 4590: padding: 0px;
1.345 albertel 4591: }
1.392 albertel 4592:
1.779 ! bisitz 4593: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4594: table#LC_title_bar.LC_with_remote {
1.359 albertel 4595: width: 100%;
1.392 albertel 4596: border-color: $pgbg;
4597: border-style: solid;
4598: border-width: $border;
4599:
1.379 albertel 4600: background: $pgbg;
4601: font-family: $sans;
1.392 albertel 4602: border-collapse: collapse;
1.403 albertel 4603: padding: 0px;
1.359 albertel 4604: }
1.409 albertel 4605: table.LC_docs_path {
4606: width: 100%;
4607: border: 0;
4608: background: $pgbg;
4609: font-family: $sans;
4610: border-collapse: collapse;
4611: padding: 0px;
4612: }
4613:
1.359 albertel 4614: table#LC_title_bar td {
4615: background: $tabbg;
4616: }
1.773 ehlerst 4617: table#LC_title_bar .LC_title_bar_who {
1.359 albertel 4618: background: $tabbg;
4619: color: $font;
1.427 albertel 4620: font: small $sans;
1.359 albertel 4621: text-align: right;
1.773 ehlerst 4622: margin: 0px;
4623: }
4624: table#LC_title_bar .LC_title_bar_name {
4625: margin: 0px;
4626: }
4627: table#LC_title_bar .LC_title_bar_role {
4628: margin: 0px;
4629: }
1.775 bisitz 4630: table#LC_title_bar .LC_title_bar_realm {
1.773 ehlerst 4631: margin: 0px;
1.359 albertel 4632: }
1.469 banghart 4633: span.LC_metadata {
4634: font-family: $sans;
4635: }
1.359 albertel 4636: table#LC_title_bar td.LC_title_bar_domain_logo {
4637: background: $sidebg;
4638: text-align: right;
1.368 albertel 4639: padding: 0px;
4640: }
4641: table#LC_title_bar td.LC_title_bar_role_logo {
4642: background: $sidebg;
4643: padding: 0px;
1.359 albertel 4644: }
4645:
1.706 harmsja 4646: table#LC_menubuttons img{
1.346 albertel 4647: border: 0px;
4648: }
1.345 albertel 4649: table#LC_top_nav td {
4650: background: $tabbg;
1.392 albertel 4651: border: 0px;
1.407 albertel 4652: font-size: small;
1.706 harmsja 4653: vertical-align:top;
4654: padding:2px 5px 2px 5px;
1.345 albertel 4655: }
4656: table#LC_top_nav td a, div#LC_top_nav a {
4657: color: $font;
4658: font-family: $sans;
4659: }
1.364 albertel 4660: table#LC_top_nav td.LC_top_nav_logo {
4661: background: $tabbg;
1.432 albertel 4662: text-align: left;
1.408 albertel 4663: white-space: nowrap;
1.432 albertel 4664: width: 31px;
1.408 albertel 4665: }
4666: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4667: border: 0px;
1.408 albertel 4668: vertical-align: bottom;
1.364 albertel 4669: }
1.777 tempelho 4670: table#LC_top_nav td.LC_top_nav_exit,
1.779 ! bisitz 4671: table#LC_top_nav td.LC_top_nav_help {
1.777 tempelho 4672: width: 2.0em;
4673: }
1.442 albertel 4674: table#LC_top_nav td.LC_top_nav_login {
4675: width: 4.0em;
4676: text-align: center;
4677: }
1.409 albertel 4678: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4679: background: $tabbg;
4680: color: $font;
4681: font-family: $sans;
1.358 albertel 4682: font-size: smaller;
1.357 albertel 4683: }
1.777 tempelho 4684: table.LC_breadcrumbs td.LC_breadcrumbs_component,
4685: table.LC_docs_path td.LC_docs_path_component {
1.779 ! bisitz 4686: background: $tabbg;
1.777 tempelho 4687: color: $font;
4688: font-family: $sans;
1.779 ! bisitz 4689: font-size: larger;
! 4690: text-align: right;
1.777 tempelho 4691: }
1.383 albertel 4692: td.LC_table_cell_checkbox {
4693: text-align: center;
4694: }
1.779 ! bisitz 4695: table#LC_mainmenu td.LC_mainmenu_column {
! 4696: vertical-align: top;
1.777 tempelho 4697: }
1.522 albertel 4698:
1.705 tempelho 4699: .LC_fontsize_small
4700: {
4701: font-size: 70%;
4702: }
4703:
4704: .LC_fontsize_medium
4705: {
4706: font-size: 85%;
4707: }
4708:
4709: .LC_fontsize_large
4710: {
4711: font-size: 120%;
4712: }
4713:
1.346 albertel 4714: .LC_menubuttons_inline_text {
4715: color: $font;
4716: font-family: $sans;
1.698 harmsja 4717: font-size: 90%;
1.701 harmsja 4718: padding-left:3px;
1.346 albertel 4719: }
4720:
1.526 www 4721: .LC_menubuttons_link {
4722: text-decoration: none;
4723: }
1.698 harmsja 4724: /*2008--9-5: new menu style sheet.Changed category*/
1.522 albertel 4725: .LC_menubuttons_category {
1.521 www 4726: color: $font;
1.526 www 4727: background: $pgbg;
1.521 www 4728: font-family: $sans;
4729: font-size: larger;
4730: font-weight: bold;
4731: }
4732:
1.346 albertel 4733: td.LC_menubuttons_text {
1.779 ! bisitz 4734: color: $font;
1.346 albertel 4735: }
1.706 harmsja 4736:
4737:
1.526 www 4738:
1.346 albertel 4739: .LC_current_location {
4740: font-family: $sans;
4741: background: $tabbg;
4742: }
4743: .LC_new_mail {
4744: font-family: $sans;
1.634 www 4745: background: $tabbg;
1.346 albertel 4746: font-weight: bold;
4747: }
1.347 albertel 4748:
1.526 www 4749:
1.527 www 4750: .LC_dropadd_labeltext {
4751: font-family: $sans;
4752: text-align: right;
4753: }
4754:
4755: .LC_preferences_labeltext {
4756: font-family: $sans;
4757: text-align: right;
4758: }
4759:
1.666 raeburn 4760: .LC_roleslog_note {
1.701 harmsja 4761: font-size: small;
1.666 raeburn 4762: }
4763:
1.715 raeburn 4764: .LC_mail_functions {
4765: font-weight: bold;
4766: }
4767:
1.440 albertel 4768: table.LC_aboutme_port {
4769: border: 0px;
4770: border-collapse: collapse;
4771: border-spacing: 0px;
4772: }
1.349 albertel 4773: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4774: border: 1px solid #000000;
1.402 albertel 4775: border-collapse: separate;
1.426 albertel 4776: border-spacing: 1px;
1.610 albertel 4777: background: $pgbg;
1.347 albertel 4778: }
1.422 albertel 4779: .LC_data_table_dense {
4780: font-size: small;
4781: }
1.507 raeburn 4782: table.LC_nested_outer {
4783: border: 1px solid #000000;
1.589 raeburn 4784: border-collapse: collapse;
1.507 raeburn 4785: border-spacing: 0px;
4786: width: 100%;
4787: }
4788: table.LC_nested {
4789: border: 0px;
1.589 raeburn 4790: border-collapse: collapse;
1.507 raeburn 4791: border-spacing: 0px;
4792: width: 100%;
4793: }
1.523 albertel 4794: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4795: table.LC_prior_tries tr th {
1.349 albertel 4796: font-weight: bold;
4797: background-color: $data_table_head;
1.701 harmsja 4798: font-size:90%;
1.347 albertel 4799: }
1.711 raeburn 4800: table.LC_data_table tr.LC_info_row > td {
1.735 bisitz 4801: background-color: #CCCCCC;
1.711 raeburn 4802: font-weight: bold;
4803: text-align: left;
4804: }
1.779 ! bisitz 4805: table.LC_data_table tr.LC_odd_row > td,
1.709 bisitz 4806: table.LC_pick_box tr > td.LC_odd_row,
1.440 albertel 4807: table.LC_aboutme_port tr td {
1.349 albertel 4808: background-color: $data_table_light;
1.425 albertel 4809: padding: 2px;
1.347 albertel 4810: }
1.610 albertel 4811: table.LC_data_table tr.LC_even_row > td,
1.709 bisitz 4812: table.LC_pick_box tr > td.LC_even_row,
1.440 albertel 4813: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4814: background-color: $data_table_dark;
1.709 bisitz 4815: padding: 2px;
1.347 albertel 4816: }
1.425 albertel 4817: table.LC_data_table tr.LC_data_table_highlight td {
4818: background-color: $data_table_darker;
4819: }
1.639 raeburn 4820: table.LC_data_table tr td.LC_leftcol_header {
4821: background-color: $data_table_head;
4822: font-weight: bold;
4823: }
1.451 albertel 4824: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4825: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4826: background-color: #FFFFFF;
1.421 albertel 4827: font-weight: bold;
4828: font-style: italic;
4829: text-align: center;
4830: padding: 8px;
1.347 albertel 4831: }
1.507 raeburn 4832: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4833: padding: 4ex
4834: }
1.507 raeburn 4835: table.LC_nested_outer tr th {
4836: font-weight: bold;
4837: background-color: $data_table_head;
1.701 harmsja 4838: font-size: small;
1.507 raeburn 4839: border-bottom: 1px solid #000000;
4840: }
4841: table.LC_nested_outer tr td.LC_subheader {
4842: background-color: $data_table_head;
4843: font-weight: bold;
4844: font-size: small;
4845: border-bottom: 1px solid #000000;
4846: text-align: right;
1.451 albertel 4847: }
1.507 raeburn 4848: table.LC_nested tr.LC_info_row td {
1.735 bisitz 4849: background-color: #CCCCCC;
1.451 albertel 4850: font-weight: bold;
4851: font-size: small;
1.507 raeburn 4852: text-align: center;
4853: }
1.589 raeburn 4854: table.LC_nested tr.LC_info_row td.LC_left_item,
4855: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4856: text-align: left;
1.451 albertel 4857: }
1.507 raeburn 4858: table.LC_nested td {
1.735 bisitz 4859: background-color: #FFFFFF;
1.451 albertel 4860: font-size: small;
1.507 raeburn 4861: }
4862: table.LC_nested_outer tr th.LC_right_item,
4863: table.LC_nested tr.LC_info_row td.LC_right_item,
4864: table.LC_nested tr.LC_odd_row td.LC_right_item,
4865: table.LC_nested tr td.LC_right_item {
1.451 albertel 4866: text-align: right;
4867: }
4868:
1.507 raeburn 4869: table.LC_nested tr.LC_odd_row td {
1.735 bisitz 4870: background-color: #EEEEEE;
1.451 albertel 4871: }
4872:
1.473 raeburn 4873: table.LC_createuser {
4874: }
4875:
4876: table.LC_createuser tr.LC_section_row td {
1.701 harmsja 4877: font-size: small;
1.473 raeburn 4878: }
4879:
4880: table.LC_createuser tr.LC_info_row td {
1.735 bisitz 4881: background-color: #CCCCCC;
1.473 raeburn 4882: font-weight: bold;
4883: text-align: center;
4884: }
4885:
1.349 albertel 4886: table.LC_calendar {
4887: border: 1px solid #000000;
4888: border-collapse: collapse;
4889: }
4890: table.LC_calendar_pickdate {
4891: font-size: xx-small;
4892: }
4893: table.LC_calendar tr td {
4894: border: 1px solid #000000;
4895: vertical-align: top;
4896: }
4897: table.LC_calendar tr td.LC_calendar_day_empty {
4898: background-color: $data_table_dark;
4899: }
1.779 ! bisitz 4900: table.LC_calendar tr td.LC_calendar_day_current {
! 4901: background-color: $data_table_highlight;
1.777 tempelho 4902: }
1.349 albertel 4903: table.LC_mail_list tr.LC_mail_new {
4904: background-color: $mail_new;
4905: }
4906: table.LC_mail_list tr.LC_mail_new:hover {
4907: background-color: $mail_new_hover;
4908: }
1.777 tempelho 4909: table.LC_mail_list tr.LC_mail_even{
4910: }
4911: table.LC_mail_list tr.LC_mail_odd{
4912: }
1.349 albertel 4913: table.LC_mail_list tr.LC_mail_read {
4914: background-color: $mail_read;
4915: }
4916: table.LC_mail_list tr.LC_mail_read:hover {
4917: background-color: $mail_read_hover;
4918: }
4919: table.LC_mail_list tr.LC_mail_replied {
4920: background-color: $mail_replied;
4921: }
4922: table.LC_mail_list tr.LC_mail_replied:hover {
4923: background-color: $mail_replied_hover;
4924: }
4925: table.LC_mail_list tr.LC_mail_other {
4926: background-color: $mail_other;
4927: }
4928: table.LC_mail_list tr.LC_mail_other:hover {
4929: background-color: $mail_other_hover;
4930: }
1.494 raeburn 4931:
1.777 tempelho 4932: table.LC_data_table tr > td.LC_browser_file,
4933: table.LC_data_table tr > td.LC_browser_file_published {
1.389 albertel 4934: background: #CCFF88;
4935: }
1.777 tempelho 4936: table.LC_data_table tr > td.LC_browser_file_locked,
4937: table.LC_data_table tr > td.LC_browser_file_unpublished {
1.389 albertel 4938: background: #FFAA99;
1.387 albertel 4939: }
1.777 tempelho 4940: table.LC_data_table tr > td.LC_browser_file_obsolete {
1.779 ! bisitz 4941: background: #AAAAAA;
! 4942: }
1.777 tempelho 4943: table.LC_data_table tr > td.LC_browser_file_modified,
1.779 ! bisitz 4944: table.LC_data_table tr > td.LC_browser_file_metamodified {
! 4945: background: #FFFF77;
1.777 tempelho 4946: }
1.696 bisitz 4947: table.LC_data_table tr.LC_browser_folder > td {
1.389 albertel 4948: background: #CCCCFF;
1.387 albertel 4949: }
1.696 bisitz 4950:
1.707 bisitz 4951: table.LC_data_table tr > td.LC_roles_is {
4952: /* background: #77FF77; */
4953: }
4954: table.LC_data_table tr > td.LC_roles_future {
4955: background: #FFFF77;
4956: }
4957: table.LC_data_table tr > td.LC_roles_will {
4958: background: #FFAA77;
4959: }
4960: table.LC_data_table tr > td.LC_roles_expired {
4961: background: #FF7777;
4962: }
4963: table.LC_data_table tr > td.LC_roles_will_not {
4964: background: #AAFF77;
4965: }
4966: table.LC_data_table tr > td.LC_roles_selected {
4967: background: #11CC55;
4968: }
4969:
1.388 albertel 4970: span.LC_current_location {
1.701 harmsja 4971: font-size:larger;
1.388 albertel 4972: background: $pgbg;
4973: }
1.387 albertel 4974:
1.395 albertel 4975: span.LC_parm_menu_item {
4976: font-size: larger;
4977: font-family: $sans;
4978: }
4979: span.LC_parm_scope_all {
4980: color: red;
4981: }
4982: span.LC_parm_scope_folder {
4983: color: green;
4984: }
4985: span.LC_parm_scope_resource {
4986: color: orange;
4987: }
4988: span.LC_parm_part {
4989: color: blue;
4990: }
4991: span.LC_parm_folder, span.LC_parm_symb {
4992: font-size: x-small;
4993: font-family: $mono;
4994: color: #AAAAAA;
4995: }
4996:
1.396 albertel 4997: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
1.777 tempelho 4998: td.LC_parm_overview_parm_selectors,td.LC_parm_overview_restrictions {
1.396 albertel 4999: border: 1px solid black;
5000: border-collapse: collapse;
5001: }
5002: table.LC_parm_overview_restrictions td {
5003: border-width: 1px 4px 1px 4px;
5004: border-style: solid;
5005: border-color: $pgbg;
5006: text-align: center;
5007: }
5008: table.LC_parm_overview_restrictions th {
5009: background: $tabbg;
5010: border-width: 1px 4px 1px 4px;
5011: border-style: solid;
5012: border-color: $pgbg;
5013: }
1.398 albertel 5014: table#LC_helpmenu {
5015: border: 0px;
5016: height: 55px;
5017: border-spacing: 0px;
5018: }
5019:
5020: table#LC_helpmenu fieldset legend {
5021: font-size: larger;
5022: font-weight: bold;
5023: }
1.397 albertel 5024: table#LC_helpmenu_links {
5025: width: 100%;
5026: border: 1px solid black;
5027: background: $pgbg;
5028: padding: 0px;
5029: border-spacing: 1px;
5030: }
5031: table#LC_helpmenu_links tr td {
5032: padding: 1px;
5033: background: $tabbg;
1.399 albertel 5034: text-align: center;
5035: font-weight: bold;
1.397 albertel 5036: }
1.396 albertel 5037:
1.397 albertel 5038: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
5039: table#LC_helpmenu_links a:active {
5040: text-decoration: none;
5041: color: $font;
5042: }
5043: table#LC_helpmenu_links a:hover {
5044: text-decoration: underline;
5045: color: $vlink;
5046: }
1.396 albertel 5047:
1.417 albertel 5048: .LC_chrt_popup_exists {
5049: border: 1px solid #339933;
5050: margin: -1px;
5051: }
5052: .LC_chrt_popup_up {
5053: border: 1px solid yellow;
5054: margin: -1px;
5055: }
5056: .LC_chrt_popup {
5057: border: 1px solid #8888FF;
5058: background: #CCCCFF;
5059: }
1.421 albertel 5060: table.LC_pick_box {
5061: border-collapse: separate;
5062: background: white;
5063: border: 1px solid black;
5064: border-spacing: 1px;
5065: }
5066: table.LC_pick_box td.LC_pick_box_title {
5067: background: $tabbg;
5068: font-weight: bold;
5069: text-align: right;
1.740 bisitz 5070: vertical-align: top;
1.421 albertel 5071: width: 184px;
5072: padding: 8px;
5073: }
1.645 raeburn 5074: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5075: background: $tabbg;
5076: font-weight: bold;
5077: text-align: right;
5078: width: 350px;
5079: padding: 8px;
5080: }
5081:
1.579 raeburn 5082: table.LC_pick_box td.LC_pick_box_value {
5083: text-align: left;
5084: padding: 8px;
5085: }
5086: table.LC_pick_box td.LC_pick_box_select {
5087: text-align: left;
5088: padding: 8px;
5089: }
1.424 albertel 5090: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5091: padding: 0px;
5092: height: 1px;
5093: background: black;
5094: }
5095: table.LC_pick_box td.LC_pick_box_submit {
5096: text-align: right;
5097: }
1.579 raeburn 5098: table.LC_pick_box td.LC_evenrow_value {
5099: text-align: left;
5100: padding: 8px;
5101: background-color: $data_table_light;
5102: }
5103: table.LC_pick_box td.LC_oddrow_value {
5104: text-align: left;
5105: padding: 8px;
5106: background-color: $data_table_light;
5107: }
5108: table.LC_helpform_receipt {
5109: width: 620px;
5110: border-collapse: separate;
5111: background: white;
5112: border: 1px solid black;
5113: border-spacing: 1px;
5114: }
5115: table.LC_helpform_receipt td.LC_pick_box_title {
5116: background: $tabbg;
5117: font-weight: bold;
5118: text-align: right;
5119: width: 184px;
5120: padding: 8px;
5121: }
5122: table.LC_helpform_receipt td.LC_evenrow_value {
5123: text-align: left;
5124: padding: 8px;
5125: background-color: $data_table_light;
5126: }
5127: table.LC_helpform_receipt td.LC_oddrow_value {
5128: text-align: left;
5129: padding: 8px;
5130: background-color: $data_table_light;
5131: }
5132: table.LC_helpform_receipt td.LC_pick_box_separator {
5133: padding: 0px;
5134: height: 1px;
5135: background: black;
5136: }
5137: span.LC_helpform_receipt_cat {
5138: font-weight: bold;
5139: }
1.424 albertel 5140: table.LC_group_priv_box {
5141: background: white;
5142: border: 1px solid black;
5143: border-spacing: 1px;
5144: }
5145: table.LC_group_priv_box td.LC_pick_box_title {
5146: background: $tabbg;
5147: font-weight: bold;
5148: text-align: right;
5149: width: 184px;
5150: }
5151: table.LC_group_priv_box td.LC_groups_fixed {
5152: background: $data_table_light;
5153: text-align: center;
5154: }
5155: table.LC_group_priv_box td.LC_groups_optional {
5156: background: $data_table_dark;
5157: text-align: center;
5158: }
5159: table.LC_group_priv_box td.LC_groups_functionality {
5160: background: $data_table_darker;
5161: text-align: center;
5162: font-weight: bold;
5163: }
5164: table.LC_group_priv td {
5165: text-align: left;
5166: padding: 0px;
5167: }
5168:
1.421 albertel 5169: table.LC_notify_front_page {
5170: background: white;
5171: border: 1px solid black;
5172: padding: 8px;
5173: }
5174: table.LC_notify_front_page td {
5175: padding: 8px;
5176: }
1.424 albertel 5177: .LC_navbuttons {
5178: margin: 2ex 0ex 2ex 0ex;
5179: }
1.423 albertel 5180: .LC_topic_bar {
5181: font-family: $sans;
5182: font-weight: bold;
5183: width: 100%;
5184: background: $tabbg;
5185: vertical-align: middle;
5186: margin: 2ex 0ex 2ex 0ex;
5187: }
5188: .LC_topic_bar span {
5189: vertical-align: middle;
5190: }
5191: .LC_topic_bar img {
5192: vertical-align: bottom;
5193: }
5194: table.LC_course_group_status {
5195: margin: 20px;
5196: }
5197: table.LC_status_selector td {
5198: vertical-align: top;
5199: text-align: center;
1.424 albertel 5200: padding: 4px;
5201: }
5202: table.LC_descriptive_input td.LC_description {
5203: vertical-align: top;
5204: text-align: right;
5205: font-weight: bold;
1.423 albertel 5206: }
1.599 albertel 5207: div.LC_feedback_link {
1.616 albertel 5208: clear: both;
1.599 albertel 5209: background: white;
1.779 ! bisitz 5210: width: 100%;
1.489 raeburn 5211: }
5212: span.LC_feedback_link {
1.599 albertel 5213: background: $feedback_link_bg;
5214: font-size: larger;
5215: }
5216: span.LC_message_link {
5217: background: $feedback_link_bg;
5218: font-size: larger;
5219: position: absolute;
5220: right: 1em;
1.489 raeburn 5221: }
1.421 albertel 5222:
1.515 albertel 5223: table.LC_prior_tries {
1.524 albertel 5224: border: 1px solid #000000;
5225: border-collapse: separate;
5226: border-spacing: 1px;
1.515 albertel 5227: }
1.523 albertel 5228:
1.515 albertel 5229: table.LC_prior_tries td {
1.524 albertel 5230: padding: 2px;
1.515 albertel 5231: }
1.523 albertel 5232:
5233: .LC_answer_correct {
5234: background: #AAFFAA;
5235: color: black;
5236: }
5237: .LC_answer_charged_try {
5238: background: #FFAAAA ! important;
5239: color: black;
5240: }
1.779 ! bisitz 5241: .LC_answer_not_charged_try,
1.523 albertel 5242: .LC_answer_no_grade,
5243: .LC_answer_late {
5244: background: #FFFFAA;
5245: color: black;
5246: }
5247: .LC_answer_previous {
5248: background: #AAAAFF;
5249: color: black;
5250: }
1.779 ! bisitz 5251: .LC_answer_no_message {
1.777 tempelho 5252: background: #FFFFFF;
5253: color: black;
1.779 ! bisitz 5254: }
! 5255: .LC_answer_unknown {
! 5256: background: orange;
! 5257: color: black;
1.777 tempelho 5258: }
1.529 albertel 5259: span.LC_prior_numerical,
5260: span.LC_prior_string,
5261: span.LC_prior_custom,
5262: span.LC_prior_reaction,
5263: span.LC_prior_math {
1.523 albertel 5264: font-family: monospace;
5265: white-space: pre;
5266: }
5267:
1.525 albertel 5268: span.LC_prior_string {
5269: font-family: monospace;
5270: white-space: pre;
5271: }
5272:
1.523 albertel 5273: table.LC_prior_option {
5274: width: 100%;
5275: border-collapse: collapse;
5276: }
1.528 albertel 5277: table.LC_prior_rank, table.LC_prior_match {
5278: border-collapse: collapse;
5279: }
5280: table.LC_prior_option tr td,
5281: table.LC_prior_rank tr td,
5282: table.LC_prior_match tr td {
1.524 albertel 5283: border: 1px solid #000000;
1.515 albertel 5284: }
5285:
1.770 droeschl 5286: td.LC_nobreak,
1.519 raeburn 5287: span.LC_nobreak {
1.544 albertel 5288: white-space: nowrap;
1.519 raeburn 5289: }
5290:
1.576 raeburn 5291: span.LC_cusr_emph {
5292: font-style: italic;
5293: }
5294:
1.633 raeburn 5295: span.LC_cusr_subheading {
5296: font-weight: normal;
5297: font-size: 85%;
5298: }
5299:
1.545 albertel 5300: table.LC_docs_documents {
5301: background: #BBBBBB;
1.547 albertel 5302: border-width: 0px;
1.545 albertel 5303: border-collapse: collapse;
5304: }
1.777 tempelho 5305: table.LC_docs_documents td.LC_docs_document {
1.779 ! bisitz 5306: border: 2px solid black;
! 5307: padding: 4px;
1.777 tempelho 5308: }
1.545 albertel 5309: .LC_docs_entry_move {
5310: border: 0px;
5311: border-collapse: collapse;
1.544 albertel 5312: }
5313:
1.545 albertel 5314: .LC_docs_entry_move td {
5315: border: 2px solid #BBBBBB;
5316: background: #DDDDDD;
5317: }
5318:
5319: .LC_docs_editor td.LC_docs_entry_commands {
5320: background: #DDDDDD;
5321: font-size: x-small;
5322: }
1.544 albertel 5323: .LC_docs_copy {
1.545 albertel 5324: color: #000099;
1.544 albertel 5325: }
5326: .LC_docs_cut {
1.545 albertel 5327: color: #550044;
1.544 albertel 5328: }
5329: .LC_docs_rename {
1.545 albertel 5330: color: #009900;
1.544 albertel 5331: }
5332: .LC_docs_remove {
1.545 albertel 5333: color: #990000;
5334: }
5335:
1.547 albertel 5336: .LC_docs_reinit_warn,
5337: .LC_docs_ext_edit {
5338: font-size: x-small;
5339: }
5340:
1.545 albertel 5341: .LC_docs_editor td.LC_docs_entry_title,
5342: .LC_docs_editor td.LC_docs_entry_icon {
5343: background: #FFFFBB;
5344: }
5345: .LC_docs_editor td.LC_docs_entry_parameter {
5346: background: #BBBBFF;
5347: font-size: x-small;
5348: white-space: nowrap;
5349: }
5350:
5351: table.LC_docs_adddocs td,
5352: table.LC_docs_adddocs th {
5353: border: 1px solid #BBBBBB;
5354: padding: 4px;
5355: background: #DDDDDD;
1.543 albertel 5356: }
5357:
1.584 albertel 5358: table.LC_sty_begin {
5359: background: #BBFFBB;
5360: }
5361: table.LC_sty_end {
5362: background: #FFBBBB;
5363: }
5364:
1.589 raeburn 5365: table.LC_double_column {
5366: border-width: 0px;
5367: border-collapse: collapse;
5368: width: 100%;
5369: padding: 2px;
5370: }
5371:
5372: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5373: top: 2px;
1.589 raeburn 5374: left: 2px;
5375: width: 47%;
5376: vertical-align: top;
5377: }
5378:
5379: table.LC_double_column tr td.LC_right_col {
5380: top: 2px;
1.779 ! bisitz 5381: right: 2px;
1.589 raeburn 5382: width: 47%;
5383: vertical-align: top;
5384: }
5385:
1.594 raeburn 5386: span.LC_role_level {
5387: font-weight: bold;
5388: }
5389:
1.591 raeburn 5390: div.LC_left_float {
5391: float: left;
5392: padding-right: 5%;
1.597 albertel 5393: padding-bottom: 4px;
1.591 raeburn 5394: }
5395:
5396: div.LC_clear_float_header {
1.597 albertel 5397: padding-bottom: 2px;
1.591 raeburn 5398: }
5399:
5400: div.LC_clear_float_footer {
1.597 albertel 5401: padding-top: 10px;
1.591 raeburn 5402: clear: both;
5403: }
5404:
1.597 albertel 5405:
5406: div.LC_grade_show_user {
5407: margin-top: 20px;
5408: border: 1px solid black;
5409: }
5410: div.LC_grade_user_name {
5411: background: #DDDDEE;
5412: border-bottom: 1px solid black;
1.705 tempelho 5413: font-weight: bold;
5414: font-size: large;
1.597 albertel 5415: }
5416: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5417: background: #DDEEDD;
5418: }
5419:
5420: div.LC_grade_show_problem,
5421: div.LC_grade_submissions,
5422: div.LC_grade_message_center,
5423: div.LC_grade_info_links,
5424: div.LC_grade_assign {
5425: margin: 5px;
5426: width: 99%;
5427: background: #FFFFFF;
5428: }
5429: div.LC_grade_show_problem_header,
5430: div.LC_grade_submissions_header,
5431: div.LC_grade_message_center_header,
5432: div.LC_grade_assign_header {
1.705 tempelho 5433: font-weight: bold;
5434: font-size: large;
1.597 albertel 5435: }
5436: div.LC_grade_show_problem_problem,
5437: div.LC_grade_submissions_body,
5438: div.LC_grade_message_center_body,
5439: div.LC_grade_assign_body {
5440: border: 1px solid black;
5441: width: 99%;
5442: background: #FFFFFF;
5443: }
1.598 albertel 5444: span.LC_grade_check_note {
1.705 tempelho 5445: font-weight: normal;
5446: font-size: medium;
1.598 albertel 5447: display: inline;
5448: position: absolute;
5449: right: 1em;
5450: }
1.597 albertel 5451:
1.613 albertel 5452: table.LC_scantron_action {
5453: width: 100%;
5454: }
5455: table.LC_scantron_action tr th {
1.698 harmsja 5456: font-weight:bold;
5457: font-style:normal;
1.613 albertel 5458: }
1.779 ! bisitz 5459: .LC_edit_problem_header,
1.614 albertel 5460: div.LC_edit_problem_footer {
1.705 tempelho 5461: font-weight: normal;
5462: font-size: medium;
1.602 albertel 5463: margin: 2px;
1.600 albertel 5464: }
5465: div.LC_edit_problem_header,
1.602 albertel 5466: div.LC_edit_problem_header div,
1.614 albertel 5467: div.LC_edit_problem_footer,
5468: div.LC_edit_problem_footer div,
1.602 albertel 5469: div.LC_edit_problem_editxml_header,
5470: div.LC_edit_problem_editxml_header div {
1.600 albertel 5471: margin-top: 5px;
5472: }
1.602 albertel 5473: div.LC_edit_problem_header_edit_row {
5474: background: $tabbg;
5475: padding: 3px;
5476: margin-bottom: 5px;
5477: }
1.600 albertel 5478: div.LC_edit_problem_header_title {
1.705 tempelho 5479: font-weight: bold;
5480: font-size: larger;
1.602 albertel 5481: background: $tabbg;
5482: padding: 3px;
5483: }
5484: table.LC_edit_problem_header_title {
1.705 tempelho 5485: font-size: larger;
5486: font-weight: bold;
1.602 albertel 5487: width: 100%;
5488: border-color: $pgbg;
5489: border-style: solid;
5490: border-width: $border;
5491:
1.600 albertel 5492: background: $tabbg;
1.602 albertel 5493: border-collapse: collapse;
5494: padding: 0px
5495: }
5496:
5497: div.LC_edit_problem_discards {
5498: float: left;
5499: padding-bottom: 5px;
5500: }
5501: div.LC_edit_problem_saves {
5502: float: right;
5503: padding-bottom: 5px;
1.600 albertel 5504: }
5505: hr.LC_edit_problem_divide {
1.602 albertel 5506: clear: both;
1.600 albertel 5507: color: $tabbg;
5508: background-color: $tabbg;
5509: height: 3px;
5510: border: 0px;
5511: }
1.679 riegler 5512: img.stift{
1.678 riegler 5513: border-width:0;
1.679 riegler 5514: vertical-align:middle;
1.677 riegler 5515: }
1.680 riegler 5516:
1.681 riegler 5517: table#LC_mainmenu{
5518: margin-top:10px;
5519: width:80%;
5520:
5521: }
5522:
1.680 riegler 5523: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5524: vertical-align: top;
5525: width: 45%;
5526: }
1.779 ! bisitz 5527: .LC_mainmenu_fieldset_category {
! 5528: color: $font;
! 5529: background: $pgbg;
! 5530: font-family: $sans;
! 5531: font-size: small;
! 5532: font-weight: bold;
1.777 tempelho 5533: }
1.716 raeburn 5534: div.LC_createcourse {
5535: margin: 10px 10px 10px 10px;
5536: }
5537:
1.693 droeschl 5538: /* ---- Remove when done ----
5539: # The following styles is part of the redesign of LON-CAPA and are
5540: # subject to change during this project.
5541: # Don't rely on their current functionality as they might be
5542: # changed or removed.
5543: # --------------------------*/
5544:
1.698 harmsja 5545: a:hover,
1.721 harmsja 5546: ol.LC_smallMenu a:hover,
5547: ol#LC_MenuBreadcrumbs a:hover,
5548: ol#LC_PathBreadcrumbs a:hover,
5549: ul#LC_TabMainMenuContent a:hover,
5550: .LC_FormSectionClearButton input:hover
5551: ul.LC_TabContent li:hover a{
1.698 harmsja 5552: color:#BF2317;
5553: text-decoration:none;
1.693 droeschl 5554: }
5555:
1.779 ! bisitz 5556: h1 {
1.721 harmsja 5557: padding:5px 10px 5px 20px;
1.693 droeschl 5558: line-height:130%;
5559: }
1.698 harmsja 5560:
1.693 droeschl 5561: h2,h3,h4,h5,h6
5562: {
1.721 harmsja 5563: margin:5px 0px 5px 0px;
5564: padding:0px;
5565: line-height:130%;
1.693 droeschl 5566: }
1.721 harmsja 5567: .LC_hcell{
1.698 harmsja 5568: padding:3px 15px 3px 15px;
5569: margin:0px;
1.703 harmsja 5570: background-color:$tabbg;
1.779 ! bisitz 5571: border-bottom:solid 1px $lg_border_color;
1.693 droeschl 5572: }
1.721 harmsja 5573: .LC_noBorder {
1.698 harmsja 5574: border:0px;
5575: }
1.693 droeschl 5576:
5577:
1.698 harmsja 5578: /* Main Header with discription of Person, Course, etc. */
1.693 droeschl 5579:
1.761 tempelho 5580: .LC_Right {
5581: float: right;
5582: margin: 0px;
5583: padding: 0px;
5584: }
5585:
1.721 harmsja 5586: p, .LC_ContentBox {
1.698 harmsja 5587: padding: 10px;
5588:
5589: }
1.721 harmsja 5590: .LC_FormSectionClearButton input {
1.779 ! bisitz 5591: background-color:transparent;
1.698 harmsja 5592: border:0px;
5593: cursor:pointer;
5594: text-decoration:underline;
1.693 droeschl 5595: }
1.763 bisitz 5596:
5597: .LC_help_open_topic {
5598: color: #FFFFFF;
5599: background-color: #EEEEFF;
5600: margin: 1px;
5601: padding: 4px;
5602: border: 1px solid #000033;
5603: white-space: nowrap;
1.759 neumanie 5604: }
1.693 droeschl 5605:
1.698 harmsja 5606: dl,ul,div,fieldset {
5607: margin: 10px 10px 10px 0px;
1.693 droeschl 5608: overflow:hidden;
5609: }
1.721 harmsja 5610: ol.LC_smallMenu, ol#LC_PathBreadcrumbs {
1.698 harmsja 5611: margin: 0px;
1.693 droeschl 5612: }
5613:
1.721 harmsja 5614: ol.LC_smallMenu li {
1.693 droeschl 5615: display: inline;
5616: padding: 5px 5px 0px 10px;
5617: vertical-align: top;
5618: }
5619:
1.721 harmsja 5620: ol.LC_smallMenu li img {
1.693 droeschl 5621: vertical-align: bottom;
5622: }
5623:
1.721 harmsja 5624: ol.LC_smallMenu a {
1.693 droeschl 5625: font-size: 90%;
5626: color: RGB(80, 80, 80);
5627: text-decoration: none;
5628: }
1.760 harmsja 5629: ol#LC_TabMainMenuContent, ul.LC_TabContent ,
1.741 harmsja 5630: ul.LC_TabContentBigger {
1.721 harmsja 5631: display:block;
5632: list-style:none;
1.741 harmsja 5633: margin: 0px;
1.693 droeschl 5634: padding: 0px;
5635: }
5636:
1.744 ehlerst 5637: ol#LC_TabMainMenuContent li, ul.LC_TabContent li,
1.741 harmsja 5638: ul.LC_TabContentBigger li{
1.693 droeschl 5639: display: inline;
1.741 harmsja 5640: border-right: solid 1px $lg_border_color;
5641: float:left;
5642: line-height:140%;
5643: white-space:nowrap;
5644: }
5645: ol#LC_TabMainMenuContent li{
1.693 droeschl 5646: vertical-align: bottom;
5647: border-bottom: solid 1px RGB(175, 175, 175);
1.721 harmsja 5648: padding: 5px 10px 5px 10px;
1.741 harmsja 5649: margin-right:5px;
5650: margin-bottom:3px;
1.693 droeschl 5651: font-weight: bold;
1.723 riegler 5652: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5653: }
5654:
1.721 harmsja 5655: ol#LC_TabMainMenuContent li a{
1.693 droeschl 5656: color: RGB(47, 47, 47);
5657: text-decoration: none;
5658: }
1.721 harmsja 5659: ul.LC_TabContent {
1.741 harmsja 5660: min-height:1.6em;
1.721 harmsja 5661: }
5662: ul.LC_TabContent li{
1.741 harmsja 5663: vertical-align:middle;
5664: padding:0px 10px 0px 10px;
1.745 ehlerst 5665: background-color:$tabbg;
5666: border-bottom:solid 1px $lg_border_color;
1.721 harmsja 5667: }
1.779 ! bisitz 5668: ul.LC_TabContent li a, ul.LC_TabContent li{
1.721 harmsja 5669: color:rgb(47,47,47);
5670: text-decoration:none;
5671: font-size:95%;
5672: font-weight:bold;
1.761 tempelho 5673: padding-right: 16px;
1.721 harmsja 5674: }
1.744 ehlerst 5675: ul.LC_TabContent li:hover, ul.LC_TabContent li.active{
1.761 tempelho 5676: background:#FFFFFF url(/adm/lonIcons/open.gif) no-repeat scroll right center;
1.745 ehlerst 5677: border-bottom:solid 1px #FFFFFF;
1.761 tempelho 5678: padding-right: 16px;
1.744 ehlerst 5679: }
1.741 harmsja 5680: ul.LC_TabContentBigger li{
5681: vertical-align:bottom;
5682: border-top:solid 1px $lg_border_color;
5683: border-left:solid 1px $lg_border_color;
5684: padding:5px 10px 5px 10px;
5685: margin-left:2px;
5686: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
5687: }
1.744 ehlerst 5688: ul.LC_TabContentBigger li:hover, ul.LC_TabContentBigger li.active{
5689: background:url(/adm/lonIcons/lightGreyBG.png) repeat-x right bottom;
5690: }
1.741 harmsja 5691: ul.LC_TabContentBigger li, ul.LC_TabContentBigger li a{
5692: font-size:110%;
5693: font-weight:bold;
5694: }
1.693 droeschl 5695:
1.721 harmsja 5696: ol#LC_MenuBreadcrumbs, ol#LC_PathBreadcrumbs {
1.693 droeschl 5697: border-top: solid 1px RGB(255, 255, 255);
5698: height: 20px;
5699: line-height: 20px;
5700: vertical-align: bottom;
5701: margin: 0px 0px 30px 0px;
5702: padding-left: 10px;
5703: list-style-position: inside;
1.723 riegler 5704: background: url(/adm/lonIcons/lightGreyBG.png) repeat-x left top;
1.693 droeschl 5705: }
5706:
1.721 harmsja 5707: ol#LC_MenuBreadcrumbs li, ol#LC_PathBreadcrumbs li {
1.741 harmsja 5708: /*
1.723 riegler 5709: background: url(/adm/lonIcons/arrow_white.png) no-repeat left center;
1.779 ! bisitz 5710: */
1.693 droeschl 5711: display: inline;
5712: padding: 0px 0px 0px 10px;
5713: vertical-align: bottom;
5714: overflow:hidden;
5715: }
5716:
1.721 harmsja 5717: ol#LC_MenuBreadcrumbs li a {
1.693 droeschl 5718: text-decoration: none;
5719: font-size:90%;
5720: }
1.721 harmsja 5721: ol#LC_PathBreadcrumbs li a{
1.698 harmsja 5722: text-decoration:none;
5723: font-size:100%;
5724: font-weight:bold;
1.693 droeschl 5725: }
1.721 harmsja 5726: .LC_ContentBoxSpecial
1.693 droeschl 5727: {
1.701 harmsja 5728: border: solid 1px $lg_border_color;
1.746 neumanie 5729: }
5730: .LC_ContentBoxSpecialContactInfo
5731: {
5732: border: solid 1px $lg_border_color;
5733: max-width:25%;
5734: min-width:25%;
1.698 harmsja 5735: }
1.747 neumanie 5736: .LC_AboutMe_Image
5737: {
5738: float:left;
5739: margin-right:10px;
5740: }
5741: .LC_Clear_AboutMe_Image
5742: {
5743: clear:left;
5744: }
1.721 harmsja 5745: dl.LC_ListStyleClean dt {
1.693 droeschl 5746: padding-right: 5px;
5747: display: table-header-group;
5748: }
5749:
1.721 harmsja 5750: dl.LC_ListStyleClean dd {
1.693 droeschl 5751: display: table-row;
5752: }
5753:
1.721 harmsja 5754: .LC_ListStyleClean,
5755: .LC_ListStyleSimple,
5756: .LC_ListStyleNormal,
1.777 tempelho 5757: .LC_ListStyle_Border,
1.721 harmsja 5758: .LC_ListStyleSpecial
1.693 droeschl 5759: {
5760: /*display:block; */
5761: list-style-position: inside;
5762: list-style-type: none;
5763: overflow: hidden;
5764: padding: 0px;
5765: }
5766:
1.721 harmsja 5767: .LC_ListStyleSimple li,
5768: .LC_ListStyleSimple dd,
5769: .LC_ListStyleNormal li,
5770: .LC_ListStyleNormal dd,
5771: .LC_ListStyleSpecial li,
5772: .LC_ListStyleSpecial dd
1.693 droeschl 5773: {
5774: margin: 0px;
5775: padding: 5px 5px 5px 10px;
5776: clear: both;
5777: }
5778:
1.721 harmsja 5779: .LC_ListStyleClean li,
5780: .LC_ListStyleClean dd {
1.693 droeschl 5781: padding-top: 0px;
5782: padding-bottom: 0px;
5783: }
5784:
1.721 harmsja 5785: .LC_ListStyleSimple dd,
5786: .LC_ListStyleSimple li{
1.698 harmsja 5787: border-bottom: solid 1px $lg_border_color;
1.693 droeschl 5788: }
5789:
1.721 harmsja 5790: .LC_ListStyleSpecial li,
5791: .LC_ListStyleSpecial dd {
1.693 droeschl 5792: list-style-type: none;
5793: background-color: RGB(220, 220, 220);
5794: margin-bottom: 4px;
5795: }
5796:
1.721 harmsja 5797: table.LC_SimpleTable {
1.698 harmsja 5798: margin:5px;
5799: border:solid 1px $lg_border_color;
1.693 droeschl 5800: }
5801:
1.721 harmsja 5802: table.LC_SimpleTable tr {
1.698 harmsja 5803: padding:0px;
5804: border:solid 1px $lg_border_color;
1.693 droeschl 5805: }
1.721 harmsja 5806: table.LC_SimpleTable thead{
1.698 harmsja 5807: background:rgb(220,220,220);
1.693 droeschl 5808: }
5809:
1.721 harmsja 5810: div.LC_columnSection {
1.693 droeschl 5811: display: block;
5812: clear: both;
5813: overflow: hidden;
5814: margin:0px;
5815: }
5816:
1.721 harmsja 5817: div.LC_columnSection>* {
1.693 droeschl 5818: float: left;
5819: margin: 10px 20px 10px 0px;
1.747 neumanie 5820: overflow:hidden;
1.693 droeschl 5821: }
1.721 harmsja 5822:
1.719 ehlerst 5823: .ContentBoxSpecialTemplate
5824: {
1.747 neumanie 5825: border: solid 1px $lg_border_color;
1.719 ehlerst 5826: }
5827: .ContentBoxTemplate {
5828: padding:10px;
5829: }
5830:
1.721 harmsja 5831: div.LC_columnSection > .ContentBoxTemplate,
5832: div.LC_columnSection > .ContentBoxSpecialTemplate
1.719 ehlerst 5833: {
5834: width: 600px;
5835: }
1.753 droeschl 5836:
1.720 ehlerst 5837: .clear{
5838: clear: both;
5839: line-height: 0px;
5840: font-size: 0px;
5841: height: 0px;
5842: }
1.693 droeschl 5843:
1.694 tempelho 5844: .LC_loginpage_container {
5845: text-align:left;
5846: margin : 0 auto;
5847: width:65%;
5848: padding: 10px;
5849: height: auto;
1.712 muellerd 5850: background-color:#FFFFFF;
1.694 tempelho 5851: border:1px solid #CCCCCC;
5852: }
5853:
5854:
5855: .LC_loginpage_loginContainer {
5856: float:left;
1.712 muellerd 5857: width: 182px;
5858: border:1px solid #CCCCCC;
5859: background-color:$loginbg;
1.694 tempelho 5860: }
5861:
1.717 tempelho 5862: .LC_loginpage_loginContainer h2{
1.712 muellerd 5863: margin-top:0;
5864: display:block;
5865: background:$bgcol;
5866: color:$textcol;
5867: padding-left:5px;
5868: }
1.694 tempelho 5869: .LC_loginpage_loginInfo {
5870: margin-left:20px;
5871: float:left;
5872: width:30%;
5873: border:1px solid #CCCCCC;
5874: padding:10px;
5875: }
5876:
1.712 muellerd 5877: .LC_loginpage_loginDomain {
5878: margin-right:20px;
5879: width:20%;
5880: float:left;
5881: padding:10px;
5882: }
5883:
1.694 tempelho 5884: .LC_loginpage_space {
1.754 droeschl 5885: clear: both;
5886: margin-bottom: 20px;
1.694 tempelho 5887: border-bottom: 1px solid #CCCCCC;
5888: }
5889:
1.748 schulted 5890: table em{
1.754 droeschl 5891: font-weight: bold;
5892: font-style: normal;
1.748 schulted 5893: }
1.779 ! bisitz 5894: table.LC_tableBrowseRes,
1.768 schulted 5895: table.LC_tableOfContent{
1.769 schulted 5896: border:none;
5897: border-spacing: 1;
1.754 droeschl 5898: padding: 3px;
5899: background-color: #FFFFFF;
5900: font-size: 90%;
1.753 droeschl 5901: }
1.771 droeschl 5902: table.LC_tableBrowseRes a,
1.768 schulted 5903: table.LC_tableOfContent a {
1.771 droeschl 5904: background-color: transparent;
1.753 droeschl 5905: text-decoration: none;
5906: }
5907:
1.771 droeschl 5908: table.LC_tableBrowseRes tr.LC_trOdd,
1.768 schulted 5909: table.LC_tableOfContent tr.LC_trOdd{
1.754 droeschl 5910: background-color: #EEEEEE;
1.753 droeschl 5911: }
5912:
1.768 schulted 5913: table.LC_tableOfContent img{
1.753 droeschl 5914: border: none;
5915: height: 1.3em;
5916: vertical-align: text-bottom;
5917: margin-right: 0.3em;
5918: }
1.757 schulted 5919:
1.774 ehlerst 5920: a#LC_content_toolbar_firsthomework{
5921: background-image:url(/res/adm/pages/open-first-problem.gif);
5922: }
5923:
5924: a#LC_content_toolbar_launchnav{
5925: background-image:url(/res/adm/pages/start-navigation.gif);
5926: }
5927:
5928: a#LC_content_toolbar_closenav{
5929: background-image:url(/res/adm/pages/close-navigation.gif);
5930: }
5931:
5932: a#LC_content_toolbar_everything{
5933: background-image:url(/res/adm/pages/show-all.gif);
5934: }
5935:
5936: a#LC_content_toolbar_uncompleted{
5937: background-image:url(/res/adm/pages/show-incomplete-problems.gif);
5938: }
5939:
5940: #LC_content_toolbar_clearbubbles{
5941: background-image:url(/res/adm/pages/mark-discussionentries-read.gif);
5942: }
5943:
1.757 schulted 5944: a#LC_content_toolbar_changefolder{
5945: background : url(/res/adm/pages/close-all-folders.gif) top center ;
5946: }
5947:
5948: a#LC_content_toolbar_changefolder_toggled{
5949: background-image:url(/res/adm/pages/open-all-folders.gif);
5950: }
5951:
5952: ul#LC_toolbar li a:hover{
5953: background-position: bottom center;
5954: }
5955:
5956: ul#LC_toolbar{
1.779 ! bisitz 5957: padding:0;
1.757 schulted 5958: margin: 2px;
5959: list-style:none;
5960: position:relative;
5961: background-color:white;
5962: }
5963:
5964: ul#LC_toolbar li{
5965: border:1px solid white;
5966: padding:0;
5967: margin: 0;
1.767 droeschl 5968: float: left;
5969: display:inline;
1.757 schulted 5970: vertical-align:middle;
5971: }
5972:
5973: a.LC_toolbarItem{
1.767 droeschl 5974: display:block;
1.757 schulted 5975: padding:0;
5976: margin:0;
5977: height: 32px;
5978: width: 32px;
1.779 ! bisitz 5979: color:white;
! 5980: border:0 none;
1.757 schulted 5981: background-repeat:no-repeat;
5982: background-color:transparent;
5983: }
5984:
5985:
1.343 albertel 5986: END
5987: }
5988:
1.306 albertel 5989: =pod
5990:
5991: =item * &headtag()
5992:
5993: Returns a uniform footer for LON-CAPA web pages.
5994:
1.307 albertel 5995: Inputs: $title - optional title for the head
5996: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5997: $args - optional arguments
1.319 albertel 5998: force_register - if is true call registerurl so the remote is
5999: informed
1.415 albertel 6000: redirect -> array ref of
6001: 1- seconds before redirect occurs
6002: 2- url to redirect to
6003: 3- whether the side effect should occur
1.315 albertel 6004: (side effect of setting
6005: $env{'internal.head.redirect'} to the url
6006: redirected too)
1.352 albertel 6007: domain -> force to color decorate a page for a specific
6008: domain
6009: function -> force usage of a specific rolish color scheme
6010: bgcolor -> override the default page bgcolor
1.460 albertel 6011: no_auto_mt_title
6012: -> prevent &mt()ing the title arg
1.464 albertel 6013:
1.306 albertel 6014: =cut
6015:
6016: sub headtag {
1.313 albertel 6017: my ($title,$head_extra,$args) = @_;
1.306 albertel 6018:
1.363 albertel 6019: my $function = $args->{'function'} || &get_users_function();
6020: my $domain = $args->{'domain'} || &determinedomain();
6021: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 6022: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 6023: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 6024: #time(),
1.418 albertel 6025: $env{'environment.color.timestamp'},
1.363 albertel 6026: $function,$domain,$bgcolor);
6027:
1.369 www 6028: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 6029:
1.308 albertel 6030: my $result =
6031: '<head>'.
1.461 albertel 6032: &font_settings();
1.319 albertel 6033:
1.461 albertel 6034: if (!$args->{'frameset'}) {
6035: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
6036: }
1.319 albertel 6037: if ($args->{'force_register'}) {
6038: $result .= &Apache::lonmenu::registerurl(1);
6039: }
1.436 albertel 6040: if (!$args->{'no_nav_bar'}
6041: && !$args->{'only_body'}
6042: && !$args->{'frameset'}) {
6043: $result .= &help_menu_js();
6044: }
1.319 albertel 6045:
1.314 albertel 6046: if (ref($args->{'redirect'})) {
1.414 albertel 6047: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 6048: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 6049: if (!$inhibit_continue) {
6050: $env{'internal.head.redirect'} = $url;
6051: }
1.313 albertel 6052: $result.=<<ADDMETA
6053: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 6054: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 6055: ADDMETA
6056: }
1.306 albertel 6057: if (!defined($title)) {
6058: $title = 'The LearningOnline Network with CAPA';
6059: }
1.460 albertel 6060: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
6061: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 6062: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
6063: .$head_extra;
1.306 albertel 6064: return $result;
6065: }
6066:
6067: =pod
6068:
1.340 albertel 6069: =item * &font_settings()
6070:
6071: Returns neccessary <meta> to set the proper encoding
6072:
6073: Inputs: none
6074:
6075: =cut
6076:
6077: sub font_settings {
6078: my $headerstring='';
1.647 www 6079: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 6080: $headerstring.=
6081: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
6082: }
6083: return $headerstring;
6084: }
6085:
1.341 albertel 6086: =pod
6087:
6088: =item * &xml_begin()
6089:
6090: Returns the needed doctype and <html>
6091:
6092: Inputs: none
6093:
6094: =cut
6095:
6096: sub xml_begin {
6097: my $output='';
6098:
1.592 albertel 6099: if ($env{'internal.start_page'}==1) {
6100: &Apache::lonhtmlcommon::init_htmlareafields();
6101: }
1.342 albertel 6102:
1.341 albertel 6103: if ($env{'browser.mathml'}) {
6104: $output='<?xml version="1.0"?>'
6105: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
6106: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
6107:
6108: # .'<!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">] >'
6109: .'<!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">'
6110: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
6111: .'xmlns="http://www.w3.org/1999/xhtml">';
6112: } else {
6113: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
6114: }
6115: return $output;
6116: }
1.340 albertel 6117:
6118: =pod
6119:
1.306 albertel 6120: =item * &endheadtag()
6121:
6122: Returns a uniform </head> for LON-CAPA web pages.
6123:
6124: Inputs: none
6125:
6126: =cut
6127:
6128: sub endheadtag {
6129: return '</head>';
6130: }
6131:
6132: =pod
6133:
6134: =item * &head()
6135:
6136: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
6137:
1.648 raeburn 6138: Inputs:
6139:
6140: =over 4
6141:
6142: $title - optional title for the page
6143:
6144: $head_extra - optional extra HTML to put inside the <head>
6145:
6146: =back
1.405 albertel 6147:
1.306 albertel 6148: =cut
6149:
6150: sub head {
1.325 albertel 6151: my ($title,$head_extra,$args) = @_;
6152: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 6153: }
6154:
6155: =pod
6156:
6157: =item * &start_page()
6158:
6159: Returns a complete <html> .. <body> section for LON-CAPA web pages.
6160:
1.648 raeburn 6161: Inputs:
6162:
6163: =over 4
6164:
6165: $title - optional title for the page
6166:
6167: $head_extra - optional extra HTML to incude inside the <head>
6168:
6169: $args - additional optional args supported are:
6170:
6171: =over 8
6172:
6173: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 6174: arg on
1.648 raeburn 6175: no_nav_bar -> is true will set &bodytag() notopbar arg on
6176: add_entries -> additional attributes to add to the <body>
6177: domain -> force to color decorate a page for a
1.317 albertel 6178: specific domain
1.648 raeburn 6179: function -> force usage of a specific rolish color
1.317 albertel 6180: scheme
1.648 raeburn 6181: redirect -> see &headtag()
6182: bgcolor -> override the default page bg color
6183: js_ready -> return a string ready for being used in
1.317 albertel 6184: a javascript writeln
1.648 raeburn 6185: html_encode -> return a string ready for being used in
1.320 albertel 6186: a html attribute
1.648 raeburn 6187: force_register -> if is true will turn on the &bodytag()
1.317 albertel 6188: $forcereg arg
1.648 raeburn 6189: body_title -> alternate text to use instead of $title
1.326 albertel 6190: in the title box that appears, this text
6191: is not auto translated like the $title is
1.648 raeburn 6192: frameset -> if true will start with a <frameset>
1.330 albertel 6193: rather than <body>
1.648 raeburn 6194: no_title -> if true the title bar won't be shown
6195: skip_phases -> hash ref of
1.338 albertel 6196: head -> skip the <html><head> generation
6197: body -> skip all <body> generation
1.648 raeburn 6198: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 6199: 'Switch To Inline Menu' link
1.648 raeburn 6200: no_auto_mt_title -> prevent &mt()ing the title arg
6201: inherit_jsmath -> when creating popup window in a page,
6202: should it have jsmath forced on by the
6203: current page
1.361 albertel 6204:
1.648 raeburn 6205: =back
1.460 albertel 6206:
1.648 raeburn 6207: =back
1.562 albertel 6208:
1.306 albertel 6209: =cut
6210:
6211: sub start_page {
1.309 albertel 6212: my ($title,$head_extra,$args) = @_;
1.318 albertel 6213: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 6214: my %head_args;
1.352 albertel 6215: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 6216: 'bgcolor','frameset','no_nav_bar','only_body',
6217: 'no_auto_mt_title') {
1.319 albertel 6218: if (defined($args->{$arg})) {
1.324 raeburn 6219: $head_args{$arg} = $args->{$arg};
1.319 albertel 6220: }
1.313 albertel 6221: }
1.319 albertel 6222:
1.315 albertel 6223: $env{'internal.start_page'}++;
1.338 albertel 6224: my $result;
6225: if (! exists($args->{'skip_phases'}{'head'}) ) {
6226: $result.=
1.341 albertel 6227: &xml_begin().
1.338 albertel 6228: &headtag($title,$head_extra,\%head_args).&endheadtag();
6229: }
6230:
6231: if (! exists($args->{'skip_phases'}{'body'}) ) {
6232: if ($args->{'frameset'}) {
6233: my $attr_string = &make_attr_string($args->{'force_register'},
6234: $args->{'add_entries'});
6235: $result .= "\n<frameset $attr_string>\n";
6236: } else {
6237: $result .=
6238: &bodytag($title,
6239: $args->{'function'}, $args->{'add_entries'},
6240: $args->{'only_body'}, $args->{'domain'},
6241: $args->{'force_register'}, $args->{'body_title'},
6242: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 6243: $args->{'no_title'}, $args->{'no_inline_link'},
6244: $args);
1.338 albertel 6245: }
1.330 albertel 6246: }
1.338 albertel 6247:
1.315 albertel 6248: if ($args->{'js_ready'}) {
1.713 kaisler 6249: $result = &js_ready($result);
1.315 albertel 6250: }
1.320 albertel 6251: if ($args->{'html_encode'}) {
1.713 kaisler 6252: $result = &html_encode($result);
6253: }
6254:
1.758 kaisler 6255: #Breadcrumbs
6256: if (exists($args->{'bread_crumbs'}) or exists($args->{'bread_crumbs_component'})) {
6257: &Apache::lonhtmlcommon::clear_breadcrumbs();
6258: #if any br links exists, add them to the breadcrumbs
6259: if (exists($args->{'bread_crumbs'}) and ref($args->{'bread_crumbs'}) eq 'ARRAY') {
6260: foreach my $crumb (@{$args->{'bread_crumbs'}}){
6261: &Apache::lonhtmlcommon::add_breadcrumb($crumb);
6262: }
6263: }
6264:
6265: #if bread_crumbs_component exists show it as headline else show only the breadcrumbs
6266: if(exists($args->{'bread_crumbs_component'})){
6267: $result .= &Apache::lonhtmlcommon::breadcrumbs($args->{'bread_crumbs_component'});
6268: }else{
6269: $result .= &Apache::lonhtmlcommon::breadcrumbs();
6270: }
1.320 albertel 6271: }
1.315 albertel 6272: return $result;
1.306 albertel 6273: }
6274:
1.330 albertel 6275:
1.306 albertel 6276: =pod
6277:
6278: =item * &head()
6279:
6280: Returns a complete </body></html> section for LON-CAPA web pages.
6281:
1.315 albertel 6282: Inputs: $args - additional optional args supported are:
6283: js_ready -> return a string ready for being used in
6284: a javascript writeln
1.320 albertel 6285: html_encode -> return a string ready for being used in
6286: a html attribute
1.330 albertel 6287: frameset -> if true will start with a <frameset>
6288: rather than <body>
1.493 albertel 6289: dicsussion -> if true will get discussion from
6290: lonxml::xmlend
6291: (you can pass the target and parser arguments
6292: through optional 'target' and 'parser' args
6293: to this routine)
1.306 albertel 6294:
6295: =cut
6296:
6297: sub end_page {
1.315 albertel 6298: my ($args) = @_;
6299: $env{'internal.end_page'}++;
1.330 albertel 6300: my $result;
1.335 albertel 6301: if ($args->{'discussion'}) {
6302: my ($target,$parser);
6303: if (ref($args->{'discussion'})) {
6304: ($target,$parser) =($args->{'discussion'}{'target'},
6305: $args->{'discussion'}{'parser'});
6306: }
6307: $result .= &Apache::lonxml::xmlend($target,$parser);
6308: }
6309:
1.330 albertel 6310: if ($args->{'frameset'}) {
6311: $result .= '</frameset>';
6312: } else {
1.635 raeburn 6313: $result .= &endbodytag($args);
1.330 albertel 6314: }
6315: $result .= "\n</html>";
6316:
1.315 albertel 6317: if ($args->{'js_ready'}) {
1.317 albertel 6318: $result = &js_ready($result);
1.315 albertel 6319: }
1.335 albertel 6320:
1.320 albertel 6321: if ($args->{'html_encode'}) {
6322: $result = &html_encode($result);
6323: }
1.335 albertel 6324:
1.315 albertel 6325: return $result;
6326: }
6327:
1.320 albertel 6328: sub html_encode {
6329: my ($result) = @_;
6330:
1.322 albertel 6331: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 6332:
6333: return $result;
6334: }
1.317 albertel 6335: sub js_ready {
6336: my ($result) = @_;
6337:
1.323 albertel 6338: $result =~ s/[\n\r]/ /xmsg;
6339: $result =~ s/\\/\\\\/xmsg;
6340: $result =~ s/'/\\'/xmsg;
1.372 albertel 6341: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 6342:
6343: return $result;
6344: }
6345:
1.315 albertel 6346: sub validate_page {
6347: if ( exists($env{'internal.start_page'})
1.316 albertel 6348: && $env{'internal.start_page'} > 1) {
6349: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 6350: $env{'internal.start_page'}.' '.
1.316 albertel 6351: $ENV{'request.filename'});
1.315 albertel 6352: }
6353: if ( exists($env{'internal.end_page'})
1.316 albertel 6354: && $env{'internal.end_page'} > 1) {
6355: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 6356: $env{'internal.end_page'}.' '.
1.316 albertel 6357: $env{'request.filename'});
1.315 albertel 6358: }
6359: if ( exists($env{'internal.start_page'})
6360: && ! exists($env{'internal.end_page'})) {
1.316 albertel 6361: &Apache::lonnet::logthis('start_page called without end_page '.
6362: $env{'request.filename'});
1.315 albertel 6363: }
6364: if ( ! exists($env{'internal.start_page'})
6365: && exists($env{'internal.end_page'})) {
1.316 albertel 6366: &Apache::lonnet::logthis('end_page called without start_page'.
6367: $env{'request.filename'});
1.315 albertel 6368: }
1.306 albertel 6369: }
1.315 albertel 6370:
1.318 albertel 6371: sub simple_error_page {
6372: my ($r,$title,$msg) = @_;
6373: my $page =
6374: &Apache::loncommon::start_page($title).
6375: &mt($msg).
6376: &Apache::loncommon::end_page();
6377: if (ref($r)) {
6378: $r->print($page);
1.327 albertel 6379: return;
1.318 albertel 6380: }
6381: return $page;
6382: }
1.347 albertel 6383:
6384: {
1.610 albertel 6385: my @row_count;
1.347 albertel 6386: sub start_data_table {
1.422 albertel 6387: my ($add_class) = @_;
6388: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 6389: unshift(@row_count,0);
1.422 albertel 6390: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 6391: }
6392:
6393: sub end_data_table {
1.610 albertel 6394: shift(@row_count);
1.389 albertel 6395: return '</table>'."\n";;
1.347 albertel 6396: }
6397:
6398: sub start_data_table_row {
1.422 albertel 6399: my ($add_class) = @_;
1.610 albertel 6400: $row_count[0]++;
6401: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 6402: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 6403: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 6404: }
1.471 banghart 6405:
6406: sub continue_data_table_row {
6407: my ($add_class) = @_;
1.610 albertel 6408: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 6409: $css_class = (join(' ',$css_class,$add_class));
6410: return '<tr class="'.$css_class.'">'."\n";;
6411: }
1.347 albertel 6412:
6413: sub end_data_table_row {
1.389 albertel 6414: return '</tr>'."\n";;
1.347 albertel 6415: }
1.367 www 6416:
1.421 albertel 6417: sub start_data_table_empty_row {
1.707 bisitz 6418: # $row_count[0]++;
1.421 albertel 6419: return '<tr class="LC_empty_row" >'."\n";;
6420: }
6421:
6422: sub end_data_table_empty_row {
6423: return '</tr>'."\n";;
6424: }
6425:
1.367 www 6426: sub start_data_table_header_row {
1.389 albertel 6427: return '<tr class="LC_header_row">'."\n";;
1.367 www 6428: }
6429:
6430: sub end_data_table_header_row {
1.389 albertel 6431: return '</tr>'."\n";;
1.367 www 6432: }
1.347 albertel 6433: }
6434:
1.548 albertel 6435: =pod
6436:
6437: =item * &inhibit_menu_check($arg)
6438:
6439: Checks for a inhibitmenu state and generates output to preserve it
6440:
6441: Inputs: $arg - can be any of
6442: - undef - in which case the return value is a string
6443: to add into arguments list of a uri
6444: - 'input' - in which case the return value is a HTML
6445: <form> <input> field of type hidden to
6446: preserve the value
6447: - a url - in which case the return value is the url with
6448: the neccesary cgi args added to preserve the
6449: inhibitmenu state
6450: - a ref to a url - no return value, but the string is
6451: updated to include the neccessary cgi
6452: args to preserve the inhibitmenu state
6453:
6454: =cut
6455:
6456: sub inhibit_menu_check {
6457: my ($arg) = @_;
6458: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
6459: if ($arg eq 'input') {
6460: if ($env{'form.inhibitmenu'}) {
6461: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
6462: } else {
6463: return
6464: }
6465: }
6466: if ($env{'form.inhibitmenu'}) {
6467: if (ref($arg)) {
6468: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6469: } elsif ($arg eq '') {
6470: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
6471: } else {
6472: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
6473: }
6474: }
6475: if (!ref($arg)) {
6476: return $arg;
6477: }
6478: }
6479:
1.251 albertel 6480: ###############################################
1.182 matthew 6481:
6482: =pod
6483:
1.549 albertel 6484: =back
6485:
6486: =head1 User Information Routines
6487:
6488: =over 4
6489:
1.405 albertel 6490: =item * &get_users_function()
1.182 matthew 6491:
6492: Used by &bodytag to determine the current users primary role.
6493: Returns either 'student','coordinator','admin', or 'author'.
6494:
6495: =cut
6496:
6497: ###############################################
6498: sub get_users_function {
6499: my $function = 'student';
1.258 albertel 6500: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 6501: $function='coordinator';
6502: }
1.258 albertel 6503: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 6504: $function='admin';
6505: }
1.258 albertel 6506: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 6507: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
6508: $function='author';
6509: }
6510: return $function;
1.54 www 6511: }
1.99 www 6512:
6513: ###############################################
6514:
1.233 raeburn 6515: =pod
6516:
1.542 raeburn 6517: =item * &check_user_status()
1.274 raeburn 6518:
6519: Determines current status of supplied role for a
6520: specific user. Roles can be active, previous or future.
6521:
6522: Inputs:
6523: user's domain, user's username, course's domain,
1.375 raeburn 6524: course's number, optional section ID.
1.274 raeburn 6525:
6526: Outputs:
6527: role status: active, previous or future.
6528:
6529: =cut
6530:
6531: sub check_user_status {
1.412 raeburn 6532: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6533: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6534: my @uroles = keys %userinfo;
6535: my $srchstr;
6536: my $active_chk = 'none';
1.412 raeburn 6537: my $now = time;
1.274 raeburn 6538: if (@uroles > 0) {
1.412 raeburn 6539: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6540: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6541: } else {
1.412 raeburn 6542: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6543: }
6544: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6545: my $role_end = 0;
6546: my $role_start = 0;
6547: $active_chk = 'active';
1.412 raeburn 6548: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6549: $role_end = $1;
6550: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6551: $role_start = $1;
1.274 raeburn 6552: }
6553: }
6554: if ($role_start > 0) {
1.412 raeburn 6555: if ($now < $role_start) {
1.274 raeburn 6556: $active_chk = 'future';
6557: }
6558: }
6559: if ($role_end > 0) {
1.412 raeburn 6560: if ($now > $role_end) {
1.274 raeburn 6561: $active_chk = 'previous';
6562: }
6563: }
6564: }
6565: }
6566: return $active_chk;
6567: }
6568:
6569: ###############################################
6570:
6571: =pod
6572:
1.405 albertel 6573: =item * &get_sections()
1.233 raeburn 6574:
6575: Determines all the sections for a course including
6576: sections with students and sections containing other roles.
1.419 raeburn 6577: Incoming parameters:
6578:
6579: 1. domain
6580: 2. course number
6581: 3. reference to array containing roles for which sections should
6582: be gathered (optional).
6583: 4. reference to array containing status types for which sections
6584: should be gathered (optional).
6585:
6586: If the third argument is undefined, sections are gathered for any role.
6587: If the fourth argument is undefined, sections are gathered for any status.
6588: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6589:
1.374 raeburn 6590: Returns section hash (keys are section IDs, values are
6591: number of users in each section), subject to the
1.419 raeburn 6592: optional roles filter, optional status filter
1.233 raeburn 6593:
6594: =cut
6595:
6596: ###############################################
6597: sub get_sections {
1.419 raeburn 6598: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6599: if (!defined($cdom) || !defined($cnum)) {
6600: my $cid = $env{'request.course.id'};
6601:
6602: return if (!defined($cid));
6603:
6604: $cdom = $env{'course.'.$cid.'.domain'};
6605: $cnum = $env{'course.'.$cid.'.num'};
6606: }
6607:
6608: my %sectioncount;
1.419 raeburn 6609: my $now = time;
1.240 albertel 6610:
1.366 albertel 6611: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6612: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6613: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6614: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6615: my $start_index = &Apache::loncoursedata::CL_START();
6616: my $end_index = &Apache::loncoursedata::CL_END();
6617: my $status;
1.366 albertel 6618: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6619: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6620: $data->[$status_index],
6621: $data->[$start_index],
6622: $data->[$end_index]);
6623: if ($stu_status eq 'Active') {
6624: $status = 'active';
6625: } elsif ($end < $now) {
6626: $status = 'previous';
6627: } elsif ($start > $now) {
6628: $status = 'future';
6629: }
6630: if ($section ne '-1' && $section !~ /^\s*$/) {
6631: if ((!defined($possible_status)) || (($status ne '') &&
6632: (grep/^\Q$status\E$/,@{$possible_status}))) {
6633: $sectioncount{$section}++;
6634: }
1.240 albertel 6635: }
6636: }
6637: }
6638: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6639: foreach my $user (sort(keys(%courseroles))) {
6640: if ($user !~ /^(\w{2})/) { next; }
6641: my ($role) = ($user =~ /^(\w{2})/);
6642: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6643: my ($section,$status);
1.240 albertel 6644: if ($role eq 'cr' &&
6645: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6646: $section=$1;
6647: }
6648: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6649: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6650: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6651: if ($end == -1 && $start == -1) {
6652: next; #deleted role
6653: }
6654: if (!defined($possible_status)) {
6655: $sectioncount{$section}++;
6656: } else {
6657: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6658: $status = 'active';
6659: } elsif ($end < $now) {
6660: $status = 'future';
6661: } elsif ($start > $now) {
6662: $status = 'previous';
6663: }
6664: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6665: $sectioncount{$section}++;
6666: }
6667: }
1.233 raeburn 6668: }
1.366 albertel 6669: return %sectioncount;
1.233 raeburn 6670: }
6671:
1.274 raeburn 6672: ###############################################
1.294 raeburn 6673:
6674: =pod
1.405 albertel 6675:
6676: =item * &get_course_users()
6677:
1.275 raeburn 6678: Retrieves usernames:domains for users in the specified course
6679: with specific role(s), and access status.
6680:
6681: Incoming parameters:
1.277 albertel 6682: 1. course domain
6683: 2. course number
6684: 3. access status: users must have - either active,
1.275 raeburn 6685: previous, future, or all.
1.277 albertel 6686: 4. reference to array of permissible roles
1.288 raeburn 6687: 5. reference to array of section restrictions (optional)
6688: 6. reference to results object (hash of hashes).
6689: 7. reference to optional userdata hash
1.609 raeburn 6690: 8. reference to optional statushash
1.630 raeburn 6691: 9. flag if privileged users (except those set to unhide in
6692: course settings) should be excluded
1.609 raeburn 6693: Keys of top level results hash are roles.
1.275 raeburn 6694: Keys of inner hashes are username:domain, with
6695: values set to access type.
1.288 raeburn 6696: Optional userdata hash returns an array with arguments in the
6697: same order as loncoursedata::get_classlist() for student data.
6698:
1.609 raeburn 6699: Optional statushash returns
6700:
1.288 raeburn 6701: Entries for end, start, section and status are blank because
6702: of the possibility of multiple values for non-student roles.
6703:
1.275 raeburn 6704: =cut
1.405 albertel 6705:
1.275 raeburn 6706: ###############################################
1.405 albertel 6707:
1.275 raeburn 6708: sub get_course_users {
1.630 raeburn 6709: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6710: my %idx = ();
1.419 raeburn 6711: my %seclists;
1.288 raeburn 6712:
6713: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6714: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6715: $idx{end} = &Apache::loncoursedata::CL_END();
6716: $idx{start} = &Apache::loncoursedata::CL_START();
6717: $idx{id} = &Apache::loncoursedata::CL_ID();
6718: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6719: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6720: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6721:
1.290 albertel 6722: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6723: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6724: my $now = time;
1.277 albertel 6725: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6726: my $match = 0;
1.412 raeburn 6727: my $secmatch = 0;
1.419 raeburn 6728: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6729: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6730: if ($section eq '') {
6731: $section = 'none';
6732: }
1.291 albertel 6733: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6734: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6735: $secmatch = 1;
6736: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6737: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6738: $secmatch = 1;
6739: }
6740: } else {
1.419 raeburn 6741: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6742: $secmatch = 1;
6743: }
1.290 albertel 6744: }
1.412 raeburn 6745: if (!$secmatch) {
6746: next;
6747: }
1.419 raeburn 6748: }
1.275 raeburn 6749: if (defined($$types{'active'})) {
1.288 raeburn 6750: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6751: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6752: $match = 1;
1.275 raeburn 6753: }
6754: }
6755: if (defined($$types{'previous'})) {
1.609 raeburn 6756: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6757: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6758: $match = 1;
1.275 raeburn 6759: }
6760: }
6761: if (defined($$types{'future'})) {
1.609 raeburn 6762: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6763: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6764: $match = 1;
1.275 raeburn 6765: }
6766: }
1.609 raeburn 6767: if ($match) {
6768: push(@{$seclists{$student}},$section);
6769: if (ref($userdata) eq 'HASH') {
6770: $$userdata{$student} = $$classlist{$student};
6771: }
6772: if (ref($statushash) eq 'HASH') {
6773: $statushash->{$student}{'st'}{$section} = $status;
6774: }
1.288 raeburn 6775: }
1.275 raeburn 6776: }
6777: }
1.412 raeburn 6778: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6779: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6780: my $now = time;
1.609 raeburn 6781: my %displaystatus = ( previous => 'Expired',
6782: active => 'Active',
6783: future => 'Future',
6784: );
1.630 raeburn 6785: my %nothide;
6786: if ($hidepriv) {
6787: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6788: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6789: if ($user !~ /:/) {
6790: $nothide{join(':',split(/[\@]/,$user))}=1;
6791: } else {
6792: $nothide{$user} = 1;
6793: }
6794: }
6795: }
1.439 raeburn 6796: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6797: my $match = 0;
1.412 raeburn 6798: my $secmatch = 0;
1.439 raeburn 6799: my $status;
1.412 raeburn 6800: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6801: $user =~ s/:$//;
1.439 raeburn 6802: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6803: if ($end == -1 || $start == -1) {
6804: next;
6805: }
6806: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6807: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6808: my ($uname,$udom) = split(/:/,$user);
6809: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6810: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6811: $secmatch = 1;
6812: } elsif ($usec eq '') {
1.420 albertel 6813: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6814: $secmatch = 1;
6815: }
6816: } else {
6817: if (grep(/^\Q$usec\E$/,@{$sections})) {
6818: $secmatch = 1;
6819: }
6820: }
6821: if (!$secmatch) {
6822: next;
6823: }
1.288 raeburn 6824: }
1.419 raeburn 6825: if ($usec eq '') {
6826: $usec = 'none';
6827: }
1.275 raeburn 6828: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6829: if ($hidepriv) {
6830: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6831: (!$nothide{$uname.':'.$udom})) {
6832: next;
6833: }
6834: }
1.503 raeburn 6835: if ($end > 0 && $end < $now) {
1.439 raeburn 6836: $status = 'previous';
6837: } elsif ($start > $now) {
6838: $status = 'future';
6839: } else {
6840: $status = 'active';
6841: }
1.277 albertel 6842: foreach my $type (keys(%{$types})) {
1.275 raeburn 6843: if ($status eq $type) {
1.420 albertel 6844: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6845: push(@{$$users{$role}{$user}},$type);
6846: }
1.288 raeburn 6847: $match = 1;
6848: }
6849: }
1.419 raeburn 6850: if (($match) && (ref($userdata) eq 'HASH')) {
6851: if (!exists($$userdata{$uname.':'.$udom})) {
6852: &get_user_info($udom,$uname,\%idx,$userdata);
6853: }
1.420 albertel 6854: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6855: push(@{$seclists{$uname.':'.$udom}},$usec);
6856: }
1.609 raeburn 6857: if (ref($statushash) eq 'HASH') {
6858: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6859: }
1.275 raeburn 6860: }
6861: }
6862: }
6863: }
1.290 albertel 6864: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6865: if ((defined($cdom)) && (defined($cnum))) {
6866: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6867: if ( defined($csettings{'internal.courseowner'}) ) {
6868: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6869: next if ($owner eq '');
6870: my ($ownername,$ownerdom);
6871: if ($owner =~ /^([^:]+):([^:]+)$/) {
6872: $ownername = $1;
6873: $ownerdom = $2;
6874: } else {
6875: $ownername = $owner;
6876: $ownerdom = $cdom;
6877: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6878: }
6879: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6880: if (defined($userdata) &&
1.609 raeburn 6881: !exists($$userdata{$owner})) {
6882: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6883: if (!grep(/^none$/,@{$seclists{$owner}})) {
6884: push(@{$seclists{$owner}},'none');
6885: }
6886: if (ref($statushash) eq 'HASH') {
6887: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6888: }
1.290 albertel 6889: }
1.279 raeburn 6890: }
6891: }
6892: }
1.419 raeburn 6893: foreach my $user (keys(%seclists)) {
6894: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6895: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6896: }
1.275 raeburn 6897: }
6898: return;
6899: }
6900:
1.288 raeburn 6901: sub get_user_info {
6902: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6903: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6904: &plainname($uname,$udom,'lastname');
1.291 albertel 6905: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6906: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6907: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6908: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6909: return;
6910: }
1.275 raeburn 6911:
1.472 raeburn 6912: ###############################################
6913:
6914: =pod
6915:
6916: =item * &get_user_quota()
6917:
6918: Retrieves quota assigned for storage of portfolio files for a user
6919:
6920: Incoming parameters:
6921: 1. user's username
6922: 2. user's domain
6923:
6924: Returns:
1.536 raeburn 6925: 1. Disk quota (in Mb) assigned to student.
6926: 2. (Optional) Type of setting: custom or default
6927: (individually assigned or default for user's
6928: institutional status).
6929: 3. (Optional) - User's institutional status (e.g., faculty, staff
6930: or student - types as defined in localenroll::inst_usertypes
6931: for user's domain, which determines default quota for user.
6932: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6933:
6934: If a value has been stored in the user's environment,
1.536 raeburn 6935: it will return that, otherwise it returns the maximal default
6936: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6937:
6938: =cut
6939:
6940: ###############################################
6941:
6942:
6943: sub get_user_quota {
6944: my ($uname,$udom) = @_;
1.536 raeburn 6945: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6946: if (!defined($udom)) {
6947: $udom = $env{'user.domain'};
6948: }
6949: if (!defined($uname)) {
6950: $uname = $env{'user.name'};
6951: }
6952: if (($udom eq '' || $uname eq '') ||
6953: ($udom eq 'public') && ($uname eq 'public')) {
6954: $quota = 0;
1.536 raeburn 6955: $quotatype = 'default';
6956: $defquota = 0;
1.472 raeburn 6957: } else {
1.536 raeburn 6958: my $inststatus;
1.472 raeburn 6959: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6960: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6961: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6962: } else {
1.536 raeburn 6963: my %userenv =
6964: &Apache::lonnet::get('environment',['portfolioquota',
6965: 'inststatus'],$udom,$uname);
1.472 raeburn 6966: my ($tmp) = keys(%userenv);
6967: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6968: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6969: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6970: } else {
6971: undef(%userenv);
6972: }
6973: }
1.536 raeburn 6974: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6975: if ($quota eq '') {
1.536 raeburn 6976: $quota = $defquota;
6977: $quotatype = 'default';
6978: } else {
6979: $quotatype = 'custom';
1.472 raeburn 6980: }
6981: }
1.536 raeburn 6982: if (wantarray) {
6983: return ($quota,$quotatype,$settingstatus,$defquota);
6984: } else {
6985: return $quota;
6986: }
1.472 raeburn 6987: }
6988:
6989: ###############################################
6990:
6991: =pod
6992:
6993: =item * &default_quota()
6994:
1.536 raeburn 6995: Retrieves default quota assigned for storage of user portfolio files,
6996: given an (optional) user's institutional status.
1.472 raeburn 6997:
6998: Incoming parameters:
6999: 1. domain
1.536 raeburn 7000: 2. (Optional) institutional status(es). This is a : separated list of
7001: status types (e.g., faculty, staff, student etc.)
7002: which apply to the user for whom the default is being retrieved.
7003: If the institutional status string in undefined, the domain
7004: default quota will be returned.
1.472 raeburn 7005:
7006: Returns:
7007: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 7008: 2. (Optional) institutional type which determined the value of the
7009: default quota.
1.472 raeburn 7010:
7011: If a value has been stored in the domain's configuration db,
7012: it will return that, otherwise it returns 20 (for backwards
7013: compatibility with domains which have not set up a configuration
7014: db file; the original statically defined portfolio quota was 20 Mb).
7015:
1.536 raeburn 7016: If the user's status includes multiple types (e.g., staff and student),
7017: the largest default quota which applies to the user determines the
7018: default quota returned.
7019:
1.472 raeburn 7020: =cut
7021:
7022: ###############################################
7023:
7024:
7025: sub default_quota {
1.536 raeburn 7026: my ($udom,$inststatus) = @_;
7027: my ($defquota,$settingstatus);
7028: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 7029: ['quotas'],$udom);
7030: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 7031: if ($inststatus ne '') {
1.765 raeburn 7032: my @statuses = map { &unescape($_); } split(/:/,$inststatus);
1.536 raeburn 7033: foreach my $item (@statuses) {
1.711 raeburn 7034: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7035: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
7036: if ($defquota eq '') {
7037: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7038: $settingstatus = $item;
7039: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
7040: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
7041: $settingstatus = $item;
7042: }
7043: }
7044: } else {
7045: if ($quotahash{'quotas'}{$item} ne '') {
7046: if ($defquota eq '') {
7047: $defquota = $quotahash{'quotas'}{$item};
7048: $settingstatus = $item;
7049: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
7050: $defquota = $quotahash{'quotas'}{$item};
7051: $settingstatus = $item;
7052: }
1.536 raeburn 7053: }
7054: }
7055: }
7056: }
7057: if ($defquota eq '') {
1.711 raeburn 7058: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
7059: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
7060: } else {
7061: $defquota = $quotahash{'quotas'}{'default'};
7062: }
1.536 raeburn 7063: $settingstatus = 'default';
7064: }
7065: } else {
7066: $settingstatus = 'default';
7067: $defquota = 20;
7068: }
7069: if (wantarray) {
7070: return ($defquota,$settingstatus);
1.472 raeburn 7071: } else {
1.536 raeburn 7072: return $defquota;
1.472 raeburn 7073: }
7074: }
7075:
1.384 raeburn 7076: sub get_secgrprole_info {
7077: my ($cdom,$cnum,$needroles,$type) = @_;
7078: my %sections_count = &get_sections($cdom,$cnum);
7079: my @sections = (sort {$a <=> $b} keys(%sections_count));
7080: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
7081: my @groups = sort(keys(%curr_groups));
7082: my $allroles = [];
7083: my $rolehash;
7084: my $accesshash = {
7085: active => 'Currently has access',
7086: future => 'Will have future access',
7087: previous => 'Previously had access',
7088: };
7089: if ($needroles) {
7090: $rolehash = {'all' => 'all'};
1.385 albertel 7091: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
7092: if (&Apache::lonnet::error(%user_roles)) {
7093: undef(%user_roles);
7094: }
7095: foreach my $item (keys(%user_roles)) {
1.384 raeburn 7096: my ($role)=split(/\:/,$item,2);
7097: if ($role eq 'cr') { next; }
7098: if ($role =~ /^cr/) {
7099: $$rolehash{$role} = (split('/',$role))[3];
7100: } else {
7101: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
7102: }
7103: }
7104: foreach my $key (sort(keys(%{$rolehash}))) {
7105: push(@{$allroles},$key);
7106: }
7107: push (@{$allroles},'st');
7108: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
7109: }
7110: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
7111: }
7112:
1.555 raeburn 7113: sub user_picker {
1.627 raeburn 7114: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 7115: my $currdom = $dom;
7116: my %curr_selected = (
7117: srchin => 'dom',
1.580 raeburn 7118: srchby => 'lastname',
1.555 raeburn 7119: );
7120: my $srchterm;
1.625 raeburn 7121: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 7122: if ($srch->{'srchby'} ne '') {
7123: $curr_selected{'srchby'} = $srch->{'srchby'};
7124: }
7125: if ($srch->{'srchin'} ne '') {
7126: $curr_selected{'srchin'} = $srch->{'srchin'};
7127: }
7128: if ($srch->{'srchtype'} ne '') {
7129: $curr_selected{'srchtype'} = $srch->{'srchtype'};
7130: }
7131: if ($srch->{'srchdomain'} ne '') {
7132: $currdom = $srch->{'srchdomain'};
7133: }
7134: $srchterm = $srch->{'srchterm'};
7135: }
7136: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 7137: 'usr' => 'Search criteria',
1.563 raeburn 7138: 'doma' => 'Domain/institution to search',
1.558 albertel 7139: 'uname' => 'username',
7140: 'lastname' => 'last name',
1.555 raeburn 7141: 'lastfirst' => 'last name, first name',
1.558 albertel 7142: 'crs' => 'in this course',
1.576 raeburn 7143: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 7144: 'alc' => 'all LON-CAPA',
1.573 raeburn 7145: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 7146: 'exact' => 'is',
7147: 'contains' => 'contains',
1.569 raeburn 7148: 'begins' => 'begins with',
1.571 raeburn 7149: 'youm' => "You must include some text to search for.",
7150: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
7151: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
7152: 'yomc' => "You must choose a domain when using an institutional directory search.",
7153: 'ymcd' => "You must choose a domain when using a domain search.",
7154: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
7155: 'whse' => "When searching by last,first you must include at least one character in the first name.",
7156: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 7157: );
1.563 raeburn 7158: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
7159: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 7160:
7161: my @srchins = ('crs','dom','alc','instd');
7162:
7163: foreach my $option (@srchins) {
7164: # FIXME 'alc' option unavailable until
7165: # loncreateuser::print_user_query_page()
7166: # has been completed.
7167: next if ($option eq 'alc');
7168: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 7169: if ($curr_selected{'srchin'} eq $option) {
7170: $srchinsel .= '
7171: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7172: } else {
7173: $srchinsel .= '
7174: <option value="'.$option.'">'.$lt{$option}.'</option>';
7175: }
1.555 raeburn 7176: }
1.563 raeburn 7177: $srchinsel .= "\n </select>\n";
1.555 raeburn 7178:
7179: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 7180: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 7181: if ($curr_selected{'srchby'} eq $option) {
7182: $srchbysel .= '
7183: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7184: } else {
7185: $srchbysel .= '
7186: <option value="'.$option.'">'.$lt{$option}.'</option>';
7187: }
7188: }
7189: $srchbysel .= "\n </select>\n";
7190:
7191: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 7192: foreach my $option ('begins','contains','exact') {
1.555 raeburn 7193: if ($curr_selected{'srchtype'} eq $option) {
7194: $srchtypesel .= '
7195: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
7196: } else {
7197: $srchtypesel .= '
7198: <option value="'.$option.'">'.$lt{$option}.'</option>';
7199: }
7200: }
7201: $srchtypesel .= "\n </select>\n";
7202:
1.558 albertel 7203: my ($newuserscript,$new_user_create);
1.556 raeburn 7204:
7205: if ($forcenewuser) {
1.576 raeburn 7206: if (ref($srch) eq 'HASH') {
7207: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 7208: if ($cancreate) {
7209: $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>';
7210: } else {
7211: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
7212: my %usertypetext = (
7213: official => 'institutional',
7214: unofficial => 'non-institutional',
7215: );
7216: $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 />';
7217: }
1.576 raeburn 7218: }
7219: }
7220:
1.556 raeburn 7221: $newuserscript = <<"ENDSCRIPT";
7222:
1.570 raeburn 7223: function setSearch(createnew,callingForm) {
1.556 raeburn 7224: if (createnew == 1) {
1.570 raeburn 7225: for (var i=0; i<callingForm.srchby.length; i++) {
7226: if (callingForm.srchby.options[i].value == 'uname') {
7227: callingForm.srchby.selectedIndex = i;
1.556 raeburn 7228: }
7229: }
1.570 raeburn 7230: for (var i=0; i<callingForm.srchin.length; i++) {
7231: if ( callingForm.srchin.options[i].value == 'dom') {
7232: callingForm.srchin.selectedIndex = i;
1.556 raeburn 7233: }
7234: }
1.570 raeburn 7235: for (var i=0; i<callingForm.srchtype.length; i++) {
7236: if (callingForm.srchtype.options[i].value == 'exact') {
7237: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 7238: }
7239: }
1.570 raeburn 7240: for (var i=0; i<callingForm.srchdomain.length; i++) {
7241: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
7242: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 7243: }
7244: }
7245: }
7246: }
7247: ENDSCRIPT
1.558 albertel 7248:
1.556 raeburn 7249: }
7250:
1.555 raeburn 7251: my $output = <<"END_BLOCK";
1.556 raeburn 7252: <script type="text/javascript">
1.570 raeburn 7253: function validateEntry(callingForm) {
1.558 albertel 7254:
1.556 raeburn 7255: var checkok = 1;
1.558 albertel 7256: var srchin;
1.570 raeburn 7257: for (var i=0; i<callingForm.srchin.length; i++) {
7258: if ( callingForm.srchin[i].checked ) {
7259: srchin = callingForm.srchin[i].value;
1.558 albertel 7260: }
7261: }
7262:
1.570 raeburn 7263: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
7264: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
7265: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
7266: var srchterm = callingForm.srchterm.value;
7267: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 7268: var msg = "";
7269:
7270: if (srchterm == "") {
7271: checkok = 0;
1.571 raeburn 7272: msg += "$lt{'youm'}\\n";
1.556 raeburn 7273: }
7274:
1.569 raeburn 7275: if (srchtype== 'begins') {
7276: if (srchterm.length < 2) {
7277: checkok = 0;
1.571 raeburn 7278: msg += "$lt{'thte'}\\n";
1.569 raeburn 7279: }
7280: }
7281:
1.556 raeburn 7282: if (srchtype== 'contains') {
7283: if (srchterm.length < 3) {
7284: checkok = 0;
1.571 raeburn 7285: msg += "$lt{'thet'}\\n";
1.556 raeburn 7286: }
7287: }
7288: if (srchin == 'instd') {
7289: if (srchdomain == '') {
7290: checkok = 0;
1.571 raeburn 7291: msg += "$lt{'yomc'}\\n";
1.556 raeburn 7292: }
7293: }
7294: if (srchin == 'dom') {
7295: if (srchdomain == '') {
7296: checkok = 0;
1.571 raeburn 7297: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 7298: }
7299: }
7300: if (srchby == 'lastfirst') {
7301: if (srchterm.indexOf(",") == -1) {
7302: checkok = 0;
1.571 raeburn 7303: msg += "$lt{'whus'}\\n";
1.556 raeburn 7304: }
7305: if (srchterm.indexOf(",") == srchterm.length -1) {
7306: checkok = 0;
1.571 raeburn 7307: msg += "$lt{'whse'}\\n";
1.556 raeburn 7308: }
7309: }
7310: if (checkok == 0) {
1.571 raeburn 7311: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 7312: return;
7313: }
7314: if (checkok == 1) {
1.570 raeburn 7315: callingForm.submit();
1.556 raeburn 7316: }
7317: }
7318:
7319: $newuserscript
7320:
7321: </script>
1.558 albertel 7322:
7323: $new_user_create
7324:
1.555 raeburn 7325: <table>
1.558 albertel 7326: <tr>
1.573 raeburn 7327: <td>$lt{'doma'}:</td>
7328: <td>$domform</td>
7329: </td>
7330: </tr>
7331: <tr>
7332: <td>$lt{'usr'}:</td>
1.563 raeburn 7333: <td>$srchbysel
7334: $srchtypesel
7335: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 7336: $srchinsel
1.563 raeburn 7337: </td>
7338: </tr>
1.555 raeburn 7339: </table>
7340: <br />
7341: END_BLOCK
1.558 albertel 7342:
1.555 raeburn 7343: return $output;
7344: }
7345:
1.612 raeburn 7346: sub user_rule_check {
1.615 raeburn 7347: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 7348: my $response;
7349: if (ref($usershash) eq 'HASH') {
7350: foreach my $user (keys(%{$usershash})) {
7351: my ($uname,$udom) = split(/:/,$user);
7352: next if ($udom eq '' || $uname eq '');
1.615 raeburn 7353: my ($id,$newuser);
1.612 raeburn 7354: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 7355: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 7356: $id = $usershash->{$user}->{'id'};
7357: }
7358: my $inst_response;
7359: if (ref($checks) eq 'HASH') {
7360: if (defined($checks->{'username'})) {
1.615 raeburn 7361: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7362: &Apache::lonnet::get_instuser($udom,$uname);
7363: } elsif (defined($checks->{'id'})) {
1.615 raeburn 7364: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 7365: &Apache::lonnet::get_instuser($udom,undef,$id);
7366: }
1.615 raeburn 7367: } else {
7368: ($inst_response,%{$inst_results->{$user}}) =
7369: &Apache::lonnet::get_instuser($udom,$uname);
7370: return;
1.612 raeburn 7371: }
1.615 raeburn 7372: if (!$got_rules->{$udom}) {
1.612 raeburn 7373: my %domconfig = &Apache::lonnet::get_dom('configuration',
7374: ['usercreation'],$udom);
7375: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 7376: foreach my $item ('username','id') {
1.612 raeburn 7377: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
7378: $$curr_rules{$udom}{$item} =
7379: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 7380: }
7381: }
7382: }
1.615 raeburn 7383: $got_rules->{$udom} = 1;
1.585 raeburn 7384: }
1.612 raeburn 7385: foreach my $item (keys(%{$checks})) {
7386: if (ref($$curr_rules{$udom}) eq 'HASH') {
7387: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
7388: if (@{$$curr_rules{$udom}{$item}} > 0) {
7389: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
7390: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
7391: if ($rule_check{$rule}) {
7392: $$rulematch{$user}{$item} = $rule;
7393: if ($inst_response eq 'ok') {
1.615 raeburn 7394: if (ref($inst_results) eq 'HASH') {
7395: if (ref($inst_results->{$user}) eq 'HASH') {
7396: if (keys(%{$inst_results->{$user}}) == 0) {
7397: $$alerts{$item}{$udom}{$uname} = 1;
7398: }
1.612 raeburn 7399: }
7400: }
1.615 raeburn 7401: }
7402: last;
1.585 raeburn 7403: }
7404: }
7405: }
7406: }
7407: }
7408: }
7409: }
7410: }
1.612 raeburn 7411: return;
7412: }
7413:
7414: sub user_rule_formats {
7415: my ($domain,$domdesc,$curr_rules,$check) = @_;
7416: my %text = (
7417: 'username' => 'Usernames',
7418: 'id' => 'IDs',
7419: );
7420: my $output;
7421: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
7422: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
7423: if (@{$ruleorder} > 0) {
7424: $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>';
7425: foreach my $rule (@{$ruleorder}) {
7426: if (ref($curr_rules) eq 'ARRAY') {
7427: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
7428: if (ref($rules->{$rule}) eq 'HASH') {
7429: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
7430: $rules->{$rule}{'desc'}.'</li>';
7431: }
7432: }
7433: }
7434: }
7435: $output .= '</ul>';
7436: }
7437: }
7438: return $output;
7439: }
7440:
7441: sub instrule_disallow_msg {
1.615 raeburn 7442: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 7443: my $response;
7444: my %text = (
7445: item => 'username',
7446: items => 'usernames',
7447: match => 'matches',
7448: do => 'does',
7449: action => 'a username',
7450: one => 'one',
7451: );
7452: if ($count > 1) {
7453: $text{'item'} = 'usernames';
7454: $text{'match'} ='match';
7455: $text{'do'} = 'do';
7456: $text{'action'} = 'usernames',
7457: $text{'one'} = 'ones';
7458: }
7459: if ($checkitem eq 'id') {
7460: $text{'items'} = 'IDs';
7461: $text{'item'} = 'ID';
7462: $text{'action'} = 'an ID';
1.615 raeburn 7463: if ($count > 1) {
7464: $text{'item'} = 'IDs';
7465: $text{'action'} = 'IDs';
7466: }
1.612 raeburn 7467: }
1.674 bisitz 7468: $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 7469: if ($mode eq 'upload') {
7470: if ($checkitem eq 'username') {
7471: $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'}.");
7472: } elsif ($checkitem eq 'id') {
1.674 bisitz 7473: $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 7474: }
1.669 raeburn 7475: } elsif ($mode eq 'selfcreate') {
7476: if ($checkitem eq 'id') {
7477: $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.");
7478: }
1.615 raeburn 7479: } else {
7480: if ($checkitem eq 'username') {
7481: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
7482: } elsif ($checkitem eq 'id') {
7483: $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.");
7484: }
1.612 raeburn 7485: }
7486: return $response;
1.585 raeburn 7487: }
7488:
1.624 raeburn 7489: sub personal_data_fieldtitles {
7490: my %fieldtitles = &Apache::lonlocal::texthash (
7491: id => 'Student/Employee ID',
7492: permanentemail => 'E-mail address',
7493: lastname => 'Last Name',
7494: firstname => 'First Name',
7495: middlename => 'Middle Name',
7496: generation => 'Generation',
7497: gen => 'Generation',
1.765 raeburn 7498: inststatus => 'Affiliation',
1.624 raeburn 7499: );
7500: return %fieldtitles;
7501: }
7502:
1.642 raeburn 7503: sub sorted_inst_types {
7504: my ($dom) = @_;
7505: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
7506: my $othertitle = &mt('All users');
7507: if ($env{'request.course.id'}) {
1.668 raeburn 7508: $othertitle = &mt('Any users');
1.642 raeburn 7509: }
7510: my @types;
7511: if (ref($order) eq 'ARRAY') {
7512: @types = @{$order};
7513: }
7514: if (@types == 0) {
7515: if (ref($usertypes) eq 'HASH') {
7516: @types = sort(keys(%{$usertypes}));
7517: }
7518: }
7519: if (keys(%{$usertypes}) > 0) {
7520: $othertitle = &mt('Other users');
7521: }
7522: return ($othertitle,$usertypes,\@types);
7523: }
7524:
1.645 raeburn 7525: sub get_institutional_codes {
7526: my ($settings,$allcourses,$LC_code) = @_;
7527: # Get complete list of course sections to update
7528: my @currsections = ();
7529: my @currxlists = ();
7530: my $coursecode = $$settings{'internal.coursecode'};
7531:
7532: if ($$settings{'internal.sectionnums'} ne '') {
7533: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7534: }
7535:
7536: if ($$settings{'internal.crosslistings'} ne '') {
7537: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7538: }
7539:
7540: if (@currxlists > 0) {
7541: foreach (@currxlists) {
7542: if (m/^([^:]+):(\w*)$/) {
7543: unless (grep/^$1$/,@{$allcourses}) {
7544: push @{$allcourses},$1;
7545: $$LC_code{$1} = $2;
7546: }
7547: }
7548: }
7549: }
7550:
7551: if (@currsections > 0) {
7552: foreach (@currsections) {
7553: if (m/^(\w+):(\w*)$/) {
7554: my $sec = $coursecode.$1;
7555: my $lc_sec = $2;
7556: unless (grep/^$sec$/,@{$allcourses}) {
7557: push @{$allcourses},$sec;
7558: $$LC_code{$sec} = $lc_sec;
7559: }
7560: }
7561: }
7562: }
7563: return;
7564: }
7565:
1.112 bowersj2 7566: =pod
7567:
1.549 albertel 7568: =back
7569:
7570: =head1 HTTP Helpers
7571:
7572: =over 4
7573:
1.648 raeburn 7574: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7575:
1.258 albertel 7576: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7577: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7578: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7579:
7580: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7581: $possible_names is an ref to an array of form element names. As an example:
7582: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7583: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7584:
7585: =cut
1.1 albertel 7586:
1.6 albertel 7587: sub get_unprocessed_cgi {
1.25 albertel 7588: my ($query,$possible_names)= @_;
1.26 matthew 7589: # $Apache::lonxml::debug=1;
1.356 albertel 7590: foreach my $pair (split(/&/,$query)) {
7591: my ($name, $value) = split(/=/,$pair);
1.369 www 7592: $name = &unescape($name);
1.25 albertel 7593: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7594: $value =~ tr/+/ /;
7595: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7596: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7597: }
1.16 harris41 7598: }
1.6 albertel 7599: }
7600:
1.112 bowersj2 7601: =pod
7602:
1.648 raeburn 7603: =item * &cacheheader()
1.112 bowersj2 7604:
7605: returns cache-controlling header code
7606:
7607: =cut
7608:
1.7 albertel 7609: sub cacheheader {
1.258 albertel 7610: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7611: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7612: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7613: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7614: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7615: return $output;
1.7 albertel 7616: }
7617:
1.112 bowersj2 7618: =pod
7619:
1.648 raeburn 7620: =item * &no_cache($r)
1.112 bowersj2 7621:
7622: specifies header code to not have cache
7623:
7624: =cut
7625:
1.9 albertel 7626: sub no_cache {
1.216 albertel 7627: my ($r) = @_;
7628: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7629: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7630: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7631: $r->no_cache(1);
7632: $r->header_out("Expires" => $date);
7633: $r->header_out("Pragma" => "no-cache");
1.123 www 7634: }
7635:
7636: sub content_type {
1.181 albertel 7637: my ($r,$type,$charset) = @_;
1.299 foxr 7638: if ($r) {
7639: # Note that printout.pl calls this with undef for $r.
7640: &no_cache($r);
7641: }
1.258 albertel 7642: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7643: unless ($charset) {
7644: $charset=&Apache::lonlocal::current_encoding;
7645: }
7646: if ($charset) { $type.='; charset='.$charset; }
7647: if ($r) {
7648: $r->content_type($type);
7649: } else {
7650: print("Content-type: $type\n\n");
7651: }
1.9 albertel 7652: }
1.25 albertel 7653:
1.112 bowersj2 7654: =pod
7655:
1.648 raeburn 7656: =item * &add_to_env($name,$value)
1.112 bowersj2 7657:
1.258 albertel 7658: adds $name to the %env hash with value
1.112 bowersj2 7659: $value, if $name already exists, the entry is converted to an array
7660: reference and $value is added to the array.
7661:
7662: =cut
7663:
1.25 albertel 7664: sub add_to_env {
7665: my ($name,$value)=@_;
1.258 albertel 7666: if (defined($env{$name})) {
7667: if (ref($env{$name})) {
1.25 albertel 7668: #already have multiple values
1.258 albertel 7669: push(@{ $env{$name} },$value);
1.25 albertel 7670: } else {
7671: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7672: my $first=$env{$name};
7673: undef($env{$name});
7674: push(@{ $env{$name} },$first,$value);
1.25 albertel 7675: }
7676: } else {
1.258 albertel 7677: $env{$name}=$value;
1.25 albertel 7678: }
1.31 albertel 7679: }
1.149 albertel 7680:
7681: =pod
7682:
1.648 raeburn 7683: =item * &get_env_multiple($name)
1.149 albertel 7684:
1.258 albertel 7685: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7686: values may be defined and end up as an array ref.
7687:
7688: returns an array of values
7689:
7690: =cut
7691:
7692: sub get_env_multiple {
7693: my ($name) = @_;
7694: my @values;
1.258 albertel 7695: if (defined($env{$name})) {
1.149 albertel 7696: # exists is it an array
1.258 albertel 7697: if (ref($env{$name})) {
7698: @values=@{ $env{$name} };
1.149 albertel 7699: } else {
1.258 albertel 7700: $values[0]=$env{$name};
1.149 albertel 7701: }
7702: }
7703: return(@values);
7704: }
7705:
1.660 raeburn 7706: sub ask_for_embedded_content {
7707: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7708: my $upload_output = '
7709: <form name="upload_embedded" action="'.$actionurl.'"
7710: method="post" enctype="multipart/form-data">';
7711: $upload_output .= $state;
1.661 raeburn 7712: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7713:
7714: my $num = 0;
7715: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7716: $upload_output .= &start_data_table_row().
7717: '<td>'.$embed_file.'</td><td>';
7718: if ($args->{'ignore_remote_references'}
7719: && $embed_file =~ m{^\w+://}) {
7720: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7721: } elsif ($args->{'error_on_invalid_names'}
7722: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7723:
7724: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7725:
7726: } else {
7727: $upload_output .='
1.661 raeburn 7728: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7729: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7730: my $attrib = join(':',@{$$allfiles{$embed_file}});
7731: $upload_output .=
7732: "\n\t\t".
7733: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7734: $attrib.'" />';
7735: if (exists($$codebase{$embed_file})) {
7736: $upload_output .=
7737: "\n\t\t".
7738: '<input name="codebase_'.$num.'" type="hidden" value="'.
7739: &escape($$codebase{$embed_file}).'" />';
7740: }
7741: }
7742: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7743: $num++;
7744: }
7745: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7746: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7747: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7748: '.&mt('(only files for which a location has been provided will be uploaded)').'
7749: </form>';
7750: return $upload_output;
7751: }
7752:
1.661 raeburn 7753: sub upload_embedded {
7754: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7755: $current_disk_usage) = @_;
7756: my $output;
7757: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7758: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7759: my $orig_uploaded_filename =
7760: $env{'form.embedded_item_'.$i.'.filename'};
7761:
7762: $env{'form.embedded_orig_'.$i} =
7763: &unescape($env{'form.embedded_orig_'.$i});
7764: my ($path,$fname) =
7765: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7766: # no path, whole string is fname
7767: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7768:
7769: $path = $env{'form.currentpath'}.$path;
7770: $fname = &Apache::lonnet::clean_filename($fname);
7771: # See if there is anything left
7772: next if ($fname eq '');
7773:
7774: # Check if file already exists as a file or directory.
7775: my ($state,$msg);
7776: if ($context eq 'portfolio') {
7777: my $port_path = $dirpath;
7778: if ($group ne '') {
7779: $port_path = "groups/$group/$port_path";
7780: }
7781: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7782: $dir_root,$port_path,$disk_quota,
7783: $current_disk_usage,$uname,$udom);
7784: if ($state eq 'will_exceed_quota'
7785: || $state eq 'file_locked'
7786: || $state eq 'file_exists' ) {
7787: $output .= $msg;
7788: next;
7789: }
7790: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7791: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7792: if ($state eq 'exists') {
7793: $output .= $msg;
7794: next;
7795: }
7796: }
7797: # Check if extension is valid
7798: if (($fname =~ /\.(\w+)$/) &&
7799: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7800: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7801: next;
7802: } elsif (($fname =~ /\.(\w+)$/) &&
7803: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7804: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7805: next;
7806: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7807: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7808: next;
7809: }
7810:
7811: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7812: if ($context eq 'portfolio') {
7813: my $result=
7814: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7815: $dirpath.$path);
7816: if ($result !~ m|^/uploaded/|) {
7817: $output .= '<span class="LC_error">'
7818: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7819: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7820: .'</span><br />';
7821: next;
7822: } else {
7823: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7824: $path.$fname.'</span>').'</p>';
7825: }
7826: } else {
7827: # Save the file
7828: my $target = $env{'form.embedded_item_'.$i};
7829: my $fullpath = $dir_root.$dirpath.'/'.$path;
7830: my $dest = $fullpath.$fname;
7831: my $url = $url_root.$dirpath.'/'.$path.$fname;
7832: my @parts=split(/\//,$fullpath);
7833: my $count;
7834: my $filepath = $dir_root;
7835: for ($count=4;$count<=$#parts;$count++) {
7836: $filepath .= "/$parts[$count]";
7837: if ((-e $filepath)!=1) {
7838: mkdir($filepath,0770);
7839: }
7840: }
7841: my $fh;
7842: if (!open($fh,'>'.$dest)) {
7843: &Apache::lonnet::logthis('Failed to create '.$dest);
7844: $output .= '<span class="LC_error">'.
7845: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7846: '</span><br />';
7847: } else {
7848: if (!print $fh $env{'form.embedded_item_'.$i}) {
7849: &Apache::lonnet::logthis('Failed to write to '.$dest);
7850: $output .= '<span class="LC_error">'.
7851: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7852: '</span><br />';
7853: } else {
7854: if ($context eq 'testbank') {
7855: $output .= &mt('Embedded file uploaded successfully:').
7856: ' <a href="'.$url.'">'.
7857: $orig_uploaded_filename.'</a><br />';
7858: } else {
1.705 tempelho 7859: $output .= '<span class=\"LC_fontsize_large\">'.
1.661 raeburn 7860: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
1.705 tempelho 7861: $orig_uploaded_filename.'</a>').'</span><br />';
1.661 raeburn 7862: }
7863: }
7864: close($fh);
7865: }
7866: }
7867: }
7868: return $output;
7869: }
7870:
7871: sub check_for_existing {
7872: my ($path,$fname,$element) = @_;
7873: my ($state,$msg);
7874: if (-d $path.'/'.$fname) {
7875: $state = 'exists';
7876: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7877: } elsif (-e $path.'/'.$fname) {
7878: $state = 'exists';
7879: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7880: }
7881: if ($state eq 'exists') {
7882: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7883: }
7884: return ($state,$msg);
7885: }
7886:
7887: sub check_for_upload {
7888: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7889: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7890: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7891: my $getpropath = 1;
7892: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7893: $getpropath);
7894: my $found_file = 0;
7895: my $locked_file = 0;
7896: foreach my $line (@dir_list) {
7897: my ($file_name)=split(/\&/,$line,2);
7898: if ($file_name eq $fname){
7899: $file_name = $path.$file_name;
7900: if ($group ne '') {
7901: $file_name = $group.$file_name;
7902: }
7903: $found_file = 1;
7904: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7905: $locked_file = 1;
7906: }
7907: }
7908: }
7909: if (($current_disk_usage + $filesize) > $disk_quota){
7910: my $msg = '<span class="LC_error">'.
7911: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7912: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7913: return ('will_exceed_quota',$msg);
7914: } elsif ($found_file) {
7915: if ($locked_file) {
7916: my $msg = '<span class="LC_error">';
7917: $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>');
7918: $msg .= '</span><br />';
7919: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7920: return ('file_locked',$msg);
7921: } else {
7922: my $msg = '<span class="LC_error">';
7923: $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'});
7924: $msg .= '</span>';
7925: $msg .= '<br />';
7926: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7927: return ('file_exists',$msg);
7928: }
7929: }
7930: }
7931:
1.31 albertel 7932:
1.41 ng 7933: =pod
1.45 matthew 7934:
1.464 albertel 7935: =back
1.41 ng 7936:
1.112 bowersj2 7937: =head1 CSV Upload/Handling functions
1.38 albertel 7938:
1.41 ng 7939: =over 4
7940:
1.648 raeburn 7941: =item * &upfile_store($r)
1.41 ng 7942:
7943: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7944: needs $env{'form.upfile'}
1.41 ng 7945: returns $datatoken to be put into hidden field
7946:
7947: =cut
1.31 albertel 7948:
7949: sub upfile_store {
7950: my $r=shift;
1.258 albertel 7951: $env{'form.upfile'}=~s/\r/\n/gs;
7952: $env{'form.upfile'}=~s/\f/\n/gs;
7953: $env{'form.upfile'}=~s/\n+/\n/gs;
7954: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7955:
1.258 albertel 7956: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7957: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7958: {
1.158 raeburn 7959: my $datafile = $r->dir_config('lonDaemons').
7960: '/tmp/'.$datatoken.'.tmp';
7961: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7962: print $fh $env{'form.upfile'};
1.158 raeburn 7963: close($fh);
7964: }
1.31 albertel 7965: }
7966: return $datatoken;
7967: }
7968:
1.56 matthew 7969: =pod
7970:
1.648 raeburn 7971: =item * &load_tmp_file($r)
1.41 ng 7972:
7973: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7974: needs $env{'form.datatoken'},
7975: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7976:
7977: =cut
1.31 albertel 7978:
7979: sub load_tmp_file {
7980: my $r=shift;
7981: my @studentdata=();
7982: {
1.158 raeburn 7983: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7984: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7985: if ( open(my $fh,"<$studentfile") ) {
7986: @studentdata=<$fh>;
7987: close($fh);
7988: }
1.31 albertel 7989: }
1.258 albertel 7990: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7991: }
7992:
1.56 matthew 7993: =pod
7994:
1.648 raeburn 7995: =item * &upfile_record_sep()
1.41 ng 7996:
7997: Separate uploaded file into records
7998: returns array of records,
1.258 albertel 7999: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 8000:
8001: =cut
1.31 albertel 8002:
8003: sub upfile_record_sep {
1.258 albertel 8004: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 8005: } else {
1.248 albertel 8006: my @records;
1.258 albertel 8007: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 8008: if ($line=~/^\s*$/) { next; }
8009: push(@records,$line);
8010: }
8011: return @records;
1.31 albertel 8012: }
8013: }
8014:
1.56 matthew 8015: =pod
8016:
1.648 raeburn 8017: =item * &record_sep($record)
1.41 ng 8018:
1.258 albertel 8019: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 8020:
8021: =cut
8022:
1.263 www 8023: sub takeleft {
8024: my $index=shift;
8025: return substr('0000'.$index,-4,4);
8026: }
8027:
1.31 albertel 8028: sub record_sep {
8029: my $record=shift;
8030: my %components=();
1.258 albertel 8031: if ($env{'form.upfiletype'} eq 'xml') {
8032: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 8033: my $i=0;
1.356 albertel 8034: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 8035: $field=~s/^(\"|\')//;
8036: $field=~s/(\"|\')$//;
1.263 www 8037: $components{&takeleft($i)}=$field;
1.31 albertel 8038: $i++;
8039: }
1.258 albertel 8040: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 8041: my $i=0;
1.356 albertel 8042: foreach my $field (split(/\t/,$record)) {
1.31 albertel 8043: $field=~s/^(\"|\')//;
8044: $field=~s/(\"|\')$//;
1.263 www 8045: $components{&takeleft($i)}=$field;
1.31 albertel 8046: $i++;
8047: }
8048: } else {
1.561 www 8049: my $separator=',';
1.480 banghart 8050: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 8051: $separator=';';
1.480 banghart 8052: }
1.31 albertel 8053: my $i=0;
1.561 www 8054: # the character we are looking for to indicate the end of a quote or a record
8055: my $looking_for=$separator;
8056: # do not add the characters to the fields
8057: my $ignore=0;
8058: # we just encountered a separator (or the beginning of the record)
8059: my $just_found_separator=1;
8060: # store the field we are working on here
8061: my $field='';
8062: # work our way through all characters in record
8063: foreach my $character ($record=~/(.)/g) {
8064: if ($character eq $looking_for) {
8065: if ($character ne $separator) {
8066: # Found the end of a quote, again looking for separator
8067: $looking_for=$separator;
8068: $ignore=1;
8069: } else {
8070: # Found a separator, store away what we got
8071: $components{&takeleft($i)}=$field;
8072: $i++;
8073: $just_found_separator=1;
8074: $ignore=0;
8075: $field='';
8076: }
8077: next;
8078: }
8079: # single or double quotation marks after a separator indicate beginning of a quote
8080: # we are now looking for the end of the quote and need to ignore separators
8081: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
8082: $looking_for=$character;
8083: next;
8084: }
8085: # ignore would be true after we reached the end of a quote
8086: if ($ignore) { next; }
8087: if (($just_found_separator) && ($character=~/\s/)) { next; }
8088: $field.=$character;
8089: $just_found_separator=0;
1.31 albertel 8090: }
1.561 www 8091: # catch the very last entry, since we never encountered the separator
8092: $components{&takeleft($i)}=$field;
1.31 albertel 8093: }
8094: return %components;
8095: }
8096:
1.144 matthew 8097: ######################################################
8098: ######################################################
8099:
1.56 matthew 8100: =pod
8101:
1.648 raeburn 8102: =item * &upfile_select_html()
1.41 ng 8103:
1.144 matthew 8104: Return HTML code to select a file from the users machine and specify
8105: the file type.
1.41 ng 8106:
8107: =cut
8108:
1.144 matthew 8109: ######################################################
8110: ######################################################
1.31 albertel 8111: sub upfile_select_html {
1.144 matthew 8112: my %Types = (
8113: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 8114: semisv => &mt('Semicolon separated values'),
1.144 matthew 8115: space => &mt('Space separated'),
8116: tab => &mt('Tabulator separated'),
8117: # xml => &mt('HTML/XML'),
8118: );
8119: my $Str = '<input type="file" name="upfile" size="50" />'.
1.727 riegler 8120: '<br />'.&mt('Type').': <select name="upfiletype">';
1.144 matthew 8121: foreach my $type (sort(keys(%Types))) {
8122: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
8123: }
8124: $Str .= "</select>\n";
8125: return $Str;
1.31 albertel 8126: }
8127:
1.301 albertel 8128: sub get_samples {
8129: my ($records,$toget) = @_;
8130: my @samples=({});
8131: my $got=0;
8132: foreach my $rec (@$records) {
8133: my %temp = &record_sep($rec);
8134: if (! grep(/\S/, values(%temp))) { next; }
8135: if (%temp) {
8136: $samples[$got]=\%temp;
8137: $got++;
8138: if ($got == $toget) { last; }
8139: }
8140: }
8141: return \@samples;
8142: }
8143:
1.144 matthew 8144: ######################################################
8145: ######################################################
8146:
1.56 matthew 8147: =pod
8148:
1.648 raeburn 8149: =item * &csv_print_samples($r,$records)
1.41 ng 8150:
8151: Prints a table of sample values from each column uploaded $r is an
8152: Apache Request ref, $records is an arrayref from
8153: &Apache::loncommon::upfile_record_sep
8154:
8155: =cut
8156:
1.144 matthew 8157: ######################################################
8158: ######################################################
1.31 albertel 8159: sub csv_print_samples {
8160: my ($r,$records) = @_;
1.662 bisitz 8161: my $samples = &get_samples($records,5);
1.301 albertel 8162:
1.594 raeburn 8163: $r->print(&mt('Samples').'<br />'.&start_data_table().
8164: &start_data_table_header_row());
1.356 albertel 8165: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8166: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 8167: $r->print(&end_data_table_header_row());
1.301 albertel 8168: foreach my $hash (@$samples) {
1.594 raeburn 8169: $r->print(&start_data_table_row());
1.356 albertel 8170: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 8171: $r->print('<td>');
1.356 albertel 8172: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 8173: $r->print('</td>');
8174: }
1.594 raeburn 8175: $r->print(&end_data_table_row());
1.31 albertel 8176: }
1.594 raeburn 8177: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 8178: }
8179:
1.144 matthew 8180: ######################################################
8181: ######################################################
8182:
1.56 matthew 8183: =pod
8184:
1.648 raeburn 8185: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 8186:
8187: Prints a table to create associations between values and table columns.
1.144 matthew 8188:
1.41 ng 8189: $r is an Apache Request ref,
8190: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 8191: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 8192:
8193: =cut
8194:
1.144 matthew 8195: ######################################################
8196: ######################################################
1.31 albertel 8197: sub csv_print_select_table {
8198: my ($r,$records,$d) = @_;
1.301 albertel 8199: my $i=0;
8200: my $samples = &get_samples($records,1);
1.144 matthew 8201: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 8202: &start_data_table().&start_data_table_header_row().
1.144 matthew 8203: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 8204: '<th>'.&mt('Column').'</th>'.
8205: &end_data_table_header_row()."\n");
1.356 albertel 8206: foreach my $array_ref (@$d) {
8207: my ($value,$display,$defaultcol)=@{ $array_ref };
1.729 raeburn 8208: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 8209:
8210: $r->print('<td><select name=f'.$i.
1.32 matthew 8211: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 8212: $r->print('<option value="none"></option>');
1.356 albertel 8213: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
8214: $r->print('<option value="'.$sample.'"'.
8215: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 8216: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 8217: }
1.594 raeburn 8218: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 8219: $i++;
8220: }
1.594 raeburn 8221: $r->print(&end_data_table());
1.31 albertel 8222: $i--;
8223: return $i;
8224: }
1.56 matthew 8225:
1.144 matthew 8226: ######################################################
8227: ######################################################
8228:
1.56 matthew 8229: =pod
1.31 albertel 8230:
1.648 raeburn 8231: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 8232:
8233: Prints a table of sample values from the upload and can make associate samples to internal names.
8234:
8235: $r is an Apache Request ref,
8236: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
8237: $d is an array of 2 element arrays (internal name, displayed name)
8238:
8239: =cut
8240:
1.144 matthew 8241: ######################################################
8242: ######################################################
1.31 albertel 8243: sub csv_samples_select_table {
8244: my ($r,$records,$d) = @_;
8245: my $i=0;
1.144 matthew 8246: #
1.662 bisitz 8247: my $max_samples = 5;
8248: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 8249: $r->print(&start_data_table().
8250: &start_data_table_header_row().'<th>'.
8251: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
8252: &end_data_table_header_row());
1.301 albertel 8253:
8254: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 8255: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 8256: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 8257: foreach my $option (@$d) {
8258: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 8259: $r->print('<option value="'.$value.'"'.
1.253 albertel 8260: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 8261: $display.'</option>');
1.31 albertel 8262: }
8263: $r->print('</select></td><td>');
1.662 bisitz 8264: foreach my $line (0..($max_samples-1)) {
1.301 albertel 8265: if (defined($samples->[$line]{$key})) {
8266: $r->print($samples->[$line]{$key}."<br />\n");
8267: }
8268: }
1.594 raeburn 8269: $r->print('</td>'.&end_data_table_row());
1.31 albertel 8270: $i++;
8271: }
1.594 raeburn 8272: $r->print(&end_data_table());
1.31 albertel 8273: $i--;
8274: return($i);
1.115 matthew 8275: }
8276:
1.144 matthew 8277: ######################################################
8278: ######################################################
8279:
1.115 matthew 8280: =pod
8281:
1.648 raeburn 8282: =item * &clean_excel_name($name)
1.115 matthew 8283:
8284: Returns a replacement for $name which does not contain any illegal characters.
8285:
8286: =cut
8287:
1.144 matthew 8288: ######################################################
8289: ######################################################
1.115 matthew 8290: sub clean_excel_name {
8291: my ($name) = @_;
8292: $name =~ s/[:\*\?\/\\]//g;
8293: if (length($name) > 31) {
8294: $name = substr($name,0,31);
8295: }
8296: return $name;
1.25 albertel 8297: }
1.84 albertel 8298:
1.85 albertel 8299: =pod
8300:
1.648 raeburn 8301: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 8302:
8303: Returns either 1 or undef
8304:
8305: 1 if the part is to be hidden, undef if it is to be shown
8306:
8307: Arguments are:
8308:
8309: $id the id of the part to be checked
8310: $symb, optional the symb of the resource to check
8311: $udom, optional the domain of the user to check for
8312: $uname, optional the username of the user to check for
8313:
8314: =cut
1.84 albertel 8315:
8316: sub check_if_partid_hidden {
8317: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 8318: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 8319: $symb,$udom,$uname);
1.141 albertel 8320: my $truth=1;
8321: #if the string starts with !, then the list is the list to show not hide
8322: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 8323: my @hiddenlist=split(/,/,$hiddenparts);
8324: foreach my $checkid (@hiddenlist) {
1.141 albertel 8325: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 8326: }
1.141 albertel 8327: return !$truth;
1.84 albertel 8328: }
1.127 matthew 8329:
1.138 matthew 8330:
8331: ############################################################
8332: ############################################################
8333:
8334: =pod
8335:
1.157 matthew 8336: =back
8337:
1.138 matthew 8338: =head1 cgi-bin script and graphing routines
8339:
1.157 matthew 8340: =over 4
8341:
1.648 raeburn 8342: =item * &get_cgi_id()
1.138 matthew 8343:
8344: Inputs: none
8345:
8346: Returns an id which can be used to pass environment variables
8347: to various cgi-bin scripts. These environment variables will
8348: be removed from the users environment after a given time by
8349: the routine &Apache::lonnet::transfer_profile_to_env.
8350:
8351: =cut
8352:
8353: ############################################################
8354: ############################################################
1.152 albertel 8355: my $uniq=0;
1.136 matthew 8356: sub get_cgi_id {
1.154 albertel 8357: $uniq=($uniq+1)%100000;
1.280 albertel 8358: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 8359: }
8360:
1.127 matthew 8361: ############################################################
8362: ############################################################
8363:
8364: =pod
8365:
1.648 raeburn 8366: =item * &DrawBarGraph()
1.127 matthew 8367:
1.138 matthew 8368: Facilitates the plotting of data in a (stacked) bar graph.
8369: Puts plot definition data into the users environment in order for
8370: graph.png to plot it. Returns an <img> tag for the plot.
8371: The bars on the plot are labeled '1','2',...,'n'.
8372:
8373: Inputs:
8374:
8375: =over 4
8376:
8377: =item $Title: string, the title of the plot
8378:
8379: =item $xlabel: string, text describing the X-axis of the plot
8380:
8381: =item $ylabel: string, text describing the Y-axis of the plot
8382:
8383: =item $Max: scalar, the maximum Y value to use in the plot
8384: If $Max is < any data point, the graph will not be rendered.
8385:
1.140 matthew 8386: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 8387: they are plotted. If undefined, default values will be used.
8388:
1.178 matthew 8389: =item $labels: array ref holding the labels to use on the x-axis for the bars.
8390:
1.138 matthew 8391: =item @Values: An array of array references. Each array reference holds data
8392: to be plotted in a stacked bar chart.
8393:
1.239 matthew 8394: =item If the final element of @Values is a hash reference the key/value
8395: pairs will be added to the graph definition.
8396:
1.138 matthew 8397: =back
8398:
8399: Returns:
8400:
8401: An <img> tag which references graph.png and the appropriate identifying
8402: information for the plot.
8403:
1.127 matthew 8404: =cut
8405:
8406: ############################################################
8407: ############################################################
1.134 matthew 8408: sub DrawBarGraph {
1.178 matthew 8409: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 8410: #
8411: if (! defined($colors)) {
8412: $colors = ['#33ff00',
8413: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
8414: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
8415: ];
8416: }
1.228 matthew 8417: my $extra_settings = {};
8418: if (ref($Values[-1]) eq 'HASH') {
8419: $extra_settings = pop(@Values);
8420: }
1.127 matthew 8421: #
1.136 matthew 8422: my $identifier = &get_cgi_id();
8423: my $id = 'cgi.'.$identifier;
1.129 matthew 8424: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 8425: return '';
8426: }
1.225 matthew 8427: #
8428: my @Labels;
8429: if (defined($labels)) {
8430: @Labels = @$labels;
8431: } else {
8432: for (my $i=0;$i<@{$Values[0]};$i++) {
8433: push (@Labels,$i+1);
8434: }
8435: }
8436: #
1.129 matthew 8437: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 8438: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 8439: my %ValuesHash;
8440: my $NumSets=1;
8441: foreach my $array (@Values) {
8442: next if (! ref($array));
1.136 matthew 8443: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 8444: join(',',@$array);
1.129 matthew 8445: }
1.127 matthew 8446: #
1.136 matthew 8447: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 8448: if ($NumBars < 3) {
8449: $width = 120+$NumBars*32;
1.220 matthew 8450: $xskip = 1;
1.225 matthew 8451: $bar_width = 30;
8452: } elsif ($NumBars < 5) {
8453: $width = 120+$NumBars*20;
8454: $xskip = 1;
8455: $bar_width = 20;
1.220 matthew 8456: } elsif ($NumBars < 10) {
1.136 matthew 8457: $width = 120+$NumBars*15;
8458: $xskip = 1;
8459: $bar_width = 15;
8460: } elsif ($NumBars <= 25) {
8461: $width = 120+$NumBars*11;
8462: $xskip = 5;
8463: $bar_width = 8;
8464: } elsif ($NumBars <= 50) {
8465: $width = 120+$NumBars*8;
8466: $xskip = 5;
8467: $bar_width = 4;
8468: } else {
8469: $width = 120+$NumBars*8;
8470: $xskip = 5;
8471: $bar_width = 4;
8472: }
8473: #
1.137 matthew 8474: $Max = 1 if ($Max < 1);
8475: if ( int($Max) < $Max ) {
8476: $Max++;
8477: $Max = int($Max);
8478: }
1.127 matthew 8479: $Title = '' if (! defined($Title));
8480: $xlabel = '' if (! defined($xlabel));
8481: $ylabel = '' if (! defined($ylabel));
1.369 www 8482: $ValuesHash{$id.'.title'} = &escape($Title);
8483: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
8484: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 8485: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 8486: $ValuesHash{$id.'.NumBars'} = $NumBars;
8487: $ValuesHash{$id.'.NumSets'} = $NumSets;
8488: $ValuesHash{$id.'.PlotType'} = 'bar';
8489: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8490: $ValuesHash{$id.'.height'} = $height;
8491: $ValuesHash{$id.'.width'} = $width;
8492: $ValuesHash{$id.'.xskip'} = $xskip;
8493: $ValuesHash{$id.'.bar_width'} = $bar_width;
8494: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 8495: #
1.228 matthew 8496: # Deal with other parameters
8497: while (my ($key,$value) = each(%$extra_settings)) {
8498: $ValuesHash{$id.'.'.$key} = $value;
8499: }
8500: #
1.646 raeburn 8501: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 8502: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8503: }
8504:
8505: ############################################################
8506: ############################################################
8507:
8508: =pod
8509:
1.648 raeburn 8510: =item * &DrawXYGraph()
1.137 matthew 8511:
1.138 matthew 8512: Facilitates the plotting of data in an XY graph.
8513: Puts plot definition data into the users environment in order for
8514: graph.png to plot it. Returns an <img> tag for the plot.
8515:
8516: Inputs:
8517:
8518: =over 4
8519:
8520: =item $Title: string, the title of the plot
8521:
8522: =item $xlabel: string, text describing the X-axis of the plot
8523:
8524: =item $ylabel: string, text describing the Y-axis of the plot
8525:
8526: =item $Max: scalar, the maximum Y value to use in the plot
8527: If $Max is < any data point, the graph will not be rendered.
8528:
8529: =item $colors: Array ref containing the hex color codes for the data to be
8530: plotted in. If undefined, default values will be used.
8531:
8532: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8533:
8534: =item $Ydata: Array ref containing Array refs.
1.185 www 8535: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8536:
8537: =item %Values: hash indicating or overriding any default values which are
8538: passed to graph.png.
8539: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8540:
8541: =back
8542:
8543: Returns:
8544:
8545: An <img> tag which references graph.png and the appropriate identifying
8546: information for the plot.
8547:
1.137 matthew 8548: =cut
8549:
8550: ############################################################
8551: ############################################################
8552: sub DrawXYGraph {
8553: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8554: #
8555: # Create the identifier for the graph
8556: my $identifier = &get_cgi_id();
8557: my $id = 'cgi.'.$identifier;
8558: #
8559: $Title = '' if (! defined($Title));
8560: $xlabel = '' if (! defined($xlabel));
8561: $ylabel = '' if (! defined($ylabel));
8562: my %ValuesHash =
8563: (
1.369 www 8564: $id.'.title' => &escape($Title),
8565: $id.'.xlabel' => &escape($xlabel),
8566: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8567: $id.'.y_max_value'=> $Max,
8568: $id.'.labels' => join(',',@$Xlabels),
8569: $id.'.PlotType' => 'XY',
8570: );
8571: #
8572: if (defined($colors) && ref($colors) eq 'ARRAY') {
8573: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8574: }
8575: #
8576: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8577: return '';
8578: }
8579: my $NumSets=1;
1.138 matthew 8580: foreach my $array (@{$Ydata}){
1.137 matthew 8581: next if (! ref($array));
8582: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8583: }
1.138 matthew 8584: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8585: #
8586: # Deal with other parameters
8587: while (my ($key,$value) = each(%Values)) {
8588: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8589: }
8590: #
1.646 raeburn 8591: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8592: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8593: }
8594:
8595: ############################################################
8596: ############################################################
8597:
8598: =pod
8599:
1.648 raeburn 8600: =item * &DrawXYYGraph()
1.138 matthew 8601:
8602: Facilitates the plotting of data in an XY graph with two Y axes.
8603: Puts plot definition data into the users environment in order for
8604: graph.png to plot it. Returns an <img> tag for the plot.
8605:
8606: Inputs:
8607:
8608: =over 4
8609:
8610: =item $Title: string, the title of the plot
8611:
8612: =item $xlabel: string, text describing the X-axis of the plot
8613:
8614: =item $ylabel: string, text describing the Y-axis of the plot
8615:
8616: =item $colors: Array ref containing the hex color codes for the data to be
8617: plotted in. If undefined, default values will be used.
8618:
8619: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8620:
8621: =item $Ydata1: The first data set
8622:
8623: =item $Min1: The minimum value of the left Y-axis
8624:
8625: =item $Max1: The maximum value of the left Y-axis
8626:
8627: =item $Ydata2: The second data set
8628:
8629: =item $Min2: The minimum value of the right Y-axis
8630:
8631: =item $Max2: The maximum value of the left Y-axis
8632:
8633: =item %Values: hash indicating or overriding any default values which are
8634: passed to graph.png.
8635: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8636:
8637: =back
8638:
8639: Returns:
8640:
8641: An <img> tag which references graph.png and the appropriate identifying
8642: information for the plot.
1.136 matthew 8643:
8644: =cut
8645:
8646: ############################################################
8647: ############################################################
1.137 matthew 8648: sub DrawXYYGraph {
8649: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8650: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8651: #
8652: # Create the identifier for the graph
8653: my $identifier = &get_cgi_id();
8654: my $id = 'cgi.'.$identifier;
8655: #
8656: $Title = '' if (! defined($Title));
8657: $xlabel = '' if (! defined($xlabel));
8658: $ylabel = '' if (! defined($ylabel));
8659: my %ValuesHash =
8660: (
1.369 www 8661: $id.'.title' => &escape($Title),
8662: $id.'.xlabel' => &escape($xlabel),
8663: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8664: $id.'.labels' => join(',',@$Xlabels),
8665: $id.'.PlotType' => 'XY',
8666: $id.'.NumSets' => 2,
1.137 matthew 8667: $id.'.two_axes' => 1,
8668: $id.'.y1_max_value' => $Max1,
8669: $id.'.y1_min_value' => $Min1,
8670: $id.'.y2_max_value' => $Max2,
8671: $id.'.y2_min_value' => $Min2,
1.136 matthew 8672: );
8673: #
1.137 matthew 8674: if (defined($colors) && ref($colors) eq 'ARRAY') {
8675: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8676: }
8677: #
8678: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8679: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8680: return '';
8681: }
8682: my $NumSets=1;
1.137 matthew 8683: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8684: next if (! ref($array));
8685: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8686: }
8687: #
8688: # Deal with other parameters
8689: while (my ($key,$value) = each(%Values)) {
8690: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8691: }
8692: #
1.646 raeburn 8693: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8694: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8695: }
8696:
8697: ############################################################
8698: ############################################################
8699:
8700: =pod
8701:
1.157 matthew 8702: =back
8703:
1.139 matthew 8704: =head1 Statistics helper routines?
8705:
8706: Bad place for them but what the hell.
8707:
1.157 matthew 8708: =over 4
8709:
1.648 raeburn 8710: =item * &chartlink()
1.139 matthew 8711:
8712: Returns a link to the chart for a specific student.
8713:
8714: Inputs:
8715:
8716: =over 4
8717:
8718: =item $linktext: The text of the link
8719:
8720: =item $sname: The students username
8721:
8722: =item $sdomain: The students domain
8723:
8724: =back
8725:
1.157 matthew 8726: =back
8727:
1.139 matthew 8728: =cut
8729:
8730: ############################################################
8731: ############################################################
8732: sub chartlink {
8733: my ($linktext, $sname, $sdomain) = @_;
8734: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8735: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8736: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8737: '">'.$linktext.'</a>';
1.153 matthew 8738: }
8739:
8740: #######################################################
8741: #######################################################
8742:
8743: =pod
8744:
8745: =head1 Course Environment Routines
1.157 matthew 8746:
8747: =over 4
1.153 matthew 8748:
1.648 raeburn 8749: =item * &restore_course_settings()
1.153 matthew 8750:
1.648 raeburn 8751: =item * &store_course_settings()
1.153 matthew 8752:
8753: Restores/Store indicated form parameters from the course environment.
8754: Will not overwrite existing values of the form parameters.
8755:
8756: Inputs:
8757: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8758:
8759: a hash ref describing the data to be stored. For example:
8760:
8761: %Save_Parameters = ('Status' => 'scalar',
8762: 'chartoutputmode' => 'scalar',
8763: 'chartoutputdata' => 'scalar',
8764: 'Section' => 'array',
1.373 raeburn 8765: 'Group' => 'array',
1.153 matthew 8766: 'StudentData' => 'array',
8767: 'Maps' => 'array');
8768:
8769: Returns: both routines return nothing
8770:
1.631 raeburn 8771: =back
8772:
1.153 matthew 8773: =cut
8774:
8775: #######################################################
8776: #######################################################
8777: sub store_course_settings {
1.496 albertel 8778: return &store_settings($env{'request.course.id'},@_);
8779: }
8780:
8781: sub store_settings {
1.153 matthew 8782: # save to the environment
8783: # appenv the same items, just to be safe
1.300 albertel 8784: my $udom = $env{'user.domain'};
8785: my $uname = $env{'user.name'};
1.496 albertel 8786: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8787: my %SaveHash;
8788: my %AppHash;
8789: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8790: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8791: my $envname = 'environment.'.$basename;
1.258 albertel 8792: if (exists($env{'form.'.$setting})) {
1.153 matthew 8793: # Save this value away
8794: if ($type eq 'scalar' &&
1.258 albertel 8795: (! exists($env{$envname}) ||
8796: $env{$envname} ne $env{'form.'.$setting})) {
8797: $SaveHash{$basename} = $env{'form.'.$setting};
8798: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8799: } elsif ($type eq 'array') {
8800: my $stored_form;
1.258 albertel 8801: if (ref($env{'form.'.$setting})) {
1.153 matthew 8802: $stored_form = join(',',
8803: map {
1.369 www 8804: &escape($_);
1.258 albertel 8805: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8806: } else {
8807: $stored_form =
1.369 www 8808: &escape($env{'form.'.$setting});
1.153 matthew 8809: }
8810: # Determine if the array contents are the same.
1.258 albertel 8811: if ($stored_form ne $env{$envname}) {
1.153 matthew 8812: $SaveHash{$basename} = $stored_form;
8813: $AppHash{$envname} = $stored_form;
8814: }
8815: }
8816: }
8817: }
8818: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8819: $udom,$uname);
1.153 matthew 8820: if ($put_result !~ /^(ok|delayed)/) {
8821: &Apache::lonnet::logthis('unable to save form parameters, '.
8822: 'got error:'.$put_result);
8823: }
8824: # Make sure these settings stick around in this session, too
1.646 raeburn 8825: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8826: return;
8827: }
8828:
8829: sub restore_course_settings {
1.499 albertel 8830: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8831: }
8832:
8833: sub restore_settings {
8834: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8835: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8836: next if (exists($env{'form.'.$setting}));
1.496 albertel 8837: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8838: '.'.$setting;
1.258 albertel 8839: if (exists($env{$envname})) {
1.153 matthew 8840: if ($type eq 'scalar') {
1.258 albertel 8841: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8842: } elsif ($type eq 'array') {
1.258 albertel 8843: $env{'form.'.$setting} = [
1.153 matthew 8844: map {
1.369 www 8845: &unescape($_);
1.258 albertel 8846: } split(',',$env{$envname})
1.153 matthew 8847: ];
8848: }
8849: }
8850: }
1.127 matthew 8851: }
8852:
1.618 raeburn 8853: #######################################################
8854: #######################################################
8855:
8856: =pod
8857:
8858: =head1 Domain E-mail Routines
8859:
8860: =over 4
8861:
1.648 raeburn 8862: =item * &build_recipient_list()
1.618 raeburn 8863:
1.766 raeburn 8864: Build recipient lists for four types of e-mail:
8865: (a) Error Reports, (b) Package Updates, (c) lonstatus warnings/errors
8866: (d) Help requests, generated by
8867: lonerrorhandler.pm, CHECKRPMS, loncron, and lonsupportreq.pm respectively.
1.618 raeburn 8868:
8869: Inputs:
1.619 raeburn 8870: defmail (scalar - email address of default recipient),
1.618 raeburn 8871: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8872: defdom (domain for which to retrieve configuration settings),
8873: origmail (scalar - email address of recipient from loncapa.conf,
8874: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8875:
1.655 raeburn 8876: Returns: comma separated list of addresses to which to send e-mail.
8877:
8878: =back
1.618 raeburn 8879:
8880: =cut
8881:
8882: ############################################################
8883: ############################################################
8884: sub build_recipient_list {
1.619 raeburn 8885: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8886: my @recipients;
8887: my $otheremails;
8888: my %domconfig =
8889: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8890: if (ref($domconfig{'contacts'}) eq 'HASH') {
1.766 raeburn 8891: if (exists($domconfig{'contacts'}{$mailing})) {
8892: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8893: my @contacts = ('adminemail','supportemail');
8894: foreach my $item (@contacts) {
8895: if ($domconfig{'contacts'}{$mailing}{$item}) {
8896: my $addr = $domconfig{'contacts'}{$item};
8897: if (!grep(/^\Q$addr\E$/,@recipients)) {
8898: push(@recipients,$addr);
8899: }
1.619 raeburn 8900: }
1.766 raeburn 8901: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
1.618 raeburn 8902: }
8903: }
1.766 raeburn 8904: } elsif ($origmail ne '') {
8905: push(@recipients,$origmail);
1.618 raeburn 8906: }
1.619 raeburn 8907: } elsif ($origmail ne '') {
8908: push(@recipients,$origmail);
1.618 raeburn 8909: }
1.688 raeburn 8910: if (defined($defmail)) {
8911: if ($defmail ne '') {
8912: push(@recipients,$defmail);
8913: }
1.618 raeburn 8914: }
8915: if ($otheremails) {
1.619 raeburn 8916: my @others;
8917: if ($otheremails =~ /,/) {
8918: @others = split(/,/,$otheremails);
1.618 raeburn 8919: } else {
1.619 raeburn 8920: push(@others,$otheremails);
8921: }
8922: foreach my $addr (@others) {
8923: if (!grep(/^\Q$addr\E$/,@recipients)) {
8924: push(@recipients,$addr);
8925: }
1.618 raeburn 8926: }
8927: }
1.619 raeburn 8928: my $recipientlist = join(',',@recipients);
1.618 raeburn 8929: return $recipientlist;
8930: }
8931:
1.127 matthew 8932: ############################################################
8933: ############################################################
1.154 albertel 8934:
1.655 raeburn 8935: =pod
8936:
8937: =head1 Course Catalog Routines
8938:
8939: =over 4
8940:
8941: =item * &gather_categories()
8942:
8943: Converts category definitions - keys of categories hash stored in
8944: coursecategories in configuration.db on the primary library server in a
8945: domain - to an array. Also generates javascript and idx hash used to
8946: generate Domain Coordinator interface for editing Course Categories.
8947:
8948: Inputs:
1.663 raeburn 8949:
1.655 raeburn 8950: categories (reference to hash of category definitions).
1.663 raeburn 8951:
1.655 raeburn 8952: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8953: categories and subcategories).
1.663 raeburn 8954:
1.655 raeburn 8955: idx (reference to hash of counters used in Domain Coordinator interface for
8956: editing Course Categories).
1.663 raeburn 8957:
1.655 raeburn 8958: jsarray (reference to array of categories used to create Javascript arrays for
8959: Domain Coordinator interface for editing Course Categories).
8960:
8961: Returns: nothing
8962:
8963: Side effects: populates cats, idx and jsarray.
8964:
8965: =cut
8966:
8967: sub gather_categories {
8968: my ($categories,$cats,$idx,$jsarray) = @_;
8969: my %counters;
8970: my $num = 0;
8971: foreach my $item (keys(%{$categories})) {
8972: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8973: if ($container eq '' && $depth == 0) {
8974: $cats->[$depth][$categories->{$item}] = $cat;
8975: } else {
8976: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8977: }
8978: my ($escitem,$tail) = split(/:/,$item,2);
8979: if ($counters{$tail} eq '') {
8980: $counters{$tail} = $num;
8981: $num ++;
8982: }
8983: if (ref($idx) eq 'HASH') {
8984: $idx->{$item} = $counters{$tail};
8985: }
8986: if (ref($jsarray) eq 'ARRAY') {
8987: push(@{$jsarray->[$counters{$tail}]},$item);
8988: }
8989: }
8990: return;
8991: }
8992:
8993: =pod
8994:
8995: =item * &extract_categories()
8996:
8997: Used to generate breadcrumb trails for course categories.
8998:
8999: Inputs:
1.663 raeburn 9000:
1.655 raeburn 9001: categories (reference to hash of category definitions).
1.663 raeburn 9002:
1.655 raeburn 9003: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9004: categories and subcategories).
1.663 raeburn 9005:
1.655 raeburn 9006: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 9007:
1.655 raeburn 9008: allitems (reference to hash - key is category key
9009: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9010:
1.655 raeburn 9011: idx (reference to hash of counters used in Domain Coordinator interface for
9012: editing Course Categories).
1.663 raeburn 9013:
1.655 raeburn 9014: jsarray (reference to array of categories used to create Javascript arrays for
9015: Domain Coordinator interface for editing Course Categories).
9016:
1.665 raeburn 9017: subcats (reference to hash of arrays containing all subcategories within each
9018: category, -recursive)
9019:
1.655 raeburn 9020: Returns: nothing
9021:
9022: Side effects: populates trails and allitems hash references.
9023:
9024: =cut
9025:
9026: sub extract_categories {
1.665 raeburn 9027: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 9028: if (ref($categories) eq 'HASH') {
9029: &gather_categories($categories,$cats,$idx,$jsarray);
9030: if (ref($cats->[0]) eq 'ARRAY') {
9031: for (my $i=0; $i<@{$cats->[0]}; $i++) {
9032: my $name = $cats->[0][$i];
9033: my $item = &escape($name).'::0';
9034: my $trailstr;
9035: if ($name eq 'instcode') {
9036: $trailstr = &mt('Official courses (with institutional codes)');
9037: } else {
9038: $trailstr = $name;
9039: }
9040: if ($allitems->{$item} eq '') {
9041: push(@{$trails},$trailstr);
9042: $allitems->{$item} = scalar(@{$trails})-1;
9043: }
9044: my @parents = ($name);
9045: if (ref($cats->[1]{$name}) eq 'ARRAY') {
9046: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
9047: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 9048: if (ref($subcats) eq 'HASH') {
9049: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
9050: }
9051: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
9052: }
9053: } else {
9054: if (ref($subcats) eq 'HASH') {
9055: $subcats->{$item} = [];
1.655 raeburn 9056: }
9057: }
9058: }
9059: }
9060: }
9061: return;
9062: }
9063:
9064: =pod
9065:
9066: =item *&recurse_categories()
9067:
9068: Recursively used to generate breadcrumb trails for course categories.
9069:
9070: Inputs:
1.663 raeburn 9071:
1.655 raeburn 9072: cats (reference to array of arrays/hashes which encapsulates hierarchy of
9073: categories and subcategories).
1.663 raeburn 9074:
1.655 raeburn 9075: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 9076:
9077: category (current course category, for which breadcrumb trail is being generated).
9078:
9079: trails (reference to array of breadcrumb trails for each category).
9080:
1.655 raeburn 9081: allitems (reference to hash - key is category key
9082: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 9083:
1.655 raeburn 9084: parents (array containing containers directories for current category,
9085: back to top level).
9086:
9087: Returns: nothing
9088:
9089: Side effects: populates trails and allitems hash references
9090:
9091: =cut
9092:
9093: sub recurse_categories {
1.665 raeburn 9094: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 9095: my $shallower = $depth - 1;
9096: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
9097: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
9098: my $name = $cats->[$depth]{$category}[$k];
9099: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9100: my $trailstr = join(' -> ',(@{$parents},$category));
9101: if ($allitems->{$item} eq '') {
9102: push(@{$trails},$trailstr);
9103: $allitems->{$item} = scalar(@{$trails})-1;
9104: }
9105: my $deeper = $depth+1;
9106: push(@{$parents},$category);
1.665 raeburn 9107: if (ref($subcats) eq 'HASH') {
9108: my $subcat = &escape($name).':'.$category.':'.$depth;
9109: for (my $j=@{$parents}; $j>=0; $j--) {
9110: my $higher;
9111: if ($j > 0) {
9112: $higher = &escape($parents->[$j]).':'.
9113: &escape($parents->[$j-1]).':'.$j;
9114: } else {
9115: $higher = &escape($parents->[$j]).'::'.$j;
9116: }
9117: push(@{$subcats->{$higher}},$subcat);
9118: }
9119: }
9120: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
9121: $subcats);
1.655 raeburn 9122: pop(@{$parents});
9123: }
9124: } else {
9125: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
9126: my $trailstr = join(' -> ',(@{$parents},$category));
9127: if ($allitems->{$item} eq '') {
9128: push(@{$trails},$trailstr);
9129: $allitems->{$item} = scalar(@{$trails})-1;
9130: }
9131: }
9132: return;
9133: }
9134:
1.663 raeburn 9135: =pod
9136:
9137: =item *&assign_categories_table()
9138:
9139: Create a datatable for display of hierarchical categories in a domain,
9140: with checkboxes to allow a course to be categorized.
9141:
9142: Inputs:
9143:
9144: cathash - reference to hash of categories defined for the domain (from
9145: configuration.db)
9146:
9147: currcat - scalar with an & separated list of categories assigned to a course.
9148:
9149: Returns: $output (markup to be displayed)
9150:
9151: =cut
9152:
9153: sub assign_categories_table {
9154: my ($cathash,$currcat) = @_;
9155: my $output;
9156: if (ref($cathash) eq 'HASH') {
9157: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
9158: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
9159: $maxdepth = scalar(@cats);
9160: if (@cats > 0) {
9161: my $itemcount = 0;
9162: if (ref($cats[0]) eq 'ARRAY') {
9163: $output = &Apache::loncommon::start_data_table();
9164: my @currcategories;
9165: if ($currcat ne '') {
9166: @currcategories = split('&',$currcat);
9167: }
9168: for (my $i=0; $i<@{$cats[0]}; $i++) {
9169: my $parent = $cats[0][$i];
9170: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9171: next if ($parent eq 'instcode');
9172: my $item = &escape($parent).'::0';
9173: my $checked = '';
9174: if (@currcategories > 0) {
9175: if (grep(/^\Q$item\E$/,@currcategories)) {
1.772 bisitz 9176: $checked = ' checked="checked"';
1.663 raeburn 9177: }
9178: }
1.675 raeburn 9179: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
9180: '<input type="checkbox" name="usecategory" value="'.
9181: $item.'"'.$checked.' />'.$parent.'</span>'.
9182: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 9183: my $depth = 1;
9184: push(@path,$parent);
9185: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
9186: pop(@path);
9187: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
9188: $itemcount ++;
9189: }
9190: $output .= &Apache::loncommon::end_data_table();
9191: }
9192: }
9193: }
9194: return $output;
9195: }
9196:
9197: =pod
9198:
9199: =item *&assign_category_rows()
9200:
9201: Create a datatable row for display of nested categories in a domain,
9202: with checkboxes to allow a course to be categorized,called recursively.
9203:
9204: Inputs:
9205:
9206: itemcount - track row number for alternating colors
9207:
9208: cats - reference to array of arrays/hashes which encapsulates hierarchy of
9209: categories and subcategories.
9210:
9211: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
9212:
9213: parent - parent of current category item
9214:
9215: path - Array containing all categories back up through the hierarchy from the
9216: current category to the top level.
9217:
9218: currcategories - reference to array of current categories assigned to the course
9219:
9220: Returns: $output (markup to be displayed).
9221:
9222: =cut
9223:
9224: sub assign_category_rows {
9225: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
9226: my ($text,$name,$item,$chgstr);
9227: if (ref($cats) eq 'ARRAY') {
9228: my $maxdepth = scalar(@{$cats});
9229: if (ref($cats->[$depth]) eq 'HASH') {
9230: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
9231: my $numchildren = @{$cats->[$depth]{$parent}};
9232: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
9233: $text .= '<td><table class="LC_datatable">';
9234: for (my $j=0; $j<$numchildren; $j++) {
9235: $name = $cats->[$depth]{$parent}[$j];
9236: $item = &escape($name).':'.&escape($parent).':'.$depth;
9237: my $deeper = $depth+1;
9238: my $checked = '';
9239: if (ref($currcategories) eq 'ARRAY') {
9240: if (@{$currcategories} > 0) {
9241: if (grep(/^\Q$item\E$/,@{$currcategories})) {
1.772 bisitz 9242: $checked = ' checked="checked"';
1.663 raeburn 9243: }
9244: }
9245: }
1.664 raeburn 9246: $text .= '<tr><td><span class="LC_nobreak"><label>'.
9247: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 9248: $item.'"'.$checked.' />'.$name.'</label></span>'.
9249: '<input type="hidden" name="catname" value="'.$name.'" />'.
9250: '</td><td>';
1.663 raeburn 9251: if (ref($path) eq 'ARRAY') {
9252: push(@{$path},$name);
9253: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
9254: pop(@{$path});
9255: }
9256: $text .= '</td></tr>';
9257: }
9258: $text .= '</table></td>';
9259: }
9260: }
9261: }
9262: return $text;
9263: }
9264:
1.655 raeburn 9265: ############################################################
9266: ############################################################
9267:
9268:
1.443 albertel 9269: sub commit_customrole {
1.664 raeburn 9270: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 9271: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 9272: ($start?', '.&mt('starting').' '.localtime($start):'').
9273: ($end?', ending '.localtime($end):'').': <b>'.
9274: &Apache::lonnet::assigncustomrole(
1.664 raeburn 9275: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 9276: '</b><br />';
9277: return $output;
9278: }
9279:
9280: sub commit_standardrole {
1.541 raeburn 9281: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
9282: my ($output,$logmsg,$linefeed);
9283: if ($context eq 'auto') {
9284: $linefeed = "\n";
9285: } else {
9286: $linefeed = "<br />\n";
9287: }
1.443 albertel 9288: if ($three eq 'st') {
1.541 raeburn 9289: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
9290: $one,$two,$sec,$context);
9291: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 9292: ($result eq 'unknown_course') || ($result eq 'refused')) {
9293: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 9294: } else {
1.541 raeburn 9295: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 9296: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9297: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
9298: if ($context eq 'auto') {
9299: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
9300: } else {
9301: $output .= '<b>'.$result.'</b>'.$linefeed.
9302: &mt('Add to classlist').': <b>ok</b>';
9303: }
9304: $output .= $linefeed;
1.443 albertel 9305: }
9306: } else {
9307: $output = &mt('Assigning').' '.$three.' in '.$url.
9308: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 9309: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 9310: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 9311: if ($context eq 'auto') {
9312: $output .= $result.$linefeed;
9313: } else {
9314: $output .= '<b>'.$result.'</b>'.$linefeed;
9315: }
1.443 albertel 9316: }
9317: return $output;
9318: }
9319:
9320: sub commit_studentrole {
1.541 raeburn 9321: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 9322: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 9323: if ($context eq 'auto') {
9324: $linefeed = "\n";
9325: } else {
9326: $linefeed = '<br />'."\n";
9327: }
1.443 albertel 9328: if (defined($one) && defined($two)) {
9329: my $cid=$one.'_'.$two;
9330: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
9331: my $secchange = 0;
9332: my $expire_role_result;
9333: my $modify_section_result;
1.628 raeburn 9334: if ($oldsec ne '-1') {
9335: if ($oldsec ne $sec) {
1.443 albertel 9336: $secchange = 1;
1.628 raeburn 9337: my $now = time;
1.443 albertel 9338: my $uurl='/'.$cid;
9339: $uurl=~s/\_/\//g;
9340: if ($oldsec) {
9341: $uurl.='/'.$oldsec;
9342: }
1.626 raeburn 9343: $oldsecurl = $uurl;
1.628 raeburn 9344: $expire_role_result =
1.652 raeburn 9345: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 9346: if ($env{'request.course.sec'} ne '') {
9347: if ($expire_role_result eq 'refused') {
9348: my @roles = ('st');
9349: my @statuses = ('previous');
9350: my @roledoms = ($one);
9351: my $withsec = 1;
9352: my %roleshash =
9353: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
9354: \@statuses,\@roles,\@roledoms,$withsec);
9355: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
9356: my ($oldstart,$oldend) =
9357: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
9358: if ($oldend > 0 && $oldend <= $now) {
9359: $expire_role_result = 'ok';
9360: }
9361: }
9362: }
9363: }
1.443 albertel 9364: $result = $expire_role_result;
9365: }
9366: }
9367: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 9368: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 9369: if ($modify_section_result =~ /^ok/) {
9370: if ($secchange == 1) {
1.628 raeburn 9371: if ($sec eq '') {
9372: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
9373: } else {
9374: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
9375: }
1.443 albertel 9376: } elsif ($oldsec eq '-1') {
1.628 raeburn 9377: if ($sec eq '') {
9378: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
9379: } else {
9380: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9381: }
1.443 albertel 9382: } else {
1.628 raeburn 9383: if ($sec eq '') {
9384: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
9385: } else {
9386: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
9387: }
1.443 albertel 9388: }
9389: } else {
1.628 raeburn 9390: if ($secchange) {
9391: $$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;
9392: } else {
9393: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
9394: }
1.443 albertel 9395: }
9396: $result = $modify_section_result;
9397: } elsif ($secchange == 1) {
1.628 raeburn 9398: if ($oldsec eq '') {
9399: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
9400: } else {
9401: $$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;
9402: }
1.626 raeburn 9403: if ($expire_role_result eq 'refused') {
9404: my $newsecurl = '/'.$cid;
9405: $newsecurl =~ s/\_/\//g;
9406: if ($sec ne '') {
9407: $newsecurl.='/'.$sec;
9408: }
9409: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
9410: if ($sec eq '') {
9411: $$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;
9412: } else {
9413: $$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;
9414: }
9415: }
9416: }
1.443 albertel 9417: }
9418: } else {
1.626 raeburn 9419: $$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 9420: $result = "error: incomplete course id\n";
9421: }
9422: return $result;
9423: }
9424:
9425: ############################################################
9426: ############################################################
9427:
1.566 albertel 9428: sub check_clone {
1.578 raeburn 9429: my ($args,$linefeed) = @_;
1.566 albertel 9430: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
9431: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
9432: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
9433: my $clonemsg;
9434: my $can_clone = 0;
9435:
9436: if ($clonehome eq 'no_host') {
1.578 raeburn 9437: $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 9438: } else {
9439: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 9440: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 9441: $can_clone = 1;
9442: } else {
9443: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
9444: $args->{'clonedomain'},$args->{'clonecourse'});
9445: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 9446: if (grep(/^\*$/,@cloners)) {
9447: $can_clone = 1;
9448: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
9449: $can_clone = 1;
9450: } else {
9451: my %roleshash =
9452: &Apache::lonnet::get_my_roles($args->{'ccuname'},
9453: $args->{'ccdomain'},
9454: 'userroles',['active'],['cc'],
9455: [$args->{'clonedomain'}]);
9456: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
9457: $can_clone = 1;
9458: } else {
9459: $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'});
9460: }
1.566 albertel 9461: }
1.578 raeburn 9462: }
1.566 albertel 9463: }
9464: return ($can_clone, $clonemsg, $cloneid, $clonehome);
9465: }
9466:
1.444 albertel 9467: sub construct_course {
1.541 raeburn 9468: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 9469: my $outcome;
1.541 raeburn 9470: my $linefeed = '<br />'."\n";
9471: if ($context eq 'auto') {
9472: $linefeed = "\n";
9473: }
1.566 albertel 9474:
9475: #
9476: # Are we cloning?
9477: #
9478: my ($can_clone, $clonemsg, $cloneid, $clonehome);
9479: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 9480: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 9481: if ($context ne 'auto') {
1.578 raeburn 9482: if ($clonemsg ne '') {
9483: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
9484: }
1.566 albertel 9485: }
9486: $outcome .= $clonemsg.$linefeed;
9487:
9488: if (!$can_clone) {
9489: return (0,$outcome);
9490: }
9491: }
9492:
1.444 albertel 9493: #
9494: # Open course
9495: #
9496: my $crstype = lc($args->{'crstype'});
9497: my %cenv=();
9498: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
9499: $args->{'cdescr'},
9500: $args->{'curl'},
9501: $args->{'course_home'},
9502: $args->{'nonstandard'},
9503: $args->{'crscode'},
9504: $args->{'ccuname'}.':'.
9505: $args->{'ccdomain'},
9506: $args->{'crstype'});
9507:
9508: # Note: The testing routines depend on this being output; see
9509: # Utils::Course. This needs to at least be output as a comment
9510: # if anyone ever decides to not show this, and Utils::Course::new
9511: # will need to be suitably modified.
1.541 raeburn 9512: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 9513: #
9514: # Check if created correctly
9515: #
1.479 albertel 9516: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 9517: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 9518: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 9519:
1.444 albertel 9520: #
1.566 albertel 9521: # Do the cloning
9522: #
9523: if ($can_clone && $cloneid) {
9524: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9525: if ($context ne 'auto') {
9526: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9527: }
9528: $outcome .= $clonemsg.$linefeed;
9529: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9530: # Copy all files
1.637 www 9531: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9532: # Restore URL
1.566 albertel 9533: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9534: # Restore title
1.566 albertel 9535: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9536: # Mark as cloned
1.566 albertel 9537: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9538: # Need to clone grading mode
9539: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9540: $cenv{'grading'}=$newenv{'grading'};
9541: # Do not clone these environment entries
9542: &Apache::lonnet::del('environment',
9543: ['default_enrollment_start_date',
9544: 'default_enrollment_end_date',
9545: 'question.email',
9546: 'policy.email',
9547: 'comment.email',
9548: 'pch.users.denied',
1.725 raeburn 9549: 'plc.users.denied',
9550: 'hidefromcat',
9551: 'categories'],
1.638 www 9552: $$crsudom,$$crsunum);
1.444 albertel 9553: }
1.566 albertel 9554:
1.444 albertel 9555: #
9556: # Set environment (will override cloned, if existing)
9557: #
9558: my @sections = ();
9559: my @xlists = ();
9560: if ($args->{'crstype'}) {
9561: $cenv{'type'}=$args->{'crstype'};
9562: }
9563: if ($args->{'crsid'}) {
9564: $cenv{'courseid'}=$args->{'crsid'};
9565: }
9566: if ($args->{'crscode'}) {
9567: $cenv{'internal.coursecode'}=$args->{'crscode'};
9568: }
9569: if ($args->{'crsquota'} ne '') {
9570: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9571: } else {
9572: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9573: }
9574: if ($args->{'ccuname'}) {
9575: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9576: ':'.$args->{'ccdomain'};
9577: } else {
9578: $cenv{'internal.courseowner'} = $args->{'curruser'};
9579: }
9580: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9581: if ($args->{'crssections'}) {
9582: $cenv{'internal.sectionnums'} = '';
9583: if ($args->{'crssections'} =~ m/,/) {
9584: @sections = split/,/,$args->{'crssections'};
9585: } else {
9586: $sections[0] = $args->{'crssections'};
9587: }
9588: if (@sections > 0) {
9589: foreach my $item (@sections) {
9590: my ($sec,$gp) = split/:/,$item;
9591: my $class = $args->{'crscode'}.$sec;
9592: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9593: $cenv{'internal.sectionnums'} .= $item.',';
9594: unless ($addcheck eq 'ok') {
9595: push @badclasses, $class;
9596: }
9597: }
9598: $cenv{'internal.sectionnums'} =~ s/,$//;
9599: }
9600: }
9601: # do not hide course coordinator from staff listing,
9602: # even if privileged
9603: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9604: # add crosslistings
9605: if ($args->{'crsxlist'}) {
9606: $cenv{'internal.crosslistings'}='';
9607: if ($args->{'crsxlist'} =~ m/,/) {
9608: @xlists = split/,/,$args->{'crsxlist'};
9609: } else {
9610: $xlists[0] = $args->{'crsxlist'};
9611: }
9612: if (@xlists > 0) {
9613: foreach my $item (@xlists) {
9614: my ($xl,$gp) = split/:/,$item;
9615: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9616: $cenv{'internal.crosslistings'} .= $item.',';
9617: unless ($addcheck eq 'ok') {
9618: push @badclasses, $xl;
9619: }
9620: }
9621: $cenv{'internal.crosslistings'} =~ s/,$//;
9622: }
9623: }
9624: if ($args->{'autoadds'}) {
9625: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9626: }
9627: if ($args->{'autodrops'}) {
9628: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9629: }
9630: # check for notification of enrollment changes
9631: my @notified = ();
9632: if ($args->{'notify_owner'}) {
9633: if ($args->{'ccuname'} ne '') {
9634: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9635: }
9636: }
9637: if ($args->{'notify_dc'}) {
9638: if ($uname ne '') {
1.630 raeburn 9639: push(@notified,$uname.':'.$udom);
1.444 albertel 9640: }
9641: }
9642: if (@notified > 0) {
9643: my $notifylist;
9644: if (@notified > 1) {
9645: $notifylist = join(',',@notified);
9646: } else {
9647: $notifylist = $notified[0];
9648: }
9649: $cenv{'internal.notifylist'} = $notifylist;
9650: }
9651: if (@badclasses > 0) {
9652: my %lt=&Apache::lonlocal::texthash(
9653: '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',
9654: 'dnhr' => 'does not have rights to access enrollment in these classes',
9655: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9656: );
1.541 raeburn 9657: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9658: ' ('.$lt{'adby'}.')';
9659: if ($context eq 'auto') {
9660: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9661: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9662: foreach my $item (@badclasses) {
9663: if ($context eq 'auto') {
9664: $outcome .= " - $item\n";
9665: } else {
9666: $outcome .= "<li>$item</li>\n";
9667: }
9668: }
9669: if ($context eq 'auto') {
9670: $outcome .= $linefeed;
9671: } else {
1.566 albertel 9672: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9673: }
9674: }
1.444 albertel 9675: }
9676: if ($args->{'no_end_date'}) {
9677: $args->{'endaccess'} = 0;
9678: }
9679: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9680: $cenv{'internal.autoend'}=$args->{'enrollend'};
9681: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9682: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9683: if ($args->{'showphotos'}) {
9684: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9685: }
9686: $cenv{'internal.authtype'} = $args->{'authtype'};
9687: $cenv{'internal.autharg'} = $args->{'autharg'};
9688: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9689: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9690: 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');
9691: if ($context eq 'auto') {
9692: $outcome .= $krb_msg;
9693: } else {
1.566 albertel 9694: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9695: }
9696: $outcome .= $linefeed;
1.444 albertel 9697: }
9698: }
9699: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9700: if ($args->{'setpolicy'}) {
9701: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9702: }
9703: if ($args->{'setcontent'}) {
9704: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9705: }
9706: }
9707: if ($args->{'reshome'}) {
9708: $cenv{'reshome'}=$args->{'reshome'}.'/';
9709: $cenv{'reshome'}=~s/\/+$/\//;
9710: }
9711: #
9712: # course has keyed access
9713: #
9714: if ($args->{'setkeys'}) {
9715: $cenv{'keyaccess'}='yes';
9716: }
9717: # if specified, key authority is not course, but user
9718: # only active if keyaccess is yes
9719: if ($args->{'keyauth'}) {
1.487 albertel 9720: my ($user,$domain) = split(':',$args->{'keyauth'});
9721: $user = &LONCAPA::clean_username($user);
9722: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9723: if ($user ne '' && $domain ne '') {
1.487 albertel 9724: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9725: }
9726: }
9727:
9728: if ($args->{'disresdis'}) {
9729: $cenv{'pch.roles.denied'}='st';
9730: }
9731: if ($args->{'disablechat'}) {
9732: $cenv{'plc.roles.denied'}='st';
9733: }
9734:
9735: # Record we've not yet viewed the Course Initialization Helper for this
9736: # course
9737: $cenv{'course.helper.not.run'} = 1;
9738: #
9739: # Use new Randomseed
9740: #
9741: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9742: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9743: #
9744: # The encryption code and receipt prefix for this course
9745: #
9746: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9747: $cenv{'internal.encpref'}=100+int(9*rand(99));
9748: #
9749: # By default, use standard grading
9750: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9751:
1.541 raeburn 9752: $outcome .= $linefeed.&mt('Setting environment').': '.
9753: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9754: #
9755: # Open all assignments
9756: #
9757: if ($args->{'openall'}) {
9758: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9759: my %storecontent = ($storeunder => time,
9760: $storeunder.'.type' => 'date_start');
9761:
9762: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9763: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9764: }
9765: #
9766: # Set first page
9767: #
9768: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9769: || ($cloneid)) {
1.445 albertel 9770: use LONCAPA::map;
1.444 albertel 9771: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9772:
9773: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9774: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9775:
1.444 albertel 9776: $outcome .= ($fatal?$errtext:'read ok').' - ';
9777: my $title; my $url;
9778: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9779: $title=&mt('Syllabus');
1.444 albertel 9780: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9781: } else {
1.690 bisitz 9782: $title=&mt('Navigate Contents');
1.444 albertel 9783: $url='/adm/navmaps';
9784: }
1.445 albertel 9785:
9786: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9787: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9788:
9789: if ($errtext) { $fatal=2; }
1.541 raeburn 9790: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9791: }
1.566 albertel 9792:
9793: return (1,$outcome);
1.444 albertel 9794: }
9795:
9796: ############################################################
9797: ############################################################
9798:
1.378 raeburn 9799: sub course_type {
9800: my ($cid) = @_;
9801: if (!defined($cid)) {
9802: $cid = $env{'request.course.id'};
9803: }
1.404 albertel 9804: if (defined($env{'course.'.$cid.'.type'})) {
9805: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9806: } else {
9807: return 'Course';
1.377 raeburn 9808: }
9809: }
1.156 albertel 9810:
1.406 raeburn 9811: sub group_term {
9812: my $crstype = &course_type();
9813: my %names = (
9814: 'Course' => 'group',
9815: 'Group' => 'team',
9816: );
9817: return $names{$crstype};
9818: }
9819:
1.156 albertel 9820: sub icon {
9821: my ($file)=@_;
1.505 albertel 9822: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9823: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9824: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9825: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9826: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9827: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9828: $curfext.".gif") {
9829: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9830: $curfext.".gif";
9831: }
9832: }
1.249 albertel 9833: return &lonhttpdurl($iconname);
1.154 albertel 9834: }
1.84 albertel 9835:
1.575 albertel 9836: sub lonhttpdurl {
1.692 www 9837: #
9838: # Had been used for "small fry" static images on separate port 8080.
9839: # Modify here if lightweight http functionality desired again.
9840: # Currently eliminated due to increasing firewall issues.
9841: #
1.575 albertel 9842: my ($url)=@_;
1.692 www 9843: return $url;
1.215 albertel 9844: }
9845:
1.213 albertel 9846: sub connection_aborted {
9847: my ($r)=@_;
9848: $r->print(" ");$r->rflush();
9849: my $c = $r->connection;
9850: return $c->aborted();
9851: }
9852:
1.221 foxr 9853: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9854: # strings as 'strings'.
9855: sub escape_single {
1.221 foxr 9856: my ($input) = @_;
1.223 albertel 9857: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9858: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9859: return $input;
9860: }
1.223 albertel 9861:
1.222 foxr 9862: # Same as escape_single, but escape's "'s This
9863: # can be used for "strings"
9864: sub escape_double {
9865: my ($input) = @_;
9866: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9867: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9868: return $input;
9869: }
1.223 albertel 9870:
1.222 foxr 9871: # Escapes the last element of a full URL.
9872: sub escape_url {
9873: my ($url) = @_;
1.238 raeburn 9874: my @urlslices = split(/\//, $url,-1);
1.369 www 9875: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9876: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9877: }
1.462 albertel 9878:
9879: # -------------------------------------------------------- Initliaze user login
9880: sub init_user_environment {
1.463 albertel 9881: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9882: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9883:
9884: my $public=($username eq 'public' && $domain eq 'public');
9885:
9886: # See if old ID present, if so, remove
9887:
9888: my ($filename,$cookie,$userroles);
9889: my $now=time;
9890:
9891: if ($public) {
9892: my $max_public=100;
9893: my $oldest;
9894: my $oldest_time=0;
9895: for(my $next=1;$next<=$max_public;$next++) {
9896: if (-e $lonids."/publicuser_$next.id") {
9897: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9898: if ($mtime<$oldest_time || !$oldest_time) {
9899: $oldest_time=$mtime;
9900: $oldest=$next;
9901: }
9902: } else {
9903: $cookie="publicuser_$next";
9904: last;
9905: }
9906: }
9907: if (!$cookie) { $cookie="publicuser_$oldest"; }
9908: } else {
1.463 albertel 9909: # if this isn't a robot, kill any existing non-robot sessions
9910: if (!$args->{'robot'}) {
9911: opendir(DIR,$lonids);
9912: while ($filename=readdir(DIR)) {
9913: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9914: unlink($lonids.'/'.$filename);
9915: }
1.462 albertel 9916: }
1.463 albertel 9917: closedir(DIR);
1.462 albertel 9918: }
9919: # Give them a new cookie
1.463 albertel 9920: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9921: : $now.$$.int(rand(10000)));
1.463 albertel 9922: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9923:
9924: # Initialize roles
9925:
9926: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9927: }
9928: # ------------------------------------ Check browser type and MathML capability
9929:
9930: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9931: $clientunicode,$clientos) = &decode_user_agent($r);
9932:
9933: # -------------------------------------- Any accessibility options to remember?
9934: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9935: foreach my $option ('imagesuppress','appletsuppress',
9936: 'embedsuppress','fontenhance','blackwhite') {
9937: if ($form->{$option} eq 'true') {
9938: &Apache::lonnet::put('environment',{$option => 'on'},
9939: $domain,$username);
9940: } else {
9941: &Apache::lonnet::del('environment',[$option],
9942: $domain,$username);
9943: }
9944: }
9945: }
9946: # ------------------------------------------------------------- Get environment
9947:
9948: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9949: my ($tmp) = keys(%userenv);
9950: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9951: # default remote control to off
9952: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9953: } else {
9954: undef(%userenv);
9955: }
9956: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9957: $form->{'interface'}=$userenv{'interface'};
9958: }
9959: $env{'environment.remote'}=$userenv{'remote'};
9960: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9961:
9962: # --------------- Do not trust query string to be put directly into environment
9963: foreach my $option ('imagesuppress','appletsuppress',
9964: 'embedsuppress','fontenhance','blackwhite',
9965: 'interface','localpath','localres') {
9966: $form->{$option}=~s/[\n\r\=]//gs;
9967: }
9968: # --------------------------------------------------------- Write first profile
9969:
9970: {
9971: my %initial_env =
9972: ("user.name" => $username,
9973: "user.domain" => $domain,
9974: "user.home" => $authhost,
9975: "browser.type" => $clientbrowser,
9976: "browser.version" => $clientversion,
9977: "browser.mathml" => $clientmathml,
9978: "browser.unicode" => $clientunicode,
9979: "browser.os" => $clientos,
9980: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9981: "request.course.fn" => '',
9982: "request.course.uri" => '',
9983: "request.course.sec" => '',
9984: "request.role" => 'cm',
9985: "request.role.adv" => $env{'user.adv'},
9986: "request.host" => $ENV{'REMOTE_ADDR'},);
9987:
9988: if ($form->{'localpath'}) {
9989: $initial_env{"browser.localpath"} = $form->{'localpath'};
9990: $initial_env{"browser.localres"} = $form->{'localres'};
9991: }
9992:
9993: if ($public) {
9994: $initial_env{"environment.remote"} = "off";
9995: }
9996: if ($form->{'interface'}) {
9997: $form->{'interface'}=~s/\W//gs;
9998: $initial_env{"browser.interface"} = $form->{'interface'};
9999: $env{'browser.interface'}=$form->{'interface'};
10000: foreach my $option ('imagesuppress','appletsuppress',
10001: 'embedsuppress','fontenhance','blackwhite') {
10002: if (($form->{$option} eq 'true') ||
10003: ($userenv{$option} eq 'on')) {
10004: $initial_env{"browser.$option"} = "on";
10005: }
10006: }
10007: }
10008:
1.724 raeburn 10009: foreach my $tool ('aboutme','blog','portfolio') {
10010: $userenv{'availabletools.'.$tool} =
10011: &Apache::lonnet::usertools_access($username,$domain,$tool,'reload');
10012: }
10013:
1.765 raeburn 10014: foreach my $crstype ('official','unofficial') {
10015: $userenv{'canrequest.'.$crstype} =
10016: &Apache::lonnet::usertools_access($username,$domain,$crstype,
10017: 'reload','requestcourses');
10018: }
10019:
1.462 albertel 10020: $env{'user.environment'} = "$lonids/$cookie.id";
10021:
10022: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
10023: &GDBM_WRCREAT(),0640)) {
10024: &_add_to_env(\%disk_env,\%initial_env);
10025: &_add_to_env(\%disk_env,\%userenv,'environment.');
10026: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 10027: if (ref($args->{'extra_env'})) {
10028: &_add_to_env(\%disk_env,$args->{'extra_env'});
10029: }
1.462 albertel 10030: untie(%disk_env);
10031: } else {
1.705 tempelho 10032: &Apache::lonnet::logthis("<span style=\"color:blue;\">WARNING: ".
10033: 'Could not create environment storage in lonauth: '.$!.'</span>');
1.462 albertel 10034: return 'error: '.$!;
10035: }
10036: }
10037: $env{'request.role'}='cm';
10038: $env{'request.role.adv'}=$env{'user.adv'};
10039: $env{'browser.type'}=$clientbrowser;
10040:
10041: return $cookie;
10042:
10043: }
10044:
10045: sub _add_to_env {
10046: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 10047: if (ref($env_data) eq 'HASH') {
10048: while (my ($key,$value) = each(%$env_data)) {
10049: $idf->{$prefix.$key} = $value;
10050: $env{$prefix.$key} = $value;
10051: }
1.462 albertel 10052: }
10053: }
10054:
1.685 tempelho 10055: # --- Get the symbolic name of a problem and the url
10056: sub get_symb {
10057: my ($request,$silent) = @_;
1.726 raeburn 10058: (my $url=$env{'form.url'}) =~ s-^https?\://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
1.685 tempelho 10059: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
10060: if ($symb eq '') {
10061: if (!$silent) {
10062: $request->print("Unable to handle ambiguous references:$url:.");
10063: return ();
10064: }
10065: }
10066: &Apache::lonenc::check_decrypt(\$symb);
10067: return ($symb);
10068: }
10069:
10070: # --------------------------------------------------------------Get annotation
10071:
10072: sub get_annotation {
10073: my ($symb,$enc) = @_;
10074:
10075: my $key = $symb;
10076: if (!$enc) {
10077: $key =
10078: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
10079: }
10080: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
10081: return $annotation{$key};
10082: }
10083:
10084: sub clean_symb {
1.731 raeburn 10085: my ($symb,$delete_enc) = @_;
1.685 tempelho 10086:
10087: &Apache::lonenc::check_decrypt(\$symb);
10088: my $enc = $env{'request.enc'};
1.731 raeburn 10089: if ($delete_enc) {
1.730 raeburn 10090: delete($env{'request.enc'});
10091: }
1.685 tempelho 10092:
10093: return ($symb,$enc);
10094: }
1.462 albertel 10095:
1.41 ng 10096: =pod
10097:
10098: =back
10099:
1.112 bowersj2 10100: =cut
1.41 ng 10101:
1.112 bowersj2 10102: 1;
10103: __END__;
1.41 ng 10104:
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