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