Annotation of loncom/interface/loncommon.pm, revision 1.692.2.3
1.10 albertel 1: # The LearningOnline Network with CAPA
1.1 albertel 2: # a pile of common routines
1.10 albertel 3: #
1.692.2.3! raeburn 4: # $Id: loncommon.pm,v 1.692.2.2 2008/12/11 18:41:03 raeburn Exp $
1.10 albertel 5: #
6: # Copyright Michigan State University Board of Trustees
7: #
8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
9: #
10: # LON-CAPA is free software; you can redistribute it and/or modify
11: # it under the terms of the GNU General Public License as published by
12: # the Free Software Foundation; either version 2 of the License, or
13: # (at your option) any later version.
14: #
15: # LON-CAPA is distributed in the hope that it will be useful,
16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18: # GNU General Public License for more details.
19: #
20: # You should have received a copy of the GNU General Public License
21: # along with LON-CAPA; if not, write to the Free Software
22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23: #
24: # /home/httpd/html/adm/gpl.txt
25: #
26: # http://www.lon-capa.org/
27: #
1.1 albertel 28:
29: # Makes a table out of the previous attempts
1.2 albertel 30: # Inputs result_from_symbread, user, domain, course_id
1.16 harris41 31: # Reads in non-network-related .tab files
1.1 albertel 32:
1.35 matthew 33: # POD header:
34:
1.45 matthew 35: =pod
36:
1.35 matthew 37: =head1 NAME
38:
39: Apache::loncommon - pile of common routines
40:
41: =head1 SYNOPSIS
42:
1.112 bowersj2 43: Common routines for manipulating connections, student answers,
44: domains, common Javascript fragments, etc.
1.35 matthew 45:
1.112 bowersj2 46: =head1 OVERVIEW
1.35 matthew 47:
1.112 bowersj2 48: A collection of commonly used subroutines that don't have a natural
49: home anywhere else. This collection helps remove
1.35 matthew 50: redundancy from other modules and increase efficiency of memory usage.
51:
52: =cut
53:
54: # End of POD header
1.1 albertel 55: package Apache::loncommon;
56:
57: use strict;
1.258 albertel 58: use Apache::lonnet;
1.46 matthew 59: use GDBM_File;
1.51 www 60: use POSIX qw(strftime mktime);
1.82 www 61: use Apache::lonmenu();
1.498 albertel 62: use Apache::lonenc();
1.117 www 63: use Apache::lonlocal;
1.685 tempelho 64: use Apache::lonnet();
1.139 matthew 65: use HTML::Entities;
1.334 albertel 66: use Apache::lonhtmlcommon();
67: use Apache::loncoursedata();
1.344 albertel 68: use Apache::lontexconvert();
1.444 albertel 69: use Apache::lonclonecourse();
1.479 albertel 70: use LONCAPA qw(:DEFAULT :match);
1.657 raeburn 71: use DateTime::TimeZone;
1.687 raeburn 72: use DateTime::Locale::Catalog;
1.117 www 73:
1.517 raeburn 74: # ---------------------------------------------- Designs
75: use vars qw(%defaultdesign);
76:
1.22 www 77: my $readit;
78:
1.517 raeburn 79:
1.157 matthew 80: ##
81: ## Global Variables
82: ##
1.46 matthew 83:
1.643 foxr 84:
85: # ----------------------------------------------- SSI with retries:
86: #
87:
88: =pod
89:
1.648 raeburn 90: =head1 Server Side include with retries:
1.643 foxr 91:
92: =over 4
93:
1.648 raeburn 94: =item * &ssi_with_retries(resource,retries form)
1.643 foxr 95:
96: Performs an ssi with some number of retries. Retries continue either
97: until the result is ok or until the retry count supplied by the
98: caller is exhausted.
99:
100: Inputs:
1.648 raeburn 101:
102: =over 4
103:
1.643 foxr 104: resource - Identifies the resource to insert.
1.648 raeburn 105:
1.643 foxr 106: retries - Count of the number of retries allowed.
1.648 raeburn 107:
1.643 foxr 108: form - Hash that identifies the rendering options.
109:
1.648 raeburn 110: =back
111:
112: Returns:
113:
114: =over 4
115:
1.643 foxr 116: content - The content of the response. If retries were exhausted this is empty.
1.648 raeburn 117:
1.643 foxr 118: response - The response from the last attempt (which may or may not have been successful.
119:
1.648 raeburn 120: =back
121:
122: =back
123:
1.643 foxr 124: =cut
125:
126: sub ssi_with_retries {
127: my ($resource, $retries, %form) = @_;
128:
129:
130: my $ok = 0; # True if we got a good response.
131: my $content;
132: my $response;
133:
134: # Try to get the ssi done. within the retries count:
135:
136: do {
137: ($content, $response) = &Apache::lonnet::ssi($resource, %form);
138: $ok = $response->is_success;
1.650 www 139: if (!$ok) {
140: &Apache::lonnet::logthis("Failed ssi_with_retries on $resource: ".$response->is_success.', '.$response->code.', '.$response->message);
141: }
1.643 foxr 142: $retries--;
143: } while (!$ok && ($retries > 0));
144:
145: if (!$ok) {
146: $content = ''; # On error return an empty content.
147: }
148: return ($content, $response);
149:
150: }
151:
152:
153:
1.20 www 154: # ----------------------------------------------- Filetypes/Languages/Copyright
1.12 harris41 155: my %language;
1.124 www 156: my %supported_language;
1.12 harris41 157: my %cprtag;
1.192 taceyjo1 158: my %scprtag;
1.351 www 159: my %fe; my %fd; my %fm;
1.41 ng 160: my %category_extensions;
1.12 harris41 161:
1.46 matthew 162: # ---------------------------------------------- Thesaurus variables
1.144 matthew 163: #
164: # %Keywords:
165: # A hash used by &keyword to determine if a word is considered a keyword.
166: # $thesaurus_db_file
167: # Scalar containing the full path to the thesaurus database.
1.46 matthew 168:
169: my %Keywords;
170: my $thesaurus_db_file;
171:
1.144 matthew 172: #
173: # Initialize values from language.tab, copyright.tab, filetypes.tab,
174: # thesaurus.tab, and filecategories.tab.
175: #
1.18 www 176: BEGIN {
1.46 matthew 177: # Variable initialization
178: $thesaurus_db_file = $Apache::lonnet::perlvar{'lonTabDir'}."/thesaurus.db";
179: #
1.22 www 180: unless ($readit) {
1.12 harris41 181: # ------------------------------------------------------------------- languages
182: {
1.158 raeburn 183: my $langtabfile = $Apache::lonnet::perlvar{'lonTabDir'}.
184: '/language.tab';
185: if ( open(my $fh,"<$langtabfile") ) {
1.356 albertel 186: while (my $line = <$fh>) {
187: next if ($line=~/^\#/);
188: chomp($line);
189: my ($key,$two,$country,$three,$enc,$val,$sup)=(split(/\t/,$line));
1.158 raeburn 190: $language{$key}=$val.' - '.$enc;
191: if ($sup) {
192: $supported_language{$key}=$sup;
193: }
194: }
195: close($fh);
196: }
1.12 harris41 197: }
198: # ------------------------------------------------------------------ copyrights
199: {
1.158 raeburn 200: my $copyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
201: '/copyright.tab';
202: if ( open (my $fh,"<$copyrightfile") ) {
1.356 albertel 203: while (my $line = <$fh>) {
204: next if ($line=~/^\#/);
205: chomp($line);
206: my ($key,$val)=(split(/\s+/,$line,2));
1.158 raeburn 207: $cprtag{$key}=$val;
208: }
209: close($fh);
210: }
1.12 harris41 211: }
1.351 www 212: # ----------------------------------------------------------- source copyrights
1.192 taceyjo1 213: {
214: my $sourcecopyrightfile = $Apache::lonnet::perlvar{'lonIncludes'}.
215: '/source_copyright.tab';
216: if ( open (my $fh,"<$sourcecopyrightfile") ) {
1.356 albertel 217: while (my $line = <$fh>) {
218: next if ($line =~ /^\#/);
219: chomp($line);
220: my ($key,$val)=(split(/\s+/,$line,2));
1.192 taceyjo1 221: $scprtag{$key}=$val;
222: }
223: close($fh);
224: }
225: }
1.63 www 226:
1.517 raeburn 227: # -------------------------------------------------------------- default domain designs
1.63 www 228: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
1.517 raeburn 229: my $designfile = $designdir.'/default.tab';
230: if ( open (my $fh,"<$designfile") ) {
231: while (my $line = <$fh>) {
232: next if ($line =~ /^\#/);
233: chomp($line);
234: my ($key,$val)=(split(/\=/,$line));
235: if ($val) { $defaultdesign{$key}=$val; }
236: }
237: close($fh);
1.63 www 238: }
239:
1.15 harris41 240: # ------------------------------------------------------------- file categories
241: {
1.158 raeburn 242: my $categoryfile = $Apache::lonnet::perlvar{'lonTabDir'}.
243: '/filecategories.tab';
244: if ( open (my $fh,"<$categoryfile") ) {
1.356 albertel 245: while (my $line = <$fh>) {
246: next if ($line =~ /^\#/);
247: chomp($line);
248: my ($extension,$category)=(split(/\s+/,$line,2));
1.158 raeburn 249: push @{$category_extensions{lc($category)}},$extension;
250: }
251: close($fh);
252: }
253:
1.15 harris41 254: }
1.12 harris41 255: # ------------------------------------------------------------------ file types
256: {
1.158 raeburn 257: my $typesfile = $Apache::lonnet::perlvar{'lonTabDir'}.
258: '/filetypes.tab';
259: if ( open (my $fh,"<$typesfile") ) {
1.356 albertel 260: while (my $line = <$fh>) {
261: next if ($line =~ /^\#/);
262: chomp($line);
263: my ($ending,$emb,$mime,$descr)=split(/\s+/,$line,4);
1.158 raeburn 264: if ($descr ne '') {
265: $fe{$ending}=lc($emb);
266: $fd{$ending}=$descr;
1.351 www 267: if ($mime ne 'unk') { $fm{$ending}=$mime; }
1.158 raeburn 268: }
269: }
270: close($fh);
271: }
1.12 harris41 272: }
1.22 www 273: &Apache::lonnet::logthis(
1.46 matthew 274: "<font color=yellow>INFO: Read file types</font>");
1.22 www 275: $readit=1;
1.46 matthew 276: } # end of unless($readit)
1.32 matthew 277:
278: }
1.112 bowersj2 279:
1.42 matthew 280: ###############################################################
281: ## HTML and Javascript Helper Functions ##
282: ###############################################################
283:
284: =pod
285:
1.112 bowersj2 286: =head1 HTML and Javascript Functions
1.42 matthew 287:
1.112 bowersj2 288: =over 4
289:
1.648 raeburn 290: =item * &browser_and_searcher_javascript()
1.112 bowersj2 291:
292: X<browsing, javascript>X<searching, javascript>Returns a string
293: containing javascript with two functions, C<openbrowser> and
294: C<opensearcher>. Returned string does not contain E<lt>scriptE<gt>
295: tags.
1.42 matthew 296:
1.648 raeburn 297: =item * &openbrowser(formname,elementname,only,omit) [javascript]
1.42 matthew 298:
299: inputs: formname, elementname, only, omit
300:
301: formname and elementname indicate the name of the html form and name of
302: the element that the results of the browsing selection are to be placed in.
303:
304: Specifying 'only' will restrict the browser to displaying only files
1.185 www 305: with the given extension. Can be a comma separated list.
1.42 matthew 306:
307: Specifying 'omit' will restrict the browser to NOT displaying files
1.185 www 308: with the given extension. Can be a comma separated list.
1.42 matthew 309:
1.648 raeburn 310: =item * &opensearcher(formname,elementname) [javascript]
1.42 matthew 311:
312: Inputs: formname, elementname
313:
314: formname and elementname specify the name of the html form and the name
315: of the element the selection from the search results will be placed in.
1.542 raeburn 316:
1.42 matthew 317: =cut
318:
319: sub browser_and_searcher_javascript {
1.199 albertel 320: my ($mode)=@_;
321: if (!defined($mode)) { $mode='edit'; }
1.453 albertel 322: my $resurl=&escape_single(&lastresurl());
1.42 matthew 323: return <<END;
1.219 albertel 324: // <!-- BEGIN LON-CAPA Internal
1.50 matthew 325: var editbrowser = null;
1.135 albertel 326: function openbrowser(formname,elementname,only,omit,titleelement) {
1.170 www 327: var url = '$resurl/?';
1.42 matthew 328: if (editbrowser == null) {
329: url += 'launch=1&';
330: }
331: url += 'catalogmode=interactive&';
1.199 albertel 332: url += 'mode=$mode&';
1.611 albertel 333: url += 'inhibitmenu=yes&';
1.42 matthew 334: url += 'form=' + formname + '&';
335: if (only != null) {
336: url += 'only=' + only + '&';
1.217 albertel 337: } else {
338: url += 'only=&';
339: }
1.42 matthew 340: if (omit != null) {
341: url += 'omit=' + omit + '&';
1.217 albertel 342: } else {
343: url += 'omit=&';
344: }
1.135 albertel 345: if (titleelement != null) {
346: url += 'titleelement=' + titleelement + '&';
1.217 albertel 347: } else {
348: url += 'titleelement=&';
349: }
1.42 matthew 350: url += 'element=' + elementname + '';
351: var title = 'Browser';
1.435 albertel 352: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 353: options += ',width=700,height=600';
354: editbrowser = open(url,title,options,'1');
355: editbrowser.focus();
356: }
357: var editsearcher;
1.135 albertel 358: function opensearcher(formname,elementname,titleelement) {
1.42 matthew 359: var url = '/adm/searchcat?';
360: if (editsearcher == null) {
361: url += 'launch=1&';
362: }
363: url += 'catalogmode=interactive&';
1.199 albertel 364: url += 'mode=$mode&';
1.42 matthew 365: url += 'form=' + formname + '&';
1.135 albertel 366: if (titleelement != null) {
367: url += 'titleelement=' + titleelement + '&';
1.217 albertel 368: } else {
369: url += 'titleelement=&';
370: }
1.42 matthew 371: url += 'element=' + elementname + '';
372: var title = 'Search';
1.435 albertel 373: var options = 'scrollbars=1,resizable=1,menubar=0,toolbar=1,location=1';
1.42 matthew 374: options += ',width=700,height=600';
375: editsearcher = open(url,title,options,'1');
376: editsearcher.focus();
377: }
1.219 albertel 378: // END LON-CAPA Internal -->
1.42 matthew 379: END
1.170 www 380: }
381:
382: sub lastresurl {
1.258 albertel 383: if ($env{'environment.lastresurl'}) {
384: return $env{'environment.lastresurl'}
1.170 www 385: } else {
386: return '/res';
387: }
388: }
389:
390: sub storeresurl {
391: my $resurl=&Apache::lonnet::clutter(shift);
392: unless ($resurl=~/^\/res/) { return 0; }
393: $resurl=~s/\/$//;
394: &Apache::lonnet::put('environment',{'lastresurl' => $resurl});
1.646 raeburn 395: &Apache::lonnet::appenv({'environment.lastresurl' => $resurl});
1.170 www 396: return 1;
1.42 matthew 397: }
398:
1.74 www 399: sub studentbrowser_javascript {
1.111 www 400: unless (
1.258 albertel 401: (($env{'request.course.id'}) &&
1.302 albertel 402: (&Apache::lonnet::allowed('srm',$env{'request.course.id'})
403: || &Apache::lonnet::allowed('srm',$env{'request.course.id'}.
404: '/'.$env{'request.course.sec'})
405: ))
1.258 albertel 406: || ($env{'request.role'}=~/^(au|dc|su)/)
1.111 www 407: ) { return ''; }
1.74 www 408: return (<<'ENDSTDBRW');
409: <script type="text/javascript" language="Javascript" >
410: var stdeditbrowser;
1.558 albertel 411: function openstdbrowser(formname,uname,udom,roleflag,ignorefilter) {
1.74 www 412: var url = '/adm/pickstudent?';
413: var filter;
1.558 albertel 414: if (!ignorefilter) {
415: eval('filter=document.'+formname+'.'+uname+'.value;');
416: }
1.74 www 417: if (filter != null) {
418: if (filter != '') {
419: url += 'filter='+filter+'&';
420: }
421: }
422: url += 'form=' + formname + '&unameelement='+uname+
423: '&udomelement='+udom;
1.111 www 424: if (roleflag) { url+="&roles=1"; }
1.102 www 425: var title = 'Student_Browser';
1.74 www 426: var options = 'scrollbars=1,resizable=1,menubar=0';
427: options += ',width=700,height=600';
428: stdeditbrowser = open(url,title,options,'1');
429: stdeditbrowser.focus();
430: }
431: </script>
432: ENDSTDBRW
433: }
1.42 matthew 434:
1.74 www 435: sub selectstudent_link {
1.111 www 436: my ($form,$unameele,$udomele)=@_;
1.258 albertel 437: if ($env{'request.course.id'}) {
1.302 albertel 438: if (!&Apache::lonnet::allowed('srm',$env{'request.course.id'})
439: && !&Apache::lonnet::allowed('srm',$env{'request.course.id'}.
440: '/'.$env{'request.course.sec'})) {
1.111 www 441: return '';
442: }
443: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.607 albertel 444: '","'.$udomele.'");'."'>".&mt('Select User')."</a>";
1.74 www 445: }
1.258 albertel 446: if ($env{'request.role'}=~/^(au|dc|su)/) {
1.111 www 447: return "<a href='".'javascript:openstdbrowser("'.$form.'","'.$unameele.
1.119 www 448: '","'.$udomele.'",1);'."'>".&mt('Select User')."</a>";
1.111 www 449: }
450: return '';
1.91 www 451: }
452:
1.653 raeburn 453: sub authorbrowser_javascript {
454: return <<"ENDAUTHORBRW";
455: <script type="text/javascript">
456: var stdeditbrowser;
457:
458: function openauthorbrowser(formname,udom) {
459: var url = '/adm/pickauthor?';
460: url += 'form='+formname+'&roledom='+udom;
461: var title = 'Author_Browser';
462: var options = 'scrollbars=1,resizable=1,menubar=0';
463: options += ',width=700,height=600';
464: stdeditbrowser = open(url,title,options,'1');
465: stdeditbrowser.focus();
466: }
467:
468: </script>
469: ENDAUTHORBRW
470: }
471:
1.91 www 472: sub coursebrowser_javascript {
1.468 raeburn 473: my ($domainfilter,$sec_element,$formname)=@_;
1.377 raeburn 474: my $crs_or_grp_alert = &mt('Please select the type of LON-CAPA entity - Course or Group - for which you wish to add/modify a user role');
1.468 raeburn 475: my $output = '
1.538 albertel 476: <script type="text/javascript">
1.468 raeburn 477: var stdeditbrowser;'."\n";
478: $output .= <<"ENDSTDBRW";
1.377 raeburn 479: function opencrsbrowser(formname,uname,udom,desc,extra_element,multflag,crstype) {
1.91 www 480: var url = '/adm/pickcourse?';
1.468 raeburn 481: var domainfilter = '';
482: var formid = getFormIdByName(formname);
483: if (formid > -1) {
484: var domid = getIndexByName(formid,udom);
485: if (domid > -1) {
486: if (document.forms[formid].elements[domid].type == 'select-one') {
487: domainfilter=document.forms[formid].elements[domid].options[document.forms[formid].elements[domid].selectedIndex].value;
488: }
489: if (document.forms[formid].elements[domid].type == 'hidden') {
490: domainfilter=document.forms[formid].elements[domid].value;
491: }
492: }
1.91 www 493: }
1.128 albertel 494: if (domainfilter != null) {
495: if (domainfilter != '') {
496: url += 'domainfilter='+domainfilter+'&';
497: }
498: }
1.91 www 499: url += 'form=' + formname + '&cnumelement='+uname+
1.187 albertel 500: '&cdomelement='+udom+
501: '&cnameelement='+desc;
1.468 raeburn 502: if (extra_element !=null && extra_element != '') {
1.594 raeburn 503: if (formname == 'rolechoice' || formname == 'studentform') {
1.468 raeburn 504: url += '&roleelement='+extra_element;
505: if (domainfilter == null || domainfilter == '') {
506: url += '&domainfilter='+extra_element;
507: }
1.234 raeburn 508: }
1.468 raeburn 509: else {
510: if (formname == 'portform') {
511: url += '&setroles='+extra_element;
512: }
513: }
1.230 raeburn 514: }
1.293 raeburn 515: if (multflag !=null && multflag != '') {
516: url += '&multiple='+multflag;
517: }
1.377 raeburn 518: if (crstype == 'Course/Group') {
519: if (formname == 'cu') {
520: crstype = document.cu.crstype.options[document.cu.crstype.selectedIndex].value;
521: if (crstype == "") {
522: alert("$crs_or_grp_alert");
523: return;
524: }
525: }
526: }
527: if (crstype !=null && crstype != '') {
528: url += '&type='+crstype;
529: }
1.102 www 530: var title = 'Course_Browser';
1.91 www 531: var options = 'scrollbars=1,resizable=1,menubar=0';
532: options += ',width=700,height=600';
533: stdeditbrowser = open(url,title,options,'1');
534: stdeditbrowser.focus();
535: }
1.468 raeburn 536:
537: function getFormIdByName(formname) {
538: for (var i=0;i<document.forms.length;i++) {
539: if (document.forms[i].name == formname) {
540: return i;
541: }
542: }
543: return -1;
544: }
545:
546: function getIndexByName(formid,item) {
547: for (var i=0;i<document.forms[formid].elements.length;i++) {
548: if (document.forms[formid].elements[i].name == item) {
549: return i;
550: }
551: }
552: return -1;
553: }
1.91 www 554: ENDSTDBRW
1.468 raeburn 555: if ($sec_element ne '') {
556: $output .= &setsec_javascript($sec_element,$formname);
557: }
558: $output .= '
559: </script>';
560: return $output;
561: }
562:
563: sub setsec_javascript {
564: my ($sec_element,$formname) = @_;
565: my $setsections = qq|
566: function setSect(sectionlist) {
1.629 raeburn 567: var sectionsArray = new Array();
568: if ((sectionlist != '') && (typeof sectionlist != "undefined")) {
569: sectionsArray = sectionlist.split(",");
570: }
1.468 raeburn 571: var numSections = sectionsArray.length;
572: document.$formname.$sec_element.length = 0;
573: if (numSections == 0) {
574: document.$formname.$sec_element.multiple=false;
575: document.$formname.$sec_element.size=1;
576: document.$formname.$sec_element.options[0] = new Option('No existing sections','',false,false)
577: } else {
578: if (numSections == 1) {
579: document.$formname.$sec_element.multiple=false;
580: document.$formname.$sec_element.size=1;
581: document.$formname.$sec_element.options[0] = new Option('Select','',true,true);
582: document.$formname.$sec_element.options[1] = new Option('No section','',false,false)
583: document.$formname.$sec_element.options[2] = new Option(sectionsArray[0],sectionsArray[0],false,false);
584: } else {
585: for (var i=0; i<numSections; i++) {
586: document.$formname.$sec_element.options[i] = new Option(sectionsArray[i],sectionsArray[i],false,false)
587: }
588: document.$formname.$sec_element.multiple=true
589: if (numSections < 3) {
590: document.$formname.$sec_element.size=numSections;
591: } else {
592: document.$formname.$sec_element.size=3;
593: }
594: document.$formname.$sec_element.options[0].selected = false
595: }
596: }
1.91 www 597: }
1.468 raeburn 598: |;
599: return $setsections;
600: }
601:
1.91 www 602:
603: sub selectcourse_link {
1.377 raeburn 604: my ($form,$unameele,$udomele,$desc,$extra_element,$multflag,$selecttype)=@_;
1.492 albertel 605: return "<a href='".'javascript:opencrsbrowser("'.$form.'","'.$unameele.
606: '","'.$udomele.'","'.$desc.'","'.$extra_element.'","'.$multflag.'","'.$selecttype.'");'."'>".&mt('Select Course')."</a>";
1.74 www 607: }
1.42 matthew 608:
1.653 raeburn 609: sub selectauthor_link {
610: my ($form,$udom)=@_;
611: return '<a href="javascript:openauthorbrowser('."'$form','$udom'".');">'.
612: &mt('Select Author').'</a>';
613: }
614:
1.273 raeburn 615: sub check_uncheck_jscript {
616: my $jscript = <<"ENDSCRT";
617: function checkAll(field) {
618: if (field.length > 0) {
619: for (i = 0; i < field.length; i++) {
620: field[i].checked = true ;
621: }
622: } else {
623: field.checked = true
624: }
625: }
626:
627: function uncheckAll(field) {
628: if (field.length > 0) {
629: for (i = 0; i < field.length; i++) {
630: field[i].checked = false ;
1.543 albertel 631: }
632: } else {
1.273 raeburn 633: field.checked = false ;
634: }
635: }
636: ENDSCRT
637: return $jscript;
638: }
639:
1.656 www 640: sub select_timezone {
1.659 raeburn 641: my ($name,$selected,$onchange,$includeempty)=@_;
642: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
643: if ($includeempty) {
644: $output .= '<option value=""';
645: if (($selected eq '') || ($selected eq 'local')) {
646: $output .= ' selected="selected" ';
647: }
648: $output .= '> </option>';
649: }
1.657 raeburn 650: my @timezones = DateTime::TimeZone->all_names;
651: foreach my $tzone (@timezones) {
652: $output.= '<option value="'.$tzone.'"';
653: if ($tzone eq $selected) {
654: $output.=' selected="selected"';
655: }
656: $output.=">$tzone</option>\n";
1.656 www 657: }
658: $output.="</select>";
659: return $output;
660: }
1.273 raeburn 661:
1.687 raeburn 662: sub select_datelocale {
663: my ($name,$selected,$onchange,$includeempty)=@_;
664: my $output='<select name="'.$name.'" '.$onchange.'>'."\n";
665: if ($includeempty) {
666: $output .= '<option value=""';
667: if ($selected eq '') {
668: $output .= ' selected="selected" ';
669: }
670: $output .= '> </option>';
671: }
672: my (@possibles,%locale_names);
673: my @locales = DateTime::Locale::Catalog::Locales;
674: foreach my $locale (@locales) {
675: if (ref($locale) eq 'HASH') {
676: my $id = $locale->{'id'};
677: if ($id ne '') {
678: my $en_terr = $locale->{'en_territory'};
679: my $native_terr = $locale->{'native_territory'};
1.692.2.1 raeburn 680: my @languages = &Apache::lonlocal::preferred_languages();
1.687 raeburn 681: if (grep(/^en$/,@languages) || !@languages) {
682: if ($en_terr ne '') {
683: $locale_names{$id} = '('.$en_terr.')';
684: } elsif ($native_terr ne '') {
685: $locale_names{$id} = $native_terr;
686: }
687: } else {
688: if ($native_terr ne '') {
689: $locale_names{$id} = $native_terr.' ';
690: } elsif ($en_terr ne '') {
691: $locale_names{$id} = '('.$en_terr.')';
692: }
693: }
694: push (@possibles,$id);
695: }
696: }
697: }
698: foreach my $item (sort(@possibles)) {
699: $output.= '<option value="'.$item.'"';
700: if ($item eq $selected) {
701: $output.=' selected="selected"';
702: }
703: $output.=">$item";
704: if ($locale_names{$item} ne '') {
705: $output.=" $locale_names{$item}</option>\n";
706: }
707: $output.="</option>\n";
708: }
709: $output.="</select>";
710: return $output;
711: }
712:
1.42 matthew 713: =pod
1.36 matthew 714:
1.648 raeburn 715: =item * &linked_select_forms(...)
1.36 matthew 716:
717: linked_select_forms returns a string containing a <script></script> block
718: and html for two <select> menus. The select menus will be linked in that
719: changing the value of the first menu will result in new values being placed
720: in the second menu. The values in the select menu will appear in alphabetical
1.609 raeburn 721: order unless a defined order is provided.
1.36 matthew 722:
723: linked_select_forms takes the following ordered inputs:
724:
725: =over 4
726:
1.112 bowersj2 727: =item * $formname, the name of the <form> tag
1.36 matthew 728:
1.112 bowersj2 729: =item * $middletext, the text which appears between the <select> tags
1.36 matthew 730:
1.112 bowersj2 731: =item * $firstdefault, the default value for the first menu
1.36 matthew 732:
1.112 bowersj2 733: =item * $firstselectname, the name of the first <select> tag
1.36 matthew 734:
1.112 bowersj2 735: =item * $secondselectname, the name of the second <select> tag
1.36 matthew 736:
1.112 bowersj2 737: =item * $hashref, a reference to a hash containing the data for the menus.
1.36 matthew 738:
1.609 raeburn 739: =item * $menuorder, the order of values in the first menu
740:
1.41 ng 741: =back
742:
1.36 matthew 743: Below is an example of such a hash. Only the 'text', 'default', and
744: 'select2' keys must appear as stated. keys(%menu) are the possible
745: values for the first select menu. The text that coincides with the
1.41 ng 746: first menu value is given in $menu{$choice1}->{'text'}. The values
1.36 matthew 747: and text for the second menu are given in the hash pointed to by
748: $menu{$choice1}->{'select2'}.
749:
1.112 bowersj2 750: my %menu = ( A1 => { text =>"Choice A1" ,
751: default => "B3",
752: select2 => {
753: B1 => "Choice B1",
754: B2 => "Choice B2",
755: B3 => "Choice B3",
756: B4 => "Choice B4"
1.609 raeburn 757: },
758: order => ['B4','B3','B1','B2'],
1.112 bowersj2 759: },
760: A2 => { text =>"Choice A2" ,
761: default => "C2",
762: select2 => {
763: C1 => "Choice C1",
764: C2 => "Choice C2",
765: C3 => "Choice C3"
1.609 raeburn 766: },
767: order => ['C2','C1','C3'],
1.112 bowersj2 768: },
769: A3 => { text =>"Choice A3" ,
770: default => "D6",
771: select2 => {
772: D1 => "Choice D1",
773: D2 => "Choice D2",
774: D3 => "Choice D3",
775: D4 => "Choice D4",
776: D5 => "Choice D5",
777: D6 => "Choice D6",
778: D7 => "Choice D7"
1.609 raeburn 779: },
780: order => ['D4','D3','D2','D1','D7','D6','D5'],
1.112 bowersj2 781: }
782: );
1.36 matthew 783:
784: =cut
785:
786: sub linked_select_forms {
787: my ($formname,
788: $middletext,
789: $firstdefault,
790: $firstselectname,
791: $secondselectname,
1.609 raeburn 792: $hashref,
793: $menuorder,
1.36 matthew 794: ) = @_;
795: my $second = "document.$formname.$secondselectname";
796: my $first = "document.$formname.$firstselectname";
797: # output the javascript to do the changing
798: my $result = '';
1.219 albertel 799: $result.="<script type=\"text/javascript\">\n";
1.36 matthew 800: $result.="var select2data = new Object();\n";
801: $" = '","';
802: my $debug = '';
803: foreach my $s1 (sort(keys(%$hashref))) {
804: $result.="select2data.d_$s1 = new Object();\n";
805: $result.="select2data.d_$s1.def = new String('".
806: $hashref->{$s1}->{'default'}."');\n";
1.609 raeburn 807: $result.="select2data.d_$s1.values = new Array(";
1.36 matthew 808: my @s2values = sort(keys( %{ $hashref->{$s1}->{'select2'} } ));
1.609 raeburn 809: if (ref($hashref->{$s1}->{'order'}) eq 'ARRAY') {
810: @s2values = @{$hashref->{$s1}->{'order'}};
811: }
1.36 matthew 812: $result.="\"@s2values\");\n";
813: $result.="select2data.d_$s1.texts = new Array(";
814: my @s2texts;
815: foreach my $value (@s2values) {
816: push @s2texts, $hashref->{$s1}->{'select2'}->{$value};
817: }
818: $result.="\"@s2texts\");\n";
819: }
820: $"=' ';
821: $result.= <<"END";
822:
823: function select1_changed() {
824: // Determine new choice
825: var newvalue = "d_" + $first.value;
826: // update select2
827: var values = select2data[newvalue].values;
828: var texts = select2data[newvalue].texts;
829: var select2def = select2data[newvalue].def;
830: var i;
831: // out with the old
832: for (i = 0; i < $second.options.length; i++) {
833: $second.options[i] = null;
834: }
835: // in with the nuclear
836: for (i=0;i<values.length; i++) {
837: $second.options[i] = new Option(values[i]);
1.143 matthew 838: $second.options[i].value = values[i];
1.36 matthew 839: $second.options[i].text = texts[i];
840: if (values[i] == select2def) {
841: $second.options[i].selected = true;
842: }
843: }
844: }
845: </script>
846: END
847: # output the initial values for the selection lists
848: $result .= "<select size=\"1\" name=\"$firstselectname\" onchange=\"select1_changed()\">\n";
1.609 raeburn 849: my @order = sort(keys(%{$hashref}));
850: if (ref($menuorder) eq 'ARRAY') {
851: @order = @{$menuorder};
852: }
853: foreach my $value (@order) {
1.36 matthew 854: $result.=" <option value=\"$value\" ";
1.253 albertel 855: $result.=" selected=\"selected\" " if ($value eq $firstdefault);
1.119 www 856: $result.=">".&mt($hashref->{$value}->{'text'})."</option>\n";
1.36 matthew 857: }
858: $result .= "</select>\n";
859: my %select2 = %{$hashref->{$firstdefault}->{'select2'}};
860: $result .= $middletext;
861: $result .= "<select size=\"1\" name=\"$secondselectname\">\n";
862: my $seconddefault = $hashref->{$firstdefault}->{'default'};
1.609 raeburn 863:
864: my @secondorder = sort(keys(%select2));
865: if (ref($hashref->{$firstdefault}->{'order'}) eq 'ARRAY') {
866: @secondorder = @{$hashref->{$firstdefault}->{'order'}};
867: }
868: foreach my $value (@secondorder) {
1.36 matthew 869: $result.=" <option value=\"$value\" ";
1.253 albertel 870: $result.=" selected=\"selected\" " if ($value eq $seconddefault);
1.119 www 871: $result.=">".&mt($select2{$value})."</option>\n";
1.36 matthew 872: }
873: $result .= "</select>\n";
874: # return $debug;
875: return $result;
876: } # end of sub linked_select_forms {
877:
1.45 matthew 878: =pod
1.44 bowersj2 879:
1.648 raeburn 880: =item * &help_open_topic($topic,$text,$stayOnPage,$width,$height)
1.44 bowersj2 881:
1.112 bowersj2 882: Returns a string corresponding to an HTML link to the given help
883: $topic, where $topic corresponds to the name of a .tex file in
884: /home/httpd/html/adm/help/tex, with underscores replaced by
885: spaces.
886:
887: $text will optionally be linked to the same topic, allowing you to
888: link text in addition to the graphic. If you do not want to link
889: text, but wish to specify one of the later parameters, pass an
890: empty string.
891:
892: $stayOnPage is a value that will be interpreted as a boolean. If true,
893: the link will not open a new window. If false, the link will open
894: a new window using Javascript. (Default is false.)
895:
896: $width and $height are optional numerical parameters that will
897: override the width and height of the popped up window, which may
898: be useful for certain help topics with big pictures included.
1.44 bowersj2 899:
900: =cut
901:
902: sub help_open_topic {
1.48 bowersj2 903: my ($topic, $text, $stayOnPage, $width, $height) = @_;
904: $text = "" if (not defined $text);
1.44 bowersj2 905: $stayOnPage = 0 if (not defined $stayOnPage);
1.552 banghart 906: if ($env{'browser.interface'} eq 'textual') {
1.79 www 907: $stayOnPage=1;
908: }
1.44 bowersj2 909: $width = 350 if (not defined $width);
910: $height = 400 if (not defined $height);
911: my $filename = $topic;
912: $filename =~ s/ /_/g;
913:
1.48 bowersj2 914: my $template = "";
915: my $link;
1.572 banghart 916:
1.159 www 917: $topic=~s/\W/\_/g;
1.44 bowersj2 918:
1.572 banghart 919: if (!$stayOnPage) {
1.72 bowersj2 920: $link = "javascript:void(open('/adm/help/${filename}.hlp', 'Help_for_$topic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1.572 banghart 921: } else {
1.48 bowersj2 922: $link = "/adm/help/${filename}.hlp";
923: }
924:
925: # Add the text
1.572 banghart 926: if ($text ne "") {
1.77 www 927: $template .=
1.572 banghart 928: "<table bgcolor='#3333AA' cellspacing='1' cellpadding='1' border='0'><tr>".
1.691 bisitz 929: "<td bgcolor='#5555FF'><span class=\"LC_nobreak\"><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.48 bowersj2 930: }
931:
932: # Add the graphic
1.179 matthew 933: my $title = &mt('Online Help');
1.667 raeburn 934: my $helpicon=&lonhttpdurl("/adm/help/help.png");
1.48 bowersj2 935: $template .= <<"ENDTEMPLATE";
1.436 albertel 936: <a target="_top" href="$link" title="$title"><img src="$helpicon" border="0" alt="(Help: $topic)" /></a>
1.44 bowersj2 937: ENDTEMPLATE
1.691 bisitz 938: if ($text ne '') { $template.='</span></td></tr></table>' };
1.44 bowersj2 939: return $template;
940:
1.106 bowersj2 941: }
942:
943: # This is a quicky function for Latex cheatsheet editing, since it
944: # appears in at least four places
945: sub helpLatexCheatsheet {
946: my $other = shift;
947: my $addOther = '';
948: if ($other) {
949: $addOther = Apache::loncommon::help_open_topic($other, shift,
950: undef, undef, 600) .
951: '</td><td>';
952: }
953: return '<table><tr><td>'.
954: $addOther .
1.636 raeburn 955: &Apache::loncommon::help_open_topic("Greek_Symbols",&mt('Greek Symbols'),
1.106 bowersj2 956: undef,undef,600)
957: .'</td><td>'.
1.636 raeburn 958: &Apache::loncommon::help_open_topic("Other_Symbols",&mt('Other Symbols'),
1.106 bowersj2 959: undef,undef,600)
1.673 felicia 960: .'</td><td>'.
961: &Apache::loncommon::help_open_topic("Authoring_Output_Tags",&mt('Output Tags'),
962: undef,undef,600)
1.106 bowersj2 963: .'</td></tr></table>';
1.172 www 964: }
965:
1.430 albertel 966: sub general_help {
967: my $helptopic='Student_Intro';
968: if ($env{'request.role'}=~/^(ca|au)/) {
969: $helptopic='Authoring_Intro';
970: } elsif ($env{'request.role'}=~/^cc/) {
971: $helptopic='Course_Coordination_Intro';
1.672 raeburn 972: } elsif ($env{'request.role'}=~/^dc/) {
973: $helptopic='Domain_Coordination_Intro';
1.430 albertel 974: }
975: return $helptopic;
976: }
977:
978: sub update_help_link {
979: my ($topic,$component_help,$faq,$bug,$stayOnPage) = @_;
980: my $origurl = $ENV{'REQUEST_URI'};
981: $origurl=~s|^/~|/priv/|;
982: my $timestamp = time;
983: foreach my $datum (\$topic,\$component_help,\$faq,\$bug,\$origurl) {
984: $$datum = &escape($$datum);
985: }
986:
987: my $banner_link = "/adm/helpmenu?page=banner&topic=$topic&component_help=$component_help&faq=$faq&bug=$bug&origurl=$origurl&stamp=$timestamp&stayonpage=$stayOnPage";
988: my $output .= <<"ENDOUTPUT";
989: <script type="text/javascript">
990: banner_link = '$banner_link';
991: </script>
992: ENDOUTPUT
993: return $output;
994: }
995:
996: # now just updates the help link and generates a blue icon
1.193 raeburn 997: sub help_open_menu {
1.430 albertel 998: my ($topic,$component_help,$faq,$bug,$stayOnPage,$width,$height,$text)
1.552 banghart 999: = @_;
1.430 albertel 1000: $stayOnPage = 0 if (not defined $stayOnPage);
1.572 banghart 1001: # only use pop-up help (stayOnPage == 0)
1.552 banghart 1002: # if environment.remote is on (using remote control UI)
1.572 banghart 1003: if ($env{'browser.interface'} eq 'textual' ||
1004: $env{'environment.remote'} eq 'off' ) {
1.552 banghart 1005: $stayOnPage=1;
1.430 albertel 1006: }
1007: my $output;
1008: if ($component_help) {
1009: if (!$text) {
1010: $output=&help_open_topic($component_help,undef,$stayOnPage,
1011: $width,$height);
1012: } else {
1013: my $help_text;
1014: $help_text=&unescape($topic);
1015: $output='<table><tr><td>'.
1016: &help_open_topic($component_help,$help_text,$stayOnPage,
1017: $width,$height).'</td></tr></table>';
1018: }
1019: }
1020: my $banner_link = &update_help_link($topic,$component_help,$faq,$bug,$stayOnPage);
1021: return $output.$banner_link;
1022: }
1023:
1024: sub top_nav_help {
1025: my ($text) = @_;
1.436 albertel 1026: $text = &mt($text);
1.572 banghart 1027: my $stay_on_page =
1.436 albertel 1028: ($env{'browser.interface'} eq 'textual' ||
1029: $env{'environment.remote'} eq 'off' );
1.572 banghart 1030: my $link = ($stay_on_page) ? "javascript:helpMenu('display')"
1.436 albertel 1031: : "javascript:helpMenu('open')";
1.572 banghart 1032: my $banner_link = &update_help_link(undef,undef,undef,undef,$stay_on_page);
1.436 albertel 1033:
1.201 raeburn 1034: my $title = &mt('Get help');
1.436 albertel 1035:
1036: return <<"END";
1037: $banner_link
1038: <a href="$link" title="$title">$text</a>
1039: END
1040: }
1041:
1042: sub help_menu_js {
1043: my ($text) = @_;
1044:
1045: my $stayOnPage =
1046: ($env{'browser.interface'} eq 'textual' ||
1047: $env{'environment.remote'} eq 'off' );
1048:
1049: my $width = 620;
1050: my $height = 600;
1.430 albertel 1051: my $helptopic=&general_help();
1052: my $details_link = '/adm/help/'.$helptopic.'.hlp';
1.261 albertel 1053: my $nothing=&Apache::lonhtmlcommon::javascript_nothing();
1.331 albertel 1054: my $start_page =
1055: &Apache::loncommon::start_page('Help Menu', undef,
1056: {'frameset' => 1,
1057: 'js_ready' => 1,
1058: 'add_entries' => {
1059: 'border' => '0',
1.579 raeburn 1060: 'rows' => "110,*",},});
1.331 albertel 1061: my $end_page =
1062: &Apache::loncommon::end_page({'frameset' => 1,
1063: 'js_ready' => 1,});
1064:
1.436 albertel 1065: my $template .= <<"ENDTEMPLATE";
1066: <script type="text/javascript">
1.253 albertel 1067: // <!-- BEGIN LON-CAPA Internal
1068: // <![CDATA[
1.430 albertel 1069: var banner_link = '';
1.243 raeburn 1070: function helpMenu(target) {
1071: var caller = this;
1072: if (target == 'open') {
1073: var newWindow = null;
1074: try {
1.262 albertel 1075: newWindow = window.open($nothing,"helpmenu","HEIGHT=$height,WIDTH=$width,resizable=yes,scrollbars=yes" )
1.243 raeburn 1076: }
1077: catch(error) {
1078: writeHelp(caller);
1079: return;
1080: }
1081: if (newWindow) {
1082: caller = newWindow;
1083: }
1.193 raeburn 1084: }
1.243 raeburn 1085: writeHelp(caller);
1086: return;
1087: }
1088: function writeHelp(caller) {
1.430 albertel 1089: caller.document.writeln('$start_page<frame name="bannerframe" src="'+banner_link+'" /><frame name="bodyframe" src="$details_link" /> $end_page')
1.243 raeburn 1090: caller.document.close()
1091: caller.focus()
1.193 raeburn 1092: }
1.253 albertel 1093: // ]]>
1.219 albertel 1094: // END LON-CAPA Internal -->
1.436 albertel 1095: </script>
1.193 raeburn 1096: ENDTEMPLATE
1097: return $template;
1098: }
1099:
1.172 www 1100: sub help_open_bug {
1101: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1102: unless ($env{'user.adv'}) { return ''; }
1.172 www 1103: unless ($Apache::lonnet::perlvar{'BugzillaHost'}) { return ''; }
1104: $text = "" if (not defined $text);
1105: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1106: if ($env{'browser.interface'} eq 'textual' ||
1107: $env{'environment.remote'} eq 'off' ) {
1.172 www 1108: $stayOnPage=1;
1109: }
1.184 albertel 1110: $width = 600 if (not defined $width);
1111: $height = 600 if (not defined $height);
1.172 www 1112:
1113: $topic=~s/\W+/\+/g;
1114: my $link='';
1115: my $template='';
1.379 albertel 1116: my $url=$Apache::lonnet::perlvar{'BugzillaHost'}.'enter_bug.cgi?product=LON-CAPA&bug_file_loc='.
1117: &escape($ENV{'REQUEST_URI'}).'&component='.$topic;
1.172 www 1118: if (!$stayOnPage)
1119: {
1120: $link = "javascript:void(open('$url', 'Bugzilla', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1121: }
1122: else
1123: {
1124: $link = $url;
1125: }
1126: # Add the text
1127: if ($text ne "")
1128: {
1129: $template .=
1130: "<table bgcolor='#AA3333' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 1131: "<td bgcolor='#FF5555'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 1132: }
1133:
1134: # Add the graphic
1.179 matthew 1135: my $title = &mt('Report a Bug');
1.215 albertel 1136: my $bugicon=&lonhttpdurl("/adm/lonMisc/smallBug.gif");
1.172 www 1137: $template .= <<"ENDTEMPLATE";
1.436 albertel 1138: <a target="_top" href="$link" title="$title"><img src="$bugicon" border="0" alt="(Bug: $topic)" /></a>
1.172 www 1139: ENDTEMPLATE
1140: if ($text ne '') { $template.='</td></tr></table>' };
1141: return $template;
1142:
1143: }
1144:
1145: sub help_open_faq {
1146: my ($topic, $text, $stayOnPage, $width, $height) = @_;
1.258 albertel 1147: unless ($env{'user.adv'}) { return ''; }
1.172 www 1148: unless ($Apache::lonnet::perlvar{'FAQHost'}) { return ''; }
1149: $text = "" if (not defined $text);
1150: $stayOnPage = 0 if (not defined $stayOnPage);
1.258 albertel 1151: if ($env{'browser.interface'} eq 'textual' ||
1152: $env{'environment.remote'} eq 'off' ) {
1.172 www 1153: $stayOnPage=1;
1154: }
1155: $width = 350 if (not defined $width);
1156: $height = 400 if (not defined $height);
1157:
1158: $topic=~s/\W+/\+/g;
1159: my $link='';
1160: my $template='';
1161: my $url=$Apache::lonnet::perlvar{'FAQHost'}.'/fom/cache/'.$topic.'.html';
1162: if (!$stayOnPage)
1163: {
1164: $link = "javascript:void(open('$url', 'FAQ-O-Matic', 'menubar=0,toolbar=1,scrollbars=1,width=$width,height=$height,resizable=yes'))";
1165: }
1166: else
1167: {
1168: $link = $url;
1169: }
1170:
1171: # Add the text
1172: if ($text ne "")
1173: {
1174: $template .=
1.173 www 1175: "<table bgcolor='#337733' cellspacing='1' cellpadding='1' border='0'><tr>".
1.436 albertel 1176: "<td bgcolor='#448844'><a target=\"_top\" href=\"$link\"><font color='#FFFFFF' size='2'>$text</font></a>";
1.172 www 1177: }
1178:
1179: # Add the graphic
1.179 matthew 1180: my $title = &mt('View the FAQ');
1.215 albertel 1181: my $faqicon=&lonhttpdurl("/adm/lonMisc/smallFAQ.gif");
1.172 www 1182: $template .= <<"ENDTEMPLATE";
1.436 albertel 1183: <a target="_top" href="$link" title="$title"><img src="$faqicon" border="0" alt="(FAQ: $topic)" /></a>
1.172 www 1184: ENDTEMPLATE
1185: if ($text ne '') { $template.='</td></tr></table>' };
1186: return $template;
1187:
1.44 bowersj2 1188: }
1.37 matthew 1189:
1.180 matthew 1190: ###############################################################
1191: ###############################################################
1192:
1.45 matthew 1193: =pod
1194:
1.648 raeburn 1195: =item * &change_content_javascript():
1.256 matthew 1196:
1197: This and the next function allow you to create small sections of an
1198: otherwise static HTML page that you can update on the fly with
1199: Javascript, even in Netscape 4.
1200:
1201: The Javascript fragment returned by this function (no E<lt>scriptE<gt> tag)
1202: must be written to the HTML page once. It will prove the Javascript
1203: function "change(name, content)". Calling the change function with the
1204: name of the section
1205: you want to update, matching the name passed to C<changable_area>, and
1206: the new content you want to put in there, will put the content into
1207: that area.
1208:
1209: B<Note>: Netscape 4 only reserves enough space for the changable area
1210: to contain room for the original contents. You need to "make space"
1211: for whatever changes you wish to make, and be B<sure> to check your
1212: code in Netscape 4. This feature in Netscape 4 is B<not> powerful;
1213: it's adequate for updating a one-line status display, but little more.
1214: This script will set the space to 100% width, so you only need to
1215: worry about height in Netscape 4.
1216:
1217: Modern browsers are much less limiting, and if you can commit to the
1218: user not using Netscape 4, this feature may be used freely with
1219: pretty much any HTML.
1220:
1221: =cut
1222:
1223: sub change_content_javascript {
1224: # If we're on Netscape 4, we need to use Layer-based code
1.258 albertel 1225: if ($env{'browser.type'} eq 'netscape' &&
1226: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1227: return (<<NETSCAPE4);
1228: function change(name, content) {
1229: doc = document.layers[name+"___escape"].layers[0].document;
1230: doc.open();
1231: doc.write(content);
1232: doc.close();
1233: }
1234: NETSCAPE4
1235: } else {
1236: # Otherwise, we need to use semi-standards-compliant code
1237: # (technically, "innerHTML" isn't standard but the equivalent
1238: # is really scary, and every useful browser supports it
1239: return (<<DOMBASED);
1240: function change(name, content) {
1241: element = document.getElementById(name);
1242: element.innerHTML = content;
1243: }
1244: DOMBASED
1245: }
1246: }
1247:
1248: =pod
1249:
1.648 raeburn 1250: =item * &changable_area($name,$origContent):
1.256 matthew 1251:
1252: This provides a "changable area" that can be modified on the fly via
1253: the Javascript code provided in C<change_content_javascript>. $name is
1254: the name you will use to reference the area later; do not repeat the
1255: same name on a given HTML page more then once. $origContent is what
1256: the area will originally contain, which can be left blank.
1257:
1258: =cut
1259:
1260: sub changable_area {
1261: my ($name, $origContent) = @_;
1262:
1.258 albertel 1263: if ($env{'browser.type'} eq 'netscape' &&
1264: $env{'browser.version'} =~ /^4\./) {
1.256 matthew 1265: # If this is netscape 4, we need to use the Layer tag
1266: return "<ilayer width='100%' id='${name}___escape' overflow='none'><layer width='100%' id='$name' overflow='none'>$origContent</layer></ilayer>";
1267: } else {
1268: return "<span id='$name'>$origContent</span>";
1269: }
1270: }
1271:
1272: =pod
1273:
1.648 raeburn 1274: =item * &viewport_geometry_js
1.590 raeburn 1275:
1276: Provides javascript object (Geometry) which can provide information about the viewport geometry for the client browser.
1277:
1278: =cut
1279:
1280:
1281: sub viewport_geometry_js {
1282: return <<"GEOMETRY";
1283: var Geometry = {};
1284: function init_geometry() {
1285: if (Geometry.init) { return };
1286: Geometry.init=1;
1287: if (window.innerHeight) {
1288: Geometry.getViewportHeight = function() { return window.innerHeight; };
1289: Geometry.getViewportWidth = function() { return window.innerWidth; };
1290: Geometry.getHorizontalScroll = function() { return window.pageXOffset; };
1291: Geometry.getVerticalScroll = function() { return window.pageYOffset; };
1292: }
1293: else if (document.documentElement && document.documentElement.clientHeight) {
1294: Geometry.getViewportHeight =
1295: function() { return document.documentElement.clientHeight; };
1296: Geometry.getViewportWidth =
1297: function() { return document.documentElement.clientWidth; };
1298:
1299: Geometry.getHorizontalScroll =
1300: function() { return document.documentElement.scrollLeft; };
1301: Geometry.getVerticalScroll =
1302: function() { return document.documentElement.scrollTop; };
1303: }
1304: else if (document.body.clientHeight) {
1305: Geometry.getViewportHeight =
1306: function() { return document.body.clientHeight; };
1307: Geometry.getViewportWidth =
1308: function() { return document.body.clientWidth; };
1309: Geometry.getHorizontalScroll =
1310: function() { return document.body.scrollLeft; };
1311: Geometry.getVerticalScroll =
1312: function() { return document.body.scrollTop; };
1313: }
1314: }
1315:
1316: GEOMETRY
1317: }
1318:
1319: =pod
1320:
1.648 raeburn 1321: =item * &viewport_size_js()
1.590 raeburn 1322:
1323: Provides a javascript function to set values of two form elements - width and height (elements are passed in as arguments to the javascript function) to the dimensions of the user's browser window.
1324:
1325: =cut
1326:
1327: sub viewport_size_js {
1328: my $geometry = &viewport_geometry_js();
1329: return <<"DIMS";
1330:
1331: $geometry
1332:
1333: function getViewportDims(width,height) {
1334: init_geometry();
1335: width.value = Geometry.getViewportWidth();
1336: height.value = Geometry.getViewportHeight();
1337: return;
1338: }
1339:
1340: DIMS
1341: }
1342:
1343: =pod
1344:
1.648 raeburn 1345: =item * &resize_textarea_js()
1.565 albertel 1346:
1347: emits the needed javascript to resize a textarea to be as big as possible
1348:
1349: creates a function resize_textrea that takes two IDs first should be
1350: the id of the element to resize, second should be the id of a div that
1351: surrounds everything that comes after the textarea, this routine needs
1352: to be attached to the <body> for the onload and onresize events.
1353:
1.648 raeburn 1354: =back
1.565 albertel 1355:
1356: =cut
1357:
1358: sub resize_textarea_js {
1.590 raeburn 1359: my $geometry = &viewport_geometry_js();
1.565 albertel 1360: return <<"RESIZE";
1361: <script type="text/javascript">
1.590 raeburn 1362: $geometry
1.565 albertel 1363:
1.588 albertel 1364: function getX(element) {
1365: var x = 0;
1366: while (element) {
1367: x += element.offsetLeft;
1368: element = element.offsetParent;
1369: }
1370: return x;
1371: }
1372: function getY(element) {
1373: var y = 0;
1374: while (element) {
1375: y += element.offsetTop;
1376: element = element.offsetParent;
1377: }
1378: return y;
1379: }
1380:
1381:
1.565 albertel 1382: function resize_textarea(textarea_id,bottom_id) {
1383: init_geometry();
1384: var textarea = document.getElementById(textarea_id);
1385: //alert(textarea);
1386:
1.588 albertel 1387: var textarea_top = getY(textarea);
1.565 albertel 1388: var textarea_height = textarea.offsetHeight;
1389: var bottom = document.getElementById(bottom_id);
1.588 albertel 1390: var bottom_top = getY(bottom);
1.565 albertel 1391: var bottom_height = bottom.offsetHeight;
1392: var window_height = Geometry.getViewportHeight();
1.588 albertel 1393: var fudge = 23;
1.565 albertel 1394: var new_height = window_height-fudge-textarea_top-bottom_height;
1395: if (new_height < 300) {
1396: new_height = 300;
1397: }
1398: textarea.style.height=new_height+'px';
1399: }
1400: </script>
1401: RESIZE
1402:
1403: }
1404:
1405: =pod
1406:
1.256 matthew 1407: =head1 Excel and CSV file utility routines
1408:
1409: =over 4
1410:
1411: =cut
1412:
1413: ###############################################################
1414: ###############################################################
1415:
1416: =pod
1417:
1.648 raeburn 1418: =item * &csv_translate($text)
1.37 matthew 1419:
1.185 www 1420: Translate $text to allow it to be output as a 'comma separated values'
1.37 matthew 1421: format.
1422:
1423: =cut
1424:
1.180 matthew 1425: ###############################################################
1426: ###############################################################
1.37 matthew 1427: sub csv_translate {
1428: my $text = shift;
1429: $text =~ s/\"/\"\"/g;
1.209 albertel 1430: $text =~ s/\n/ /g;
1.37 matthew 1431: return $text;
1432: }
1.180 matthew 1433:
1434: ###############################################################
1435: ###############################################################
1436:
1437: =pod
1438:
1.648 raeburn 1439: =item * &define_excel_formats()
1.180 matthew 1440:
1441: Define some commonly used Excel cell formats.
1442:
1443: Currently supported formats:
1444:
1445: =over 4
1446:
1447: =item header
1448:
1449: =item bold
1450:
1451: =item h1
1452:
1453: =item h2
1454:
1455: =item h3
1456:
1.256 matthew 1457: =item h4
1458:
1459: =item i
1460:
1.180 matthew 1461: =item date
1462:
1463: =back
1464:
1465: Inputs: $workbook
1466:
1467: Returns: $format, a hash reference.
1468:
1469: =cut
1470:
1471: ###############################################################
1472: ###############################################################
1473: sub define_excel_formats {
1474: my ($workbook) = @_;
1475: my $format;
1476: $format->{'header'} = $workbook->add_format(bold => 1,
1477: bottom => 1,
1478: align => 'center');
1479: $format->{'bold'} = $workbook->add_format(bold=>1);
1480: $format->{'h1'} = $workbook->add_format(bold=>1, size=>18);
1481: $format->{'h2'} = $workbook->add_format(bold=>1, size=>16);
1482: $format->{'h3'} = $workbook->add_format(bold=>1, size=>14);
1.255 matthew 1483: $format->{'h4'} = $workbook->add_format(bold=>1, size=>12);
1.246 matthew 1484: $format->{'i'} = $workbook->add_format(italic=>1);
1.180 matthew 1485: $format->{'date'} = $workbook->add_format(num_format=>
1.207 matthew 1486: 'mm/dd/yyyy hh:mm:ss');
1.180 matthew 1487: return $format;
1488: }
1489:
1490: ###############################################################
1491: ###############################################################
1.113 bowersj2 1492:
1493: =pod
1494:
1.648 raeburn 1495: =item * &create_workbook()
1.255 matthew 1496:
1497: Create an Excel worksheet. If it fails, output message on the
1498: request object and return undefs.
1499:
1500: Inputs: Apache request object
1501:
1502: Returns (undef) on failure,
1503: Excel worksheet object, scalar with filename, and formats
1504: from &Apache::loncommon::define_excel_formats on success
1505:
1506: =cut
1507:
1508: ###############################################################
1509: ###############################################################
1510: sub create_workbook {
1511: my ($r) = @_;
1512: #
1513: # Create the excel spreadsheet
1514: my $filename = '/prtspool/'.
1.258 albertel 1515: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.255 matthew 1516: time.'_'.rand(1000000000).'.xls';
1517: my $workbook = Spreadsheet::WriteExcel->new('/home/httpd'.$filename);
1518: if (! defined($workbook)) {
1519: $r->log_error("Error creating excel spreadsheet $filename: $!");
1520: $r->print('<p>'.&mt("Unable to create new Excel file. ".
1521: "This error has been logged. ".
1522: "Please alert your LON-CAPA administrator").
1523: '</p>');
1524: return (undef);
1525: }
1526: #
1527: $workbook->set_tempdir('/home/httpd/perl/tmp');
1528: #
1529: my $format = &Apache::loncommon::define_excel_formats($workbook);
1530: return ($workbook,$filename,$format);
1531: }
1532:
1533: ###############################################################
1534: ###############################################################
1535:
1536: =pod
1537:
1.648 raeburn 1538: =item * &create_text_file()
1.113 bowersj2 1539:
1.542 raeburn 1540: Create a file to write to and eventually make available to the user.
1.256 matthew 1541: If file creation fails, outputs an error message on the request object and
1542: return undefs.
1.113 bowersj2 1543:
1.256 matthew 1544: Inputs: Apache request object, and file suffix
1.113 bowersj2 1545:
1.256 matthew 1546: Returns (undef) on failure,
1547: Filehandle and filename on success.
1.113 bowersj2 1548:
1549: =cut
1550:
1.256 matthew 1551: ###############################################################
1552: ###############################################################
1553: sub create_text_file {
1554: my ($r,$suffix) = @_;
1555: if (! defined($suffix)) { $suffix = 'txt'; };
1556: my $fh;
1557: my $filename = '/prtspool/'.
1.258 albertel 1558: $env{'user.name'}.'_'.$env{'user.domain'}.'_'.
1.256 matthew 1559: time.'_'.rand(1000000000).'.'.$suffix;
1560: $fh = Apache::File->new('>/home/httpd'.$filename);
1561: if (! defined($fh)) {
1562: $r->log_error("Couldn't open $filename for output $!");
1.683 bisitz 1563: $r->print(&mt('Problems occurred in creating the output file. '
1564: .'This error has been logged. '
1565: .'Please alert your LON-CAPA administrator.'));
1.113 bowersj2 1566: }
1.256 matthew 1567: return ($fh,$filename)
1.113 bowersj2 1568: }
1569:
1570:
1.256 matthew 1571: =pod
1.113 bowersj2 1572:
1573: =back
1574:
1575: =cut
1.37 matthew 1576:
1577: ###############################################################
1.33 matthew 1578: ## Home server <option> list generating code ##
1579: ###############################################################
1.35 matthew 1580:
1.169 www 1581: # ------------------------------------------
1582:
1583: sub domain_select {
1584: my ($name,$value,$multiple)=@_;
1585: my %domains=map {
1.514 albertel 1586: $_ => $_.' '. &Apache::lonnet::domain($_,'description')
1.512 albertel 1587: } &Apache::lonnet::all_domains();
1.169 www 1588: if ($multiple) {
1589: $domains{''}=&mt('Any domain');
1.550 albertel 1590: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.287 albertel 1591: return &multiple_select_form($name,$value,4,\%domains);
1.169 www 1592: } else {
1.550 albertel 1593: $domains{'select_form_order'} = [sort {lc($a) cmp lc($b) } (keys(%domains))];
1.169 www 1594: return &select_form($name,$value,%domains);
1595: }
1596: }
1597:
1.282 albertel 1598: #-------------------------------------------
1599:
1600: =pod
1601:
1.519 raeburn 1602: =head1 Routines for form select boxes
1603:
1604: =over 4
1605:
1.648 raeburn 1606: =item * &multiple_select_form($name,$value,$size,$hash,$order)
1.282 albertel 1607:
1608: Returns a string containing a <select> element int multiple mode
1609:
1610:
1611: Args:
1612: $name - name of the <select> element
1.506 raeburn 1613: $value - scalar or array ref of values that should already be selected
1.282 albertel 1614: $size - number of rows long the select element is
1.283 albertel 1615: $hash - the elements should be 'option' => 'shown text'
1.282 albertel 1616: (shown text should already have been &mt())
1.506 raeburn 1617: $order - (optional) array ref of the order to show the elements in
1.283 albertel 1618:
1.282 albertel 1619: =cut
1620:
1621: #-------------------------------------------
1.169 www 1622: sub multiple_select_form {
1.284 albertel 1623: my ($name,$value,$size,$hash,$order)=@_;
1.169 www 1624: my %selected = map { $_ => 1 } ref($value)?@{$value}:($value);
1625: my $output='';
1.191 matthew 1626: if (! defined($size)) {
1627: $size = 4;
1.283 albertel 1628: if (scalar(keys(%$hash))<4) {
1629: $size = scalar(keys(%$hash));
1.191 matthew 1630: }
1631: }
1.169 www 1632: $output.="\n<select name='$name' size='$size' multiple='1'>";
1.501 banghart 1633: my @order;
1.506 raeburn 1634: if (ref($order) eq 'ARRAY') {
1635: @order = @{$order};
1636: } else {
1637: @order = sort(keys(%$hash));
1.501 banghart 1638: }
1639: if (exists($$hash{'select_form_order'})) {
1640: @order = @{$$hash{'select_form_order'}};
1641: }
1642:
1.284 albertel 1643: foreach my $key (@order) {
1.356 albertel 1644: $output.='<option value="'.&HTML::Entities::encode($key,'"<>&').'" ';
1.284 albertel 1645: $output.='selected="selected" ' if ($selected{$key});
1646: $output.='>'.$hash->{$key}."</option>\n";
1.169 www 1647: }
1648: $output.="</select>\n";
1649: return $output;
1650: }
1651:
1.88 www 1652: #-------------------------------------------
1653:
1654: =pod
1655:
1.648 raeburn 1656: =item * &select_form($defdom,$name,%hash)
1.88 www 1657:
1658: Returns a string containing a <select name='$name' size='1'> form to
1659: allow a user to select options from a hash option_name => displayed text.
1660: See lonrights.pm for an example invocation and use.
1661:
1662: =cut
1663:
1664: #-------------------------------------------
1665: sub select_form {
1666: my ($def,$name,%hash) = @_;
1667: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1.128 albertel 1668: my @keys;
1669: if (exists($hash{'select_form_order'})) {
1670: @keys=@{$hash{'select_form_order'}};
1671: } else {
1672: @keys=sort(keys(%hash));
1673: }
1.356 albertel 1674: foreach my $key (@keys) {
1675: $selectform.=
1676: '<option value="'.&HTML::Entities::encode($key,'"<>&').'" '.
1677: ($key eq $def ? 'selected="selected" ' : '').
1678: ">".&mt($hash{$key})."</option>\n";
1.88 www 1679: }
1680: $selectform.="</select>";
1681: return $selectform;
1682: }
1683:
1.475 www 1684: # For display filters
1685:
1686: sub display_filter {
1687: if (!$env{'form.show'}) { $env{'form.show'}=10; }
1.477 www 1688: if (!$env{'form.displayfilter'}) { $env{'form.displayfilter'}='currentfolder'; }
1.475 www 1689: return '<nobr><label>'.&mt('Records [_1]',
1690: &Apache::lonmeta::selectbox('show',$env{'form.show'},undef,
1691: (&mt('all'),10,20,50,100,1000,10000))).
1.478 www 1692: '</label></nobr> <nobr>'.
1.475 www 1693: &mt('Filter [_1]',
1.477 www 1694: &select_form($env{'form.displayfilter'},
1695: 'displayfilter',
1696: ('currentfolder' => 'Current folder/page',
1697: 'containing' => 'Containing phrase',
1698: 'none' => 'None'))).
1.478 www 1699: '<input type="text" name="containingphrase" size="30" value="'.&HTML::Entities::encode($env{'form.containingphrase'}).'" /></nobr>';
1.475 www 1700: }
1701:
1.167 www 1702: sub gradeleveldescription {
1703: my $gradelevel=shift;
1704: my %gradelevels=(0 => 'Not specified',
1705: 1 => 'Grade 1',
1706: 2 => 'Grade 2',
1707: 3 => 'Grade 3',
1708: 4 => 'Grade 4',
1709: 5 => 'Grade 5',
1710: 6 => 'Grade 6',
1711: 7 => 'Grade 7',
1712: 8 => 'Grade 8',
1713: 9 => 'Grade 9',
1714: 10 => 'Grade 10',
1715: 11 => 'Grade 11',
1716: 12 => 'Grade 12',
1717: 13 => 'Grade 13',
1718: 14 => '100 Level',
1719: 15 => '200 Level',
1720: 16 => '300 Level',
1721: 17 => '400 Level',
1722: 18 => 'Graduate Level');
1723: return &mt($gradelevels{$gradelevel});
1724: }
1725:
1.163 www 1726: sub select_level_form {
1727: my ($deflevel,$name)=@_;
1728: unless ($deflevel) { $deflevel=0; }
1.167 www 1729: my $selectform = "<select name=\"$name\" size=\"1\">\n";
1730: for (my $i=0; $i<=18; $i++) {
1731: $selectform.="<option value=\"$i\" ".
1.253 albertel 1732: ($i==$deflevel ? 'selected="selected" ' : '').
1.167 www 1733: ">".&gradeleveldescription($i)."</option>\n";
1734: }
1735: $selectform.="</select>";
1736: return $selectform;
1.163 www 1737: }
1.167 www 1738:
1.35 matthew 1739: #-------------------------------------------
1740:
1.45 matthew 1741: =pod
1742:
1.648 raeburn 1743: =item * &select_dom_form($defdom,$name,$includeempty,$showdomdesc)
1.35 matthew 1744:
1745: Returns a string containing a <select name='$name' size='1'> form to
1746: allow a user to select the domain to preform an operation in.
1747: See loncreateuser.pm for an example invocation and use.
1748:
1.90 www 1749: If the $includeempty flag is set, it also includes an empty choice ("no domain
1750: selected");
1751:
1.563 raeburn 1752: If the $showdomdesc flag is set, the domain name is followed by the domain description.
1753:
1.35 matthew 1754: =cut
1755:
1756: #-------------------------------------------
1.34 matthew 1757: sub select_dom_form {
1.563 raeburn 1758: my ($defdom,$name,$includeempty,$showdomdesc) = @_;
1.550 albertel 1759: my @domains = sort {lc($a) cmp lc($b)} (&Apache::lonnet::all_domains());
1.90 www 1760: if ($includeempty) { @domains=('',@domains); }
1.34 matthew 1761: my $selectdomain = "<select name=\"$name\" size=\"1\">\n";
1.356 albertel 1762: foreach my $dom (@domains) {
1763: $selectdomain.="<option value=\"$dom\" ".
1.563 raeburn 1764: ($dom eq $defdom ? 'selected="selected" ' : '').'>'.$dom;
1765: if ($showdomdesc) {
1766: if ($dom ne '') {
1767: my $domdesc = &Apache::lonnet::domain($dom,'description');
1768: if ($domdesc ne '') {
1769: $selectdomain .= ' ('.$domdesc.')';
1770: }
1771: }
1772: }
1773: $selectdomain .= "</option>\n";
1.34 matthew 1774: }
1775: $selectdomain.="</select>";
1776: return $selectdomain;
1777: }
1778:
1.35 matthew 1779: #-------------------------------------------
1780:
1.45 matthew 1781: =pod
1782:
1.648 raeburn 1783: =item * &home_server_form_item($domain,$name,$defaultflag)
1.35 matthew 1784:
1.586 raeburn 1785: input: 4 arguments (two required, two optional) -
1786: $domain - domain of new user
1787: $name - name of form element
1788: $default - Value of 'default' causes a default item to be first
1789: option, and selected by default.
1790: $hide - Value of 'hide' causes hiding of the name of the server,
1791: if 1 server found, or default, if 0 found.
1.594 raeburn 1792: output: returns 2 items:
1.586 raeburn 1793: (a) form element which contains either:
1794: (i) <select name="$name">
1795: <option value="$hostid1">$hostid $servers{$hostid}</option>
1796: <option value="$hostid2">$hostid $servers{$hostid}</option>
1797: </select>
1798: form item if there are multiple library servers in $domain, or
1799: (ii) an <input type="hidden" name="$name" value="$hostid" /> form item
1800: if there is only one library server in $domain.
1801:
1802: (b) number of library servers found.
1803:
1804: See loncreateuser.pm for example of use.
1.35 matthew 1805:
1806: =cut
1807:
1808: #-------------------------------------------
1.586 raeburn 1809: sub home_server_form_item {
1810: my ($domain,$name,$default,$hide) = @_;
1.513 albertel 1811: my %servers = &Apache::lonnet::get_servers($domain,'library');
1.586 raeburn 1812: my $result;
1813: my $numlib = keys(%servers);
1814: if ($numlib > 1) {
1815: $result .= '<select name="'.$name.'" />'."\n";
1816: if ($default) {
1817: $result .= '<option value="default" selected>'.&mt('default').
1818: '</option>'."\n";
1819: }
1820: foreach my $hostid (sort(keys(%servers))) {
1821: $result.= '<option value="'.$hostid.'">'.
1822: $hostid.' '.$servers{$hostid}."</option>\n";
1823: }
1824: $result .= '</select>'."\n";
1825: } elsif ($numlib == 1) {
1826: my $hostid;
1827: foreach my $item (keys(%servers)) {
1828: $hostid = $item;
1829: }
1830: $result .= '<input type="hidden" name="'.$name.'" value="'.
1831: $hostid.'" />';
1832: if (!$hide) {
1833: $result .= $hostid.' '.$servers{$hostid};
1834: }
1835: $result .= "\n";
1836: } elsif ($default) {
1837: $result .= '<input type="hidden" name="'.$name.
1838: '" value="default" />';
1839: if (!$hide) {
1840: $result .= &mt('default');
1841: }
1842: $result .= "\n";
1.33 matthew 1843: }
1.586 raeburn 1844: return ($result,$numlib);
1.33 matthew 1845: }
1.112 bowersj2 1846:
1847: =pod
1848:
1.534 albertel 1849: =back
1850:
1.112 bowersj2 1851: =cut
1.87 matthew 1852:
1853: ###############################################################
1.112 bowersj2 1854: ## Decoding User Agent ##
1.87 matthew 1855: ###############################################################
1856:
1857: =pod
1858:
1.112 bowersj2 1859: =head1 Decoding the User Agent
1860:
1861: =over 4
1862:
1863: =item * &decode_user_agent()
1.87 matthew 1864:
1865: Inputs: $r
1866:
1867: Outputs:
1868:
1869: =over 4
1870:
1.112 bowersj2 1871: =item * $httpbrowser
1.87 matthew 1872:
1.112 bowersj2 1873: =item * $clientbrowser
1.87 matthew 1874:
1.112 bowersj2 1875: =item * $clientversion
1.87 matthew 1876:
1.112 bowersj2 1877: =item * $clientmathml
1.87 matthew 1878:
1.112 bowersj2 1879: =item * $clientunicode
1.87 matthew 1880:
1.112 bowersj2 1881: =item * $clientos
1.87 matthew 1882:
1883: =back
1884:
1.157 matthew 1885: =back
1886:
1.87 matthew 1887: =cut
1888:
1889: ###############################################################
1890: ###############################################################
1891: sub decode_user_agent {
1.247 albertel 1892: my ($r)=@_;
1.87 matthew 1893: my @browsertype=split(/\&/,$Apache::lonnet::perlvar{"lonBrowsDet"});
1894: my %mathcap=split(/\&/,$$Apache::lonnet::perlvar{"lonMathML"});
1895: my $httpbrowser=$ENV{"HTTP_USER_AGENT"};
1.247 albertel 1896: if (!$httpbrowser && $r) { $httpbrowser=$r->header_in('User-Agent'); }
1.87 matthew 1897: my $clientbrowser='unknown';
1898: my $clientversion='0';
1899: my $clientmathml='';
1900: my $clientunicode='0';
1901: for (my $i=0;$i<=$#browsertype;$i++) {
1902: my ($bname,$match,$notmatch,$vreg,$minv,$univ)=split(/\:/,$browsertype[$i]);
1903: if (($httpbrowser=~/$match/i) && ($httpbrowser!~/$notmatch/i)) {
1904: $clientbrowser=$bname;
1905: $httpbrowser=~/$vreg/i;
1906: $clientversion=$1;
1907: $clientmathml=($clientversion>=$minv);
1908: $clientunicode=($clientversion>=$univ);
1909: }
1910: }
1911: my $clientos='unknown';
1912: if (($httpbrowser=~/linux/i) ||
1913: ($httpbrowser=~/unix/i) ||
1914: ($httpbrowser=~/ux/i) ||
1915: ($httpbrowser=~/solaris/i)) { $clientos='unix'; }
1916: if (($httpbrowser=~/vax/i) ||
1917: ($httpbrowser=~/vms/i)) { $clientos='vms'; }
1918: if ($httpbrowser=~/next/i) { $clientos='next'; }
1919: if (($httpbrowser=~/mac/i) ||
1920: ($httpbrowser=~/powerpc/i)) { $clientos='mac'; }
1921: if ($httpbrowser=~/win/i) { $clientos='win'; }
1922: if ($httpbrowser=~/embed/i) { $clientos='pda'; }
1923: return ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
1924: $clientunicode,$clientos,);
1925: }
1926:
1.32 matthew 1927: ###############################################################
1928: ## Authentication changing form generation subroutines ##
1929: ###############################################################
1930: ##
1931: ## All of the authform_xxxxxxx subroutines take their inputs in a
1932: ## hash, and have reasonable default values.
1933: ##
1934: ## formname = the name given in the <form> tag.
1.35 matthew 1935: #-------------------------------------------
1936:
1.45 matthew 1937: =pod
1938:
1.112 bowersj2 1939: =head1 Authentication Routines
1940:
1941: =over 4
1942:
1.648 raeburn 1943: =item * &authform_xxxxxx()
1.35 matthew 1944:
1945: The authform_xxxxxx subroutines provide javascript and html forms which
1946: handle some of the conveniences required for authentication forms.
1947: This is not an optimal method, but it works.
1948:
1949: =over 4
1950:
1.112 bowersj2 1951: =item * authform_header
1.35 matthew 1952:
1.112 bowersj2 1953: =item * authform_authorwarning
1.35 matthew 1954:
1.112 bowersj2 1955: =item * authform_nochange
1.35 matthew 1956:
1.112 bowersj2 1957: =item * authform_kerberos
1.35 matthew 1958:
1.112 bowersj2 1959: =item * authform_internal
1.35 matthew 1960:
1.112 bowersj2 1961: =item * authform_filesystem
1.35 matthew 1962:
1963: =back
1964:
1.648 raeburn 1965: See loncreateuser.pm for invocation and use examples.
1.157 matthew 1966:
1.35 matthew 1967: =cut
1968:
1969: #-------------------------------------------
1.32 matthew 1970: sub authform_header{
1971: my %in = (
1972: formname => 'cu',
1.80 albertel 1973: kerb_def_dom => '',
1.32 matthew 1974: @_,
1975: );
1976: $in{'formname'} = 'document.' . $in{'formname'};
1977: my $result='';
1.80 albertel 1978:
1979: #---------------------------------------------- Code for upper case translation
1980: my $Javascript_toUpperCase;
1981: unless ($in{kerb_def_dom}) {
1982: $Javascript_toUpperCase =<<"END";
1983: switch (choice) {
1984: case 'krb': currentform.elements[choicearg].value =
1985: currentform.elements[choicearg].value.toUpperCase();
1986: break;
1987: default:
1988: }
1989: END
1990: } else {
1991: $Javascript_toUpperCase = "";
1992: }
1993:
1.165 raeburn 1994: my $radioval = "'nochange'";
1.591 raeburn 1995: if (defined($in{'curr_authtype'})) {
1996: if ($in{'curr_authtype'} ne '') {
1997: $radioval = "'".$in{'curr_authtype'}."arg'";
1998: }
1.174 matthew 1999: }
1.165 raeburn 2000: my $argfield = 'null';
1.591 raeburn 2001: if (defined($in{'mode'})) {
1.165 raeburn 2002: if ($in{'mode'} eq 'modifycourse') {
1.591 raeburn 2003: if (defined($in{'curr_autharg'})) {
2004: if ($in{'curr_autharg'} ne '') {
1.165 raeburn 2005: $argfield = "'$in{'curr_autharg'}'";
2006: }
2007: }
2008: }
2009: }
2010:
1.32 matthew 2011: $result.=<<"END";
2012: var current = new Object();
1.165 raeburn 2013: current.radiovalue = $radioval;
2014: current.argfield = $argfield;
1.32 matthew 2015:
2016: function changed_radio(choice,currentform) {
2017: var choicearg = choice + 'arg';
2018: // If a radio button in changed, we need to change the argfield
2019: if (current.radiovalue != choice) {
2020: current.radiovalue = choice;
2021: if (current.argfield != null) {
2022: currentform.elements[current.argfield].value = '';
2023: }
2024: if (choice == 'nochange') {
2025: current.argfield = null;
2026: } else {
2027: current.argfield = choicearg;
2028: switch(choice) {
2029: case 'krb':
2030: currentform.elements[current.argfield].value =
2031: "$in{'kerb_def_dom'}";
2032: break;
2033: default:
2034: break;
2035: }
2036: }
2037: }
2038: return;
2039: }
1.22 www 2040:
1.32 matthew 2041: function changed_text(choice,currentform) {
2042: var choicearg = choice + 'arg';
2043: if (currentform.elements[choicearg].value !='') {
1.80 albertel 2044: $Javascript_toUpperCase
1.32 matthew 2045: // clear old field
2046: if ((current.argfield != choicearg) && (current.argfield != null)) {
2047: currentform.elements[current.argfield].value = '';
2048: }
2049: current.argfield = choicearg;
2050: }
2051: set_auth_radio_buttons(choice,currentform);
2052: return;
1.20 www 2053: }
1.32 matthew 2054:
2055: function set_auth_radio_buttons(newvalue,currentform) {
2056: var i=0;
2057: while (i < currentform.login.length) {
2058: if (currentform.login[i].value == newvalue) { break; }
2059: i++;
2060: }
2061: if (i == currentform.login.length) {
2062: return;
2063: }
2064: current.radiovalue = newvalue;
2065: currentform.login[i].checked = true;
2066: return;
2067: }
2068: END
2069: return $result;
2070: }
2071:
2072: sub authform_authorwarning{
2073: my $result='';
1.144 matthew 2074: $result='<i>'.
2075: &mt('As a general rule, only authors or co-authors should be '.
2076: 'filesystem authenticated '.
2077: '(which allows access to the server filesystem).')."</i>\n";
1.32 matthew 2078: return $result;
2079: }
2080:
2081: sub authform_nochange{
2082: my %in = (
2083: formname => 'document.cu',
2084: kerb_def_dom => 'MSU.EDU',
2085: @_,
2086: );
1.586 raeburn 2087: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
2088: my $result;
2089: if (keys(%can_assign) == 0) {
2090: $result = &mt('Under you current role you are not permitted to change login settings for this user');
2091: } else {
2092: $result = '<label>'.&mt('[_1] Do not change login data',
2093: '<input type="radio" name="login" value="nochange" '.
2094: 'checked="checked" onclick="'.
1.281 albertel 2095: "javascript:changed_radio('nochange',$in{'formname'});".'" />').
2096: '</label>';
1.586 raeburn 2097: }
1.32 matthew 2098: return $result;
2099: }
2100:
1.591 raeburn 2101: sub authform_kerberos {
1.32 matthew 2102: my %in = (
2103: formname => 'document.cu',
2104: kerb_def_dom => 'MSU.EDU',
1.80 albertel 2105: kerb_def_auth => 'krb4',
1.32 matthew 2106: @_,
2107: );
1.586 raeburn 2108: my ($check4,$check5,$krbcheck,$krbarg,$krbver,$result,$authtype,
2109: $autharg,$jscall);
2110: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.80 albertel 2111: if ($in{'kerb_def_auth'} eq 'krb5') {
1.586 raeburn 2112: $check5 = ' checked="on"';
1.80 albertel 2113: } else {
1.586 raeburn 2114: $check4 = ' checked="on"';
1.80 albertel 2115: }
1.165 raeburn 2116: $krbarg = $in{'kerb_def_dom'};
1.591 raeburn 2117: if (defined($in{'curr_authtype'})) {
2118: if ($in{'curr_authtype'} eq 'krb') {
1.586 raeburn 2119: $krbcheck = ' checked="on"';
1.623 raeburn 2120: if (defined($in{'mode'})) {
2121: if ($in{'mode'} eq 'modifyuser') {
2122: $krbcheck = '';
2123: }
2124: }
1.591 raeburn 2125: if (defined($in{'curr_kerb_ver'})) {
2126: if ($in{'curr_krb_ver'} eq '5') {
2127: $check5 = ' checked="on"';
2128: $check4 = '';
2129: } else {
2130: $check4 = ' checked="on"';
2131: $check5 = '';
2132: }
1.586 raeburn 2133: }
1.591 raeburn 2134: if (defined($in{'curr_autharg'})) {
1.165 raeburn 2135: $krbarg = $in{'curr_autharg'};
2136: }
1.586 raeburn 2137: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
1.591 raeburn 2138: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2139: $result =
2140: &mt('Currently Kerberos authenticated with domain [_1] Version [_2].',
2141: $in{'curr_autharg'},$krbver);
2142: } else {
2143: $result =
2144: &mt('Currently Kerberos authenticated, Version [_1].',$krbver);
2145: }
2146: return $result;
2147: }
2148: }
2149: } else {
2150: if ($authnum == 1) {
2151: $authtype = '<input type="hidden" name="login" value="krb">';
1.165 raeburn 2152: }
2153: }
1.586 raeburn 2154: if (!$can_assign{'krb4'} && !$can_assign{'krb5'}) {
2155: return;
1.587 raeburn 2156: } elsif ($authtype eq '') {
1.591 raeburn 2157: if (defined($in{'mode'})) {
1.587 raeburn 2158: if ($in{'mode'} eq 'modifycourse') {
2159: if ($authnum == 1) {
2160: $authtype = '<input type="hidden" name="login" value="krb">';
2161: }
2162: }
2163: }
1.586 raeburn 2164: }
2165: $jscall = "javascript:changed_radio('krb',$in{'formname'});";
2166: if ($authtype eq '') {
2167: $authtype = '<input type="radio" name="login" value="krb" '.
2168: 'onclick="'.$jscall.'" onchange="'.$jscall.'"'.
2169: $krbcheck.' />';
2170: }
2171: if (($can_assign{'krb4'} && $can_assign{'krb5'}) ||
2172: ($can_assign{'krb4'} && !$can_assign{'krb5'} &&
2173: $in{'curr_authtype'} eq 'krb5') ||
2174: (!$can_assign{'krb4'} && $can_assign{'krb5'} &&
2175: $in{'curr_authtype'} eq 'krb4')) {
2176: $result .= &mt
1.144 matthew 2177: ('[_1] Kerberos authenticated with domain [_2] '.
1.281 albertel 2178: '[_3] Version 4 [_4] Version 5 [_5]',
1.586 raeburn 2179: '<label>'.$authtype,
1.281 albertel 2180: '</label><input type="text" size="10" name="krbarg" '.
1.165 raeburn 2181: 'value="'.$krbarg.'" '.
1.144 matthew 2182: 'onchange="'.$jscall.'" />',
1.281 albertel 2183: '<label><input type="radio" name="krbver" value="4" '.$check4.' />',
2184: '</label><label><input type="radio" name="krbver" value="5" '.$check5.' />',
2185: '</label>');
1.586 raeburn 2186: } elsif ($can_assign{'krb4'}) {
2187: $result .= &mt
2188: ('[_1] Kerberos authenticated with domain [_2] '.
2189: '[_3] Version 4 [_4]',
2190: '<label>'.$authtype,
2191: '</label><input type="text" size="10" name="krbarg" '.
2192: 'value="'.$krbarg.'" '.
2193: 'onchange="'.$jscall.'" />',
2194: '<label><input type="hidden" name="krbver" value="4" />',
2195: '</label>');
2196: } elsif ($can_assign{'krb5'}) {
2197: $result .= &mt
2198: ('[_1] Kerberos authenticated with domain [_2] '.
2199: '[_3] Version 5 [_4]',
2200: '<label>'.$authtype,
2201: '</label><input type="text" size="10" name="krbarg" '.
2202: 'value="'.$krbarg.'" '.
2203: 'onchange="'.$jscall.'" />',
2204: '<label><input type="hidden" name="krbver" value="5" />',
2205: '</label>');
2206: }
1.32 matthew 2207: return $result;
2208: }
2209:
2210: sub authform_internal{
1.586 raeburn 2211: my %in = (
1.32 matthew 2212: formname => 'document.cu',
2213: kerb_def_dom => 'MSU.EDU',
2214: @_,
2215: );
1.586 raeburn 2216: my ($intcheck,$intarg,$result,$authtype,$autharg,$jscall);
2217: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2218: if (defined($in{'curr_authtype'})) {
2219: if ($in{'curr_authtype'} eq 'int') {
1.586 raeburn 2220: if ($can_assign{'int'}) {
2221: $intcheck = 'checked="on" ';
1.623 raeburn 2222: if (defined($in{'mode'})) {
2223: if ($in{'mode'} eq 'modifyuser') {
2224: $intcheck = '';
2225: }
2226: }
1.591 raeburn 2227: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2228: $intarg = $in{'curr_autharg'};
2229: }
2230: } else {
2231: $result = &mt('Currently internally authenticated.');
2232: return $result;
1.165 raeburn 2233: }
2234: }
1.586 raeburn 2235: } else {
2236: if ($authnum == 1) {
2237: $authtype = '<input type="hidden" name="login" value="int">';
2238: }
2239: }
2240: if (!$can_assign{'int'}) {
2241: return;
1.587 raeburn 2242: } elsif ($authtype eq '') {
1.591 raeburn 2243: if (defined($in{'mode'})) {
1.587 raeburn 2244: if ($in{'mode'} eq 'modifycourse') {
2245: if ($authnum == 1) {
2246: $authtype = '<input type="hidden" name="login" value="int">';
2247: }
2248: }
2249: }
1.165 raeburn 2250: }
1.586 raeburn 2251: $jscall = "javascript:changed_radio('int',$in{'formname'});";
2252: if ($authtype eq '') {
2253: $authtype = '<input type="radio" name="login" value="int" '.$intcheck.
2254: ' onchange="'.$jscall.'" onclick="'.$jscall.'" />';
2255: }
1.605 bisitz 2256: $autharg = '<input type="password" size="10" name="intarg" value="'.
1.586 raeburn 2257: $intarg.'" onchange="'.$jscall.'" />';
2258: $result = &mt
1.144 matthew 2259: ('[_1] Internally authenticated (with initial password [_2])',
1.586 raeburn 2260: '<label>'.$authtype,'</label>'.$autharg);
1.620 www 2261: $result.="<label><input type=\"checkbox\" name=\"visible\" onClick='if (this.checked) { this.form.intarg.type=\"text\" } else { this.form.intarg.type=\"password\" }' />".&mt('Visible input').'</label>';
1.32 matthew 2262: return $result;
2263: }
2264:
2265: sub authform_local{
2266: my %in = (
2267: formname => 'document.cu',
2268: kerb_def_dom => 'MSU.EDU',
2269: @_,
2270: );
1.586 raeburn 2271: my ($loccheck,$locarg,$result,$authtype,$autharg,$jscall);
2272: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2273: if (defined($in{'curr_authtype'})) {
2274: if ($in{'curr_authtype'} eq 'loc') {
1.586 raeburn 2275: if ($can_assign{'loc'}) {
2276: $loccheck = 'checked="on" ';
1.623 raeburn 2277: if (defined($in{'mode'})) {
2278: if ($in{'mode'} eq 'modifyuser') {
2279: $loccheck = '';
2280: }
2281: }
1.591 raeburn 2282: if (defined($in{'curr_autharg'})) {
1.586 raeburn 2283: $locarg = $in{'curr_autharg'};
2284: }
2285: } else {
2286: $result = &mt('Currently using local (institutional) authentication.');
2287: return $result;
1.165 raeburn 2288: }
2289: }
1.586 raeburn 2290: } else {
2291: if ($authnum == 1) {
2292: $authtype = '<input type="hidden" name="login" value="loc">';
2293: }
2294: }
2295: if (!$can_assign{'loc'}) {
2296: return;
1.587 raeburn 2297: } elsif ($authtype eq '') {
1.591 raeburn 2298: if (defined($in{'mode'})) {
1.587 raeburn 2299: if ($in{'mode'} eq 'modifycourse') {
2300: if ($authnum == 1) {
2301: $authtype = '<input type="hidden" name="login" value="loc">';
2302: }
2303: }
2304: }
1.165 raeburn 2305: }
1.586 raeburn 2306: $jscall = "javascript:changed_radio('loc',$in{'formname'});";
2307: if ($authtype eq '') {
2308: $authtype = '<input type="radio" name="login" value="loc" '.
2309: $loccheck.' onchange="'.$jscall.'" onclick="'.
2310: $jscall.'" />';
2311: }
2312: $autharg = '<input type="text" size="10" name="locarg" value="'.
2313: $locarg.'" onchange="'.$jscall.'" />';
2314: $result = &mt('[_1] Local Authentication with argument [_2]',
2315: '<label>'.$authtype,'</label>'.$autharg);
1.32 matthew 2316: return $result;
2317: }
2318:
2319: sub authform_filesystem{
2320: my %in = (
2321: formname => 'document.cu',
2322: kerb_def_dom => 'MSU.EDU',
2323: @_,
2324: );
1.586 raeburn 2325: my ($fsyscheck,$result,$authtype,$autharg,$jscall);
2326: my ($authnum,%can_assign) = &get_assignable_auth($in{'domain'});
1.591 raeburn 2327: if (defined($in{'curr_authtype'})) {
2328: if ($in{'curr_authtype'} eq 'fsys') {
1.586 raeburn 2329: if ($can_assign{'fsys'}) {
2330: $fsyscheck = 'checked="on" ';
1.623 raeburn 2331: if (defined($in{'mode'})) {
2332: if ($in{'mode'} eq 'modifyuser') {
2333: $fsyscheck = '';
2334: }
2335: }
1.586 raeburn 2336: } else {
2337: $result = &mt('Currently Filesystem Authenticated.');
2338: return $result;
2339: }
2340: }
2341: } else {
2342: if ($authnum == 1) {
2343: $authtype = '<input type="hidden" name="login" value="fsys">';
2344: }
2345: }
2346: if (!$can_assign{'fsys'}) {
2347: return;
1.587 raeburn 2348: } elsif ($authtype eq '') {
1.591 raeburn 2349: if (defined($in{'mode'})) {
1.587 raeburn 2350: if ($in{'mode'} eq 'modifycourse') {
2351: if ($authnum == 1) {
2352: $authtype = '<input type="hidden" name="login" value="fsys">';
2353: }
2354: }
2355: }
1.586 raeburn 2356: }
2357: $jscall = "javascript:changed_radio('fsys',$in{'formname'});";
2358: if ($authtype eq '') {
2359: $authtype = '<input type="radio" name="login" value="fsys" '.
2360: $fsyscheck.' onchange="'.$jscall.'" onclick="'.
2361: $jscall.'" />';
2362: }
2363: $autharg = '<input type="text" size="10" name="fsysarg" value=""'.
2364: ' onchange="'.$jscall.'" />';
2365: $result = &mt
1.144 matthew 2366: ('[_1] Filesystem Authenticated (with initial password [_2])',
1.281 albertel 2367: '<label><input type="radio" name="login" value="fsys" '.
1.586 raeburn 2368: $fsyscheck.'onchange="'.$jscall.'" onclick="'.$jscall.'" />',
1.605 bisitz 2369: '</label><input type="password" size="10" name="fsysarg" value="" '.
1.144 matthew 2370: 'onchange="'.$jscall.'" />');
1.32 matthew 2371: return $result;
2372: }
2373:
1.586 raeburn 2374: sub get_assignable_auth {
2375: my ($dom) = @_;
2376: if ($dom eq '') {
2377: $dom = $env{'request.role.domain'};
2378: }
2379: my %can_assign = (
2380: krb4 => 1,
2381: krb5 => 1,
2382: int => 1,
2383: loc => 1,
2384: );
2385: my %domconfig = &Apache::lonnet::get_dom('configuration',['usercreation'],$dom);
2386: if (ref($domconfig{'usercreation'}) eq 'HASH') {
2387: if (ref($domconfig{'usercreation'}{'authtypes'}) eq 'HASH') {
2388: my $authhash = $domconfig{'usercreation'}{'authtypes'};
2389: my $context;
2390: if ($env{'request.role'} =~ /^au/) {
2391: $context = 'author';
2392: } elsif ($env{'request.role'} =~ /^dc/) {
2393: $context = 'domain';
2394: } elsif ($env{'request.course.id'}) {
2395: $context = 'course';
2396: }
2397: if ($context) {
2398: if (ref($authhash->{$context}) eq 'HASH') {
2399: %can_assign = %{$authhash->{$context}};
2400: }
2401: }
2402: }
2403: }
2404: my $authnum = 0;
2405: foreach my $key (keys(%can_assign)) {
2406: if ($can_assign{$key}) {
2407: $authnum ++;
2408: }
2409: }
2410: if ($can_assign{'krb4'} && $can_assign{'krb5'}) {
2411: $authnum --;
2412: }
2413: return ($authnum,%can_assign);
2414: }
2415:
1.80 albertel 2416: ###############################################################
2417: ## Get Kerberos Defaults for Domain ##
2418: ###############################################################
2419: ##
2420: ## Returns default kerberos version and an associated argument
2421: ## as listed in file domain.tab. If not listed, provides
2422: ## appropriate default domain and kerberos version.
2423: ##
2424: #-------------------------------------------
2425:
2426: =pod
2427:
1.648 raeburn 2428: =item * &get_kerberos_defaults()
1.80 albertel 2429:
2430: get_kerberos_defaults($target_domain) returns the default kerberos
1.641 raeburn 2431: version and domain. If not found, it defaults to version 4 and the
2432: domain of the server.
1.80 albertel 2433:
1.648 raeburn 2434: =over 4
2435:
1.80 albertel 2436: ($def_version, $def_krb_domain) = &get_kerberos_defaults($target_domain);
2437:
1.648 raeburn 2438: =back
2439:
2440: =back
2441:
1.80 albertel 2442: =cut
2443:
2444: #-------------------------------------------
2445: sub get_kerberos_defaults {
2446: my $domain=shift;
1.641 raeburn 2447: my ($krbdef,$krbdefdom);
2448: my %domdefaults = &Apache::lonnet::get_domain_defaults($domain);
2449: if (($domdefaults{'auth_def'} =~/^krb(4|5)$/) && ($domdefaults{'auth_arg_def'} ne '')) {
2450: $krbdef = $domdefaults{'auth_def'};
2451: $krbdefdom = $domdefaults{'auth_arg_def'};
2452: } else {
1.80 albertel 2453: $ENV{'SERVER_NAME'}=~/(\w+\.\w+)$/;
2454: my $krbdefdom=$1;
2455: $krbdefdom=~tr/a-z/A-Z/;
2456: $krbdef = "krb4";
2457: }
2458: return ($krbdef,$krbdefdom);
2459: }
1.112 bowersj2 2460:
1.32 matthew 2461:
1.46 matthew 2462: ###############################################################
2463: ## Thesaurus Functions ##
2464: ###############################################################
1.20 www 2465:
1.46 matthew 2466: =pod
1.20 www 2467:
1.112 bowersj2 2468: =head1 Thesaurus Functions
2469:
2470: =over 4
2471:
1.648 raeburn 2472: =item * &initialize_keywords()
1.46 matthew 2473:
2474: Initializes the package variable %Keywords if it is empty. Uses the
2475: package variable $thesaurus_db_file.
2476:
2477: =cut
2478:
2479: ###################################################
2480:
2481: sub initialize_keywords {
2482: return 1 if (scalar keys(%Keywords));
2483: # If we are here, %Keywords is empty, so fill it up
2484: # Make sure the file we need exists...
2485: if (! -e $thesaurus_db_file) {
2486: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file".
2487: " failed because it does not exist");
2488: return 0;
2489: }
2490: # Set up the hash as a database
2491: my %thesaurus_db;
2492: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2493: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2494: &Apache::lonnet::logthis("Could not tie \%thesaurus_db to ".
2495: $thesaurus_db_file);
2496: return 0;
2497: }
2498: # Get the average number of appearances of a word.
2499: my $avecount = $thesaurus_db{'average.count'};
2500: # Put keywords (those that appear > average) into %Keywords
2501: while (my ($word,$data)=each (%thesaurus_db)) {
2502: my ($count,undef) = split /:/,$data;
2503: $Keywords{$word}++ if ($count > $avecount);
2504: }
2505: untie %thesaurus_db;
2506: # Remove special values from %Keywords.
1.356 albertel 2507: foreach my $value ('total.count','average.count') {
2508: delete($Keywords{$value}) if (exists($Keywords{$value}));
1.586 raeburn 2509: }
1.46 matthew 2510: return 1;
2511: }
2512:
2513: ###################################################
2514:
2515: =pod
2516:
1.648 raeburn 2517: =item * &keyword($word)
1.46 matthew 2518:
2519: Returns true if $word is a keyword. A keyword is a word that appears more
2520: than the average number of times in the thesaurus database. Calls
2521: &initialize_keywords
2522:
2523: =cut
2524:
2525: ###################################################
1.20 www 2526:
2527: sub keyword {
1.46 matthew 2528: return if (!&initialize_keywords());
2529: my $word=lc(shift());
2530: $word=~s/\W//g;
2531: return exists($Keywords{$word});
1.20 www 2532: }
1.46 matthew 2533:
2534: ###############################################################
2535:
2536: =pod
1.20 www 2537:
1.648 raeburn 2538: =item * &get_related_words()
1.46 matthew 2539:
1.160 matthew 2540: Look up a word in the thesaurus. Takes a scalar argument and returns
1.46 matthew 2541: an array of words. If the keyword is not in the thesaurus, an empty array
2542: will be returned. The order of the words returned is determined by the
2543: database which holds them.
2544:
2545: Uses global $thesaurus_db_file.
2546:
2547: =cut
2548:
2549: ###############################################################
2550: sub get_related_words {
2551: my $keyword = shift;
2552: my %thesaurus_db;
2553: if (! -e $thesaurus_db_file) {
2554: &Apache::lonnet::logthis("Attempt to access $thesaurus_db_file ".
2555: "failed because the file does not exist");
2556: return ();
2557: }
2558: if (! tie(%thesaurus_db,'GDBM_File',
1.53 albertel 2559: $thesaurus_db_file,&GDBM_READER(),0640)){
1.46 matthew 2560: return ();
2561: }
2562: my @Words=();
1.429 www 2563: my $count=0;
1.46 matthew 2564: if (exists($thesaurus_db{$keyword})) {
1.356 albertel 2565: # The first element is the number of times
2566: # the word appears. We do not need it now.
1.429 www 2567: my (undef,@RelatedWords) = (split(/:/,$thesaurus_db{$keyword}));
2568: my (undef,$mostfrequentcount)=split(/\,/,$RelatedWords[0]);
2569: my $threshold=$mostfrequentcount/10;
2570: foreach my $possibleword (@RelatedWords) {
2571: my ($word,$wordcount)=split(/\,/,$possibleword);
2572: if ($wordcount>$threshold) {
2573: push(@Words,$word);
2574: $count++;
2575: if ($count>10) { last; }
2576: }
1.20 www 2577: }
2578: }
1.46 matthew 2579: untie %thesaurus_db;
2580: return @Words;
1.14 harris41 2581: }
1.46 matthew 2582:
1.112 bowersj2 2583: =pod
2584:
2585: =back
2586:
2587: =cut
1.61 www 2588:
2589: # -------------------------------------------------------------- Plaintext name
1.81 albertel 2590: =pod
2591:
1.112 bowersj2 2592: =head1 User Name Functions
2593:
2594: =over 4
2595:
1.648 raeburn 2596: =item * &plainname($uname,$udom,$first)
1.81 albertel 2597:
1.112 bowersj2 2598: Takes a users logon name and returns it as a string in
1.226 albertel 2599: "first middle last generation" form
2600: if $first is set to 'lastname' then it returns it as
2601: 'lastname generation, firstname middlename' if their is a lastname
1.81 albertel 2602:
2603: =cut
1.61 www 2604:
1.295 www 2605:
1.81 albertel 2606: ###############################################################
1.61 www 2607: sub plainname {
1.226 albertel 2608: my ($uname,$udom,$first)=@_;
1.537 albertel 2609: return if (!defined($uname) || !defined($udom));
1.295 www 2610: my %names=&getnames($uname,$udom);
1.226 albertel 2611: my $name=&Apache::lonnet::format_name($names{'firstname'},
2612: $names{'middlename'},
2613: $names{'lastname'},
2614: $names{'generation'},$first);
2615: $name=~s/^\s+//;
1.62 www 2616: $name=~s/\s+$//;
2617: $name=~s/\s+/ /g;
1.353 albertel 2618: if ($name !~ /\S/) { $name=$uname.':'.$udom; }
1.62 www 2619: return $name;
1.61 www 2620: }
1.66 www 2621:
2622: # -------------------------------------------------------------------- Nickname
1.81 albertel 2623: =pod
2624:
1.648 raeburn 2625: =item * &nickname($uname,$udom)
1.81 albertel 2626:
2627: Gets a users name and returns it as a string as
2628:
2629: ""nickname""
1.66 www 2630:
1.81 albertel 2631: if the user has a nickname or
2632:
2633: "first middle last generation"
2634:
2635: if the user does not
2636:
2637: =cut
1.66 www 2638:
2639: sub nickname {
2640: my ($uname,$udom)=@_;
1.537 albertel 2641: return if (!defined($uname) || !defined($udom));
1.295 www 2642: my %names=&getnames($uname,$udom);
1.68 albertel 2643: my $name=$names{'nickname'};
1.66 www 2644: if ($name) {
2645: $name='"'.$name.'"';
2646: } else {
2647: $name=$names{'firstname'}.' '.$names{'middlename'}.' '.
2648: $names{'lastname'}.' '.$names{'generation'};
2649: $name=~s/\s+$//;
2650: $name=~s/\s+/ /g;
2651: }
2652: return $name;
2653: }
2654:
1.295 www 2655: sub getnames {
2656: my ($uname,$udom)=@_;
1.537 albertel 2657: return if (!defined($uname) || !defined($udom));
1.433 albertel 2658: if ($udom eq 'public' && $uname eq 'public') {
2659: return ('lastname' => &mt('Public'));
2660: }
1.295 www 2661: my $id=$uname.':'.$udom;
2662: my ($names,$cached)=&Apache::lonnet::is_cached_new('namescache',$id);
2663: if ($cached) {
2664: return %{$names};
2665: } else {
2666: my %loadnames=&Apache::lonnet::get('environment',
2667: ['firstname','middlename','lastname','generation','nickname'],
2668: $udom,$uname);
2669: &Apache::lonnet::do_cache_new('namescache',$id,\%loadnames);
2670: return %loadnames;
2671: }
2672: }
1.61 www 2673:
1.542 raeburn 2674: # -------------------------------------------------------------------- getemails
1.648 raeburn 2675:
1.542 raeburn 2676: =pod
2677:
1.648 raeburn 2678: =item * &getemails($uname,$udom)
1.542 raeburn 2679:
2680: Gets a user's email information and returns it as a hash with keys:
2681: notification, critnotification, permanentemail
2682:
2683: For notification and critnotification, values are comma-separated lists
1.648 raeburn 2684: of e-mail addresses; for permanentemail, value is a single e-mail address.
1.542 raeburn 2685:
1.648 raeburn 2686:
1.542 raeburn 2687: =cut
2688:
1.648 raeburn 2689:
1.466 albertel 2690: sub getemails {
2691: my ($uname,$udom)=@_;
2692: if ($udom eq 'public' && $uname eq 'public') {
2693: return;
2694: }
1.467 www 2695: if (!$udom) { $udom=$env{'user.domain'}; }
2696: if (!$uname) { $uname=$env{'user.name'}; }
1.466 albertel 2697: my $id=$uname.':'.$udom;
2698: my ($names,$cached)=&Apache::lonnet::is_cached_new('emailscache',$id);
2699: if ($cached) {
2700: return %{$names};
2701: } else {
2702: my %loadnames=&Apache::lonnet::get('environment',
2703: ['notification','critnotification',
2704: 'permanentemail'],
2705: $udom,$uname);
2706: &Apache::lonnet::do_cache_new('emailscache',$id,\%loadnames);
2707: return %loadnames;
2708: }
2709: }
2710:
1.551 albertel 2711: sub flush_email_cache {
2712: my ($uname,$udom)=@_;
2713: if (!$udom) { $udom =$env{'user.domain'}; }
2714: if (!$uname) { $uname=$env{'user.name'}; }
2715: return if ($udom eq 'public' && $uname eq 'public');
2716: my $id=$uname.':'.$udom;
2717: &Apache::lonnet::devalidate_cache_new('emailscache',$id);
2718: }
2719:
1.61 www 2720: # ------------------------------------------------------------------ Screenname
1.81 albertel 2721:
2722: =pod
2723:
1.648 raeburn 2724: =item * &screenname($uname,$udom)
1.81 albertel 2725:
2726: Gets a users screenname and returns it as a string
2727:
2728: =cut
1.61 www 2729:
2730: sub screenname {
2731: my ($uname,$udom)=@_;
1.258 albertel 2732: if ($uname eq $env{'user.name'} &&
2733: $udom eq $env{'user.domain'}) {return $env{'environment.screenname'};}
1.212 albertel 2734: my %names=&Apache::lonnet::get('environment',['screenname'],$udom,$uname);
1.68 albertel 2735: return $names{'screenname'};
1.62 www 2736: }
2737:
1.212 albertel 2738:
1.62 www 2739: # ------------------------------------------------------------- Message Wrapper
2740:
2741: sub messagewrapper {
1.369 www 2742: my ($link,$username,$domain,$subject,$text)=@_;
1.62 www 2743: return
1.441 albertel 2744: '<a href="/adm/email?compose=individual&'.
2745: 'recname='.$username.'&recdom='.$domain.
2746: '&subject='.&escape($subject).'&text='.&escape($text).'" '.
1.200 matthew 2747: 'title="'.&mt('Send message').'">'.$link.'</a>';
1.74 www 2748: }
2749: # --------------------------------------------------------------- Notes Wrapper
2750:
2751: sub noteswrapper {
2752: my ($link,$un,$do)=@_;
2753: return
2754: "<a href='/adm/email?recordftf=retrieve&recname=$un&recdom=$do'>$link</a>";
1.62 www 2755: }
2756: # ------------------------------------------------------------- Aboutme Wrapper
2757:
2758: sub aboutmewrapper {
1.166 www 2759: my ($link,$username,$domain,$target)=@_;
1.447 raeburn 2760: if (!defined($username) && !defined($domain)) {
2761: return;
2762: }
1.205 www 2763: return '<a href="/adm/'.$domain.'/'.$username.'/aboutme"'.
1.454 banghart 2764: ($target?' target="$target"':'').' title="'.&mt("View this user's personal page").'">'.$link.'</a>';
1.62 www 2765: }
2766:
2767: # ------------------------------------------------------------ Syllabus Wrapper
2768:
2769:
2770: sub syllabuswrapper {
1.109 matthew 2771: my ($linktext,$coursedir,$domain,$fontcolor)=@_;
2772: if ($fontcolor) {
2773: $linktext='<font color="'.$fontcolor.'">'.$linktext.'</font>';
2774: }
1.208 matthew 2775: return qq{<a href="/public/$domain/$coursedir/syllabus">$linktext</a>};
1.61 www 2776: }
1.14 harris41 2777:
1.208 matthew 2778: sub track_student_link {
1.268 albertel 2779: my ($linktext,$sname,$sdom,$target,$start) = @_;
2780: my $link ="/adm/trackstudent?";
1.208 matthew 2781: my $title = 'View recent activity';
2782: if (defined($sname) && $sname !~ /^\s*$/ &&
2783: defined($sdom) && $sdom !~ /^\s*$/) {
1.268 albertel 2784: $link .= "selected_student=$sname:$sdom";
1.208 matthew 2785: $title .= ' of this student';
1.268 albertel 2786: }
1.208 matthew 2787: if (defined($target) && $target !~ /^\s*$/) {
2788: $target = qq{target="$target"};
2789: } else {
2790: $target = '';
2791: }
1.268 albertel 2792: if ($start) { $link.='&start='.$start; }
1.554 albertel 2793: $title = &mt($title);
2794: $linktext = &mt($linktext);
1.448 albertel 2795: return qq{<a href="$link" title="$title" $target>$linktext</a>}.
2796: &help_open_topic('View_recent_activity');
1.208 matthew 2797: }
2798:
1.508 www 2799: # ===================================================== Display a student photo
2800:
2801:
1.509 albertel 2802: sub student_image_tag {
1.508 www 2803: my ($domain,$user)=@_;
2804: my $imgsrc=&Apache::lonnet::studentphoto($domain,$user,'jpg');
2805: if (($imgsrc) && ($imgsrc ne '/adm/lonKaputt/lonlogo_broken.gif')) {
2806: return '<img src="'.$imgsrc.'" align="right" />';
2807: } else {
2808: return '';
2809: }
2810: }
2811:
1.112 bowersj2 2812: =pod
2813:
2814: =back
2815:
2816: =head1 Access .tab File Data
2817:
2818: =over 4
2819:
1.648 raeburn 2820: =item * &languageids()
1.112 bowersj2 2821:
2822: returns list of all language ids
2823:
2824: =cut
2825:
1.14 harris41 2826: sub languageids {
1.16 harris41 2827: return sort(keys(%language));
1.14 harris41 2828: }
2829:
1.112 bowersj2 2830: =pod
2831:
1.648 raeburn 2832: =item * &languagedescription()
1.112 bowersj2 2833:
2834: returns description of a specified language id
2835:
2836: =cut
2837:
1.14 harris41 2838: sub languagedescription {
1.125 www 2839: my $code=shift;
2840: return ($supported_language{$code}?'* ':'').
2841: $language{$code}.
1.126 www 2842: ($supported_language{$code}?' ('.&mt('interface available').')':'');
1.145 www 2843: }
2844:
2845: sub plainlanguagedescription {
2846: my $code=shift;
2847: return $language{$code};
2848: }
2849:
2850: sub supportedlanguagecode {
2851: my $code=shift;
2852: return $supported_language{$code};
1.97 www 2853: }
2854:
1.112 bowersj2 2855: =pod
2856:
1.648 raeburn 2857: =item * ©rightids()
1.112 bowersj2 2858:
2859: returns list of all copyrights
2860:
2861: =cut
2862:
2863: sub copyrightids {
2864: return sort(keys(%cprtag));
2865: }
2866:
2867: =pod
2868:
1.648 raeburn 2869: =item * ©rightdescription()
1.112 bowersj2 2870:
2871: returns description of a specified copyright id
2872:
2873: =cut
2874:
2875: sub copyrightdescription {
1.166 www 2876: return &mt($cprtag{shift(@_)});
1.112 bowersj2 2877: }
1.197 matthew 2878:
2879: =pod
2880:
1.648 raeburn 2881: =item * &source_copyrightids()
1.192 taceyjo1 2882:
2883: returns list of all source copyrights
2884:
2885: =cut
2886:
2887: sub source_copyrightids {
2888: return sort(keys(%scprtag));
2889: }
2890:
2891: =pod
2892:
1.648 raeburn 2893: =item * &source_copyrightdescription()
1.192 taceyjo1 2894:
2895: returns description of a specified source copyright id
2896:
2897: =cut
2898:
2899: sub source_copyrightdescription {
2900: return &mt($scprtag{shift(@_)});
2901: }
1.112 bowersj2 2902:
2903: =pod
2904:
1.648 raeburn 2905: =item * &filecategories()
1.112 bowersj2 2906:
2907: returns list of all file categories
2908:
2909: =cut
2910:
2911: sub filecategories {
2912: return sort(keys(%category_extensions));
2913: }
2914:
2915: =pod
2916:
1.648 raeburn 2917: =item * &filecategorytypes()
1.112 bowersj2 2918:
2919: returns list of file types belonging to a given file
2920: category
2921:
2922: =cut
2923:
2924: sub filecategorytypes {
1.356 albertel 2925: my ($cat) = @_;
2926: return @{$category_extensions{lc($cat)}};
1.112 bowersj2 2927: }
2928:
2929: =pod
2930:
1.648 raeburn 2931: =item * &fileembstyle()
1.112 bowersj2 2932:
2933: returns embedding style for a specified file type
2934:
2935: =cut
2936:
2937: sub fileembstyle {
2938: return $fe{lc(shift(@_))};
1.169 www 2939: }
2940:
1.351 www 2941: sub filemimetype {
2942: return $fm{lc(shift(@_))};
2943: }
2944:
1.169 www 2945:
2946: sub filecategoryselect {
2947: my ($name,$value)=@_;
1.189 matthew 2948: return &select_form($value,$name,
1.169 www 2949: '' => &mt('Any category'),
2950: map { $_,$_ } sort(keys(%category_extensions)));
1.112 bowersj2 2951: }
2952:
2953: =pod
2954:
1.648 raeburn 2955: =item * &filedescription()
1.112 bowersj2 2956:
2957: returns description for a specified file type
2958:
2959: =cut
2960:
2961: sub filedescription {
1.188 matthew 2962: my $file_description = $fd{lc(shift())};
2963: $file_description =~ s:([\[\]]):~$1:g;
2964: return &mt($file_description);
1.112 bowersj2 2965: }
2966:
2967: =pod
2968:
1.648 raeburn 2969: =item * &filedescriptionex()
1.112 bowersj2 2970:
2971: returns description for a specified file type with
2972: extra formatting
2973:
2974: =cut
2975:
2976: sub filedescriptionex {
2977: my $ex=shift;
1.188 matthew 2978: my $file_description = $fd{lc($ex)};
2979: $file_description =~ s:([\[\]]):~$1:g;
2980: return '.'.$ex.' '.&mt($file_description);
1.112 bowersj2 2981: }
2982:
2983: # End of .tab access
2984: =pod
2985:
2986: =back
2987:
2988: =cut
2989:
2990: # ------------------------------------------------------------------ File Types
2991: sub fileextensions {
2992: return sort(keys(%fe));
2993: }
2994:
1.97 www 2995: # ----------------------------------------------------------- Display Languages
2996: # returns a hash with all desired display languages
2997: #
2998:
2999: sub display_languages {
3000: my %languages=();
1.692.2.1 raeburn 3001: foreach my $lang (&Apache::lonlocal::preferred_languages()) {
1.356 albertel 3002: $languages{$lang}=1;
1.97 www 3003: }
3004: &get_unprocessed_cgi($ENV{'QUERY_STRING'},['displaylanguage']);
1.258 albertel 3005: if ($env{'form.displaylanguage'}) {
1.356 albertel 3006: foreach my $lang (split(/\s*(\,|\;|\:)\s*/,$env{'form.displaylanguage'})) {
3007: $languages{$lang}=1;
1.97 www 3008: }
3009: }
3010: return %languages;
1.14 harris41 3011: }
3012:
1.582 albertel 3013: sub languages {
3014: my ($possible_langs) = @_;
1.692.2.1 raeburn 3015: my @preferred_langs = &Apache::lonlocal::preferred_languages();
1.582 albertel 3016: if (!ref($possible_langs)) {
3017: if( wantarray ) {
3018: return @preferred_langs;
3019: } else {
3020: return $preferred_langs[0];
3021: }
3022: }
3023: my %possibilities = map { $_ => 1 } (@$possible_langs);
3024: my @preferred_possibilities;
3025: foreach my $preferred_lang (@preferred_langs) {
3026: if (exists($possibilities{$preferred_lang})) {
3027: push(@preferred_possibilities, $preferred_lang);
3028: }
3029: }
3030: if( wantarray ) {
3031: return @preferred_possibilities;
3032: }
3033: return $preferred_possibilities[0];
3034: }
3035:
1.112 bowersj2 3036: ###############################################################
3037: ## Student Answer Attempts ##
3038: ###############################################################
3039:
3040: =pod
3041:
3042: =head1 Alternate Problem Views
3043:
3044: =over 4
3045:
1.648 raeburn 3046: =item * &get_previous_attempt($symb, $username, $domain, $course,
1.112 bowersj2 3047: $getattempt, $regexp, $gradesub)
3048:
3049: Return string with previous attempt on problem. Arguments:
3050:
3051: =over 4
3052:
3053: =item * $symb: Problem, including path
3054:
3055: =item * $username: username of the desired student
3056:
3057: =item * $domain: domain of the desired student
1.14 harris41 3058:
1.112 bowersj2 3059: =item * $course: Course ID
1.14 harris41 3060:
1.112 bowersj2 3061: =item * $getattempt: Leave blank for all attempts, otherwise put
3062: something
1.14 harris41 3063:
1.112 bowersj2 3064: =item * $regexp: if string matches this regexp, the string will be
3065: sent to $gradesub
1.14 harris41 3066:
1.112 bowersj2 3067: =item * $gradesub: routine that processes the string if it matches $regexp
1.14 harris41 3068:
1.112 bowersj2 3069: =back
1.14 harris41 3070:
1.112 bowersj2 3071: The output string is a table containing all desired attempts, if any.
1.16 harris41 3072:
1.112 bowersj2 3073: =cut
1.1 albertel 3074:
3075: sub get_previous_attempt {
1.43 ng 3076: my ($symb,$username,$domain,$course,$getattempt,$regexp,$gradesub)=@_;
1.1 albertel 3077: my $prevattempts='';
1.43 ng 3078: no strict 'refs';
1.1 albertel 3079: if ($symb) {
1.3 albertel 3080: my (%returnhash)=
3081: &Apache::lonnet::restore($symb,$course,$domain,$username);
1.1 albertel 3082: if ($returnhash{'version'}) {
3083: my %lasthash=();
3084: my $version;
3085: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.356 albertel 3086: foreach my $key (sort(split(/\:/,$returnhash{$version.':keys'}))) {
3087: $lasthash{$key}=$returnhash{$version.':'.$key};
1.19 harris41 3088: }
1.1 albertel 3089: }
1.596 albertel 3090: $prevattempts=&start_data_table().&start_data_table_header_row();
3091: $prevattempts.='<th>'.&mt('History').'</th>';
1.356 albertel 3092: foreach my $key (sort(keys(%lasthash))) {
3093: my ($ign,@parts) = split(/\./,$key);
1.41 ng 3094: if ($#parts > 0) {
1.31 albertel 3095: my $data=$parts[-1];
3096: pop(@parts);
1.596 albertel 3097: $prevattempts.='<th>'.&mt('Part ').join('.',@parts).'<br />'.$data.' </th>';
1.31 albertel 3098: } else {
1.41 ng 3099: if ($#parts == 0) {
3100: $prevattempts.='<th>'.$parts[0].'</th>';
3101: } else {
3102: $prevattempts.='<th>'.$ign.'</th>';
3103: }
1.31 albertel 3104: }
1.16 harris41 3105: }
1.596 albertel 3106: $prevattempts.=&end_data_table_header_row();
1.40 ng 3107: if ($getattempt eq '') {
3108: for ($version=1;$version<=$returnhash{'version'};$version++) {
1.596 albertel 3109: $prevattempts.=&start_data_table_row().
3110: '<td>'.&mt('Transaction [_1]',$version).'</td>';
1.356 albertel 3111: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3112: my $value = &format_previous_attempt_value($key,
3113: $returnhash{$version.':'.$key});
3114: $prevattempts.='<td>'.$value.' </td>';
1.40 ng 3115: }
1.596 albertel 3116: $prevattempts.=&end_data_table_row();
1.40 ng 3117: }
1.1 albertel 3118: }
1.596 albertel 3119: $prevattempts.=&start_data_table_row().'<td>'.&mt('Current').'</td>';
1.356 albertel 3120: foreach my $key (sort(keys(%lasthash))) {
1.581 albertel 3121: my $value = &format_previous_attempt_value($key,$lasthash{$key});
1.356 albertel 3122: if ($key =~/$regexp$/ && (defined &$gradesub)) {$value = &$gradesub($value)}
1.40 ng 3123: $prevattempts.='<td>'.$value.' </td>';
1.16 harris41 3124: }
1.596 albertel 3125: $prevattempts.= &end_data_table_row().&end_data_table();
1.1 albertel 3126: } else {
1.596 albertel 3127: $prevattempts=
3128: &start_data_table().&start_data_table_row().
3129: '<td>'.&mt('Nothing submitted - no attempts.').'</td>'.
3130: &end_data_table_row().&end_data_table();
1.1 albertel 3131: }
3132: } else {
1.596 albertel 3133: $prevattempts=
3134: &start_data_table().&start_data_table_row().
3135: '<td>'.&mt('No data.').'</td>'.
3136: &end_data_table_row().&end_data_table();
1.1 albertel 3137: }
1.10 albertel 3138: }
3139:
1.581 albertel 3140: sub format_previous_attempt_value {
3141: my ($key,$value) = @_;
3142: if ($key =~ /timestamp/) {
3143: $value = &Apache::lonlocal::locallocaltime($value);
3144: } elsif (ref($value) eq 'ARRAY') {
3145: $value = '('.join(', ', @{ $value }).')';
3146: } else {
3147: $value = &unescape($value);
3148: }
3149: return $value;
3150: }
3151:
3152:
1.107 albertel 3153: sub relative_to_absolute {
3154: my ($url,$output)=@_;
3155: my $parser=HTML::TokeParser->new(\$output);
3156: my $token;
3157: my $thisdir=$url;
3158: my @rlinks=();
3159: while ($token=$parser->get_token) {
3160: if ($token->[0] eq 'S') {
3161: if ($token->[1] eq 'a') {
3162: if ($token->[2]->{'href'}) {
3163: $rlinks[$#rlinks+1]=$token->[2]->{'href'};
3164: }
3165: } elsif ($token->[1] eq 'img' || $token->[1] eq 'embed' ) {
3166: $rlinks[$#rlinks+1]=$token->[2]->{'src'};
3167: } elsif ($token->[1] eq 'base') {
3168: $thisdir=$token->[2]->{'href'};
3169: }
3170: }
3171: }
3172: $thisdir=~s-/[^/]*$--;
1.356 albertel 3173: foreach my $link (@rlinks) {
3174: unless (($link=~/^http:\/\//i) ||
3175: ($link=~/^\//) ||
3176: ($link=~/^javascript:/i) ||
3177: ($link=~/^mailto:/i) ||
3178: ($link=~/^\#/)) {
3179: my $newlocation=&Apache::lonnet::hreflocation($thisdir,$link);
3180: $output=~s/(\"|\'|\=\s*)\Q$link\E(\"|\'|\s|\>)/$1$newlocation$2/;
1.107 albertel 3181: }
3182: }
3183: # -------------------------------------------------- Deal with Applet codebases
3184: $output=~s/(\<applet[^\>]+)(codebase\=[^\S\>]+)*([^\>]*)\>/$1.($2?$2:' codebase="'.$thisdir.'"').$3.'>'/gei;
3185: return $output;
3186: }
3187:
1.112 bowersj2 3188: =pod
3189:
1.648 raeburn 3190: =item * &get_student_view()
1.112 bowersj2 3191:
3192: show a snapshot of what student was looking at
3193:
3194: =cut
3195:
1.10 albertel 3196: sub get_student_view {
1.186 albertel 3197: my ($symb,$username,$domain,$courseid,$target,$moreenv) = @_;
1.114 www 3198: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3199: my (%form);
1.10 albertel 3200: my @elements=('symb','courseid','domain','username');
3201: foreach my $element (@elements) {
1.186 albertel 3202: $form{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3203: }
1.186 albertel 3204: if (defined($moreenv)) {
3205: %form=(%form,%{$moreenv});
3206: }
1.236 albertel 3207: if (defined($target)) { $form{'grade_target'} = $target; }
1.107 albertel 3208: $feedurl=&Apache::lonnet::clutter($feedurl);
1.650 www 3209: my ($userview,$response)=&Apache::lonnet::ssi_body($feedurl,%form);
1.11 albertel 3210: $userview=~s/\<body[^\>]*\>//gi;
3211: $userview=~s/\<\/body\>//gi;
3212: $userview=~s/\<html\>//gi;
3213: $userview=~s/\<\/html\>//gi;
3214: $userview=~s/\<head\>//gi;
3215: $userview=~s/\<\/head\>//gi;
3216: $userview=~s/action\s*\=/would_be_action\=/gi;
1.107 albertel 3217: $userview=&relative_to_absolute($feedurl,$userview);
1.650 www 3218: if (wantarray) {
3219: return ($userview,$response);
3220: } else {
3221: return $userview;
3222: }
3223: }
3224:
3225: sub get_student_view_with_retries {
3226: my ($symb,$retries,$username,$domain,$courseid,$target,$moreenv) = @_;
3227:
3228: my $ok = 0; # True if we got a good response.
3229: my $content;
3230: my $response;
3231:
3232: # Try to get the student_view done. within the retries count:
3233:
3234: do {
3235: ($content, $response) = &get_student_view($symb,$username,$domain,$courseid,$target,$moreenv);
3236: $ok = $response->is_success;
3237: if (!$ok) {
3238: &Apache::lonnet::logthis("Failed get_student_view_with_retries on $symb: ".$response->is_success.', '.$response->code.', '.$response->message);
3239: }
3240: $retries--;
3241: } while (!$ok && ($retries > 0));
3242:
3243: if (!$ok) {
3244: $content = ''; # On error return an empty content.
3245: }
1.651 www 3246: if (wantarray) {
3247: return ($content, $response);
3248: } else {
3249: return $content;
3250: }
1.11 albertel 3251: }
3252:
1.112 bowersj2 3253: =pod
3254:
1.648 raeburn 3255: =item * &get_student_answers()
1.112 bowersj2 3256:
3257: show a snapshot of how student was answering problem
3258:
3259: =cut
3260:
1.11 albertel 3261: sub get_student_answers {
1.100 sakharuk 3262: my ($symb,$username,$domain,$courseid,%form) = @_;
1.114 www 3263: my ($map,$id,$feedurl) = &Apache::lonnet::decode_symb($symb);
1.186 albertel 3264: my (%moreenv);
1.11 albertel 3265: my @elements=('symb','courseid','domain','username');
3266: foreach my $element (@elements) {
1.186 albertel 3267: $moreenv{'grade_'.$element}=eval '$'.$element #'
1.10 albertel 3268: }
1.186 albertel 3269: $moreenv{'grade_target'}='answer';
3270: %moreenv=(%form,%moreenv);
1.497 raeburn 3271: $feedurl = &Apache::lonnet::clutter($feedurl);
3272: my $userview=&Apache::lonnet::ssi($feedurl,%moreenv);
1.10 albertel 3273: return $userview;
1.1 albertel 3274: }
1.116 albertel 3275:
3276: =pod
3277:
3278: =item * &submlink()
3279:
1.242 albertel 3280: Inputs: $text $uname $udom $symb $target
1.116 albertel 3281:
3282: Returns: A link to grades.pm such as to see the SUBM view of a student
3283:
3284: =cut
3285:
3286: ###############################################
3287: sub submlink {
1.242 albertel 3288: my ($text,$uname,$udom,$symb,$target)=@_;
1.116 albertel 3289: if (!($uname && $udom)) {
3290: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3291: &Apache::lonnet::whichuser($symb);
1.116 albertel 3292: if (!$symb) { $symb=$cursymb; }
3293: }
1.254 matthew 3294: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3295: $symb=&escape($symb);
1.242 albertel 3296: if ($target) { $target="target=\"$target\""; }
3297: return '<a href="/adm/grades?&command=submission&'.
3298: 'symb='.$symb.'&student='.$uname.
3299: '&userdom='.$udom.'" '.$target.'>'.$text.'</a>';
3300: }
3301: ##############################################
3302:
3303: =pod
3304:
3305: =item * &pgrdlink()
3306:
3307: Inputs: $text $uname $udom $symb $target
3308:
3309: Returns: A link to grades.pm such as to see the PGRD view of a student
3310:
3311: =cut
3312:
3313: ###############################################
3314: sub pgrdlink {
3315: my $link=&submlink(@_);
3316: $link=~s/(&command=submission)/$1&showgrading=yes/;
3317: return $link;
3318: }
3319: ##############################################
3320:
3321: =pod
3322:
3323: =item * &pprmlink()
3324:
3325: Inputs: $text $uname $udom $symb $target
3326:
3327: Returns: A link to parmset.pm such as to see the PPRM view of a
1.283 albertel 3328: student and a specific resource
1.242 albertel 3329:
3330: =cut
3331:
3332: ###############################################
3333: sub pprmlink {
3334: my ($text,$uname,$udom,$symb,$target)=@_;
3335: if (!($uname && $udom)) {
3336: (my $cursymb, my $courseid,$udom,$uname)=
1.463 albertel 3337: &Apache::lonnet::whichuser($symb);
1.242 albertel 3338: if (!$symb) { $symb=$cursymb; }
3339: }
1.254 matthew 3340: if (!$symb) { $symb=&Apache::lonnet::symbread(); }
1.369 www 3341: $symb=&escape($symb);
1.242 albertel 3342: if ($target) { $target="target=\"$target\""; }
1.595 albertel 3343: return '<a href="/adm/parmset?command=set&'.
3344: 'symb='.$symb.'&uname='.$uname.
3345: '&udom='.$udom.'" '.$target.'>'.$text.'</a>';
1.116 albertel 3346: }
3347: ##############################################
1.37 matthew 3348:
1.112 bowersj2 3349: =pod
3350:
3351: =back
3352:
3353: =cut
3354:
1.37 matthew 3355: ###############################################
1.51 www 3356:
3357:
3358: sub timehash {
1.687 raeburn 3359: my ($thistime) = @_;
3360: my $timezone = &Apache::lonlocal::gettimezone();
3361: my $dt = DateTime->from_epoch(epoch => $thistime)
3362: ->set_time_zone($timezone);
3363: my $wday = $dt->day_of_week();
3364: if ($wday == 7) { $wday = 0; }
3365: return ( 'second' => $dt->second(),
3366: 'minute' => $dt->minute(),
3367: 'hour' => $dt->hour(),
3368: 'day' => $dt->day_of_month(),
3369: 'month' => $dt->month(),
3370: 'year' => $dt->year(),
3371: 'weekday' => $wday,
3372: 'dayyear' => $dt->day_of_year(),
3373: 'dlsav' => $dt->is_dst() );
1.51 www 3374: }
3375:
1.370 www 3376: sub utc_string {
3377: my ($date)=@_;
1.371 www 3378: return strftime("%Y%m%dT%H%M%SZ",gmtime($date));
1.370 www 3379: }
3380:
1.51 www 3381: sub maketime {
3382: my %th=@_;
1.687 raeburn 3383: my ($epoch_time,$timezone,$dt);
3384: $timezone = &Apache::lonlocal::gettimezone();
3385: eval {
3386: $dt = DateTime->new( year => $th{'year'},
3387: month => $th{'month'},
3388: day => $th{'day'},
3389: hour => $th{'hour'},
3390: minute => $th{'minute'},
3391: second => $th{'second'},
3392: time_zone => $timezone,
3393: );
3394: };
3395: if (!$@) {
3396: $epoch_time = $dt->epoch;
3397: if ($epoch_time) {
3398: return $epoch_time;
3399: }
3400: }
1.51 www 3401: return POSIX::mktime(
3402: ($th{'seconds'},$th{'minutes'},$th{'hours'},
1.210 www 3403: $th{'day'},$th{'month'}-1,$th{'year'}-1900,0,0,-1));
1.70 www 3404: }
3405:
3406: #########################################
1.51 www 3407:
3408: sub findallcourses {
1.482 raeburn 3409: my ($roles,$uname,$udom) = @_;
1.355 albertel 3410: my %roles;
3411: if (ref($roles)) { %roles = map { $_ => 1 } @{$roles}; }
1.348 albertel 3412: my %courses;
1.51 www 3413: my $now=time;
1.482 raeburn 3414: if (!defined($uname)) {
3415: $uname = $env{'user.name'};
3416: }
3417: if (!defined($udom)) {
3418: $udom = $env{'user.domain'};
3419: }
3420: if (($uname ne $env{'user.name'}) || ($udom ne $env{'user.domain'})) {
3421: my %roleshash = &Apache::lonnet::dump('roles',$udom,$uname);
3422: if (!%roles) {
3423: %roles = (
3424: cc => 1,
3425: in => 1,
3426: ep => 1,
3427: ta => 1,
3428: cr => 1,
3429: st => 1,
3430: );
3431: }
3432: foreach my $entry (keys(%roleshash)) {
3433: my ($trole,$tend,$tstart) = split(/_/,$roleshash{$entry});
3434: if ($trole =~ /^cr/) {
3435: next if (!exists($roles{$trole}) && !exists($roles{'cr'}));
3436: } else {
3437: next if (!exists($roles{$trole}));
3438: }
3439: if ($tend) {
3440: next if ($tend < $now);
3441: }
3442: if ($tstart) {
3443: next if ($tstart > $now);
3444: }
3445: my ($cdom,$cnum,$sec,$cnumpart,$secpart,$role,$realsec);
3446: (undef,$cdom,$cnumpart,$secpart) = split(/\//,$entry);
3447: if ($secpart eq '') {
3448: ($cnum,$role) = split(/_/,$cnumpart);
3449: $sec = 'none';
3450: $realsec = '';
3451: } else {
3452: $cnum = $cnumpart;
3453: ($sec,$role) = split(/_/,$secpart);
3454: $realsec = $sec;
1.490 raeburn 3455: }
1.482 raeburn 3456: $courses{$cdom.'_'.$cnum}{$sec} = $trole.'/'.$cdom.'/'.$cnum.'/'.$realsec;
3457: }
3458: } else {
3459: foreach my $key (keys(%env)) {
1.483 albertel 3460: if ( $key=~m{^user\.role\.(\w+)\./($match_domain)/($match_courseid)/?(\w*)$} ||
3461: $key=~m{^user\.role\.(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_courseid)/?(\w*)$}) {
1.482 raeburn 3462: my ($role,$cdom,$cnum,$sec) = ($1,$2,$3,$4);
3463: next if ($role eq 'ca' || $role eq 'aa');
3464: next if (%roles && !exists($roles{$role}));
3465: my ($starttime,$endtime)=split(/\./,$env{$key});
3466: my $active=1;
3467: if ($starttime) {
3468: if ($now<$starttime) { $active=0; }
3469: }
3470: if ($endtime) {
3471: if ($now>$endtime) { $active=0; }
3472: }
3473: if ($active) {
3474: if ($sec eq '') {
3475: $sec = 'none';
3476: }
3477: $courses{$cdom.'_'.$cnum}{$sec} =
3478: $role.'/'.$cdom.'/'.$cnum.'/'.$sec;
1.474 raeburn 3479: }
3480: }
1.51 www 3481: }
3482: }
1.474 raeburn 3483: return %courses;
1.51 www 3484: }
1.37 matthew 3485:
1.54 www 3486: ###############################################
1.474 raeburn 3487:
3488: sub blockcheck {
1.482 raeburn 3489: my ($setters,$activity,$uname,$udom) = @_;
1.490 raeburn 3490:
3491: if (!defined($udom)) {
3492: $udom = $env{'user.domain'};
3493: }
3494: if (!defined($uname)) {
3495: $uname = $env{'user.name'};
3496: }
3497:
3498: # If uname and udom are for a course, check for blocks in the course.
3499:
3500: if (&Apache::lonnet::is_course($udom,$uname)) {
3501: my %records = &Apache::lonnet::dump('comm_block',$udom,$uname);
1.502 raeburn 3502: my ($startblock,$endblock)=&get_blocks($setters,$activity,$udom,$uname);
1.490 raeburn 3503: return ($startblock,$endblock);
3504: }
1.474 raeburn 3505:
1.502 raeburn 3506: my $startblock = 0;
3507: my $endblock = 0;
1.482 raeburn 3508: my %live_courses = &findallcourses(undef,$uname,$udom);
1.474 raeburn 3509:
1.490 raeburn 3510: # If uname is for a user, and activity is course-specific, i.e.,
3511: # boards, chat or groups, check for blocking in current course only.
1.474 raeburn 3512:
1.490 raeburn 3513: if (($activity eq 'boards' || $activity eq 'chat' ||
3514: $activity eq 'groups') && ($env{'request.course.id'})) {
3515: foreach my $key (keys(%live_courses)) {
3516: if ($key ne $env{'request.course.id'}) {
3517: delete($live_courses{$key});
3518: }
3519: }
3520: }
3521:
3522: my $otheruser = 0;
3523: my %own_courses;
3524: if ((($uname ne $env{'user.name'})) || ($udom ne $env{'user.domain'})) {
3525: # Resource belongs to user other than current user.
3526: $otheruser = 1;
3527: # Gather courses for current user
3528: %own_courses =
3529: &findallcourses(undef,$env{'user.name'},$env{'user.domain'});
3530: }
3531:
3532: # Gather active course roles - course coordinator, instructor,
3533: # exam proctor, ta, student, or custom role.
1.474 raeburn 3534:
3535: foreach my $course (keys(%live_courses)) {
1.482 raeburn 3536: my ($cdom,$cnum);
3537: if ((defined($env{'course.'.$course.'.domain'})) && (defined($env{'course.'.$course.'.num'}))) {
3538: $cdom = $env{'course.'.$course.'.domain'};
3539: $cnum = $env{'course.'.$course.'.num'};
3540: } else {
1.490 raeburn 3541: ($cdom,$cnum) = split(/_/,$course);
1.482 raeburn 3542: }
3543: my $no_ownblock = 0;
3544: my $no_userblock = 0;
1.533 raeburn 3545: if ($otheruser && $activity ne 'com') {
1.490 raeburn 3546: # Check if current user has 'evb' priv for this
3547: if (defined($own_courses{$course})) {
3548: foreach my $sec (keys(%{$own_courses{$course}})) {
3549: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
3550: if ($sec ne 'none') {
3551: $checkrole .= '/'.$sec;
3552: }
3553: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3554: $no_ownblock = 1;
3555: last;
3556: }
3557: }
3558: }
3559: # if they have 'evb' priv and are currently not playing student
3560: next if (($no_ownblock) &&
3561: ($env{'request.role'} !~ m{^st\./$cdom/$cnum}));
3562: }
1.474 raeburn 3563: foreach my $sec (keys(%{$live_courses{$course}})) {
1.482 raeburn 3564: my $checkrole = 'cm./'.$cdom.'/'.$cnum;
1.474 raeburn 3565: if ($sec ne 'none') {
1.482 raeburn 3566: $checkrole .= '/'.$sec;
1.474 raeburn 3567: }
1.490 raeburn 3568: if ($otheruser) {
3569: # Resource belongs to user other than current user.
3570: # Assemble privs for that user, and check for 'evb' priv.
1.482 raeburn 3571: my ($trole,$tdom,$tnum,$tsec);
3572: my $entry = $live_courses{$course}{$sec};
3573: if ($entry =~ /^cr/) {
3574: ($trole,$tdom,$tnum,$tsec) =
3575: ($entry =~ m|^(cr/$match_domain/$match_username/\w+)\./($match_domain)/($match_username)/?(\w*)$|);
3576: } else {
3577: ($trole,$tdom,$tnum,$tsec) = split(/\//,$entry);
3578: }
3579: my ($spec,$area,$trest,%allroles,%userroles);
3580: $area = '/'.$tdom.'/'.$tnum;
3581: $trest = $tnum;
3582: if ($tsec ne '') {
3583: $area .= '/'.$tsec;
3584: $trest .= '/'.$tsec;
3585: }
3586: $spec = $trole.'.'.$area;
3587: if ($trole =~ /^cr/) {
3588: &Apache::lonnet::custom_roleprivs(\%allroles,$trole,
3589: $tdom,$spec,$trest,$area);
3590: } else {
3591: &Apache::lonnet::standard_roleprivs(\%allroles,$trole,
3592: $tdom,$spec,$trest,$area);
3593: }
3594: my ($author,$adv) = &Apache::lonnet::set_userprivs(\%userroles,\%allroles);
1.486 raeburn 3595: if ($userroles{'user.priv.'.$checkrole} =~ /evb\&([^\:]*)/) {
3596: if ($1) {
3597: $no_userblock = 1;
3598: last;
3599: }
3600: }
1.490 raeburn 3601: } else {
3602: # Resource belongs to current user
3603: # Check for 'evb' priv via lonnet::allowed().
1.482 raeburn 3604: if (&Apache::lonnet::allowed('evb',undef,undef,$checkrole)) {
3605: $no_ownblock = 1;
3606: last;
3607: }
1.474 raeburn 3608: }
3609: }
3610: # if they have the evb priv and are currently not playing student
1.482 raeburn 3611: next if (($no_ownblock) &&
1.491 albertel 3612: ($env{'request.role'} !~ m{^st\./\Q$cdom\E/\Q$cnum\E}));
1.482 raeburn 3613: next if ($no_userblock);
1.474 raeburn 3614:
1.490 raeburn 3615: # Retrieve blocking times and identity of blocker for course
3616: # of specified user, unless user has 'evb' privilege.
1.502 raeburn 3617:
3618: my ($start,$end)=&get_blocks($setters,$activity,$cdom,$cnum);
3619: if (($start != 0) &&
3620: (($startblock == 0) || ($startblock > $start))) {
3621: $startblock = $start;
3622: }
3623: if (($end != 0) &&
3624: (($endblock == 0) || ($endblock < $end))) {
3625: $endblock = $end;
3626: }
1.490 raeburn 3627: }
3628: return ($startblock,$endblock);
3629: }
3630:
3631: sub get_blocks {
3632: my ($setters,$activity,$cdom,$cnum) = @_;
3633: my $startblock = 0;
3634: my $endblock = 0;
3635: my $course = $cdom.'_'.$cnum;
3636: $setters->{$course} = {};
3637: $setters->{$course}{'staff'} = [];
3638: $setters->{$course}{'times'} = [];
3639: my %records = &Apache::lonnet::dump('comm_block',$cdom,$cnum);
3640: foreach my $record (keys(%records)) {
3641: my ($start,$end) = ($record =~ m/^(\d+)____(\d+)$/);
3642: if ($start <= time && $end >= time) {
3643: my ($staff_name,$staff_dom,$title,$blocks) =
3644: &parse_block_record($records{$record});
3645: if ($blocks->{$activity} eq 'on') {
3646: push(@{$$setters{$course}{'staff'}},[$staff_name,$staff_dom]);
3647: push(@{$$setters{$course}{'times'}}, [$start,$end]);
1.491 albertel 3648: if ( ($startblock == 0) || ($startblock > $start) ) {
3649: $startblock = $start;
1.490 raeburn 3650: }
1.491 albertel 3651: if ( ($endblock == 0) || ($endblock < $end) ) {
3652: $endblock = $end;
1.474 raeburn 3653: }
3654: }
3655: }
3656: }
3657: return ($startblock,$endblock);
3658: }
3659:
3660: sub parse_block_record {
3661: my ($record) = @_;
3662: my ($setuname,$setudom,$title,$blocks);
3663: if (ref($record) eq 'HASH') {
3664: ($setuname,$setudom) = split(/:/,$record->{'setter'});
3665: $title = &unescape($record->{'event'});
3666: $blocks = $record->{'blocks'};
3667: } else {
3668: my @data = split(/:/,$record,3);
3669: if (scalar(@data) eq 2) {
3670: $title = $data[1];
3671: ($setuname,$setudom) = split(/@/,$data[0]);
3672: } else {
3673: ($setuname,$setudom,$title) = @data;
3674: }
3675: $blocks = { 'com' => 'on' };
3676: }
3677: return ($setuname,$setudom,$title,$blocks);
3678: }
3679:
3680: sub build_block_table {
3681: my ($startblock,$endblock,$setters) = @_;
3682: my %lt = &Apache::lonlocal::texthash(
3683: 'cacb' => 'Currently active communication blocks',
3684: 'cour' => 'Course',
3685: 'dura' => 'Duration',
3686: 'blse' => 'Block set by'
3687: );
3688: my $output;
1.476 raeburn 3689: $output = '<br />'.$lt{'cacb'}.':<br />';
1.474 raeburn 3690: $output .= &start_data_table();
3691: $output .= '
3692: <tr>
3693: <th>'.$lt{'cour'}.'</th>
3694: <th>'.$lt{'dura'}.'</th>
3695: <th>'.$lt{'blse'}.'</th>
3696: </tr>
3697: ';
3698: foreach my $course (keys(%{$setters})) {
3699: my %courseinfo=&Apache::lonnet::coursedescription($course);
3700: for (my $i=0; $i<@{$$setters{$course}{staff}}; $i++) {
3701: my ($uname,$udom) = @{$$setters{$course}{staff}[$i]};
1.490 raeburn 3702: my $fullname = &plainname($uname,$udom);
3703: if (defined($env{'user.name'}) && defined($env{'user.domain'})
3704: && $env{'user.name'} ne 'public'
3705: && $env{'user.domain'} ne 'public') {
3706: $fullname = &aboutmewrapper($fullname,$uname,$udom);
3707: }
1.474 raeburn 3708: my ($openblock,$closeblock) = @{$$setters{$course}{times}[$i]};
3709: $openblock = &Apache::lonlocal::locallocaltime($openblock);
3710: $closeblock= &Apache::lonlocal::locallocaltime($closeblock);
3711: $output .= &Apache::loncommon::start_data_table_row().
3712: '<td>'.$courseinfo{'description'}.'</td>'.
3713: '<td>'.$openblock.' to '.$closeblock.'</td>'.
1.490 raeburn 3714: '<td>'.$fullname.'</td>'.
1.474 raeburn 3715: &Apache::loncommon::end_data_table_row();
3716: }
3717: }
3718: $output .= &end_data_table();
3719: }
3720:
1.490 raeburn 3721: sub blocking_status {
3722: my ($activity,$uname,$udom) = @_;
3723: my %setters;
3724: my ($blocked,$output,$ownitem,$is_course);
3725: my ($startblock,$endblock)=&blockcheck(\%setters,$activity,$uname,$udom);
3726: if ($startblock && $endblock) {
3727: $blocked = 1;
3728: if (wantarray) {
3729: my $category;
3730: if ($activity eq 'boards') {
3731: $category = 'Discussion posts in this course';
3732: } elsif ($activity eq 'blogs') {
3733: $category = 'Blogs';
3734: } elsif ($activity eq 'port') {
3735: if (defined($uname) && defined($udom)) {
3736: if ($uname eq $env{'user.name'} &&
3737: $udom eq $env{'user.domain'}) {
3738: $ownitem = 1;
3739: }
3740: }
3741: $is_course = &Apache::lonnet::is_course($udom,$uname);
3742: if ($ownitem) {
3743: $category = 'Your portfolio files';
3744: } elsif ($is_course) {
3745: my $coursedesc;
3746: foreach my $course (keys(%setters)) {
3747: my %courseinfo =
3748: &Apache::lonnet::coursedescription($course);
3749: $coursedesc = $courseinfo{'description'};
3750: }
3751: $category = "Group files in the course '$coursedesc'";
3752: } else {
3753: $category = 'Portfolio files belonging to ';
3754: if ($env{'user.name'} eq 'public' &&
3755: $env{'user.domain'} eq 'public') {
3756: $category .= &plainname($uname,$udom);
3757: } else {
3758: $category .= &aboutmewrapper(&plainname($uname,$udom),$uname,$udom);
3759: }
3760: }
3761: } elsif ($activity eq 'groups') {
3762: $category = 'Groups in this course';
3763: }
3764: my $showstart = &Apache::lonlocal::locallocaltime($startblock);
3765: my $showend = &Apache::lonlocal::locallocaltime($endblock);
3766: $output = '<br />'.&mt('[_1] will be inaccessible between [_2] and [_3] because communication is being blocked.',$category,$showstart,$showend).'<br />';
3767: if (!($activity eq 'port' && !($ownitem) && !($is_course))) {
3768: $output .= &build_block_table($startblock,$endblock,\%setters);
3769: }
3770: }
3771: }
3772: if (wantarray) {
3773: return ($blocked,$output);
3774: } else {
3775: return $blocked;
3776: }
3777: }
3778:
1.60 matthew 3779: ###############################################
3780:
1.682 raeburn 3781: sub check_ip_acc {
3782: my ($acc)=@_;
3783: &Apache::lonxml::debug("acc is $acc");
3784: if (!defined($acc) || $acc =~ /^\s*$/ || $acc =~/^\s*no\s*$/i) {
3785: return 1;
3786: }
3787: my $allowed=0;
3788: my $ip=$env{'request.host'} || $ENV{'REMOTE_ADDR'};
3789:
3790: my $name;
3791: foreach my $pattern (split(',',$acc)) {
3792: $pattern =~ s/^\s*//;
3793: $pattern =~ s/\s*$//;
3794: if ($pattern =~ /\*$/) {
3795: #35.8.*
3796: $pattern=~s/\*//;
3797: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3798: } elsif ($pattern =~ /(\d+\.\d+\.\d+)\.\[(\d+)-(\d+)\]$/) {
3799: #35.8.3.[34-56]
3800: my $low=$2;
3801: my $high=$3;
3802: $pattern=$1;
3803: if ($ip =~ /^\Q$pattern\E/) {
3804: my $last=(split(/\./,$ip))[3];
3805: if ($last <=$high && $last >=$low) { $allowed=1; }
3806: }
3807: } elsif ($pattern =~ /^\*/) {
3808: #*.msu.edu
3809: $pattern=~s/\*//;
3810: if (!defined($name)) {
3811: use Socket;
3812: my $netaddr=inet_aton($ip);
3813: ($name)=gethostbyaddr($netaddr,AF_INET);
3814: }
3815: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3816: } elsif ($pattern =~ /\d+\.\d+\.\d+\.\d+/) {
3817: #127.0.0.1
3818: if ($ip =~ /^\Q$pattern\E/) { $allowed=1; }
3819: } else {
3820: #some.name.com
3821: if (!defined($name)) {
3822: use Socket;
3823: my $netaddr=inet_aton($ip);
3824: ($name)=gethostbyaddr($netaddr,AF_INET);
3825: }
3826: if ($name =~ /\Q$pattern\E$/i) { $allowed=1; }
3827: }
3828: if ($allowed) { last; }
3829: }
3830: return $allowed;
3831: }
3832:
3833: ###############################################
3834:
1.60 matthew 3835: =pod
3836:
1.112 bowersj2 3837: =head1 Domain Template Functions
3838:
3839: =over 4
3840:
3841: =item * &determinedomain()
1.60 matthew 3842:
3843: Inputs: $domain (usually will be undef)
3844:
1.63 www 3845: Returns: Determines which domain should be used for designs
1.60 matthew 3846:
3847: =cut
1.54 www 3848:
1.60 matthew 3849: ###############################################
1.63 www 3850: sub determinedomain {
3851: my $domain=shift;
1.531 albertel 3852: if (! $domain) {
1.60 matthew 3853: # Determine domain if we have not been given one
3854: $domain = $Apache::lonnet::perlvar{'lonDefDomain'};
1.258 albertel 3855: if ($env{'user.domain'}) { $domain=$env{'user.domain'}; }
3856: if ($env{'request.role.domain'}) {
3857: $domain=$env{'request.role.domain'};
1.60 matthew 3858: }
3859: }
1.63 www 3860: return $domain;
3861: }
3862: ###############################################
1.517 raeburn 3863:
1.518 albertel 3864: sub devalidate_domconfig_cache {
3865: my ($udom)=@_;
3866: &Apache::lonnet::devalidate_cache_new('domainconfig',$udom);
3867: }
3868:
3869: # ---------------------- Get domain configuration for a domain
3870: sub get_domainconf {
3871: my ($udom) = @_;
3872: my $cachetime=1800;
3873: my ($result,$cached)=&Apache::lonnet::is_cached_new('domainconfig',$udom);
3874: if (defined($cached)) { return %{$result}; }
3875:
3876: my %domconfig = &Apache::lonnet::get_dom('configuration',
3877: ['login','rolecolors'],$udom);
1.632 raeburn 3878: my (%designhash,%legacy);
1.518 albertel 3879: if (keys(%domconfig) > 0) {
3880: if (ref($domconfig{'login'}) eq 'HASH') {
1.632 raeburn 3881: if (keys(%{$domconfig{'login'}})) {
3882: foreach my $key (keys(%{$domconfig{'login'}})) {
1.692.2.2 raeburn 3883: if (ref($domconfig{'login'}{$key}) eq 'HASH') {
3884: foreach my $img (keys(%{$domconfig{'login'}{$key}})) {
3885: $designhash{$udom.'.login.'.$key.'_'.$img} =
3886: $domconfig{'login'}{$key}{$img};
3887: }
3888: } else {
3889: $designhash{$udom.'.login.'.$key}=$domconfig{'login'}{$key};
3890: }
1.632 raeburn 3891: }
3892: } else {
3893: $legacy{'login'} = 1;
1.518 albertel 3894: }
1.632 raeburn 3895: } else {
3896: $legacy{'login'} = 1;
1.518 albertel 3897: }
3898: if (ref($domconfig{'rolecolors'}) eq 'HASH') {
1.632 raeburn 3899: if (keys(%{$domconfig{'rolecolors'}})) {
3900: foreach my $role (keys(%{$domconfig{'rolecolors'}})) {
3901: if (ref($domconfig{'rolecolors'}{$role}) eq 'HASH') {
3902: foreach my $item (keys(%{$domconfig{'rolecolors'}{$role}})) {
3903: $designhash{$udom.'.'.$role.'.'.$item}=$domconfig{'rolecolors'}{$role}{$item};
3904: }
1.518 albertel 3905: }
3906: }
1.632 raeburn 3907: } else {
3908: $legacy{'rolecolors'} = 1;
1.518 albertel 3909: }
1.632 raeburn 3910: } else {
3911: $legacy{'rolecolors'} = 1;
1.518 albertel 3912: }
1.632 raeburn 3913: if (keys(%legacy) > 0) {
3914: my %legacyhash = &get_legacy_domconf($udom);
3915: foreach my $item (keys(%legacyhash)) {
3916: if ($item =~ /^\Q$udom\E\.login/) {
3917: if ($legacy{'login'}) {
3918: $designhash{$item} = $legacyhash{$item};
3919: }
3920: } else {
3921: if ($legacy{'rolecolors'}) {
3922: $designhash{$item} = $legacyhash{$item};
3923: }
1.518 albertel 3924: }
3925: }
3926: }
1.632 raeburn 3927: } else {
3928: %designhash = &get_legacy_domconf($udom);
1.518 albertel 3929: }
3930: &Apache::lonnet::do_cache_new('domainconfig',$udom,\%designhash,
3931: $cachetime);
3932: return %designhash;
3933: }
3934:
1.632 raeburn 3935: sub get_legacy_domconf {
3936: my ($udom) = @_;
3937: my %legacyhash;
3938: my $designdir=$Apache::lonnet::perlvar{'lonTabDir'}.'/lonDomColors';
3939: my $designfile = $designdir.'/'.$udom.'.tab';
3940: if (-e $designfile) {
3941: if ( open (my $fh,"<$designfile") ) {
3942: while (my $line = <$fh>) {
3943: next if ($line =~ /^\#/);
3944: chomp($line);
3945: my ($key,$val)=(split(/\=/,$line));
3946: if ($val) { $legacyhash{$udom.'.'.$key}=$val; }
3947: }
3948: close($fh);
3949: }
3950: }
3951: if (-e '/home/httpd/html/adm/lonDomLogos/'.$udom.'.gif') {
3952: $legacyhash{$udom.'.login.domlogo'} = "/adm/lonDomLogos/$udom.gif";
3953: }
3954: return %legacyhash;
3955: }
3956:
1.63 www 3957: =pod
3958:
1.112 bowersj2 3959: =item * &domainlogo()
1.63 www 3960:
3961: Inputs: $domain (usually will be undef)
3962:
3963: Returns: A link to a domain logo, if the domain logo exists.
3964: If the domain logo does not exist, a description of the domain.
3965:
3966: =cut
1.112 bowersj2 3967:
1.63 www 3968: ###############################################
3969: sub domainlogo {
1.517 raeburn 3970: my $domain = &determinedomain(shift);
1.518 albertel 3971: my %designhash = &get_domainconf($domain);
1.517 raeburn 3972: # See if there is a logo
3973: if ($designhash{$domain.'.login.domlogo'} ne '') {
1.519 raeburn 3974: my $imgsrc = $designhash{$domain.'.login.domlogo'};
1.538 albertel 3975: if ($imgsrc =~ m{^/(adm|res)/}) {
3976: if ($imgsrc =~ m{^/res/}) {
3977: my $local_name = &Apache::lonnet::filelocation('',$imgsrc);
3978: &Apache::lonnet::repcopy($local_name);
3979: }
3980: $imgsrc = &lonhttpdurl($imgsrc);
1.519 raeburn 3981: }
3982: return '<img src="'.$imgsrc.'" alt="'.$domain.'" />';
1.514 albertel 3983: } elsif (defined(&Apache::lonnet::domain($domain,'description'))) {
3984: return &Apache::lonnet::domain($domain,'description');
1.59 www 3985: } else {
1.60 matthew 3986: return '';
1.59 www 3987: }
3988: }
1.63 www 3989: ##############################################
3990:
3991: =pod
3992:
1.112 bowersj2 3993: =item * &designparm()
1.63 www 3994:
3995: Inputs: $which parameter; $domain (usually will be undef)
3996:
3997: Returns: value of designparamter $which
3998:
3999: =cut
1.112 bowersj2 4000:
1.397 albertel 4001:
1.400 albertel 4002: ##############################################
1.397 albertel 4003: sub designparm {
4004: my ($which,$domain)=@_;
1.258 albertel 4005: if ($env{'browser.blackwhite'} eq 'on') {
1.635 raeburn 4006: if ($which=~/\.(font|alink|vlink|link|textcol)$/) {
1.110 www 4007: return '#000000';
4008: }
1.635 raeburn 4009: if ($which=~/\.(pgbg|sidebg|bgcol)$/) {
1.110 www 4010: return '#FFFFFF';
4011: }
4012: if ($which=~/\.tabbg$/) {
4013: return '#CCCCCC';
4014: }
4015: }
1.397 albertel 4016: if (exists($env{'environment.color.'.$which})) {
1.258 albertel 4017: return $env{'environment.color.'.$which};
1.96 www 4018: }
1.63 www 4019: $domain=&determinedomain($domain);
1.518 albertel 4020: my %domdesign = &get_domainconf($domain);
1.520 raeburn 4021: my $output;
1.517 raeburn 4022: if ($domdesign{$domain.'.'.$which} ne '') {
1.520 raeburn 4023: $output = $domdesign{$domain.'.'.$which};
1.63 www 4024: } else {
1.520 raeburn 4025: $output = $defaultdesign{$which};
4026: }
4027: if (($which =~ /^(student|coordinator|author|admin)\.img$/) ||
1.635 raeburn 4028: ($which =~ /login\.(img|logo|domlogo|login)/)) {
1.538 albertel 4029: if ($output =~ m{^/(adm|res)/}) {
4030: if ($output =~ m{^/res/}) {
4031: my $local_name = &Apache::lonnet::filelocation('',$output);
4032: &Apache::lonnet::repcopy($local_name);
4033: }
1.520 raeburn 4034: $output = &lonhttpdurl($output);
4035: }
1.63 www 4036: }
1.520 raeburn 4037: return $output;
1.63 www 4038: }
1.59 www 4039:
1.60 matthew 4040: ###############################################
4041: ###############################################
4042:
4043: =pod
4044:
1.112 bowersj2 4045: =back
4046:
1.549 albertel 4047: =head1 HTML Helpers
1.112 bowersj2 4048:
4049: =over 4
4050:
4051: =item * &bodytag()
1.60 matthew 4052:
4053: Returns a uniform header for LON-CAPA web pages.
4054:
4055: Inputs:
4056:
1.112 bowersj2 4057: =over 4
4058:
4059: =item * $title, A title to be displayed on the page.
4060:
4061: =item * $function, the current role (can be undef).
4062:
4063: =item * $addentries, extra parameters for the <body> tag.
4064:
4065: =item * $bodyonly, if defined, only return the <body> tag.
4066:
4067: =item * $domain, if defined, force a given domain.
4068:
4069: =item * $forcereg, if page should register as content page (relevant for
1.86 www 4070: text interface only)
1.60 matthew 4071:
1.326 albertel 4072: =item * $customtitle, alternate text to use instead of $title
4073: in the title box that appears, this text
4074: is not auto translated like the $title is
1.309 albertel 4075:
4076: =item * $notopbar, if true, keep the 'what is this' info but remove the
4077: navigational links
1.317 albertel 4078:
1.338 albertel 4079: =item * $bgcolor, used to override the bgcolor on a webpage to a specific value
4080:
4081: =item * $notitle, if true keep the nav controls, but remove the title bar
4082:
1.361 albertel 4083: =item * $no_inline_link, if true and in remote mode, don't show the
4084: 'Switch To Inline Menu' link
4085:
1.460 albertel 4086: =item * $args, optional argument valid values are
4087: no_auto_mt_title -> prevents &mt()ing the title arg
1.562 albertel 4088: inherit_jsmath -> when creating popup window in a page,
4089: should it have jsmath forced on by the
4090: current page
1.460 albertel 4091:
1.112 bowersj2 4092: =back
4093:
1.60 matthew 4094: Returns: A uniform header for LON-CAPA web pages.
4095: If $bodyonly is nonzero, a string containing a <body> tag will be returned.
4096: If $bodyonly is undef or zero, an html string containing a <body> tag and
4097: other decorations will be returned.
4098:
4099: =cut
4100:
1.54 www 4101: sub bodytag {
1.309 albertel 4102: my ($title,$function,$addentries,$bodyonly,$domain,$forcereg,$customtitle,
1.460 albertel 4103: $notopbar,$bgcolor,$notitle,$no_inline_link,$args)=@_;
1.339 albertel 4104:
1.460 albertel 4105: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
1.339 albertel 4106:
1.183 matthew 4107: $function = &get_users_function() if (!$function);
1.339 albertel 4108: my $img = &designparm($function.'.img',$domain);
4109: my $font = &designparm($function.'.font',$domain);
4110: my $pgbg = $bgcolor || &designparm($function.'.pgbg',$domain);
4111:
4112: my %design = ( 'style' => 'margin-top: 0px',
1.535 albertel 4113: 'bgcolor' => $pgbg,
1.339 albertel 4114: 'text' => $font,
4115: 'alink' => &designparm($function.'.alink',$domain),
4116: 'vlink' => &designparm($function.'.vlink',$domain),
4117: 'link' => &designparm($function.'.link',$domain),);
1.438 albertel 4118: @design{keys(%$addentries)} = @$addentries{keys(%$addentries)};
1.339 albertel 4119:
1.63 www 4120: # role and realm
1.378 raeburn 4121: my ($role,$realm) = split(/\./,$env{'request.role'},2);
4122: if ($role eq 'ca') {
1.479 albertel 4123: my ($rdom,$rname) = ($realm =~ m{^/($match_domain)/($match_username)$});
1.500 albertel 4124: $realm = &plainname($rname,$rdom);
1.378 raeburn 4125: }
1.55 www 4126: # realm
1.258 albertel 4127: if ($env{'request.course.id'}) {
1.378 raeburn 4128: if ($env{'request.role'} !~ /^cr/) {
4129: $role = &Apache::lonnet::plaintext($role,&course_type());
4130: }
1.359 albertel 4131: $realm = $env{'course.'.$env{'request.course.id'}.'.description'};
1.378 raeburn 4132: } else {
4133: $role = &Apache::lonnet::plaintext($role);
1.54 www 4134: }
1.433 albertel 4135:
1.359 albertel 4136: if (!$realm) { $realm=' '; }
1.55 www 4137: # Set messages
1.60 matthew 4138: my $messages=&domainlogo($domain);
1.330 albertel 4139:
1.438 albertel 4140: my $extra_body_attr = &make_attr_string($forcereg,\%design);
1.329 albertel 4141:
1.101 www 4142: # construct main body tag
1.359 albertel 4143: my $bodytag = "<body $extra_body_attr>".
1.562 albertel 4144: &Apache::lontexconvert::init_math_support($args->{'inherit_jsmath'});
1.252 albertel 4145:
1.530 albertel 4146: if ($bodyonly) {
1.60 matthew 4147: return $bodytag;
1.258 albertel 4148: } elsif ($env{'browser.interface'} eq 'textual') {
1.95 www 4149: # Accessibility
1.224 raeburn 4150:
1.337 albertel 4151: $bodytag.=&Apache::lonmenu::menubuttons($forcereg,$forcereg);
1.338 albertel 4152: if (!$notitle) {
1.337 albertel 4153: $bodytag.='<h1>LON-CAPA: '.$title.'</h1>';
4154: }
4155: return $bodytag;
1.359 albertel 4156: }
4157:
1.410 albertel 4158: my $name = &plainname($env{'user.name'},$env{'user.domain'});
1.433 albertel 4159: if ($env{'user.name'} eq 'public' && $env{'user.domain'} eq 'public') {
4160: undef($role);
1.434 albertel 4161: } else {
4162: $name = &aboutmewrapper($name,$env{'user.name'},$env{'user.domain'});
1.433 albertel 4163: }
1.359 albertel 4164:
4165: my $roleinfo=(<<ENDROLE);
4166: <td class="LC_title_bar_who">
4167: <div class="LC_title_bar_name">
1.410 albertel 4168: $name
1.361 albertel 4169:
1.359 albertel 4170: </div>
4171: <div class="LC_title_bar_role">
1.361 albertel 4172: $role
1.359 albertel 4173: </div>
4174: <div class="LC_title_bar_realm">
1.361 albertel 4175: $realm
1.359 albertel 4176: </div>
1.206 albertel 4177: </td>
4178: ENDROLE
1.235 raeburn 4179:
1.359 albertel 4180: my $titleinfo = '<span class="LC_title_bar_title">'.$title.'</span>';
4181: if ($customtitle) {
4182: $titleinfo = $customtitle;
4183: }
4184: #
4185: # Extra info if you are the DC
4186: my $dc_info = '';
4187: if ($env{'user.adv'} && exists($env{'user.role.dc./'.
4188: $env{'course.'.$env{'request.course.id'}.
4189: '.domain'}.'/'})) {
4190: my $cid = $env{'request.course.id'};
4191: $dc_info.= $cid.' '.$env{'course.'.$cid.'.internal.coursecode'};
1.380 www 4192: $dc_info =~ s/\s+$//;
1.359 albertel 4193: $dc_info = '('.$dc_info.')';
4194: }
4195:
1.644 www 4196: if (($env{'environment.remote'} eq 'off') || ($args->{'suppress_header_logos'})) {
1.359 albertel 4197: # No Remote
1.258 albertel 4198: if ($env{'request.state'} eq 'construct') {
1.359 albertel 4199: $forcereg=1;
4200: }
4201:
4202: if (!$customtitle && $env{'request.state'} eq 'construct') {
4203: # this is for resources; directories have customtitle, and crumbs
4204: # and select recent are created in lonpubdir.pm
1.229 albertel 4205: my ($uname,$thisdisfn)=
1.258 albertel 4206: ($env{'request.filename'} =~ m|^/home/([^/]+)/public_html/(.*)|);
1.229 albertel 4207: my $formaction='/priv/'.$uname.'/'.$thisdisfn;
4208: $formaction=~s/\/+/\//g;
4209:
1.359 albertel 4210: my $parentpath = '';
4211: my $lastitem = '';
4212: if ($thisdisfn =~ m-(.+/)([^/]*)$-) {
4213: $parentpath = $1;
4214: $lastitem = $2;
4215: } else {
4216: $lastitem = $thisdisfn;
4217: }
4218: $titleinfo =
1.640 bisitz 4219: &Apache::loncommon::help_open_menu('','',3,'Authoring')
4220: .'<b>'.&mt('Construction Space').'</b>: '
4221: .'<form name="dirs" method="post" action="'.$formaction
1.359 albertel 4222: .'" target="_top"><tt><b>'
4223: .&Apache::lonhtmlcommon::crumbs($uname.'/'.$parentpath,'_top','/priv','','+1',1)."<font size=\"+1\">$lastitem</font></b></tt><br />"
4224: .&Apache::lonhtmlcommon::select_recent('construct','recent','this.form.action=this.form.recent.value;this.form.submit()')
4225: .'</form>'
4226: .&Apache::lonmenu::constspaceform();
1.235 raeburn 4227: }
1.359 albertel 4228:
1.337 albertel 4229: my $titletable;
1.338 albertel 4230: if (!$notitle) {
1.337 albertel 4231: $titletable =
1.359 albertel 4232: '<table id="LC_title_bar">'.
4233: "<tr><td> $titleinfo $dc_info</td>".$roleinfo.
4234: '</tr></table>';
1.337 albertel 4235: }
1.359 albertel 4236: if ($notopbar) {
4237: $bodytag .= $titletable;
4238: } else {
4239: if ($env{'request.state'} eq 'construct') {
1.337 albertel 4240: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg,
4241: $titletable);
1.272 raeburn 4242: } else {
1.336 albertel 4243: $bodytag .= &Apache::lonmenu::menubuttons($forcereg,$forcereg).
1.359 albertel 4244: $titletable;
1.272 raeburn 4245: }
1.235 raeburn 4246: }
4247: return $bodytag;
1.94 www 4248: }
1.95 www 4249:
1.93 www 4250: #
1.95 www 4251: # Top frame rendering, Remote is up
1.93 www 4252: #
1.359 albertel 4253:
1.517 raeburn 4254: my $imgsrc = $img;
4255: if ($img =~ /^\/adm/) {
1.575 albertel 4256: $imgsrc = &lonhttpdurl($img);
1.517 raeburn 4257: }
4258: my $upperleft='<img src="'.$imgsrc.'" alt="'.$function.'" />';
1.359 albertel 4259:
1.305 www 4260: # Explicit link to get inline menu
1.361 albertel 4261: my $menu= ($no_inline_link?''
4262: :'<br /><a href="/adm/remote?action=collapse">'.&mt('Switch to Inline Menu Mode').'</a>');
1.245 matthew 4263: #
1.338 albertel 4264: if ($notitle) {
1.337 albertel 4265: return $bodytag;
4266: }
1.94 www 4267: return(<<ENDBODY);
1.60 matthew 4268: $bodytag
1.359 albertel 4269: <table id="LC_title_bar" class="LC_with_remote">
1.368 albertel 4270: <tr><td class="LC_title_bar_role_logo">$upperleft</td>
1.359 albertel 4271: <td class="LC_title_bar_domain_logo">$messages </td>
1.54 www 4272: </tr>
1.359 albertel 4273: <tr><td>$titleinfo $dc_info $menu</td>
4274: $roleinfo
1.368 albertel 4275: </tr>
1.356 albertel 4276: </table>
1.54 www 4277: ENDBODY
1.182 matthew 4278: }
4279:
1.330 albertel 4280: sub make_attr_string {
4281: my ($register,$attr_ref) = @_;
4282:
4283: if ($attr_ref && !ref($attr_ref)) {
4284: die("addentries Must be a hash ref ".
4285: join(':',caller(1))." ".
4286: join(':',caller(0))." ");
4287: }
4288:
4289: if ($register) {
1.339 albertel 4290: my ($on_load,$on_unload);
4291: foreach my $key (keys(%{$attr_ref})) {
4292: if (lc($key) eq 'onload') {
4293: $on_load.=$attr_ref->{$key}.';';
4294: delete($attr_ref->{$key});
4295:
4296: } elsif (lc($key) eq 'onunload') {
4297: $on_unload.=$attr_ref->{$key}.';';
4298: delete($attr_ref->{$key});
4299: }
4300: }
4301: $attr_ref->{'onload'} =
4302: &Apache::lonmenu::loadevents(). $on_load;
4303: $attr_ref->{'onunload'}=
4304: &Apache::lonmenu::unloadevents().$on_unload;
4305: }
4306:
4307: # Accessibility font enhance
4308: if ($env{'browser.fontenhance'} eq 'on') {
4309: my $style;
4310: foreach my $key (keys(%{$attr_ref})) {
4311: if (lc($key) eq 'style') {
4312: $style.=$attr_ref->{$key}.';';
4313: delete($attr_ref->{$key});
4314: }
4315: }
4316: $attr_ref->{'style'}=$style.'; font-size: x-large;';
1.330 albertel 4317: }
1.339 albertel 4318:
4319: if ($env{'browser.blackwhite'} eq 'on') {
4320: delete($attr_ref->{'font'});
4321: delete($attr_ref->{'link'});
4322: delete($attr_ref->{'alink'});
4323: delete($attr_ref->{'vlink'});
4324: delete($attr_ref->{'bgcolor'});
4325: delete($attr_ref->{'background'});
4326: }
4327:
1.330 albertel 4328: my $attr_string;
4329: foreach my $attr (keys(%$attr_ref)) {
4330: $attr_string .= " $attr=\"".$attr_ref->{$attr}.'" ';
4331: }
4332: return $attr_string;
4333: }
4334:
4335:
1.182 matthew 4336: ###############################################
1.251 albertel 4337: ###############################################
4338:
4339: =pod
4340:
4341: =item * &endbodytag()
4342:
4343: Returns a uniform footer for LON-CAPA web pages.
4344:
1.635 raeburn 4345: Inputs: 1 - optional reference to an args hash
4346: If in the hash, key for noredirectlink has a value which evaluates to true,
4347: a 'Continue' link is not displayed if the page contains an
4348: internal redirect in the <head></head> section,
4349: i.e., $env{'internal.head.redirect'} exists
1.251 albertel 4350:
4351: =cut
4352:
4353: sub endbodytag {
1.635 raeburn 4354: my ($args) = @_;
1.251 albertel 4355: my $endbodytag='</body>';
1.269 albertel 4356: $endbodytag=&Apache::lontexconvert::jsMath_process()."\n".$endbodytag;
1.315 albertel 4357: if ( exists( $env{'internal.head.redirect'} ) ) {
1.635 raeburn 4358: if (!(ref($args) eq 'HASH' && $args->{'noredirectlink'})) {
4359: $endbodytag=
4360: "<br /><a href=\"$env{'internal.head.redirect'}\">".
4361: &mt('Continue').'</a>'.
4362: $endbodytag;
4363: }
1.315 albertel 4364: }
1.251 albertel 4365: return $endbodytag;
4366: }
4367:
1.352 albertel 4368: =pod
4369:
4370: =item * &standard_css()
4371:
4372: Returns a style sheet
4373:
4374: Inputs: (all optional)
4375: domain -> force to color decorate a page for a specific
4376: domain
4377: function -> force usage of a specific rolish color scheme
4378: bgcolor -> override the default page bgcolor
4379:
4380: =cut
4381:
1.343 albertel 4382: sub standard_css {
1.345 albertel 4383: my ($function,$domain,$bgcolor) = @_;
1.352 albertel 4384: $function = &get_users_function() if (!$function);
4385: my $img = &designparm($function.'.img', $domain);
4386: my $tabbg = &designparm($function.'.tabbg', $domain);
4387: my $font = &designparm($function.'.font', $domain);
1.345 albertel 4388: my $sidebg = &designparm($function.'.sidebg',$domain);
1.382 albertel 4389: my $pgbg_or_bgcolor =
4390: $bgcolor ||
1.352 albertel 4391: &designparm($function.'.pgbg', $domain);
1.382 albertel 4392: my $pgbg = &designparm($function.'.pgbg', $domain);
1.352 albertel 4393: my $alink = &designparm($function.'.alink', $domain);
4394: my $vlink = &designparm($function.'.vlink', $domain);
4395: my $link = &designparm($function.'.link', $domain);
4396:
1.602 albertel 4397: my $sans = 'Verdana,Arial,Helvetica,sans-serif';
1.395 albertel 4398: my $mono = 'monospace';
1.352 albertel 4399: my $data_table_head = $tabbg;
4400: my $data_table_light = '#EEEEEE';
1.470 banghart 4401: my $data_table_dark = '#DDDDDD';
4402: my $data_table_darker = '#CCCCCC';
1.349 albertel 4403: my $data_table_highlight = '#FFFF00';
1.352 albertel 4404: my $mail_new = '#FFBB77';
4405: my $mail_new_hover = '#DD9955';
4406: my $mail_read = '#BBBB77';
4407: my $mail_read_hover = '#999944';
4408: my $mail_replied = '#AAAA88';
4409: my $mail_replied_hover = '#888855';
4410: my $mail_other = '#99BBBB';
4411: my $mail_other_hover = '#669999';
1.391 albertel 4412: my $table_header = '#DDDDDD';
1.489 raeburn 4413: my $feedback_link_bg = '#BBBBBB';
1.392 albertel 4414:
1.608 albertel 4415: my $border = ($env{'browser.type'} eq 'explorer' ||
4416: $env{'browser.type'} eq 'safari' ) ? '0px 2px 0px 2px'
4417: : '0px 3px 0px 4px';
1.448 albertel 4418:
1.523 albertel 4419:
1.343 albertel 4420: return <<END;
1.345 albertel 4421: h1, h2, h3, th { font-family: $sans }
1.343 albertel 4422: a:focus { color: red; background: yellow }
1.510 albertel 4423: table.thinborder,
1.523 albertel 4424:
1.510 albertel 4425: table.thinborder tr th {
4426: border-style: solid;
4427: border-width: 1px;
4428: background: $tabbg;
4429: }
1.523 albertel 4430: table.thinborder tr td {
1.510 albertel 4431: border-style: solid;
4432: border-width: 1px
4433: }
1.426 albertel 4434:
1.343 albertel 4435: form, .inline { display: inline; }
4436: .center { text-align: center; }
1.593 albertel 4437: .LC_filename {font-family: $mono; white-space:pre;}
1.350 albertel 4438: .LC_error {
4439: color: red;
4440: font-size: larger;
4441: }
1.457 albertel 4442: .LC_warning,
4443: .LC_diff_removed {
1.394 albertel 4444: color: red;
4445: }
1.532 albertel 4446:
4447: .LC_info,
1.457 albertel 4448: .LC_success,
4449: .LC_diff_added {
1.350 albertel 4450: color: green;
4451: }
1.543 albertel 4452: .LC_unknown {
4453: color: yellow;
4454: }
4455:
1.440 albertel 4456: .LC_icon {
4457: border: 0px;
4458: }
1.539 albertel 4459: .LC_indexer_icon {
4460: border: 0px;
4461: height: 22px;
4462: }
1.543 albertel 4463: .LC_docs_spacer {
4464: width: 25px;
4465: height: 1px;
4466: border: 0px;
4467: }
1.346 albertel 4468:
1.532 albertel 4469: .LC_internal_info {
4470: color: #999;
4471: }
4472:
1.458 albertel 4473: table.LC_pastsubmission {
4474: border: 1px solid black;
4475: margin: 2px;
4476: }
4477:
1.606 albertel 4478: table#LC_top_nav, table#LC_menubuttons,table#LC_nav_location {
1.345 albertel 4479: width: 100%;
4480: background: $pgbg;
1.392 albertel 4481: border: 2px;
1.402 albertel 4482: border-collapse: separate;
1.403 albertel 4483: padding: 0px;
1.345 albertel 4484: }
1.392 albertel 4485:
1.606 albertel 4486: table#LC_title_bar, table.LC_breadcrumbs,
1.393 albertel 4487: table#LC_title_bar.LC_with_remote {
1.359 albertel 4488: width: 100%;
1.392 albertel 4489: border-color: $pgbg;
4490: border-style: solid;
4491: border-width: $border;
4492:
1.379 albertel 4493: background: $pgbg;
4494: font-family: $sans;
1.392 albertel 4495: border-collapse: collapse;
1.403 albertel 4496: padding: 0px;
1.359 albertel 4497: }
1.392 albertel 4498:
1.409 albertel 4499: table.LC_docs_path {
4500: width: 100%;
4501: border: 0;
4502: background: $pgbg;
4503: font-family: $sans;
4504: border-collapse: collapse;
4505: padding: 0px;
4506: }
4507:
1.359 albertel 4508: table#LC_title_bar td {
4509: background: $tabbg;
4510: }
4511: table#LC_title_bar td.LC_title_bar_who {
4512: background: $tabbg;
4513: color: $font;
1.427 albertel 4514: font: small $sans;
1.359 albertel 4515: text-align: right;
4516: }
1.469 banghart 4517: span.LC_metadata {
4518: font-family: $sans;
4519: }
1.359 albertel 4520: span.LC_title_bar_title {
1.416 albertel 4521: font: bold x-large $sans;
1.359 albertel 4522: }
4523: table#LC_title_bar td.LC_title_bar_domain_logo {
4524: background: $sidebg;
4525: text-align: right;
1.368 albertel 4526: padding: 0px;
4527: }
4528: table#LC_title_bar td.LC_title_bar_role_logo {
4529: background: $sidebg;
4530: padding: 0px;
1.359 albertel 4531: }
4532:
1.346 albertel 4533: table#LC_menubuttons_mainmenu {
1.526 www 4534: width: 100%;
1.346 albertel 4535: border: 0px;
4536: border-spacing: 1px;
1.372 albertel 4537: padding: 0px 1px;
1.346 albertel 4538: margin: 0px;
4539: border-collapse: separate;
4540: }
4541: table#LC_menubuttons img, table#LC_menubuttons_mainmenu img {
4542: border: 0px;
4543: }
1.345 albertel 4544: table#LC_top_nav td {
4545: background: $tabbg;
1.392 albertel 4546: border: 0px;
1.407 albertel 4547: font-size: small;
1.345 albertel 4548: }
4549: table#LC_top_nav td a, div#LC_top_nav a {
4550: color: $font;
4551: font-family: $sans;
4552: }
1.364 albertel 4553: table#LC_top_nav td.LC_top_nav_logo {
4554: background: $tabbg;
1.432 albertel 4555: text-align: left;
1.408 albertel 4556: white-space: nowrap;
1.432 albertel 4557: width: 31px;
1.408 albertel 4558: }
4559: table#LC_top_nav td.LC_top_nav_logo img {
1.432 albertel 4560: border: 0px;
1.408 albertel 4561: vertical-align: bottom;
1.364 albertel 4562: }
1.432 albertel 4563: table#LC_top_nav td.LC_top_nav_exit,
4564: table#LC_top_nav td.LC_top_nav_help {
4565: width: 2.0em;
4566: }
1.442 albertel 4567: table#LC_top_nav td.LC_top_nav_login {
4568: width: 4.0em;
4569: text-align: center;
4570: }
1.409 albertel 4571: table.LC_breadcrumbs td, table.LC_docs_path td {
1.357 albertel 4572: background: $tabbg;
4573: color: $font;
4574: font-family: $sans;
1.358 albertel 4575: font-size: smaller;
1.357 albertel 4576: }
1.411 albertel 4577: table.LC_breadcrumbs td.LC_breadcrumbs_component,
1.409 albertel 4578: table.LC_docs_path td.LC_docs_path_component {
1.357 albertel 4579: background: $tabbg;
4580: color: $font;
4581: font-family: $sans;
4582: font-size: larger;
4583: text-align: right;
4584: }
1.383 albertel 4585: td.LC_table_cell_checkbox {
4586: text-align: center;
4587: }
1.522 albertel 4588: table#LC_mainmenu td.LC_mainmenu_column {
4589: vertical-align: top;
4590: }
4591:
1.346 albertel 4592: .LC_menubuttons_inline_text {
4593: color: $font;
4594: font-family: $sans;
4595: font-size: smaller;
4596: }
4597:
1.526 www 4598: .LC_menubuttons_link {
4599: text-decoration: none;
4600: }
1.680 riegler 4601: #2008--9-5: new menu style sheet.Changed category
1.522 albertel 4602: .LC_menubuttons_category {
1.521 www 4603: color: $font;
1.526 www 4604: background: $pgbg;
1.521 www 4605: font-family: $sans;
4606: font-size: larger;
4607: font-weight: bold;
4608: }
4609:
1.346 albertel 4610: td.LC_menubuttons_text {
1.526 www 4611: width: 90%;
1.346 albertel 4612: color: $font;
4613: font-family: $sans;
4614: }
1.526 www 4615:
1.346 albertel 4616: td.LC_menubuttons_img {
4617: }
1.526 www 4618:
1.346 albertel 4619: .LC_current_location {
4620: font-family: $sans;
4621: background: $tabbg;
4622: }
4623: .LC_new_mail {
4624: font-family: $sans;
1.634 www 4625: background: $tabbg;
1.346 albertel 4626: font-weight: bold;
4627: }
1.347 albertel 4628:
1.526 www 4629: .LC_rolesmenu_is {
4630: font-family: $sans;
4631: }
4632:
4633: .LC_rolesmenu_selected {
4634: font-family: $sans;
4635: }
4636:
4637: .LC_rolesmenu_future {
4638: font-family: $sans;
4639: }
4640:
4641:
4642: .LC_rolesmenu_will {
4643: font-family: $sans;
4644: }
4645:
4646: .LC_rolesmenu_will_not {
4647: font-family: $sans;
4648: }
4649:
4650: .LC_rolesmenu_expired {
4651: font-family: $sans;
4652: }
4653:
4654: .LC_rolesinfo {
4655: font-family: $sans;
4656: }
4657:
1.527 www 4658: .LC_dropadd_labeltext {
4659: font-family: $sans;
4660: text-align: right;
4661: }
4662:
4663: .LC_preferences_labeltext {
4664: font-family: $sans;
4665: text-align: right;
4666: }
4667:
1.666 raeburn 4668: .LC_roleslog_note {
4669: font-size: smaller;
4670: }
4671:
1.440 albertel 4672: table.LC_aboutme_port {
4673: border: 0px;
4674: border-collapse: collapse;
4675: border-spacing: 0px;
4676: }
1.349 albertel 4677: table.LC_data_table, table.LC_mail_list {
1.347 albertel 4678: border: 1px solid #000000;
1.402 albertel 4679: border-collapse: separate;
1.426 albertel 4680: border-spacing: 1px;
1.610 albertel 4681: background: $pgbg;
1.347 albertel 4682: }
1.422 albertel 4683: .LC_data_table_dense {
4684: font-size: small;
4685: }
1.507 raeburn 4686: table.LC_nested_outer {
4687: border: 1px solid #000000;
1.589 raeburn 4688: border-collapse: collapse;
1.507 raeburn 4689: border-spacing: 0px;
4690: width: 100%;
4691: }
4692: table.LC_nested {
4693: border: 0px;
1.589 raeburn 4694: border-collapse: collapse;
1.507 raeburn 4695: border-spacing: 0px;
4696: width: 100%;
4697: }
1.523 albertel 4698: table.LC_data_table tr th, table.LC_calendar tr th, table.LC_mail_list tr th,
4699: table.LC_prior_tries tr th {
1.349 albertel 4700: font-weight: bold;
4701: background-color: $data_table_head;
1.421 albertel 4702: font-size: smaller;
1.347 albertel 4703: }
1.692.2.3! raeburn 4704: table.LC_data_table tr.LC_info_row > td {
! 4705: background-color: #CCC;
! 4706: font-weight: bold;
! 4707: text-align: left;
! 4708: }
1.610 albertel 4709: table.LC_data_table tr.LC_odd_row > td,
1.440 albertel 4710: table.LC_aboutme_port tr td {
1.349 albertel 4711: background-color: $data_table_light;
1.425 albertel 4712: padding: 2px;
1.347 albertel 4713: }
1.610 albertel 4714: table.LC_data_table tr.LC_even_row > td,
1.440 albertel 4715: table.LC_aboutme_port tr.LC_even_row td {
1.349 albertel 4716: background-color: $data_table_dark;
1.347 albertel 4717: }
1.425 albertel 4718: table.LC_data_table tr.LC_data_table_highlight td {
4719: background-color: $data_table_darker;
4720: }
1.639 raeburn 4721: table.LC_data_table tr td.LC_leftcol_header {
4722: background-color: $data_table_head;
4723: font-weight: bold;
4724: }
1.451 albertel 4725: table.LC_data_table tr.LC_empty_row td,
1.507 raeburn 4726: table.LC_nested tr.LC_empty_row td {
1.347 albertel 4727: background-color: #FFFFFF;
1.421 albertel 4728: font-weight: bold;
4729: font-style: italic;
4730: text-align: center;
4731: padding: 8px;
1.347 albertel 4732: }
1.507 raeburn 4733: table.LC_nested tr.LC_empty_row td {
1.465 albertel 4734: padding: 4ex
4735: }
1.507 raeburn 4736: table.LC_nested_outer tr th {
4737: font-weight: bold;
4738: background-color: $data_table_head;
4739: font-size: smaller;
4740: border-bottom: 1px solid #000000;
4741: }
4742: table.LC_nested_outer tr td.LC_subheader {
4743: background-color: $data_table_head;
4744: font-weight: bold;
4745: font-size: small;
4746: border-bottom: 1px solid #000000;
4747: text-align: right;
1.451 albertel 4748: }
1.507 raeburn 4749: table.LC_nested tr.LC_info_row td {
1.451 albertel 4750: background-color: #CCC;
4751: font-weight: bold;
4752: font-size: small;
1.507 raeburn 4753: text-align: center;
4754: }
1.589 raeburn 4755: table.LC_nested tr.LC_info_row td.LC_left_item,
4756: table.LC_nested_outer tr th.LC_left_item {
1.507 raeburn 4757: text-align: left;
1.451 albertel 4758: }
1.507 raeburn 4759: table.LC_nested td {
1.451 albertel 4760: background-color: #FFF;
4761: font-size: small;
1.507 raeburn 4762: }
4763: table.LC_nested_outer tr th.LC_right_item,
4764: table.LC_nested tr.LC_info_row td.LC_right_item,
4765: table.LC_nested tr.LC_odd_row td.LC_right_item,
4766: table.LC_nested tr td.LC_right_item {
1.451 albertel 4767: text-align: right;
4768: }
4769:
1.507 raeburn 4770: table.LC_nested tr.LC_odd_row td {
1.451 albertel 4771: background-color: #EEE;
4772: }
4773:
1.473 raeburn 4774: table.LC_createuser {
4775: }
4776:
4777: table.LC_createuser tr.LC_section_row td {
4778: font-size: smaller;
4779: }
4780:
4781: table.LC_createuser tr.LC_info_row td {
4782: background-color: #CCC;
4783: font-weight: bold;
4784: text-align: center;
4785: }
4786:
1.349 albertel 4787: table.LC_calendar {
4788: border: 1px solid #000000;
4789: border-collapse: collapse;
4790: }
4791: table.LC_calendar_pickdate {
4792: font-size: xx-small;
4793: }
4794: table.LC_calendar tr td {
4795: border: 1px solid #000000;
4796: vertical-align: top;
4797: }
4798: table.LC_calendar tr td.LC_calendar_day_empty {
4799: background-color: $data_table_dark;
4800: }
4801: table.LC_calendar tr td.LC_calendar_day_current {
4802: background-color: $data_table_highlight;
4803: }
4804:
4805: table.LC_mail_list tr.LC_mail_new {
4806: background-color: $mail_new;
4807: }
4808: table.LC_mail_list tr.LC_mail_new:hover {
4809: background-color: $mail_new_hover;
4810: }
4811: table.LC_mail_list tr.LC_mail_read {
4812: background-color: $mail_read;
4813: }
4814: table.LC_mail_list tr.LC_mail_read:hover {
4815: background-color: $mail_read_hover;
4816: }
4817: table.LC_mail_list tr.LC_mail_replied {
4818: background-color: $mail_replied;
4819: }
4820: table.LC_mail_list tr.LC_mail_replied:hover {
4821: background-color: $mail_replied_hover;
4822: }
4823: table.LC_mail_list tr.LC_mail_other {
4824: background-color: $mail_other;
4825: }
4826: table.LC_mail_list tr.LC_mail_other:hover {
4827: background-color: $mail_other_hover;
4828: }
1.494 raeburn 4829: table.LC_mail_list tr.LC_mail_even {
4830: }
4831: table.LC_mail_list tr.LC_mail_odd {
4832: }
4833:
1.385 albertel 4834:
1.386 albertel 4835: table#LC_portfolio_actions {
4836: width: auto;
4837: background: $pgbg;
4838: border: 0px;
4839: border-spacing: 2px 2px;
4840: padding: 0px;
4841: margin: 0px;
4842: border-collapse: separate;
4843: }
4844: table#LC_portfolio_actions td.LC_label {
4845: background: $tabbg;
4846: text-align: right;
4847: }
4848: table#LC_portfolio_actions td.LC_value {
4849: background: $tabbg;
4850: }
1.385 albertel 4851:
1.391 albertel 4852: table#LC_cstr_controls {
4853: width: 100%;
4854: border-collapse: collapse;
4855: }
4856: table#LC_cstr_controls tr td {
4857: border: 4px solid $pgbg;
4858: padding: 4px;
4859: text-align: center;
4860: background: $tabbg;
4861: }
4862: table#LC_cstr_controls tr th {
4863: border: 4px solid $pgbg;
4864: background: $table_header;
4865: text-align: center;
4866: font-family: $sans;
4867: font-size: smaller;
4868: }
4869:
1.389 albertel 4870: table#LC_browser {
4871:
4872: }
4873: table#LC_browser tr th {
1.391 albertel 4874: background: $table_header;
1.389 albertel 4875: }
1.390 albertel 4876: table#LC_browser tr td {
4877: padding: 2px;
4878: }
1.389 albertel 4879: table#LC_browser tr.LC_browser_file,
4880: table#LC_browser tr.LC_browser_file_published {
4881: background: #CCFF88;
4882: }
4883: table#LC_browser tr.LC_browser_file_locked,
4884: table#LC_browser tr.LC_browser_file_unpublished {
4885: background: #FFAA99;
1.387 albertel 4886: }
1.389 albertel 4887: table#LC_browser tr.LC_browser_file_obsolete {
4888: background: #AAAAAA;
1.387 albertel 4889: }
1.455 albertel 4890: table#LC_browser tr.LC_browser_file_modified,
4891: table#LC_browser tr.LC_browser_file_metamodified {
1.389 albertel 4892: background: #FFFF77;
1.387 albertel 4893: }
1.389 albertel 4894: table#LC_browser tr.LC_browser_folder {
4895: background: #CCCCFF;
1.387 albertel 4896: }
1.388 albertel 4897: span.LC_current_location {
4898: font-size: x-large;
4899: background: $pgbg;
4900: }
1.387 albertel 4901:
1.395 albertel 4902: span.LC_parm_menu_item {
4903: font-size: larger;
4904: font-family: $sans;
4905: }
4906: span.LC_parm_scope_all {
4907: color: red;
4908: }
4909: span.LC_parm_scope_folder {
4910: color: green;
4911: }
4912: span.LC_parm_scope_resource {
4913: color: orange;
4914: }
4915: span.LC_parm_part {
4916: color: blue;
4917: }
4918: span.LC_parm_folder, span.LC_parm_symb {
4919: font-size: x-small;
4920: font-family: $mono;
4921: color: #AAAAAA;
4922: }
4923:
1.396 albertel 4924: td.LC_parm_overview_level_menu, td.LC_parm_overview_map_menu,
4925: td.LC_parm_overview_parm_selectors, td.LC_parm_overview_parm_restrictions {
4926: border: 1px solid black;
4927: border-collapse: collapse;
4928: }
4929: table.LC_parm_overview_restrictions td {
4930: border-width: 1px 4px 1px 4px;
4931: border-style: solid;
4932: border-color: $pgbg;
4933: text-align: center;
4934: }
4935: table.LC_parm_overview_restrictions th {
4936: background: $tabbg;
4937: border-width: 1px 4px 1px 4px;
4938: border-style: solid;
4939: border-color: $pgbg;
4940: }
1.398 albertel 4941: table#LC_helpmenu {
4942: border: 0px;
4943: height: 55px;
4944: border-spacing: 0px;
4945: }
4946:
4947: table#LC_helpmenu fieldset legend {
4948: font-size: larger;
4949: font-weight: bold;
4950: }
1.397 albertel 4951: table#LC_helpmenu_links {
4952: width: 100%;
4953: border: 1px solid black;
4954: background: $pgbg;
4955: padding: 0px;
4956: border-spacing: 1px;
4957: }
4958: table#LC_helpmenu_links tr td {
4959: padding: 1px;
4960: background: $tabbg;
1.399 albertel 4961: text-align: center;
4962: font-weight: bold;
1.397 albertel 4963: }
1.396 albertel 4964:
1.397 albertel 4965: table#LC_helpmenu_links a:link, table#LC_helpmenu_links a:visited,
4966: table#LC_helpmenu_links a:active {
4967: text-decoration: none;
4968: color: $font;
4969: }
4970: table#LC_helpmenu_links a:hover {
4971: text-decoration: underline;
4972: color: $vlink;
4973: }
1.396 albertel 4974:
1.417 albertel 4975: .LC_chrt_popup_exists {
4976: border: 1px solid #339933;
4977: margin: -1px;
4978: }
4979: .LC_chrt_popup_up {
4980: border: 1px solid yellow;
4981: margin: -1px;
4982: }
4983: .LC_chrt_popup {
4984: border: 1px solid #8888FF;
4985: background: #CCCCFF;
4986: }
1.421 albertel 4987: table.LC_pick_box {
4988: border-collapse: separate;
4989: background: white;
4990: border: 1px solid black;
4991: border-spacing: 1px;
4992: }
4993: table.LC_pick_box td.LC_pick_box_title {
4994: background: $tabbg;
4995: font-weight: bold;
4996: text-align: right;
4997: width: 184px;
4998: padding: 8px;
4999: }
1.645 raeburn 5000: table.LC_pick_box td.LC_selfenroll_pick_box_title {
5001: background: $tabbg;
5002: font-weight: bold;
5003: text-align: right;
5004: width: 350px;
5005: padding: 8px;
5006: }
5007:
1.579 raeburn 5008: table.LC_pick_box td.LC_pick_box_value {
5009: text-align: left;
5010: padding: 8px;
5011: }
5012: table.LC_pick_box td.LC_pick_box_select {
5013: text-align: left;
5014: padding: 8px;
5015: }
1.424 albertel 5016: table.LC_pick_box td.LC_pick_box_separator {
1.421 albertel 5017: padding: 0px;
5018: height: 1px;
5019: background: black;
5020: }
5021: table.LC_pick_box td.LC_pick_box_submit {
5022: text-align: right;
5023: }
1.579 raeburn 5024: table.LC_pick_box td.LC_evenrow_value {
5025: text-align: left;
5026: padding: 8px;
5027: background-color: $data_table_light;
5028: }
5029: table.LC_pick_box td.LC_oddrow_value {
5030: text-align: left;
5031: padding: 8px;
5032: background-color: $data_table_light;
5033: }
5034: table.LC_helpform_receipt {
5035: width: 620px;
5036: border-collapse: separate;
5037: background: white;
5038: border: 1px solid black;
5039: border-spacing: 1px;
5040: }
5041: table.LC_helpform_receipt td.LC_pick_box_title {
5042: background: $tabbg;
5043: font-weight: bold;
5044: text-align: right;
5045: width: 184px;
5046: padding: 8px;
5047: }
5048: table.LC_helpform_receipt td.LC_evenrow_value {
5049: text-align: left;
5050: padding: 8px;
5051: background-color: $data_table_light;
5052: }
5053: table.LC_helpform_receipt td.LC_oddrow_value {
5054: text-align: left;
5055: padding: 8px;
5056: background-color: $data_table_light;
5057: }
5058: table.LC_helpform_receipt td.LC_pick_box_separator {
5059: padding: 0px;
5060: height: 1px;
5061: background: black;
5062: }
5063: span.LC_helpform_receipt_cat {
5064: font-weight: bold;
5065: }
1.424 albertel 5066: table.LC_group_priv_box {
5067: background: white;
5068: border: 1px solid black;
5069: border-spacing: 1px;
5070: }
5071: table.LC_group_priv_box td.LC_pick_box_title {
5072: background: $tabbg;
5073: font-weight: bold;
5074: text-align: right;
5075: width: 184px;
5076: }
5077: table.LC_group_priv_box td.LC_groups_fixed {
5078: background: $data_table_light;
5079: text-align: center;
5080: }
5081: table.LC_group_priv_box td.LC_groups_optional {
5082: background: $data_table_dark;
5083: text-align: center;
5084: }
5085: table.LC_group_priv_box td.LC_groups_functionality {
5086: background: $data_table_darker;
5087: text-align: center;
5088: font-weight: bold;
5089: }
5090: table.LC_group_priv td {
5091: text-align: left;
5092: padding: 0px;
5093: }
5094:
1.421 albertel 5095: table.LC_notify_front_page {
5096: background: white;
5097: border: 1px solid black;
5098: padding: 8px;
5099: }
5100: table.LC_notify_front_page td {
5101: padding: 8px;
5102: }
1.424 albertel 5103: .LC_navbuttons {
5104: margin: 2ex 0ex 2ex 0ex;
5105: }
1.423 albertel 5106: .LC_topic_bar {
5107: font-family: $sans;
5108: font-weight: bold;
5109: width: 100%;
5110: background: $tabbg;
5111: vertical-align: middle;
5112: margin: 2ex 0ex 2ex 0ex;
5113: }
5114: .LC_topic_bar span {
5115: vertical-align: middle;
5116: }
5117: .LC_topic_bar img {
5118: vertical-align: bottom;
5119: }
5120: table.LC_course_group_status {
5121: margin: 20px;
5122: }
5123: table.LC_status_selector td {
5124: vertical-align: top;
5125: text-align: center;
1.424 albertel 5126: padding: 4px;
5127: }
5128: table.LC_descriptive_input td.LC_description {
5129: vertical-align: top;
5130: text-align: right;
5131: font-weight: bold;
1.423 albertel 5132: }
1.599 albertel 5133: div.LC_feedback_link {
1.616 albertel 5134: clear: both;
1.599 albertel 5135: background: white;
5136: width: 100%;
1.489 raeburn 5137: }
5138: span.LC_feedback_link {
1.599 albertel 5139: background: $feedback_link_bg;
5140: font-size: larger;
5141: }
5142: span.LC_message_link {
5143: background: $feedback_link_bg;
5144: font-size: larger;
5145: position: absolute;
5146: right: 1em;
1.489 raeburn 5147: }
1.421 albertel 5148:
1.515 albertel 5149: table.LC_prior_tries {
1.524 albertel 5150: border: 1px solid #000000;
5151: border-collapse: separate;
5152: border-spacing: 1px;
1.515 albertel 5153: }
1.523 albertel 5154:
1.515 albertel 5155: table.LC_prior_tries td {
1.524 albertel 5156: padding: 2px;
1.515 albertel 5157: }
1.523 albertel 5158:
5159: .LC_answer_correct {
5160: background: #AAFFAA;
5161: color: black;
5162: }
5163: .LC_answer_charged_try {
5164: background: #FFAAAA ! important;
5165: color: black;
5166: }
5167: .LC_answer_not_charged_try,
5168: .LC_answer_no_grade,
5169: .LC_answer_late {
5170: background: #FFFFAA;
5171: color: black;
5172: }
5173: .LC_answer_previous {
5174: background: #AAAAFF;
5175: color: black;
5176: }
5177: .LC_answer_no_message {
5178: background: #FFFFFF;
5179: color: black;
5180: }
5181: .LC_answer_unknown {
5182: background: orange;
5183: color: black;
5184: }
5185:
5186:
1.529 albertel 5187: span.LC_prior_numerical,
5188: span.LC_prior_string,
5189: span.LC_prior_custom,
5190: span.LC_prior_reaction,
5191: span.LC_prior_math {
1.523 albertel 5192: font-family: monospace;
5193: white-space: pre;
5194: }
5195:
1.525 albertel 5196: span.LC_prior_string {
5197: font-family: monospace;
5198: white-space: pre;
5199: }
5200:
1.523 albertel 5201: table.LC_prior_option {
5202: width: 100%;
5203: border-collapse: collapse;
5204: }
1.528 albertel 5205: table.LC_prior_rank, table.LC_prior_match {
5206: border-collapse: collapse;
5207: }
5208: table.LC_prior_option tr td,
5209: table.LC_prior_rank tr td,
5210: table.LC_prior_match tr td {
1.524 albertel 5211: border: 1px solid #000000;
1.515 albertel 5212: }
5213:
1.519 raeburn 5214: span.LC_nobreak {
1.544 albertel 5215: white-space: nowrap;
1.519 raeburn 5216: }
5217:
1.576 raeburn 5218: span.LC_cusr_emph {
5219: font-style: italic;
5220: }
5221:
1.633 raeburn 5222: span.LC_cusr_subheading {
5223: font-weight: normal;
5224: font-size: 85%;
5225: }
5226:
1.545 albertel 5227: table.LC_docs_documents {
5228: background: #BBBBBB;
1.547 albertel 5229: border-width: 0px;
1.545 albertel 5230: border-collapse: collapse;
5231: }
5232:
5233: table.LC_docs_documents td.LC_docs_document {
5234: border: 2px solid black;
5235: padding: 4px;
5236: }
5237:
5238: .LC_docs_course_commands div {
5239: float: left;
5240: border: 4px solid #AAAAAA;
5241: padding: 4px;
5242: background: #DDDDCC;
5243: }
5244:
5245: .LC_docs_entry_move {
5246: border: 0px;
5247: border-collapse: collapse;
1.544 albertel 5248: }
5249:
1.545 albertel 5250: .LC_docs_entry_move td {
5251: border: 2px solid #BBBBBB;
5252: background: #DDDDDD;
5253: }
5254:
5255: .LC_docs_editor td.LC_docs_entry_commands {
5256: background: #DDDDDD;
5257: font-size: x-small;
5258: }
1.544 albertel 5259: .LC_docs_copy {
1.545 albertel 5260: color: #000099;
1.544 albertel 5261: }
5262: .LC_docs_cut {
1.545 albertel 5263: color: #550044;
1.544 albertel 5264: }
5265: .LC_docs_rename {
1.545 albertel 5266: color: #009900;
1.544 albertel 5267: }
5268: .LC_docs_remove {
1.545 albertel 5269: color: #990000;
5270: }
5271:
1.547 albertel 5272: .LC_docs_reinit_warn,
5273: .LC_docs_ext_edit {
5274: font-size: x-small;
5275: }
5276:
1.545 albertel 5277: .LC_docs_editor td.LC_docs_entry_title,
5278: .LC_docs_editor td.LC_docs_entry_icon {
5279: background: #FFFFBB;
5280: }
5281: .LC_docs_editor td.LC_docs_entry_parameter {
5282: background: #BBBBFF;
5283: font-size: x-small;
5284: white-space: nowrap;
5285: }
5286:
5287: table.LC_docs_adddocs td,
5288: table.LC_docs_adddocs th {
5289: border: 1px solid #BBBBBB;
5290: padding: 4px;
5291: background: #DDDDDD;
1.543 albertel 5292: }
5293:
1.584 albertel 5294: table.LC_sty_begin {
5295: background: #BBFFBB;
5296: }
5297: table.LC_sty_end {
5298: background: #FFBBBB;
5299: }
5300:
1.589 raeburn 5301: table.LC_double_column {
5302: border-width: 0px;
5303: border-collapse: collapse;
5304: width: 100%;
5305: padding: 2px;
5306: }
5307:
5308: table.LC_double_column tr td.LC_left_col {
1.590 raeburn 5309: top: 2px;
1.589 raeburn 5310: left: 2px;
5311: width: 47%;
5312: vertical-align: top;
5313: }
5314:
5315: table.LC_double_column tr td.LC_right_col {
5316: top: 2px;
5317: right: 2px;
5318: width: 47%;
5319: vertical-align: top;
5320: }
5321:
1.594 raeburn 5322: span.LC_role_level {
5323: font-weight: bold;
5324: }
5325:
1.591 raeburn 5326: div.LC_left_float {
5327: float: left;
5328: padding-right: 5%;
1.597 albertel 5329: padding-bottom: 4px;
1.591 raeburn 5330: }
5331:
5332: div.LC_clear_float_header {
1.597 albertel 5333: padding-bottom: 2px;
1.591 raeburn 5334: }
5335:
5336: div.LC_clear_float_footer {
1.597 albertel 5337: padding-top: 10px;
1.591 raeburn 5338: clear: both;
5339: }
5340:
1.597 albertel 5341:
1.601 albertel 5342: div.LC_grade_select_mode {
1.604 albertel 5343: font-family: $sans;
1.601 albertel 5344: }
5345: div.LC_grade_select_mode div div {
5346: margin: 5px;
5347: }
5348: div.LC_grade_select_mode_selector {
5349: margin: 5px;
5350: float: left;
5351: }
5352: div.LC_grade_select_mode_selector_header {
5353: font: bold medium $sans;
5354: }
5355: div.LC_grade_select_mode_type {
5356: clear: left;
5357: }
5358:
1.597 albertel 5359: div.LC_grade_show_user {
5360: margin-top: 20px;
5361: border: 1px solid black;
5362: }
5363: div.LC_grade_user_name {
5364: background: #DDDDEE;
5365: border-bottom: 1px solid black;
5366: font: bold large $sans;
5367: }
5368: div.LC_grade_show_user_odd_row div.LC_grade_user_name {
5369: background: #DDEEDD;
5370: }
5371:
5372: div.LC_grade_show_problem,
5373: div.LC_grade_submissions,
5374: div.LC_grade_message_center,
5375: div.LC_grade_info_links,
5376: div.LC_grade_assign {
5377: margin: 5px;
5378: width: 99%;
5379: background: #FFFFFF;
5380: }
5381: div.LC_grade_show_problem_header,
5382: div.LC_grade_submissions_header,
5383: div.LC_grade_message_center_header,
5384: div.LC_grade_assign_header {
5385: font: bold large $sans;
5386: }
5387: div.LC_grade_show_problem_problem,
5388: div.LC_grade_submissions_body,
5389: div.LC_grade_message_center_body,
5390: div.LC_grade_assign_body {
5391: border: 1px solid black;
5392: width: 99%;
5393: background: #FFFFFF;
5394: }
1.598 albertel 5395: span.LC_grade_check_note {
5396: font: normal medium $sans;
5397: display: inline;
5398: position: absolute;
5399: right: 1em;
5400: }
1.597 albertel 5401:
1.613 albertel 5402: table.LC_scantron_action {
5403: width: 100%;
5404: }
5405: table.LC_scantron_action tr th {
5406: font: normal bold $sans;
5407: }
1.600 albertel 5408:
1.614 albertel 5409: div.LC_edit_problem_header,
5410: div.LC_edit_problem_footer {
1.600 albertel 5411: font: normal medium $sans;
1.602 albertel 5412: margin: 2px;
1.600 albertel 5413: }
5414: div.LC_edit_problem_header,
1.602 albertel 5415: div.LC_edit_problem_header div,
1.614 albertel 5416: div.LC_edit_problem_footer,
5417: div.LC_edit_problem_footer div,
1.602 albertel 5418: div.LC_edit_problem_editxml_header,
5419: div.LC_edit_problem_editxml_header div {
1.600 albertel 5420: margin-top: 5px;
5421: }
1.602 albertel 5422: div.LC_edit_problem_header_edit_row {
5423: background: $tabbg;
5424: padding: 3px;
5425: margin-bottom: 5px;
5426: }
1.600 albertel 5427: div.LC_edit_problem_header_title {
1.602 albertel 5428: font: larger bold $sans;
5429: background: $tabbg;
5430: padding: 3px;
5431: }
5432: table.LC_edit_problem_header_title {
5433: font: larger bold $sans;
5434: width: 100%;
5435: border-color: $pgbg;
5436: border-style: solid;
5437: border-width: $border;
5438:
1.600 albertel 5439: background: $tabbg;
1.602 albertel 5440: border-collapse: collapse;
5441: padding: 0px
5442: }
5443:
5444: div.LC_edit_problem_discards {
5445: float: left;
5446: padding-bottom: 5px;
5447: }
5448: div.LC_edit_problem_saves {
5449: float: right;
5450: padding-bottom: 5px;
1.600 albertel 5451: }
5452: hr.LC_edit_problem_divide {
1.602 albertel 5453: clear: both;
1.600 albertel 5454: color: $tabbg;
5455: background-color: $tabbg;
5456: height: 3px;
5457: border: 0px;
5458: }
1.679 riegler 5459: img.stift{
1.678 riegler 5460: border-width:0;
1.679 riegler 5461: vertical-align:middle;
1.677 riegler 5462: }
1.680 riegler 5463:
1.681 riegler 5464: table#LC_mainmenu{
5465: margin-top:10px;
5466: width:80%;
5467:
5468: }
5469:
1.680 riegler 5470: table#LC_mainmenu td.LC_mainmenu_col_fieldset{
5471: vertical-align: top;
5472: width: 45%;
5473: }
5474: .LC_mainmenu_fieldset_category {
5475: color: $font;
5476: background: $pgbg;
5477: font-family: $sans;
5478: font-size: small;
5479: font-weight: bold;
5480: }
5481: fieldset#LC_mainmenu_fieldset {
1.681 riegler 5482: margin:0px 10px 10px 0px;
1.680 riegler 5483:
5484: }
1.343 albertel 5485: END
5486: }
5487:
1.306 albertel 5488: =pod
5489:
5490: =item * &headtag()
5491:
5492: Returns a uniform footer for LON-CAPA web pages.
5493:
1.307 albertel 5494: Inputs: $title - optional title for the head
5495: $head_extra - optional extra HTML to put inside the <head>
1.315 albertel 5496: $args - optional arguments
1.319 albertel 5497: force_register - if is true call registerurl so the remote is
5498: informed
1.415 albertel 5499: redirect -> array ref of
5500: 1- seconds before redirect occurs
5501: 2- url to redirect to
5502: 3- whether the side effect should occur
1.315 albertel 5503: (side effect of setting
5504: $env{'internal.head.redirect'} to the url
5505: redirected too)
1.352 albertel 5506: domain -> force to color decorate a page for a specific
5507: domain
5508: function -> force usage of a specific rolish color scheme
5509: bgcolor -> override the default page bgcolor
1.460 albertel 5510: no_auto_mt_title
5511: -> prevent &mt()ing the title arg
1.464 albertel 5512:
1.306 albertel 5513: =cut
5514:
5515: sub headtag {
1.313 albertel 5516: my ($title,$head_extra,$args) = @_;
1.306 albertel 5517:
1.363 albertel 5518: my $function = $args->{'function'} || &get_users_function();
5519: my $domain = $args->{'domain'} || &determinedomain();
5520: my $bgcolor = $args->{'bgcolor'} || &designparm($function.'.pgbg',$domain);
1.418 albertel 5521: my $url = join(':',$env{'user.name'},$env{'user.domain'},
1.458 albertel 5522: $Apache::lonnet::perlvar{'lonVersion'},
1.531 albertel 5523: #time(),
1.418 albertel 5524: $env{'environment.color.timestamp'},
1.363 albertel 5525: $function,$domain,$bgcolor);
5526:
1.369 www 5527: $url = '/adm/css/'.&escape($url).'.css';
1.363 albertel 5528:
1.308 albertel 5529: my $result =
5530: '<head>'.
1.461 albertel 5531: &font_settings();
1.319 albertel 5532:
1.461 albertel 5533: if (!$args->{'frameset'}) {
5534: $result .= &Apache::lonhtmlcommon::htmlareaheaders();
5535: }
1.319 albertel 5536: if ($args->{'force_register'}) {
5537: $result .= &Apache::lonmenu::registerurl(1);
5538: }
1.436 albertel 5539: if (!$args->{'no_nav_bar'}
5540: && !$args->{'only_body'}
5541: && !$args->{'frameset'}) {
5542: $result .= &help_menu_js();
5543: }
1.319 albertel 5544:
1.314 albertel 5545: if (ref($args->{'redirect'})) {
1.414 albertel 5546: my ($time,$url,$inhibit_continue) = @{$args->{'redirect'}};
1.315 albertel 5547: $url = &Apache::lonenc::check_encrypt($url);
1.414 albertel 5548: if (!$inhibit_continue) {
5549: $env{'internal.head.redirect'} = $url;
5550: }
1.313 albertel 5551: $result.=<<ADDMETA
5552: <meta http-equiv="pragma" content="no-cache" />
1.344 albertel 5553: <meta http-equiv="Refresh" content="$time; url=$url" />
1.313 albertel 5554: ADDMETA
5555: }
1.306 albertel 5556: if (!defined($title)) {
5557: $title = 'The LearningOnline Network with CAPA';
5558: }
1.460 albertel 5559: if (!$args->{'no_auto_mt_title'}) { $title = &mt($title); }
5560: $result .= '<title> LON-CAPA '.$title.'</title>'
1.414 albertel 5561: .'<link rel="stylesheet" type="text/css" href="'.$url.'" />'
5562: .$head_extra;
1.306 albertel 5563: return $result;
5564: }
5565:
5566: =pod
5567:
1.340 albertel 5568: =item * &font_settings()
5569:
5570: Returns neccessary <meta> to set the proper encoding
5571:
5572: Inputs: none
5573:
5574: =cut
5575:
5576: sub font_settings {
5577: my $headerstring='';
1.647 www 5578: if (!$env{'browser.mathml'} && $env{'browser.unicode'}) {
1.340 albertel 5579: $headerstring.=
5580: '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />';
5581: }
5582: return $headerstring;
5583: }
5584:
1.341 albertel 5585: =pod
5586:
5587: =item * &xml_begin()
5588:
5589: Returns the needed doctype and <html>
5590:
5591: Inputs: none
5592:
5593: =cut
5594:
5595: sub xml_begin {
5596: my $output='';
5597:
1.592 albertel 5598: if ($env{'internal.start_page'}==1) {
5599: &Apache::lonhtmlcommon::init_htmlareafields();
5600: }
1.342 albertel 5601:
1.341 albertel 5602: if ($env{'browser.mathml'}) {
5603: $output='<?xml version="1.0"?>'
5604: #.'<?xml-stylesheet type="text/css" href="/adm/MathML/mathml.css"?>'."\n"
5605: # .'<!DOCTYPE html SYSTEM "/adm/MathML/mathml.dtd" '
5606:
5607: # .'<!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">] >'
5608: .'<!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">'
5609: .'<html xmlns:math="http://www.w3.org/1998/Math/MathML" '
5610: .'xmlns="http://www.w3.org/1999/xhtml">';
5611: } else {
5612: $output='<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html>';
5613: }
5614: return $output;
5615: }
1.340 albertel 5616:
5617: =pod
5618:
1.306 albertel 5619: =item * &endheadtag()
5620:
5621: Returns a uniform </head> for LON-CAPA web pages.
5622:
5623: Inputs: none
5624:
5625: =cut
5626:
5627: sub endheadtag {
5628: return '</head>';
5629: }
5630:
5631: =pod
5632:
5633: =item * &head()
5634:
5635: Returns a uniform complete <head>..</head> section for LON-CAPA web pages.
5636:
1.648 raeburn 5637: Inputs:
5638:
5639: =over 4
5640:
5641: $title - optional title for the page
5642:
5643: $head_extra - optional extra HTML to put inside the <head>
5644:
5645: =back
1.405 albertel 5646:
1.306 albertel 5647: =cut
5648:
5649: sub head {
1.325 albertel 5650: my ($title,$head_extra,$args) = @_;
5651: return &headtag($title,$head_extra,$args).&endheadtag();
1.306 albertel 5652: }
5653:
5654: =pod
5655:
5656: =item * &start_page()
5657:
5658: Returns a complete <html> .. <body> section for LON-CAPA web pages.
5659:
1.648 raeburn 5660: Inputs:
5661:
5662: =over 4
5663:
5664: $title - optional title for the page
5665:
5666: $head_extra - optional extra HTML to incude inside the <head>
5667:
5668: $args - additional optional args supported are:
5669:
5670: =over 8
5671:
5672: only_body -> is true will set &bodytag() onlybodytag
1.317 albertel 5673: arg on
1.648 raeburn 5674: no_nav_bar -> is true will set &bodytag() notopbar arg on
5675: add_entries -> additional attributes to add to the <body>
5676: domain -> force to color decorate a page for a
1.317 albertel 5677: specific domain
1.648 raeburn 5678: function -> force usage of a specific rolish color
1.317 albertel 5679: scheme
1.648 raeburn 5680: redirect -> see &headtag()
5681: bgcolor -> override the default page bg color
5682: js_ready -> return a string ready for being used in
1.317 albertel 5683: a javascript writeln
1.648 raeburn 5684: html_encode -> return a string ready for being used in
1.320 albertel 5685: a html attribute
1.648 raeburn 5686: force_register -> if is true will turn on the &bodytag()
1.317 albertel 5687: $forcereg arg
1.648 raeburn 5688: body_title -> alternate text to use instead of $title
1.326 albertel 5689: in the title box that appears, this text
5690: is not auto translated like the $title is
1.648 raeburn 5691: frameset -> if true will start with a <frameset>
1.330 albertel 5692: rather than <body>
1.648 raeburn 5693: no_title -> if true the title bar won't be shown
5694: skip_phases -> hash ref of
1.338 albertel 5695: head -> skip the <html><head> generation
5696: body -> skip all <body> generation
1.648 raeburn 5697: no_inline_link -> if true and in remote mode, don't show the
1.361 albertel 5698: 'Switch To Inline Menu' link
1.648 raeburn 5699: no_auto_mt_title -> prevent &mt()ing the title arg
5700: inherit_jsmath -> when creating popup window in a page,
5701: should it have jsmath forced on by the
5702: current page
1.361 albertel 5703:
1.648 raeburn 5704: =back
1.460 albertel 5705:
1.648 raeburn 5706: =back
1.562 albertel 5707:
1.306 albertel 5708: =cut
5709:
5710: sub start_page {
1.309 albertel 5711: my ($title,$head_extra,$args) = @_;
1.318 albertel 5712: #&Apache::lonnet::logthis("start_page ".join(':',caller(0)));
1.313 albertel 5713: my %head_args;
1.352 albertel 5714: foreach my $arg ('redirect','force_register','domain','function',
1.460 albertel 5715: 'bgcolor','frameset','no_nav_bar','only_body',
5716: 'no_auto_mt_title') {
1.319 albertel 5717: if (defined($args->{$arg})) {
1.324 raeburn 5718: $head_args{$arg} = $args->{$arg};
1.319 albertel 5719: }
1.313 albertel 5720: }
1.319 albertel 5721:
1.315 albertel 5722: $env{'internal.start_page'}++;
1.338 albertel 5723: my $result;
5724: if (! exists($args->{'skip_phases'}{'head'}) ) {
5725: $result.=
1.341 albertel 5726: &xml_begin().
1.338 albertel 5727: &headtag($title,$head_extra,\%head_args).&endheadtag();
5728: }
5729:
5730: if (! exists($args->{'skip_phases'}{'body'}) ) {
5731: if ($args->{'frameset'}) {
5732: my $attr_string = &make_attr_string($args->{'force_register'},
5733: $args->{'add_entries'});
5734: $result .= "\n<frameset $attr_string>\n";
5735: } else {
5736: $result .=
5737: &bodytag($title,
5738: $args->{'function'}, $args->{'add_entries'},
5739: $args->{'only_body'}, $args->{'domain'},
5740: $args->{'force_register'}, $args->{'body_title'},
5741: $args->{'no_nav_bar'}, $args->{'bgcolor'},
1.460 albertel 5742: $args->{'no_title'}, $args->{'no_inline_link'},
5743: $args);
1.338 albertel 5744: }
1.330 albertel 5745: }
1.338 albertel 5746:
1.315 albertel 5747: if ($args->{'js_ready'}) {
1.317 albertel 5748: $result = &js_ready($result);
1.315 albertel 5749: }
1.320 albertel 5750: if ($args->{'html_encode'}) {
5751: $result = &html_encode($result);
5752: }
1.315 albertel 5753: return $result;
1.306 albertel 5754: }
5755:
1.330 albertel 5756:
1.306 albertel 5757: =pod
5758:
5759: =item * &head()
5760:
5761: Returns a complete </body></html> section for LON-CAPA web pages.
5762:
1.315 albertel 5763: Inputs: $args - additional optional args supported are:
5764: js_ready -> return a string ready for being used in
5765: a javascript writeln
1.320 albertel 5766: html_encode -> return a string ready for being used in
5767: a html attribute
1.330 albertel 5768: frameset -> if true will start with a <frameset>
5769: rather than <body>
1.493 albertel 5770: dicsussion -> if true will get discussion from
5771: lonxml::xmlend
5772: (you can pass the target and parser arguments
5773: through optional 'target' and 'parser' args
5774: to this routine)
1.306 albertel 5775:
5776: =cut
5777:
5778: sub end_page {
1.315 albertel 5779: my ($args) = @_;
5780: $env{'internal.end_page'}++;
1.330 albertel 5781: my $result;
1.335 albertel 5782: if ($args->{'discussion'}) {
5783: my ($target,$parser);
5784: if (ref($args->{'discussion'})) {
5785: ($target,$parser) =($args->{'discussion'}{'target'},
5786: $args->{'discussion'}{'parser'});
5787: }
5788: $result .= &Apache::lonxml::xmlend($target,$parser);
5789: }
5790:
1.330 albertel 5791: if ($args->{'frameset'}) {
5792: $result .= '</frameset>';
5793: } else {
1.635 raeburn 5794: $result .= &endbodytag($args);
1.330 albertel 5795: }
5796: $result .= "\n</html>";
5797:
1.315 albertel 5798: if ($args->{'js_ready'}) {
1.317 albertel 5799: $result = &js_ready($result);
1.315 albertel 5800: }
1.335 albertel 5801:
1.320 albertel 5802: if ($args->{'html_encode'}) {
5803: $result = &html_encode($result);
5804: }
1.335 albertel 5805:
1.315 albertel 5806: return $result;
5807: }
5808:
1.320 albertel 5809: sub html_encode {
5810: my ($result) = @_;
5811:
1.322 albertel 5812: $result = &HTML::Entities::encode($result,'<>&"');
1.320 albertel 5813:
5814: return $result;
5815: }
1.317 albertel 5816: sub js_ready {
5817: my ($result) = @_;
5818:
1.323 albertel 5819: $result =~ s/[\n\r]/ /xmsg;
5820: $result =~ s/\\/\\\\/xmsg;
5821: $result =~ s/'/\\'/xmsg;
1.372 albertel 5822: $result =~ s{</}{<\\/}xmsg;
1.317 albertel 5823:
5824: return $result;
5825: }
5826:
1.315 albertel 5827: sub validate_page {
5828: if ( exists($env{'internal.start_page'})
1.316 albertel 5829: && $env{'internal.start_page'} > 1) {
5830: &Apache::lonnet::logthis('start_page called multiple times '.
1.318 albertel 5831: $env{'internal.start_page'}.' '.
1.316 albertel 5832: $ENV{'request.filename'});
1.315 albertel 5833: }
5834: if ( exists($env{'internal.end_page'})
1.316 albertel 5835: && $env{'internal.end_page'} > 1) {
5836: &Apache::lonnet::logthis('end_page called multiple times '.
1.318 albertel 5837: $env{'internal.end_page'}.' '.
1.316 albertel 5838: $env{'request.filename'});
1.315 albertel 5839: }
5840: if ( exists($env{'internal.start_page'})
5841: && ! exists($env{'internal.end_page'})) {
1.316 albertel 5842: &Apache::lonnet::logthis('start_page called without end_page '.
5843: $env{'request.filename'});
1.315 albertel 5844: }
5845: if ( ! exists($env{'internal.start_page'})
5846: && exists($env{'internal.end_page'})) {
1.316 albertel 5847: &Apache::lonnet::logthis('end_page called without start_page'.
5848: $env{'request.filename'});
1.315 albertel 5849: }
1.306 albertel 5850: }
1.315 albertel 5851:
1.318 albertel 5852: sub simple_error_page {
5853: my ($r,$title,$msg) = @_;
5854: my $page =
5855: &Apache::loncommon::start_page($title).
5856: &mt($msg).
5857: &Apache::loncommon::end_page();
5858: if (ref($r)) {
5859: $r->print($page);
1.327 albertel 5860: return;
1.318 albertel 5861: }
5862: return $page;
5863: }
1.347 albertel 5864:
5865: {
1.610 albertel 5866: my @row_count;
1.347 albertel 5867: sub start_data_table {
1.422 albertel 5868: my ($add_class) = @_;
5869: my $css_class = (join(' ','LC_data_table',$add_class));
1.610 albertel 5870: unshift(@row_count,0);
1.422 albertel 5871: return '<table class="'.$css_class.'">'."\n";
1.347 albertel 5872: }
5873:
5874: sub end_data_table {
1.610 albertel 5875: shift(@row_count);
1.389 albertel 5876: return '</table>'."\n";;
1.347 albertel 5877: }
5878:
5879: sub start_data_table_row {
1.422 albertel 5880: my ($add_class) = @_;
1.610 albertel 5881: $row_count[0]++;
5882: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.428 albertel 5883: $css_class = (join(' ',$css_class,$add_class));
1.422 albertel 5884: return '<tr class="'.$css_class.'">'."\n";;
1.347 albertel 5885: }
1.471 banghart 5886:
5887: sub continue_data_table_row {
5888: my ($add_class) = @_;
1.610 albertel 5889: my $css_class = ($row_count[0] % 2)?'LC_odd_row':'LC_even_row';
1.471 banghart 5890: $css_class = (join(' ',$css_class,$add_class));
5891: return '<tr class="'.$css_class.'">'."\n";;
5892: }
1.347 albertel 5893:
5894: sub end_data_table_row {
1.389 albertel 5895: return '</tr>'."\n";;
1.347 albertel 5896: }
1.367 www 5897:
1.421 albertel 5898: sub start_data_table_empty_row {
1.610 albertel 5899: $row_count[0]++;
1.421 albertel 5900: return '<tr class="LC_empty_row" >'."\n";;
5901: }
5902:
5903: sub end_data_table_empty_row {
5904: return '</tr>'."\n";;
5905: }
5906:
1.367 www 5907: sub start_data_table_header_row {
1.389 albertel 5908: return '<tr class="LC_header_row">'."\n";;
1.367 www 5909: }
5910:
5911: sub end_data_table_header_row {
1.389 albertel 5912: return '</tr>'."\n";;
1.367 www 5913: }
1.347 albertel 5914: }
5915:
1.548 albertel 5916: =pod
5917:
5918: =item * &inhibit_menu_check($arg)
5919:
5920: Checks for a inhibitmenu state and generates output to preserve it
5921:
5922: Inputs: $arg - can be any of
5923: - undef - in which case the return value is a string
5924: to add into arguments list of a uri
5925: - 'input' - in which case the return value is a HTML
5926: <form> <input> field of type hidden to
5927: preserve the value
5928: - a url - in which case the return value is the url with
5929: the neccesary cgi args added to preserve the
5930: inhibitmenu state
5931: - a ref to a url - no return value, but the string is
5932: updated to include the neccessary cgi
5933: args to preserve the inhibitmenu state
5934:
5935: =cut
5936:
5937: sub inhibit_menu_check {
5938: my ($arg) = @_;
5939: &get_unprocessed_cgi($ENV{'QUERY_STRING'}, ['inhibitmenu']);
5940: if ($arg eq 'input') {
5941: if ($env{'form.inhibitmenu'}) {
5942: return '<input type="hidden" name="inhibitmenu" value="'.$env{'form.inhibitmenu'}.'" />';
5943: } else {
5944: return
5945: }
5946: }
5947: if ($env{'form.inhibitmenu'}) {
5948: if (ref($arg)) {
5949: $$arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5950: } elsif ($arg eq '') {
5951: $arg .= 'inhibitmenu='.$env{'form.inhibitmenu'};
5952: } else {
5953: $arg .= '?inhibitmenu='.$env{'form.inhibitmenu'};
5954: }
5955: }
5956: if (!ref($arg)) {
5957: return $arg;
5958: }
5959: }
5960:
1.251 albertel 5961: ###############################################
1.182 matthew 5962:
5963: =pod
5964:
1.549 albertel 5965: =back
5966:
5967: =head1 User Information Routines
5968:
5969: =over 4
5970:
1.405 albertel 5971: =item * &get_users_function()
1.182 matthew 5972:
5973: Used by &bodytag to determine the current users primary role.
5974: Returns either 'student','coordinator','admin', or 'author'.
5975:
5976: =cut
5977:
5978: ###############################################
5979: sub get_users_function {
5980: my $function = 'student';
1.258 albertel 5981: if ($env{'request.role'}=~/^(cc|in|ta|ep)/) {
1.182 matthew 5982: $function='coordinator';
5983: }
1.258 albertel 5984: if ($env{'request.role'}=~/^(su|dc|ad|li)/) {
1.182 matthew 5985: $function='admin';
5986: }
1.258 albertel 5987: if (($env{'request.role'}=~/^(au|ca)/) ||
1.182 matthew 5988: ($ENV{'REQUEST_URI'}=~/^(\/priv|\~)/)) {
5989: $function='author';
5990: }
5991: return $function;
1.54 www 5992: }
1.99 www 5993:
5994: ###############################################
5995:
1.233 raeburn 5996: =pod
5997:
1.542 raeburn 5998: =item * &check_user_status()
1.274 raeburn 5999:
6000: Determines current status of supplied role for a
6001: specific user. Roles can be active, previous or future.
6002:
6003: Inputs:
6004: user's domain, user's username, course's domain,
1.375 raeburn 6005: course's number, optional section ID.
1.274 raeburn 6006:
6007: Outputs:
6008: role status: active, previous or future.
6009:
6010: =cut
6011:
6012: sub check_user_status {
1.412 raeburn 6013: my ($udom,$uname,$cdom,$crs,$role,$sec) = @_;
1.274 raeburn 6014: my %userinfo = &Apache::lonnet::dump('roles',$udom,$uname);
6015: my @uroles = keys %userinfo;
6016: my $srchstr;
6017: my $active_chk = 'none';
1.412 raeburn 6018: my $now = time;
1.274 raeburn 6019: if (@uroles > 0) {
1.412 raeburn 6020: if (($role eq 'cc') || ($sec eq '') || (!defined($sec))) {
1.274 raeburn 6021: $srchstr = '/'.$cdom.'/'.$crs.'_'.$role;
6022: } else {
1.412 raeburn 6023: $srchstr = '/'.$cdom.'/'.$crs.'/'.$sec.'_'.$role;
6024: }
6025: if (grep/^\Q$srchstr\E$/,@uroles) {
1.274 raeburn 6026: my $role_end = 0;
6027: my $role_start = 0;
6028: $active_chk = 'active';
1.412 raeburn 6029: if ($userinfo{$srchstr} =~ m/^\Q$role\E_(\d+)/) {
6030: $role_end = $1;
6031: if ($userinfo{$srchstr} =~ m/^\Q$role\E_\Q$role_end\E_(\d+)$/) {
6032: $role_start = $1;
1.274 raeburn 6033: }
6034: }
6035: if ($role_start > 0) {
1.412 raeburn 6036: if ($now < $role_start) {
1.274 raeburn 6037: $active_chk = 'future';
6038: }
6039: }
6040: if ($role_end > 0) {
1.412 raeburn 6041: if ($now > $role_end) {
1.274 raeburn 6042: $active_chk = 'previous';
6043: }
6044: }
6045: }
6046: }
6047: return $active_chk;
6048: }
6049:
6050: ###############################################
6051:
6052: =pod
6053:
1.405 albertel 6054: =item * &get_sections()
1.233 raeburn 6055:
6056: Determines all the sections for a course including
6057: sections with students and sections containing other roles.
1.419 raeburn 6058: Incoming parameters:
6059:
6060: 1. domain
6061: 2. course number
6062: 3. reference to array containing roles for which sections should
6063: be gathered (optional).
6064: 4. reference to array containing status types for which sections
6065: should be gathered (optional).
6066:
6067: If the third argument is undefined, sections are gathered for any role.
6068: If the fourth argument is undefined, sections are gathered for any status.
6069: Permissible values are 'active' or 'future' or 'previous'.
1.233 raeburn 6070:
1.374 raeburn 6071: Returns section hash (keys are section IDs, values are
6072: number of users in each section), subject to the
1.419 raeburn 6073: optional roles filter, optional status filter
1.233 raeburn 6074:
6075: =cut
6076:
6077: ###############################################
6078: sub get_sections {
1.419 raeburn 6079: my ($cdom,$cnum,$possible_roles,$possible_status) = @_;
1.366 albertel 6080: if (!defined($cdom) || !defined($cnum)) {
6081: my $cid = $env{'request.course.id'};
6082:
6083: return if (!defined($cid));
6084:
6085: $cdom = $env{'course.'.$cid.'.domain'};
6086: $cnum = $env{'course.'.$cid.'.num'};
6087: }
6088:
6089: my %sectioncount;
1.419 raeburn 6090: my $now = time;
1.240 albertel 6091:
1.366 albertel 6092: if (!defined($possible_roles) || (grep(/^st$/,@$possible_roles))) {
1.276 albertel 6093: my ($classlist) = &Apache::loncoursedata::get_classlist($cdom,$cnum);
1.240 albertel 6094: my $sec_index = &Apache::loncoursedata::CL_SECTION();
6095: my $status_index = &Apache::loncoursedata::CL_STATUS();
1.419 raeburn 6096: my $start_index = &Apache::loncoursedata::CL_START();
6097: my $end_index = &Apache::loncoursedata::CL_END();
6098: my $status;
1.366 albertel 6099: while (my ($student,$data) = each(%$classlist)) {
1.419 raeburn 6100: my ($section,$stu_status,$start,$end) = ($data->[$sec_index],
6101: $data->[$status_index],
6102: $data->[$start_index],
6103: $data->[$end_index]);
6104: if ($stu_status eq 'Active') {
6105: $status = 'active';
6106: } elsif ($end < $now) {
6107: $status = 'previous';
6108: } elsif ($start > $now) {
6109: $status = 'future';
6110: }
6111: if ($section ne '-1' && $section !~ /^\s*$/) {
6112: if ((!defined($possible_status)) || (($status ne '') &&
6113: (grep/^\Q$status\E$/,@{$possible_status}))) {
6114: $sectioncount{$section}++;
6115: }
1.240 albertel 6116: }
6117: }
6118: }
6119: my %courseroles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6120: foreach my $user (sort(keys(%courseroles))) {
6121: if ($user !~ /^(\w{2})/) { next; }
6122: my ($role) = ($user =~ /^(\w{2})/);
6123: if ($possible_roles && !(grep(/^$role$/,@$possible_roles))) { next; }
1.419 raeburn 6124: my ($section,$status);
1.240 albertel 6125: if ($role eq 'cr' &&
6126: $user =~ m-^$role/[^/]*/[^/]*/[^/]*:[^:]*:[^:]*:(\w+)-) {
6127: $section=$1;
6128: }
6129: if ($user =~ /^$role:[^:]*:[^:]*:(\w+)/) { $section=$1; }
6130: if (!defined($section) || $section eq '-1') { next; }
1.419 raeburn 6131: my ($end,$start) = ($courseroles{$user} =~ /^([^:]*):([^:]*)$/);
6132: if ($end == -1 && $start == -1) {
6133: next; #deleted role
6134: }
6135: if (!defined($possible_status)) {
6136: $sectioncount{$section}++;
6137: } else {
6138: if ((!$end || $end >= $now) && (!$start || $start <= $now)) {
6139: $status = 'active';
6140: } elsif ($end < $now) {
6141: $status = 'future';
6142: } elsif ($start > $now) {
6143: $status = 'previous';
6144: }
6145: if (($status ne '') && (grep/^\Q$status\E$/,@{$possible_status})) {
6146: $sectioncount{$section}++;
6147: }
6148: }
1.233 raeburn 6149: }
1.366 albertel 6150: return %sectioncount;
1.233 raeburn 6151: }
6152:
1.274 raeburn 6153: ###############################################
1.294 raeburn 6154:
6155: =pod
1.405 albertel 6156:
6157: =item * &get_course_users()
6158:
1.275 raeburn 6159: Retrieves usernames:domains for users in the specified course
6160: with specific role(s), and access status.
6161:
6162: Incoming parameters:
1.277 albertel 6163: 1. course domain
6164: 2. course number
6165: 3. access status: users must have - either active,
1.275 raeburn 6166: previous, future, or all.
1.277 albertel 6167: 4. reference to array of permissible roles
1.288 raeburn 6168: 5. reference to array of section restrictions (optional)
6169: 6. reference to results object (hash of hashes).
6170: 7. reference to optional userdata hash
1.609 raeburn 6171: 8. reference to optional statushash
1.630 raeburn 6172: 9. flag if privileged users (except those set to unhide in
6173: course settings) should be excluded
1.609 raeburn 6174: Keys of top level results hash are roles.
1.275 raeburn 6175: Keys of inner hashes are username:domain, with
6176: values set to access type.
1.288 raeburn 6177: Optional userdata hash returns an array with arguments in the
6178: same order as loncoursedata::get_classlist() for student data.
6179:
1.609 raeburn 6180: Optional statushash returns
6181:
1.288 raeburn 6182: Entries for end, start, section and status are blank because
6183: of the possibility of multiple values for non-student roles.
6184:
1.275 raeburn 6185: =cut
1.405 albertel 6186:
1.275 raeburn 6187: ###############################################
1.405 albertel 6188:
1.275 raeburn 6189: sub get_course_users {
1.630 raeburn 6190: my ($cdom,$cnum,$types,$roles,$sections,$users,$userdata,$statushash,$hidepriv) = @_;
1.288 raeburn 6191: my %idx = ();
1.419 raeburn 6192: my %seclists;
1.288 raeburn 6193:
6194: $idx{udom} = &Apache::loncoursedata::CL_SDOM();
6195: $idx{uname} = &Apache::loncoursedata::CL_SNAME();
6196: $idx{end} = &Apache::loncoursedata::CL_END();
6197: $idx{start} = &Apache::loncoursedata::CL_START();
6198: $idx{id} = &Apache::loncoursedata::CL_ID();
6199: $idx{section} = &Apache::loncoursedata::CL_SECTION();
6200: $idx{fullname} = &Apache::loncoursedata::CL_FULLNAME();
6201: $idx{status} = &Apache::loncoursedata::CL_STATUS();
6202:
1.290 albertel 6203: if (grep(/^st$/,@{$roles})) {
1.276 albertel 6204: my ($classlist,$keylist)=&Apache::loncoursedata::get_classlist($cdom,$cnum);
1.278 raeburn 6205: my $now = time;
1.277 albertel 6206: foreach my $student (keys(%{$classlist})) {
1.288 raeburn 6207: my $match = 0;
1.412 raeburn 6208: my $secmatch = 0;
1.419 raeburn 6209: my $section = $$classlist{$student}[$idx{section}];
1.609 raeburn 6210: my $status = $$classlist{$student}[$idx{status}];
1.419 raeburn 6211: if ($section eq '') {
6212: $section = 'none';
6213: }
1.291 albertel 6214: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6215: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6216: $secmatch = 1;
6217: } elsif ($$classlist{$student}[$idx{section}] eq '') {
1.420 albertel 6218: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6219: $secmatch = 1;
6220: }
6221: } else {
1.419 raeburn 6222: if (grep(/^\Q$section\E$/,@{$sections})) {
1.412 raeburn 6223: $secmatch = 1;
6224: }
1.290 albertel 6225: }
1.412 raeburn 6226: if (!$secmatch) {
6227: next;
6228: }
1.419 raeburn 6229: }
1.275 raeburn 6230: if (defined($$types{'active'})) {
1.288 raeburn 6231: if ($$classlist{$student}[$idx{status}] eq 'Active') {
1.275 raeburn 6232: push(@{$$users{st}{$student}},'active');
1.288 raeburn 6233: $match = 1;
1.275 raeburn 6234: }
6235: }
6236: if (defined($$types{'previous'})) {
1.609 raeburn 6237: if ($$classlist{$student}[$idx{status}] eq 'Expired') {
1.275 raeburn 6238: push(@{$$users{st}{$student}},'previous');
1.288 raeburn 6239: $match = 1;
1.275 raeburn 6240: }
6241: }
6242: if (defined($$types{'future'})) {
1.609 raeburn 6243: if ($$classlist{$student}[$idx{status}] eq 'Future') {
1.275 raeburn 6244: push(@{$$users{st}{$student}},'future');
1.288 raeburn 6245: $match = 1;
1.275 raeburn 6246: }
6247: }
1.609 raeburn 6248: if ($match) {
6249: push(@{$seclists{$student}},$section);
6250: if (ref($userdata) eq 'HASH') {
6251: $$userdata{$student} = $$classlist{$student};
6252: }
6253: if (ref($statushash) eq 'HASH') {
6254: $statushash->{$student}{'st'}{$section} = $status;
6255: }
1.288 raeburn 6256: }
1.275 raeburn 6257: }
6258: }
1.412 raeburn 6259: if ((@{$roles} > 1) || ((@{$roles} == 1) && ($$roles[0] ne "st"))) {
1.439 raeburn 6260: my %coursepersonnel = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6261: my $now = time;
1.609 raeburn 6262: my %displaystatus = ( previous => 'Expired',
6263: active => 'Active',
6264: future => 'Future',
6265: );
1.630 raeburn 6266: my %nothide;
6267: if ($hidepriv) {
6268: my %coursehash=&Apache::lonnet::coursedescription($cdom.'_'.$cnum);
6269: foreach my $user (split(/\s*\,\s*/,$coursehash{'nothideprivileged'})) {
6270: if ($user !~ /:/) {
6271: $nothide{join(':',split(/[\@]/,$user))}=1;
6272: } else {
6273: $nothide{$user} = 1;
6274: }
6275: }
6276: }
1.439 raeburn 6277: foreach my $person (sort(keys(%coursepersonnel))) {
1.288 raeburn 6278: my $match = 0;
1.412 raeburn 6279: my $secmatch = 0;
1.439 raeburn 6280: my $status;
1.412 raeburn 6281: my ($role,$user,$usec) = ($person =~ /^([^:]*):([^:]+:[^:]+):([^:]*)/);
1.275 raeburn 6282: $user =~ s/:$//;
1.439 raeburn 6283: my ($end,$start) = split(/:/,$coursepersonnel{$person});
6284: if ($end == -1 || $start == -1) {
6285: next;
6286: }
6287: if (($role) && ((grep(/^\Q$role\E$/,@{$roles})) ||
6288: (grep(/^cr$/,@{$roles}) && $role =~ /^cr\//))) {
1.412 raeburn 6289: my ($uname,$udom) = split(/:/,$user);
6290: if ((ref($sections) eq 'ARRAY') && (@{$sections} > 0)) {
1.420 albertel 6291: if (grep(/^all$/,@{$sections})) {
1.412 raeburn 6292: $secmatch = 1;
6293: } elsif ($usec eq '') {
1.420 albertel 6294: if (grep(/^none$/,@{$sections})) {
1.412 raeburn 6295: $secmatch = 1;
6296: }
6297: } else {
6298: if (grep(/^\Q$usec\E$/,@{$sections})) {
6299: $secmatch = 1;
6300: }
6301: }
6302: if (!$secmatch) {
6303: next;
6304: }
1.288 raeburn 6305: }
1.419 raeburn 6306: if ($usec eq '') {
6307: $usec = 'none';
6308: }
1.275 raeburn 6309: if ($uname ne '' && $udom ne '') {
1.630 raeburn 6310: if ($hidepriv) {
6311: if ((&Apache::lonnet::privileged($uname,$udom)) &&
6312: (!$nothide{$uname.':'.$udom})) {
6313: next;
6314: }
6315: }
1.503 raeburn 6316: if ($end > 0 && $end < $now) {
1.439 raeburn 6317: $status = 'previous';
6318: } elsif ($start > $now) {
6319: $status = 'future';
6320: } else {
6321: $status = 'active';
6322: }
1.277 albertel 6323: foreach my $type (keys(%{$types})) {
1.275 raeburn 6324: if ($status eq $type) {
1.420 albertel 6325: if (!grep(/^\Q$type\E$/,@{$$users{$role}{$user}})) {
1.419 raeburn 6326: push(@{$$users{$role}{$user}},$type);
6327: }
1.288 raeburn 6328: $match = 1;
6329: }
6330: }
1.419 raeburn 6331: if (($match) && (ref($userdata) eq 'HASH')) {
6332: if (!exists($$userdata{$uname.':'.$udom})) {
6333: &get_user_info($udom,$uname,\%idx,$userdata);
6334: }
1.420 albertel 6335: if (!grep(/^\Q$usec\E$/,@{$seclists{$uname.':'.$udom}})) {
1.419 raeburn 6336: push(@{$seclists{$uname.':'.$udom}},$usec);
6337: }
1.609 raeburn 6338: if (ref($statushash) eq 'HASH') {
6339: $statushash->{$uname.':'.$udom}{$role}{$usec} = $displaystatus{$status};
6340: }
1.275 raeburn 6341: }
6342: }
6343: }
6344: }
1.290 albertel 6345: if (grep(/^ow$/,@{$roles})) {
1.279 raeburn 6346: if ((defined($cdom)) && (defined($cnum))) {
6347: my %csettings = &Apache::lonnet::get('environment',['internal.courseowner'],$cdom,$cnum);
6348: if ( defined($csettings{'internal.courseowner'}) ) {
6349: my $owner = $csettings{'internal.courseowner'};
1.609 raeburn 6350: next if ($owner eq '');
6351: my ($ownername,$ownerdom);
6352: if ($owner =~ /^([^:]+):([^:]+)$/) {
6353: $ownername = $1;
6354: $ownerdom = $2;
6355: } else {
6356: $ownername = $owner;
6357: $ownerdom = $cdom;
6358: $owner = $ownername.':'.$ownerdom;
1.439 raeburn 6359: }
6360: @{$$users{'ow'}{$owner}} = 'any';
1.290 albertel 6361: if (defined($userdata) &&
1.609 raeburn 6362: !exists($$userdata{$owner})) {
6363: &get_user_info($ownerdom,$ownername,\%idx,$userdata);
6364: if (!grep(/^none$/,@{$seclists{$owner}})) {
6365: push(@{$seclists{$owner}},'none');
6366: }
6367: if (ref($statushash) eq 'HASH') {
6368: $statushash->{$owner}{'ow'}{'none'} = 'Any';
1.419 raeburn 6369: }
1.290 albertel 6370: }
1.279 raeburn 6371: }
6372: }
6373: }
1.419 raeburn 6374: foreach my $user (keys(%seclists)) {
6375: @{$seclists{$user}} = (sort {$a <=> $b} @{$seclists{$user}});
6376: $$userdata{$user}[$idx{section}] = join(',',@{$seclists{$user}});
6377: }
1.275 raeburn 6378: }
6379: return;
6380: }
6381:
1.288 raeburn 6382: sub get_user_info {
6383: my ($udom,$uname,$idx,$userdata) = @_;
1.289 albertel 6384: $$userdata{$uname.':'.$udom}[$$idx{fullname}] =
6385: &plainname($uname,$udom,'lastname');
1.291 albertel 6386: $$userdata{$uname.':'.$udom}[$$idx{uname}] = $uname;
1.297 raeburn 6387: $$userdata{$uname.':'.$udom}[$$idx{udom}] = $udom;
1.609 raeburn 6388: my %idhash = &Apache::lonnet::idrget($udom,($uname));
6389: $$userdata{$uname.':'.$udom}[$$idx{id}] = $idhash{$uname};
1.288 raeburn 6390: return;
6391: }
1.275 raeburn 6392:
1.472 raeburn 6393: ###############################################
6394:
6395: =pod
6396:
6397: =item * &get_user_quota()
6398:
6399: Retrieves quota assigned for storage of portfolio files for a user
6400:
6401: Incoming parameters:
6402: 1. user's username
6403: 2. user's domain
6404:
6405: Returns:
1.536 raeburn 6406: 1. Disk quota (in Mb) assigned to student.
6407: 2. (Optional) Type of setting: custom or default
6408: (individually assigned or default for user's
6409: institutional status).
6410: 3. (Optional) - User's institutional status (e.g., faculty, staff
6411: or student - types as defined in localenroll::inst_usertypes
6412: for user's domain, which determines default quota for user.
6413: 4. (Optional) - Default quota which would apply to the user.
1.472 raeburn 6414:
6415: If a value has been stored in the user's environment,
1.536 raeburn 6416: it will return that, otherwise it returns the maximal default
6417: defined for the user's instituional status(es) in the domain.
1.472 raeburn 6418:
6419: =cut
6420:
6421: ###############################################
6422:
6423:
6424: sub get_user_quota {
6425: my ($uname,$udom) = @_;
1.536 raeburn 6426: my ($quota,$quotatype,$settingstatus,$defquota);
1.472 raeburn 6427: if (!defined($udom)) {
6428: $udom = $env{'user.domain'};
6429: }
6430: if (!defined($uname)) {
6431: $uname = $env{'user.name'};
6432: }
6433: if (($udom eq '' || $uname eq '') ||
6434: ($udom eq 'public') && ($uname eq 'public')) {
6435: $quota = 0;
1.536 raeburn 6436: $quotatype = 'default';
6437: $defquota = 0;
1.472 raeburn 6438: } else {
1.536 raeburn 6439: my $inststatus;
1.472 raeburn 6440: if ($udom eq $env{'user.domain'} && $uname eq $env{'user.name'}) {
6441: $quota = $env{'environment.portfolioquota'};
1.536 raeburn 6442: $inststatus = $env{'environment.inststatus'};
1.472 raeburn 6443: } else {
1.536 raeburn 6444: my %userenv =
6445: &Apache::lonnet::get('environment',['portfolioquota',
6446: 'inststatus'],$udom,$uname);
1.472 raeburn 6447: my ($tmp) = keys(%userenv);
6448: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
6449: $quota = $userenv{'portfolioquota'};
1.536 raeburn 6450: $inststatus = $userenv{'inststatus'};
1.472 raeburn 6451: } else {
6452: undef(%userenv);
6453: }
6454: }
1.536 raeburn 6455: ($defquota,$settingstatus) = &default_quota($udom,$inststatus);
1.472 raeburn 6456: if ($quota eq '') {
1.536 raeburn 6457: $quota = $defquota;
6458: $quotatype = 'default';
6459: } else {
6460: $quotatype = 'custom';
1.472 raeburn 6461: }
6462: }
1.536 raeburn 6463: if (wantarray) {
6464: return ($quota,$quotatype,$settingstatus,$defquota);
6465: } else {
6466: return $quota;
6467: }
1.472 raeburn 6468: }
6469:
6470: ###############################################
6471:
6472: =pod
6473:
6474: =item * &default_quota()
6475:
1.536 raeburn 6476: Retrieves default quota assigned for storage of user portfolio files,
6477: given an (optional) user's institutional status.
1.472 raeburn 6478:
6479: Incoming parameters:
6480: 1. domain
1.536 raeburn 6481: 2. (Optional) institutional status(es). This is a : separated list of
6482: status types (e.g., faculty, staff, student etc.)
6483: which apply to the user for whom the default is being retrieved.
6484: If the institutional status string in undefined, the domain
6485: default quota will be returned.
1.472 raeburn 6486:
6487: Returns:
6488: 1. Default disk quota (in Mb) for user portfolios in the domain.
1.536 raeburn 6489: 2. (Optional) institutional type which determined the value of the
6490: default quota.
1.472 raeburn 6491:
6492: If a value has been stored in the domain's configuration db,
6493: it will return that, otherwise it returns 20 (for backwards
6494: compatibility with domains which have not set up a configuration
6495: db file; the original statically defined portfolio quota was 20 Mb).
6496:
1.536 raeburn 6497: If the user's status includes multiple types (e.g., staff and student),
6498: the largest default quota which applies to the user determines the
6499: default quota returned.
6500:
1.472 raeburn 6501: =cut
6502:
6503: ###############################################
6504:
6505:
6506: sub default_quota {
1.536 raeburn 6507: my ($udom,$inststatus) = @_;
6508: my ($defquota,$settingstatus);
6509: my %quotahash = &Apache::lonnet::get_dom('configuration',
1.622 raeburn 6510: ['quotas'],$udom);
6511: if (ref($quotahash{'quotas'}) eq 'HASH') {
1.536 raeburn 6512: if ($inststatus ne '') {
6513: my @statuses = split(/:/,$inststatus);
6514: foreach my $item (@statuses) {
1.692.2.3! raeburn 6515: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
! 6516: if ($quotahash{'quotas'}{'defaultquota'}{$item} ne '') {
! 6517: if ($defquota eq '') {
! 6518: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
! 6519: $settingstatus = $item;
! 6520: } elsif ($quotahash{'quotas'}{'defaultquota'}{$item} > $defquota) {
! 6521: $defquota = $quotahash{'quotas'}{'defaultquota'}{$item};
! 6522: $settingstatus = $item;
! 6523: }
! 6524: }
! 6525: } else {
! 6526: if ($quotahash{'quotas'}{$item} ne '') {
! 6527: if ($defquota eq '') {
! 6528: $defquota = $quotahash{'quotas'}{$item};
! 6529: $settingstatus = $item;
! 6530: } elsif ($quotahash{'quotas'}{$item} > $defquota) {
! 6531: $defquota = $quotahash{'quotas'}{$item};
! 6532: $settingstatus = $item;
! 6533: }
1.536 raeburn 6534: }
6535: }
6536: }
6537: }
6538: if ($defquota eq '') {
1.692.2.3! raeburn 6539: if (ref($quotahash{'quotas'}{'defaultquota'}) eq 'HASH') {
! 6540: $defquota = $quotahash{'quotas'}{'defaultquota'}{'default'};
! 6541: } else {
! 6542: $defquota = $quotahash{'quotas'}{'default'};
! 6543: }
1.536 raeburn 6544: $settingstatus = 'default';
6545: }
6546: } else {
6547: $settingstatus = 'default';
6548: $defquota = 20;
6549: }
6550: if (wantarray) {
6551: return ($defquota,$settingstatus);
1.472 raeburn 6552: } else {
1.536 raeburn 6553: return $defquota;
1.472 raeburn 6554: }
6555: }
6556:
1.384 raeburn 6557: sub get_secgrprole_info {
6558: my ($cdom,$cnum,$needroles,$type) = @_;
6559: my %sections_count = &get_sections($cdom,$cnum);
6560: my @sections = (sort {$a <=> $b} keys(%sections_count));
6561: my %curr_groups = &Apache::longroup::coursegroups($cdom,$cnum);
6562: my @groups = sort(keys(%curr_groups));
6563: my $allroles = [];
6564: my $rolehash;
6565: my $accesshash = {
6566: active => 'Currently has access',
6567: future => 'Will have future access',
6568: previous => 'Previously had access',
6569: };
6570: if ($needroles) {
6571: $rolehash = {'all' => 'all'};
1.385 albertel 6572: my %user_roles = &Apache::lonnet::dump('nohist_userroles',$cdom,$cnum);
6573: if (&Apache::lonnet::error(%user_roles)) {
6574: undef(%user_roles);
6575: }
6576: foreach my $item (keys(%user_roles)) {
1.384 raeburn 6577: my ($role)=split(/\:/,$item,2);
6578: if ($role eq 'cr') { next; }
6579: if ($role =~ /^cr/) {
6580: $$rolehash{$role} = (split('/',$role))[3];
6581: } else {
6582: $$rolehash{$role} = &Apache::lonnet::plaintext($role,$type);
6583: }
6584: }
6585: foreach my $key (sort(keys(%{$rolehash}))) {
6586: push(@{$allroles},$key);
6587: }
6588: push (@{$allroles},'st');
6589: $$rolehash{'st'} = &Apache::lonnet::plaintext('st',$type);
6590: }
6591: return (\@sections,\@groups,$allroles,$rolehash,$accesshash);
6592: }
6593:
1.555 raeburn 6594: sub user_picker {
1.627 raeburn 6595: my ($dom,$srch,$forcenewuser,$caller,$cancreate,$usertype) = @_;
1.555 raeburn 6596: my $currdom = $dom;
6597: my %curr_selected = (
6598: srchin => 'dom',
1.580 raeburn 6599: srchby => 'lastname',
1.555 raeburn 6600: );
6601: my $srchterm;
1.625 raeburn 6602: if ((ref($srch) eq 'HASH') && ($env{'form.origform'} ne 'crtusername')) {
1.555 raeburn 6603: if ($srch->{'srchby'} ne '') {
6604: $curr_selected{'srchby'} = $srch->{'srchby'};
6605: }
6606: if ($srch->{'srchin'} ne '') {
6607: $curr_selected{'srchin'} = $srch->{'srchin'};
6608: }
6609: if ($srch->{'srchtype'} ne '') {
6610: $curr_selected{'srchtype'} = $srch->{'srchtype'};
6611: }
6612: if ($srch->{'srchdomain'} ne '') {
6613: $currdom = $srch->{'srchdomain'};
6614: }
6615: $srchterm = $srch->{'srchterm'};
6616: }
6617: my %lt=&Apache::lonlocal::texthash(
1.573 raeburn 6618: 'usr' => 'Search criteria',
1.563 raeburn 6619: 'doma' => 'Domain/institution to search',
1.558 albertel 6620: 'uname' => 'username',
6621: 'lastname' => 'last name',
1.555 raeburn 6622: 'lastfirst' => 'last name, first name',
1.558 albertel 6623: 'crs' => 'in this course',
1.576 raeburn 6624: 'dom' => 'in selected LON-CAPA domain',
1.558 albertel 6625: 'alc' => 'all LON-CAPA',
1.573 raeburn 6626: 'instd' => 'in institutional directory for selected domain',
1.558 albertel 6627: 'exact' => 'is',
6628: 'contains' => 'contains',
1.569 raeburn 6629: 'begins' => 'begins with',
1.571 raeburn 6630: 'youm' => "You must include some text to search for.",
6631: 'thte' => "The text you are searching for must contain at least two characters when using a 'begins' type search.",
6632: 'thet' => "The text you are searching for must contain at least three characters when using a 'contains' type search.",
6633: 'yomc' => "You must choose a domain when using an institutional directory search.",
6634: 'ymcd' => "You must choose a domain when using a domain search.",
6635: 'whus' => "When using searching by last,first you must include a comma as separator between last name and first name.",
6636: 'whse' => "When searching by last,first you must include at least one character in the first name.",
6637: 'thfo' => "The following need to be corrected before the search can be run:",
1.555 raeburn 6638: );
1.563 raeburn 6639: my $domform = &select_dom_form($currdom,'srchdomain',1,1);
6640: my $srchinsel = ' <select name="srchin">';
1.555 raeburn 6641:
6642: my @srchins = ('crs','dom','alc','instd');
6643:
6644: foreach my $option (@srchins) {
6645: # FIXME 'alc' option unavailable until
6646: # loncreateuser::print_user_query_page()
6647: # has been completed.
6648: next if ($option eq 'alc');
6649: next if ($option eq 'crs' && !$env{'request.course.id'});
1.563 raeburn 6650: if ($curr_selected{'srchin'} eq $option) {
6651: $srchinsel .= '
6652: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6653: } else {
6654: $srchinsel .= '
6655: <option value="'.$option.'">'.$lt{$option}.'</option>';
6656: }
1.555 raeburn 6657: }
1.563 raeburn 6658: $srchinsel .= "\n </select>\n";
1.555 raeburn 6659:
6660: my $srchbysel = ' <select name="srchby">';
1.580 raeburn 6661: foreach my $option ('lastname','lastfirst','uname') {
1.555 raeburn 6662: if ($curr_selected{'srchby'} eq $option) {
6663: $srchbysel .= '
6664: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6665: } else {
6666: $srchbysel .= '
6667: <option value="'.$option.'">'.$lt{$option}.'</option>';
6668: }
6669: }
6670: $srchbysel .= "\n </select>\n";
6671:
6672: my $srchtypesel = ' <select name="srchtype">';
1.580 raeburn 6673: foreach my $option ('begins','contains','exact') {
1.555 raeburn 6674: if ($curr_selected{'srchtype'} eq $option) {
6675: $srchtypesel .= '
6676: <option value="'.$option.'" selected="selected">'.$lt{$option}.'</option>';
6677: } else {
6678: $srchtypesel .= '
6679: <option value="'.$option.'">'.$lt{$option}.'</option>';
6680: }
6681: }
6682: $srchtypesel .= "\n </select>\n";
6683:
1.558 albertel 6684: my ($newuserscript,$new_user_create);
1.556 raeburn 6685:
6686: if ($forcenewuser) {
1.576 raeburn 6687: if (ref($srch) eq 'HASH') {
6688: if ($srch->{'srchby'} eq 'uname' && $srch->{'srchtype'} eq 'exact' && $srch->{'srchin'} eq 'dom' && $srch->{'srchdomain'} eq $env{'request.role.domain'}) {
1.627 raeburn 6689: if ($cancreate) {
6690: $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>';
6691: } else {
6692: my $helplink = ' href="javascript:helpMenu('."'display'".')"';
6693: my %usertypetext = (
6694: official => 'institutional',
6695: unofficial => 'non-institutional',
6696: );
6697: $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 />';
6698: }
1.576 raeburn 6699: }
6700: }
6701:
1.556 raeburn 6702: $newuserscript = <<"ENDSCRIPT";
6703:
1.570 raeburn 6704: function setSearch(createnew,callingForm) {
1.556 raeburn 6705: if (createnew == 1) {
1.570 raeburn 6706: for (var i=0; i<callingForm.srchby.length; i++) {
6707: if (callingForm.srchby.options[i].value == 'uname') {
6708: callingForm.srchby.selectedIndex = i;
1.556 raeburn 6709: }
6710: }
1.570 raeburn 6711: for (var i=0; i<callingForm.srchin.length; i++) {
6712: if ( callingForm.srchin.options[i].value == 'dom') {
6713: callingForm.srchin.selectedIndex = i;
1.556 raeburn 6714: }
6715: }
1.570 raeburn 6716: for (var i=0; i<callingForm.srchtype.length; i++) {
6717: if (callingForm.srchtype.options[i].value == 'exact') {
6718: callingForm.srchtype.selectedIndex = i;
1.556 raeburn 6719: }
6720: }
1.570 raeburn 6721: for (var i=0; i<callingForm.srchdomain.length; i++) {
6722: if (callingForm.srchdomain.options[i].value == '$env{'request.role.domain'}') {
6723: callingForm.srchdomain.selectedIndex = i;
1.556 raeburn 6724: }
6725: }
6726: }
6727: }
6728: ENDSCRIPT
1.558 albertel 6729:
1.556 raeburn 6730: }
6731:
1.555 raeburn 6732: my $output = <<"END_BLOCK";
1.556 raeburn 6733: <script type="text/javascript">
1.570 raeburn 6734: function validateEntry(callingForm) {
1.558 albertel 6735:
1.556 raeburn 6736: var checkok = 1;
1.558 albertel 6737: var srchin;
1.570 raeburn 6738: for (var i=0; i<callingForm.srchin.length; i++) {
6739: if ( callingForm.srchin[i].checked ) {
6740: srchin = callingForm.srchin[i].value;
1.558 albertel 6741: }
6742: }
6743:
1.570 raeburn 6744: var srchtype = callingForm.srchtype.options[callingForm.srchtype.selectedIndex].value;
6745: var srchby = callingForm.srchby.options[callingForm.srchby.selectedIndex].value;
6746: var srchdomain = callingForm.srchdomain.options[callingForm.srchdomain.selectedIndex].value;
6747: var srchterm = callingForm.srchterm.value;
6748: var srchin = callingForm.srchin.options[callingForm.srchin.selectedIndex].value;
1.556 raeburn 6749: var msg = "";
6750:
6751: if (srchterm == "") {
6752: checkok = 0;
1.571 raeburn 6753: msg += "$lt{'youm'}\\n";
1.556 raeburn 6754: }
6755:
1.569 raeburn 6756: if (srchtype== 'begins') {
6757: if (srchterm.length < 2) {
6758: checkok = 0;
1.571 raeburn 6759: msg += "$lt{'thte'}\\n";
1.569 raeburn 6760: }
6761: }
6762:
1.556 raeburn 6763: if (srchtype== 'contains') {
6764: if (srchterm.length < 3) {
6765: checkok = 0;
1.571 raeburn 6766: msg += "$lt{'thet'}\\n";
1.556 raeburn 6767: }
6768: }
6769: if (srchin == 'instd') {
6770: if (srchdomain == '') {
6771: checkok = 0;
1.571 raeburn 6772: msg += "$lt{'yomc'}\\n";
1.556 raeburn 6773: }
6774: }
6775: if (srchin == 'dom') {
6776: if (srchdomain == '') {
6777: checkok = 0;
1.571 raeburn 6778: msg += "$lt{'ymcd'}\\n";
1.556 raeburn 6779: }
6780: }
6781: if (srchby == 'lastfirst') {
6782: if (srchterm.indexOf(",") == -1) {
6783: checkok = 0;
1.571 raeburn 6784: msg += "$lt{'whus'}\\n";
1.556 raeburn 6785: }
6786: if (srchterm.indexOf(",") == srchterm.length -1) {
6787: checkok = 0;
1.571 raeburn 6788: msg += "$lt{'whse'}\\n";
1.556 raeburn 6789: }
6790: }
6791: if (checkok == 0) {
1.571 raeburn 6792: alert("$lt{'thfo'}\\n"+msg);
1.556 raeburn 6793: return;
6794: }
6795: if (checkok == 1) {
1.570 raeburn 6796: callingForm.submit();
1.556 raeburn 6797: }
6798: }
6799:
6800: $newuserscript
6801:
6802: </script>
1.558 albertel 6803:
6804: $new_user_create
6805:
1.555 raeburn 6806: <table>
1.558 albertel 6807: <tr>
1.573 raeburn 6808: <td>$lt{'doma'}:</td>
6809: <td>$domform</td>
6810: </td>
6811: </tr>
6812: <tr>
6813: <td>$lt{'usr'}:</td>
1.563 raeburn 6814: <td>$srchbysel
6815: $srchtypesel
6816: <input type="text" size="15" name="srchterm" value="$srchterm" />
1.564 albertel 6817: $srchinsel
1.563 raeburn 6818: </td>
6819: </tr>
1.555 raeburn 6820: </table>
6821: <br />
6822: END_BLOCK
1.558 albertel 6823:
1.555 raeburn 6824: return $output;
6825: }
6826:
1.612 raeburn 6827: sub user_rule_check {
1.615 raeburn 6828: my ($usershash,$checks,$alerts,$rulematch,$inst_results,$curr_rules,$got_rules) = @_;
1.612 raeburn 6829: my $response;
6830: if (ref($usershash) eq 'HASH') {
6831: foreach my $user (keys(%{$usershash})) {
6832: my ($uname,$udom) = split(/:/,$user);
6833: next if ($udom eq '' || $uname eq '');
1.615 raeburn 6834: my ($id,$newuser);
1.612 raeburn 6835: if (ref($usershash->{$user}) eq 'HASH') {
1.615 raeburn 6836: $newuser = $usershash->{$user}->{'newuser'};
1.612 raeburn 6837: $id = $usershash->{$user}->{'id'};
6838: }
6839: my $inst_response;
6840: if (ref($checks) eq 'HASH') {
6841: if (defined($checks->{'username'})) {
1.615 raeburn 6842: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 6843: &Apache::lonnet::get_instuser($udom,$uname);
6844: } elsif (defined($checks->{'id'})) {
1.615 raeburn 6845: ($inst_response,%{$inst_results->{$user}}) =
1.612 raeburn 6846: &Apache::lonnet::get_instuser($udom,undef,$id);
6847: }
1.615 raeburn 6848: } else {
6849: ($inst_response,%{$inst_results->{$user}}) =
6850: &Apache::lonnet::get_instuser($udom,$uname);
6851: return;
1.612 raeburn 6852: }
1.615 raeburn 6853: if (!$got_rules->{$udom}) {
1.612 raeburn 6854: my %domconfig = &Apache::lonnet::get_dom('configuration',
6855: ['usercreation'],$udom);
6856: if (ref($domconfig{'usercreation'}) eq 'HASH') {
1.615 raeburn 6857: foreach my $item ('username','id') {
1.612 raeburn 6858: if (ref($domconfig{'usercreation'}{$item.'_rule'}) eq 'ARRAY') {
6859: $$curr_rules{$udom}{$item} =
6860: $domconfig{'usercreation'}{$item.'_rule'};
1.585 raeburn 6861: }
6862: }
6863: }
1.615 raeburn 6864: $got_rules->{$udom} = 1;
1.585 raeburn 6865: }
1.612 raeburn 6866: foreach my $item (keys(%{$checks})) {
6867: if (ref($$curr_rules{$udom}) eq 'HASH') {
6868: if (ref($$curr_rules{$udom}{$item}) eq 'ARRAY') {
6869: if (@{$$curr_rules{$udom}{$item}} > 0) {
6870: my %rule_check = &Apache::lonnet::inst_rulecheck($udom,$uname,$id,$item,$$curr_rules{$udom}{$item});
6871: foreach my $rule (@{$$curr_rules{$udom}{$item}}) {
6872: if ($rule_check{$rule}) {
6873: $$rulematch{$user}{$item} = $rule;
6874: if ($inst_response eq 'ok') {
1.615 raeburn 6875: if (ref($inst_results) eq 'HASH') {
6876: if (ref($inst_results->{$user}) eq 'HASH') {
6877: if (keys(%{$inst_results->{$user}}) == 0) {
6878: $$alerts{$item}{$udom}{$uname} = 1;
6879: }
1.612 raeburn 6880: }
6881: }
1.615 raeburn 6882: }
6883: last;
1.585 raeburn 6884: }
6885: }
6886: }
6887: }
6888: }
6889: }
6890: }
6891: }
1.612 raeburn 6892: return;
6893: }
6894:
6895: sub user_rule_formats {
6896: my ($domain,$domdesc,$curr_rules,$check) = @_;
6897: my %text = (
6898: 'username' => 'Usernames',
6899: 'id' => 'IDs',
6900: );
6901: my $output;
6902: my ($rules,$ruleorder) = &Apache::lonnet::inst_userrules($domain,$check);
6903: if ((ref($rules) eq 'HASH') && (ref($ruleorder) eq 'ARRAY')) {
6904: if (@{$ruleorder} > 0) {
6905: $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>';
6906: foreach my $rule (@{$ruleorder}) {
6907: if (ref($curr_rules) eq 'ARRAY') {
6908: if (grep(/^\Q$rule\E$/,@{$curr_rules})) {
6909: if (ref($rules->{$rule}) eq 'HASH') {
6910: $output .= '<li>'.$rules->{$rule}{'name'}.': '.
6911: $rules->{$rule}{'desc'}.'</li>';
6912: }
6913: }
6914: }
6915: }
6916: $output .= '</ul>';
6917: }
6918: }
6919: return $output;
6920: }
6921:
6922: sub instrule_disallow_msg {
1.615 raeburn 6923: my ($checkitem,$domdesc,$count,$mode) = @_;
1.612 raeburn 6924: my $response;
6925: my %text = (
6926: item => 'username',
6927: items => 'usernames',
6928: match => 'matches',
6929: do => 'does',
6930: action => 'a username',
6931: one => 'one',
6932: );
6933: if ($count > 1) {
6934: $text{'item'} = 'usernames';
6935: $text{'match'} ='match';
6936: $text{'do'} = 'do';
6937: $text{'action'} = 'usernames',
6938: $text{'one'} = 'ones';
6939: }
6940: if ($checkitem eq 'id') {
6941: $text{'items'} = 'IDs';
6942: $text{'item'} = 'ID';
6943: $text{'action'} = 'an ID';
1.615 raeburn 6944: if ($count > 1) {
6945: $text{'item'} = 'IDs';
6946: $text{'action'} = 'IDs';
6947: }
1.612 raeburn 6948: }
1.674 bisitz 6949: $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 6950: if ($mode eq 'upload') {
6951: if ($checkitem eq 'username') {
6952: $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'}.");
6953: } elsif ($checkitem eq 'id') {
1.674 bisitz 6954: $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 6955: }
1.669 raeburn 6956: } elsif ($mode eq 'selfcreate') {
6957: if ($checkitem eq 'id') {
6958: $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.");
6959: }
1.615 raeburn 6960: } else {
6961: if ($checkitem eq 'username') {
6962: $response .= &mt("You must choose $text{'action'} with a different format -- $text{'one'} that will not conflict with 'official' institutional $text{'items'}.");
6963: } elsif ($checkitem eq 'id') {
6964: $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.");
6965: }
1.612 raeburn 6966: }
6967: return $response;
1.585 raeburn 6968: }
6969:
1.624 raeburn 6970: sub personal_data_fieldtitles {
6971: my %fieldtitles = &Apache::lonlocal::texthash (
6972: id => 'Student/Employee ID',
6973: permanentemail => 'E-mail address',
6974: lastname => 'Last Name',
6975: firstname => 'First Name',
6976: middlename => 'Middle Name',
6977: generation => 'Generation',
6978: gen => 'Generation',
6979: );
6980: return %fieldtitles;
6981: }
6982:
1.642 raeburn 6983: sub sorted_inst_types {
6984: my ($dom) = @_;
6985: my ($usertypes,$order) = &Apache::lonnet::retrieve_inst_usertypes($dom);
6986: my $othertitle = &mt('All users');
6987: if ($env{'request.course.id'}) {
1.668 raeburn 6988: $othertitle = &mt('Any users');
1.642 raeburn 6989: }
6990: my @types;
6991: if (ref($order) eq 'ARRAY') {
6992: @types = @{$order};
6993: }
6994: if (@types == 0) {
6995: if (ref($usertypes) eq 'HASH') {
6996: @types = sort(keys(%{$usertypes}));
6997: }
6998: }
6999: if (keys(%{$usertypes}) > 0) {
7000: $othertitle = &mt('Other users');
7001: }
7002: return ($othertitle,$usertypes,\@types);
7003: }
7004:
1.645 raeburn 7005: sub get_institutional_codes {
7006: my ($settings,$allcourses,$LC_code) = @_;
7007: # Get complete list of course sections to update
7008: my @currsections = ();
7009: my @currxlists = ();
7010: my $coursecode = $$settings{'internal.coursecode'};
7011:
7012: if ($$settings{'internal.sectionnums'} ne '') {
7013: @currsections = split(/,/,$$settings{'internal.sectionnums'});
7014: }
7015:
7016: if ($$settings{'internal.crosslistings'} ne '') {
7017: @currxlists = split(/,/,$$settings{'internal.crosslistings'});
7018: }
7019:
7020: if (@currxlists > 0) {
7021: foreach (@currxlists) {
7022: if (m/^([^:]+):(\w*)$/) {
7023: unless (grep/^$1$/,@{$allcourses}) {
7024: push @{$allcourses},$1;
7025: $$LC_code{$1} = $2;
7026: }
7027: }
7028: }
7029: }
7030:
7031: if (@currsections > 0) {
7032: foreach (@currsections) {
7033: if (m/^(\w+):(\w*)$/) {
7034: my $sec = $coursecode.$1;
7035: my $lc_sec = $2;
7036: unless (grep/^$sec$/,@{$allcourses}) {
7037: push @{$allcourses},$sec;
7038: $$LC_code{$sec} = $lc_sec;
7039: }
7040: }
7041: }
7042: }
7043: return;
7044: }
7045:
1.112 bowersj2 7046: =pod
7047:
1.549 albertel 7048: =back
7049:
7050: =head1 HTTP Helpers
7051:
7052: =over 4
7053:
1.648 raeburn 7054: =item * &get_unprocessed_cgi($query,$possible_names)
1.112 bowersj2 7055:
1.258 albertel 7056: Modify the %env hash to contain unprocessed CGI form parameters held in
1.112 bowersj2 7057: $query. The parameters listed in $possible_names (an array reference),
1.258 albertel 7058: will be set in $env{'form.name'} if they do not already exist.
1.112 bowersj2 7059:
7060: Typically called with $ENV{'QUERY_STRING'} as the first parameter.
7061: $possible_names is an ref to an array of form element names. As an example:
7062: get_unprocessed_cgi($ENV{'QUERY_STRING'},['uname','udom']);
1.258 albertel 7063: will result in $env{'form.uname'} and $env{'form.udom'} being set.
1.112 bowersj2 7064:
7065: =cut
1.1 albertel 7066:
1.6 albertel 7067: sub get_unprocessed_cgi {
1.25 albertel 7068: my ($query,$possible_names)= @_;
1.26 matthew 7069: # $Apache::lonxml::debug=1;
1.356 albertel 7070: foreach my $pair (split(/&/,$query)) {
7071: my ($name, $value) = split(/=/,$pair);
1.369 www 7072: $name = &unescape($name);
1.25 albertel 7073: if (!defined($possible_names) || (grep {$_ eq $name} @$possible_names)) {
7074: $value =~ tr/+/ /;
7075: $value =~ s/%([a-fA-F0-9][a-fA-F0-9])/pack("C",hex($1))/eg;
1.258 albertel 7076: unless (defined($env{'form.'.$name})) { &add_to_env('form.'.$name,$value) };
1.25 albertel 7077: }
1.16 harris41 7078: }
1.6 albertel 7079: }
7080:
1.112 bowersj2 7081: =pod
7082:
1.648 raeburn 7083: =item * &cacheheader()
1.112 bowersj2 7084:
7085: returns cache-controlling header code
7086:
7087: =cut
7088:
1.7 albertel 7089: sub cacheheader {
1.258 albertel 7090: unless ($env{'request.method'} eq 'GET') { return ''; }
1.216 albertel 7091: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime);
7092: my $output .='<meta HTTP-EQUIV="Expires" CONTENT="'.$date.'" />
1.7 albertel 7093: <meta HTTP-EQUIV="Cache-control" CONTENT="no-cache" />
7094: <meta HTTP-EQUIV="Pragma" CONTENT="no-cache" />';
1.216 albertel 7095: return $output;
1.7 albertel 7096: }
7097:
1.112 bowersj2 7098: =pod
7099:
1.648 raeburn 7100: =item * &no_cache($r)
1.112 bowersj2 7101:
7102: specifies header code to not have cache
7103:
7104: =cut
7105:
1.9 albertel 7106: sub no_cache {
1.216 albertel 7107: my ($r) = @_;
7108: if ($ENV{'REQUEST_METHOD'} ne 'GET' &&
1.258 albertel 7109: $env{'request.method'} ne 'GET') { return ''; }
1.216 albertel 7110: my $date=strftime("%a, %d %b %Y %H:%M:%S GMT",gmtime(time));
7111: $r->no_cache(1);
7112: $r->header_out("Expires" => $date);
7113: $r->header_out("Pragma" => "no-cache");
1.123 www 7114: }
7115:
7116: sub content_type {
1.181 albertel 7117: my ($r,$type,$charset) = @_;
1.299 foxr 7118: if ($r) {
7119: # Note that printout.pl calls this with undef for $r.
7120: &no_cache($r);
7121: }
1.258 albertel 7122: if ($env{'browser.mathml'} && $type eq 'text/html') { $type='text/xml'; }
1.181 albertel 7123: unless ($charset) {
7124: $charset=&Apache::lonlocal::current_encoding;
7125: }
7126: if ($charset) { $type.='; charset='.$charset; }
7127: if ($r) {
7128: $r->content_type($type);
7129: } else {
7130: print("Content-type: $type\n\n");
7131: }
1.9 albertel 7132: }
1.25 albertel 7133:
1.112 bowersj2 7134: =pod
7135:
1.648 raeburn 7136: =item * &add_to_env($name,$value)
1.112 bowersj2 7137:
1.258 albertel 7138: adds $name to the %env hash with value
1.112 bowersj2 7139: $value, if $name already exists, the entry is converted to an array
7140: reference and $value is added to the array.
7141:
7142: =cut
7143:
1.25 albertel 7144: sub add_to_env {
7145: my ($name,$value)=@_;
1.258 albertel 7146: if (defined($env{$name})) {
7147: if (ref($env{$name})) {
1.25 albertel 7148: #already have multiple values
1.258 albertel 7149: push(@{ $env{$name} },$value);
1.25 albertel 7150: } else {
7151: #first time seeing multiple values, convert hash entry to an arrayref
1.258 albertel 7152: my $first=$env{$name};
7153: undef($env{$name});
7154: push(@{ $env{$name} },$first,$value);
1.25 albertel 7155: }
7156: } else {
1.258 albertel 7157: $env{$name}=$value;
1.25 albertel 7158: }
1.31 albertel 7159: }
1.149 albertel 7160:
7161: =pod
7162:
1.648 raeburn 7163: =item * &get_env_multiple($name)
1.149 albertel 7164:
1.258 albertel 7165: gets $name from the %env hash, it seemlessly handles the cases where multiple
1.149 albertel 7166: values may be defined and end up as an array ref.
7167:
7168: returns an array of values
7169:
7170: =cut
7171:
7172: sub get_env_multiple {
7173: my ($name) = @_;
7174: my @values;
1.258 albertel 7175: if (defined($env{$name})) {
1.149 albertel 7176: # exists is it an array
1.258 albertel 7177: if (ref($env{$name})) {
7178: @values=@{ $env{$name} };
1.149 albertel 7179: } else {
1.258 albertel 7180: $values[0]=$env{$name};
1.149 albertel 7181: }
7182: }
7183: return(@values);
7184: }
7185:
1.660 raeburn 7186: sub ask_for_embedded_content {
7187: my ($actionurl,$state,$allfiles,$codebase,$args)=@_;
7188: my $upload_output = '
7189: <form name="upload_embedded" action="'.$actionurl.'"
7190: method="post" enctype="multipart/form-data">';
7191: $upload_output .= $state;
1.661 raeburn 7192: $upload_output .= '<b>Upload embedded files</b>:<br />'.&start_data_table();
1.660 raeburn 7193:
7194: my $num = 0;
7195: foreach my $embed_file (sort {lc($a) cmp lc($b)} keys(%{$allfiles})) {
7196: $upload_output .= &start_data_table_row().
7197: '<td>'.$embed_file.'</td><td>';
7198: if ($args->{'ignore_remote_references'}
7199: && $embed_file =~ m{^\w+://}) {
7200: $upload_output.='<span class="LC_warning">'.&mt("URL points to other server.").'</span>';
7201: } elsif ($args->{'error_on_invalid_names'}
7202: && $embed_file ne &Apache::lonnet::clean_filename($embed_file,{'keep_path' => 1,})) {
7203:
7204: $upload_output.='<span class="LC_warning">'.&mt("Invalid characters").'</span>';
7205:
7206: } else {
7207: $upload_output .='
1.661 raeburn 7208: <input name="embedded_item_'.$num.'" type="file" value="" />
1.660 raeburn 7209: <input name="embedded_orig_'.$num.'" type="hidden" value="'.&escape($embed_file).'" />';
7210: my $attrib = join(':',@{$$allfiles{$embed_file}});
7211: $upload_output .=
7212: "\n\t\t".
7213: '<input name="embedded_attrib_'.$num.'" type="hidden" value="'.
7214: $attrib.'" />';
7215: if (exists($$codebase{$embed_file})) {
7216: $upload_output .=
7217: "\n\t\t".
7218: '<input name="codebase_'.$num.'" type="hidden" value="'.
7219: &escape($$codebase{$embed_file}).'" />';
7220: }
7221: }
7222: $upload_output .= '</td>'.&Apache::loncommon::end_data_table_row();
7223: $num++;
7224: }
7225: $upload_output .= &Apache::loncommon::end_data_table().'<br />
7226: <input type ="hidden" name="number_embedded_items" value="'.$num.'" />
7227: <input type ="submit" value="'.&mt('Upload Listed Files').'" />
7228: '.&mt('(only files for which a location has been provided will be uploaded)').'
7229: </form>';
7230: return $upload_output;
7231: }
7232:
1.661 raeburn 7233: sub upload_embedded {
7234: my ($context,$dirpath,$uname,$udom,$dir_root,$url_root,$group,$disk_quota,
7235: $current_disk_usage) = @_;
7236: my $output;
7237: for (my $i=0; $i<$env{'form.number_embedded_items'}; $i++) {
7238: next if (!exists($env{'form.embedded_item_'.$i.'.filename'}));
7239: my $orig_uploaded_filename =
7240: $env{'form.embedded_item_'.$i.'.filename'};
7241:
7242: $env{'form.embedded_orig_'.$i} =
7243: &unescape($env{'form.embedded_orig_'.$i});
7244: my ($path,$fname) =
7245: ($env{'form.embedded_orig_'.$i} =~ m{(.*/)([^/]*)});
7246: # no path, whole string is fname
7247: if (!$fname) { $fname = $env{'form.embedded_orig_'.$i} };
7248:
7249: $path = $env{'form.currentpath'}.$path;
7250: $fname = &Apache::lonnet::clean_filename($fname);
7251: # See if there is anything left
7252: next if ($fname eq '');
7253:
7254: # Check if file already exists as a file or directory.
7255: my ($state,$msg);
7256: if ($context eq 'portfolio') {
7257: my $port_path = $dirpath;
7258: if ($group ne '') {
7259: $port_path = "groups/$group/$port_path";
7260: }
7261: ($state,$msg) = &check_for_upload($path,$fname,$group,'embedded_item_'.$i,
7262: $dir_root,$port_path,$disk_quota,
7263: $current_disk_usage,$uname,$udom);
7264: if ($state eq 'will_exceed_quota'
7265: || $state eq 'file_locked'
7266: || $state eq 'file_exists' ) {
7267: $output .= $msg;
7268: next;
7269: }
7270: } elsif (($context eq 'author') || ($context eq 'testbank')) {
7271: ($state,$msg) = &check_for_existing($path,$fname,'embedded_item_'.$i);
7272: if ($state eq 'exists') {
7273: $output .= $msg;
7274: next;
7275: }
7276: }
7277: # Check if extension is valid
7278: if (($fname =~ /\.(\w+)$/) &&
7279: (&Apache::loncommon::fileembstyle($1) eq 'hdn')) {
7280: $output .= &mt('Invalid file extension ([_1]) - reserved for LONCAPA use - rename the file with a different extension and re-upload. ',$1);
7281: next;
7282: } elsif (($fname =~ /\.(\w+)$/) &&
7283: (!defined(&Apache::loncommon::fileembstyle($1)))) {
7284: $output .= &mt('Unrecognized file extension ([_1]) - rename the file with a proper extension and re-upload.',$1);
7285: next;
7286: } elsif ($fname=~/\.(\d+)\.(\w+)$/) {
7287: $output .= &mt('File name not allowed - rename the file to remove the number immediately before the file extension([_1]) and re-upload.',$2);
7288: next;
7289: }
7290:
7291: $env{'form.embedded_item_'.$i.'.filename'}=$fname;
7292: if ($context eq 'portfolio') {
7293: my $result=
7294: &Apache::lonnet::userfileupload('embedded_item_'.$i,'',
7295: $dirpath.$path);
7296: if ($result !~ m|^/uploaded/|) {
7297: $output .= '<span class="LC_error">'
7298: .&mt('An error occurred ([_1]) while trying to upload [_2] for embedded element [_3].'
7299: ,$result,$orig_uploaded_filename,$env{'form.embedded_orig_'.$i})
7300: .'</span><br />';
7301: next;
7302: } else {
7303: $output .= '<p>'.&mt('Uploaded [_1]','<span class="LC_filename">'.
7304: $path.$fname.'</span>').'</p>';
7305: }
7306: } else {
7307: # Save the file
7308: my $target = $env{'form.embedded_item_'.$i};
7309: my $fullpath = $dir_root.$dirpath.'/'.$path;
7310: my $dest = $fullpath.$fname;
7311: my $url = $url_root.$dirpath.'/'.$path.$fname;
7312: my @parts=split(/\//,$fullpath);
7313: my $count;
7314: my $filepath = $dir_root;
7315: for ($count=4;$count<=$#parts;$count++) {
7316: $filepath .= "/$parts[$count]";
7317: if ((-e $filepath)!=1) {
7318: mkdir($filepath,0770);
7319: }
7320: }
7321: my $fh;
7322: if (!open($fh,'>'.$dest)) {
7323: &Apache::lonnet::logthis('Failed to create '.$dest);
7324: $output .= '<span class="LC_error">'.
7325: &mt('An error occurred while trying to upload [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7326: '</span><br />';
7327: } else {
7328: if (!print $fh $env{'form.embedded_item_'.$i}) {
7329: &Apache::lonnet::logthis('Failed to write to '.$dest);
7330: $output .= '<span class="LC_error">'.
7331: &mt('An error occurred while writing the file [_1] for embedded element [_2].',$orig_uploaded_filename,$env{'form.embedded_orig_'.$i}).
7332: '</span><br />';
7333: } else {
7334: if ($context eq 'testbank') {
7335: $output .= &mt('Embedded file uploaded successfully:').
7336: ' <a href="'.$url.'">'.
7337: $orig_uploaded_filename.'</a><br />';
7338: } else {
7339: $output .= '<font size="+2">'.
7340: &mt('View embedded file: [_1]','<a href="'.$url.'">'.
7341: $orig_uploaded_filename.'</a>').'</font><br />';
7342: }
7343: }
7344: close($fh);
7345: }
7346: }
7347: }
7348: return $output;
7349: }
7350:
7351: sub check_for_existing {
7352: my ($path,$fname,$element) = @_;
7353: my ($state,$msg);
7354: if (-d $path.'/'.$fname) {
7355: $state = 'exists';
7356: $msg = &mt('Unable to upload [_1]. A directory by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7357: } elsif (-e $path.'/'.$fname) {
7358: $state = 'exists';
7359: $msg = &mt('Unable to upload [_1]. A file by that name was found in [_2].','<span class="LC_filename">'.$fname.'</span>',$path);
7360: }
7361: if ($state eq 'exists') {
7362: $msg = '<span class="LC_error">'.$msg.'</span><br />';
7363: }
7364: return ($state,$msg);
7365: }
7366:
7367: sub check_for_upload {
7368: my ($path,$fname,$group,$element,$portfolio_root,$port_path,
7369: $disk_quota,$current_disk_usage,$uname,$udom) = @_;
7370: my $filesize = (length($env{'form.'.$element})) / 1000; #express in k (1024?)
7371: my $getpropath = 1;
7372: my @dir_list = &Apache::lonnet::dirlist($portfolio_root.$path,$udom,$uname,
7373: $getpropath);
7374: my $found_file = 0;
7375: my $locked_file = 0;
7376: foreach my $line (@dir_list) {
7377: my ($file_name)=split(/\&/,$line,2);
7378: if ($file_name eq $fname){
7379: $file_name = $path.$file_name;
7380: if ($group ne '') {
7381: $file_name = $group.$file_name;
7382: }
7383: $found_file = 1;
7384: if (&Apache::lonnet::is_locked($file_name,$udom,$uname) eq 'true') {
7385: $locked_file = 1;
7386: }
7387: }
7388: }
7389: if (($current_disk_usage + $filesize) > $disk_quota){
7390: my $msg = '<span class="LC_error">'.
7391: &mt('Unable to upload [_1]. (size = [_2] kilobytes). Disk quota will be exceeded.','<span class="LC_filename">'.$fname.'</span>',$filesize).'</span>'.
7392: '<br />'.&mt('Disk quota is [_1] kilobytes. Your current disk usage is [_2] kilobytes.',$disk_quota,$current_disk_usage);
7393: return ('will_exceed_quota',$msg);
7394: } elsif ($found_file) {
7395: if ($locked_file) {
7396: my $msg = '<span class="LC_error">';
7397: $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>');
7398: $msg .= '</span><br />';
7399: $msg .= &mt('You will be able to rename or delete existing [_1] after a grade has been assigned.','<span class="LC_filename">'.$fname.'</span>');
7400: return ('file_locked',$msg);
7401: } else {
7402: my $msg = '<span class="LC_error">';
7403: $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'});
7404: $msg .= '</span>';
7405: $msg .= '<br />';
7406: $msg .= &mt('To upload, rename or delete existing [_1] in [_2].','<span class="LC_filename">'.$fname.'</span>', $port_path.$env{'form.currentpath'});
7407: return ('file_exists',$msg);
7408: }
7409: }
7410: }
7411:
1.31 albertel 7412:
1.41 ng 7413: =pod
1.45 matthew 7414:
1.464 albertel 7415: =back
1.41 ng 7416:
1.112 bowersj2 7417: =head1 CSV Upload/Handling functions
1.38 albertel 7418:
1.41 ng 7419: =over 4
7420:
1.648 raeburn 7421: =item * &upfile_store($r)
1.41 ng 7422:
7423: Store uploaded file, $r should be the HTTP Request object,
1.258 albertel 7424: needs $env{'form.upfile'}
1.41 ng 7425: returns $datatoken to be put into hidden field
7426:
7427: =cut
1.31 albertel 7428:
7429: sub upfile_store {
7430: my $r=shift;
1.258 albertel 7431: $env{'form.upfile'}=~s/\r/\n/gs;
7432: $env{'form.upfile'}=~s/\f/\n/gs;
7433: $env{'form.upfile'}=~s/\n+/\n/gs;
7434: $env{'form.upfile'}=~s/\n+$//gs;
1.31 albertel 7435:
1.258 albertel 7436: my $datatoken=$env{'user.name'}.'_'.$env{'user.domain'}.
7437: '_enroll_'.$env{'request.course.id'}.'_'.time.'_'.$$;
1.31 albertel 7438: {
1.158 raeburn 7439: my $datafile = $r->dir_config('lonDaemons').
7440: '/tmp/'.$datatoken.'.tmp';
7441: if ( open(my $fh,">$datafile") ) {
1.258 albertel 7442: print $fh $env{'form.upfile'};
1.158 raeburn 7443: close($fh);
7444: }
1.31 albertel 7445: }
7446: return $datatoken;
7447: }
7448:
1.56 matthew 7449: =pod
7450:
1.648 raeburn 7451: =item * &load_tmp_file($r)
1.41 ng 7452:
7453: Load uploaded file from tmp, $r should be the HTTP Request object,
1.258 albertel 7454: needs $env{'form.datatoken'},
7455: sets $env{'form.upfile'} to the contents of the file
1.41 ng 7456:
7457: =cut
1.31 albertel 7458:
7459: sub load_tmp_file {
7460: my $r=shift;
7461: my @studentdata=();
7462: {
1.158 raeburn 7463: my $studentfile = $r->dir_config('lonDaemons').
1.258 albertel 7464: '/tmp/'.$env{'form.datatoken'}.'.tmp';
1.158 raeburn 7465: if ( open(my $fh,"<$studentfile") ) {
7466: @studentdata=<$fh>;
7467: close($fh);
7468: }
1.31 albertel 7469: }
1.258 albertel 7470: $env{'form.upfile'}=join('',@studentdata);
1.31 albertel 7471: }
7472:
1.56 matthew 7473: =pod
7474:
1.648 raeburn 7475: =item * &upfile_record_sep()
1.41 ng 7476:
7477: Separate uploaded file into records
7478: returns array of records,
1.258 albertel 7479: needs $env{'form.upfile'} and $env{'form.upfiletype'}
1.41 ng 7480:
7481: =cut
1.31 albertel 7482:
7483: sub upfile_record_sep {
1.258 albertel 7484: if ($env{'form.upfiletype'} eq 'xml') {
1.31 albertel 7485: } else {
1.248 albertel 7486: my @records;
1.258 albertel 7487: foreach my $line (split(/\n/,$env{'form.upfile'})) {
1.248 albertel 7488: if ($line=~/^\s*$/) { next; }
7489: push(@records,$line);
7490: }
7491: return @records;
1.31 albertel 7492: }
7493: }
7494:
1.56 matthew 7495: =pod
7496:
1.648 raeburn 7497: =item * &record_sep($record)
1.41 ng 7498:
1.258 albertel 7499: Separate a record into fields $record should be an item from the upfile_record_sep(), needs $env{'form.upfiletype'}
1.41 ng 7500:
7501: =cut
7502:
1.263 www 7503: sub takeleft {
7504: my $index=shift;
7505: return substr('0000'.$index,-4,4);
7506: }
7507:
1.31 albertel 7508: sub record_sep {
7509: my $record=shift;
7510: my %components=();
1.258 albertel 7511: if ($env{'form.upfiletype'} eq 'xml') {
7512: } elsif ($env{'form.upfiletype'} eq 'space') {
1.31 albertel 7513: my $i=0;
1.356 albertel 7514: foreach my $field (split(/\s+/,$record)) {
1.31 albertel 7515: $field=~s/^(\"|\')//;
7516: $field=~s/(\"|\')$//;
1.263 www 7517: $components{&takeleft($i)}=$field;
1.31 albertel 7518: $i++;
7519: }
1.258 albertel 7520: } elsif ($env{'form.upfiletype'} eq 'tab') {
1.31 albertel 7521: my $i=0;
1.356 albertel 7522: foreach my $field (split(/\t/,$record)) {
1.31 albertel 7523: $field=~s/^(\"|\')//;
7524: $field=~s/(\"|\')$//;
1.263 www 7525: $components{&takeleft($i)}=$field;
1.31 albertel 7526: $i++;
7527: }
7528: } else {
1.561 www 7529: my $separator=',';
1.480 banghart 7530: if ($env{'form.upfiletype'} eq 'semisv') {
1.561 www 7531: $separator=';';
1.480 banghart 7532: }
1.31 albertel 7533: my $i=0;
1.561 www 7534: # the character we are looking for to indicate the end of a quote or a record
7535: my $looking_for=$separator;
7536: # do not add the characters to the fields
7537: my $ignore=0;
7538: # we just encountered a separator (or the beginning of the record)
7539: my $just_found_separator=1;
7540: # store the field we are working on here
7541: my $field='';
7542: # work our way through all characters in record
7543: foreach my $character ($record=~/(.)/g) {
7544: if ($character eq $looking_for) {
7545: if ($character ne $separator) {
7546: # Found the end of a quote, again looking for separator
7547: $looking_for=$separator;
7548: $ignore=1;
7549: } else {
7550: # Found a separator, store away what we got
7551: $components{&takeleft($i)}=$field;
7552: $i++;
7553: $just_found_separator=1;
7554: $ignore=0;
7555: $field='';
7556: }
7557: next;
7558: }
7559: # single or double quotation marks after a separator indicate beginning of a quote
7560: # we are now looking for the end of the quote and need to ignore separators
7561: if ((($character eq '"') || ($character eq "'")) && ($just_found_separator)) {
7562: $looking_for=$character;
7563: next;
7564: }
7565: # ignore would be true after we reached the end of a quote
7566: if ($ignore) { next; }
7567: if (($just_found_separator) && ($character=~/\s/)) { next; }
7568: $field.=$character;
7569: $just_found_separator=0;
1.31 albertel 7570: }
1.561 www 7571: # catch the very last entry, since we never encountered the separator
7572: $components{&takeleft($i)}=$field;
1.31 albertel 7573: }
7574: return %components;
7575: }
7576:
1.144 matthew 7577: ######################################################
7578: ######################################################
7579:
1.56 matthew 7580: =pod
7581:
1.648 raeburn 7582: =item * &upfile_select_html()
1.41 ng 7583:
1.144 matthew 7584: Return HTML code to select a file from the users machine and specify
7585: the file type.
1.41 ng 7586:
7587: =cut
7588:
1.144 matthew 7589: ######################################################
7590: ######################################################
1.31 albertel 7591: sub upfile_select_html {
1.144 matthew 7592: my %Types = (
7593: csv => &mt('CSV (comma separated values, spreadsheet)'),
1.480 banghart 7594: semisv => &mt('Semicolon separated values'),
1.144 matthew 7595: space => &mt('Space separated'),
7596: tab => &mt('Tabulator separated'),
7597: # xml => &mt('HTML/XML'),
7598: );
7599: my $Str = '<input type="file" name="upfile" size="50" />'.
7600: '<br />Type: <select name="upfiletype">';
7601: foreach my $type (sort(keys(%Types))) {
7602: $Str .= '<option value="'.$type.'" >'.$Types{$type}."</option>\n";
7603: }
7604: $Str .= "</select>\n";
7605: return $Str;
1.31 albertel 7606: }
7607:
1.301 albertel 7608: sub get_samples {
7609: my ($records,$toget) = @_;
7610: my @samples=({});
7611: my $got=0;
7612: foreach my $rec (@$records) {
7613: my %temp = &record_sep($rec);
7614: if (! grep(/\S/, values(%temp))) { next; }
7615: if (%temp) {
7616: $samples[$got]=\%temp;
7617: $got++;
7618: if ($got == $toget) { last; }
7619: }
7620: }
7621: return \@samples;
7622: }
7623:
1.144 matthew 7624: ######################################################
7625: ######################################################
7626:
1.56 matthew 7627: =pod
7628:
1.648 raeburn 7629: =item * &csv_print_samples($r,$records)
1.41 ng 7630:
7631: Prints a table of sample values from each column uploaded $r is an
7632: Apache Request ref, $records is an arrayref from
7633: &Apache::loncommon::upfile_record_sep
7634:
7635: =cut
7636:
1.144 matthew 7637: ######################################################
7638: ######################################################
1.31 albertel 7639: sub csv_print_samples {
7640: my ($r,$records) = @_;
1.662 bisitz 7641: my $samples = &get_samples($records,5);
1.301 albertel 7642:
1.594 raeburn 7643: $r->print(&mt('Samples').'<br />'.&start_data_table().
7644: &start_data_table_header_row());
1.356 albertel 7645: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7646: $r->print('<th>'.&mt('Column [_1]',($sample+1)).'</th>'); }
1.594 raeburn 7647: $r->print(&end_data_table_header_row());
1.301 albertel 7648: foreach my $hash (@$samples) {
1.594 raeburn 7649: $r->print(&start_data_table_row());
1.356 albertel 7650: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
1.31 albertel 7651: $r->print('<td>');
1.356 albertel 7652: if (defined($$hash{$sample})) { $r->print($$hash{$sample}); }
1.31 albertel 7653: $r->print('</td>');
7654: }
1.594 raeburn 7655: $r->print(&end_data_table_row());
1.31 albertel 7656: }
1.594 raeburn 7657: $r->print(&end_data_table().'<br />'."\n");
1.31 albertel 7658: }
7659:
1.144 matthew 7660: ######################################################
7661: ######################################################
7662:
1.56 matthew 7663: =pod
7664:
1.648 raeburn 7665: =item * &csv_print_select_table($r,$records,$d)
1.41 ng 7666:
7667: Prints a table to create associations between values and table columns.
1.144 matthew 7668:
1.41 ng 7669: $r is an Apache Request ref,
7670: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
1.174 matthew 7671: $d is an array of 2 element arrays (internal name, displayed name,defaultcol)
1.41 ng 7672:
7673: =cut
7674:
1.144 matthew 7675: ######################################################
7676: ######################################################
1.31 albertel 7677: sub csv_print_select_table {
7678: my ($r,$records,$d) = @_;
1.301 albertel 7679: my $i=0;
7680: my $samples = &get_samples($records,1);
1.144 matthew 7681: $r->print(&mt('Associate columns with student attributes.')."\n".
1.594 raeburn 7682: &start_data_table().&start_data_table_header_row().
1.144 matthew 7683: '<th>'.&mt('Attribute').'</th>'.
1.594 raeburn 7684: '<th>'.&mt('Column').'</th>'.
7685: &end_data_table_header_row()."\n");
1.356 albertel 7686: foreach my $array_ref (@$d) {
7687: my ($value,$display,$defaultcol)=@{ $array_ref };
1.689 bisitz 7688: $r->print(&start_data_table_row().'<td>'.$display.'</td>');
1.31 albertel 7689:
7690: $r->print('<td><select name=f'.$i.
1.32 matthew 7691: ' onchange="javascript:flip(this.form,'.$i.');">');
1.31 albertel 7692: $r->print('<option value="none"></option>');
1.356 albertel 7693: foreach my $sample (sort({$a <=> $b} keys(%{ $samples->[0] }))) {
7694: $r->print('<option value="'.$sample.'"'.
7695: ($sample eq $defaultcol ? ' selected="selected" ' : '').
1.662 bisitz 7696: '>'.&mt('Column [_1]',($sample+1)).'</option>');
1.31 albertel 7697: }
1.594 raeburn 7698: $r->print('</select></td>'.&end_data_table_row()."\n");
1.31 albertel 7699: $i++;
7700: }
1.594 raeburn 7701: $r->print(&end_data_table());
1.31 albertel 7702: $i--;
7703: return $i;
7704: }
1.56 matthew 7705:
1.144 matthew 7706: ######################################################
7707: ######################################################
7708:
1.56 matthew 7709: =pod
1.31 albertel 7710:
1.648 raeburn 7711: =item * &csv_samples_select_table($r,$records,$d)
1.41 ng 7712:
7713: Prints a table of sample values from the upload and can make associate samples to internal names.
7714:
7715: $r is an Apache Request ref,
7716: $records is an arrayref from &Apache::loncommon::upfile_record_sep,
7717: $d is an array of 2 element arrays (internal name, displayed name)
7718:
7719: =cut
7720:
1.144 matthew 7721: ######################################################
7722: ######################################################
1.31 albertel 7723: sub csv_samples_select_table {
7724: my ($r,$records,$d) = @_;
7725: my $i=0;
1.144 matthew 7726: #
1.662 bisitz 7727: my $max_samples = 5;
7728: my $samples = &get_samples($records,$max_samples);
1.594 raeburn 7729: $r->print(&start_data_table().
7730: &start_data_table_header_row().'<th>'.
7731: &mt('Field').'</th><th>'.&mt('Samples').'</th>'.
7732: &end_data_table_header_row());
1.301 albertel 7733:
7734: foreach my $key (sort(keys(%{ $samples->[0] }))) {
1.594 raeburn 7735: $r->print(&start_data_table_row().'<td><select name="f'.$i.'"'.
1.32 matthew 7736: ' onchange="javascript:flip(this.form,'.$i.');">');
1.301 albertel 7737: foreach my $option (@$d) {
7738: my ($value,$display,$defaultcol)=@{ $option };
1.174 matthew 7739: $r->print('<option value="'.$value.'"'.
1.253 albertel 7740: ($i eq $defaultcol ? ' selected="selected" ':'').'>'.
1.174 matthew 7741: $display.'</option>');
1.31 albertel 7742: }
7743: $r->print('</select></td><td>');
1.662 bisitz 7744: foreach my $line (0..($max_samples-1)) {
1.301 albertel 7745: if (defined($samples->[$line]{$key})) {
7746: $r->print($samples->[$line]{$key}."<br />\n");
7747: }
7748: }
1.594 raeburn 7749: $r->print('</td>'.&end_data_table_row());
1.31 albertel 7750: $i++;
7751: }
1.594 raeburn 7752: $r->print(&end_data_table());
1.31 albertel 7753: $i--;
7754: return($i);
1.115 matthew 7755: }
7756:
1.144 matthew 7757: ######################################################
7758: ######################################################
7759:
1.115 matthew 7760: =pod
7761:
1.648 raeburn 7762: =item * &clean_excel_name($name)
1.115 matthew 7763:
7764: Returns a replacement for $name which does not contain any illegal characters.
7765:
7766: =cut
7767:
1.144 matthew 7768: ######################################################
7769: ######################################################
1.115 matthew 7770: sub clean_excel_name {
7771: my ($name) = @_;
7772: $name =~ s/[:\*\?\/\\]//g;
7773: if (length($name) > 31) {
7774: $name = substr($name,0,31);
7775: }
7776: return $name;
1.25 albertel 7777: }
1.84 albertel 7778:
1.85 albertel 7779: =pod
7780:
1.648 raeburn 7781: =item * &check_if_partid_hidden($id,$symb,$udom,$uname)
1.85 albertel 7782:
7783: Returns either 1 or undef
7784:
7785: 1 if the part is to be hidden, undef if it is to be shown
7786:
7787: Arguments are:
7788:
7789: $id the id of the part to be checked
7790: $symb, optional the symb of the resource to check
7791: $udom, optional the domain of the user to check for
7792: $uname, optional the username of the user to check for
7793:
7794: =cut
1.84 albertel 7795:
7796: sub check_if_partid_hidden {
7797: my ($id,$symb,$udom,$uname) = @_;
1.133 albertel 7798: my $hiddenparts=&Apache::lonnet::EXT('resource.0.hiddenparts',
1.84 albertel 7799: $symb,$udom,$uname);
1.141 albertel 7800: my $truth=1;
7801: #if the string starts with !, then the list is the list to show not hide
7802: if ($hiddenparts=~s/^\s*!//) { $truth=undef; }
1.84 albertel 7803: my @hiddenlist=split(/,/,$hiddenparts);
7804: foreach my $checkid (@hiddenlist) {
1.141 albertel 7805: if ($checkid =~ /^\s*\Q$id\E\s*$/) { return $truth; }
1.84 albertel 7806: }
1.141 albertel 7807: return !$truth;
1.84 albertel 7808: }
1.127 matthew 7809:
1.138 matthew 7810:
7811: ############################################################
7812: ############################################################
7813:
7814: =pod
7815:
1.157 matthew 7816: =back
7817:
1.138 matthew 7818: =head1 cgi-bin script and graphing routines
7819:
1.157 matthew 7820: =over 4
7821:
1.648 raeburn 7822: =item * &get_cgi_id()
1.138 matthew 7823:
7824: Inputs: none
7825:
7826: Returns an id which can be used to pass environment variables
7827: to various cgi-bin scripts. These environment variables will
7828: be removed from the users environment after a given time by
7829: the routine &Apache::lonnet::transfer_profile_to_env.
7830:
7831: =cut
7832:
7833: ############################################################
7834: ############################################################
1.152 albertel 7835: my $uniq=0;
1.136 matthew 7836: sub get_cgi_id {
1.154 albertel 7837: $uniq=($uniq+1)%100000;
1.280 albertel 7838: return (time.'_'.$$.'_'.$uniq);
1.136 matthew 7839: }
7840:
1.127 matthew 7841: ############################################################
7842: ############################################################
7843:
7844: =pod
7845:
1.648 raeburn 7846: =item * &DrawBarGraph()
1.127 matthew 7847:
1.138 matthew 7848: Facilitates the plotting of data in a (stacked) bar graph.
7849: Puts plot definition data into the users environment in order for
7850: graph.png to plot it. Returns an <img> tag for the plot.
7851: The bars on the plot are labeled '1','2',...,'n'.
7852:
7853: Inputs:
7854:
7855: =over 4
7856:
7857: =item $Title: string, the title of the plot
7858:
7859: =item $xlabel: string, text describing the X-axis of the plot
7860:
7861: =item $ylabel: string, text describing the Y-axis of the plot
7862:
7863: =item $Max: scalar, the maximum Y value to use in the plot
7864: If $Max is < any data point, the graph will not be rendered.
7865:
1.140 matthew 7866: =item $colors: array ref holding the colors to be used for the data sets when
1.138 matthew 7867: they are plotted. If undefined, default values will be used.
7868:
1.178 matthew 7869: =item $labels: array ref holding the labels to use on the x-axis for the bars.
7870:
1.138 matthew 7871: =item @Values: An array of array references. Each array reference holds data
7872: to be plotted in a stacked bar chart.
7873:
1.239 matthew 7874: =item If the final element of @Values is a hash reference the key/value
7875: pairs will be added to the graph definition.
7876:
1.138 matthew 7877: =back
7878:
7879: Returns:
7880:
7881: An <img> tag which references graph.png and the appropriate identifying
7882: information for the plot.
7883:
1.127 matthew 7884: =cut
7885:
7886: ############################################################
7887: ############################################################
1.134 matthew 7888: sub DrawBarGraph {
1.178 matthew 7889: my ($Title,$xlabel,$ylabel,$Max,$colors,$labels,@Values)=@_;
1.134 matthew 7890: #
7891: if (! defined($colors)) {
7892: $colors = ['#33ff00',
7893: '#0033cc', '#990000', '#aaaa66', '#663399', '#ff9933',
7894: '#66ccff', '#ff9999', '#cccc33', '#660000', '#33cc66',
7895: ];
7896: }
1.228 matthew 7897: my $extra_settings = {};
7898: if (ref($Values[-1]) eq 'HASH') {
7899: $extra_settings = pop(@Values);
7900: }
1.127 matthew 7901: #
1.136 matthew 7902: my $identifier = &get_cgi_id();
7903: my $id = 'cgi.'.$identifier;
1.129 matthew 7904: if (! @Values || ref($Values[0]) ne 'ARRAY') {
1.127 matthew 7905: return '';
7906: }
1.225 matthew 7907: #
7908: my @Labels;
7909: if (defined($labels)) {
7910: @Labels = @$labels;
7911: } else {
7912: for (my $i=0;$i<@{$Values[0]};$i++) {
7913: push (@Labels,$i+1);
7914: }
7915: }
7916: #
1.129 matthew 7917: my $NumBars = scalar(@{$Values[0]});
1.225 matthew 7918: if ($NumBars < scalar(@Labels)) { $NumBars = scalar(@Labels); }
1.129 matthew 7919: my %ValuesHash;
7920: my $NumSets=1;
7921: foreach my $array (@Values) {
7922: next if (! ref($array));
1.136 matthew 7923: $ValuesHash{$id.'.data.'.$NumSets++} =
1.132 matthew 7924: join(',',@$array);
1.129 matthew 7925: }
1.127 matthew 7926: #
1.136 matthew 7927: my ($height,$width,$xskip,$bar_width) = (200,120,1,15);
1.225 matthew 7928: if ($NumBars < 3) {
7929: $width = 120+$NumBars*32;
1.220 matthew 7930: $xskip = 1;
1.225 matthew 7931: $bar_width = 30;
7932: } elsif ($NumBars < 5) {
7933: $width = 120+$NumBars*20;
7934: $xskip = 1;
7935: $bar_width = 20;
1.220 matthew 7936: } elsif ($NumBars < 10) {
1.136 matthew 7937: $width = 120+$NumBars*15;
7938: $xskip = 1;
7939: $bar_width = 15;
7940: } elsif ($NumBars <= 25) {
7941: $width = 120+$NumBars*11;
7942: $xskip = 5;
7943: $bar_width = 8;
7944: } elsif ($NumBars <= 50) {
7945: $width = 120+$NumBars*8;
7946: $xskip = 5;
7947: $bar_width = 4;
7948: } else {
7949: $width = 120+$NumBars*8;
7950: $xskip = 5;
7951: $bar_width = 4;
7952: }
7953: #
1.137 matthew 7954: $Max = 1 if ($Max < 1);
7955: if ( int($Max) < $Max ) {
7956: $Max++;
7957: $Max = int($Max);
7958: }
1.127 matthew 7959: $Title = '' if (! defined($Title));
7960: $xlabel = '' if (! defined($xlabel));
7961: $ylabel = '' if (! defined($ylabel));
1.369 www 7962: $ValuesHash{$id.'.title'} = &escape($Title);
7963: $ValuesHash{$id.'.xlabel'} = &escape($xlabel);
7964: $ValuesHash{$id.'.ylabel'} = &escape($ylabel);
1.137 matthew 7965: $ValuesHash{$id.'.y_max_value'} = $Max;
1.136 matthew 7966: $ValuesHash{$id.'.NumBars'} = $NumBars;
7967: $ValuesHash{$id.'.NumSets'} = $NumSets;
7968: $ValuesHash{$id.'.PlotType'} = 'bar';
7969: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
7970: $ValuesHash{$id.'.height'} = $height;
7971: $ValuesHash{$id.'.width'} = $width;
7972: $ValuesHash{$id.'.xskip'} = $xskip;
7973: $ValuesHash{$id.'.bar_width'} = $bar_width;
7974: $ValuesHash{$id.'.labels'} = join(',',@Labels);
1.127 matthew 7975: #
1.228 matthew 7976: # Deal with other parameters
7977: while (my ($key,$value) = each(%$extra_settings)) {
7978: $ValuesHash{$id.'.'.$key} = $value;
7979: }
7980: #
1.646 raeburn 7981: &Apache::lonnet::appenv(\%ValuesHash);
1.137 matthew 7982: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
7983: }
7984:
7985: ############################################################
7986: ############################################################
7987:
7988: =pod
7989:
1.648 raeburn 7990: =item * &DrawXYGraph()
1.137 matthew 7991:
1.138 matthew 7992: Facilitates the plotting of data in an XY graph.
7993: Puts plot definition data into the users environment in order for
7994: graph.png to plot it. Returns an <img> tag for the plot.
7995:
7996: Inputs:
7997:
7998: =over 4
7999:
8000: =item $Title: string, the title of the plot
8001:
8002: =item $xlabel: string, text describing the X-axis of the plot
8003:
8004: =item $ylabel: string, text describing the Y-axis of the plot
8005:
8006: =item $Max: scalar, the maximum Y value to use in the plot
8007: If $Max is < any data point, the graph will not be rendered.
8008:
8009: =item $colors: Array ref containing the hex color codes for the data to be
8010: plotted in. If undefined, default values will be used.
8011:
8012: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8013:
8014: =item $Ydata: Array ref containing Array refs.
1.185 www 8015: Each of the contained arrays will be plotted as a separate curve.
1.138 matthew 8016:
8017: =item %Values: hash indicating or overriding any default values which are
8018: passed to graph.png.
8019: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8020:
8021: =back
8022:
8023: Returns:
8024:
8025: An <img> tag which references graph.png and the appropriate identifying
8026: information for the plot.
8027:
1.137 matthew 8028: =cut
8029:
8030: ############################################################
8031: ############################################################
8032: sub DrawXYGraph {
8033: my ($Title,$xlabel,$ylabel,$Max,$colors,$Xlabels,$Ydata,%Values)=@_;
8034: #
8035: # Create the identifier for the graph
8036: my $identifier = &get_cgi_id();
8037: my $id = 'cgi.'.$identifier;
8038: #
8039: $Title = '' if (! defined($Title));
8040: $xlabel = '' if (! defined($xlabel));
8041: $ylabel = '' if (! defined($ylabel));
8042: my %ValuesHash =
8043: (
1.369 www 8044: $id.'.title' => &escape($Title),
8045: $id.'.xlabel' => &escape($xlabel),
8046: $id.'.ylabel' => &escape($ylabel),
1.137 matthew 8047: $id.'.y_max_value'=> $Max,
8048: $id.'.labels' => join(',',@$Xlabels),
8049: $id.'.PlotType' => 'XY',
8050: );
8051: #
8052: if (defined($colors) && ref($colors) eq 'ARRAY') {
8053: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8054: }
8055: #
8056: if (! ref($Ydata) || ref($Ydata) ne 'ARRAY') {
8057: return '';
8058: }
8059: my $NumSets=1;
1.138 matthew 8060: foreach my $array (@{$Ydata}){
1.137 matthew 8061: next if (! ref($array));
8062: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
8063: }
1.138 matthew 8064: $ValuesHash{$id.'.NumSets'} = $NumSets-1;
1.137 matthew 8065: #
8066: # Deal with other parameters
8067: while (my ($key,$value) = each(%Values)) {
8068: $ValuesHash{$id.'.'.$key} = $value;
1.127 matthew 8069: }
8070: #
1.646 raeburn 8071: &Apache::lonnet::appenv(\%ValuesHash);
1.136 matthew 8072: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
8073: }
8074:
8075: ############################################################
8076: ############################################################
8077:
8078: =pod
8079:
1.648 raeburn 8080: =item * &DrawXYYGraph()
1.138 matthew 8081:
8082: Facilitates the plotting of data in an XY graph with two Y axes.
8083: Puts plot definition data into the users environment in order for
8084: graph.png to plot it. Returns an <img> tag for the plot.
8085:
8086: Inputs:
8087:
8088: =over 4
8089:
8090: =item $Title: string, the title of the plot
8091:
8092: =item $xlabel: string, text describing the X-axis of the plot
8093:
8094: =item $ylabel: string, text describing the Y-axis of the plot
8095:
8096: =item $colors: Array ref containing the hex color codes for the data to be
8097: plotted in. If undefined, default values will be used.
8098:
8099: =item $Xlabels: Array ref containing the labels to be used for the X-axis.
8100:
8101: =item $Ydata1: The first data set
8102:
8103: =item $Min1: The minimum value of the left Y-axis
8104:
8105: =item $Max1: The maximum value of the left Y-axis
8106:
8107: =item $Ydata2: The second data set
8108:
8109: =item $Min2: The minimum value of the right Y-axis
8110:
8111: =item $Max2: The maximum value of the left Y-axis
8112:
8113: =item %Values: hash indicating or overriding any default values which are
8114: passed to graph.png.
8115: Possible values are: width, xskip, x_ticks, x_tick_offset, among others.
8116:
8117: =back
8118:
8119: Returns:
8120:
8121: An <img> tag which references graph.png and the appropriate identifying
8122: information for the plot.
1.136 matthew 8123:
8124: =cut
8125:
8126: ############################################################
8127: ############################################################
1.137 matthew 8128: sub DrawXYYGraph {
8129: my ($Title,$xlabel,$ylabel,$colors,$Xlabels,$Ydata1,$Min1,$Max1,
8130: $Ydata2,$Min2,$Max2,%Values)=@_;
1.136 matthew 8131: #
8132: # Create the identifier for the graph
8133: my $identifier = &get_cgi_id();
8134: my $id = 'cgi.'.$identifier;
8135: #
8136: $Title = '' if (! defined($Title));
8137: $xlabel = '' if (! defined($xlabel));
8138: $ylabel = '' if (! defined($ylabel));
8139: my %ValuesHash =
8140: (
1.369 www 8141: $id.'.title' => &escape($Title),
8142: $id.'.xlabel' => &escape($xlabel),
8143: $id.'.ylabel' => &escape($ylabel),
1.136 matthew 8144: $id.'.labels' => join(',',@$Xlabels),
8145: $id.'.PlotType' => 'XY',
8146: $id.'.NumSets' => 2,
1.137 matthew 8147: $id.'.two_axes' => 1,
8148: $id.'.y1_max_value' => $Max1,
8149: $id.'.y1_min_value' => $Min1,
8150: $id.'.y2_max_value' => $Max2,
8151: $id.'.y2_min_value' => $Min2,
1.136 matthew 8152: );
8153: #
1.137 matthew 8154: if (defined($colors) && ref($colors) eq 'ARRAY') {
8155: $ValuesHash{$id.'.Colors'} = join(',',@{$colors});
8156: }
8157: #
8158: if (! ref($Ydata1) || ref($Ydata1) ne 'ARRAY' ||
8159: ! ref($Ydata2) || ref($Ydata2) ne 'ARRAY'){
1.136 matthew 8160: return '';
8161: }
8162: my $NumSets=1;
1.137 matthew 8163: foreach my $array ($Ydata1,$Ydata2){
1.136 matthew 8164: next if (! ref($array));
8165: $ValuesHash{$id.'.data.'.$NumSets++} = join(',',@$array);
1.137 matthew 8166: }
8167: #
8168: # Deal with other parameters
8169: while (my ($key,$value) = each(%Values)) {
8170: $ValuesHash{$id.'.'.$key} = $value;
1.136 matthew 8171: }
8172: #
1.646 raeburn 8173: &Apache::lonnet::appenv(\%ValuesHash);
1.130 albertel 8174: return '<img src="/cgi-bin/graph.png?'.$identifier.'" border="1" />';
1.139 matthew 8175: }
8176:
8177: ############################################################
8178: ############################################################
8179:
8180: =pod
8181:
1.157 matthew 8182: =back
8183:
1.139 matthew 8184: =head1 Statistics helper routines?
8185:
8186: Bad place for them but what the hell.
8187:
1.157 matthew 8188: =over 4
8189:
1.648 raeburn 8190: =item * &chartlink()
1.139 matthew 8191:
8192: Returns a link to the chart for a specific student.
8193:
8194: Inputs:
8195:
8196: =over 4
8197:
8198: =item $linktext: The text of the link
8199:
8200: =item $sname: The students username
8201:
8202: =item $sdomain: The students domain
8203:
8204: =back
8205:
1.157 matthew 8206: =back
8207:
1.139 matthew 8208: =cut
8209:
8210: ############################################################
8211: ############################################################
8212: sub chartlink {
8213: my ($linktext, $sname, $sdomain) = @_;
8214: my $link = '<a href="/adm/statistics?reportSelected=student_assessment'.
1.369 www 8215: '&SelectedStudent='.&escape($sname.':'.$sdomain).
1.219 albertel 8216: '&chartoutputmode='.HTML::Entities::encode('html, with all links').
1.139 matthew 8217: '">'.$linktext.'</a>';
1.153 matthew 8218: }
8219:
8220: #######################################################
8221: #######################################################
8222:
8223: =pod
8224:
8225: =head1 Course Environment Routines
1.157 matthew 8226:
8227: =over 4
1.153 matthew 8228:
1.648 raeburn 8229: =item * &restore_course_settings()
1.153 matthew 8230:
1.648 raeburn 8231: =item * &store_course_settings()
1.153 matthew 8232:
8233: Restores/Store indicated form parameters from the course environment.
8234: Will not overwrite existing values of the form parameters.
8235:
8236: Inputs:
8237: a scalar describing the data (e.g. 'chart', 'problem_analysis')
8238:
8239: a hash ref describing the data to be stored. For example:
8240:
8241: %Save_Parameters = ('Status' => 'scalar',
8242: 'chartoutputmode' => 'scalar',
8243: 'chartoutputdata' => 'scalar',
8244: 'Section' => 'array',
1.373 raeburn 8245: 'Group' => 'array',
1.153 matthew 8246: 'StudentData' => 'array',
8247: 'Maps' => 'array');
8248:
8249: Returns: both routines return nothing
8250:
1.631 raeburn 8251: =back
8252:
1.153 matthew 8253: =cut
8254:
8255: #######################################################
8256: #######################################################
8257: sub store_course_settings {
1.496 albertel 8258: return &store_settings($env{'request.course.id'},@_);
8259: }
8260:
8261: sub store_settings {
1.153 matthew 8262: # save to the environment
8263: # appenv the same items, just to be safe
1.300 albertel 8264: my $udom = $env{'user.domain'};
8265: my $uname = $env{'user.name'};
1.496 albertel 8266: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8267: my %SaveHash;
8268: my %AppHash;
8269: while (my ($setting,$type) = each(%$Settings)) {
1.496 albertel 8270: my $basename = join('.','internal',$context,$prefix,$setting);
1.300 albertel 8271: my $envname = 'environment.'.$basename;
1.258 albertel 8272: if (exists($env{'form.'.$setting})) {
1.153 matthew 8273: # Save this value away
8274: if ($type eq 'scalar' &&
1.258 albertel 8275: (! exists($env{$envname}) ||
8276: $env{$envname} ne $env{'form.'.$setting})) {
8277: $SaveHash{$basename} = $env{'form.'.$setting};
8278: $AppHash{$envname} = $env{'form.'.$setting};
1.153 matthew 8279: } elsif ($type eq 'array') {
8280: my $stored_form;
1.258 albertel 8281: if (ref($env{'form.'.$setting})) {
1.153 matthew 8282: $stored_form = join(',',
8283: map {
1.369 www 8284: &escape($_);
1.258 albertel 8285: } sort(@{$env{'form.'.$setting}}));
1.153 matthew 8286: } else {
8287: $stored_form =
1.369 www 8288: &escape($env{'form.'.$setting});
1.153 matthew 8289: }
8290: # Determine if the array contents are the same.
1.258 albertel 8291: if ($stored_form ne $env{$envname}) {
1.153 matthew 8292: $SaveHash{$basename} = $stored_form;
8293: $AppHash{$envname} = $stored_form;
8294: }
8295: }
8296: }
8297: }
8298: my $put_result = &Apache::lonnet::put('environment',\%SaveHash,
1.300 albertel 8299: $udom,$uname);
1.153 matthew 8300: if ($put_result !~ /^(ok|delayed)/) {
8301: &Apache::lonnet::logthis('unable to save form parameters, '.
8302: 'got error:'.$put_result);
8303: }
8304: # Make sure these settings stick around in this session, too
1.646 raeburn 8305: &Apache::lonnet::appenv(\%AppHash);
1.153 matthew 8306: return;
8307: }
8308:
8309: sub restore_course_settings {
1.499 albertel 8310: return &restore_settings($env{'request.course.id'},@_);
1.496 albertel 8311: }
8312:
8313: sub restore_settings {
8314: my ($context,$prefix,$Settings) = @_;
1.153 matthew 8315: while (my ($setting,$type) = each(%$Settings)) {
1.258 albertel 8316: next if (exists($env{'form.'.$setting}));
1.496 albertel 8317: my $envname = 'environment.internal.'.$context.'.'.$prefix.
1.153 matthew 8318: '.'.$setting;
1.258 albertel 8319: if (exists($env{$envname})) {
1.153 matthew 8320: if ($type eq 'scalar') {
1.258 albertel 8321: $env{'form.'.$setting} = $env{$envname};
1.153 matthew 8322: } elsif ($type eq 'array') {
1.258 albertel 8323: $env{'form.'.$setting} = [
1.153 matthew 8324: map {
1.369 www 8325: &unescape($_);
1.258 albertel 8326: } split(',',$env{$envname})
1.153 matthew 8327: ];
8328: }
8329: }
8330: }
1.127 matthew 8331: }
8332:
1.618 raeburn 8333: #######################################################
8334: #######################################################
8335:
8336: =pod
8337:
8338: =head1 Domain E-mail Routines
8339:
8340: =over 4
8341:
1.648 raeburn 8342: =item * &build_recipient_list()
1.618 raeburn 8343:
8344: Build recipient lists for three types of e-mail:
8345: (a) Error Reports, (b) Package Updates, (c) Help requests, generated by
1.619 raeburn 8346: lonerrorhandler.pm, CHECKRPMS and lonsupportreq.pm respectively.
1.618 raeburn 8347:
8348: Inputs:
1.619 raeburn 8349: defmail (scalar - email address of default recipient),
1.618 raeburn 8350: mailing type (scalar - errormail, packagesmail, or helpdeskmail),
1.619 raeburn 8351: defdom (domain for which to retrieve configuration settings),
8352: origmail (scalar - email address of recipient from loncapa.conf,
8353: i.e., predates configuration by DC via domainprefs.pm
1.618 raeburn 8354:
1.655 raeburn 8355: Returns: comma separated list of addresses to which to send e-mail.
8356:
8357: =back
1.618 raeburn 8358:
8359: =cut
8360:
8361: ############################################################
8362: ############################################################
8363: sub build_recipient_list {
1.619 raeburn 8364: my ($defmail,$mailing,$defdom,$origmail) = @_;
1.618 raeburn 8365: my @recipients;
8366: my $otheremails;
8367: my %domconfig =
8368: &Apache::lonnet::get_dom('configuration',['contacts'],$defdom);
8369: if (ref($domconfig{'contacts'}) eq 'HASH') {
8370: if (ref($domconfig{'contacts'}{$mailing}) eq 'HASH') {
8371: my @contacts = ('adminemail','supportemail');
8372: foreach my $item (@contacts) {
8373: if ($domconfig{'contacts'}{$mailing}{$item}) {
1.619 raeburn 8374: my $addr = $domconfig{'contacts'}{$item};
8375: if (!grep(/^\Q$addr\E$/,@recipients)) {
8376: push(@recipients,$addr);
8377: }
1.618 raeburn 8378: }
8379: $otheremails = $domconfig{'contacts'}{$mailing}{'others'};
8380: }
8381: }
1.619 raeburn 8382: } elsif ($origmail ne '') {
8383: push(@recipients,$origmail);
1.618 raeburn 8384: }
1.688 raeburn 8385: if (defined($defmail)) {
8386: if ($defmail ne '') {
8387: push(@recipients,$defmail);
8388: }
1.618 raeburn 8389: }
8390: if ($otheremails) {
1.619 raeburn 8391: my @others;
8392: if ($otheremails =~ /,/) {
8393: @others = split(/,/,$otheremails);
1.618 raeburn 8394: } else {
1.619 raeburn 8395: push(@others,$otheremails);
8396: }
8397: foreach my $addr (@others) {
8398: if (!grep(/^\Q$addr\E$/,@recipients)) {
8399: push(@recipients,$addr);
8400: }
1.618 raeburn 8401: }
8402: }
1.619 raeburn 8403: my $recipientlist = join(',',@recipients);
1.618 raeburn 8404: return $recipientlist;
8405: }
8406:
1.127 matthew 8407: ############################################################
8408: ############################################################
1.154 albertel 8409:
1.655 raeburn 8410: =pod
8411:
8412: =head1 Course Catalog Routines
8413:
8414: =over 4
8415:
8416: =item * &gather_categories()
8417:
8418: Converts category definitions - keys of categories hash stored in
8419: coursecategories in configuration.db on the primary library server in a
8420: domain - to an array. Also generates javascript and idx hash used to
8421: generate Domain Coordinator interface for editing Course Categories.
8422:
8423: Inputs:
1.663 raeburn 8424:
1.655 raeburn 8425: categories (reference to hash of category definitions).
1.663 raeburn 8426:
1.655 raeburn 8427: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8428: categories and subcategories).
1.663 raeburn 8429:
1.655 raeburn 8430: idx (reference to hash of counters used in Domain Coordinator interface for
8431: editing Course Categories).
1.663 raeburn 8432:
1.655 raeburn 8433: jsarray (reference to array of categories used to create Javascript arrays for
8434: Domain Coordinator interface for editing Course Categories).
8435:
8436: Returns: nothing
8437:
8438: Side effects: populates cats, idx and jsarray.
8439:
8440: =cut
8441:
8442: sub gather_categories {
8443: my ($categories,$cats,$idx,$jsarray) = @_;
8444: my %counters;
8445: my $num = 0;
8446: foreach my $item (keys(%{$categories})) {
8447: my ($cat,$container,$depth) = map { &unescape($_); } split(/:/,$item);
8448: if ($container eq '' && $depth == 0) {
8449: $cats->[$depth][$categories->{$item}] = $cat;
8450: } else {
8451: $cats->[$depth]{$container}[$categories->{$item}] = $cat;
8452: }
8453: my ($escitem,$tail) = split(/:/,$item,2);
8454: if ($counters{$tail} eq '') {
8455: $counters{$tail} = $num;
8456: $num ++;
8457: }
8458: if (ref($idx) eq 'HASH') {
8459: $idx->{$item} = $counters{$tail};
8460: }
8461: if (ref($jsarray) eq 'ARRAY') {
8462: push(@{$jsarray->[$counters{$tail}]},$item);
8463: }
8464: }
8465: return;
8466: }
8467:
8468: =pod
8469:
8470: =item * &extract_categories()
8471:
8472: Used to generate breadcrumb trails for course categories.
8473:
8474: Inputs:
1.663 raeburn 8475:
1.655 raeburn 8476: categories (reference to hash of category definitions).
1.663 raeburn 8477:
1.655 raeburn 8478: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8479: categories and subcategories).
1.663 raeburn 8480:
1.655 raeburn 8481: trails (reference to array of breacrumb trails for each category).
1.663 raeburn 8482:
1.655 raeburn 8483: allitems (reference to hash - key is category key
8484: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8485:
1.655 raeburn 8486: idx (reference to hash of counters used in Domain Coordinator interface for
8487: editing Course Categories).
1.663 raeburn 8488:
1.655 raeburn 8489: jsarray (reference to array of categories used to create Javascript arrays for
8490: Domain Coordinator interface for editing Course Categories).
8491:
1.665 raeburn 8492: subcats (reference to hash of arrays containing all subcategories within each
8493: category, -recursive)
8494:
1.655 raeburn 8495: Returns: nothing
8496:
8497: Side effects: populates trails and allitems hash references.
8498:
8499: =cut
8500:
8501: sub extract_categories {
1.665 raeburn 8502: my ($categories,$cats,$trails,$allitems,$idx,$jsarray,$subcats) = @_;
1.655 raeburn 8503: if (ref($categories) eq 'HASH') {
8504: &gather_categories($categories,$cats,$idx,$jsarray);
8505: if (ref($cats->[0]) eq 'ARRAY') {
8506: for (my $i=0; $i<@{$cats->[0]}; $i++) {
8507: my $name = $cats->[0][$i];
8508: my $item = &escape($name).'::0';
8509: my $trailstr;
8510: if ($name eq 'instcode') {
8511: $trailstr = &mt('Official courses (with institutional codes)');
8512: } else {
8513: $trailstr = $name;
8514: }
8515: if ($allitems->{$item} eq '') {
8516: push(@{$trails},$trailstr);
8517: $allitems->{$item} = scalar(@{$trails})-1;
8518: }
8519: my @parents = ($name);
8520: if (ref($cats->[1]{$name}) eq 'ARRAY') {
8521: for (my $j=0; $j<@{$cats->[1]{$name}}; $j++) {
8522: my $category = $cats->[1]{$name}[$j];
1.665 raeburn 8523: if (ref($subcats) eq 'HASH') {
8524: push(@{$subcats->{$item}},&escape($category).':'.&escape($name).':1');
8525: }
8526: &recurse_categories($cats,2,$category,$trails,$allitems,\@parents,$subcats);
8527: }
8528: } else {
8529: if (ref($subcats) eq 'HASH') {
8530: $subcats->{$item} = [];
1.655 raeburn 8531: }
8532: }
8533: }
8534: }
8535: }
8536: return;
8537: }
8538:
8539: =pod
8540:
8541: =item *&recurse_categories()
8542:
8543: Recursively used to generate breadcrumb trails for course categories.
8544:
8545: Inputs:
1.663 raeburn 8546:
1.655 raeburn 8547: cats (reference to array of arrays/hashes which encapsulates hierarchy of
8548: categories and subcategories).
1.663 raeburn 8549:
1.655 raeburn 8550: depth (current depth in hierarchy of categories and sub-categories - 0 indexed).
1.663 raeburn 8551:
8552: category (current course category, for which breadcrumb trail is being generated).
8553:
8554: trails (reference to array of breadcrumb trails for each category).
8555:
1.655 raeburn 8556: allitems (reference to hash - key is category key
8557: (format: escaped(name):escaped(parent category):depth in hierarchy).
1.663 raeburn 8558:
1.655 raeburn 8559: parents (array containing containers directories for current category,
8560: back to top level).
8561:
8562: Returns: nothing
8563:
8564: Side effects: populates trails and allitems hash references
8565:
8566: =cut
8567:
8568: sub recurse_categories {
1.665 raeburn 8569: my ($cats,$depth,$category,$trails,$allitems,$parents,$subcats) = @_;
1.655 raeburn 8570: my $shallower = $depth - 1;
8571: if (ref($cats->[$depth]{$category}) eq 'ARRAY') {
8572: for (my $k=0; $k<@{$cats->[$depth]{$category}}; $k++) {
8573: my $name = $cats->[$depth]{$category}[$k];
8574: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8575: my $trailstr = join(' -> ',(@{$parents},$category));
8576: if ($allitems->{$item} eq '') {
8577: push(@{$trails},$trailstr);
8578: $allitems->{$item} = scalar(@{$trails})-1;
8579: }
8580: my $deeper = $depth+1;
8581: push(@{$parents},$category);
1.665 raeburn 8582: if (ref($subcats) eq 'HASH') {
8583: my $subcat = &escape($name).':'.$category.':'.$depth;
8584: for (my $j=@{$parents}; $j>=0; $j--) {
8585: my $higher;
8586: if ($j > 0) {
8587: $higher = &escape($parents->[$j]).':'.
8588: &escape($parents->[$j-1]).':'.$j;
8589: } else {
8590: $higher = &escape($parents->[$j]).'::'.$j;
8591: }
8592: push(@{$subcats->{$higher}},$subcat);
8593: }
8594: }
8595: &recurse_categories($cats,$deeper,$name,$trails,$allitems,$parents,
8596: $subcats);
1.655 raeburn 8597: pop(@{$parents});
8598: }
8599: } else {
8600: my $item = &escape($category).':'.&escape($parents->[-1]).':'.$shallower;
8601: my $trailstr = join(' -> ',(@{$parents},$category));
8602: if ($allitems->{$item} eq '') {
8603: push(@{$trails},$trailstr);
8604: $allitems->{$item} = scalar(@{$trails})-1;
8605: }
8606: }
8607: return;
8608: }
8609:
1.663 raeburn 8610: =pod
8611:
8612: =item *&assign_categories_table()
8613:
8614: Create a datatable for display of hierarchical categories in a domain,
8615: with checkboxes to allow a course to be categorized.
8616:
8617: Inputs:
8618:
8619: cathash - reference to hash of categories defined for the domain (from
8620: configuration.db)
8621:
8622: currcat - scalar with an & separated list of categories assigned to a course.
8623:
8624: Returns: $output (markup to be displayed)
8625:
8626: =cut
8627:
8628: sub assign_categories_table {
8629: my ($cathash,$currcat) = @_;
8630: my $output;
8631: if (ref($cathash) eq 'HASH') {
8632: my (@cats,@trails,%allitems,%idx,@jsarray,@path,$maxdepth);
8633: &extract_categories($cathash,\@cats,\@trails,\%allitems,\%idx,\@jsarray);
8634: $maxdepth = scalar(@cats);
8635: if (@cats > 0) {
8636: my $itemcount = 0;
8637: if (ref($cats[0]) eq 'ARRAY') {
8638: $output = &Apache::loncommon::start_data_table();
8639: my @currcategories;
8640: if ($currcat ne '') {
8641: @currcategories = split('&',$currcat);
8642: }
8643: for (my $i=0; $i<@{$cats[0]}; $i++) {
8644: my $parent = $cats[0][$i];
8645: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8646: next if ($parent eq 'instcode');
8647: my $item = &escape($parent).'::0';
8648: my $checked = '';
8649: if (@currcategories > 0) {
8650: if (grep(/^\Q$item\E$/,@currcategories)) {
8651: $checked = ' checked="checked" ';
8652: }
8653: }
1.675 raeburn 8654: $output .= '<tr '.$css_class.'><td><span class="LC_nobreak">'.
8655: '<input type="checkbox" name="usecategory" value="'.
8656: $item.'"'.$checked.' />'.$parent.'</span>'.
8657: '<input type="hidden" name="catname" value="'.$parent.'" /></td>';
1.663 raeburn 8658: my $depth = 1;
8659: push(@path,$parent);
8660: $output .= &assign_category_rows($itemcount,\@cats,$depth,$parent,\@path,\@currcategories);
8661: pop(@path);
8662: $output .= '</tr><tr><td colspan="'.$maxdepth.'" class="LC_row_separator"></td></tr>';
8663: $itemcount ++;
8664: }
8665: $output .= &Apache::loncommon::end_data_table();
8666: }
8667: }
8668: }
8669: return $output;
8670: }
8671:
8672: =pod
8673:
8674: =item *&assign_category_rows()
8675:
8676: Create a datatable row for display of nested categories in a domain,
8677: with checkboxes to allow a course to be categorized,called recursively.
8678:
8679: Inputs:
8680:
8681: itemcount - track row number for alternating colors
8682:
8683: cats - reference to array of arrays/hashes which encapsulates hierarchy of
8684: categories and subcategories.
8685:
8686: depth - current depth in hierarchy of categories and sub-categories - 0 indexed.
8687:
8688: parent - parent of current category item
8689:
8690: path - Array containing all categories back up through the hierarchy from the
8691: current category to the top level.
8692:
8693: currcategories - reference to array of current categories assigned to the course
8694:
8695: Returns: $output (markup to be displayed).
8696:
8697: =cut
8698:
8699: sub assign_category_rows {
8700: my ($itemcount,$cats,$depth,$parent,$path,$currcategories) = @_;
8701: my ($text,$name,$item,$chgstr);
8702: if (ref($cats) eq 'ARRAY') {
8703: my $maxdepth = scalar(@{$cats});
8704: if (ref($cats->[$depth]) eq 'HASH') {
8705: if (ref($cats->[$depth]{$parent}) eq 'ARRAY') {
8706: my $numchildren = @{$cats->[$depth]{$parent}};
8707: my $css_class = $itemcount%2?' class="LC_odd_row"':'';
8708: $text .= '<td><table class="LC_datatable">';
8709: for (my $j=0; $j<$numchildren; $j++) {
8710: $name = $cats->[$depth]{$parent}[$j];
8711: $item = &escape($name).':'.&escape($parent).':'.$depth;
8712: my $deeper = $depth+1;
8713: my $checked = '';
8714: if (ref($currcategories) eq 'ARRAY') {
8715: if (@{$currcategories} > 0) {
8716: if (grep(/^\Q$item\E$/,@{$currcategories})) {
8717: $checked = ' checked="checked" ';
8718: }
8719: }
8720: }
1.664 raeburn 8721: $text .= '<tr><td><span class="LC_nobreak"><label>'.
8722: '<input type="checkbox" name="usecategory" value="'.
1.675 raeburn 8723: $item.'"'.$checked.' />'.$name.'</label></span>'.
8724: '<input type="hidden" name="catname" value="'.$name.'" />'.
8725: '</td><td>';
1.663 raeburn 8726: if (ref($path) eq 'ARRAY') {
8727: push(@{$path},$name);
8728: $text .= &assign_category_rows($itemcount,$cats,$deeper,$name,$path,$currcategories);
8729: pop(@{$path});
8730: }
8731: $text .= '</td></tr>';
8732: }
8733: $text .= '</table></td>';
8734: }
8735: }
8736: }
8737: return $text;
8738: }
8739:
1.655 raeburn 8740: ############################################################
8741: ############################################################
8742:
8743:
1.443 albertel 8744: sub commit_customrole {
1.664 raeburn 8745: my ($udom,$uname,$url,$three,$four,$five,$start,$end,$context) = @_;
1.630 raeburn 8746: my $output = &mt('Assigning custom role').' "'.$five.'" by '.$four.':'.$three.' in '.$url.
1.443 albertel 8747: ($start?', '.&mt('starting').' '.localtime($start):'').
8748: ($end?', ending '.localtime($end):'').': <b>'.
8749: &Apache::lonnet::assigncustomrole(
1.664 raeburn 8750: $udom,$uname,$url,$three,$four,$five,$end,$start,undef,undef,$context).
1.443 albertel 8751: '</b><br />';
8752: return $output;
8753: }
8754:
8755: sub commit_standardrole {
1.541 raeburn 8756: my ($udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
8757: my ($output,$logmsg,$linefeed);
8758: if ($context eq 'auto') {
8759: $linefeed = "\n";
8760: } else {
8761: $linefeed = "<br />\n";
8762: }
1.443 albertel 8763: if ($three eq 'st') {
1.541 raeburn 8764: my $result = &commit_studentrole(\$logmsg,$udom,$uname,$url,$three,$start,$end,
8765: $one,$two,$sec,$context);
8766: if (($result =~ /^error/) || ($result eq 'not_in_class') ||
1.626 raeburn 8767: ($result eq 'unknown_course') || ($result eq 'refused')) {
8768: $output = $logmsg.' '.&mt('Error: ').$result."\n";
1.443 albertel 8769: } else {
1.541 raeburn 8770: $output = $logmsg.$linefeed.&mt('Assigning').' '.$three.' in '.$url.
1.443 albertel 8771: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 8772: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
8773: if ($context eq 'auto') {
8774: $output .= $result.$linefeed.&mt('Add to classlist').': ok';
8775: } else {
8776: $output .= '<b>'.$result.'</b>'.$linefeed.
8777: &mt('Add to classlist').': <b>ok</b>';
8778: }
8779: $output .= $linefeed;
1.443 albertel 8780: }
8781: } else {
8782: $output = &mt('Assigning').' '.$three.' in '.$url.
8783: ($start?', '.&mt('starting').' '.localtime($start):'').
1.541 raeburn 8784: ($end?', '.&mt('ending').' '.localtime($end):'').': ';
1.652 raeburn 8785: my $result = &Apache::lonnet::assignrole($udom,$uname,$url,$three,$end,$start,'','',$context);
1.541 raeburn 8786: if ($context eq 'auto') {
8787: $output .= $result.$linefeed;
8788: } else {
8789: $output .= '<b>'.$result.'</b>'.$linefeed;
8790: }
1.443 albertel 8791: }
8792: return $output;
8793: }
8794:
8795: sub commit_studentrole {
1.541 raeburn 8796: my ($logmsg,$udom,$uname,$url,$three,$start,$end,$one,$two,$sec,$context) = @_;
1.626 raeburn 8797: my ($result,$linefeed,$oldsecurl,$newsecurl);
1.541 raeburn 8798: if ($context eq 'auto') {
8799: $linefeed = "\n";
8800: } else {
8801: $linefeed = '<br />'."\n";
8802: }
1.443 albertel 8803: if (defined($one) && defined($two)) {
8804: my $cid=$one.'_'.$two;
8805: my $oldsec=&Apache::lonnet::getsection($udom,$uname,$cid);
8806: my $secchange = 0;
8807: my $expire_role_result;
8808: my $modify_section_result;
1.628 raeburn 8809: if ($oldsec ne '-1') {
8810: if ($oldsec ne $sec) {
1.443 albertel 8811: $secchange = 1;
1.628 raeburn 8812: my $now = time;
1.443 albertel 8813: my $uurl='/'.$cid;
8814: $uurl=~s/\_/\//g;
8815: if ($oldsec) {
8816: $uurl.='/'.$oldsec;
8817: }
1.626 raeburn 8818: $oldsecurl = $uurl;
1.628 raeburn 8819: $expire_role_result =
1.652 raeburn 8820: &Apache::lonnet::assignrole($udom,$uname,$uurl,'st',$now,'','',$context);
1.628 raeburn 8821: if ($env{'request.course.sec'} ne '') {
8822: if ($expire_role_result eq 'refused') {
8823: my @roles = ('st');
8824: my @statuses = ('previous');
8825: my @roledoms = ($one);
8826: my $withsec = 1;
8827: my %roleshash =
8828: &Apache::lonnet::get_my_roles($uname,$udom,'userroles',
8829: \@statuses,\@roles,\@roledoms,$withsec);
8830: if (defined ($roleshash{$two.':'.$one.':st:'.$oldsec})) {
8831: my ($oldstart,$oldend) =
8832: split(':',$roleshash{$two.':'.$one.':st:'.$oldsec});
8833: if ($oldend > 0 && $oldend <= $now) {
8834: $expire_role_result = 'ok';
8835: }
8836: }
8837: }
8838: }
1.443 albertel 8839: $result = $expire_role_result;
8840: }
8841: }
8842: if (($expire_role_result eq 'ok') || ($secchange == 0)) {
1.652 raeburn 8843: $modify_section_result = &Apache::lonnet::modify_student_enrollment($udom,$uname,undef,undef,undef,undef,undef,$sec,$end,$start,'','',$cid,'',$context);
1.443 albertel 8844: if ($modify_section_result =~ /^ok/) {
8845: if ($secchange == 1) {
1.628 raeburn 8846: if ($sec eq '') {
8847: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to student role without a section.',$uname,$oldsec).$linefeed;
8848: } else {
8849: $$logmsg .= &mt('Section for [_1] switched from (possibly expired) old section: [_2] to new section: [_3].',$uname,$oldsec,$sec).$linefeed;
8850: }
1.443 albertel 8851: } elsif ($oldsec eq '-1') {
1.628 raeburn 8852: if ($sec eq '') {
8853: $$logmsg .= &mt('New student role without a section for [_1] in course [_2].',$uname,$cid).$linefeed;
8854: } else {
8855: $$logmsg .= &mt('New student role for [_1] in section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
8856: }
1.443 albertel 8857: } else {
1.628 raeburn 8858: if ($sec eq '') {
8859: $$logmsg .= &mt('Student [_1] assigned to course [_2] without a section.',$uname,$cid).$linefeed;
8860: } else {
8861: $$logmsg .= &mt('Student [_1] assigned to section [_2] in course [_3].',$uname,$sec,$cid).$linefeed;
8862: }
1.443 albertel 8863: }
8864: } else {
1.628 raeburn 8865: if ($secchange) {
8866: $$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;
8867: } else {
8868: $$logmsg .= &mt('Error when attempting to modify role for [_1] for section: "[_2]" in course [_3] -error:',$uname,$sec,$cid).' '.$modify_section_result.$linefeed;
8869: }
1.443 albertel 8870: }
8871: $result = $modify_section_result;
8872: } elsif ($secchange == 1) {
1.628 raeburn 8873: if ($oldsec eq '') {
8874: $$logmsg .= &mt('Error when attempting to expire existing role without a section for [_1] in course [_3] -error: ',$uname,$cid).' '.$expire_role_result.$linefeed;
8875: } else {
8876: $$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;
8877: }
1.626 raeburn 8878: if ($expire_role_result eq 'refused') {
8879: my $newsecurl = '/'.$cid;
8880: $newsecurl =~ s/\_/\//g;
8881: if ($sec ne '') {
8882: $newsecurl.='/'.$sec;
8883: }
8884: if (&Apache::lonnet::allowed('cst',$newsecurl) && !(&Apache::lonnet::allowed('cst',$oldsecurl))) {
8885: if ($sec eq '') {
8886: $$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;
8887: } else {
8888: $$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;
8889: }
8890: }
8891: }
1.443 albertel 8892: }
8893: } else {
1.626 raeburn 8894: $$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 8895: $result = "error: incomplete course id\n";
8896: }
8897: return $result;
8898: }
8899:
8900: ############################################################
8901: ############################################################
8902:
1.566 albertel 8903: sub check_clone {
1.578 raeburn 8904: my ($args,$linefeed) = @_;
1.566 albertel 8905: my $cloneid='/'.$args->{'clonedomain'}.'/'.$args->{'clonecourse'};
8906: my ($clonecrsudom,$clonecrsunum)= &LONCAPA::split_courseid($cloneid);
8907: my $clonehome=&Apache::lonnet::homeserver($clonecrsunum,$clonecrsudom);
8908: my $clonemsg;
8909: my $can_clone = 0;
8910:
8911: if ($clonehome eq 'no_host') {
1.578 raeburn 8912: $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 8913: } else {
8914: my %clonedesc = &Apache::lonnet::coursedescription($cloneid,{'one_time' => 1});
1.568 albertel 8915: if ($env{'request.role.domain'} eq $args->{'clonedomain'}) {
1.566 albertel 8916: $can_clone = 1;
8917: } else {
8918: my %clonehash = &Apache::lonnet::get('environment',['cloners'],
8919: $args->{'clonedomain'},$args->{'clonecourse'});
8920: my @cloners = split(/,/,$clonehash{'cloners'});
1.578 raeburn 8921: if (grep(/^\*$/,@cloners)) {
8922: $can_clone = 1;
8923: } elsif (grep(/^\*\:\Q$args->{'ccdomain'}\E$/,@cloners)) {
8924: $can_clone = 1;
8925: } else {
8926: my %roleshash =
8927: &Apache::lonnet::get_my_roles($args->{'ccuname'},
8928: $args->{'ccdomain'},
8929: 'userroles',['active'],['cc'],
8930: [$args->{'clonedomain'}]);
8931: if (($roleshash{$args->{'clonecourse'}.':'.$args->{'clonedomain'}.':cc'}) || (grep(/^\Q$args->{'ccuname'}\E:\Q$args->{'ccdomain'}\E$/,@cloners))) {
8932: $can_clone = 1;
8933: } else {
8934: $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'});
8935: }
1.566 albertel 8936: }
1.578 raeburn 8937: }
1.566 albertel 8938: }
8939: return ($can_clone, $clonemsg, $cloneid, $clonehome);
8940: }
8941:
1.444 albertel 8942: sub construct_course {
1.541 raeburn 8943: my ($args,$logmsg,$courseid,$crsudom,$crsunum,$udom,$uname,$context) = @_;
1.444 albertel 8944: my $outcome;
1.541 raeburn 8945: my $linefeed = '<br />'."\n";
8946: if ($context eq 'auto') {
8947: $linefeed = "\n";
8948: }
1.566 albertel 8949:
8950: #
8951: # Are we cloning?
8952: #
8953: my ($can_clone, $clonemsg, $cloneid, $clonehome);
8954: if (($args->{'clonecourse'}) && ($args->{'clonedomain'})) {
1.578 raeburn 8955: ($can_clone, $clonemsg, $cloneid, $clonehome) = &check_clone($args,$linefeed);
1.566 albertel 8956: if ($context ne 'auto') {
1.578 raeburn 8957: if ($clonemsg ne '') {
8958: $clonemsg = '<span class="LC_error">'.$clonemsg.'</span>';
8959: }
1.566 albertel 8960: }
8961: $outcome .= $clonemsg.$linefeed;
8962:
8963: if (!$can_clone) {
8964: return (0,$outcome);
8965: }
8966: }
8967:
1.444 albertel 8968: #
8969: # Open course
8970: #
8971: my $crstype = lc($args->{'crstype'});
8972: my %cenv=();
8973: $$courseid=&Apache::lonnet::createcourse($args->{'course_domain'},
8974: $args->{'cdescr'},
8975: $args->{'curl'},
8976: $args->{'course_home'},
8977: $args->{'nonstandard'},
8978: $args->{'crscode'},
8979: $args->{'ccuname'}.':'.
8980: $args->{'ccdomain'},
8981: $args->{'crstype'});
8982:
8983: # Note: The testing routines depend on this being output; see
8984: # Utils::Course. This needs to at least be output as a comment
8985: # if anyone ever decides to not show this, and Utils::Course::new
8986: # will need to be suitably modified.
1.541 raeburn 8987: $outcome .= &mt('New LON-CAPA [_1] ID: [_2]',$crstype,$$courseid).$linefeed;
1.444 albertel 8988: #
8989: # Check if created correctly
8990: #
1.479 albertel 8991: ($$crsudom,$$crsunum)= &LONCAPA::split_courseid($$courseid);
1.444 albertel 8992: my $crsuhome=&Apache::lonnet::homeserver($$crsunum,$$crsudom);
1.541 raeburn 8993: $outcome .= &mt('Created on').': '.$crsuhome.$linefeed;
1.566 albertel 8994:
1.444 albertel 8995: #
1.566 albertel 8996: # Do the cloning
8997: #
8998: if ($can_clone && $cloneid) {
8999: $clonemsg = &mt('Cloning [_1] from [_2]',$crstype,$clonehome);
9000: if ($context ne 'auto') {
9001: $clonemsg = '<span class="LC_success">'.$clonemsg.'</span>';
9002: }
9003: $outcome .= $clonemsg.$linefeed;
9004: my %oldcenv=&Apache::lonnet::dump('environment',$$crsudom,$$crsunum);
1.444 albertel 9005: # Copy all files
1.637 www 9006: &Apache::lonclonecourse::copycoursefiles($cloneid,$$courseid,$args->{'datemode'},$args->{'dateshift'});
1.444 albertel 9007: # Restore URL
1.566 albertel 9008: $cenv{'url'}=$oldcenv{'url'};
1.444 albertel 9009: # Restore title
1.566 albertel 9010: $cenv{'description'}=$oldcenv{'description'};
1.444 albertel 9011: # Mark as cloned
1.566 albertel 9012: $cenv{'clonedfrom'}=$cloneid;
1.638 www 9013: # Need to clone grading mode
9014: my %newenv=&Apache::lonnet::get('environment',['grading'],$$crsudom,$$crsunum);
9015: $cenv{'grading'}=$newenv{'grading'};
9016: # Do not clone these environment entries
9017: &Apache::lonnet::del('environment',
9018: ['default_enrollment_start_date',
9019: 'default_enrollment_end_date',
9020: 'question.email',
9021: 'policy.email',
9022: 'comment.email',
9023: 'pch.users.denied',
9024: 'plc.users.denied'],
9025: $$crsudom,$$crsunum);
1.444 albertel 9026: }
1.566 albertel 9027:
1.444 albertel 9028: #
9029: # Set environment (will override cloned, if existing)
9030: #
9031: my @sections = ();
9032: my @xlists = ();
9033: if ($args->{'crstype'}) {
9034: $cenv{'type'}=$args->{'crstype'};
9035: }
9036: if ($args->{'crsid'}) {
9037: $cenv{'courseid'}=$args->{'crsid'};
9038: }
9039: if ($args->{'crscode'}) {
9040: $cenv{'internal.coursecode'}=$args->{'crscode'};
9041: }
9042: if ($args->{'crsquota'} ne '') {
9043: $cenv{'internal.coursequota'}=$args->{'crsquota'};
9044: } else {
9045: $cenv{'internal.coursequota'}=$args->{'crsquota'} = 20;
9046: }
9047: if ($args->{'ccuname'}) {
9048: $cenv{'internal.courseowner'} = $args->{'ccuname'}.
9049: ':'.$args->{'ccdomain'};
9050: } else {
9051: $cenv{'internal.courseowner'} = $args->{'curruser'};
9052: }
9053: my @badclasses = (); # Used to accumulate sections/crosslistings that did not pass classlist access check for course owner.
9054: if ($args->{'crssections'}) {
9055: $cenv{'internal.sectionnums'} = '';
9056: if ($args->{'crssections'} =~ m/,/) {
9057: @sections = split/,/,$args->{'crssections'};
9058: } else {
9059: $sections[0] = $args->{'crssections'};
9060: }
9061: if (@sections > 0) {
9062: foreach my $item (@sections) {
9063: my ($sec,$gp) = split/:/,$item;
9064: my $class = $args->{'crscode'}.$sec;
9065: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$class,$cenv{'internal.courseowner'});
9066: $cenv{'internal.sectionnums'} .= $item.',';
9067: unless ($addcheck eq 'ok') {
9068: push @badclasses, $class;
9069: }
9070: }
9071: $cenv{'internal.sectionnums'} =~ s/,$//;
9072: }
9073: }
9074: # do not hide course coordinator from staff listing,
9075: # even if privileged
9076: $cenv{'nothideprivileged'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9077: # add crosslistings
9078: if ($args->{'crsxlist'}) {
9079: $cenv{'internal.crosslistings'}='';
9080: if ($args->{'crsxlist'} =~ m/,/) {
9081: @xlists = split/,/,$args->{'crsxlist'};
9082: } else {
9083: $xlists[0] = $args->{'crsxlist'};
9084: }
9085: if (@xlists > 0) {
9086: foreach my $item (@xlists) {
9087: my ($xl,$gp) = split/:/,$item;
9088: my $addcheck = &Apache::lonnet::auto_new_course($$crsunum,$$crsudom,$xl,$cenv{'internal.courseowner'});
9089: $cenv{'internal.crosslistings'} .= $item.',';
9090: unless ($addcheck eq 'ok') {
9091: push @badclasses, $xl;
9092: }
9093: }
9094: $cenv{'internal.crosslistings'} =~ s/,$//;
9095: }
9096: }
9097: if ($args->{'autoadds'}) {
9098: $cenv{'internal.autoadds'}=$args->{'autoadds'};
9099: }
9100: if ($args->{'autodrops'}) {
9101: $cenv{'internal.autodrops'}=$args->{'autodrops'};
9102: }
9103: # check for notification of enrollment changes
9104: my @notified = ();
9105: if ($args->{'notify_owner'}) {
9106: if ($args->{'ccuname'} ne '') {
9107: push(@notified,$args->{'ccuname'}.':'.$args->{'ccdomain'});
9108: }
9109: }
9110: if ($args->{'notify_dc'}) {
9111: if ($uname ne '') {
1.630 raeburn 9112: push(@notified,$uname.':'.$udom);
1.444 albertel 9113: }
9114: }
9115: if (@notified > 0) {
9116: my $notifylist;
9117: if (@notified > 1) {
9118: $notifylist = join(',',@notified);
9119: } else {
9120: $notifylist = $notified[0];
9121: }
9122: $cenv{'internal.notifylist'} = $notifylist;
9123: }
9124: if (@badclasses > 0) {
9125: my %lt=&Apache::lonlocal::texthash(
9126: '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',
9127: 'dnhr' => 'does not have rights to access enrollment in these classes',
9128: 'adby' => 'as determined by the policies of your institution on access to official classlists'
9129: );
1.541 raeburn 9130: my $badclass_msg = $cenv{'internal.courseowner'}.') - '.$lt{'dnhr'}.
9131: ' ('.$lt{'adby'}.')';
9132: if ($context eq 'auto') {
9133: $outcome .= $badclass_msg.$linefeed;
1.566 albertel 9134: $outcome .= '<div class="LC_warning">'.$badclass_msg.$linefeed.'<ul>'."\n";
1.541 raeburn 9135: foreach my $item (@badclasses) {
9136: if ($context eq 'auto') {
9137: $outcome .= " - $item\n";
9138: } else {
9139: $outcome .= "<li>$item</li>\n";
9140: }
9141: }
9142: if ($context eq 'auto') {
9143: $outcome .= $linefeed;
9144: } else {
1.566 albertel 9145: $outcome .= "</ul><br /><br /></div>\n";
1.541 raeburn 9146: }
9147: }
1.444 albertel 9148: }
9149: if ($args->{'no_end_date'}) {
9150: $args->{'endaccess'} = 0;
9151: }
9152: $cenv{'internal.autostart'}=$args->{'enrollstart'};
9153: $cenv{'internal.autoend'}=$args->{'enrollend'};
9154: $cenv{'default_enrollment_start_date'}=$args->{'startaccess'};
9155: $cenv{'default_enrollment_end_date'}=$args->{'endaccess'};
9156: if ($args->{'showphotos'}) {
9157: $cenv{'internal.showphotos'}=$args->{'showphotos'};
9158: }
9159: $cenv{'internal.authtype'} = $args->{'authtype'};
9160: $cenv{'internal.autharg'} = $args->{'autharg'};
9161: if ( ($cenv{'internal.authtype'} =~ /^krb/) && ($cenv{'internal.autoadds'} == 1)) {
9162: if (! defined($cenv{'internal.autharg'}) || $cenv{'internal.autharg'} eq '') {
1.541 raeburn 9163: 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');
9164: if ($context eq 'auto') {
9165: $outcome .= $krb_msg;
9166: } else {
1.566 albertel 9167: $outcome .= '<span class="LC_error">'.$krb_msg.'</span>';
1.541 raeburn 9168: }
9169: $outcome .= $linefeed;
1.444 albertel 9170: }
9171: }
9172: if (($args->{'ccdomain'}) && ($args->{'ccuname'})) {
9173: if ($args->{'setpolicy'}) {
9174: $cenv{'policy.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9175: }
9176: if ($args->{'setcontent'}) {
9177: $cenv{'question.email'}=$args->{'ccuname'}.':'.$args->{'ccdomain'};
9178: }
9179: }
9180: if ($args->{'reshome'}) {
9181: $cenv{'reshome'}=$args->{'reshome'}.'/';
9182: $cenv{'reshome'}=~s/\/+$/\//;
9183: }
9184: #
9185: # course has keyed access
9186: #
9187: if ($args->{'setkeys'}) {
9188: $cenv{'keyaccess'}='yes';
9189: }
9190: # if specified, key authority is not course, but user
9191: # only active if keyaccess is yes
9192: if ($args->{'keyauth'}) {
1.487 albertel 9193: my ($user,$domain) = split(':',$args->{'keyauth'});
9194: $user = &LONCAPA::clean_username($user);
9195: $domain = &LONCAPA::clean_username($domain);
1.488 foxr 9196: if ($user ne '' && $domain ne '') {
1.487 albertel 9197: $cenv{'keyauth'}=$user.':'.$domain;
1.444 albertel 9198: }
9199: }
9200:
9201: if ($args->{'disresdis'}) {
9202: $cenv{'pch.roles.denied'}='st';
9203: }
9204: if ($args->{'disablechat'}) {
9205: $cenv{'plc.roles.denied'}='st';
9206: }
9207:
9208: # Record we've not yet viewed the Course Initialization Helper for this
9209: # course
9210: $cenv{'course.helper.not.run'} = 1;
9211: #
9212: # Use new Randomseed
9213: #
9214: $cenv{'rndseed'}=&Apache::lonnet::latest_rnd_algorithm_id();;
9215: $cenv{'receiptalg'}=&Apache::lonnet::latest_receipt_algorithm_id();;
9216: #
9217: # The encryption code and receipt prefix for this course
9218: #
9219: $cenv{'internal.encseed'}=$Apache::lonnet::perlvar{'lonReceipt'}.$$.time.int(rand(9999));
9220: $cenv{'internal.encpref'}=100+int(9*rand(99));
9221: #
9222: # By default, use standard grading
9223: if (!defined($cenv{'grading'})) { $cenv{'grading'} = 'standard'; }
9224:
1.541 raeburn 9225: $outcome .= $linefeed.&mt('Setting environment').': '.
9226: &Apache::lonnet::put('environment',\%cenv,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9227: #
9228: # Open all assignments
9229: #
9230: if ($args->{'openall'}) {
9231: my $storeunder=$$crsudom.'_'.$$crsunum.'.0.opendate';
9232: my %storecontent = ($storeunder => time,
9233: $storeunder.'.type' => 'date_start');
9234:
9235: $outcome .= &mt('Opening all assignments').': '.&Apache::lonnet::cput
1.541 raeburn 9236: ('resourcedata',\%storecontent,$$crsudom,$$crsunum).$linefeed;
1.444 albertel 9237: }
9238: #
9239: # Set first page
9240: #
9241: unless (($args->{'nonstandard'}) || ($args->{'firstres'} eq 'blank')
9242: || ($cloneid)) {
1.445 albertel 9243: use LONCAPA::map;
1.444 albertel 9244: $outcome .= &mt('Setting first resource').': ';
1.445 albertel 9245:
9246: my $map = '/uploaded/'.$$crsudom.'/'.$$crsunum.'/default.sequence';
9247: my ($errtext,$fatal)=&LONCAPA::map::mapread($map);
9248:
1.444 albertel 9249: $outcome .= ($fatal?$errtext:'read ok').' - ';
9250: my $title; my $url;
9251: if ($args->{'firstres'} eq 'syl') {
1.690 bisitz 9252: $title=&mt('Syllabus');
1.444 albertel 9253: $url='/public/'.$$crsudom.'/'.$$crsunum.'/syllabus';
9254: } else {
1.690 bisitz 9255: $title=&mt('Navigate Contents');
1.444 albertel 9256: $url='/adm/navmaps';
9257: }
1.445 albertel 9258:
9259: $LONCAPA::map::resources[1]=$title.':'.$url.':false:start:res';
9260: (my $outtext,$errtext) = &LONCAPA::map::storemap($map,1);
9261:
9262: if ($errtext) { $fatal=2; }
1.541 raeburn 9263: $outcome .= ($fatal?$errtext:'write ok').$linefeed;
1.444 albertel 9264: }
1.566 albertel 9265:
9266: return (1,$outcome);
1.444 albertel 9267: }
9268:
9269: ############################################################
9270: ############################################################
9271:
1.378 raeburn 9272: sub course_type {
9273: my ($cid) = @_;
9274: if (!defined($cid)) {
9275: $cid = $env{'request.course.id'};
9276: }
1.404 albertel 9277: if (defined($env{'course.'.$cid.'.type'})) {
9278: return $env{'course.'.$cid.'.type'};
1.378 raeburn 9279: } else {
9280: return 'Course';
1.377 raeburn 9281: }
9282: }
1.156 albertel 9283:
1.406 raeburn 9284: sub group_term {
9285: my $crstype = &course_type();
9286: my %names = (
9287: 'Course' => 'group',
9288: 'Group' => 'team',
9289: );
9290: return $names{$crstype};
9291: }
9292:
1.156 albertel 9293: sub icon {
9294: my ($file)=@_;
1.505 albertel 9295: my $curfext = lc((split(/\./,$file))[-1]);
1.168 albertel 9296: my $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/unknown.gif';
1.156 albertel 9297: my $embstyle = &Apache::loncommon::fileembstyle($curfext);
1.168 albertel 9298: if (!(!defined($embstyle) || $embstyle eq 'unk' || $embstyle eq 'hdn')) {
9299: if (-e $Apache::lonnet::perlvar{'lonDocRoot'}.'/'.
9300: $Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9301: $curfext.".gif") {
9302: $iconname=$Apache::lonnet::perlvar{'lonIconsURL'}.'/'.
9303: $curfext.".gif";
9304: }
9305: }
1.249 albertel 9306: return &lonhttpdurl($iconname);
1.154 albertel 9307: }
1.84 albertel 9308:
1.575 albertel 9309: sub lonhttpdurl {
1.692 www 9310: #
9311: # Had been used for "small fry" static images on separate port 8080.
9312: # Modify here if lightweight http functionality desired again.
9313: # Currently eliminated due to increasing firewall issues.
9314: #
1.575 albertel 9315: my ($url)=@_;
1.692 www 9316: return $url;
1.215 albertel 9317: }
9318:
1.213 albertel 9319: sub connection_aborted {
9320: my ($r)=@_;
9321: $r->print(" ");$r->rflush();
9322: my $c = $r->connection;
9323: return $c->aborted();
9324: }
9325:
1.221 foxr 9326: # Escapes strings that may have embedded 's that will be put into
1.222 foxr 9327: # strings as 'strings'.
9328: sub escape_single {
1.221 foxr 9329: my ($input) = @_;
1.223 albertel 9330: $input =~ s/\\/\\\\/g; # Escape the \'s..(must be first)>
1.221 foxr 9331: $input =~ s/\'/\\\'/g; # Esacpe the 's....
9332: return $input;
9333: }
1.223 albertel 9334:
1.222 foxr 9335: # Same as escape_single, but escape's "'s This
9336: # can be used for "strings"
9337: sub escape_double {
9338: my ($input) = @_;
9339: $input =~ s/\\/\\\\/g; # Escape the /'s..(must be first)>
9340: $input =~ s/\"/\\\"/g; # Esacpe the "s....
9341: return $input;
9342: }
1.223 albertel 9343:
1.222 foxr 9344: # Escapes the last element of a full URL.
9345: sub escape_url {
9346: my ($url) = @_;
1.238 raeburn 9347: my @urlslices = split(/\//, $url,-1);
1.369 www 9348: my $lastitem = &escape(pop(@urlslices));
1.223 albertel 9349: return join('/',@urlslices).'/'.$lastitem;
1.222 foxr 9350: }
1.462 albertel 9351:
9352: # -------------------------------------------------------- Initliaze user login
9353: sub init_user_environment {
1.463 albertel 9354: my ($r, $username, $domain, $authhost, $form, $args) = @_;
1.462 albertel 9355: my $lonids=$Apache::lonnet::perlvar{'lonIDsDir'};
9356:
9357: my $public=($username eq 'public' && $domain eq 'public');
9358:
9359: # See if old ID present, if so, remove
9360:
9361: my ($filename,$cookie,$userroles);
9362: my $now=time;
9363:
9364: if ($public) {
9365: my $max_public=100;
9366: my $oldest;
9367: my $oldest_time=0;
9368: for(my $next=1;$next<=$max_public;$next++) {
9369: if (-e $lonids."/publicuser_$next.id") {
9370: my $mtime=(stat($lonids."/publicuser_$next.id"))[9];
9371: if ($mtime<$oldest_time || !$oldest_time) {
9372: $oldest_time=$mtime;
9373: $oldest=$next;
9374: }
9375: } else {
9376: $cookie="publicuser_$next";
9377: last;
9378: }
9379: }
9380: if (!$cookie) { $cookie="publicuser_$oldest"; }
9381: } else {
1.463 albertel 9382: # if this isn't a robot, kill any existing non-robot sessions
9383: if (!$args->{'robot'}) {
9384: opendir(DIR,$lonids);
9385: while ($filename=readdir(DIR)) {
9386: if ($filename=~/^$username\_\d+\_$domain\_$authhost\.id$/) {
9387: unlink($lonids.'/'.$filename);
9388: }
1.462 albertel 9389: }
1.463 albertel 9390: closedir(DIR);
1.462 albertel 9391: }
9392: # Give them a new cookie
1.463 albertel 9393: my $id = ($args->{'robot'} ? 'robot'.$args->{'robot'}
1.684 www 9394: : $now.$$.int(rand(10000)));
1.463 albertel 9395: $cookie="$username\_$id\_$domain\_$authhost";
1.462 albertel 9396:
9397: # Initialize roles
9398:
9399: $userroles=&Apache::lonnet::rolesinit($domain,$username,$authhost);
9400: }
9401: # ------------------------------------ Check browser type and MathML capability
9402:
9403: my ($httpbrowser,$clientbrowser,$clientversion,$clientmathml,
9404: $clientunicode,$clientos) = &decode_user_agent($r);
9405:
9406: # -------------------------------------- Any accessibility options to remember?
9407: if (($form->{'interface'}) && ($form->{'remember'} eq 'true')) {
9408: foreach my $option ('imagesuppress','appletsuppress',
9409: 'embedsuppress','fontenhance','blackwhite') {
9410: if ($form->{$option} eq 'true') {
9411: &Apache::lonnet::put('environment',{$option => 'on'},
9412: $domain,$username);
9413: } else {
9414: &Apache::lonnet::del('environment',[$option],
9415: $domain,$username);
9416: }
9417: }
9418: }
9419: # ------------------------------------------------------------- Get environment
9420:
9421: my %userenv = &Apache::lonnet::dump('environment',$domain,$username);
9422: my ($tmp) = keys(%userenv);
9423: if ($tmp !~ /^(con_lost|error|no_such_host)/i) {
9424: # default remote control to off
9425: if ($userenv{'remote'} ne 'on') { $userenv{'remote'} = 'off'; }
9426: } else {
9427: undef(%userenv);
9428: }
9429: if (($userenv{'interface'}) && (!$form->{'interface'})) {
9430: $form->{'interface'}=$userenv{'interface'};
9431: }
9432: $env{'environment.remote'}=$userenv{'remote'};
9433: if ($userenv{'texengine'} eq 'ttm') { $clientmathml=1; }
9434:
9435: # --------------- Do not trust query string to be put directly into environment
9436: foreach my $option ('imagesuppress','appletsuppress',
9437: 'embedsuppress','fontenhance','blackwhite',
9438: 'interface','localpath','localres') {
9439: $form->{$option}=~s/[\n\r\=]//gs;
9440: }
9441: # --------------------------------------------------------- Write first profile
9442:
9443: {
9444: my %initial_env =
9445: ("user.name" => $username,
9446: "user.domain" => $domain,
9447: "user.home" => $authhost,
9448: "browser.type" => $clientbrowser,
9449: "browser.version" => $clientversion,
9450: "browser.mathml" => $clientmathml,
9451: "browser.unicode" => $clientunicode,
9452: "browser.os" => $clientos,
9453: "server.domain" => $Apache::lonnet::perlvar{'lonDefDomain'},
9454: "request.course.fn" => '',
9455: "request.course.uri" => '',
9456: "request.course.sec" => '',
9457: "request.role" => 'cm',
9458: "request.role.adv" => $env{'user.adv'},
9459: "request.host" => $ENV{'REMOTE_ADDR'},);
9460:
9461: if ($form->{'localpath'}) {
9462: $initial_env{"browser.localpath"} = $form->{'localpath'};
9463: $initial_env{"browser.localres"} = $form->{'localres'};
9464: }
9465:
9466: if ($public) {
9467: $initial_env{"environment.remote"} = "off";
9468: }
9469: if ($form->{'interface'}) {
9470: $form->{'interface'}=~s/\W//gs;
9471: $initial_env{"browser.interface"} = $form->{'interface'};
9472: $env{'browser.interface'}=$form->{'interface'};
9473: foreach my $option ('imagesuppress','appletsuppress',
9474: 'embedsuppress','fontenhance','blackwhite') {
9475: if (($form->{$option} eq 'true') ||
9476: ($userenv{$option} eq 'on')) {
9477: $initial_env{"browser.$option"} = "on";
9478: }
9479: }
9480: }
9481:
9482: $env{'user.environment'} = "$lonids/$cookie.id";
9483:
9484: if (tie(my %disk_env,'GDBM_File',"$lonids/$cookie.id",
9485: &GDBM_WRCREAT(),0640)) {
9486: &_add_to_env(\%disk_env,\%initial_env);
9487: &_add_to_env(\%disk_env,\%userenv,'environment.');
9488: &_add_to_env(\%disk_env,$userroles);
1.463 albertel 9489: if (ref($args->{'extra_env'})) {
9490: &_add_to_env(\%disk_env,$args->{'extra_env'});
9491: }
1.462 albertel 9492: untie(%disk_env);
9493: } else {
9494: &Apache::lonnet::logthis("<font color=\"blue\">WARNING: ".
9495: 'Could not create environment storage in lonauth: '.$!.'</font>');
9496: return 'error: '.$!;
9497: }
9498: }
9499: $env{'request.role'}='cm';
9500: $env{'request.role.adv'}=$env{'user.adv'};
9501: $env{'browser.type'}=$clientbrowser;
9502:
9503: return $cookie;
9504:
9505: }
9506:
9507: sub _add_to_env {
9508: my ($idf,$env_data,$prefix) = @_;
1.676 raeburn 9509: if (ref($env_data) eq 'HASH') {
9510: while (my ($key,$value) = each(%$env_data)) {
9511: $idf->{$prefix.$key} = $value;
9512: $env{$prefix.$key} = $value;
9513: }
1.462 albertel 9514: }
9515: }
9516:
1.685 tempelho 9517: # --- Get the symbolic name of a problem and the url
9518: sub get_symb {
9519: my ($request,$silent) = @_;
9520: (my $url=$env{'form.url'}) =~ s-^http://($ENV{'SERVER_NAME'}|$ENV{'HTTP_HOST'})--;
9521: my $symb=($env{'form.symb'} ne '' ? $env{'form.symb'} : (&Apache::lonnet::symbread($url)));
9522: if ($symb eq '') {
9523: if (!$silent) {
9524: $request->print("Unable to handle ambiguous references:$url:.");
9525: return ();
9526: }
9527: }
9528: &Apache::lonenc::check_decrypt(\$symb);
9529: return ($symb);
9530: }
9531:
9532: # --------------------------------------------------------------Get annotation
9533:
9534: sub get_annotation {
9535: my ($symb,$enc) = @_;
9536:
9537: my $key = $symb;
9538: if (!$enc) {
9539: $key =
9540: &Apache::lonnet::clutter((&Apache::lonnet::decode_symb($symb))[2]);
9541: }
9542: my %annotation=&Apache::lonnet::get('nohist_annotations',[$key]);
9543: return $annotation{$key};
9544: }
9545:
9546: sub clean_symb {
9547: my ($symb) = @_;
9548:
9549: &Apache::lonenc::check_decrypt(\$symb);
9550: my $enc = $env{'request.enc'};
9551: delete($env{'request.enc'});
9552:
9553: return ($symb,$enc);
9554: }
1.462 albertel 9555:
1.41 ng 9556: =pod
9557:
9558: =back
9559:
1.112 bowersj2 9560: =cut
1.41 ng 9561:
1.112 bowersj2 9562: 1;
9563: __END__;
1.41 ng 9564:
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